Skip to content

refactor: slash-and-burn Annotatable BuiltIn XBlock - #38746

Open
irfanuddinahmad wants to merge 4 commits into
masterfrom
irfanuddinahmad/slash-and-burn-annotatable-block
Open

refactor: slash-and-burn Annotatable BuiltIn XBlock#38746
irfanuddinahmad wants to merge 4 commits into
masterfrom
irfanuddinahmad/slash-and-burn-annotatable-block

Conversation

@irfanuddinahmad

@irfanuddinahmad irfanuddinahmad commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Removes the built-in Annotatable XBlock and all associated assets. The extracted xblocks_contrib.annotatable.AnnotatableBlock has been the active implementation since USE_EXTRACTED_ANNOTATABLE_BLOCK = True.

Step 3 of 8 in the Slash-n-Burn Built-In XBlocks epic.

Closes openedx/public-engineering#535

Note: xmodule/annotator_mixin.py is intentionally kept — it is still used by cms/djangoapps/contentstore/courseware_index.py and xmodule/util/misc.py for the html_to_text utility function and is not part of this removal.

Changes

  • Remove USE_EXTRACTED_ANNOTATABLE_BLOCK toggle from openedx/envs/common.py
  • Remove conflicting built-in annotatable entrypoint from pyproject.toml (the xblocks-contrib entrypoint remains active)
  • Delete xmodule/annotatable_block.py
  • Delete xmodule/js/src/annotatable/display.js, JS spec, and HTML fixture
  • Delete lms/templates/annotatable.html
  • Delete xmodule/static/css-builtin-blocks/AnnotatableBlock{Display,Editor}.css
  • Remove AnnotatableBlockDisplay / AnnotatableBlockEditor webpack entries
  • Delete xmodule/tests/test_annotatable_block.py
  • Update stale AnnotatableBlock reference in xblock_serializer/utils.py docstring

Epic Step 1: Post-extraction commit review

Reviewed commits to xmodule/annotatable_block.py after USE_EXTRACTED_ANNOTATABLE_BLOCK was set to True (2025-12-16 · 24cb3cf9f5). All 4 post-toggle commits were cosmetic: deprecation markers (#38174), 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

Automated checks (CI):

  • Run xmodule unit tests: pytest xmodule/tests/
  • Confirm webpack build succeeds: npm run build
  • Confirm annotator_mixin.html_to_text still works (used by search indexing)

@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.

@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
@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-annotatable-block branch from cdd06dc to 4755121 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-annotatable-block branch from 47349ab to f7e929e Compare June 12, 2026 11:52
Irfan Ahmad and others added 2 commits June 12, 2026 21:55
Removes the built-in Annotatable XBlock and all associated assets now
that USE_EXTRACTED_ANNOTATABLE_BLOCK has been True. Keeps
xmodule/annotator_mixin.py as it is still used by
cms/djangoapps/contentstore/courseware_index.py and xmodule/util/misc.py.

- Remove USE_EXTRACTED_ANNOTATABLE_BLOCK toggle from common.py
- Remove annotatable entrypoint from pyproject.toml
- Delete xmodule/annotatable_block.py (built-in class + shim)
- Delete xmodule/js/src/annotatable/display.js
- Delete xmodule/js/spec/annotatable/display_spec.js and fixture
- Delete lms/templates/annotatable.html
- Delete xmodule/static/css-builtin-blocks/AnnotatableBlock{Display,Editor}.css
- Remove AnnotatableBlockDisplay/AnnotatableBlockEditor webpack entries
- Delete xmodule/tests/test_annotatable_block.py
- Update docstring in xblock_serializer/utils.py to remove stale reference

Closes openedx/public-engineering#535

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-annotatable-block branch from f7e929e to 92d60da Compare June 12, 2026 16:55
The AnnotatableBlockDisplay webpack entry (and the annotatable/display.js
file itself) are deleted in this PR. The corresponding imports-loader rule
in webpack.common.config.js was left behind; remove it for consistency
with how Poll, WordCloud, and LTI PRs handle their own rule cleanup.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@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 Annotatable BuiltIn XBlock

3 participants