Skip to content

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

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

irfanuddinahmad wants to merge 6 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. xblock_poll_question.PollBlock has been the default since USE_EXTRACTED_POLL_QUESTION_BLOCK = True, so the built-in code no longer runs.

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

Merge status: ✅ ready for review.
Known gaps (pre-existing, not regressions): Poll has no Studio editor, and V2 Libraries can't load a Poll block. The built-in block has the same two gaps, so removing it takes away no working fallback. Follow-up: openedx/xblocks-core#274.
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/poll_block.py (built-in class + shim), xmodule/js/src/poll/, lms/templates/poll.html, PollBlockDisplay.css, the PollBlockDisplay/PollBlockEditor webpack entries, the built-in poll_question entrypoint, and the USE_EXTRACTED_POLL_QUESTION_BLOCK toggle.

Tests:

  • Kept: xmodule/tests/test_poll.py now runs against xblock_poll_question.PollBlock. Only the BuiltIn twin class and the toggle override were dropped; xblocks-core has no equivalent of these tests.
  • Removed: none.

Epic Step 1: Post-extraction commit review

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

LMS and CMS content was authored through an OLX import, because Poll has no editor.

V2 Library checklist: 2/12 pass, the rest blocked by xblocks-core#274

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: 500, see above
  • L2. Edit → save → reload the page → reopen the editor: every field kept its value — blocked by L1
  • 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 — not ticked: course → course paste works; course → library paste can't be loaded (L1)
  • 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 — blocked by L1
  • L7. Sync: edit and publish in the library, then accept the update in the course and also ignore one — blocked by L1
  • L8. Override the title on the reused copy in the course — blocked by L1
  • L9. Library search: filtering by content type finds the block — blocked by L1
  • 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

Poll-specific (see the openedx/xblocks-core#274 note below):

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.

Why xblocks-core#274 isn't a merge blocker

Re-checking the built-in code on master (547da6f6a5) shows it has the same two gaps:

  1. No working editor. _BuiltInPollBlock inherits studio_view from MakoTemplateBlockBase (xmodule/mako_block.py), which renders self.mako_template. Nothing in Poll's class chain sets mako_template, so opening Edit on the built-in block raises AttributeError. The PollBlockEditor webpack entry only bundles xmodule.js, so there's no editor JS either.
  2. Same library loading failure. The built-in definition_from_xml raises ValueError("Poll_question definition must include at least one 'answer' tag") for an empty Poll, exactly like the extracted block, and the V2 library runtime falls back to XBlock.parse_xml for Polls with answers in both.

Setting USE_EXTRACTED_POLL_QUESTION_BLOCK = False would therefore not restore editing or library loading. This conclusion comes from reading the code; a runtime check against the built-in block can be done on a sandbox once sandbox deployments work again.

Screenshots

7 screenshots (LMS, Studio unit, V2 Library)

Earlier sandbox deployment

CMS
image

LMS
image

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

LMS student view (imported block) Studio course unit (authoring MFE)
lms_inline studio_unit
V2 library home V2 library preview: 500 (pre-existing loader gap, openedx/xblocks-core#274)
library_home lib_preview
LMS student view (no library-reused copy possible; see openedx/xblocks-core#274)
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-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
@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
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-poll-block branch from 1221a7c to b6cebd6 Compare November 4, 2026 11:24
Irfan Ahmad and others added 5 commits November 10, 2026 12:56
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 <[email protected]>
These tests already exercised the extracted block (via
USE_EXTRACTED_POLL_QUESTION_BLOCK=True) and have no equivalent in
xblocks-core, so keep them instead of deleting them. Only the
BuiltIn variant and the toggle override are dropped; test names and
logic are unchanged.

Co-Authored-By: Claude Opus 5.5 <[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.poll -> xblock_poll_question).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@irfanuddinahmad
irfanuddinahmad force-pushed the irfanuddinahmad/slash-and-burn-poll-block branch from 6ecad1d to d6cc318 Compare November 10, 2026 10:25
@irfanuddinahmad irfanuddinahmad added create-sandbox open-craft-grove should create a sandbox environment from this PR and removed create-sandbox open-craft-grove should create a sandbox environment from this PR labels Nov 11, 2026

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

3 participants