refactor: Extract get_additional_student_profile_attributes function#38154
Conversation
Extract the configuration_helpers.get_value_for_org() call for fetching additional student profile attributes into a dedicated function to eliminate code duplication.
|
Thanks for the pull request, @igobranco! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
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_attributesfrom site configuration was duplicated in two locations:lms/djangoapps/instructor_analytics/basic.pyin theget_student_features_with_custom()functionlms/djangoapps/instructor/views/api.pyin theGetStudentsFeaturesviewlms/djangoapps/instructor/views/api_v2.pyin theGenerateReportViewviewThis 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 theinstructor_analytics.basicmodule. 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.