Skip to content
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

Fix math and mermaid rendering bugs #24049

Merged
merged 7 commits into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion web_src/css/base.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/* non-color variables */
--border-radius: 0.28571429rem;
--opacity-disabled: 0.55;
--height-loading: 12rem;
--height-loading: 16rem;
/* base colors */
--color-primary: #4183c4;
--color-primary-contrast: #ffffff;
Expand Down
3 changes: 2 additions & 1 deletion web_src/css/helpers.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
.gt-overflow-x-scroll { overflow-x: scroll !important; }
.gt-cursor-default { cursor: default !important; }
.gt-items-start { align-items: flex-start !important; }
.gt-whitespace-pre { white-space: pre !important }
.gt-whitespace-pre { white-space: pre !important; }
.gt-invisible { visibility: hidden !important; }

.gt-mono {
font-family: var(--fonts-monospace) !important;
Expand Down
2 changes: 1 addition & 1 deletion web_src/css/markup/content.css
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@

.markup-block-error {
display: block !important; /* override fomantic .ui.form .error.message {display: none} */
border: 1px solid var(--color-error-border) !important;
border: none !important;
margin-bottom: 0 !important;
border-bottom-left-radius: 0 !important;
border-bottom-right-radius: 0 !important;
Expand Down
2 changes: 1 addition & 1 deletion web_src/js/markup/asciicast.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export async function renderAsciinemaPlayer() {
export async function renderAsciicast() {
const els = document.querySelectorAll('.asciinema-player-container');
if (!els.length) return;

Expand Down
8 changes: 8 additions & 0 deletions web_src/js/markup/common.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export function displayError(el, err) {
el.classList.remove('is-loading');
const errorNode = document.createElement('pre');
errorNode.setAttribute('class', 'ui message error markup-block-error');
errorNode.textContent = err.str || err.message || String(err);
el.before(errorNode);
el.setAttribute('data-render-done', 'true');
}
4 changes: 2 additions & 2 deletions web_src/js/markup/content.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import {renderMermaid} from './mermaid.js';
import {renderMath} from './math.js';
import {renderCodeCopy} from './codecopy.js';
import {renderAsciinemaPlayer} from './asciicast.js';
import {renderAsciicast} from './asciicast.js';
import {initMarkupTasklist} from './tasklist.js';

// code that runs for all markup content
export function initMarkupContent() {
renderMermaid();
renderMath();
renderCodeCopy();
renderAsciinemaPlayer();
renderAsciicast();
}

// code that only runs for comments
Expand Down
18 changes: 7 additions & 11 deletions web_src/js/markup/math.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
function displayError(el, err) {
const target = targetElement(el);
target.classList.remove('is-loading');
const errorNode = document.createElement('div');
errorNode.setAttribute('class', 'ui message error markup-block-error gt-mono');
errorNode.textContent = err.str || err.message || String(err);
target.before(errorNode);
}
import {displayError} from './common.js';

function targetElement(el) {
// The target element is either the current element if it has the `is-loading` class or the pre that contains it
// The target element is either the current element if it has the
// `is-loading` class or the pre that contains it
return el.classList.contains('is-loading') ? el : el.closest('pre');
}

Expand All @@ -22,6 +16,8 @@ export async function renderMath() {
]);

for (const el of els) {
const target = targetElement(el);
if (target.hasAttribute('data-render-done')) continue;
const source = el.textContent;
const displayMode = el.classList.contains('display');
const nodeName = displayMode ? 'p' : 'span';
Expand All @@ -33,9 +29,9 @@ export async function renderMath() {
maxExpand: 50,
displayMode,
});
targetElement(el).replaceWith(tempEl);
target.replaceWith(tempEl);
} catch (error) {
displayError(el, error);
displayError(target, error);
}
}
}
50 changes: 24 additions & 26 deletions web_src/js/markup/mermaid.js
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
import {isDarkTheme} from '../utils.js';
import {makeCodeCopyButton} from './codecopy.js';
import {displayError} from './common.js';

const {mermaidMaxSourceCharacters} = window.config;

const iframeCss = `
:root {color-scheme: normal}
body {margin: 0; padding: 0; overflow: hidden}
#mermaid {display: block; margin: 0 auto}
`;

function displayError(el, err) {
el.closest('pre').classList.remove('is-loading');
const errorNode = document.createElement('div');
errorNode.setAttribute('class', 'ui message error markup-block-error gt-mono');
errorNode.textContent = err.str || err.message || String(err);
el.closest('pre').before(errorNode);
}
const iframeCss = `:root {color-scheme: normal}
body {margin: 0; padding: 0; overflow: hidden}
#mermaid {display: block; margin: 0 auto}`;

export async function renderMermaid() {
const els = document.querySelectorAll('.markup code.language-mermaid');
Expand All @@ -30,45 +21,52 @@ export async function renderMermaid() {
});

for (const el of els) {
const source = el.textContent;
const pre = el.closest('pre');
if (pre.hasAttribute('data-render-done')) continue;

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}.`));
displayError(pre, new Error(`Mermaid source of ${source.length} characters exceeds the maximum allowed length of ${mermaidMaxSourceCharacters}.`));
continue;
}

try {
await mermaid.parse(source);
} catch (err) {
displayError(el, err);
el.closest('pre').classList.remove('is-loading');
displayError(pre, err);
continue;
}

try {
// 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
const {svg} = await mermaid.render('mermaid', source);
const heightStr = (svg.match(/viewBox="(.+?)"/) || ['', ''])[1].split(/\s+/)[3];
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.classList.add('markup-render', 'gt-invisible');
iframe.srcdoc = `<html><head><style>${iframeCss}</style></head><body>${svg}</body></html>`;

const mermaidBlock = document.createElement('div');
mermaidBlock.classList.add('mermaid-block');
mermaidBlock.classList.add('mermaid-block', 'is-loading', 'gt-hidden');
mermaidBlock.append(iframe);

const btn = makeCodeCopyButton();
btn.setAttribute('data-clipboard-text', source);

mermaidBlock.append(btn);
el.closest('pre').replaceWith(mermaidBlock);

iframe.addEventListener('load', () => {
pre.replaceWith(mermaidBlock);
mermaidBlock.classList.remove('gt-hidden');
iframe.style.height = `${iframe.contentWindow.document.body.clientHeight}px`;
setTimeout(() => { // avoid flash of iframe background
mermaidBlock.classList.remove('is-loading');
iframe.classList.remove('gt-invisible');
}, 0);
});

document.body.append(mermaidBlock);
} catch (err) {
displayError(el, err);
displayError(pre, err);
}
}
}