Skip to content

Build your personal knowledge base with Trilium Notes

perf(mermaid): preview diagrams from their saved SVG

Elian Doran90d70a421ef0
diff --git a/apps/client/src/services/content_renderer.spec.ts b/apps/client/src/services/content_renderer.spec.ts
index f798f9ee53..e5e6a8be9c 100644
--- a/apps/client/src/services/content_renderer.spec.ts
+++ b/apps/client/src/services/content_renderer.spec.ts
@@ -58,16 +58,6 @@ vi.mock("./open.js", () => ({
}
}));
-const getMermaidConfig = vi.fn(() => ({
- theme: "default", layout: "dagre", look: "classic",
- flowchart: { useMaxWidth: false }, gantt: { useMaxWidth: false }, pie: { useMaxWidth: true }
-}));
-const postprocessMermaidSvg = vi.fn((...args: any[]) => `<svg class="mm">${args[0]}</svg>`);
-vi.mock("./mermaid.js", () => ({
- getMermaidConfig: () => getMermaidConfig(),
- postprocessMermaidSvg: (...a: any[]) => postprocessMermaidSvg(...a)
-}));
-
// isOfficeMimeType comes (unmocked) from @triliumnext/commons; only the server
// round-trip is stubbed out.
const renderOfficeToHtml = vi.fn(async (..._args: any[]) => ({ css: "", html: `<div class="office-doc">converted</div>` }));
@@ -76,9 +66,11 @@ vi.mock("./office_renderer.js", () => ({
}));
const mermaidRender = vi.fn(async (..._args: any[]) => ({ svg: "<g/>" }));
-const mermaidInitialize = vi.fn((..._args: any[]) => {});
vi.mock("mermaid", () => ({
- default: { mermaidAPI: { initialize: (...a: any[]) => mermaidInitialize(...a), render: (...a: any[]) => mermaidRender(...a) } }
+ default: {
+ render: (...a: any[]) => mermaidRender(...a),
+ mermaidAPI: { render: (...a: any[]) => mermaidRender(...a) }
+ }
}));
const pdfViewerComponent = vi.fn((_props: any) => null);
@@ -879,36 +871,15 @@ describe("getRenderedContent render / doc / protectedSession / mermaid", () => {
expect(enterProtectedSession).toHaveBeenCalledOnce();
});
- it("renders a mermaid diagram and post-processes the svg", async () => {
+ it("shows a mermaid note's saved SVG instead of rendering its source", async () => {
const note = buildNote({ title: "M", type: "mermaid", content: "graph TD; A-->B" });
const { type, $renderedContent } = await getRenderedContent(note);
expect(type).toBe("mermaid");
- expect(mermaidInitialize).toHaveBeenCalledOnce();
- expect(mermaidInitialize).toHaveBeenCalledWith(
- expect.objectContaining({ layout: "dagre", look: "classic", startOnLoad: false })
- );
- const config = mermaidInitialize.mock.calls[0][0];
- expect(config.flowchart).toEqual({ useMaxWidth: true });
- expect(config.gantt).toEqual({ useMaxWidth: true });
- expect(config.pie).toEqual({ useMaxWidth: true });
- expect(postprocessMermaidSvg).toHaveBeenCalledWith("<g/>");
- expect($renderedContent.find("svg.mm").length).toBe(1);
- });
-
- it("renders a mermaid error message when rendering throws", async () => {
- mermaidRender.mockRejectedValueOnce(new Error("bad diagram"));
- const note = buildNote({ title: "MErr", type: "mermaid", content: "bogus" });
- const { $renderedContent } = await getRenderedContent(note);
- expect($renderedContent.find("p").length).toBe(1);
- expect(postprocessMermaidSvg).not.toHaveBeenCalled();
- });
-
- it("handles a mermaid note with no blob content", async () => {
- const note = buildNote({ title: "MEmpty", type: "mermaid" });
- note.getBlob = (async () => null) as any;
- const { type } = await getRenderedContent(note);
- expect(type).toBe("mermaid");
- expect(mermaidRender).toHaveBeenCalled();
+ const $img = $renderedContent.find("img");
+ expect($img.length).toBe(1);
+ expect($img.attr("src")).toContain(`api/images/${note.noteId}/`);
+ expect($renderedContent.find("svg").length).toBe(0);
+ expect(mermaidRender).not.toHaveBeenCalled();
});
});
diff --git a/apps/client/src/services/content_renderer.ts b/apps/client/src/services/content_renderer.ts
index a9b49217e7..909f7f7147 100644
--- a/apps/client/src/services/content_renderer.ts
+++ b/apps/client/src/services/content_renderer.ts
@@ -12,7 +12,6 @@ import {
type TextRepresentationResponse
} from "@triliumnext/commons";
import DOMPurify from "dompurify";
-import type { MermaidConfig } from "mermaid";
import { h, type JSX, render } from "preact";
import type Component from "../components/component.js";
@@ -29,7 +28,6 @@ import renderText, {
} from "./content_renderer_text.js";
import renderDoc from "./doc_renderer.js";
import { getAttachmentImageUrl, getNoteImageUrl } from "./image_urls.js";
-import { getMermaidConfig, postprocessMermaidSvg } from "./mermaid.js";
import { renderOfficeToHtml } from "./office_renderer.js";
import openService from "./open.js";
import { waitForPendingRenders } from "./pending_renders.js";
@@ -202,14 +200,12 @@ export async function getRenderedContent(this: {} | { ctx: string }, entity: FNo
await renderCanvasDrawing(entity, $renderedContent, options);
} else if (type === "image" && options.mediaEnvironment === "embedded") {
await renderImageViewer(entity, $renderedContent);
- } else if (["image", "canvas", "mindMap", "spreadsheet"].includes(type)) {
+ } else if (["image", "canvas", "mermaid", "mindMap", "spreadsheet"].includes(type)) {
await renderImage(entity, $renderedContent, options);
} else if (!options.tooltip && type === "office") {
await renderOffice(entity, $renderedContent, options);
} else if (!options.tooltip && ["file", "pdf", "audio", "video"].includes(type)) {
await renderFile(entity, type, $renderedContent, options);
- } else if (type === "mermaid") {
- await renderMermaid(entity, $renderedContent);
} else if (type === "render" && entity instanceof FNote) {
const $content = $("<div>");
@@ -289,7 +285,6 @@ export const CONTENT_RENDERERS = {
pdf: () => import("../widgets/type_widgets/file/PdfViewer"),
media: () => import("../widgets/type_widgets/file/MediaPreview")
},
- mermaid: () => import("mermaid"),
render: () => import("./render.js"),
webView: () => import("../widgets/type_widgets/WebView"),
llmChat: () => import("../widgets/type_widgets/llm_chat/ChatPreview"),
@@ -765,41 +760,6 @@ async function renderMedia(entity: FNote | FAttachment, environment: MediaEnviro
$content.append($container);
}
-async function renderMermaid(note: FNote | FAttachment, $renderedContent: JQuery<HTMLElement>) {
- const mermaid = (await CONTENT_RENDERERS.mermaid()).default;
-
- const blob = await note.getBlob();
- const content = blob?.content || "";
-
- $renderedContent.css("display", "flex").css("justify-content", "space-around");
-
- mermaid.mermaidAPI.initialize({ ...fitToContainer(getMermaidConfig()), startOnLoad: false });
-
- try {
- const { svg } = await mermaid.mermaidAPI.render(`in-mermaid-graph-${idCounter++}`, content);
-
- $renderedContent.append($(postprocessMermaidSvg(svg)));
- } catch (e) {
- const $error = $("<p>The diagram could not displayed.</p>");
-
- $renderedContent.append($error);
- }
-}
-
-/**
- * Sets `useMaxWidth` on every diagram type, so the SVG takes the width of the card, tooltip or
- * include box that holds it instead of the diagram's natural size, which the container crops.
- */
-function fitToContainer(config: MermaidConfig): MermaidConfig {
- const fitted: Record<string, unknown> = { ...config };
- for (const [ key, value ] of Object.entries(config)) {
- if (value && typeof value === "object" && "useMaxWidth" in value) {
- fitted[key] = { ...value, useMaxWidth: true };
- }
- }
- return fitted as MermaidConfig;
-}
-
/**
* Mounts the live {@link WebView} type widget — an Electron `<webview>` or a sandboxed `<iframe>` —
* into the rendered content. Used by interactive contexts (e.g. the dashboard) that opt in via
diff --git a/packages/commons/src/lib/notes.spec.ts b/packages/commons/src/lib/notes.spec.ts
index 973bdb6081..82cf0d1d1c 100644
--- a/packages/commons/src/lib/notes.spec.ts
+++ b/packages/commons/src/lib/notes.spec.ts
@@ -338,7 +338,7 @@ describe("getNoteContentType", () => {
[ "video", "file" ],
[ "office", undefined ],
[ "file", undefined ],
- [ "mermaid", "mermaid" ]
+ [ "mermaid", undefined ]
]);
expect(getContentRendererGroup("constructor")).toBeUndefined();
});
diff --git a/packages/commons/src/lib/notes.ts b/packages/commons/src/lib/notes.ts
index fc3d8b0dbf..77d8e2b696 100644
--- a/packages/commons/src/lib/notes.ts
+++ b/packages/commons/src/lib/notes.ts
@@ -287,7 +287,6 @@ export const CONTENT_RENDERER_GROUPS: Readonly<Record<string, string>> = {
pdf: "file",
audio: "file",
video: "file",
- mermaid: "mermaid",
render: "render",
webView: "webView",
llmChat: "llmChat"