diff --git a/apps/client/public/locales/en-US/translation.json b/apps/client/public/locales/en-US/translation.json index 9b57f724..a08029b9 100644 --- a/apps/client/public/locales/en-US/translation.json +++ b/apps/client/public/locales/en-US/translation.json @@ -1,4 +1,5 @@ { + "A new version is available": "A new version is available", "Account": "Account", "Active": "Active", "Add": "Add", diff --git a/apps/client/public/locales/ru-RU/translation.json b/apps/client/public/locales/ru-RU/translation.json index e22d8746..786d20cd 100644 --- a/apps/client/public/locales/ru-RU/translation.json +++ b/apps/client/public/locales/ru-RU/translation.json @@ -1,4 +1,5 @@ { + "A new version is available": "Доступна новая версия", "Account": "Аккаунт", "Active": "Активный", "Add": "Добавить", diff --git a/apps/client/src/components/chunk-load-error-boundary.tsx b/apps/client/src/components/chunk-load-error-boundary.tsx index e28dfe26..c1cd585d 100644 --- a/apps/client/src/components/chunk-load-error-boundary.tsx +++ b/apps/client/src/components/chunk-load-error-boundary.tsx @@ -1,26 +1,11 @@ import { ReactNode } from "react"; import { ErrorBoundary } from "react-error-boundary"; import { Button, Center, Stack, Text } from "@mantine/core"; - -// sessionStorage key holding the epoch-ms timestamp of the last automatic reload. -const RELOAD_AT_KEY = "chunk-reload-at"; -// Allow at most one automatic reload per this window. A stale-deploy 404 is cured -// by a single reload, so anything inside the window is treated as a reload loop -// (permanently-broken chunk) and falls through to the manual UI. A window (rather -// than a one-shot flag) lets a SECOND deploy in the same tab's lifetime recover too. -const RELOAD_WINDOW_MS = 5 * 60 * 1000; - -// Pure window decision, unit-tested in isolation: auto-reload only if we have never -// auto-reloaded (lastReloadAt null/NaN) or the last one was strictly older than the -// window. Anything inside the window is suppressed to break an infinite reload loop. -export function shouldAutoReload( - now: number, - lastReloadAt: number | null, - windowMs: number, -): boolean { - if (lastReloadAt === null || Number.isNaN(lastReloadAt)) return true; - return now - lastReloadAt > windowMs; -} +import { + hasAutoReloaded, + markAutoReloaded, + recordReloadBreadcrumb, +} from "@/lib/reload-guard"; // Heuristic detection of a failed dynamic import. Since the code-splitting work, // every route (plus Aside / AiChatWindow) is React.lazy: when a new deploy @@ -42,21 +27,20 @@ export function isChunkLoadError(error: unknown): boolean { function handleError(error: unknown) { if (!isChunkLoadError(error)) return; // A stale-chunk 404 is cured by a full reload that re-fetches index.html and - // the new chunk manifest. Auto-reload at most once per RELOAD_WINDOW_MS: this - // recovers across multiple deploys in a single tab's lifetime, yet a - // permanently-broken lazy chunk (which would loop) is stopped after the first - // reload and falls through to the manual recovery UI below. - try { - const raw = sessionStorage.getItem(RELOAD_AT_KEY); - const lastReloadAt = raw === null ? null : Number.parseInt(raw, 10); - const now = Date.now(); - if (!shouldAutoReload(now, lastReloadAt, RELOAD_WINDOW_MS)) return; - sessionStorage.setItem(RELOAD_AT_KEY, String(now)); - } catch { - // sessionStorage unavailable (private mode / disabled): skip the automatic - // reload rather than risk an unguarded loop; the fallback UI still recovers. - return; - } + // the new chunk manifest. Auto-reload at most once per window via the SHARED + // window-based reload guard (see @/lib/reload-guard — the same budget the + // proactive version-coherence path consumes, so a mismatch that arrives on + // both paths reloads at most once per window across BOTH). This recovers + // across multiple deploys in a single tab's lifetime, yet a permanently-broken + // lazy chunk (which would loop) is stopped after the first reload and falls + // through to the manual recovery UI below. If the shared budget is already + // spent this window, or the stamp write fails (storage unavailable), we return + // without reloading rather than risk a loop. + if (hasAutoReloaded()) return; + if (!markAutoReloaded()) return; + // Trace before the reload clears the console (same diagnostic breadcrumb the + // proactive version-coherence path writes, tagged with this path). + recordReloadBreadcrumb({ path: "chunk-boundary" }); window.location.reload(); } diff --git a/apps/client/src/features/user/guarded-reload.test.tsx b/apps/client/src/features/user/guarded-reload.test.tsx new file mode 100644 index 00000000..8b1c984b --- /dev/null +++ b/apps/client/src/features/user/guarded-reload.test.tsx @@ -0,0 +1,124 @@ +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; + +// Mocks for the dirty shell's side-effecting collaborators. +vi.mock("@mantine/notifications", () => ({ + notifications: { show: vi.fn() }, +})); +vi.mock("@/i18n.ts", () => ({ default: { t: (k: string) => k } })); +vi.mock("@/lib/reload-guard", () => ({ + hasAutoReloaded: vi.fn(() => false), + markAutoReloaded: vi.fn(() => true), +})); + +import { notifications } from "@mantine/notifications"; +import { hasAutoReloaded, markAutoReloaded } from "@/lib/reload-guard"; +import { + triggerGuardedReload, + __resetGuardedReloadForTests, +} from "./guarded-reload"; + +const show = notifications.show as unknown as ReturnType; +const mockHasAutoReloaded = hasAutoReloaded as unknown as ReturnType< + typeof vi.fn +>; +const mockMarkAutoReloaded = markAutoReloaded as unknown as ReturnType< + typeof vi.fn +>; + +let reload: ReturnType; +let visibility: DocumentVisibilityState; + +function setVisibility(state: DocumentVisibilityState) { + visibility = state; + document.dispatchEvent(new Event("visibilitychange")); +} + +beforeEach(() => { + __resetGuardedReloadForTests(); + vi.clearAllMocks(); + mockHasAutoReloaded.mockReturnValue(false); + mockMarkAutoReloaded.mockReturnValue(true); + + vi.stubGlobal("APP_VERSION", "test-A"); + + reload = vi.fn(); + Object.defineProperty(window, "location", { + configurable: true, + value: { reload }, + }); + + visibility = "visible"; + Object.defineProperty(document, "visibilityState", { + configurable: true, + get: () => visibility, + }); +}); + +afterEach(() => { + vi.unstubAllGlobals(); +}); + +describe("triggerGuardedReload", () => { + it("noop when versions match: no banner, no reload", () => { + triggerGuardedReload("test-A"); + expect(show).not.toHaveBeenCalled(); + expect(reload).not.toHaveBeenCalled(); + }); + + it("noop when the server version is empty (fail-safe)", () => { + triggerGuardedReload(""); + triggerGuardedReload(undefined); + expect(show).not.toHaveBeenCalled(); + expect(reload).not.toHaveBeenCalled(); + }); + + it("hidden tab on a real mismatch reloads immediately, no banner", () => { + visibility = "hidden"; + triggerGuardedReload("test-B"); + expect(reload).toHaveBeenCalledTimes(1); + expect(show).not.toHaveBeenCalled(); + }); + + it("visible tab on a real mismatch shows the banner and arms a reload on hidden", () => { + triggerGuardedReload("test-B"); + // Banner shown, no immediate reload. + expect(show).toHaveBeenCalledTimes(1); + expect(show.mock.calls[0][0]).toMatchObject({ + id: "app-version-reload", + autoClose: false, + withCloseButton: true, + }); + expect(reload).not.toHaveBeenCalled(); + + // Going to the background triggers the guarded auto-reload. + setVisibility("hidden"); + expect(reload).toHaveBeenCalledTimes(1); + }); + + it("banner-only (auto-reload already spent): banner, never auto-reload", () => { + mockHasAutoReloaded.mockReturnValue(true); + triggerGuardedReload("test-B"); + expect(show).toHaveBeenCalledTimes(1); + expect(reload).not.toHaveBeenCalled(); + + // Even backgrounding must not reload (no listener was armed). + setVisibility("hidden"); + expect(reload).not.toHaveBeenCalled(); + }); + + it("does NOT reload when the flag write fails; falls back to the banner", () => { + mockMarkAutoReloaded.mockReturnValue(false); + visibility = "hidden"; + triggerGuardedReload("test-B"); + expect(reload).not.toHaveBeenCalled(); + // performAutoReload falls back to showing the banner. + expect(show).toHaveBeenCalledTimes(1); + }); + + it("is idempotent within a tab-load: repeated emits do not stack banners", () => { + triggerGuardedReload("test-B"); + triggerGuardedReload("test-B"); + triggerGuardedReload("test-C"); + expect(show).toHaveBeenCalledTimes(1); + }); +}); diff --git a/apps/client/src/features/user/guarded-reload.tsx b/apps/client/src/features/user/guarded-reload.tsx new file mode 100644 index 00000000..d483f0e9 --- /dev/null +++ b/apps/client/src/features/user/guarded-reload.tsx @@ -0,0 +1,116 @@ +import { Button } from "@mantine/core"; +import { notifications } from "@mantine/notifications"; +import i18n from "@/i18n.ts"; +import { hasAutoReloaded, markAutoReloaded } from "@/lib/reload-guard"; +import { decideVersionAction } from "@/features/user/version-coherence"; + +// Dirty shell around the pure `decideVersionAction`: it reads globals +// (APP_VERSION, document.visibilityState), touches sessionStorage via the +// shared reload-guard, and drives the Mantine notification. Kept separate from +// the pure module so the decision stays unit-testable without a DOM. + +// One fixed id so repeated app-version signals (e.g. every reconnect) update a +// single banner instead of stacking a new one each time. +const BANNER_ID = "app-version-reload"; + +// Module-level idempotency for the current tab-load: once a mismatch has been +// handled we don't re-arm the visibility listener or re-show the banner on +// subsequent app-version emits. +let handled = false; + +// Read the build version baked into THIS bundle. The `typeof` guard avoids a +// ReferenceError where the `APP_VERSION` global is absent (e.g. under vitest, +// where Vite's `define` did not run) — an unknown client version makes the +// pure decision no-op (fail-safe). +function readClientVersion(): string { + return (typeof APP_VERSION !== "undefined" ? APP_VERSION : "").trim(); +} + +// Perform the actual reload — but only after the shared one-shot flag is +// persisted. If the write fails (storage unavailable) we must NOT reload +// (mirrors the reactive chunk-load boundary's `catch → return`), and fall back +// to the manual banner so the user can still recover. +function performAutoReload(): void { + if (!markAutoReloaded()) { + showReloadBanner(); + return; + } + window.location.reload(); +} + +function showReloadBanner(): void { + notifications.show({ + id: BANNER_ID, + title: i18n.t("A new version is available"), + message: ( + + ), + autoClose: false, + withCloseButton: true, + }); +} + +/** + * Handle a server `app-version` announcement: compare it to this bundle's + * version and, on a real mismatch, do a guarded reload. + * + * - hidden tab → reload immediately (nobody is looking). + * - visible tab → show the banner AND self-reload the moment the + * tab goes to the background (or on the button). + * - auto-reload already used / storage error → banner only (no auto-reload), + * so there is at most one automatic reload per session (loop safety). + */ +export function triggerGuardedReload( + rawServerVersion: string | undefined | null, +): void { + const serverVersion = (rawServerVersion ?? "").trim(); + const clientVersion = readClientVersion(); + + // A storage read error surfaces as autoReloadUsed=true → fail toward NOT + // reloading (banner only). + const autoReloadUsed = hasAutoReloaded(); + + const action = decideVersionAction({ + serverVersion, + clientVersion, + autoReloadUsed, + }); + if (action === "noop") return; + + // Idempotent per tab-load: don't stack banners or re-arm the listener across + // repeated emits (reconnects) once we've already acted. + if (handled) return; + handled = true; + + if (action === "banner") { + // Entered banner-only (permanent skew, node oscillation, or spent + // auto-reload). Log for diagnosability; show the manual banner. + console.warn( + `[version-coherence] server=${serverVersion} client=${clientVersion}: ` + + "auto-reload already spent this session — showing manual banner", + ); + showReloadBanner(); + return; + } + + // action === "reload" + if (document.visibilityState === "hidden") { + // Covers tabs that are already backgrounded at the moment the signal + // arrives — reload them right away. + performAutoReload(); + return; + } + + showReloadBanner(); + const onHidden = () => { + if (document.visibilityState === "hidden") performAutoReload(); + }; + document.addEventListener("visibilitychange", onHidden, { once: true }); +} + +// Test-only: reset the module-level idempotency latch between cases. +export function __resetGuardedReloadForTests(): void { + handled = false; +} diff --git a/apps/client/src/features/user/user-provider.tsx b/apps/client/src/features/user/user-provider.tsx index 5c29203c..7d3a591d 100644 --- a/apps/client/src/features/user/user-provider.tsx +++ b/apps/client/src/features/user/user-provider.tsx @@ -13,6 +13,8 @@ import { useCollabToken } from "@/features/auth/queries/auth-query.tsx"; import { Error404 } from "@/components/ui/error-404.tsx"; import { queryClient } from "@/main.tsx"; import { makeConnectHandler } from "@/features/user/connect-resync.ts"; +import { triggerGuardedReload } from "@/features/user/guarded-reload.tsx"; +import type { AppVersionSocketPayload } from "@/features/user/version-coherence.ts"; export function UserProvider({ children }: React.PropsWithChildren) { const [, setCurrentUser] = useAtom(currentUserAtom); @@ -47,6 +49,15 @@ export function UserProvider({ children }: React.PropsWithChildren) { handleConnect(); }); + // Register the version-coherence listener SYNCHRONOUSLY, before the socket + // connects: the server emits `app-version` immediately in handleConnection, + // so a listener attached after connect would miss it on a fast localhost + // connect. On a version mismatch the client guard-reloads (banner on a + // visible tab, auto-reload on a hidden one) before it hits a stale chunk. + newSocket.on("app-version", (payload?: AppVersionSocketPayload) => { + triggerGuardedReload(payload?.version); + }); + return () => { console.log("ws disconnected"); newSocket.disconnect(); diff --git a/apps/client/src/features/user/version-coherence.test.ts b/apps/client/src/features/user/version-coherence.test.ts new file mode 100644 index 00000000..787e9c9d --- /dev/null +++ b/apps/client/src/features/user/version-coherence.test.ts @@ -0,0 +1,64 @@ +import { describe, it, expect } from "vitest"; +import { decideVersionAction } from "./version-coherence"; + +describe("decideVersionAction", () => { + it("noop when the server version is empty (fail-safe)", () => { + expect( + decideVersionAction({ + serverVersion: "", + clientVersion: "v1", + autoReloadUsed: false, + }), + ).toBe("noop"); + }); + + it("noop when the client version is empty (fail-safe)", () => { + expect( + decideVersionAction({ + serverVersion: "v1", + clientVersion: "", + autoReloadUsed: false, + }), + ).toBe("noop"); + }); + + it("noop when versions are equal (in sync)", () => { + expect( + decideVersionAction({ + serverVersion: "v1", + clientVersion: "v1", + autoReloadUsed: false, + }), + ).toBe("noop"); + }); + + it("reload on a real mismatch the first time this session", () => { + expect( + decideVersionAction({ + serverVersion: "test-B", + clientVersion: "test-A", + autoReloadUsed: false, + }), + ).toBe("reload"); + }); + + it("banner on a mismatch once the session auto-reload is spent", () => { + expect( + decideVersionAction({ + serverVersion: "test-B", + clientVersion: "test-A", + autoReloadUsed: true, + }), + ).toBe("banner"); + }); + + it("equal versions stay noop even if auto-reload was already used", () => { + expect( + decideVersionAction({ + serverVersion: "v1", + clientVersion: "v1", + autoReloadUsed: true, + }), + ).toBe("noop"); + }); +}); diff --git a/apps/client/src/features/user/version-coherence.ts b/apps/client/src/features/user/version-coherence.ts new file mode 100644 index 00000000..ba99d757 --- /dev/null +++ b/apps/client/src/features/user/version-coherence.ts @@ -0,0 +1,32 @@ +// Payload of the per-connect `app-version` socket.io event announced by the +// server (ws.gateway.ts) after a successful auth. A dedicated event — NOT a +// member of the room-scoped `WebSocketEvent` union (which is discriminated by +// `operation`), so it never touches use-query-subscription. +export type AppVersionSocketPayload = { version: string }; + +/** + * Pure decision for the version-coherence guard. + * + * All inputs are injected (no globals, no side effects) so it is unit-testable + * without a DOM or the build-time `APP_VERSION` global (undefined under vitest). + * + * - `autoReloadUsed` = a session-wide automatic reload has already happened, + * so we must not auto-reload again (loop safety, shared with the reactive + * chunk-load boundary). + * + * Returns: + * - "noop" — do nothing (unknown version on either side, or already in sync). + * - "banner" — show the manual "update available" banner only (no auto-reload). + * - "reload" — real first-time mismatch: eligible for a guarded auto-reload. + */ +export function decideVersionAction(args: { + serverVersion: string; + clientVersion: string; + autoReloadUsed: boolean; +}): "reload" | "banner" | "noop" { + const { serverVersion, clientVersion, autoReloadUsed } = args; + if (!serverVersion || !clientVersion) return "noop"; // fail-safe: unknown version → never act + if (serverVersion === clientVersion) return "noop"; // in sync + if (autoReloadUsed) return "banner"; // one auto-reload per session already spent + return "reload"; // real mismatch, first time this session +} diff --git a/apps/client/src/lib/reload-guard.test.ts b/apps/client/src/lib/reload-guard.test.ts new file mode 100644 index 00000000..1c549af4 --- /dev/null +++ b/apps/client/src/lib/reload-guard.test.ts @@ -0,0 +1,54 @@ +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; +import { hasAutoReloaded, markAutoReloaded } from "./reload-guard"; + +const FLAG = "chunk-reload-attempted"; + +describe("reload-guard", () => { + beforeEach(() => { + sessionStorage.clear(); + vi.restoreAllMocks(); + }); + + afterEach(() => { + sessionStorage.clear(); + vi.restoreAllMocks(); + }); + + it("hasAutoReloaded is false before any reload, true after mark", () => { + expect(hasAutoReloaded()).toBe(false); + expect(markAutoReloaded()).toBe(true); + expect(hasAutoReloaded()).toBe(true); + // Uses the same key the reactive chunk-load boundary reads. + expect(sessionStorage.getItem(FLAG)).toBe("1"); + }); + + it("hasAutoReloaded returns true when reading storage throws (fail toward not reloading)", () => { + vi.stubGlobal("sessionStorage", { + getItem: () => { + throw new Error("storage disabled"); + }, + setItem: () => { + throw new Error("storage disabled"); + }, + }); + try { + expect(hasAutoReloaded()).toBe(true); + } finally { + vi.unstubAllGlobals(); + } + }); + + it("markAutoReloaded returns false when writing storage throws", () => { + vi.stubGlobal("sessionStorage", { + getItem: () => null, + setItem: () => { + throw new Error("storage disabled"); + }, + }); + try { + expect(markAutoReloaded()).toBe(false); + } finally { + vi.unstubAllGlobals(); + } + }); +}); diff --git a/apps/client/src/lib/reload-guard.ts b/apps/client/src/lib/reload-guard.ts new file mode 100644 index 00000000..cc6a44ac --- /dev/null +++ b/apps/client/src/lib/reload-guard.ts @@ -0,0 +1,121 @@ +// Shared, window-based auto-reload budget. +// +// Both auto-reload paths — the reactive chunk-load-error-boundary (recovers +// AFTER a stale lazy chunk 404s) and the proactive version-coherence feature +// (reloads BEFORE the tab hits a stale chunk) — go through these functions so +// they share ONE session-scoped reload budget: at most a single automatic +// reload per RELOAD_WINDOW_MS across BOTH paths. A window (rather than a +// permanent one-shot flag) lets a SECOND deploy in the same tab's lifetime +// recover too, while a permanent skew, node oscillation, or a genuinely-missing +// chunk still degrades to a manual banner/UI after the first reload instead of +// looping. When sessionStorage is unavailable every mismatch degrades to the +// manual UI — no unguarded reload. + +// sessionStorage key holding the epoch-ms timestamp of the last automatic reload +// (shared by both paths). +const RELOAD_AT_KEY = "chunk-reload-at"; + +// Allow at most one automatic reload per this window. A stale-deploy 404 is cured +// by a single reload, so anything inside the window is treated as a reload loop +// (permanently-broken chunk / permanent skew) and falls through to the manual UI. +export const RELOAD_WINDOW_MS = 5 * 60 * 1000; + +/** + * Pure window decision, unit-tested in isolation: auto-reload only if we have + * never auto-reloaded (lastReloadAt null/NaN) or the last one was strictly older + * than the window. Anything inside the window is suppressed to break an infinite + * reload loop. + */ +export function shouldAutoReload( + now: number, + lastReloadAt: number | null, + windowMs: number, +): boolean { + if (lastReloadAt === null || Number.isNaN(lastReloadAt)) return true; + return now - lastReloadAt > windowMs; +} + +/** + * Has an automatic reload already happened within the current window (so the + * shared budget is spent right now)? Both paths check this before reloading; a + * `true` return means fall through to the manual banner/UI instead of reloading. + * + * A storage read error (private mode / disabled) is reported as `true` so the + * caller fails toward NOT reloading — an unguarded loop is worse than a stale + * tab the user can reload manually. Note a window (not a permanent flag): once + * the window elapses a later deploy's mismatch is allowed to reload again. + */ +export function hasAutoReloaded(now: number = Date.now()): boolean { + try { + const raw = sessionStorage.getItem(RELOAD_AT_KEY); + const lastReloadAt = raw === null ? null : Number.parseInt(raw, 10); + return !shouldAutoReload(now, lastReloadAt, RELOAD_WINDOW_MS); + } catch { + return true; + } +} + +/** + * Stamp the shared window as consumed now — record that an automatic reload is + * being performed this session. + * + * Returns whether the write succeeded. A `false` return (storage unavailable) + * means the caller MUST NOT reload — otherwise the stamp would never stick and + * the reload could loop. + */ +export function markAutoReloaded(now: number = Date.now()): boolean { + try { + sessionStorage.setItem(RELOAD_AT_KEY, String(now)); + return true; + } catch { + return false; + } +} + +// Diagnostic breadcrumb for an automatic reload. Written right before +// window.location.reload() (which clears the console) and read back on the next +// page load, so a "the tab reloaded itself / it's looping" field report is +// diagnosable: which path fired (proactive version-coherence vs the reactive +// chunk-load boundary) and which version pair triggered it. sessionStorage +// survives a same-tab reload, unlike the console. +const RELOAD_BREADCRUMB_KEY = "reload-breadcrumb"; + +export type ReloadBreadcrumb = { + path: "proactive" | "chunk-boundary"; + serverVersion?: string; + clientVersion?: string; + at: number; +}; + +/** + * Persist a best-effort breadcrumb just before an automatic reload. Failures + * (storage unavailable) are swallowed — this is diagnostics only and must never + * block or alter the reload decision. + */ +export function recordReloadBreadcrumb( + entry: Omit, +): void { + try { + sessionStorage.setItem( + RELOAD_BREADCRUMB_KEY, + JSON.stringify({ ...entry, at: Date.now() }), + ); + } catch { + // best-effort diagnostics only + } +} + +/** + * Read and clear the breadcrumb left by an auto-reload in the previous page + * load. Cleared on read so it surfaces exactly once per reload. + */ +export function takeReloadBreadcrumb(): ReloadBreadcrumb | null { + try { + const raw = sessionStorage.getItem(RELOAD_BREADCRUMB_KEY); + if (!raw) return null; + sessionStorage.removeItem(RELOAD_BREADCRUMB_KEY); + return JSON.parse(raw) as ReloadBreadcrumb; + } catch { + return null; + } +} diff --git a/apps/client/vite.config.ts b/apps/client/vite.config.ts index c93c7a7b..25041afb 100644 --- a/apps/client/vite.config.ts +++ b/apps/client/vite.config.ts @@ -1,7 +1,8 @@ -import { defineConfig, loadEnv } from "vite"; +import { defineConfig, loadEnv, type Plugin } from "vite"; import react from "@vitejs/plugin-react"; import { compression } from "vite-plugin-compression2"; import * as path from "path"; +import * as fs from "node:fs"; import { execSync } from "node:child_process"; const envPath = path.resolve(process.cwd(), "..", ".."); @@ -24,7 +25,32 @@ function resolveAppVersion(cwd: string): string { } } +// Emit /version.json = { "version": appVersion } so the server can read +// the exact same build id the bundle was compiled with. The value is the SAME +// `appVersion` fed into `define.APP_VERSION`, so version.json and the baked-in +// global are identical by construction — the single source of truth (no +// runtime-env second copy that could drift and cause a false version mismatch). +function versionJsonPlugin(version: string): Plugin { + let outDir = "dist"; + return { + name: "emit-version-json", + apply: "build", + configResolved(config) { + outDir = config.build.outDir; + }, + writeBundle() { + const root = path.resolve(process.cwd(), outDir); + fs.mkdirSync(root, { recursive: true }); + fs.writeFileSync( + path.join(root, "version.json"), + JSON.stringify({ version }), + ); + }, + }; +} + export default defineConfig(({ mode }) => { + const appVersion = resolveAppVersion(envPath); const { APP_URL, FILE_UPLOAD_SIZE_LIMIT, @@ -52,10 +78,11 @@ export default defineConfig(({ mode }) => { POSTHOG_HOST, POSTHOG_KEY, }, - APP_VERSION: JSON.stringify(resolveAppVersion(envPath)), + APP_VERSION: JSON.stringify(appVersion), }, plugins: [ react(), + versionJsonPlugin(appVersion), // Emit .br and .gz next to every built asset so the server can serve the // precompressed copy (see @fastify/static preCompressed in static.module.ts). compression({ diff --git a/apps/server/src/common/helpers/client-version.spec.ts b/apps/server/src/common/helpers/client-version.spec.ts new file mode 100644 index 00000000..604a6403 --- /dev/null +++ b/apps/server/src/common/helpers/client-version.spec.ts @@ -0,0 +1,52 @@ +import { join } from 'path'; +import * as fs from 'node:fs'; +import * as os from 'node:os'; +import { readClientBuildVersion } from './client-version'; + +describe('readClientBuildVersion', () => { + let dir: string; + + beforeEach(() => { + dir = fs.mkdtempSync(join(os.tmpdir(), 'client-version-')); + }); + + afterEach(() => { + fs.rmSync(dir, { recursive: true, force: true }); + }); + + const writeVersionJson = (content: string) => + fs.writeFileSync(join(dir, 'version.json'), content); + + it('returns the version from a valid version.json', () => { + writeVersionJson(JSON.stringify({ version: 'test-A' })); + expect(readClientBuildVersion(dir)).toBe('test-A'); + }); + + it('trims surrounding whitespace in the version', () => { + writeVersionJson(JSON.stringify({ version: ' v1.2.3 ' })); + expect(readClientBuildVersion(dir)).toBe('v1.2.3'); + }); + + it('returns "" when version.json is missing', () => { + expect(readClientBuildVersion(dir)).toBe(''); + }); + + it('returns "" on malformed JSON', () => { + writeVersionJson('{ not json'); + expect(readClientBuildVersion(dir)).toBe(''); + }); + + it('returns "" when the version field is absent', () => { + writeVersionJson(JSON.stringify({ notVersion: 'x' })); + expect(readClientBuildVersion(dir)).toBe(''); + }); + + it('returns "" when the version field is not a string', () => { + writeVersionJson(JSON.stringify({ version: 123 })); + expect(readClientBuildVersion(dir)).toBe(''); + }); + + it('returns "" when the path does not exist at all', () => { + expect(readClientBuildVersion(join(dir, 'nope'))).toBe(''); + }); +}); diff --git a/apps/server/src/common/helpers/client-version.ts b/apps/server/src/common/helpers/client-version.ts new file mode 100644 index 00000000..9c4281b7 --- /dev/null +++ b/apps/server/src/common/helpers/client-version.ts @@ -0,0 +1,36 @@ +import { join } from 'path'; +import * as fs from 'node:fs'; + +/** + * Resolve the absolute path to the built client bundle directory + * (`apps/client/dist`) shipped into the runtime image. + * + * The `../` depth is anchored on THIS module's compiled location + * (`dist/common/helpers`). `integrations/static` sits at the same depth under + * the compiled root, so both callers (StaticModule and readClientBuildVersion) + * MUST share this single helper rather than duplicating the depth — a copy in a + * module at a different depth would silently resolve to the wrong directory. + */ +export function resolveClientDistPath(): string { + return join(__dirname, '..', '..', '..', '..', 'client/dist'); +} + +/** + * Read the build version the client bundle was compiled with, from + * `/version.json` (written by the Vite build — the single + * source of truth shared by the baked-in `APP_VERSION` global and this file). + * + * Fail-safe: any error (missing file, unreadable, bad JSON, non-string + * version) yields `''`. The caller treats an empty version as "unknown" and + * the whole version-coherence feature stays silently inert — existing deploys + * without the file keep working unchanged. + */ +export function readClientBuildVersion(clientDistPath: string): string { + try { + const raw = fs.readFileSync(join(clientDistPath, 'version.json'), 'utf8'); + const version = (JSON.parse(raw) as { version?: unknown }).version; + return typeof version === 'string' ? version.trim() : ''; + } catch { + return ''; + } +} diff --git a/apps/server/src/common/helpers/index.ts b/apps/server/src/common/helpers/index.ts index 80e9a902..8a0e2be1 100644 --- a/apps/server/src/common/helpers/index.ts +++ b/apps/server/src/common/helpers/index.ts @@ -3,3 +3,4 @@ export * from './nanoid.utils'; export * from './file.helper'; export * from './constants'; export * from './security-headers'; +export * from './client-version'; diff --git a/apps/server/src/integrations/static/static.module.ts b/apps/server/src/integrations/static/static.module.ts index ea2d398f..6b4e878b 100644 --- a/apps/server/src/integrations/static/static.module.ts +++ b/apps/server/src/integrations/static/static.module.ts @@ -4,6 +4,7 @@ import { join } from 'path'; import * as fs from 'node:fs'; import fastifyStatic from '@fastify/static'; import { EnvironmentService } from '../environment/environment.service'; +import { resolveClientDistPath } from '../../common/helpers/client-version'; /** * Resolve the response headers for a statically served client asset. @@ -56,14 +57,7 @@ export class StaticModule implements OnModuleInit { const httpAdapter = this.httpAdapterHost.httpAdapter; const app = httpAdapter.getInstance(); - const clientDistPath = join( - __dirname, - '..', - '..', - '..', - '..', - 'client/dist', - ); + const clientDistPath = resolveClientDistPath(); const indexFilePath = join(clientDistPath, 'index.html'); diff --git a/apps/server/src/ws/ws.gateway.ts b/apps/server/src/ws/ws.gateway.ts index a4f66257..087e109c 100644 --- a/apps/server/src/ws/ws.gateway.ts +++ b/apps/server/src/ws/ws.gateway.ts @@ -9,10 +9,14 @@ import { import { Server, Socket } from 'socket.io'; import { TokenService } from '../core/auth/services/token.service'; import { JwtPayload, JwtType } from '../core/auth/dto/jwt-payload'; -import { OnModuleDestroy } from '@nestjs/common'; +import { Logger, OnModuleDestroy, OnModuleInit } from '@nestjs/common'; import { SpaceMemberRepo } from '@docmost/db/repos/space/space-member.repo'; import { WsService } from './ws.service'; import { getSpaceRoomName, getUserRoomName } from './ws.utils'; +import { + readClientBuildVersion, + resolveClientDistPath, +} from '../common/helpers/client-version'; import * as cookie from 'cookie'; @WebSocketGateway({ @@ -20,17 +24,40 @@ import * as cookie from 'cookie'; transports: ['websocket'], }) export class WsGateway - implements OnGatewayConnection, OnGatewayInit, OnModuleDestroy + implements + OnGatewayConnection, + OnGatewayInit, + OnModuleInit, + OnModuleDestroy { @WebSocketServer() server: Server; + private readonly logger = new Logger(WsGateway.name); + + // The build version of the client bundle shipped in this image, read once at + // startup from client/dist/version.json (single source of truth, same value + // baked into the client's APP_VERSION). Empty string => version.json missing + // or empty => the proactive version-coherence reload feature stays inert. + private appVersion = ''; + constructor( private tokenService: TokenService, private spaceMemberRepo: SpaceMemberRepo, private wsService: WsService, ) {} + onModuleInit(): void { + this.appVersion = readClientBuildVersion(resolveClientDistPath()); + if (this.appVersion) { + this.logger.log(`app-version reload: ACTIVE (v=${this.appVersion})`); + } else { + this.logger.log( + 'app-version reload: DISABLED (version.json missing/empty)', + ); + } + } + afterInit(server: Server): void { this.wsService.setServer(server); } @@ -55,6 +82,14 @@ export class WsGateway const spaceRooms = userSpaceIds.map((id) => getSpaceRoomName(id)); client.join([userRoom, workspaceRoom, ...spaceRooms]); + + // Announce this container's client build version to the freshly + // authenticated socket. On a redeploy the client reconnects to the new + // container and receives the new version here, letting it guard-reload + // before it hits a stale lazy chunk. Per-connect only (no broadcast): + // natural reconnect covers both single-container and cluster without a + // thundering-herd fleet reload. + client.emit('app-version', { version: this.appVersion }); } catch (err) { client.emit('Unauthorized'); client.disconnect();