Skip to content

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

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.

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

BryanttV
Copy link
Contributor

@BryanttV BryanttV commented May 9, 2025

Description

This PR introduces a new feature toggle called SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT. This toggle allows operators to include private fields (such as year_of_birth) in the profile information JSON report or CSV file.

Context

In this PR, the year_of_birth field was removed from the report containing enrolled students' profile information for a specific course.

The new feature toggle gives operators the option to include or exclude private fields in these reports. By default, private fields remain hidden, preserving the current behavior. However, if an operator wants to include them, they can enable the feature toggle.

Testing instructions

  1. Create a Tutor environment.

  2. Create a mount of edx-platform with the changes in this PR.

  3. Create a course and enroll some students in it.

  4. Then, go to the LMS > [Your Course] > Instructor > Data Download > Download profile information as a CSV.

  5. You shouldn't see the year_of_birth column in the CSV.

  6. Now, enable the new feature toggle in your settings. You can use this tutor inline plugin

    name: common-settings
    version: 1.0.0
    patches:
      openedx-common-settings: |
        FEATURES['SHOW_PRIVATE_FIELDS_IN_PROFILE_INFORMATION_REPORT'] = True
  7. Again, download profile information as a CSV.

  8. You should see the year_of_birth column in the CSV.

Deadline

None

Other information

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 9, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented May 9, 2025

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions May 9, 2025
@BryanttV BryanttV force-pushed the bav/add-feature-toggle-for-show-private-fields-in-csv-profile-info branch from 598198c to f166066 Compare May 9, 2025 14:00
@BryanttV BryanttV marked this pull request as ready for review May 9, 2025 14:01
@BryanttV BryanttV changed the title feat: add feature toggle for private fields in profile information CSV export feat: add feature toggle for private fields in profile information report May 12, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions May 12, 2025
@mphilbrick211 mphilbrick211 added the needs reviewer assigned PR needs to be (re-)assigned a new reviewer label May 12, 2025
@BryanttV BryanttV force-pushed the bav/add-feature-toggle-for-show-private-fields-in-csv-profile-info branch from e235843 to e825a39 Compare May 13, 2025 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

3 participants