feat: adds waffle flags for legacy libraries v1 and new libraries v2 [FC-0062] #35576
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @pomegranited! What's next?Please work through the following steps to get your changes 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. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
pomegranited
force-pushed
the
jill/libraries-waffle-flags
branch
from
d6c07b3
to
1b09f94
Compare
to better reflect how this serializer/API is used in the Authoring MFE
…in new Studio Home These waffle flags replace the MFE env flag LIBRARY_MODE.
and ENABLE_CONTENT_LIBRARIES feature toggle where possible. ENABLE_CONTENT_LIBRARIES has been incorporated into both the libraries_v1_enabled() and libraries_v2_enabled() toggles: FEATURES['ENABLE_CONTENT_LIBRARIES'] must be true for either version of libraries to be "enabled".
pomegranited
force-pushed
the
jill/libraries-waffle-flags
branch
from
8cab2d3
to
0d0b473
Compare
There was a problem hiding this comment.
Nice work!
I note that contentstore.new_studio_mfe.disable_new_libraries doesn't disable the v2 libraries REST APIs, but I think that's good.
I tested various combinations of this, and I did confirm that contentstore.new_studio_mfe.disable_legacy_libraries does disable the legacy UI library views like http://studio.local.openedx.io:8001/library/library-v1:foo+bar (now gives 404 if that waffle flag is enabled).
I note that because this depends on Meilisearch, even though v2 libraries will now generally be on by default, they will remain off on edx.org (which is not ready to roll them out yet), because it doesn't have Meilisearch configured. So merging this should not affect 2U.
|
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. |
Description
Adds waffle flags to replace the Authoring MFE's
LIBRARY_MODEenv config variable, and exposes them with the contentstore "home" REST API.Since waffle flags are disabled by default, and we want both v1 and v2 libraries enabled by default in the Authoring MFE, we've named these flags as
disable_*_libraries.contentstore.new_studio_mfe.disable_legacy_libraries-> negated to providelibraries_v1_enabledin the REST APIcontentstore.new_studio_mfe.disable_new_libraries-> negated and combined withsettings.MEILISEARCH_ENABLEDto providelibraries_v2_enabledin the REST API.Combined with openedx/frontend-app-authoring#1329, this change impacts Course Authors.
Supporting information
Relates to:
Private-ref: FAL-3858
Testing instructions
See openedx/frontend-app-authoring#1329
Deadline
ASAP
Concerns
settings.FEATURESflag calledENABLE_CONTENT_LIBRARIES. How this flag should affect use of libraries v1 and/or v2 is under discussion.