Skip to content

refactor: Extract get_additional_student_profile_attributes function#38154

Open
igobranco wants to merge 1 commit intoopenedx:masterfrom
igobranco:igobranco/upstream/797/refactor-additional-student-profile-attributes
Open

refactor: Extract get_additional_student_profile_attributes function#38154
igobranco wants to merge 1 commit intoopenedx:masterfrom
igobranco:igobranco/upstream/797/refactor-additional-student-profile-attributes

Conversation

@igobranco
Copy link
Contributor

Extract the configuration_helpers.get_value_for_org() call for fetching additional student profile attributes into a dedicated function to eliminate code duplication.

Description

This PR refactors the retrieval of additional student profile attributes to eliminate code duplication and improve maintainability.

Problem

The code for fetching additional_student_profile_attributes from site configuration was duplicated in two locations:

  1. lms/djangoapps/instructor_analytics/basic.py in the get_student_features_with_custom() function
  2. lms/djangoapps/instructor/views/api.py in the GetStudentsFeatures view
    1. lms/djangoapps/instructor/views/api_v2.py in the GenerateReportView view

This duplication made the code harder to maintain and increased the risk of inconsistencies.

Solution

Extracted the duplicated configuration retrieval logic into a dedicated function get_additional_student_profile_attributes() in the instructor_analytics.basic module. Both call sites now use this shared function.

Business requirement

It allows to monkey patch the new function get_additional_student_profile_attributes() for better extensibility.

For example on NAU installation to have a per course configuration to better align with our GDPR compliance of custom fields.

Extract the configuration_helpers.get_value_for_org() call for fetching
additional student profile attributes into a dedicated function to eliminate
code duplication.
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Mar 11, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Mar 11, 2026

Thanks for the pull request, @igobranco!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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.

Details
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 Mar 11, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Mar 11, 2026
@igobranco igobranco marked this pull request as ready for review March 12, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

2 participants