Skip to content

refactor: remove built-in Discussion XBlock implementation (slash-n-burn #37819) - #38749

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

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

Conversation

@irfanuddinahmad

@irfanuddinahmad irfanuddinahmad commented Jun 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Removes the built-in Discussion XBlock. xblock_discussion.DiscussionXBlock has been the default since USE_EXTRACTED_DISCUSSION_BLOCK = True, so the built-in code no longer runs.

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

Merge status: ✅ ready for review.
Known gaps: none. V2 Library checks don't apply, because discussion isn't an allowed library block type. lms/djangoapps/discussion/ (the forum app) is out of scope.
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: xmodule/discussion_block.py (built-in class + shim), xmodule/js/src/discussion/display.js, the built-in discussion entrypoint, and the USE_EXTRACTED_DISCUSSION_BLOCK toggle.

Modified: lms/djangoapps/courseware/management/commands/dump_course_structure.py and openedx/core/djangoapps/discussions/utils.py import DiscussionXBlock from xblock_discussion.

Tests:

Removed from the platform Counterpart in xblocks-core
xmodule/tests/test_discussion.py (4 tests) src/xblock_discussion/tests/: same names; 2 near-identical, 2 differ only in .format() vs f-string

Kept in the platform: lms/djangoapps/courseware/tests/test_discussion_xblock.py, which imports DiscussionXBlock from xblock_discussion.

Epic Step 1: Post-extraction commit review

Toggle flipped 2026-04-15 (c534f5754f). The 1 later commit is cosmetic (lint-amnesty). A legacy-attribute fix (d71f81312d) landed the day before the toggle; xblocks-core already has an equivalent fix (0dd64cd, 2026-04-02). 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: N/A, discussion isn't an allowed V2 library block type
  • dump_course_structure runs on a course with 3 Discussion blocks (exit 0, all listed)
  • CI: pytest lms/djangoapps/courseware/tests/test_discussion_xblock.py (18 passed locally), npm run build
V2 Library checklist: N/A (Discussion isn't offered in libraries)

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 — N/A: Discussion isn't offered in V2 libraries
  • L2. Edit → save → reload the page → reopen the editor: every field kept its value — N/A: Discussion isn't offered in V2 libraries
  • L3. Publish the component; its status changes to Published — N/A: Discussion isn't offered in V2 libraries
  • L4. Copy to clipboard from the library, then paste into the library and into a course unit — N/A: Discussion isn't offered in V2 libraries
  • 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) — N/A: Discussion isn't offered in V2 libraries
  • 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 — N/A: Discussion isn't offered in V2 libraries
  • L7. Sync: edit and publish in the library, then accept the update in the course and also ignore one — N/A: Discussion isn't offered in V2 libraries
  • L8. Override the title on the reused copy in the course — N/A: Discussion isn't offered in V2 libraries
  • L9. Library search: filtering by content type finds the block — N/A: Discussion isn't offered in V2 libraries
  • 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: import (inline and pointer tag) passes; Discussion exports inline, the same as the built-in (both put XBlock.add_xml_to_node first in the MRO)

Discussion-specific:

  • D1. If Discussion is offered in the library's Add menu, run L1–L6 with it and check that the inline discussion renders in the LMS; if it isn't offered, note that here — (not offered: discussion isn't in /api/libraries/v2/<lib>/block_types/)
  • D2. dump_course_structure still runs on a course containing a reused Discussion block — not ticked: a reused block isn't possible (D1); dump_course_structure passes on a course with 3 Discussion blocks

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/38749.

LMS student view (imported block) Studio course unit (authoring MFE)
lms_inline studio_unit
V2 library home (Discussion blocks forced in via the API) V2 library preview: 500, but Discussion isn't offered in libraries (API-forced, N/A)
library_home lib_preview
LMS student view (no library-reused copy: Discussion isn't a library type)
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 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-discussion-block branch from 291afe6 to 7649131 Compare June 11, 2026 12:52
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Jun 11, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-discussion-block branch 2 times, most recently from 12185a2 to ab31c37 Compare June 12, 2026 16:55
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-discussion-block branch from ab31c37 to 89e5060 Compare June 22, 2026 11:23
@irfanuddinahmad irfanuddinahmad changed the title feat: remove built-in Discussion XBlock implementation (slash-n-burn #37819) refactor: remove built-in Discussion XBlock implementation (slash-n-burn #37819) Jun 22, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-discussion-block branch from 89e5060 to 7b1e644 Compare November 4, 2026 11:07
@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 4 commits November 10, 2026 15:22
…urn #37819)

Removes xmodule/discussion_block.py, its JS assets, built-in unit tests,
the USE_EXTRACTED_DISCUSSION_BLOCK toggle, and the conflicting 'discussion'
entrypoint in pyproject.toml now that the extracted version in xblocks-contrib
is the only implementation. Updates production imports in dump_course_structure
and discussions/utils to import DiscussionXBlock from xblocks_contrib.discussion.

Note: lms/djangoapps/discussion/ Django app is NOT in scope for this removal.

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
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-discussion-block branch from 7b1e644 to ff56d3a Compare November 10, 2026 10:26

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

2 participants