Skip to content

Fix: Prevent Duplicate Instructions Rendering in Annotatable XBlock #36445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kdmccormick merged 1 commit into from
Apr 10, 2025
Merged

Fix: Prevent Duplicate Instructions Rendering in Annotatable XBlock #36445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions xmodule/annotatable_block.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,8 @@ def _render_content(self):
""" Renders annotatable content with annotation spans and returns HTML. """

xmltree = etree.fromstring(self.data)
content = etree.tostring(xmltree, encoding='unicode')
self._extract_instructions(xmltree)

xmltree = etree.fromstring(content)
xmltree.tag = 'div'
if 'display_name' in xmltree.attrib:
del xmltree.attrib['display_name']
Expand Down
8 changes: 8 additions & 0 deletions xmodule/tests/test_annotatable_block.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,11 @@ def test_extract_instructions(self):
xmltree = etree.fromstring('<annotatable>foo</annotatable>')
actual = self.annotatable._extract_instructions(xmltree) # lint-amnesty, pylint: disable=protected-access
assert actual is None

def test_instruction_removal(self):
xmltree = etree.fromstring(self.sample_xml)
instructions = self.annotatable._extract_instructions(xmltree) # pylint: disable=protected-access

assert instructions is not None
assert "Read the text." in instructions
assert xmltree.find("instructions") is None
Loading