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(print): wait for render note scripts and mount their JSX
Elian Doran4c5e9cd9291d
diff --git a/apps/client/src/print.spec.tsx b/apps/client/src/print.spec.tsxindex e14e7252c7..de06025004 100644--- a/apps/client/src/print.spec.tsx+++ b/apps/client/src/print.spec.tsx@@ -24,6 +24,7 @@ vi.mock("./widgets/collections/NoteList", () => ({}}));+import Component from "./components/component";import { App, Error404, loadCustomCss, main, SingleNoteRenderer } from "./print";import froca from "./services/froca";import { buildNote } from "./test/easy-froca";@@ -178,7 +179,16 @@ describe("SingleNoteRenderer", () => {});expect(lazyImg.getAttribute("loading")).toBe("eager");// Printing preserves full embed nesting via expandNestedEmbeds.- expect(h.getRenderedContent).toHaveBeenCalledWith(note, { noChildrenList: true, expandNestedEmbeds: true, mediaEnvironment: "native" });+ expect(h.getRenderedContent).toHaveBeenCalledWith(note, { noChildrenList: true, expandNestedEmbeds: true, mediaEnvironment: "native", parentComponent: expect.any(Component) });+ });++ it("gives a render note a root component for its JSX to mount under", async () => {+ const note = buildNote({ id: "render", title: "Render", type: "render" });+ const onReady = vi.fn();+ renderInto(<SingleNoteRenderer note={note} onReady={onReady} onProgressChanged={() => {}} />);++ await vi.waitFor(() => expect(onReady).toHaveBeenCalledWith({ type: "single-note" }));+ expect(h.getRenderedContent.mock.lastCall?.[1]?.parentComponent).toBeInstanceOf(Component);});it("renders a non-text, non-spreadsheet note via the content renderer", async () => {@@ -188,7 +198,7 @@ describe("SingleNoteRenderer", () => {await vi.waitFor(() => expect(onReady).toHaveBeenCalledWith({ type: "single-note" }));// Printing preserves full embed nesting via expandNestedEmbeds.- expect(h.getRenderedContent).toHaveBeenCalledWith(note, { noChildrenList: true, expandNestedEmbeds: true, mediaEnvironment: "native" });+ expect(h.getRenderedContent).toHaveBeenCalledWith(note, { noChildrenList: true, expandNestedEmbeds: true, mediaEnvironment: "native", parentComponent: expect.any(Component) });});});diff --git a/apps/client/src/print.tsx b/apps/client/src/print.tsxindex 2238f4f352..17430e082b 100644--- a/apps/client/src/print.tsx+++ b/apps/client/src/print.tsx@@ -1,6 +1,7 @@import { render } from "preact";import { useCallback, useLayoutEffect, useRef } from "preact/hooks";+import Component from "./components/component";import FNote from "./entities/fnote";import content_renderer from "./services/content_renderer";import { applyInlineMermaid } from "./services/content_renderer_text";@@ -117,8 +118,14 @@ export function SingleNoteRenderer({ note, onReady }: RendererProps) {await import("@triliumnext/ckeditor5/src/theme/ck-content.css");await import("@triliumnext/ckeditor5/src/theme/multicolumn.css");}- // Printing preserves full embed nesting (see expandNestedEmbeds).- const { $renderedContent } = await content_renderer.getRenderedContent(note, { noChildrenList: true, expandNestedEmbeds: true, mediaEnvironment: "native" });+ // Printing preserves full embed nesting (see expandNestedEmbeds). The print page has+ // no component tree, so a JSX render note mounts under a bare root `Component`.+ const { $renderedContent } = await content_renderer.getRenderedContent(note, {+ noChildrenList: true,+ expandNestedEmbeds: true,+ mediaEnvironment: "native",+ parentComponent: new Component()+ });container.replaceChildren(...$renderedContent);// Note types rendered as a mounted component (an AI chat) start their transformdiff --git a/apps/client/src/services/render.spec.tsx b/apps/client/src/services/render.spec.tsxindex ff7f2b09b0..dc75e89110 100644--- a/apps/client/src/services/render.spec.tsx+++ b/apps/client/src/services/render.spec.tsx@@ -19,6 +19,7 @@ import noteAttributeCache from "../services/note_attribute_cache.js";import utils from "../services/utils.js";import { buildNote } from "../test/easy-froca";import froca from "./froca.js";+import { waitForPendingRenders } from "./pending_renders.js";import renderDefault, { render, renderIfJsx } from "./render.js";import { RENDER_SCOPE_CLASS } from "./render_css_scope.js";import server from "./server.js";@@ -261,6 +262,33 @@ describe("render", () => {expect(renderAtElementMock.mock.calls[0][0]).toBe(closest);expect(renderAtElementMock.mock.calls[0][2]).toBe($el[0]);});++ it("holds waitForPendingRenders until the script and its JSX mount have settled", async () => {+ const target = buildNote({ title: "Target8", type: "code" });+ const jsxNote = buildNote({ id: "jsxRoot8", title: "JSX root" });+ jsxNote.mime = "text/jsx";+ const note = buildNote({ title: "Host8", "~renderNote": target.noteId });+ server.postWithSilentInternalServerError = vi.fn(async () => ({+ script: "",+ html: "",+ noteId: "jsxRoot8",+ allNoteIds: []+ })) as typeof server.postWithSilentInternalServerError;+ let finishScript: (result: unknown) => void = () => {};+ executeMock.mockReturnValue(new Promise((resolve) => { finishScript = resolve; }));+ (glob as any).getComponentByEl = vi.fn(() => ({ fake: "component" }));++ const $el = $("<div class='component'>");+ await render(note, $el, vi.fn());+ let settled = false;+ const wait = waitForPendingRenders($el[0]).then(() => { settled = true; });+ await flush();+ expect(settled).toBe(false);++ finishScript(() => null);+ await wait;+ expect(renderAtElementMock).toHaveBeenCalledOnce();+ });});describe("renderIfJsx", () => {diff --git a/apps/client/src/services/render.tsx b/apps/client/src/services/render.tsxindex f6c068926d..2a097445e2 100644--- a/apps/client/src/services/render.tsx+++ b/apps/client/src/services/render.tsx@@ -6,6 +6,7 @@ import type FNote from "../entities/fnote.js";import { renderReactWidgetAtElement } from "../widgets/react/react_utils.jsx";import { type Bundle, executeBundleWithoutErrorHandling } from "./bundle.js";import froca from "./froca.js";+import { trackPendingRender } from "./pending_renders.js";import { keepStylesScoped, RENDER_SCOPE_CLASS } from "./render_css_scope.js";/**@@ -39,15 +40,16 @@ export async function render(note: FNote, $el: JQuery<HTMLElement>, onError?: Er$scriptContainer.append(bundle.html);keepStylesScoped($scriptContainer[0]);- // async so that scripts cannot block trilium execution- executeBundleWithoutErrorHandling(bundle, note, $scriptContainer)+ // Not awaited, so that a script cannot block Trilium. `trackPendingRender` lets printing+ // wait for the script and its JSX mount before it captures the page.+ const work = executeBundleWithoutErrorHandling(bundle, note, $scriptContainer).catch((e) => onError?.(e, renderNoteId))- .then(result => {- // Render JSX+ .then(async (result) => {if (bundle.html === "") {- renderIfJsx(bundle, result, $el, onError, parentComponent).catch((e) => onError?.(e, bundle.noteId));+ await renderIfJsx(bundle, result, $el, onError, parentComponent).catch((e) => onError?.(e, bundle.noteId));}});+ trackPendingRender($el[0], work);}return renderNoteIds.length > 0;