Skip to content

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

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

irfanuddinahmad wants to merge 5 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. xblock_annotatable.AnnotatableBlock has been the default since USE_EXTRACTED_ANNOTATABLE_BLOCK = True, so the built-in code no longer runs.

Step 3 of 8 of the Slash-n-Burn Built-In XBlocks epic. Closes openedx/public-engineering#535

Merge status: ⏸️ on hold until openedx/xblocks-core#323 is fixed (fix PR: openedx/xblocks-core#324) and released into the platform requirements.
A new, empty Annotatable in a V2 Library returns a 500 on preview in the extracted block (XMLSyntaxError: Document is empty). The built-in block renders it, so this PR would remove the only working fallback. The fix in #324 was verified locally (500 → 200 in Studio and the LMS).
Also waiting on openedx/xblocks-core#319, which moves the JS spec deleted here.
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. Its JS strings also need i18n_js_namespace (review on #329).

Changes

Deleted: xmodule/annotatable_block.py, xmodule/js/src/annotatable/display.js, lms/templates/annotatable.html, AnnotatableBlock{Display,Editor}.css, the AnnotatableBlockDisplay/AnnotatableBlockEditor webpack entries, the built-in annotatable entrypoint, and the USE_EXTRACTED_ANNOTATABLE_BLOCK toggle.

Kept: xmodule/annotator_mixin.py, because cms/djangoapps/contentstore/courseware_index.py and xmodule/util/misc.py still use its html_to_text.

Modified: a stale AnnotatableBlock reference in the xblock_serializer/utils.py docstring.

Tests:

Removed from the platform Counterpart in xblocks-core
xmodule/tests/test_annotatable_block.py (9 tests) src/xblock_annotatable/tests/test_annotatable.py: same names, near-identical bodies (compared one by one)
xmodule/js/spec/annotatable/display_spec.js + fixture (Annotatable › constructor › works) moved in openedx/xblocks-core#319 (adds the Annotatable karma setup)

Kept in the platform: none needed (no platform-integration tests for this block).

Epic Step 1: Post-extraction commit review

Toggle flipped 2025-12-16 (24cb3cf9f5). All 4 later commits to annotatable_block.py are cosmetic (deprecation markers #38174, 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.

V2 Library checklist: 8/11 pass (L1 empty-block 500, L10 export diff not done, A1 popups not checked)

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 — not ticked: empty block → 500 (Fix LMS-530: Reflected XSS in chapter and page numbers #323); with content the preview renders
  • 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

Annotatable-specific:

  • A1. The library preview and the LMS view of the reused copy show annotations and their popups (they need the kept html/display.js / imageModal.js) — not ticked: annotation spans and bodies render in the LMS; the popups (JS) on the library preview and reused copy weren't checked

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

5 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/38746.

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)
lms_reused

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

@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 2 times, most recently from f7e929e to 92d60da Compare June 12, 2026 16:55
@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-annotatable-block branch from 279fc61 to 4384a6f 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
irfanuddinahmad added a commit to irfanuddinahmad/xblocks-core that referenced this pull request Nov 10, 2026
Adds a karma/jasmine setup for the Annotatable XBlock (mirroring the
existing Problem/Discussion/Video setups) and ports
xmodule/js/spec/annotatable/display_spec.js with its fixture, which
openedx/openedx-platform#38746 removes along with the built-in block.

The test name, fixture and logic are unchanged; only the initializer call
is adapted to the extracted block's Annotatable(runtime, element), and a
no-op $.fn.qtip stub replaces the globally loaded qTip vendor plugin.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Irfan Ahmad and others added 5 commits November 10, 2026 13:14
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 <[email protected]>
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 <[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.video.video -> xblock_video.block).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@irfanuddinahmad

Copy link
Copy Markdown
Contributor Author

Holding this PR until openedx/xblocks-core#323 is fixed (fix PR: openedx/xblocks-core#324).

While smoke-testing on a local Tutor nightly (platform master + xblocks-core 2.0.0) I found that a newly created, empty Annotatable in a Content Library V2 returns HTTP 500 on preview:

  • The extracted definition_from_xml stores a bare <annotatable/> as data="", and get_html() then fails on etree.fromstring("") with XMLSyntaxError: Document is empty.
  • The built-in block this PR deletes uses RawMixin, which stores "<annotatable/>" and renders an empty annotatable.

Master already defaults to the extracted block, so master has this bug today. USE_EXTRACTED_ANNOTATABLE_BLOCK = False is the only working fallback, and this PR removes it.

Everything else in the test plan passed locally:

  • pytest xmodule/tests/ gave 719 passed, including test_annotator_mixin.py::test_html_to_text. The single failure (test_video.py::VideoBlockIndexingTestCase::test_video_with_multiple_transcripts_index_dictionary) also fails on master in this environment.
  • CI static-assets-check (npm run build) passed.
  • Smoke checks: 20/21 passed. That covers OLX import (inline and pointer tag), Studio preview and editor, LMS render with annotations, and all library flows with content (publish, copy/paste, units, reuse in a course, sync accept and ignore, title override, search, OLX export).

I'll remove the hold once #324 is merged and released into the platform requirements.

| Generated using Claude Code

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 Annotatable BuiltIn XBlock

2 participants