Skip to content

refactor: slash-and-burn Poll BuiltIn XBlock#38744

Open
irfanuddinahmad wants to merge 2 commits into
masterfrom
irfanuddinahmad/slash-and-burn-poll-block
Open

refactor: slash-and-burn Poll BuiltIn XBlock#38744
irfanuddinahmad wants to merge 2 commits into
masterfrom
irfanuddinahmad/slash-and-burn-poll-block

Conversation

@irfanuddinahmad

@irfanuddinahmad irfanuddinahmad commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Removes the built-in Poll XBlock and all associated assets. The extracted xblocks_contrib.poll.PollBlock has been the default since USE_EXTRACTED_POLL_QUESTION_BLOCK was set to True, so the built-in implementation is now dead code.

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

Closes openedx/public-engineering#533

Changes

  • Remove USE_EXTRACTED_POLL_QUESTION_BLOCK toggle from openedx/envs/common.py
  • Remove conflicting built-in poll_question entrypoint from pyproject.toml (the xblocks-contrib entrypoint remains active)
  • Delete xmodule/poll_block.py (built-in class + shim)
  • Delete xmodule/js/src/poll/ (JS assets)
  • Delete lms/templates/poll.html
  • Delete xmodule/static/css-builtin-blocks/PollBlockDisplay.css
  • Remove PollBlockDisplay / PollBlockEditor webpack entries from webpack.builtinblocks.config.js and webpack.common.config.js
  • Delete xmodule/tests/test_poll.py (covered by xblocks-contrib tests)

Epic Step 1: Post-extraction commit review

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

⚠️ Scope of the checks above, and why merging should wait on xblocks-core#274:

  • The LMS and CMS course unit checks confirm rendering only, via content authored through raw OLX import — the normal "Add Component → Edit" flow for this block doesn't work at all, for anyone, in courses or libraries. xblocks_contrib.poll.PollBlock has no studio_view (unlike every other extracted block).
  • CMS V2 Library is unchecked, and not just because it's untested: any Poll block created directly in a library (the standard, empty-first creation flow) becomes permanently unloadable — confirmed by reproducing the crash against the real block class. It's not a matter of testing harder; that flow is broken.

Both issues predate this PR (they're gaps in the xblocks-contrib extraction), but this PR removes the last working fallback (the built-in block's editor) for them. Recommend holding merge until xblocks-core#274 is resolved — same pattern as the Word Cloud PR being gated on xblocks-core#273.

Screenshots on sandbox

CMS
image

LMS
image

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

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-poll-block branch from f3724d8 to 83ca0c7 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-poll-block branch 2 times, most recently from dd15236 to 155ae51 Compare June 12, 2026 16:55
Irfan Ahmad and others added 2 commits July 7, 2026 14:36
Removes the built-in Poll XBlock implementation and all associated assets
now that the extracted `xblocks_contrib.poll.PollBlock` is the default
(USE_EXTRACTED_POLL_QUESTION_BLOCK has been True since extraction).

- Remove USE_EXTRACTED_POLL_QUESTION_BLOCK toggle from common.py
- Remove poll_question entrypoint from pyproject.toml
- Delete xmodule/poll_block.py (built-in class + shim)
- Delete xmodule/js/src/poll/ (JS assets)
- Delete lms/templates/poll.html
- Delete xmodule/static/css-builtin-blocks/PollBlockDisplay.css
- Remove PollBlockDisplay/PollBlockEditor webpack entries
- Delete xmodule/tests/test_poll.py (covered by xblocks-contrib)

Closes openedx/public-engineering#533

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@irfanuddinahmad irfanuddinahmad added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jul 7, 2026
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-poll-block branch from 155ae51 to ec54976 Compare July 7, 2026 09:37
@irfanuddinahmad
irfanuddinahmad marked this pull request as draft July 7, 2026 11:57
@irfanuddinahmad

irfanuddinahmad commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Found two real blockers to merging this while testing poll_question in the sandbox — full detail and reproduction steps tracked in openedx/xblocks-core#274:

  1. No Studio editing view. xblocks_contrib.poll.PollBlock only defines student_view — no studio_view, unlike every other extracted block (Video/Annotatable/Word Cloud/HTML/LTI/Discussion all have one). Opening "Edit" on a poll_question block fails client-side (edit_xblock.js: xblockElement is empty or not defined).

  2. Empty Poll blocks are permanently unloadable in Content Libraries v2. definition_from_xml hard-fails if there are zero <answer> tags. That check is meant to run once at course-import time, but under Content Libraries v2's Learning Core runtime it re-runs on every load — so any Poll created via the normal "Add Component" flow (always empty at first) can never be loaded again, by anyone, for any reason. Confirmed by reproducing against the real block class in a local devstack.

This PR shouldn't merge until both are resolved in xblocks-core.

Updated the test plan checkboxes above with a note on what the LMS/CMS checks actually cover (rendering, via an OLX-import workaround, since the normal editor is broken) and why CMS V2 Library stays unchecked — it's not a matter of testing harder, that flow is broken for any Poll created directly in a library.

@irfanuddinahmad
irfanuddinahmad marked this pull request as ready for review July 8, 2026 06:40
@mphilbrick211 mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Jul 13, 2026
@mphilbrick211 mphilbrick211 added needs reviewer assigned PR needs to be (re-)assigned a new reviewer and removed needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels 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). 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 Poll BuiltIn XBlock

3 participants