Skip to content

[Refactor] Slash-n-Burn Word Cloud BuiltIn XBlock #534

Open
openedx/openedx-platform
#38745

Description

@irfanuddinahmad

See parent epic: openedx/openedx-platform#37819


Rollout Position

Step 2 of 8 — Small footprint (~837 LOC). Has a custom webpack config (xmodule/assets/word_cloud/webpack.config.js) that needs to be cleaned up alongside the main webpack.builtinblocks.config.js entries.


Block Details

Toggle USE_EXTRACTED_WORD_CLOUD_BLOCK in openedx/envs/common.py
Shim class _BuiltInWordCloudBlock in xmodule/word_cloud_block.py
Entrypoint word_cloud = "xmodule.word_cloud_block:WordCloudBlock" in pyproject.toml

Checklist

Pre-condition

  • Review PRs merged into the built-in Word Cloud XBlock code in edx-platform after the extraction work was done — port any bug fixes or improvements to xblocks-contrib if not already there.

Review surfaced a real gap: xmodule/tests/test_word_cloud.py / lms/djangoapps/courseware/tests/test_word_cloud.py exercised Studio-editor-save and OLX-import/export scenarios against the extracted block that had no equivalent coverage in xblocks-contrib. Porting is in progress in openedx/xblocks-core#273 (open, not yet merged). Leaving this unchecked until that PR lands.

Steps (single PR)

  • Remove the toggle — delete USE_EXTRACTED_WORD_CLOUD_BLOCK from openedx/envs/common.py and all usages.
  • Remove the shim — delete _BuiltInWordCloudBlock class and the from xblocks_contrib.word_cloud import WordCloudBlock as _ExtractedWordCloudBlock import from xmodule/word_cloud_block.py.
  • Re-point the entrypoint — change word_cloud = "xmodule.word_cloud_block:WordCloudBlock" in pyproject.toml to word_cloud = "xblock_word_cloud:WordCloudBlock". The name word_cloud stays in the platform, because xblocks-core only registers _word_cloud_extracted (for testing).
  • Remove remaining assets:
    • xmodule/word_cloud_block.py (Python class)
    • xmodule/assets/word_cloud/ (entire directory, including custom webpack.config.js and D3 vendor libs)
    • lms/templates/word_cloud.html (template)
    • xmodule/static/css-builtin-blocks/WordCloudBlockDisplay.css (CSS)
    • Webpack entries WordCloudBlockDisplay / WordCloudBlockEditor in webpack.builtinblocks.config.js
  • Run smoke tests on the extracted Word Cloud block to verify nothing is broken. Done on a local Tutor nightly stack: LMS, CMS course unit and V2 Library all pass (22/22). Results are in the PR description.

Activity

  1. irfanuddinahmad commented on Jun 11, 2026

    @irfanuddinahmad
    Author
  2. added 3 commits that reference this issue on Jun 11, 2026
    ed55494
    1b7be5a
    f84351d
  3. moved this to 👀 In review in Aximprovements Teamon Jun 24, 2026
  4. added a commit that references this issue on Jul 3, 2026
    5233a68
  5. moved this from 👀 In review to 🏗 In progress in Aximprovements Teamon Jul 6, 2026
  6. added a commit that references this issue on Jul 6, 2026
    4783f19
  7. moved this from 🏗 In progress to 👀 In review in Aximprovements Teamon Jul 7, 2026
  8. moved this from 👀 In review to 🏗 In progress in Aximprovements Teamon Jul 9, 2026
  9. moved this from 🏗 In progress to 🔖 Ready in Aximprovements Teamon Jul 13, 2026
  10. added 2 commits that reference this issue on Nov 4, 2026
    ac7423f
    cdf9547
  11. moved this from 🔖 Ready to 🏗 In progress in Aximprovements Teamon Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions