Repository navigation
Open
openedx/openedx-platform
#38745Description
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.pyexercised 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_BLOCKfromopenedx/envs/common.pyand all usages. - Remove the shim — delete
_BuiltInWordCloudBlockclass and thefrom xblocks_contrib.word_cloud import WordCloudBlock as _ExtractedWordCloudBlockimport fromxmodule/word_cloud_block.py. - Re-point the entrypoint — change
word_cloud = "xmodule.word_cloud_block:WordCloudBlock"inpyproject.tomltoword_cloud = "xblock_word_cloud:WordCloudBlock". The nameword_cloudstays 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 customwebpack.config.jsand D3 vendor libs) -
lms/templates/word_cloud.html(template) -
xmodule/static/css-builtin-blocks/WordCloudBlockDisplay.css(CSS) - Webpack entries
WordCloudBlockDisplay/WordCloudBlockEditorinwebpack.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.
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
- StatusShow more project fields🏗 In progress
Activity
irfanuddinahmad commentedon Jun 11, 2026
Implementation PR: openedx/openedx-platform#38745
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock
refactor: slash-and-burn Word Cloud BuiltIn XBlock