Skip to content

fix: render empty Annotatable blocks instead of raising XMLSyntaxError - #324

Draft
irfanuddinahmad wants to merge 1 commit into
openedx:mainfrom
irfanuddinahmad:irfanuddinahmad/annotatable-empty-data
Draft

irfanuddinahmad wants to merge 1 commit into
openedx:mainfrom
irfanuddinahmad:irfanuddinahmad/annotatable-empty-data

Conversation

@irfanuddinahmad

Copy link
Copy Markdown
Contributor

Description

Fixes #323: a newly created Annotatable component in a Content Library V2 returns HTTP 500 on preview (XMLSyntaxError: Document is empty).

definition_from_xml maps a bare <annotatable/> to empty data; get_html() and _render_content() then called etree.fromstring(""). This PR parses data through a small helper, _get_xmltree(), that treats empty or whitespace-only data as an empty <annotatable/> element. That matches the built-in block, which rendered such blocks as empty content.

definition_from_xml itself is unchanged, because its empty-data branch is part of pointer-tag support (#118).

Testing

  • New tests in src/xblock_annotatable/tests/test_annotatable.py:
    • test_get_html_with_empty_data: "" and whitespace-only data render as <div/>, with no instructions.
    • test_bare_element_from_xml_renders: definition_from_xml(<annotatable/>) → get_html() succeeds (the library "create component" path).
  • Both new tests fail on main (XMLSyntaxError) and pass with the fix; the full Annotatable suite passes (12 passed).
  • ruff format --check and ruff check are clean.

Context

This blocks openedx/openedx-platform#38746 (removal of the built-in Annotatable block), because the built-in toggle is currently the only working fallback.

🤖 Generated with Claude Code

A bare <annotatable/>, which is what Content Libraries v2 creates for a
new Annotatable component, is stored with empty `data` by
definition_from_xml. get_html() and _render_content() then called
etree.fromstring("") and failed with "XMLSyntaxError: Document is
empty", so the library preview returned HTTP 500 until content was
saved. The built-in block rendered such blocks as empty content.

Parse through a helper that treats empty data as an empty
<annotatable/> element.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@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 Nov 11, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @irfanuddinahmad!

This repository is currently maintained by @openedx/axim-engineering.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

@irfanuddinahmad

Copy link
Copy Markdown
Contributor Author

Verified end-to-end on a local Tutor nightly (platform master + xblocks-core 2.0.0), creating a new Annotatable in a Content Library V2 and opening its preview (GET /api/xblock/v2/xblocks/<usage>/view/student_view/):

xblock_annotatable/block.py preview
main (before) 500 (XMLSyntaxError: Document is empty)
this PR 200
main restored 500

| Generated using Claude Code

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). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

Annotatable: newly created empty block in a Content Library V2 fails to render (XMLSyntaxError: Document is empty)

2 participants