Various Mermaid improvements (#18776) (#18780)

silverwind · lunny · web-flow · commit 1f7802db97c8 · 2022-02-16T17:26:53.000+08:00
* Various Mermaid improvments

- Render into iframe for improved security
- Use built-in dark theme instead of color inversion
- Remove flexbox attributes, resulting in more consistent size rendering
- Update API usage and update to latest version

* restart ci

* misc tweaks

* remove unneccesary declaration

* make it work without allow-same-origin, add loading=lazy

* remove loading attribute, does not seem to work

* rename variable

* skip roundtrip to DOM for rendering

* don't guess chart height

* update comment to make it clear it's intentional

* tweak

* replace deprecated 'scrolling' property

* remove unused css file

Co-authored-by: Lunny Xiao &lt;xiaolunwen@gmail.com&gt;

Co-authored-by: Lunny Xiao &lt;xiaolunwen@gmail.com&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
     "less": "4.1.2",
     "less-loader": "10.2.0",
     "license-checker-webpack-plugin": "0.2.1",
-    "mermaid": "8.13.10",
+    "mermaid": "8.14.0",
     "mini-css-extract-plugin": "2.5.2",
     "monaco-editor": "0.31.1",
     "monaco-editor-webpack-plugin": "7.0.1",
diff --git a/web_src/js/markup/mermaid.js b/web_src/js/markup/mermaid.js
@@ -1,5 +1,11 @@
+import {isDarkTheme} from '../utils.js';
 const {mermaidMaxSourceCharacters} = window.config;
 
+const iframeCss = `
+  body {margin: 0; padding: 0}
+  #mermaid {display: block; margin: 0 auto}
+`;
+
 function displayError(el, err) {
   el.closest('pre').classList.remove('is-loading');
   const errorNode = document.createElement('div');
@@ -15,26 +21,22 @@ export async function renderMermaid() {
   const {default: mermaid} = await import(/* webpackChunkName: "mermaid" */'mermaid');
 
   mermaid.initialize({
-    mermaid: {
-      startOnLoad: false,
-    },
-    flowchart: {
-      useMaxWidth: true,
-      htmlLabels: false,
-    },
-    theme: 'neutral',
+    startOnLoad: false,
+    theme: isDarkTheme() ? 'dark' : 'neutral',
     securityLevel: 'strict',
   });
 
   for (const el of els) {
-    if (mermaidMaxSourceCharacters >= 0 && el.textContent.length > mermaidMaxSourceCharacters) {
-      displayError(el, new Error(`Mermaid source of ${el.textContent.length} characters exceeds the maximum allowed length of ${mermaidMaxSourceCharacters}.`));
+    const source = el.textContent;
+
+    if (mermaidMaxSourceCharacters >= 0 && source.length > mermaidMaxSourceCharacters) {
+      displayError(el, new Error(`Mermaid source of ${source.length} characters exceeds the maximum allowed length of ${mermaidMaxSourceCharacters}.`));
       continue;
     }
 
     let valid;
     try {
-      valid = mermaid.parse(el.textContent);
+      valid = mermaid.parse(source);
     } catch (err) {
       displayError(el, err);
     }
@@ -45,10 +47,17 @@ export async function renderMermaid() {
     }
 
     try {
-      mermaid.init(undefined, el, (id) => {
-        const svg = document.getElementById(id);
-        svg.classList.add('mermaid-chart');
-        svg.closest('pre').replaceWith(svg);
+      // can't use bindFunctions here because we can't cross the iframe boundary. This
+      // means js-based interactions won't work but they aren't intended to work either
+      mermaid.mermaidAPI.render('mermaid', source, (svgStr) => {
+        const heightStr = (svgStr.match(/height="(.+?)"/) || [])[1];
+        if (!heightStr) return displayError(el, new Error('Could not determine chart height'));
+        const iframe = document.createElement('iframe');
+        iframe.classList.add('markup-render');
+        iframe.sandbox = 'allow-scripts';
+        iframe.style.height = `${Math.ceil(parseFloat(heightStr))}px`;
+        iframe.srcdoc = `<html><head><style>${iframeCss}</style></head><body>${svgStr}</body></html>`;
+        el.closest('pre').replaceWith(iframe);
       });
     } catch (err) {
       displayError(el, err);
diff --git a/web_src/less/_base.less b/web_src/less/_base.less
@@ -6,6 +6,7 @@
   /* other variables */
   --border-radius: .28571429rem;
   --opacity-disabled: .55;
+  --height-loading: 12rem;
   --color-primary: #4183c4;
   --color-primary-dark-1: #3876b3;
   --color-primary-dark-2: #31699f;
diff --git a/web_src/less/animations.less b/web_src/less/animations.less
@@ -30,7 +30,7 @@
 
 .markup pre.is-loading,
 .editor-loading.is-loading {
-  height: 12rem;
+  height: var(--height-loading);
 }
 
 @keyframes fadein {
diff --git a/web_src/less/index.less b/web_src/less/index.less
@@ -10,7 +10,6 @@
 @import "./features/codeeditor.less";
 @import "./features/projects.less";
 @import "./markup/content.less";
-@import "./markup/mermaid.less";
 @import "./markup/codecopy.less";
 @import "./code/linebutton.less";
 
diff --git a/web_src/less/markup/content.less b/web_src/less/markup/content.less
@@ -536,6 +536,14 @@
   }
 }
 
+.markup-render {
+  display: block;
+  border: none;
+  width: 100%;
+  height: var(--height-loading); // actual height is set in JS after loading
+  overflow: hidden;
+}
+
 .markup-block-error {
   margin-bottom: 0 !important;
   border-bottom-left-radius: 0 !important;
diff --git a/web_src/less/markup/mermaid.less b/web_src/less/markup/mermaid.less
diff --git a/web_src/less/themes/theme-arc-green.less b/web_src/less/themes/theme-arc-green.less
@@ -455,10 +455,6 @@ img[src$="/img/matrix.svg"] {
   filter: invert(80%);
 }
 
-.mermaid-chart {
-  filter: invert(84%) hue-rotate(180deg);
-}
-
 .is-loading::after {
   border-color: #4a4c58 #4a4c58 #d7d7da #d7d7da;
 }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`
`31`	`31`	`.markup pre.is-loading,`
`32`	`32`	`.editor-loading.is-loading {`
`33`		`- height: 12rem;`
	`33`	`+ height: var(--height-loading);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`@keyframes fadein {`
Original file line number	Diff line number	Diff line change
`@@ -536,6 +536,14 @@`
`536`	`536`	`}`
`537`	`537`	`}`
`538`	`538`
	`539`	`+.markup-render {`
	`540`	`+ display: block;`
	`541`	`+ border: none;`
	`542`	`+ width: 100%;`
	`543`	`+ height: var(--height-loading); // actual height is set in JS after loading`
	`544`	`+ overflow: hidden;`
	`545`	`+}`
	`546`	`+`
`539`	`547`	`.markup-block-error {`
`540`	`548`	`margin-bottom: 0 !important;`
`541`	`549`	`border-bottom-left-radius: 0 !important;`
Original file line number	Diff line number	Diff line change
`@@ -455,10 +455,6 @@ img[src$="/img/matrix.svg"] {`
`455`	`455`	`filter: invert(80%);`
`456`	`456`	`}`
`457`	`457`
`458`		`-.mermaid-chart {`
`459`		`- filter: invert(84%) hue-rotate(180deg);`
`460`		`-}`
`461`		`-`
`462`	`458`	`.is-loading::after {`
`463`	`459`	`border-color: #4a4c58 #4a4c58 #d7d7da #d7d7da;`
`464`	`460`	`}`