Skip to content

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

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

refactor: remove built-in HTML XBlock implementation (slash-n-burn #37819)#38748
irfanuddinahmad wants to merge 5 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 as part of the Slash-n-Burn Built-In XBlocks epic (#37819). The extracted version in xblocks-contrib has been the active implementation since USE_EXTRACTED_HTML_BLOCK was set to True.

Closes openedx/public-engineering#536

Deleted:

  • _BuiltinHtmlBlockMixin class (~330 LOC) — built-in HTML mixin
  • _BuiltInHtmlBlock class — built-in HTML block
  • HtmlBlockMixin = None / reset_Mixin() — shim for the mixin
  • HtmlBlock = None / reset_class() — shim for HtmlBlock
  • xmodule/static/css-builtin-blocks/HtmlBlockDisplay.css
  • All unused imports from html_block.py

Kept:

  • AboutBlock, StaticTabBlock, CourseInfoBlock — still live in html_block.py; now inherit from xblocks_contrib.html.HtmlBlockMixin directly
  • HtmlBlockEditor webpack entry — still loaded by the instructor dashboard
  • xmodule/js/src/html/edit.js, HtmlBlockEditor.css — referenced by instructor dashboard template

Modified:

  • openedx/envs/common.py — removed USE_EXTRACTED_HTML_BLOCK toggle
  • pyproject.toml — removed conflicting html entrypoint
  • webpack.builtinblocks.config.js — removed HtmlBlockDisplay entry
  • xmodule/tests/test_html_block.py — removed toggle-conditional test classes; kept CourseInfoBlockTestCase
  • lms/djangoapps/courseware/tests/test_block_render.py — import HtmlBlock from xblocks_contrib.html

Note: xmodule/js/src/html/display.js and imageModal.js are still referenced by AnnotatableBlockDisplay in webpack (removed in PR #38746). After both #38746 and this PR merge, those two JS files become dead code. Their deletion is tracked in #38792.

Epic Step 1: Post-extraction commit review

Reviewed commits to xmodule/html_block.py after USE_EXTRACTED_HTML_BLOCK was set to True (2025-12-03 · 1fed4be5c9). All 6 post-toggle commits were cosmetic or independently mirrored: the HtmlBlockMixin base refactor (b2376c5f7c, 2026-01-01) was independently applied in xblocks-contrib (b277504) with the same intent; remaining commits were ruff suppression, import sorting, and lint-amnesty removal. No functional bug fixes or features to port.

Test plan

Testing scope: The xblocks-contrib implementation's behavioral correctness was fully validated during the extraction phase (when USE_EXTRACTED_* was set to True). These slash-n-burn PRs only delete dead built-in code — no behavioral change is possible. The only regression risk is that an entrypoint, webpack bundle, or import path is broken, which surfaces as a block failing to load. Basic load verification across LMS, CMS course, and CMS library is sufficient.

Smoke tests require a live Tutor environment and cannot be pre-checked in CI. Please verify during staging.

  • Block loads and renders in LMS (student view)
  • Block loads and renders in CMS course unit
  • Block loads and renders in CMS V2 Library
  • Course About page renders in LMS — AboutBlock still lives in html_block.py, now inheriting from xblocks_contrib.html.HtmlBlockMixin
  • Static Tabs render in LMS course navigation — same reason (StaticTabBlock)
  • Course Info/Updates tab renders in LMS — same reason (CourseInfoBlock)
  • HtmlBlockEditor (TinyMCE) loads in CMS course unit editor — the HtmlBlockEditor webpack bundle was intentionally retained

Automated checks (CI):

  • Run pytest xmodule/tests/test_html_block.pyCourseInfoBlockTestCase should pass
  • Run pytest lms/djangoapps/courseware/tests/test_block_render.py — no HtmlBlock import errors

@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

Copy link
Copy Markdown

Thanks for the pull request, @irfanuddinahmad!

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

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
Irfan Ahmad and others added 5 commits June 22, 2026 16:14
…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 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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 <noreply@anthropic.com>
@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
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). 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

3 participants