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_preview): drop results of superseded preview requests
Elian Doran9b4026746bf3
diff --git a/apps/client/src/widgets/dialogs/print_preview.spec.tsx b/apps/client/src/widgets/dialogs/print_preview.spec.tsxnew file mode 100644index 0000000000..11813b89ce--- /dev/null+++ b/apps/client/src/widgets/dialogs/print_preview.spec.tsx@@ -0,0 +1,90 @@+import { act } from "preact/test-utils";+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";++import Component from "../../components/component";+import { buildNote } from "../../test/easy-froca";+import { renderInto } from "../../test/render";+import { ParentComponent } from "../react/react_utils";+import PrintPreviewDialog from "./print_preview";++vi.mock("../../services/i18n", () => ({ t: (key: string) => key }));+vi.mock("../type_widgets/file/PdfViewer", () => ({+ default: ({ pdfUrl }: { pdfUrl: string }) => <div className="pdf-viewer-mock" data-url={pdfUrl} />+}));++type PreviewResult = { buffer?: Uint8Array; error?: string; requestId?: number };++const printing = {+ getPrinters: vi.fn(async () => []),+ exportAsPdfPreview: vi.fn(),+ onExportAsPdfPreviewResult: vi.fn(),+ removeExportAsPdfPreviewResultListener: vi.fn(),+ savePdf: vi.fn(),+ printFromPreview: vi.fn()+};++/** Delivers a result to the listener the dialog registered, as the main process would. */+function deliver(result: PreviewResult) {+ const listener = printing.onExportAsPdfPreviewResult.mock.calls.at(-1)?.[0] as ((r: PreviewResult) => void) | undefined;+ if (!listener) throw new Error("the dialog registered no result listener");+ act(() => listener(result));+}++function requestIds(): unknown[] {+ return printing.exportAsPdfPreview.mock.calls.map(([ opts ]) => (opts as { requestId?: number }).requestId);+}++describe("PrintPreviewDialog", () => {+ let urlCount = 0;++ beforeEach(() => {+ document.body.innerHTML = "";+ for (const fn of Object.values(printing)) fn.mockClear();+ (window as any).electronApi = { printing };+ URL.createObjectURL = vi.fn(() => `blob:preview-${++urlCount}`);+ URL.revokeObjectURL = vi.fn();+ });++ afterEach(() => {+ delete (window as any).electronApi;+ });++ it("ignores the result of a request a newer one has superseded", async () => {+ const note = buildNote({ id: "print-me", title: "Print me" });+ const host = new Component();+ renderInto(+ <ParentComponent.Provider value={host}>+ <PrintPreviewDialog />+ </ParentComponent.Provider>+ );+ await act(async () => {+ await host.handleEvent("showPrintPreview", { note, notePath: "root/print-me" });+ });+ await vi.waitFor(() => expect(printing.exportAsPdfPreview).toHaveBeenCalledTimes(1));++ // A settings change while the first render is still running starts a second one.+ const pageRanges = document.querySelector<HTMLInputElement>(".print-preview-page-ranges");+ expect(pageRanges).toBeTruthy();+ act(() => {+ if (!pageRanges) return;+ pageRanges.value = "1";+ pageRanges.dispatchEvent(new Event("input", { bubbles: true }));+ });+ await vi.waitFor(() => expect(printing.exportAsPdfPreview).toHaveBeenCalledTimes(2), { timeout: 2000 });+ const [ firstId, secondId ] = requestIds();+ expect(firstId).not.toBe(secondId);++ deliver({ requestId: secondId as number, buffer: new Uint8Array([ 1 ]) });+ const viewer = () => document.querySelector(".pdf-viewer-mock");+ expect(viewer()?.getAttribute("data-url")).toBe(`blob:preview-${urlCount}`);+ const currentUrl = viewer()?.getAttribute("data-url");++ // The first request finishing late, with an error or a PDF, changes nothing.+ deliver({ requestId: firstId as number, error: "stale failure" });+ expect(document.querySelector(".print-preview-pane .no-items")).toBeNull();+ expect(viewer()?.getAttribute("data-url")).toBe(currentUrl);++ deliver({ requestId: firstId as number, buffer: new Uint8Array([ 2 ]) });+ expect(viewer()?.getAttribute("data-url")).toBe(currentUrl);+ });+});diff --git a/apps/client/src/widgets/dialogs/print_preview.tsx b/apps/client/src/widgets/dialogs/print_preview.tsxindex bb32f990df..e1407a3e6d 100644--- a/apps/client/src/widgets/dialogs/print_preview.tsx+++ b/apps/client/src/widgets/dialogs/print_preview.tsx@@ -101,6 +101,7 @@ export default function PrintPreviewDialog() {const bufferRef = useRef<Uint8Array>();const notePathRef = useRef("");const pdfUrlRef = useRef<string>();+ const requestIdRef = useRef(0);const [landscape, setLandscape] = useNoteLabelBoolean(note, "printLandscape");@@ -154,13 +155,14 @@ export default function PrintPreviewDialog() {});// Handle regeneration results via a persistent listener scoped to the- // dialog's lifecycle. A generation counter discards stale results when+ // dialog's lifecycle. `requestIdRef` discards stale results when// multiple requests overlap.useEffect(() => {const api = window.electronApi?.printing;if (!shown || !api) return;- api.onExportAsPdfPreviewResult(({ buffer, error }) => {+ api.onExportAsPdfPreviewResult(({ buffer, error, requestId }) => {+ if (requestId !== requestIdRef.current) return;toast.closePersistent("printing");if (error) {setLoading(false);@@ -189,6 +191,7 @@ export default function PrintPreviewDialog() {setLoading(true);api.exportAsPdfPreview({+ requestId: ++requestIdRef.current,notePath: notePathRef.current,pageSize: opts.pageSize,landscape: opts.landscape,@@ -213,6 +216,7 @@ export default function PrintPreviewDialog() {}, [shown, landscape, pageSize, scale, marginsStr, pageRanges, pageRangesValid, regeneratePreview]);function handleClose() {+ requestIdRef.current++;setShown(false);isFirstGenerationRef.current = true;setError(undefined);diff --git a/apps/desktop/src/preload.ts b/apps/desktop/src/preload.tsindex c7cd50e06a..8dac0decaa 100644--- a/apps/desktop/src/preload.ts+++ b/apps/desktop/src/preload.ts@@ -198,7 +198,7 @@ contextBridge.exposeInMainWorld("electronApi", {exportAsPdfPreview(opts: Record<string, unknown>) {ipcRenderer.send("export-as-pdf-preview", opts);},- onExportAsPdfPreviewResult(callback: (result: { buffer?: Uint8Array; error?: string }) => void) {+ onExportAsPdfPreviewResult(callback: (result: { buffer?: Uint8Array; error?: string; requestId?: number }) => void) {ipcRenderer.on("export-as-pdf-preview-result", (_event, result) => callback(result));},removeExportAsPdfPreviewResultListener() {diff --git a/apps/desktop/src/services/printing.spec.ts b/apps/desktop/src/services/printing.spec.tsindex ed84db401d..f0069595b8 100644--- a/apps/desktop/src/services/printing.spec.ts+++ b/apps/desktop/src/services/printing.spec.ts@@ -101,7 +101,8 @@ const PDF_OPTS = {pageSize: "A4" as const,scale: 1,margins: "default",- pageRanges: ""+ pageRanges: "",+ requestId: 7};describe("printing — pure helpers", () => {@@ -290,30 +291,30 @@ describe("setupPrintingHandlers", () => {describe("export-as-pdf-preview", () => {it("returns the rendered buffer to the renderer", async () => {const e = await fireOn("export-as-pdf-preview", PDF_OPTS);- expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", expect.objectContaining({ notePath: "root/abc", buffer: expect.any(Buffer) }));+ expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", expect.objectContaining({ notePath: "root/abc", requestId: 7, buffer: expect.any(Buffer) }));expect(e.sender.send).toHaveBeenCalledWith("print-done", "REPORT");});it("returns an error result when rendering fails (Error and non-Error)", async () => {h.printToPDF.mockRejectedValue(new Error("render boom"));const e1 = await fireOn("export-as-pdf-preview", PDF_OPTS);- expect(e1.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "render boom" });+ expect(e1.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "render boom" });h.printToPDF.mockRejectedValue("render string");const e2 = await fireOn("export-as-pdf-preview", PDF_OPTS);- expect(e2.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "render string" });+ expect(e2.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "render string" });});it("returns an error result and destroys the window when the print window fails (Error and non-Error)", async () => {h.loadURL.mockRejectedValue(new Error("load failed"));const e1 = await fireOn("export-as-pdf-preview", PDF_OPTS);- expect(e1.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "load failed" });+ expect(e1.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "load failed" });expect(e1.sender.send).not.toHaveBeenCalledWith("print-done", expect.anything());expect(h.destroy).toHaveBeenCalledTimes(1);h.loadURL.mockRejectedValue("load string");const e2 = await fireOn("export-as-pdf-preview", PDF_OPTS);- expect(e2.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "load string" });+ expect(e2.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "load string" });});});@@ -336,7 +337,7 @@ describe("setupPrintingHandlers", () => {await vi.advanceTimersByTimeAsync(1);await done;- expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "pdf.render-timeout" });+ expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "pdf.render-timeout" });expect(h.printToPDF).not.toHaveBeenCalled();expect(h.destroy).toHaveBeenCalledTimes(1);expect(h.off).toContainEqual(["print-progress", expect.any(Function)]);@@ -381,7 +382,7 @@ describe("setupPrintingHandlers", () => {await vi.advanceTimersByTimeAsync(1);await done;- expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", error: "pdf.render-timeout" });+ expect(e.sender.send).toHaveBeenCalledWith("export-as-pdf-preview-result", { notePath: "root/abc", requestId: 7, error: "pdf.render-timeout" });expect(h.destroy).toHaveBeenCalledTimes(1);});});diff --git a/apps/desktop/src/services/printing.ts b/apps/desktop/src/services/printing.tsindex fd1af0beba..4986acf530 100644--- a/apps/desktop/src/services/printing.ts+++ b/apps/desktop/src/services/printing.ts@@ -49,6 +49,11 @@ interface ExportAsPdfOpts {pageRanges: string;}+interface PreviewOpts extends ExportAsPdfOpts {+ /** Echoed back with the result so the dialog can drop results of superseded requests. */+ requestId: number;+}+interface PrintFromPreviewOpts extends ExportAsPdfOpts {silent: boolean;deviceName?: string;@@ -314,7 +319,7 @@ export function setupPrintingHandlers() {}});- electron.ipcMain.on("export-as-pdf-preview", async (e, { notePath, landscape, pageSize, scale, margins, pageRanges }: ExportAsPdfOpts) => {+ electron.ipcMain.on("export-as-pdf-preview", async (e, { notePath, requestId, landscape, pageSize, scale, margins, pageRanges }: PreviewOpts) => {try {const { browserWindow, printReport } = await getBrowserWindowForPrinting(e, notePath, "exporting_pdf");@@ -337,17 +342,17 @@ export function setupPrintingHandlers() {`});- e.sender.send("export-as-pdf-preview-result", { buffer, notePath });+ e.sender.send("export-as-pdf-preview-result", { buffer, notePath, requestId });} catch (err) {const message = err instanceof Error ? err.message : String(err);- e.sender.send("export-as-pdf-preview-result", { notePath, error: message });+ e.sender.send("export-as-pdf-preview-result", { notePath, requestId, error: message });} finally {e.sender.send("print-done", printReport);browserWindow.destroy();}} catch (err) {// The preview dialog reports the error itself, so no `print-done` goes out.- e.sender.send("export-as-pdf-preview-result", { notePath, error: err instanceof Error ? err.message : String(err) });+ e.sender.send("export-as-pdf-preview-result", { notePath, requestId, error: err instanceof Error ? err.message : String(err) });}});diff --git a/packages/commons/src/lib/electron_api_interface.ts b/packages/commons/src/lib/electron_api_interface.tsindex 7584944087..6c6b5f7192 100644--- a/packages/commons/src/lib/electron_api_interface.ts+++ b/packages/commons/src/lib/electron_api_interface.ts@@ -413,7 +413,7 @@ export interface ElectronPrintingApi {exportAsPdfPreview(opts: Record<string, unknown>): void;/** Subscribes to the result of an {@link exportAsPdfPreview} call. */- onExportAsPdfPreviewResult(callback: (result: { buffer?: Uint8Array; error?: string }) => void): void;+ onExportAsPdfPreviewResult(callback: (result: { buffer?: Uint8Array; error?: string; requestId?: number }) => void): void;/** Removes the listener registered via {@link onExportAsPdfPreviewResult}. */removeExportAsPdfPreviewResultListener(): void;