feat!: Flip Studio MFE Waffle Flags to be On-By-Default by kdmccormick · Pull Request #36495 · openedx/openedx-platform

kdmccormick · 2025-04-07T20:22:29Z

Description

This makes nearly all of Studio React-by-default by replacing
the "opt-in-to-React" flags with a set of parallel
"opt-out-of-React-and-use-the-legacy-experience" flags.
Here is the mapping:

contentstore.new_studio_mfe.use_new_unit_page ->
!legacy_studio.unit_editor
new_core_editors.use_new_problem_editor ->
!legacy_studio.problem_editor
new_core_editors.use_new_text_editor ->
!legacy_studio.text_editor
new_core_editors.use_new_video_editor ->
!legacy_studio.video_editor
new_studio_mfe.use_new_home_page ->
!legacy_studio.home
contentstore.new_studio_mfe.use_new_custom_pages ->
!legacy_studio.custom_pages
contentstore.new_studio_mfe.use_new_schedule_details_page ->
!legacy_studio.schedule_details
contentstore.new_studio_mfe.use_new_advanced_settings_page ->
!legacy_studio.advanced_settings
contentstore.new_studio_mfe.use_new_grading_page ->
!legacy_studio.grading
contentstore.new_studio_mfe.use_new_updates_page ->
!legacy_studio.updates
contentstore.new_studio_mfe.use_new_import_page ->
!legacy_studio.import
contentstore.new_studio_mfe.use_new_export_page ->
!legacy_studio.export
contentstore.new_studio_mfe.use_new_files_uploads_page ->
!legacy_studio.files_uploads
contentstore.new_studio_mfe.use_new_course_outline_page ->
!legacy_studio.course_outline
contentstore.new_studio_mfe.use_new_course_team_page ->
!legacy_studio.course_team
contentstore.new_studio_mfe.use_new_certificates_page ->
!legacy_studio.certificates
contentstore.new_studio_mfe.use_new_textbooks_page ->
!legacy_studio.textbooks
contentstore.new_studio_mfe.use_new_group_configurations_page ->
!legacy_studio.configurations

Supporting Info

This is part of the plan detailed in: #36275

Merge considerations

I have warned about this in #cc-risky-changes. The waffle flip was extensively communicated using the DEPR process, so there should not be any blocker to merging this.

Test instructions

Go into the sandbox, log in as admin (UN=openedx, PW=openedx)
Notice that all new_studio_mfe opt-in waffles have been deleted from this sandbox
- Tutor generally creates these flags by default. Once this PR merges, we will be able to remove those init steps from Tutor.
Go to the "Course with default (React) UI" and click around. Confirm that it is all served from the Authoring MFE.
Notice that all the legacy opt-out flags are enabled for "Course with Legacy UI"
Go to the "Course with Legacy UI" and navigate down to the unit level. Once you're there, confirm that clicking around keeps you in the legacy experience.

Other Information

Known issues

Even when the legacy experience is enabled, some MFE pages hard-code the MFE URLs, and thus keep you in the MFE when you should be kicked back to legacy. This is an existing issue. I would try to fix this if we had more time.
I missed the ENABLE_PAGES_AND_RESOURCES flag on the DEPR waffle because, for historical reasons, it was tucked amongst the discussions toggles rather than the contentstore toggles. So, Studio will still default to the really old Pages page in Teak, unless I can sell BTR on the idea of backporting one more waffle-flip.
Some links still send you to the legacy experience before redirecting you back to the MFE. Then end result is fine, but it's a much slower and clunkier experience than it would be if the platform just rendered URLs directly to whichever experience is active. I had hoped to make progress on this for Teak, but ran out of time.
Many unit tests will need rework in order to remove the legacy UI without removing a bunch of test coverage. I've tried to add TODO comments to these test modules.

Query count increases

cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_index.py:CourseIndexViewTest.test_number_of_calls_to_db increased from 32 to 33
cms/djangoapps/contentstore/views/tests/test_course_index.py:TestCourseOutline.test_number_of_calls_to_db
increased from 29 to 38 😬

In both cases, the new query(ies) were all:

