Annotatable: newly created empty block in a Content Library V2 fails to render (XMLSyntaxError: Document is empty)
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 65/100
Direzione di ricerca
Start with AnnotatableBlock.definition_from_xml and get_html() in xblock_annotatable/block.py, then inspect _render_content() and the existing tests around empty block data. Reproduce the preview failure with an empty Annotatable and check the related OLX serialization path. Done when empty blocks render without the XMLSyntaxError and regression tests cover rendering and serialization.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
A newly created Annotatable component in a Content Library V2 can't be previewed: the preview returns HTTP 500 until content is saved into it.
Found while smoke-testing openedx/openedx-platform#38746 (removal of the built-in Annotatable block) on a local Tutor nightly (platform master + xblocks-core 2.0.0).
Steps to reproduce
- In a V2 library, create a new Annotatable component through the REST API (
POST /api/libraries/v2/<lib>/blocks/with{"block_type": "annotatable", ...}). Its OLX is<annotatable />. - Open its preview (
GET /api/xblock/v2/xblocks/<usage_key>/view/student_view/).
Actual
xblock_annotatable/block.py:183 get_html
-> etree.fromstring(self.data)
lxml.etree.XMLSyntaxError: Document is empty, line 1, column 1
Correction (2026-11-11): an earlier version of this issue said the authoring MFE's "New → Advanced → Annotation" menu creates such a block. That's wrong:
annotatableisn't in the library's allowed block types (GET /api/libraries/v2/<lib>/block_types/), so the library UI doesn't offer it. The empty block is reachable through the REST API (above) and, verified, through course OLX import: a course whoseannotatable/<url_name>.xmlis a bare<annotatable></annotatable>imports fine but then returns HTTP 500 in the LMS.
Cause
AnnotatableBlock.definition_from_xml maps a bare <annotatable/> to data="" (the empty-data branch added with pointer-tag support in #118). get_html() and _render_content() then call etree.fromstring("").
The built-in block (_BuiltInAnnotatableBlock on platform master) uses RawMixin.definition_from_xml, which always serializes the node, so it stored "<annotatable/>" and rendered an empty annotatable. Platform master already defaults to the extracted block, so the built-in toggle is currently the only working fallback, and #38746 removes it.
Related, not yet verified
With empty data, definition_to_xml returns None ("Could not serialize ..."). An empty Annotatable may therefore be dropped on OLX export, where the built-in exported <annotatable/>.
Fix
Draft PR to follow: parse data through a helper that treats empty data as an empty <annotatable/> element, plus regression tests.
| Generated using Claude Code
- Lingua principale
- JavaScript
- Stelle
- 0
- Fork
- 19
- Merge medio
- 8h
- PR unite (30g)
- 7
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openedx/xblocks-core
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 84/100
openedx/xblocks-core#305 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 43/100
openedx/xblocks-core#332 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 75/100
openedx/xblocks-core#326 ·
I maintainer di solito rispondono entro 1 giorno
-
ChoiceTextResponse: a submission that omits a required numtolerance_input key is graded correctAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 65/100
openedx/xblocks-core#306 ·
I maintainer di solito rispondono entro 1 giorno
-
WCAG - Question Content Not Programmatically Associated With Answer ChoicesForse di nuovo libera @jesusbalderramawgu l’ha presa 66 giorni fa e non c’è nessuna pull request aperta. Aperta
openedx/xblocks-core#300 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di openedx/xblocks-core
Issue simili
-
marketing
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
enhancement good first issue severity: low
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
TMHSDigital/Static_Chess#163 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug] Account menu (footer ⚙) doesn't dismiss on outside click — stays open and covers the Bot listAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
Fei2411/DeepSeek-Bot#1693 ·
-
area-templates triage:bot-seen triage:needs-human
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/aspire#22356 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno