Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Prevent temporary Mermaid diagrams from shifting the interface https://github.com/siyuan-note/siyuan/issues/20381

Vanessabcde529bb34e
diff --git a/app/src/protyle/render/mermaidRender.test.ts b/app/src/protyle/render/mermaidRender.test.ts
index 91ddf9a7bc..189993d0e1 100644
--- a/app/src/protyle/render/mermaidRender.test.ts
+++ b/app/src/protyle/render/mermaidRender.test.ts
@@ -10,7 +10,11 @@ const compiled = transpileModule(readFileSync("src/protyle/render/mermaidRender.
test("Mermaid follows both theme directions and discards renders superseded by a theme change", async () => {
const attributes = new Map([["data-subtype", "mermaid"], ["data-content", "graph TD; A-->B"]]);
- const renders: Array<{theme: string, resolve: (value: {svg: string}) => void}> = [];
+ const renders: Array<{theme: string, resolve: (value: {svg: string}) => void, reject: (reason: unknown) => void}> = [];
+ const temporaryContainers: Array<{
+ style: {cssText: string}, attached: boolean, removed: boolean,
+ querySelector: (selector: string) => {outerHTML: string}, remove: () => void,
+ }> = [];
let theme = "";
let counter = 0;
const container = {
@@ -29,11 +33,31 @@ test("Mermaid follows both theme directions and discards renders superseded by a
const api = {} as {mermaidRender: (element: unknown) => void, refreshMermaidTheme: (element: unknown) => void};
runInNewContext(compiled, {
exports: api,
+ document: {
+ body: {clientWidth: 1000, appendChild: (element: typeof temporaryContainers[number]) => {
+ element.attached = true;
+ }},
+ createElement: (tag: string) => {
+ assert.equal(tag, "div");
+ const element = {
+ style: {cssText: ""}, attached: false, removed: false,
+ querySelector: (selector: string) => {
+ assert.equal(selector, "#mermaid" + (temporaryContainers.indexOf(element) + 1));
+ assert.equal(element.removed, false);
+ return {outerHTML: "error diagram"};
+ },
+ remove() { this.removed = true; },
+ };
+ temporaryContainers.push(element);
+ return element;
+ },
+ },
require: () => ({
Constants: {PROTYLE_CDN: "", ZWSP: ""}, addScript: async () => {},
isFoldedRenderContent: () => false, isZenumlDiagram: () => false,
getMermaidLayout: () => "", applyMermaidLayout: (value: string) => value,
hasClosestByClassName: (): Element => null, getHostCapabilities: () => ({remoteKernel: false}),
+ escapeHtml: (value: string) => value,
}),
Lute: {NewNodeID: () => String(++counter), UnEscapeHTMLStr: (value: string) => value},
window: {siyuan: {config}, DOMPurify: {sanitize: (value: string) => value}, mermaid: {
@@ -42,7 +66,15 @@ test("Mermaid follows both theme directions and discards renders superseded by a
assert.equal(value.layout, undefined);
theme = value.theme;
},
- render: () => new Promise(resolve => renders.push({theme, resolve})),
+ render: (_id: string, _content: string, element: typeof temporaryContainers[number]) => {
+ assert.equal(element, temporaryContainers[renders.length]);
+ assert.equal(element.attached, true);
+ assert.match(element.style.cssText, /position: fixed/);
+ assert.match(element.style.cssText, /left: -100000px/);
+ assert.match(element.style.cssText, /width: 1000px/);
+ assert.doesNotMatch(element.style.cssText, /display:\s*none/);
+ return new Promise((resolve, reject) => renders.push({theme, resolve, reject}));
+ },
}},
});
const flush = async () => { for (let i = 0; i < 8; i++) { await Promise.resolve(); } };
@@ -74,4 +106,22 @@ test("Mermaid follows both theme directions and discards renders superseded by a
renders[3].resolve({svg: "dark body diagram"});
await flush();
assert.equal(container.lastElementChild.innerHTML, "dark body diagram");
+ assert.ok(temporaryContainers.every(element => element.removed));
+ api.refreshMermaidTheme(block);
+ await flush();
+ renders[4].reject("render failed");
+ await flush();
+ assert.match(container.lastElementChild.innerHTML, /error diagram/);
+ assert.match(container.lastElementChild.innerHTML, /render failed/);
+ assert.equal(temporaryContainers[4].removed, true);
+ api.refreshMermaidTheme(block);
+ await flush();
+ api.refreshMermaidTheme(block);
+ await flush();
+ renders[6].resolve({svg: "latest diagram"});
+ await flush();
+ renders[5].reject("stale error");
+ await flush();
+ assert.equal(container.lastElementChild.innerHTML, "latest diagram");
+ assert.ok(temporaryContainers.every(element => element.removed));
});
diff --git a/app/src/protyle/render/mermaidRender.ts b/app/src/protyle/render/mermaidRender.ts
index 6414b32209..868327cb3f 100644
--- a/app/src/protyle/render/mermaidRender.ts
+++ b/app/src/protyle/render/mermaidRender.ts
@@ -145,15 +145,19 @@ const initMermaid = (mermaidElements: Element[]) => {
return;
}
const id = "mermaid" + Lute.NewNodeID();
+ const container = document.createElement("div");
+ // 在屏幕外测量图形,避免临时节点参与主界面布局。
+ container.style.cssText = `position: fixed;left: -100000px;top: 0;width: ${document.body.clientWidth}px;pointer-events: none;`;
let diagramElement: Element;
try {
- renderElement.innerHTML = `<span style="position: absolute;left:0;top:0;width: 1px;">${Constants.ZWSP}</span><div contenteditable="false"><span id="${id}"></span></div>`;
+ document.body.appendChild(container);
+ renderElement.innerHTML = `<span style="position: absolute;left:0;top:0;width: 1px;">${Constants.ZWSP}</span><div contenteditable="false"></div>`;
diagramElement = renderElement.lastElementChild;
const content = applyMermaidLayout(
Lute.UnEscapeHTMLStr(item.getAttribute("data-content")),
getMermaidLayout(item.getAttribute(MERMAID_LAYOUT_ATTR))
);
- const mermaidData = await window.mermaid.render(id, content);
+ const mermaidData = await window.mermaid.render(id, content, container);
if (renderElement.lastElementChild !== diagramElement) {
return;
}
@@ -164,12 +168,13 @@ const initMermaid = (mermaidElements: Element[]) => {
if (renderElement.lastElementChild !== diagramElement) {
return;
}
- const errorElement = document.querySelector("#" + id);
+ const errorElement = container.querySelector("#" + id);
const errorDiagram = errorElement ?
window.DOMPurify.sanitize(errorElement.outerHTML, MERMAID_SANITIZE_OPTIONS) : "";
const errorMessage = escapeHtml(e instanceof Error ? e.message : String(e)).replace(/\n/g, "<br>");
renderElement.lastElementChild.innerHTML = `${errorDiagram}<div class="fn__hr"></div><div class="ft__error">${errorMessage}</div>`;
- errorElement?.parentElement?.remove();
+ } finally {
+ container.remove();
}
});
};
diff --git a/app/src/types/index.d.ts b/app/src/types/index.d.ts
index 3bbcaed3c0..52d84c8aad 100644
--- a/app/src/types/index.d.ts
+++ b/app/src/types/index.d.ts
@@ -136,7 +136,7 @@ interface Window {
mermaidTidyTree: object[],
mermaid: {
initialize(options: any): void,
- render(id: string, text: string): Promise<{ svg: string }>,
+ render(id: string, text: string, container?: HTMLElement): Promise<{ svg: string }>,
registerExternalDiagrams(ex: object[]): Promise<void>,
registerLayoutLoaders(layouts: object[]): void,
registerIconPacks(options: {