Skip to content

feat: remove legacy Django unit editor - #38985

Draft
salman2013 wants to merge 6 commits into
masterfrom
salman/remove-legacy-unit-editor
Draft

feat: remove legacy Django unit editor#38985
salman2013 wants to merge 6 commits into
masterfrom
salman/remove-legacy-unit-editor

Conversation

@salman2013

@salman2013 salman2013 commented Aug 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

  • Removes the LEGACY_STUDIO_UNIT_EDITOR waffle flag and all code paths behind it — the MFE-based unit editor (frontend-app-authoring) is now always active
  • Removes use_new_unit_page() from toggles.py — it had no remaining callers after container_handler was simplified
  • Simplifies container_handler to always redirect to the MFE unit editor
  • Simplifies get_unit_url() in utils.py — removed the use_new_unit_page() conditional, always builds the MFE URL
  • Hardcodes use_new_unit_page: true in the waffle flags serializer — the legacy toggle is gone but the API key is kept for now (see Future cleanup below)
  • Deletes container.html — the legacy full-page Django-template unit editor
  • Cleans up related legacy tests and JS specs

What was kept (MFE still needs these)

  • xblock_edit_view and /xblock/<key>/action/edit URL — the MFE still calls this endpoint to load the xblock edit modal in an iframe (getLegacyEditModalUrl in xblock-container-iframe)
  • container_editor.html — rendered by xblock_edit_view for that modal iframe
  • container_embed_handler and /container_embed/<usage_key> URL — used by the MFE to load xblock content in iframes
  • container_chromeless.html — rendered for those MFE iframes
  • get_use_new_unit_page serializer method — tombstoned, always returns True; kept in the API response until the MFE confirms it no longer reads this key

Future cleanup

  • Once MFE stops reading use_new_unit_page from the waffle flags API: remove get_use_new_unit_page method and use_new_unit_page field from the serializer

References:
#2539
#35587
#36495

Test plan

  • Visit a unit page in Studio — confirm redirect to MFE unit editor
  • Confirm xblock components load correctly inside the MFE unit page (via container_embed_handler iframes)
  • Confirm editing an xblock component opens the edit modal correctly (via xblock_edit_view)
  • Confirm adding/removing components on the unit page works
  • Run CMS tests: pytest cms/djangoapps/contentstore/ --ds=cms.envs.test

🤖 Generated with Claude Code

@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 Aug 13, 2026
@openedx-webhooks

openedx-webhooks commented Aug 13, 2026

Copy link
Copy Markdown

Thanks for the pull request, @salman2013!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

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 Aug 13, 2026
@salman2013 @claude
feat: remove legacy Django unit editor
2d87434 
The legacy unit editor (controlled by LEGACY_STUDIO_UNIT_EDITOR waffle
flag) has been fully removed. The MFE-based unit editor (frontend-app-
authoring) is now the only editor and is always active.

Removed:
- LEGACY_STUDIO_UNIT_EDITOR CourseWaffleFlag
- container_handler legacy Django-rendered path (now always redirects to MFE)
- xblock_edit_view and xblock_edit_handler URL (/xblock/<key>/action/edit)
- container.html and container_editor.html templates
- unit_outline_spec.js and related legacy tests

Kept (still used by MFE):
- container_embed_handler and /container_embed/<key> URL
- container_chromeless.html template (rendered for MFE iframes)
- use_new_unit_page serializer field (hardcoded True; MFE still reads it)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013
salman2013 force-pushed the salman/remove-legacy-unit-editor branch from 717835e to 2d87434 Compare August 13, 2026 13:00
@salman2013 salman2013 added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Aug 13, 2026
salman2013 and others added 2 commits August 17, 2026 15:50
@salman2013 @claude
fix: remove unused imports and stale Karma spec reference
2d839db 
- Remove unused imports in block.py (xframe_options_exempt,
  render_to_response, _get_item_in_course)
- Remove unused libraries_v1_enabled import in component.py
- Remove unused ADVANCED_COMPONENT_TYPES import in test_contentstore.py
- Remove unused BeautifulSoup import in test_block.py
- Fix trailing newlines in test_block.py and test_container_page.py
- Remove deleted unit_outline_spec.js from Karma spec list in main.js

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013 @claude
fix: remove legacy test_container_html and revert split_test fallback
95b84bd 
The test_container_html was testing legacy Django-rendered HTML content
(breadcrumbs, section tags from the deleted container.html template).
Removed it since the legacy editor is gone and the split_test container
URL (/container/<key>) was legacy-only — the MFE does not use it.

Also reverts the get_parent_xblock fallback added to container_handler
as it was adding new functionality rather than just removing legacy code.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@salman2013 salman2013 closed this Aug 18, 2026
@salman2013 salman2013 reopened this Aug 18, 2026
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Aug 18, 2026
@Agrendalath Agrendalath added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Aug 19, 2026
@irfanuddinahmad irfanuddinahmad mentioned this pull request Aug 20, 2026
Open
salman2013
salman2013 commented Aug 21, 2026
View reviewed changes
Comment thread cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py
@@ -158,10 +158,14 @@ def get_use_new_course_outline_page(self, obj):

def get_use_new_unit_page(self, obj):

@salman2013 salman2013 Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use_new_unit_page is kept in the serializer response for now as a field returning True. Once the MFE confirms it no longer reads this key from the waffle flags API, the field and its method can be removed in a follow-up PR.

@salman2013 @claude
refactor: restore xblock_edit_view and remove use_new_unit_page from …
db13ea0 
…toggles

- Restore xblock_edit_view, container_editor.html, and the xblock_edit_handler
  URL — the Authoring MFE still calls /xblock/<id>/action/edit to load the
  xblock edit modal in an iframe (getLegacyEditModalUrl in xblock-container-iframe)
- Remove use_new_unit_page() from toggles.py — it had no remaining callers
  after container_handler was simplified to always redirect to the MFE

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

Contributions
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@salman2013 @openedx-webhooks @Agrendalath