Skip to content

Build your personal knowledge base with Trilium Notes

fix(pdf): address every viewer message to the note context that sent it

Elian Doran2623a97204d0
diff --git a/apps/client/src/types-pdfjs.d.ts b/apps/client/src/types-pdfjs.d.ts
index c701375644..34f871c6e5 100644
--- a/apps/client/src/types-pdfjs.d.ts
+++ b/apps/client/src/types-pdfjs.d.ts
@@ -84,28 +84,28 @@ interface PdfSaveSignaturesMessage extends WithContext {
data: string;
}
-interface PdfViewerTocMessage {
+interface PdfViewerTocMessage extends WithContext {
type: "pdfjs-viewer-toc";
data: PdfOutlineItem[];
}
-interface PdfViewerActiveHeadingMessage {
+interface PdfViewerActiveHeadingMessage extends WithContext {
type: "pdfjs-viewer-active-heading";
headingId: string;
}
-interface PdfViewerPageInfoMessage {
+interface PdfViewerPageInfoMessage extends WithContext {
type: "pdfjs-viewer-page-info";
totalPages: number;
currentPage: number;
}
-interface PdfViewerCurrentPageMessage {
+interface PdfViewerCurrentPageMessage extends WithContext {
type: "pdfjs-viewer-current-page";
currentPage: number;
}
-interface PdfViewerThumbnailMessage {
+interface PdfViewerThumbnailMessage extends WithContext {
type: "pdfjs-viewer-thumbnail";
pageNumber: number;
dataUrl: string;
@@ -118,7 +118,7 @@ interface PdfAttachment {
size: number;
}
-interface PdfViewerAttachmentsMessage {
+interface PdfViewerAttachmentsMessage extends WithContext {
type: "pdfjs-viewer-attachments";
attachments: PdfAttachment[];
downloadAttachment?: (id: string) => void;
@@ -130,7 +130,7 @@ interface PdfLayer {
visible: boolean;
}
-interface PdfViewerLayersMessage {
+interface PdfViewerLayersMessage extends WithContext {
type: "pdfjs-viewer-layers";
layers: PdfLayer[];
toggleLayer?: (layerId: string, visible: boolean) => void;
@@ -148,7 +148,7 @@ interface PdfAnnotationInfo {
modificationDate: string | null;
}
-interface PdfViewerAnnotationsMessage {
+interface PdfViewerAnnotationsMessage extends WithContext {
type: "pdfjs-viewer-annotations";
annotations: PdfAnnotationInfo[];
}
diff --git a/apps/client/src/widgets/sidebar/pdf/PdfPages.tsx b/apps/client/src/widgets/sidebar/pdf/PdfPages.tsx
index 985deacb3b..7f71007117 100644
--- a/apps/client/src/widgets/sidebar/pdf/PdfPages.tsx
+++ b/apps/client/src/widgets/sidebar/pdf/PdfPages.tsx
@@ -13,7 +13,7 @@ const ROW_HEIGHT = 180;
const COLUMNS = 2;
export default function PdfPages() {
- const { note } = useActiveNoteContext();
+ const { note, noteContext } = useActiveNoteContext();
const noteType = useNoteProperty(note, "type");
const noteMime = useNoteProperty(note, "mime");
const pagesData = useGetContextData("pdfPages");
@@ -24,12 +24,12 @@ export default function PdfPages() {
return (pagesData &&
<RightPanelWidget id="pdf-pages" title={t("pdf.pages", { count: pagesData?.totalPages || 0 })} grow>
- <PdfPagesList key={note?.noteId} pagesData={pagesData} />
+ <PdfPagesList key={note?.noteId} pagesData={pagesData} ntxId={noteContext?.ntxId} />
</RightPanelWidget>
);
}
-function PdfPagesList({ pagesData }: { pagesData: NoteContextDataMap["pdfPages"] }) {
+function PdfPagesList({ pagesData, ntxId }: { pagesData: NoteContextDataMap["pdfPages"]; ntxId: string | null | undefined }) {
const [thumbnails, setThumbnails] = useState<Map<number, string>>(new Map());
const requestedThumbnails = useRef<Set<number>>(new Set());
const containerRef = useRef<HTMLDivElement>(null);
@@ -37,6 +37,8 @@ function PdfPagesList({ pagesData }: { pagesData: NoteContextDataMap["pdfPages"]
useEffect(() => {
function handleThumbnail(event: CustomEvent) {
+ // Another open PDF renders onto the same window; its pages are not these.
+ if (event.detail.ntxId !== ntxId) return;
const { pageNumber, dataUrl } = event.detail;
setThumbnails(prev => new Map(prev).set(pageNumber, dataUrl));
}
@@ -45,7 +47,7 @@ function PdfPagesList({ pagesData }: { pagesData: NoteContextDataMap["pdfPages"]
return () => {
window.removeEventListener("pdf-thumbnail", handleThumbnail as EventListener);
};
- }, []);
+ }, [ ntxId ]);
useEffect(() => {
const el = containerRef.current;
diff --git a/apps/client/src/widgets/type_widgets/file/Pdf.tsx b/apps/client/src/widgets/type_widgets/file/Pdf.tsx
index 2ee315b9e9..9f35c2d5d5 100644
--- a/apps/client/src/widgets/type_widgets/file/Pdf.tsx
+++ b/apps/client/src/widgets/type_widgets/file/Pdf.tsx
@@ -65,25 +65,26 @@ export default function PdfPreview({ note, blob, componentId, noteContext }: {
useEffect(() => {
function handleMessage(event: PdfMessageEvent) {
- if (event.data?.type === "pdfjs-viewer-document-modified") {
- if (!isReadOnly && event.data.noteId === note.noteId && event.data.ntxId === noteContext.ntxId) {
- spacedUpdate.resetUpdateTimer();
- spacedUpdate.scheduleUpdate();
- }
+ // Every viewer posts to the shared parent window, so a second one — a split, or
+ // another tab that has been opened — delivers its messages here as well.
+ // Everything below writes this note context's data or talks to this iframe, so
+ // a message addressed to a different viewer would show one document's
+ // annotations while navigating another's.
+ if (event.data?.noteId !== note.noteId || event.data?.ntxId !== noteContext.ntxId) return;
+
+ if (event.data?.type === "pdfjs-viewer-document-modified" && !isReadOnly) {
+ spacedUpdate.resetUpdateTimer();
+ spacedUpdate.scheduleUpdate();
}
if (event.data.type === "pdfjs-viewer-save-view-history" && event.data?.data) {
- if (event.data.noteId === note.noteId && event.data.ntxId === noteContext.ntxId) {
- historyConfig?.storeFn(JSON.parse(event.data.data));
- }
+ historyConfig?.storeFn(JSON.parse(event.data.data));
}
if (event.data?.type === "pdfjs-viewer-save-signatures" && event.data?.data) {
- // The signature library is global (not per-note), but scope the write to this
- // viewer instance so multiple open PDFs don't each re-save the same payload.
- if (event.data.noteId === note.noteId && event.data.ntxId === noteContext.ntxId) {
- options.save("pdfSignatures", event.data.data);
- }
+ // The library is global rather than per-note; the guard above keeps every open
+ // PDF from re-saving the same payload.
+ options.save("pdfSignatures", event.data.data);
}
if (event.data.type === "pdfjs-viewer-toc") {
@@ -150,9 +151,12 @@ export default function PdfPreview({ note, blob, componentId, noteContext }: {
}
if (event.data.type === "pdfjs-viewer-thumbnail") {
- // Forward thumbnail to any listeners
+ // Relayed on the window rather than through context data because thumbnails
+ // arrive one at a time; the page list keys them itself. It carries the context it
+ // was rendered for, since a second viewer relays onto the same window.
window.dispatchEvent(new CustomEvent("pdf-thumbnail", {
detail: {
+ ntxId: noteContext.ntxId,
pageNumber: event.data.pageNumber,
dataUrl: event.data.dataUrl
}
diff --git a/packages/pdfjs-viewer/src/annotations.ts b/packages/pdfjs-viewer/src/annotations.ts
index f8457855d1..c39bc8c6b1 100644
--- a/packages/pdfjs-viewer/src/annotations.ts
+++ b/packages/pdfjs-viewer/src/annotations.ts
@@ -191,7 +191,9 @@ function applyEditorOverrides(annotations: PdfAnnotationInfo[], storage: any): P
function sendAnnotations(annotations: PdfAnnotationInfo[]) {
window.parent.postMessage({
type: "pdfjs-viewer-annotations",
- annotations
+ annotations,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerAnnotationsMessage, window.location.origin);
}
diff --git a/packages/pdfjs-viewer/src/attachments.ts b/packages/pdfjs-viewer/src/attachments.ts
index eec06ca929..e1c22e4450 100644
--- a/packages/pdfjs-viewer/src/attachments.ts
+++ b/packages/pdfjs-viewer/src/attachments.ts
@@ -51,7 +51,9 @@ async function extractAndSendAttachments() {
window.parent.postMessage({
type: "pdfjs-viewer-attachments",
- attachments
+ attachments,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerAttachmentsMessage, window.location.origin);
}
diff --git a/packages/pdfjs-viewer/src/bootstrap.spec.ts b/packages/pdfjs-viewer/src/bootstrap.spec.ts
index 0b80aa9824..c6c3a7490d 100644
--- a/packages/pdfjs-viewer/src/bootstrap.spec.ts
+++ b/packages/pdfjs-viewer/src/bootstrap.spec.ts
@@ -103,6 +103,28 @@ describe("boot sequence", () => {
expect(viewer.messagesOfType("pdfjs-viewer-document-modified")).toHaveLength(1);
});
+ it("addresses every message to the viewer that sent it", async () => {
+ viewer = await installViewerApp(allFeaturesPdf());
+ await bootWith("editable=1");
+
+ viewer.eventBus.dispatch("documentloaded", { source: null });
+ await vi.waitFor(() => expect(viewer.messagesOfType("pdfjs-viewer-annotations").length).toBeGreaterThan(0));
+
+ // Drive the senders that boot alone does not reach.
+ viewer.eventBus.dispatch("pagechanging", { source: null, pageNumber: 2 });
+ viewer.sendFromParent({ type: "trilium-request-thumbnail", pageNumber: 1 });
+ (viewer.pdfDocument.annotationStorage as any).setValue("field-1", { value: "typed" });
+ await vi.waitFor(() => expect(viewer.messagesOfType("pdfjs-viewer-current-page").length).toBeGreaterThan(0));
+
+ // A second open PDF posts onto the same parent window, so what each message carries is the
+ // only thing telling the two apart. One that says nothing is applied by whichever viewer
+ // happens to receive it — listing one document's annotations against another's pages.
+ expect(viewer.messages.length).toBeGreaterThan(0);
+ for (const message of viewer.messages) {
+ expect(message).toMatchObject({ type: expect.any(String), noteId: "note-1", ntxId: "ntx-1" });
+ }
+ });
+
it("applies the toolbar and sidebar switches from the URL", async () => {
document.body.innerHTML = `
<div id="viewsManagerToggleButton"></div>
diff --git a/packages/pdfjs-viewer/src/layers.ts b/packages/pdfjs-viewer/src/layers.ts
index 95395525bb..614b5754e2 100644
--- a/packages/pdfjs-viewer/src/layers.ts
+++ b/packages/pdfjs-viewer/src/layers.ts
@@ -28,7 +28,9 @@ async function extractAndSendLayers() {
if (!optionalContentConfig) {
window.parent.postMessage({
type: "pdfjs-viewer-layers",
- layers: []
+ layers: [],
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerLayersMessage, window.location.origin);
return;
}
@@ -38,7 +40,9 @@ async function extractAndSendLayers() {
if (!order || order.length === 0) {
window.parent.postMessage({
type: "pdfjs-viewer-layers",
- layers: []
+ layers: [],
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerLayersMessage, window.location.origin);
return;
}
@@ -79,13 +83,17 @@ async function extractAndSendLayers() {
window.parent.postMessage({
type: "pdfjs-viewer-layers",
- layers
+ layers,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerLayersMessage, window.location.origin);
} catch (error) {
console.error("Error extracting layers:", error);
window.parent.postMessage({
type: "pdfjs-viewer-layers",
- layers: []
+ layers: [],
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerLayersMessage, window.location.origin);
}
}
diff --git a/packages/pdfjs-viewer/src/pages.ts b/packages/pdfjs-viewer/src/pages.ts
index 866e996208..59f3b81b8b 100644
--- a/packages/pdfjs-viewer/src/pages.ts
+++ b/packages/pdfjs-viewer/src/pages.ts
@@ -15,7 +15,9 @@ export function setupPdfPages() {
app.eventBus.on("pagechanging", (evt: any) => {
window.parent.postMessage({
type: "pdfjs-viewer-current-page",
- currentPage: evt.pageNumber
+ currentPage: evt.pageNumber,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerCurrentPageMessage, window.location.origin);
});
@@ -41,7 +43,9 @@ function sendPageInfo() {
window.parent.postMessage({
type: "pdfjs-viewer-page-info",
totalPages: app.pdfDocument.numPages,
- currentPage: app.pdfViewer.currentPageNumber
+ currentPage: app.pdfViewer.currentPageNumber,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerPageInfoMessage, window.location.origin);
}
@@ -74,7 +78,9 @@ async function generateThumbnail(pageNumber: number) {
window.parent.postMessage({
type: "pdfjs-viewer-thumbnail",
pageNumber,
- dataUrl
+ dataUrl,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerThumbnailMessage, window.location.origin);
} catch (error) {
console.error(`Error generating thumbnail for page %d:`, pageNumber, error);
diff --git a/packages/pdfjs-viewer/src/toc.ts b/packages/pdfjs-viewer/src/toc.ts
index 9ba8777098..9224c60777 100644
--- a/packages/pdfjs-viewer/src/toc.ts
+++ b/packages/pdfjs-viewer/src/toc.ts
@@ -10,7 +10,9 @@ export async function extractAndSendToc() {
if (!outline || outline.length === 0) {
window.parent.postMessage({
type: "pdfjs-viewer-toc",
- data: null
+ data: null,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerTocMessage, window.location.origin);
return;
}
@@ -25,12 +27,16 @@ export async function extractAndSendToc() {
window.parent.postMessage({
type: "pdfjs-viewer-toc",
- data: toc
+ data: toc,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerTocMessage, window.location.origin);
} catch (error) {
window.parent.postMessage({
type: "pdfjs-viewer-toc",
- data: null
+ data: null,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerTocMessage, window.location.origin);
}
}
@@ -164,7 +170,9 @@ export function setupActiveHeadingTracking() {
lastActiveHeading = activeHeadingId;
window.parent.postMessage({
type: "pdfjs-viewer-active-heading",
- headingId: activeHeadingId
+ headingId: activeHeadingId,
+ ntxId: window.TRILIUM_NTX_ID,
+ noteId: window.TRILIUM_NOTE_ID
} satisfies PdfViewerActiveHeadingMessage, window.location.origin);
}
}