Skip to content

feat: replace enterprise username import in progress/views.py with pluggable_override #38108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pwnage101 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat: replace enterprise username import in progress/views.py with pluggable_override #38108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions lms/djangoapps/course_home_api/progress/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from django.contrib.auth import get_user_model
from django.http.response import Http404
from edx_django_utils import monitoring as monitoring_utils
from edx_django_utils.plugins import pluggable_override
from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
from edx_rest_framework_extensions.auth.session.authentication import SessionAuthenticationAllowInactiveUser
from opaque_keys.edx.keys import CourseKey
Expand Down Expand Up @@ -39,11 +40,22 @@
from openedx.core.lib.api.authentication import BearerAuthenticationAllowInactiveUser
from openedx.features.content_type_gating.block_transformers import ContentTypeGateTransformer
from openedx.features.course_duration_limits.access import get_access_expiration_data
from openedx.features.enterprise_support.utils import get_enterprise_learner_generic_name

User = get_user_model()


@pluggable_override('OVERRIDE_COURSE_HOME_PROGRESS_USERNAME')
def obfuscated_username(request, student):
"""
Return an obfuscated username for the student, or None.

This function can be overridden by an installed plugin via the
OVERRIDE_COURSE_HOME_PROGRESS_USERNAME setting to return a generic name
for learners who should not have their real username exposed.
"""
return None


class ProgressTabView(RetrieveAPIView):
"""
**Use Cases**
Expand Down Expand Up @@ -206,7 +218,7 @@ def get(self, request, *args, **kwargs):
is_staff = bool(has_access(request.user, 'staff', course_key))

student = self._get_student_user(request, course_key, student_id, is_staff)
username = get_enterprise_learner_generic_name(request) or student.username
username = obfuscated_username(request, student) or student.username

course = get_course_or_403(student, 'load', course_key, check_if_enrolled=False)

Expand Down
Loading