Skip to content

refactor: remove built-in HTML XBlock implementation (slash-n-burn #37819) - #38748

Open
irfanuddinahmad wants to merge 6 commits into
masterfrom
irfanuddinahmad/slash-and-burn-html-block
Open

irfanuddinahmad wants to merge 6 commits into
masterfrom
irfanuddinahmad/slash-and-burn-html-block

Conversation

@irfanuddinahmad

@irfanuddinahmad irfanuddinahmad commented Jun 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Removes the built-in HTML XBlock from xmodule/html_block.py. xblock_html.HtmlBlock has been the default since USE_EXTRACTED_HTML_BLOCK = True, so the built-in code no longer runs. This is a partial removal: the About, Static Tab and Course Info blocks stay in the platform.

Part of the Slash-n-Burn Built-In XBlocks epic. Closes openedx/public-engineering#536

Merge status: ✅ ready for review.
Known gaps: none. Follow-up: xmodule/js/src/html/display.js and imageModal.js become dead code once both this PR and #38746 merge; they're removed in #38792.
Translations hold: merge only after openedx/xblocks-core#329 and openedx/openedx-translations#85196 are live and the xblock_* catalogs are confirmed. Until then the extracted block is translated only through the built-in xmodule msgids that this PR deletes.

Changes

Deleted: _BuiltinHtmlBlockMixin (~330 LOC) and _BuiltInHtmlBlock, the HtmlBlockMixin = None/reset_Mixin() and HtmlBlock = None/reset_class() shims, now-unused imports in html_block.py, HtmlBlockDisplay.css, the HtmlBlockDisplay webpack entry, the built-in html entrypoint, and the USE_EXTRACTED_HTML_BLOCK toggle.

Kept (still used):

  • AboutBlock, StaticTabBlock and CourseInfoBlock in html_block.py, which now inherit xblock_html.HtmlBlockMixin directly.
  • The HtmlBlockEditor webpack entry, xmodule/js/src/html/edit.js and HtmlBlockEditor.css, used by the instructor dashboard.

Tests:

Removed from the platform Counterpart in xblocks-core
Toggle-parametrized HtmlBlock classes in xmodule/tests/test_html_block.py (13 tests) src/xblock_html/tests/: same names; 11 near-identical, 2 differ only in how the block class is referenced

Kept in the platform:

  • xmodule/tests/test_html_block.py: CourseInfoBlockTestCase stays, since that block stays.
  • lms/djangoapps/courseware/tests/test_block_render.py: imports HtmlBlock from xblock_html.

Epic Step 1: Post-extraction commit review

Toggle flipped 2025-12-03 (1fed4be5c9). Of the 6 later commits to html_block.py, the HtmlBlockMixin base refactor (b2376c5f7c) was applied independently in xblocks-core (b277504); the rest are cosmetic (ruff suppression, import sorting, lint-amnesty). Nothing to port.

Test plan

Tested on a local Tutor nightly (master 6f85d63c7f + xblocks-core 2.0.0) through the REST APIs and a headless browser, because PR sandboxes aren't deploying (open-craft/pr-sandbox-automation#28). A box is ticked only if that flow actually ran.

  • LMS student view
  • CMS course unit
  • CMS V2 Library
  • Kept blocks render in the LMS: Course About page, Static Tabs, Course Info handouts and updates
  • HtmlBlockEditor (TinyMCE) on the instructor dashboard: the kept HtmlBlockEditor.js bundle loads (200) on the legacy instructor dashboard, but the editor itself wasn't exercised (the Send Email tab needs bulk email). css/HtmlBlockEditor.css returns 404 locally; that template line is unchanged from master
  • CI: pytest xmodule/tests/test_html_block.py and lms/djangoapps/courseware/tests/test_block_render.py, plus locally test_course_index.py, test_library_root.py, test_split_test_block.py, test_library_content.py (all passed), npm run build
V2 Library checklist: 11/13 pass (L10 export diff and H3 text override not done)

Content Libraries V2: smoke tests (historically the most fragile area for extracted blocks: openedx/xblocks-core#123, openedx/xblocks-core#132, openedx/xblocks-core#243, openedx/xblocks-core#274)

  • L1. Create the block in a V2 library; the preview renders with no 500 or console errors
  • L2. Edit → save → reload the page → reopen the editor: every field kept its value
  • L3. Publish the component; its status changes to Published
  • L4. Copy to clipboard from the library, then paste into the library and into a course unit
  • L5. In a library unit: add the block as new content, then add it as existing library content (watch for "There was an error linking the content to this container", [Test failure] TC-00338: Libraries: Unable to add existing component to a unit wg-build-test-release#556)
  • L6. Reuse in a course: add it through "Library content" in a unit, and reuse a library unit containing it from the course outline. Both render in Studio and in the LMS student view
  • L7. Sync: edit and publish in the library, then accept the update in the course and also ignore one
  • L8. Override the title on the reused copy in the course
  • L9. Library search: filtering by content type finds the block
  • L10. OLX: import as a pointer tag and inline, export as a pointer tag, and diff the export against master (which still has the built-in block) — not ticked: inline and pointer-tag import and pointer-tag export pass; the export diff against the built-in block wasn't done

HTML-specific:

  • H1. Library text editor: headings, formatting, links, an uploaded image, a table and an iframe all save and render (ULMO TC-00322) — (verified through the editor's save API and render; not through the UI)
  • H2. Images uploaded in the library resolve in the library preview and after reuse in the course (LibraryLocatorV2 branch in xblock_html/block.py)
  • H3. Text override on the reused copy, both standalone and inside a reused unit (ULMO TC-00366/00367) — not ticked: title override verified (L8); text override wasn't tested

Library checklist compiled from the Aximprovements manual test doc (Extracted Block Tests tab) and the Ulmo test sheet's library cases. Generated using Claude Code.

Screenshots

6 screenshots (LMS, Studio unit, V2 Library)

Local Tutor nightly, 2026-11-12

Captured automatically during the local smoke tests (the sandbox isn't reachable yet, see open-craft/pr-sandbox-automation#28). All images: irfanuddinahmad/edx-platform@snb-smoke-screenshots/38748.

LMS student view (imported block) Studio course unit (authoring MFE)
lms_inline studio_unit
V2 library home V2 library component preview
library_home lib_preview
LMS: copy reused from the library (after sync + title override) Legacy instructor dashboard (kept HtmlBlockEditor bundle loads)
lms_reused instructor_dashboard_legacy

🤖 Generated with Claude Code

Settings

# Workaround for open-craft/pr-sandbox-automation#28: the openedx-permissions image name gets mangled.
DOCKER_IMAGE_PERMISSIONS: docker.io/overhangio/openedx-permissions:23.0.0-main

@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 Jun 11, 2026
@openedx-webhooks

openedx-webhooks commented Jun 11, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @irfanuddinahmad!

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.

Details
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 Jun 11, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-html-block branch from a524f10 to 90638b4 Compare June 11, 2026 12:52
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 11, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-html-block branch 2 times, most recently from 0ebcc95 to 998f59c Compare June 12, 2026 16:55
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-html-block branch from 998f59c to c982ac4 Compare June 22, 2026 11:15
@irfanuddinahmad irfanuddinahmad changed the title feat: remove built-in HTML XBlock implementation (slash-n-burn #37819) refactor: remove built-in HTML XBlock implementation (slash-n-burn #37819) Jun 22, 2026
@mphilbrick211 mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Jul 13, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-html-block branch from c982ac4 to fddf171 Compare November 4, 2026 11:06
@irfanuddinahmad irfanuddinahmad added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Nov 5, 2026
Irfan Ahmad and others added 6 commits November 10, 2026 15:23
…7819)

Removes the _BuiltinHtmlBlockMixin, _BuiltInHtmlBlock classes, the
HtmlBlockMixin/HtmlBlock shims, and the USE_EXTRACTED_HTML_BLOCK
toggle now that the extracted version in xblocks-contrib is the only
implementation. AboutBlock, StaticTabBlock, and CourseInfoBlock remain
in html_block.py and now inherit from xblocks_contrib.html.HtmlBlockMixin
directly. HtmlBlockDisplay webpack entry removed; HtmlBlockEditor kept
since the instructor dashboard loads it explicitly.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
HtmlBlockDisplay (the only webpack entry including html/display.js and
imageModal.js, other than AnnotatableBlockDisplay which is removed in the
Annotatable PR) is deleted in this PR. Remove the now-dead imports-loader
rules from webpack.common.config.js for consistency with how Poll,
WordCloud, and LTI PRs handle their own cleanup.

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
xblocks-core 2.0.0 (#38473) removed the xblocks_contrib package. Point the
platform entrypoint, imports and mock.patch targets at the new per-block
packages (e.g. xblocks_contrib.html -> xblock_html).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-html-block branch from fddf171 to 5db9614 Compare November 10, 2026 10:25

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

[Refactor] Slash-n-Burn HTML BuiltIn XBlock

2 participants