leanprover / leanprover/lean4

ToString instance for Xml does not correctly escape

Open Beginner friendly
#4,411 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug P-low
Dominant language
Lean
Stars
9.2k
Forks
990
Avg merge
1d 17h
Merged PRs (30d)
175

Description

Prerequisites

Please put an X between the brackets as you perform the following steps:

Description

While the XML parser correctly handles XML escape sequences, the stringifier does not emit them.

Context

Zulip thread. This leads to some mangled markdown in doc-gen, which unknowingly tries to work around this bug.

Steps to Reproduce

Run the following:

import Lean

run_cmd do
  let .ok doc := Lean.Xml.parse "<b class=\"&quot;\">hello &lt; world </b>" | unreachable!
  Lean.logInfo (toString doc)

Expected behavior: The output is <b class="&quot;">hello &lt; world </b>

Actual behavior: The output is <b class=""">hello < world </b>, which is invalid XML

Versions

4.9.0-rc1
4.10.0-nightly-2024-06-09

Additional Information

[Additional information, configuration or data that might be necessary to reproduce the issue]

Impact

Add 👍 to issues you consider important. If others are impacted by this issue, please ask them to add 👍 to it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the supplied Lean.Xml.parse and toString reproduction, then locate the Lean.Xml stringifier and compare it with the parser's escape handling. Done means toString emits valid XML with quotes and angle brackets escaped as shown in the expected output, without breaking the reported doc-gen use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
compilers
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.