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(client): rebuild froca inside the frontend-update queue
Elian Doran620556263b4f
diff --git a/apps/client/src/services/froca.ts b/apps/client/src/services/froca.tsindex 52f94e8fa4..6e29f6c8e6 100644--- a/apps/client/src/services/froca.ts+++ b/apps/client/src/services/froca.ts@@ -67,7 +67,8 @@ class FrocaImpl implements Froca {/*** Replaces everything froca holds with the backend's current state: the initial tree, then- * the notes froca held outside it, which open tabs and widgets can still refer to.+ * the notes froca held outside it, which open tabs and widgets can still refer to. Run it+ * through `reloadFroca()` in ws.ts, which keeps entity changes from applying meanwhile.*/async reloadAll() {const allNoteIds = Object.keys(this.notes);diff --git a/apps/client/src/services/protected_session.spec.ts b/apps/client/src/services/protected_session.spec.tsindex 43bca0b928..c6a62e30e5 100644--- a/apps/client/src/services/protected_session.spec.ts+++ b/apps/client/src/services/protected_session.spec.ts@@ -6,8 +6,9 @@ import { beforeAll, beforeEach, describe, expect, it, vi } from "vitest";// override ws.js for this spec to CAPTURE them (hoisted so the factory runs// before any transitive load of the module under test). protected_session only// consumes `subscribeToMessages`; nothing else in its graph needs ws at load.-const { messageHandlers } = vi.hoisted(() => ({- messageHandlers: [] as ((message: any) => Promise<void> | void)[]+const { messageHandlers, reloadFroca } = vi.hoisted(() => ({+ messageHandlers: [] as ((message: any) => Promise<void> | void)[],+ reloadFroca: vi.fn(async () => {})}));vi.mock("./ws.js", () => ({@@ -15,7 +16,8 @@ vi.mock("./ws.js", () => ({subscribeToMessages(cb: (message: any) => Promise<void> | void) {messageHandlers.push(cb);},- waitForMaxKnownEntityChangeId: async () => {}+ waitForMaxKnownEntityChangeId: async () => {},+ reloadFroca}}));@@ -30,7 +32,6 @@ vi.mock("./i18n.js", () => ({}));import appContext from "../components/app_context.js";-import froca from "./froca.js";import options from "./options.js";import protectedSessionHolder from "./protected_session_holder.js";import server from "./server.js";@@ -157,11 +158,8 @@ describe("protectNote", () => {});describe("protectedSessionLogin / logout ws handler", () => {- it("reloads data, fires events, resolves a pending deferred, and shows a message on login", async () => {- // Build a note so reloadData has something to gather/reload.- const note = froca.notes;- froca.loadInitialTree = vi.fn(async () => ({}) as any);- froca.reloadNotes = vi.fn(async () => {});+ it("reloads froca, fires events, resolves a pending deferred, and shows a message on login", async () => {+ reloadFroca.mockClear();const triggerEvent = vi.spyOn(appContext, "triggerEvent").mockResolvedValue(undefined as any);const triggerCommand = vi.spyOn(appContext, "triggerCommand").mockReturnValue(undefined as any);const showMessage = vi.spyOn(toastService, "showMessage").mockReturnValue(undefined as any);@@ -173,9 +171,7 @@ describe("protectedSessionLogin / logout ws handler", () => {await dispatch({ type: "protectedSessionLogin" });- expect(froca.loadInitialTree).toHaveBeenCalled();- expect(froca.reloadNotes).toHaveBeenCalledWith(Object.keys(note));- expect(triggerEvent).toHaveBeenCalledWith("frocaReloaded", {});+ expect(reloadFroca).toHaveBeenCalledTimes(1);expect(triggerEvent).toHaveBeenCalledWith("protectedSessionStarted", {});expect(triggerCommand).toHaveBeenCalledWith("closeProtectedSessionPasswordDialog");expect(showMessage).toHaveBeenCalled();@@ -185,8 +181,6 @@ describe("protectedSessionLogin / logout ws handler", () => {});it("handles login when no deferred is pending", async () => {- froca.loadInitialTree = vi.fn(async () => ({}) as any);- froca.reloadNotes = vi.fn(async () => {});vi.spyOn(appContext, "triggerEvent").mockResolvedValue(undefined as any);vi.spyOn(appContext, "triggerCommand").mockReturnValue(undefined as any);const showMessage = vi.spyOn(toastService, "showMessage").mockReturnValue(undefined as any);@@ -205,12 +199,12 @@ describe("protectedSessionLogin / logout ws handler", () => {});it("ignores unrelated message types", async () => {- froca.loadInitialTree = vi.fn(async () => ({}) as any);+ reloadFroca.mockClear();const reload = vi.spyOn(utils, "reloadFrontendApp").mockReturnValue(undefined as any);await dispatch({ type: "somethingElse" });- expect(froca.loadInitialTree).not.toHaveBeenCalled();+ expect(reloadFroca).not.toHaveBeenCalled();expect(reload).not.toHaveBeenCalled();});});diff --git a/apps/client/src/services/protected_session.ts b/apps/client/src/services/protected_session.tsindex ea68e443f8..9e4a3d649c 100644--- a/apps/client/src/services/protected_session.ts+++ b/apps/client/src/services/protected_session.ts@@ -4,7 +4,6 @@ import toastService from "./toast.js";import type { ToastOptionsWithRequiredId } from "./toast.js";import ws from "./ws.js";import appContext from "../components/app_context.js";-import froca from "./froca.js";import utils from "./utils.js";import options from "./options.js";import { t } from "./i18n.js";@@ -63,9 +62,7 @@ async function setupProtectedSession(password: string) {ws.subscribeToMessages(async (message) => {if (message.type === "protectedSessionLogin") {- await froca.reloadAll();-- await appContext.triggerEvent("frocaReloaded", {});+ await ws.reloadFroca();appContext.triggerEvent("protectedSessionStarted", {});diff --git a/apps/client/src/services/ws.spec.ts b/apps/client/src/services/ws.spec.tsindex 790efeaeb7..8aeb50d465 100644--- a/apps/client/src/services/ws.spec.ts+++ b/apps/client/src/services/ws.spec.ts@@ -233,6 +233,41 @@ describe("frontend-update / executeFrontendUpdate", () => {// the third consumer found nothing left -> only 2 real processing callsexpect(frocaUpdater.processEntityChanges).toHaveBeenCalledTimes(2);});++ it("runs a froca rebuild and entity changes one after the other, in either order", async () => {+ const ws = await loadWs();+ const { default: froca } = await import("./froca.js");+ const settle = () => new Promise((res) => setTimeout(res, 0));+ const update = (id: number) => ws.dispatchMessage({+ type: "frontend-update", data: { entityChanges: [{ id, entityName: "notes", entityId: `r${id}` }] }+ } as any);+ const rebuild = () => ws.dispatchMessage({ type: "reload-froca", reason: "test" } as WebSocketMessage);++ let finishRebuild = () => {};+ const reloadAll = vi.spyOn(froca, "reloadAll")+ .mockImplementationOnce(() => new Promise<void>((res) => { finishRebuild = res; }))+ .mockResolvedValue(undefined);+ const firstRebuild = rebuild();+ await settle();+ const updateDuringRebuild = update(301);+ await settle();+ expect(frocaUpdater.processEntityChanges).not.toHaveBeenCalled();+ finishRebuild();+ await Promise.all([ firstRebuild, updateDuringRebuild ]);+ expect(frocaUpdater.processEntityChanges).toHaveBeenCalledTimes(1);++ let finishUpdate = () => {};+ frocaUpdater.processEntityChanges+ .mockImplementationOnce(() => new Promise<void>((res) => { finishUpdate = res; }));+ const heldUpdate = update(302);+ await settle();+ const rebuildDuringUpdate = rebuild();+ await settle();+ expect(reloadAll).toHaveBeenCalledTimes(1);+ finishUpdate();+ await Promise.all([ heldUpdate, rebuildDuringUpdate ]);+ expect(reloadAll).toHaveBeenCalledTimes(2);+ });});describe("waitForMaxKnownEntityChangeId", () => {diff --git a/apps/client/src/services/ws.ts b/apps/client/src/services/ws.tsindex 5253fde396..ea855dc534 100644--- a/apps/client/src/services/ws.ts+++ b/apps/client/src/services/ws.ts@@ -97,8 +97,7 @@ export async function dispatchMessage(message: WebSocketMessage) {utils.reloadFrontendApp("received request from backend to reload frontend");} else if (messageType === "reload-froca") {logInfo(`Reloading froca: ${msg.reason}`);- await froca.reloadAll();- await appContext.triggerEvent("frocaReloaded", {});+ await reloadFroca();} else if (messageType === "frontend-update") {await executeFrontendUpdate(msg.data.entityChanges);} else if (messageType === "sync-hash-check-failed") {@@ -165,20 +164,35 @@ async function executeFrontendUpdate(entityChanges: EntityChange[]) {sendPing();- // first wait for all the preceding consumers to finish- while (consumeQueuePromise) {- await consumeQueuePromise;- }+ await runInUpdateQueue(consumeFrontendUpdateData);+ }+}- try {- // it's my turn, so start it up- consumeQueuePromise = consumeFrontendUpdateData();+/**+ * Rebuilds froca from the backend and has the widgets switch to the new objects. It runs in the+ * update queue, so entity changes that arrive meanwhile apply on top of the rebuilt cache.+ */+export async function reloadFroca() {+ await runInUpdateQueue(async () => {+ await froca.reloadAll();+ await appContext.triggerEvent("frocaReloaded", {});+ });+}- await consumeQueuePromise;- } finally {- // finish and set to null to signal somebody else can pick it up- consumeQueuePromise = null;- }+async function runInUpdateQueue(task: () => Promise<void>) {+ // first wait for all the preceding consumers to finish+ while (consumeQueuePromise) {+ await consumeQueuePromise;+ }++ try {+ // it's my turn, so start it up+ consumeQueuePromise = task();++ await consumeQueuePromise;+ } finally {+ // finish and set to null to signal somebody else can pick it up+ consumeQueuePromise = null;}}@@ -370,5 +384,6 @@ export default {logError,subscribeToMessages,waitForMaxKnownEntityChangeId,+ reloadFroca,getMaxKnownEntityChangeSyncId: () => lastAcceptedEntityChangeSyncId};