Skip to content

Fix: Properly decode <, >, and & in mindmap node labels #6406

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.

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

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

BambioGaming
Copy link

@BambioGaming BambioGaming commented Mar 22, 2025

📑 Summary

This pull request fixes a rendering bug in Mermaid mindmap diagrams where characters like <, >, and & were incorrectly displayed as &lt;, &gt;, and &amp; inside SVG elements.

This issue occurred because .text() in D3/SVG escapes HTML entities even when the decoded content is passed in. This PR addresses it by decoding these entities right before rendering.

Resolves #6396

📏 Design Decisions

Modified decodeEntities() function in utils.ts to replace common HTML entities (&lt;, &gt;, &amp;) with their correct characters.

Applied decodeEntities() immediately before inserting text content into <tspan> elements via .text() in the updateTextContentAndStyles() function of createText.ts.

This approach ensures that the final text rendered in the SVG node is accurate and unescaped while maintaining full safety.

Screenshots

Before
image

After
image

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Mar 22, 2025

⚠️ No Changeset found

Latest commit: 7776ce1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the Type: Bug / Error Something isn't working or is incorrect label Mar 22, 2025
Copy link

netlify bot commented Mar 22, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 7776ce1
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/67e2cfc9d358bd0008c0796c
😎 Deploy Preview https://deploy-preview-6406--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Mar 22, 2025

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6406
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6406
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6406
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6406

commit: 7776ce1

Copy link

codecov bot commented Mar 22, 2025

Codecov Report

Attention: Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.

Project coverage is 3.86%. Comparing base (936d107) to head (7776ce1).

Files with missing lines Patch % Lines
packages/mermaid/src/utils.ts 0.00% 7 Missing ⚠️
packages/mermaid/src/rendering-util/createText.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6406   +/-   ##
=======================================
  Coverage     3.86%   3.86%           
=======================================
  Files          412     411    -1     
  Lines        43189   43184    -5     
  Branches       664     664           
=======================================
  Hits          1670    1670           
+ Misses       41519   41514    -5     
Flag Coverage Δ
unit 3.86% <0.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
packages/mermaid/src/rendering-util/createText.ts 0.50% <0.00%> (ø)
packages/mermaid/src/utils.ts 17.89% <0.00%> (-0.20%) ⬇️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@BambioGaming BambioGaming deleted the bug/6396_mindmap-decode branch March 23, 2025 00:31
@BambioGaming BambioGaming restored the bug/6396_mindmap-decode branch March 23, 2025 00:32
@BambioGaming BambioGaming reopened this Mar 23, 2025
@BambioGaming BambioGaming reopened this Mar 23, 2025
Copy link

argos-ci bot commented Mar 25, 2025

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ⚠️ Changes detected (Review) 114 changed Mar 25, 2025, 4:01 PM

@BambioGaming BambioGaming force-pushed the bug/6396_mindmap-decode branch from 6360dd7 to d9335ea Compare March 25, 2025 15:44
@BambioGaming
Copy link
Author

I’ve confirmed that decodeEntities() is only used in mindmap rendering logic. Other diagram types are unaffected. The Argos visual changes are expected and limited to corrected rendering in mindmap node labels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect Rendering of < in Mindmap
1 participant