Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #30603 from openedx/sajjad/VAN-977

Browse Source 
fix: remove fields based on extended_profile configuration
This commit is contained in:
Syed Sajjad Hussain Shah
2022-06-20 13:52:38 +05:00
committed by GitHub
parent 7a700dcfd1 c1a58499a5
commit 897905ce29
4 changed files with 50 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
common/djangoapps/student/models.py
View File

@@ -497,6 +497,8 @@ class UserProfile(models.Model):
user = models.OneToOneField(User, unique=True, db_index=True, related_name='profile', on_delete=models.CASCADE)
name = models.CharField(blank=True, max_length=255, db_index=True)
# How meta field works: meta will only store those fields which are available in extended_profile configuration,
# so in order to store a field in meta, it must be available in extended_profile configuration.
meta = models.TextField(blank=True) # JSON dictionary for future expansion
courseware = models.CharField(blank=True, max_length=255, default='course.xml')

2
openedx/core/djangoapps/user_authn/api/form_fields.py
View File

@@ -177,7 +177,7 @@ def add_profession_field(is_field_required=False):
def add_specialty_field(is_field_required=False):
"""
Returns the user speciality field description
Returns the user specialty field description
"""
# Translators: This label appears above a dropdown menu to select
# the user's specialty

20
openedx/core/djangoapps/user_authn/api/helper.py
View File

@@ -9,6 +9,7 @@ from rest_framework.views import APIView
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from openedx.core.djangoapps.user_authn.api import form_fields
from openedx.core.djangoapps.user_authn.views.registration_form import get_registration_extension_form
from common.djangoapps.student.models import UserProfile
class RegistrationFieldsContext(APIView):
@@ -37,6 +38,7 @@ class RegistrationFieldsContext(APIView):
'specialty',
'marketing_emails_opt_in',
]
user_profile_fields = [field.name for field in UserProfile._meta.get_fields()]
def _get_field_order(self):
"""
@@ -84,6 +86,16 @@ class RegistrationFieldsContext(APIView):
):
self.valid_fields.append(field_name)
def _field_can_be_saved(self, field):
"""
Checks if the field exists in UserProfile Model fields or extended_profile configuration,
if it exists, then the field is valid to save because the meta field in UserProfile model
only stores those fields which are available in extended_profile configuration, so we only
want to send those fields which can be saved.
"""
return (field in self.user_profile_fields or
field in configuration_helpers.get_value('extended_profile_fields', []))
def _get_fields(self):
"""
Returns the required or optional fields configured in REGISTRATION_EXTRA_FIELDS settings.
@@ -92,6 +104,8 @@ class RegistrationFieldsContext(APIView):
custom_form = get_registration_extension_form() or {}
response = {}
for field in self.valid_fields:
if field == 'confirm_email' and self.field_type == 'optional' or not self._field_can_be_saved(field):
continue
if custom_form and field in custom_form.fields:
response[field] = form_fields.add_extension_form_field(
field, custom_form, custom_form.fields[field], self.field_type
@@ -99,10 +113,6 @@ class RegistrationFieldsContext(APIView):
else:
field_handler = getattr(form_fields, f'add_{field}_field', None)
if field_handler:
if field == 'confirm_email':
if self.field_type == 'required':
response[field] = field_handler(self.field_type == 'required')
else:
response[field] = field_handler(self.field_type == 'required')
response[field] = field_handler(self.field_type == 'required')
return response

33
openedx/core/djangoapps/user_authn/api/tests/test_views.py
View File

@@ -202,6 +202,11 @@ class MFEContextViewTest(ThirdPartyAuthTestMixin, APITestCase):
assert response.status_code == status.HTTP_200_OK
assert response.data['registration_fields']['fields'] == {}
@with_site_configuration(
configuration={
'extended_profile_fields': ['first_name', 'last_name']
}
)
@override_settings(
ENABLE_DYNAMIC_REGISTRATION_FIELDS=True,
REGISTRATION_EXTRA_FIELDS={'state': 'required', 'last_name': 'required', 'first_name': 'required'},
@@ -241,7 +246,8 @@ class MFEContextViewTest(ThirdPartyAuthTestMixin, APITestCase):
@with_site_configuration(
configuration={
'EXTRA_FIELD_OPTIONS': {'profession': ['Software Engineer', 'Teacher', 'Other']}
'EXTRA_FIELD_OPTIONS': {'profession': ['Software Engineer', 'Teacher', 'Other']},
'extended_profile_fields': ['profession', 'specialty']
}
)
@override_settings(
@@ -272,6 +278,11 @@ class MFEContextViewTest(ThirdPartyAuthTestMixin, APITestCase):
assert response.status_code == status.HTTP_200_OK
assert response.data['optional_fields']['fields'] == expected_response
@with_site_configuration(
configuration={
'extended_profile_fields': ['specialty']
}
)
@override_settings(
ENABLE_DYNAMIC_REGISTRATION_FIELDS=True,
REGISTRATION_EXTRA_FIELDS={'goals': 'optional', 'specialty': 'optional'},
@@ -285,6 +296,26 @@ class MFEContextViewTest(ThirdPartyAuthTestMixin, APITestCase):
assert response.status_code == status.HTTP_200_OK
assert list(response.data['optional_fields']['fields'].keys()) == ['specialty', 'goals']
@with_site_configuration(
configuration={
'extended_profile_fields': ['specialty']
}
)
@override_settings(
ENABLE_DYNAMIC_REGISTRATION_FIELDS=True,
REGISTRATION_EXTRA_FIELDS={'profession': 'required', 'specialty': 'required'},
REGISTRATION_FIELD_ORDER=['specialty', 'profession'],
)
def test_field_not_available_in_extended_profile_config(self):
"""
Test that if the field is not available in extended_profile configuration then the field
will not be sent in response.
"""
self.query_params.update({'is_registered': True})
response = self.client.get(self.url, self.query_params)
assert response.status_code == status.HTTP_200_OK
assert list(response.data['registration_fields']['fields'].keys()) == ['specialty']
@skip_unless_lms
class SendAccountActivationEmail(UserAPITestCase):