-
Notifications
You must be signed in to change notification settings - Fork 4.2k
refactor: flatten FEATURES dictionary with backward compatible proxy #37067
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
refactor: flatten FEATURES dictionary with backward compatible proxy #37067
Conversation
|
Thanks for the pull request, @wgu-ram-chandra! 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. |
aeb1504 to
f2ac8a1
Compare
|
Sandbox deployment failed 💥 |
|
Sandbox deployment successful 🚀 |
kdmccormick
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great overall approach and great work so far 👍🏻 Just some comments on the implementation of the FEATURES proxy.
|
Sandbox deployment failed 💥 |
d034f51 to
d689dec
Compare
|
Sandbox deployment failed 💥 |
e915471 to
03204fd
Compare
|
Sandbox deployment failed 💥 |
|
Sandbox deployment failed 💥 |
9d9a03e to
20b41a0
Compare
|
Sandbox deployment failed 💥 |
|
Sandbox deployment successful 🚀 |
dd6c5f8 to
067150b
Compare
wgu-taylor-payne
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for making those changes. I think this looks good to go, but we need to coordinate an updated DEPR and also changes to Tutor.
Here are the FEATURE settings that Tutor and tutor-mfe reference:
|----------------------------------+--------------------|
| FEATURE setting | Tutor source |
|----------------------------------+--------------------|
| ENABLE_CORS_HEADERS | common_all.py |
| ENABLE_COURSEWARE_INDEX | common_cms.py |
| ENABLE_COURSEWARE_MICROFRONTEND | lms/development.py |
| ENABLE_COURSEWARE_SEARCH | common_lms.py |
| ENABLE_COURSE_DISCOVERY | common_lms.py |
| ENABLE_DASHBOARD_SEARCH | common_lms.py |
| ENABLE_DISCUSSION_SERVICE | common_all.py |
| ENABLE_ENTERPRISE_INTEGRATION | lms/development.py |
| PREVENT_CONCURRENT_LOGINS | common_all.py |
| ENABLE_AUTHN_MICROFRONTEND | tutor-mfe |
| ENABLE_NEW_BULK_EMAIL_EXPERIENCE | tutor-mfe |
|----------------------------------+--------------------|
I think one good approach to resolve this is to add something like this to the top of common_all.py:
try:
from openedx.core.lib.features_setting_proxy import FeaturesProxy
FEATURES = FeaturesProxy(globals())
except ImportError:
passThis would provide backwards compatibility with the FEATURES dictionary, as we transition off of it. @wgu-ram-chandra, do you want to create a PR for this on the Tutor main branch?
The instructions in the DEPR, which was created when we were trying the read-only approach, will not work with the new updates. We need to request that operators add something like the snippet above to any custom settings modules that write to FEATURES. How do you recommend we go about this @kdmccormick?
|
Sandbox deployment successful 🚀 |
067150b to
906e676
Compare
|
Sandbox deployment successful 🚀 |
906e676 to
790a67a
Compare
|
Sandbox deployment failed 💥 |
|
Sandbox deployment failed 💥 |
|
Sandbox deployment successful 🚀 |
I recommend closing the current DEPR, and opening a new one. Use the fast-track template, as we do not need a comment period for this. You do not need to make the Tutor updates yourself. Instead, I recommend sharing the new DEPR in the #tutor-maintenance channel. The maintainers there are quite responsive and should be able to make the necessary Tutor updates shortly. (we're trying to maintain a degree of separation between Tutor and Open edX projects; we want to establish that Open edX devs are responsible for communicating breaking changes clearly, but not responsible for updating downstream projects like Tutor) |
kdmccormick
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks great!
I'll merge once that DEPR is posted and the "breaking changes" date has passed. I think 1 week is appropriate, since the change is so small.
|
Sandbox deployment failed 💥 |
|
Sandbox deployment successful 🚀 |
|
Related DEPR: #37345 |
|
Breaking changes are now unblocked so I'll be merging this now. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
|
2U Release Notice: This PR has been deployed to the edX production environment. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
See also: [DEPR]: Add FEATURES = FeaturesProxy(...) to your django settings
Description
This PR begins the process of flattening the FEATURES dictionary by moving all boolean feature flags from the nested FEATURES dictionary directly into the settings namespace, while maintaining full backward compatibility through a proxy.
Problem Overview
Both LMS and CMS settings contain a large FEATURES dictionary with boolean values that adds unnecessary complexity:
Solution
FEATURES['ENABLE_COURSE_DISCOVERY']->ENABLE_COURSE_DISCOVERY)Implementation Details
settings.FEATURES['KEY']usageTesting
xmodule/tests/test_word_cloud.pywhere patch was conflicting with proxyBackward Compatibility
Backward compatible - existing code using
settings.FEATURES['KEY']continues to work unchanged.Multi-PR approach
This is Phase 1 of a multi-PR approach:
Below is the Reference Update Script: FEATURES → Direct Settings
Script (click to expand)
Fixes: #36890
CC: @kdmccormick