feat: add feature toggle for private fields in profile information report

Author: BryanttV

lms/djangoapps/instructor/tests/test_api.py

@@ -22,6 +22,7 @@
 from django.http import HttpRequest, HttpResponse
 from django.test import RequestFactory, TestCase
 from django.test.client import MULTIPART_CONTENT
+from django.test.utils import override_settings
 from django.urls import reverse as django_reverse
 from django.utils.translation import gettext as _
 from edx_when.api import get_dates_for_course, get_overrides_for_user, set_date_for_block
@@ -2626,6 +2627,23 @@ def test_get_students_features(self):
             assert student_json['city'] == student.profile.city
             assert student_json['country'] == ''
 
+    @ddt.data(True, False)
+    def test_get_students_features_private_fields(self, show_private_fields):
+        """
+        Test that the get_students_features returns the expected private fields
+        """
+        with override_settings(FEATURES={'SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT': show_private_fields}):
+            url = reverse('get_students_features', kwargs={'course_id': str(self.course.id)})
+            response = self.client.post(url, {})
+            res_json = json.loads(response.content.decode('utf-8'))
+
+            assert 'students' in res_json
+            for student in res_json['students']:
+                if show_private_fields:
+                    assert 'year_of_birth' in student
+                else:
+                    assert 'year_of_birth' not in student
+
     @ddt.data(True, False)
     def test_get_students_features_cohorted(self, is_cohorted):
         """

lms/djangoapps/instructor/views/api.py

@@ -1485,40 +1485,45 @@ def post(self, request, course_id, csv=False):  # pylint: disable=redefined-oute
         # We need to clone the list because we modify it below
         query_features = list(configuration_helpers.get_value('student_profile_download_fields', []))
 
-        if not query_features:
-            query_features = [
-                'id', 'username', 'name', 'email', 'language', 'location',
-                'year_of_birth', 'gender', 'level_of_education', 'mailing_address',
-                'goals', 'enrollment_mode', 'last_login', 'date_joined', 'external_user_key'
-            ]
-        keep_field_private(query_features, 'year_of_birth')  # protected information
-
-        # Provide human-friendly and translatable names for these features. These names
-        # will be displayed in the table generated in data_download.js. It is not (yet)
-        # used as the header row in the CSV, but could be in the future.
-        query_features_names = {
-            'id': _('User ID'),
-            'username': _('Username'),
-            'name': _('Name'),
-            'email': _('Email'),
-            'language': _('Language'),
-            'location': _('Location'),
-            #  'year_of_birth': _('Birth Year'),  treated as privileged information as of TNL-10683,
-            #  not to go in reports
-            'gender': _('Gender'),
-            'level_of_education': _('Level of Education'),
-            'mailing_address': _('Mailing Address'),
-            'goals': _('Goals'),
-            'enrollment_mode': _('Enrollment Mode'),
-            'last_login': _('Last Login'),
-            'date_joined': _('Date Joined'),
-            'external_user_key': _('External User Key'),
-        }
+    if not query_features:
+        query_features = [
+            'id', 'username', 'name', 'email', 'language', 'location',
+            'year_of_birth', 'gender', 'level_of_education', 'mailing_address',
+            'goals', 'enrollment_mode', 'verification_status',
+            'last_login', 'date_joined', 'external_user_key',
+            'enrollment_date'
+        ]
+
+    # Provide human-friendly and translatable names for these features. These names
+    # will be displayed in the table generated in data_download.js. It is not (yet)
+    # used as the header row in the CSV, but could be in the future.
+    query_features_names = {
+        'id': _('User ID'),
+        'username': _('Username'),
+        'name': _('Name'),
+        'email': _('Email'),
+        'language': _('Language'),
+        'location': _('Location'),
+        'year_of_birth': _('Birth Year'),
+        'gender': _('Gender'),
+        'level_of_education': _('Level of Education'),
+        'mailing_address': _('Mailing Address'),
+        'goals': _('Goals'),
+        'enrollment_mode': _('Enrollment Mode'),
+        'last_login': _('Last Login'),
+        'date_joined': _('Date Joined'),
+        'external_user_key': _('External User Key'),
+        'enrollment_date': _('Enrollment Date'),
+    }
+
+    if not settings.FEATURES.get('SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT', False):
+            keep_field_private(query_features, 'year_of_birth')
+            query_features_names.pop('year_of_birth', None)
 
-        if is_course_cohorted(course.id):
-            # Translators: 'Cohort' refers to a group of students within a course.
-            query_features.append('cohort')
-            query_features_names['cohort'] = _('Cohort')
+    if is_course_cohorted(course.id):
+        # Translators: 'Cohort' refers to a group of students within a course.
+        query_features.append('cohort')
+        query_features_names['cohort'] = _('Cohort')
 
         if course.teams_enabled:
             query_features.append('team')

lms/envs/common.py

@@ -1067,6 +1067,16 @@
     # .. toggle_creation_date: 2024-04-02
     # .. toggle_target_removal_date: None
     'BADGES_ENABLED': False,
+
+    # .. toggle_name: FEATURES['SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT']
+    # .. toggle_implementation: DjangoSetting
+    # .. toggle_default: False
+    # .. toggle_description: Adds private fields to the profile information report.
+    # .. toggle_use_cases: open_edx
+    # .. toggle_creation_date: 2025-05-12
+    # .. toggle_target_removal_date: None
+    # .. toggle_tickets: https://github.com/openedx/edx-platform/pull/36688
+    'SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT': False,
 }
 
 # Specifies extra XBlock fields that should available when requested via the Course Blocks API