Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
fix(client): draw a Mermaid attachment before a static render returns
Elian Doran94f2ed7a6591
diff --git a/apps/client/src/services/content_renderer.spec.ts b/apps/client/src/services/content_renderer.spec.tsindex bcb3305127..a418bef5ee 100644--- a/apps/client/src/services/content_renderer.spec.ts+++ b/apps/client/src/services/content_renderer.spec.ts@@ -104,13 +104,25 @@ vi.mock("../widgets/type_widgets/canvas/CanvasDrawing", () => ({renderCanvasDrawingPicture: (entity: unknown) => renderCanvasDrawingPicture(entity)}));+const mermaidDiagramComponent = vi.fn((_props: any): VNode<any> =>+ h("span", { class: "mock-mermaid-diagram-marker" }));+vi.mock("../widgets/type_widgets/mermaid/MermaidDiagram", () => ({ default: mermaidDiagramComponent }));+const renderMermaidSvg = vi.fn(async (_source: string) => "<svg class=\"mock-mermaid-svg\"></svg>");+vi.mock("./mermaid", async (importOriginal) => ({+ ...await importOriginal<object>(),+ renderMermaidSvg: (source: string) => renderMermaidSvg(source)+}));+const chatPreviewComponent = vi.fn((props: any): VNode<any> =>h("span", { class: "mock-chat-marker" }, `messages:${props.messages.length}`));vi.mock("../widgets/type_widgets/llm_chat/ChatPreview", () => ({ default: chatPreviewComponent }));const codeEmbedComponent = vi.fn((_props: any): VNode<any> =>h("span", { class: "mock-code-embed-marker" }));-vi.mock("../widgets/type_widgets/code/CodeEmbed", () => ({ default: codeEmbedComponent }));+vi.mock("../widgets/type_widgets/code/CodeEmbed", () => ({+ default: codeEmbedComponent,+ useSavedContent: () => {}+}));const textEmbedComponent = vi.fn((_props: any): VNode<any> =>h("span", { class: "mock-text-embed-marker" }));@@ -1149,6 +1161,24 @@ describe("getRenderedContent canvas drawing rendering", () => {});});+describe("Mermaid diagram attachments", () => {+ it("draws the diagram before returning where it is not interactive, and mounts it where it is", async () => {+ const att = buildAttachment({ role: "file", mime: "text/vnd.mermaid" });+ att.getBlob = async () => ({ content: "graph TD;" }) as never;++ const { type, $renderedContent } = await getRenderedContent(att);+ expect(type).toBe("mermaidDiagram");+ expect(renderMermaidSvg).toHaveBeenCalledWith("graph TD;");+ expect($renderedContent.find("svg.mock-mermaid-svg").length).toBe(1);+ expect(mermaidDiagramComponent).not.toHaveBeenCalled();++ const { $renderedContent: $live } = await getRenderedContent(att, { interactive: true });+ expect($live.find(".mock-mermaid-diagram-marker").length).toBe(1);+ expect(mermaidDiagramComponent.mock.calls[0][0].content).toBe("graph TD;");+ disposeInteractiveContent($live);+ });+});+describe("interactive content disposal", () => {it("tags an interactive mount and disposes it, unmounting the widget", async () => {const note = buildNote({ title: "WI", type: "webView", "#webViewSrc": "https://example.com" });diff --git a/apps/client/src/services/content_renderer.ts b/apps/client/src/services/content_renderer.tsindex f93f6ac726..d3c8268298 100644--- a/apps/client/src/services/content_renderer.ts+++ b/apps/client/src/services/content_renderer.ts@@ -594,7 +594,7 @@ async function renderCanvasDrawing(/*** Renders the source of a {@link SourceEmbedType} kept in a file or an attachment, such as a Mermaid* diagram. Interactive content of an attachment can be edited while the Editable toggle of its- * embed is on.+ * embed is on; otherwise the content is drawn as a picture before this returns.*/async function renderSourceEmbed(entity: FNote | FAttachment,@@ -605,11 +605,20 @@ async function renderSourceEmbed(const sourceType = getSourceEmbedTypeByContentType(type);if (!sourceType) return;+ // A presentation slide, for one, takes the HTML as soon as this returns.+ if (!options.interactive) {+ const container = document.createElement("div");+ container.className = "source-embed";+ await sourceType.renderPreview((await entity.getBlob())?.content ?? "", container);+ $renderedContent.append(container);+ return;+ }+const [ { default: AttachmentSourceEmbed }, component ] = await Promise.all([CONTENT_RENDERERS.file.sourceEmbed(),sourceType.load()]);- const editor = options.interactive ? getContentEditor(entity, options) : undefined;+ const editor = getContentEditor(entity, options);const content = editor?.getUnsavedContent() ?? (await entity.getBlob())?.content ?? "";const $container = $('<div class="source-embed">');