fix(mermaid): use XMLSerializer to produce valid SVG/XML on download#517
Open
sleitor wants to merge 1 commit into
Open
fix(mermaid): use XMLSerializer to produce valid SVG/XML on download#517sleitor wants to merge 1 commit into
sleitor wants to merge 1 commit into
Conversation
Mermaid renders diagrams via innerHTML which causes the browser to normalize elements like <br /> to their HTML void form (<br>), making the raw SVG string invalid XML. Saving that string as .svg or converting it to PNG via an <img>/canvas both fail on that input. Add sanitizeSvgForExport() which re-parses the SVG through a temporary DOM node and re-serializes with XMLSerializer.serializeToString(), producing a well-formed XML document. Both the SVG download path and the PNG conversion path now sanitize before use. Fixes vercel#516
Contributor
|
@sleitor is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Mermaid renders diagrams via
innerHTML, which allows the browser to normalize elements like<br />to their HTML void form (<br>). Saving that raw string as an SVG file fails because SVG/XML parsers reject the non-self-closing element, and PNG conversion via canvas also fails since the<img>cannot load invalid XML SVG.Reported in #516.
Fix
Add
sanitizeSvgForExport()inlib/mermaid/utils.tsthat:<div>.innerHTML<svg>element withXMLSerializer.serializeToString(), producing a well-formed XML documentBoth the SVG download path and the PNG conversion path in
download-button.tsxnow sanitize the SVG string before use.Tests
<br>element case in bothmermaid-download.test.tsxandmermaid-utils.test.tsFixes #516