SELECT "site_configuration_siteconfiguration"."id", "site_configuration_siteconfiguration"."site_id", "site_configuration_siteconfiguration"."enabled", "site_configuration_siteconfiguration"."site_values" FROM "site_configuration_siteconfiguration" WHERE ("site_configuration_siteconfiguration"."enabled" AND "site_configuration_siteconfiguration"."site_values" LIKE '%course\_org\_filter%' ESCAPE '\')

I believe this is all because get_course_authoring_url queries org-level site configuration, and for whatever reason the result isn't cached. Ick.

ormsbee · 2025-04-23T19:29:20Z

It looks really good. I really like how it demonstrates the value of having independent functions to answer the question of whether something is enabled, allowing us to switch the toggles underneath. I'm not sure if we document that pattern explicitly anywhere.

open-craft-grove · 2025-04-24T05:05:04Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-04-24T05:36:26Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-04-24T06:30:48Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-04-24T07:24:10Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

This makes nearly all of Studio React-by-default by replacing the "opt-in-to-React" flags with a set of parallel "opt-out-of-React-and-use-the-legacy-experience" flags. Here is the mapping: * `contentstore.new_studio_mfe.use_new_unit_page` -> `!legacy_studio.unit_editor` * `new_core_editors.use_new_problem_editor` -> `!legacy_studio.problem_editor` * `new_core_editors.use_new_text_editor` -> `!legacy_studio.text_editor` * `new_core_editors.use_new_video_editor` -> `!legacy_studio.video_editor` * `new_studio_mfe.use_new_home_page` -> `!legacy_studio.home` * `contentstore.new_studio_mfe.use_new_custom_pages` -> `!legacy_studio.custom_pages` * `contentstore.new_studio_mfe.use_new_schedule_details_page` -> `!legacy_studio.schedule_details` * `contentstore.new_studio_mfe.use_new_advanced_settings_page` -> `!legacy_studio.advanced_settings` * `contentstore.new_studio_mfe.use_new_grading_page` -> `!legacy_studio.grading` * `contentstore.new_studio_mfe.use_new_updates_page` -> `!legacy_studio.updates` * `contentstore.new_studio_mfe.use_new_import_page` -> `!legacy_studio.import` * `contentstore.new_studio_mfe.use_new_export_page` -> `!legacy_studio.export` * `contentstore.new_studio_mfe.use_new_files_uploads_page` -> `!legacy_studio.files_uploads` * `contentstore.new_studio_mfe.use_new_course_outline_page` -> `!legacy_studio.course_outline` * `contentstore.new_studio_mfe.use_new_course_team_page` -> `!legacy_studio.course_team` * `contentstore.new_studio_mfe.use_new_certificates_page` -> `!legacy_studio.certificates` * `contentstore.new_studio_mfe.use_new_textbooks_page` -> `!legacy_studio.textbooks` * `contentstore.new_studio_mfe.use_new_group_configurations_page` -> `!legacy_studio.configurations` Part of: openedx#36275

open-craft-grove · 2025-04-24T07:46:17Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

open-craft-grove · 2025-04-24T08:20:46Z

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

ormsbee · 2025-04-24T14:01:48Z

cms/djangoapps/contentstore/toggles.py

-)
+# .. toggle_description: Temporarily fall back to the old proctored exam settings view.
+# .. toggle_use_cases: temporary
+# .. toggle_creation_date: 2025-03-14


Nit: The toggle creation dates are all set to the DEPR acceptance date here instead of when they're actually being created. Is that intentional?

Oh, nvm, of course it is. Because that's part of the whole six month notice + removal cycle.

ormsbee · 2025-04-24T14:05:27Z

cms/djangoapps/contentstore/toggles.py



-def exam_setting_view_enabled():
+def exam_setting_view_enabled(course_key):


What would you think about giving course_key a default value of None where you're currently adding a required param, so that we're less likely to break plugins that might have been calling these functions?

