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
perf(share): read share templates once in development
Elian Doranc5ab62db82ea
diff --git a/apps/server/src/share/adapters.spec.ts b/apps/server/src/share/adapters.spec.tsindex eab9666e99..c66b65aba4 100644--- a/apps/server/src/share/adapters.spec.ts+++ b/apps/server/src/share/adapters.spec.ts@@ -70,18 +70,22 @@ describe("share routes", () => {});describe("share provider", () => {- it("registers once and reads a template from the sources on every use in development", async () => {- const { provider, readFileSync } = await registerProvider("development");+ it("registers once and reads a template from the sources again in development once it changes", async () => {+ const { provider, readFileSync, statSync } = await registerProvider("development");expect(provider.readTemplate("page")).toBe("template");expect(provider.readTemplate("page")).toBe("template");- expect(readFileSync).toHaveBeenCalledTimes(2);+ expect(readFileSync).toHaveBeenCalledOnce();expect(String(readFileSync.mock.calls[0][0]).replaceAll("\\", "/")).toMatch(/packages\/share-theme\/src\/templates\/page\.ejs$/);++ statSync.mockReturnValue({ mtimeMs: 2 });+ expect(provider.readTemplate("page")).toBe("template");+ expect(readFileSync).toHaveBeenCalledTimes(2);});it("reads each template once, from the resource directory, outside development", async () => {- const { provider, readFileSync } = await registerProvider("production");+ const { provider, readFileSync, statSync } = await registerProvider("production");expect(provider.readTemplate("404")).toBe("template");expect(provider.readTemplate("404")).toBe("template");@@ -89,18 +93,21 @@ describe("share provider", () => {expect(readFileSync).toHaveBeenCalledOnce();expect(String(readFileSync.mock.calls[0][0]).replaceAll("\\", "/")).toMatch(/^\/resources\/share-theme\/templates\/404\.ejs$/);+ expect(statSync).not.toHaveBeenCalled();});async function registerProvider(nodeEnv: string) {vi.stubEnv("NODE_ENV", nodeEnv);const readFileSync = vi.fn((_path: string) => "template");+ const statSync = vi.fn((_path: string) => ({ mtimeMs: 1 }));const initShare = vi.fn<(provider: ShareProvider) => void>();vi.resetModules();vi.doMock(SHARE_INDEX, () => ({ initShare }));vi.doMock("./sql.js", () => ({ default: {}, isShareDbReady: () => true }));vi.doMock("fs", async (importOriginal) => ({...await importOriginal<object>(),- readFileSync+ readFileSync,+ statSync}));vi.doMock("../services/utils.js", () => ({ getResourceDir: () => "/resources" }));vi.doMock("../services/scripting_guard.js", () => ({ isScriptingEnabled: () => false }));@@ -109,7 +116,7 @@ describe("share provider", () => {registerShareProvider();expect(initShare).toHaveBeenCalledOnce();- return { provider: initShare.mock.calls[0][0], readFileSync };+ return { provider: initShare.mock.calls[0][0], readFileSync, statSync };}});diff --git a/apps/server/src/share/share_provider.ts b/apps/server/src/share/share_provider.tsindex 1a7c16bea1..9b52c127af 100644--- a/apps/server/src/share/share_provider.ts+++ b/apps/server/src/share/share_provider.ts@@ -1,12 +1,12 @@import { initShare } from "@triliumnext/core/src/share/index.js";-import { readFileSync } from "fs";+import { readFileSync, statSync } from "fs";import { join } from "path";import { isScriptingEnabled } from "../services/scripting_guard.js";import { getResourceDir } from "../services/utils.js";import sql, { isShareDbReady } from "./sql.js";-const templateCache: Map<string, string> = new Map();+const templateCache = new Map<string, { template: string; modified: number }>();let registered = false;/**@@ -28,23 +28,21 @@ export function registerShareProvider() {registered = true;}-/** Reads a template of the share theme, from disk on every call in development so edits show at once. */+/**+ * Reads a template of the share theme once. In development it reads the file again once its+ * modification time changes, so edits show at once.+ */function readTemplate(name: string) {const path = getDefaultTemplatePath(name);- if (process.env.NODE_ENV === "development") {- return readFileSync(path, "utf-8");- }-- const cachedTemplate = templateCache.get(path);-- if (cachedTemplate) {- return cachedTemplate;+ const modified = process.env.NODE_ENV === "development" ? statSync(path).mtimeMs : 0;+ const cached = templateCache.get(path);+ if (cached?.modified === modified) {+ return cached.template;}- const templateString = readFileSync(path, "utf-8");- templateCache.set(path, templateString);-- return templateString;+ const template = readFileSync(path, "utf-8");+ templateCache.set(path, { template, modified });+ return template;}function getDefaultTemplatePath(template: string) {