fix: mermaid racing conditions when multiple diagrams are present#1385
Open
fix: mermaid racing conditions when multiple diagrams are present#1385
Conversation
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.
🧰 Changes
Pages with multiple mermaid diagrams would intermittently render broken on refresh. Two or more diagrams would overlap into the same
<pre>element while another would be empty.The root cause is mermaid's ID generation. It uses
Date.now()to generate SVG IDs, and when multiple diagrams are processed in the same millisecond they get identical IDs. Since mermaid usesdocument.getElementById()to clean up before rendering, a duplicate ID causes it to delete the wrong SVG from the DOM.Previously, each CodeTabs instance called
mermaid.run()independently with all mermaid nodes on the page. Now mermaid nodes are batched into a singlemermaid.run()call using asetTimeout(0)to collect all nodes from the same render cycle. Combined withdeterministicIds: true, this gives every diagram in the batch a unique ID.🧬 QA & Testing
https://www.loom.com/share/376c0ae07c0142d083a6cadf99889e9f
Add multiple mermaid charts in a doc and refresh multiple times