(Odds are small anyhow, but I'm paranoid.)

@ormsbee I initially agreed, and I was in the process of making that change for this function and for the use_new_$blah_editor functions. But then I realized that this wouldn't really be preserving backwards compatibility--rather, it would be suppressing backwards incompatibility. If a plugin is calling these functions from the context of a course and isn't passing in the course_key, then that is incorrect. It needs to pass in course_key in order to respect WaffleFlagCourseOverride expectations. So, I think I'd rather leave this, and let plugins break if they are reaching into this module.

It would still be correct if there weren't course-specific overrides, which is going to be a very common case, since course waffle flags fallback to that behavior if course_key=None. The failure mode would also be, "some users see the wrong thing for a specific course because the plugin doesn't respect course-specific overrides" vs. "all users get a 500 error because the check explodes".

I'm not going to hold up the PR over it since it's such an edge case, but we should probably message it in the risky-changes slack channel just in case.

open-craft-grove · 2025-04-24T14:13:04Z

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

ormsbee

I had one question w.r.t adding a default value for checks like exam_setting_view_enabled where it goes from being no-arg to taking an explicit course_key. I'll wait until you're up, since the cut datetime has been pushed to Friday morning EST anyhow.

Otherwise, LGTM.

ormsbee

Approved, with the caveat that I do think it's worth making a few of the feature check calls more backwards compatible with a default course_key of None, even though it won't respect course overrides.

edx-pipeline-bot · 2025-04-24T17:57:46Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-04-24T18:26:51Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-04-24T18:26:51Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-04-24T18:45:30Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

This makes nearly all of Studio React-by-default by replacing the "opt-in-to-React" flags with a set of parallel "opt-out-of-React-and-use-the-legacy-experience" flags. Here is the mapping: * `contentstore.new_studio_mfe.use_new_unit_page` -> `!legacy_studio.unit_editor` * `new_core_editors.use_new_problem_editor` -> `!legacy_studio.problem_editor` * `new_core_editors.use_new_text_editor` -> `!legacy_studio.text_editor` * `new_core_editors.use_new_video_editor` -> `!legacy_studio.video_editor` * `new_studio_mfe.use_new_home_page` -> `!legacy_studio.home` * `contentstore.new_studio_mfe.use_new_custom_pages` -> `!legacy_studio.custom_pages` * `contentstore.new_studio_mfe.use_new_schedule_details_page` -> `!legacy_studio.schedule_details` * `contentstore.new_studio_mfe.use_new_advanced_settings_page` -> `!legacy_studio.advanced_settings` * `contentstore.new_studio_mfe.use_new_grading_page` -> `!legacy_studio.grading` * `contentstore.new_studio_mfe.use_new_updates_page` -> `!legacy_studio.updates` * `contentstore.new_studio_mfe.use_new_import_page` -> `!legacy_studio.import` * `contentstore.new_studio_mfe.use_new_export_page` -> `!legacy_studio.export` * `contentstore.new_studio_mfe.use_new_files_uploads_page` -> `!legacy_studio.files_uploads` * `contentstore.new_studio_mfe.use_new_course_outline_page` -> `!legacy_studio.course_outline` * `contentstore.new_studio_mfe.use_new_course_team_page` -> `!legacy_studio.course_team` * `contentstore.new_studio_mfe.use_new_certificates_page` -> `!legacy_studio.certificates` * `contentstore.new_studio_mfe.use_new_textbooks_page` -> `!legacy_studio.textbooks` * `contentstore.new_studio_mfe.use_new_group_configurations_page` -> `!legacy_studio.configurations` Part of: #36275

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from 47ba960 to 7019761 Compare April 7, 2025 20:26

This was referenced Apr 7, 2025

[DEPR]: All Legacy Studio Frontends #36275

Open

fix: Switch to inverted Studio MFE waffle flags overhangio/tutor-mfe#247

Closed

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch 5 times, most recently from 3da457a to d2e91bd Compare April 11, 2025 15:02

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from d2e91bd to e07c1a9 Compare April 23, 2025 18:58

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from 9c7e299 to f85807b Compare April 24, 2025 02:33

kdmccormick added the create-sandbox A test sandbox will be created for this PR, using the `open-craft/pr-sandbox-automation` tool label Apr 24, 2025

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from 7587da1 to 7bf3c0b Compare April 24, 2025 03:48

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from c9e9baf to b30ba54 Compare April 24, 2025 05:22

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch 2 times, most recently from f76a8be to 4bab1d1 Compare April 24, 2025 06:14

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from 4bab1d1 to c9f1a5c Compare April 24, 2025 06:51

kdmccormick marked this pull request as ready for review April 24, 2025 07:18

kdmccormick requested a review from ormsbee April 24, 2025 07:18

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from c9f1a5c to 10447ad Compare April 24, 2025 07:24

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from 10447ad to c399772 Compare April 24, 2025 07:25

kdmccormick force-pushed the kdmccormick/legacy-studio-depr-flip-waffles branch from c399772 to 3c452d0 Compare April 24, 2025 07:25

Merge branch 'master' into kdmccormick/legacy-studio-depr-flip-waffles

b25279b

ormsbee reviewed Apr 24, 2025

View reviewed changes

kdmccormick requested a review from ormsbee April 24, 2025 15:57

ormsbee approved these changes Apr 24, 2025

View reviewed changes

kdmccormick merged commit 8e9f944 into openedx:master Apr 24, 2025
49 checks passed

kdmccormick deleted the kdmccormick/legacy-studio-depr-flip-waffles branch April 24, 2025 16:34

rayzhou-bit mentioned this pull request Apr 24, 2025

chore: update readme on legacy flags openedx/frontend-app-authoring#1861

Merged

kdmccormick mentioned this pull request Jun 5, 2025

feat: enable authoring MFE markdown editor waffle flag for everyone by default #36602

Closed

kdmccormick mentioned this pull request Jul 21, 2025

Disabling tutor-mfe no longer will disable the Studio MFE overhangio/tutor-mfe#263

Closed



		def exam_setting_view_enabled():
		def exam_setting_view_enabled(course_key):

Conversation

kdmccormick commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting Info

Merge considerations

Test instructions

Other Information

Known issues

Query count increases

Uh oh!

ormsbee commented Apr 23, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

ormsbee Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

ormsbee Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ormsbee Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ormsbee Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

kdmccormick Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

ormsbee Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

ormsbee Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

open-craft-grove commented Apr 24, 2025

Uh oh!

ormsbee left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ormsbee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

edx-pipeline-bot commented Apr 24, 2025

Uh oh!

edx-pipeline-bot commented Apr 24, 2025

Uh oh!

edx-pipeline-bot commented Apr 24, 2025

Uh oh!

edx-pipeline-bot commented Apr 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kdmccormick commented Apr 7, 2025 •

edited

Loading

ormsbee Apr 24, 2025 •

edited

Loading

ormsbee Apr 24, 2025 •

edited

Loading

ormsbee left a comment •

edited

Loading