fix: getMessageAPI so it considers entity codes

[ad1992]

fixes #4983

📑 Summary

This issue is reproducible when using the API diagram.parser.yy.getMessages or diagram.db.getMessages API directly eg in test since the entity codes are not handled in getDiagramFromText API.

In mermaid it was working fine since the entity codes were being handled before calling the API getDiagramFromText hence I have removed that and instead handling it inside the function getDiagramFromText.
I hope this should be acceptable and I have added test as well for the same.

Resolves #4983

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.
Already explained above

📋 Tasks

Already explained above

As per the lint rule failing for circular deps, I think we can move the util encodeEntities to packages/mermaid/src/utils.ts since now its a reusable common util. let me know If I should move the util.

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.
• 🔖 targeted develop branch

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	dff1343
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/65488c217ada750008840a5d
😎 Deploy Preview	https://deploy-preview-5002--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[codecov]

Codecov Report

Merging #5002 (dff1343) into develop (f5bd1e0) will decrease coverage by 0.02%.
The diff coverage is 71.05%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #5002      +/-   ##
===========================================
- Coverage    79.37%   79.35%   -0.02%     
===========================================
  Files          164      164              
  Lines        13820    13842      +22     
  Branches       693      693              
===========================================
+ Hits         10969    10984      +15     
- Misses        2702     2709       +7     
  Partials       149      149              

Flag	Coverage Δ
e2e	85.26% <100.00%> (+0.03%)	⬆️
unit	42.88% <35.13%> (-0.06%)	⬇️

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

Files	Coverage Δ
packages/mermaid/src/Diagram.ts	74.35% <100.00%> (+0.67%)	⬆️
packages/mermaid/src/dagre-wrapper/createLabel.js	92.85% <ø> (ø)
packages/mermaid/src/dagre-wrapper/shapes/util.js	96.22% <ø> (ø)
packages/mermaid/src/mermaidAPI.ts	78.73% <ø> (-1.27%)	⬇️
packages/mermaid/src/rendering-util/createText.ts	88.50% <ø> (ø)
packages/mermaid/src/utils.ts	64.18% <70.27%> (+0.25%)	⬆️

... and 2 files with indirect coverage changes

[ad1992]

@sidharthv96 can you take a look at the PR and share your insights 🙏

[sidharthv96]

Happy to see tests!
If moving to constructor and splitting the functions to a different file doesn't cause issues, it should be good to go.

Also, curious to know the usecase for directly accessing the inner functions.
These could break in a while as we switch to a new internal architecture.

[ad1992]

Also, curious to know the usecase for directly accessing the inner functions.
These could break in a while as we switch to a new internal architecture.

In Excalidraw we are adding support for mermaid hence using these internal function to get the diagram data from text.

[ad1992]

@sidharthv96 I have made the changes, however I am not sure what docs I am suppose to update (its throwing lint error), could you guide me here ? Thanks!

[sidharthv96]

Please move the encode entities function invocation into the diagram constructor.

[sidharthv96]

@ad1992 you can run pnpm --filter mermaid run docs:build to fix the docs.

[ad1992]

@sidharthv96 made the changes, the PR should be good to go!

[sidharthv96]

Thanks @ad1992!

[mermaid-bot]

@ad1992, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.