Skip to content

Build your personal knowledge base with Trilium Notes

feat(share): prerender the page behind a link the visitor is about to open

Elian Dorand72cb6193b79
diff --git a/packages/share-theme/src/index.spec.ts b/packages/share-theme/src/index.spec.ts
index 5686ff860f..84c6e706c3 100644
--- a/packages/share-theme/src/index.spec.ts
+++ b/packages/share-theme/src/index.spec.ts
@@ -11,6 +11,8 @@ const mocks = vi.hoisted(() => ({
setupSearch: vi.fn().mockRejectedValue(new Error("search failed")),
setupToC: vi.fn(),
setupFooter: vi.fn(),
+ setupSpeculation: vi.fn(),
+ whenActivated: vi.fn((callback: () => void) => callback()),
setupMath: vi.fn(),
setupMermaid: vi.fn(),
applyTabs: vi.fn(),
@@ -27,6 +29,10 @@ vi.mock("./page/theme_switch.js", () => ({ default: mocks.setupThemeSelector }))
vi.mock("./page/search.js", () => ({ default: mocks.setupSearch }));
vi.mock("./page/toc.js", () => ({ default: mocks.setupToC }));
vi.mock("./page/footer.js", () => ({ default: mocks.setupFooter }));
+vi.mock("./page/speculation.js", () => ({
+ default: mocks.setupSpeculation,
+ whenActivated: mocks.whenActivated
+}));
vi.mock("./content/math.js", () => ({ default: mocks.setupMath }));
vi.mock("./content/mermaid.js", () => ({ default: mocks.setupMermaid }));
vi.mock("@triliumnext/ckeditor5/src/plugins/tabs/tabs_read_only.js", () => ({
@@ -43,13 +49,16 @@ describe("share theme entry", () => {
// Vitest clears the calls of every mock before each test.
let pageSetupCalls: number[] = [];
let loggedErrors: unknown[] = [];
+ let deferredSetups = 0;
beforeAll(async () => {
await import("./index.js");
await vi.waitFor(() => expect(consoleError).toHaveBeenCalledTimes(2));
pageSetupCalls = [ mocks.setupThemeSelector, mocks.setupToC, mocks.setupExpanders,
- mocks.setupTreeState, mocks.setupLayout, mocks.setupSearch, mocks.setupFooter ]
+ mocks.setupTreeState, mocks.setupLayout, mocks.setupSearch, mocks.setupFooter,
+ mocks.setupSpeculation ]
.map((setup) => setup.mock.calls.length);
+ deferredSetups = mocks.whenActivated.mock.calls.length;
loggedErrors = consoleError.mock.calls.map(([ error ]) => (error as Error).message);
});
@@ -61,7 +70,9 @@ describe("share theme entry", () => {
});
it("sets up every part of the page, logging what one throws or rejects with", () => {
- expect(pageSetupCalls).toEqual([ 1, 1, 1, 1, 1, 1, 1 ]);
+ expect(pageSetupCalls).toEqual([ 1, 1, 1, 1, 1, 1, 1, 1 ]);
+ // The theme and the tree's state wait for a prerendered page to be shown.
+ expect(deferredSetups).toBe(2);
expect(loggedErrors.sort()).toEqual([ "search failed", "theme switch failed" ]);
});
diff --git a/packages/share-theme/src/index.ts b/packages/share-theme/src/index.ts
index e8e781cc4f..23dd8c8e1b 100644
--- a/packages/share-theme/src/index.ts
+++ b/packages/share-theme/src/index.ts
@@ -9,6 +9,7 @@ import setupSearch from "./page/search.js";
import setupToC from "./page/toc.js";
import "./page/child_links.css";
import setupFooter from "./page/footer.js";
+import setupSpeculation, { whenActivated } from "./page/speculation.js";
import "./content/content.css";
import "./content/footnotes.css";
import "./content/external_links.css";
@@ -44,13 +45,15 @@ async function fetchNote(noteId: string | null = null) {
}
Object.assign(window, { fetchNote });
-$try(setupThemeSelector);
+// A prerendered page reads the theme and the tree's state once it is shown, not while prerendering.
+whenActivated(() => $try(setupThemeSelector));
$try(setupToC);
$try(setupExpanders);
-$try(setupTreeState);
+whenActivated(() => $try(setupTreeState));
$try(setupLayout);
$try(setupSearch);
$try(setupFooter);
+$try(setupSpeculation);
function setupTextNote() {
$try(setupMermaid);
diff --git a/packages/share-theme/src/page/navigation.spec.ts b/packages/share-theme/src/page/navigation.spec.ts
index 01519b13ab..b1a1b85e16 100644
--- a/packages/share-theme/src/page/navigation.spec.ts
+++ b/packages/share-theme/src/page/navigation.spec.ts
@@ -95,6 +95,16 @@ describe("setupTreeState", () => {
expect(pane().scrollTop).toBe(0);
});
+ it("saves the pane's state before a prerendered page replaces this one", () => {
+ renderPane("site1", { activeTop: 120 });
+ setupTreeState();
+ pane().scrollTop = 40;
+ window.dispatchEvent(new Event("pageswap"));
+
+ expect(JSON.parse(sessionStorage.getItem("share-tree-state") ?? "null"))
+ .toMatchObject({ siteId: "site1", top: 40 });
+ });
+
it("remembers the expanded pages of a site, also on pages that expand others", () => {
renderPane("site1", { menu: TREE });
setupExpanders();
diff --git a/packages/share-theme/src/page/navigation.ts b/packages/share-theme/src/page/navigation.ts
index c969062b50..322a03de4c 100644
--- a/packages/share-theme/src/page/navigation.ts
+++ b/packages/share-theme/src/page/navigation.ts
@@ -97,7 +97,8 @@ export function setupTreeState() {
}
});
- window.addEventListener("pagehide", () => {
+ // `pageswap` fires before a prerendered page is shown, `pagehide` only once this one unloads.
+ const saveState = () => {
const expandedItems = pane.querySelectorAll<HTMLElement>("#menu li.expanded[data-note-id]");
const expanded = [ ...expandedItems ].map((item) => item.dataset.noteId);
const state = { siteId, top: pane.scrollTop, expanded, activePath };
@@ -106,7 +107,9 @@ export function setupTreeState() {
} catch {
// The next page then starts from the server's expansion and the current note.
}
- });
+ };
+ window.addEventListener("pageswap", saveState);
+ window.addEventListener("pagehide", saveState);
}
/**
diff --git a/packages/share-theme/src/page/speculation.spec.ts b/packages/share-theme/src/page/speculation.spec.ts
new file mode 100644
index 0000000000..32d14d6c09
--- /dev/null
+++ b/packages/share-theme/src/page/speculation.spec.ts
@@ -0,0 +1,76 @@
+// @vitest-environment happy-dom
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import setupSpeculation, { whenActivated } from "./speculation.js";
+
+describe("setupSpeculation", () => {
+ afterEach(() => {
+ document.head.innerHTML = "";
+ delete window.glob;
+ vi.restoreAllMocks();
+ });
+
+ it("prerenders the site's pages a visitor is about to open, leaving out files and the login", () => {
+ stubSupport(true);
+ window.glob = { isStatic: false, theme: "light" };
+
+ setupSpeculation();
+
+ const scripts = document.head.querySelectorAll("script[type=speculationrules]");
+ expect(scripts).toHaveLength(1);
+ expect(JSON.parse(scripts[0].textContent ?? "")).toStrictEqual({
+ prerender: [ {
+ where: {
+ and: [
+ { href_matches: "./*", relative_to: "document" },
+ { not: { href_matches: "./api/*", relative_to: "document" } },
+ { not: { selector_matches: "[target], [download], .login-link" } }
+ ]
+ },
+ eagerness: "moderate"
+ } ]
+ });
+ });
+
+ it("adds no rules to a static export or in a browser without speculation rules", () => {
+ stubSupport(true);
+ window.glob = { isStatic: true, theme: "light" };
+ setupSpeculation();
+
+ stubSupport(false);
+ window.glob = { isStatic: false, theme: "light" };
+ setupSpeculation();
+
+ vi.stubGlobal("HTMLScriptElement", {});
+ setupSpeculation();
+ vi.unstubAllGlobals();
+
+ expect(document.head.querySelector("script")).toBeNull();
+ });
+});
+
+describe("whenActivated", () => {
+ afterEach(() => {
+ Reflect.deleteProperty(document, "prerendering");
+ });
+
+ it("runs at once on a page being shown, and on activation on a prerendered one", () => {
+ const callback = vi.fn();
+ whenActivated(callback);
+ expect(callback).toHaveBeenCalledOnce();
+
+ callback.mockClear();
+ Object.defineProperty(document, "prerendering", { value: true, configurable: true });
+ whenActivated(callback);
+ expect(callback).not.toHaveBeenCalled();
+
+ document.dispatchEvent(new Event("prerenderingchange"));
+ document.dispatchEvent(new Event("prerenderingchange"));
+ expect(callback).toHaveBeenCalledOnce();
+ });
+});
+
+function stubSupport(isSupported: boolean) {
+ vi.spyOn(HTMLScriptElement, "supports")
+ .mockImplementation((type) => isSupported && type === "speculationrules");
+}
diff --git a/packages/share-theme/src/page/speculation.ts b/packages/share-theme/src/page/speculation.ts
new file mode 100644
index 0000000000..a2a22ae8a7
--- /dev/null
+++ b/packages/share-theme/src/page/speculation.ts
@@ -0,0 +1,40 @@
+/**
+ * Lets Chromium prerender the page behind a link of the site once the visitor holds the pointer on
+ * it or presses it (`moderate` eagerness), so the click shows a page already drawn. Links to files
+ * (`./api/…`), the login and links opening elsewhere are left out. A static export has no server
+ * to prerender from.
+ */
+export default function setupSpeculation() {
+ if (window.glob?.isStatic || !HTMLScriptElement.supports?.("speculationrules")) {
+ return;
+ }
+
+ const script = document.createElement("script");
+ script.type = "speculationrules";
+ script.textContent = JSON.stringify({
+ prerender: [ {
+ where: {
+ and: [
+ { href_matches: "./*", relative_to: "document" },
+ { not: { href_matches: "./api/*", relative_to: "document" } },
+ { not: { selector_matches: "[target], [download], .login-link" } }
+ ]
+ },
+ eagerness: "moderate"
+ } ]
+ });
+ document.head.append(script);
+}
+
+/**
+ * Runs `callback` once the page is shown: at once, or on activation for a prerendered page, whose
+ * scripts otherwise run while the visitor is still on the previous page and read its state too
+ * early.
+ */
+export function whenActivated(callback: () => void) {
+ if (document.prerendering) {
+ document.addEventListener("prerenderingchange", callback, { once: true });
+ } else {
+ callback();
+ }
+}
diff --git a/packages/share-theme/src/types.d.ts b/packages/share-theme/src/types.d.ts
index c6f2abbcf8..5c3a3d736f 100644
--- a/packages/share-theme/src/types.d.ts
+++ b/packages/share-theme/src/types.d.ts
@@ -7,3 +7,8 @@ interface Window {
theme: string;
};
}
+
+interface Document {
+ /** Whether the page is being prerendered (Speculation Rules); not yet in TypeScript's DOM types. */
+ readonly prerendering?: boolean;
+}