@fluidframework/container-loader 2.74.0 → 2.81.0-374083

package/lib/snapshotRefresher.js

@@ -0,0 +1,163 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var _RefreshPromiseTracker_promise, _SnapshotRefresher_disposed, _SnapshotRefresher_snapshotRefreshEnabled;
+import { assert, Timer } from "@fluidframework/core-utils/internal";
+import { FetchSource } from "@fluidframework/driver-definitions/internal";
+import { createChildMonitoringContext, } from "@fluidframework/telemetry-utils/internal";
+import { getLatestSnapshotInfo, } from "./serializedStateManager.js";
+class RefreshPromiseTracker {
+    get hasPromise() {
+        return __classPrivateFieldGet(this, _RefreshPromiseTracker_promise, "f") !== undefined;
+    }
+    get promise() {
+        return __classPrivateFieldGet(this, _RefreshPromiseTracker_promise, "f");
+    }
+    constructor(catchHandler) {
+        this.catchHandler = catchHandler;
+        _RefreshPromiseTracker_promise.set(this, void 0);
+    }
+    setPromise(p) {
+        if (this.hasPromise) {
+            throw new Error("Cannot start new snapshot refresh while a refresh is already in progress");
+        }
+        __classPrivateFieldSet(this, _RefreshPromiseTracker_promise, p.finally(() => {
+            __classPrivateFieldSet(this, _RefreshPromiseTracker_promise, undefined, "f");
+        }), "f");
+        p.catch(this.catchHandler);
+    }
+}
+_RefreshPromiseTracker_promise = new WeakMap();
+/**
+ * Manages periodic refresh of the latest snapshot for a document.
+ *
+ * `SnapshotRefresher` polls the storage service for the most recent snapshot and, when a newer
+ * snapshot is discovered, invokes the provided `onSnapshotRefreshed` callback with the updated
+ * snapshot metadata. It is responsible for:
+ *
+ * - Tracking the most recent snapshot that has been observed.
+ * - Scheduling and managing refresh attempts via an internal timer.
+ * - Emitting telemetry for successful and failed refresh attempts.
+ *
+ * The refresh behavior can be configured via constructor arguments, including whether offline
+ * loading and the `getSnapshot` API are supported, as well as the refresh timeout. Callers
+ * should dispose this instance when snapshot refresh is no longer needed to stop any pending
+ * timers and prevent further refresh attempts.
+ */
+export class SnapshotRefresher {
+    get disposed() {
+        return __classPrivateFieldGet(this, _SnapshotRefresher_disposed, "f");
+    }
+    constructor(subLogger, storageAdapter, offlineLoadEnabled, supportGetSnapshotApi, onSnapshotRefreshed, snapshotRefreshTimeoutMs) {
+        this.storageAdapter = storageAdapter;
+        this.offlineLoadEnabled = offlineLoadEnabled;
+        this.supportGetSnapshotApi = supportGetSnapshotApi;
+        this.onSnapshotRefreshed = onSnapshotRefreshed;
+        _SnapshotRefresher_disposed.set(this, false);
+        this.refreshTracker = new RefreshPromiseTracker(
+        // eslint-disable-next-line unicorn/consistent-function-scoping
+        (error) => this.mc.logger.sendErrorEvent({
+            eventName: "RefreshLatestSnapshotFailed",
+        }, error));
+        this.snapshotRefreshTimeoutMs = 60 * 60 * 24 * 1000;
+        _SnapshotRefresher_snapshotRefreshEnabled.set(this, void 0);
+        this.mc = createChildMonitoringContext({
+            logger: subLogger,
+            namespace: "serializedStateManager",
+        });
+        this.snapshotRefreshTimeoutMs = snapshotRefreshTimeoutMs ?? this.snapshotRefreshTimeoutMs;
+        __classPrivateFieldSet(this, _SnapshotRefresher_snapshotRefreshEnabled, this.offlineLoadEnabled &&
+            (this.mc.config.getBoolean("Fluid.Container.enableOfflineSnapshotRefresh") ??
+                this.mc.config.getBoolean("Fluid.Container.enableOfflineFull")) === true, "f");
+        this.refreshTimer = __classPrivateFieldGet(this, _SnapshotRefresher_snapshotRefreshEnabled, "f")
+            ? new Timer(this.snapshotRefreshTimeoutMs, () => this.tryRefreshSnapshot())
+            : undefined;
+    }
+    tryRefreshSnapshot() {
+        if (__classPrivateFieldGet(this, _SnapshotRefresher_snapshotRefreshEnabled, "f") &&
+            !__classPrivateFieldGet(this, _SnapshotRefresher_disposed, "f") &&
+            !this.refreshTracker.hasPromise &&
+            this.latestSnapshot === undefined) {
+            // Don't block on the refresh snapshot call - it is for the next time we serialize, not booting this incarnation
+            this.refreshTracker.setPromise(this.refreshLatestSnapshot(this.supportGetSnapshotApi()));
+        }
+    }
+    /**
+     * Fetch the latest snapshot for the container, including delay-loaded groupIds if pendingLocalState was provided and contained any groupIds.
+     * Note that this will update the StorageAdapter's cached snapshots for the groupIds (if present)
+     *
+     * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree (must be true to fetch by groupIds)
+     */
+    async refreshLatestSnapshot(supportGetSnapshotApi) {
+        this.latestSnapshot = await getLatestSnapshotInfo(this.mc, this.storageAdapter, supportGetSnapshotApi);
+        if (__classPrivateFieldGet(this, _SnapshotRefresher_disposed, "f")) {
+            return -1;
+        }
+        // These are loading groupIds that the containerRuntime has requested over its lifetime.
+        // We will fetch the latest snapshot for the groupIds, which will update storageAdapter.loadedGroupIdSnapshots's cache
+        const downloadedGroupIds = Object.keys(this.storageAdapter.loadedGroupIdSnapshots);
+        if (supportGetSnapshotApi && downloadedGroupIds.length > 0) {
+            assert(this.storageAdapter.getSnapshot !== undefined, 0x972 /* getSnapshot should exist */);
+            // (This is a separate network call from above because it requires work for storage to add a special base groupId)
+            const snapshot = await this.storageAdapter.getSnapshot({
+                versionId: undefined,
+                scenarioName: "getLatestSnapshotInfo",
+                cacheSnapshot: false,
+                loadingGroupIds: downloadedGroupIds,
+                fetchSource: FetchSource.noCache,
+            });
+            assert(snapshot !== undefined, 0x973 /* Snapshot should exist */);
+        }
+        // Notify the manager about the fetched snapshot - let it decide what to do with it
+        const result = this.latestSnapshot === undefined ? -1 : this.onSnapshotRefreshed(this.latestSnapshot);
+        this.refreshTimer?.restart();
+        return result;
+    }
+    /**
+     * Clears the latest snapshot after it's been consumed by the manager.
+     * This allows the next refresh cycle to proceed.
+     */
+    clearLatestSnapshot() {
+        this.latestSnapshot = undefined;
+    }
+    /**
+     * Starts the refresh timer.
+     */
+    startTimer() {
+        this.refreshTimer?.start();
+    }
+    /**
+     * Restarts the refresh timer.
+     */
+    restartTimer() {
+        this.refreshTimer?.restart();
+    }
+    /**
+     * Gets the current refresh promise for testing purposes.
+     * @returns The snapshot sequence number promise, or undefined if no refresh is in progress
+     */
+    get refreshSnapshotP() {
+        return this.refreshTracker.promise;
+    }
+    /**
+     * Disposes the refresher and clears the timer.
+     */
+    dispose() {
+        __classPrivateFieldSet(this, _SnapshotRefresher_disposed, true, "f");
+        this.refreshTimer?.clear();
+    }
+}
+_SnapshotRefresher_disposed = new WeakMap(), _SnapshotRefresher_snapshotRefreshEnabled = new WeakMap();
+//# sourceMappingURL=snapshotRefresher.js.map

package/lib/snapshotRefresher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotRefresher.js","sourceRoot":"","sources":["../src/snapshotRefresher.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAIH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,6CAA6C,CAAC;AAC1E,OAAO,EACN,4BAA4B,GAE5B,MAAM,0CAA0C,CAAC;AAElD,OAAO,EACN,qBAAqB,GAGrB,MAAM,6BAA6B,CAAC;AAErC,MAAM,qBAAqB;IAC1B,IAAW,UAAU;QACpB,OAAO,uBAAA,IAAI,sCAAS,KAAK,SAAS,CAAC;IACpC,CAAC;IACD,IAAW,OAAO;QACjB,OAAO,uBAAA,IAAI,sCAAS,CAAC;IACtB,CAAC;IACD,YAA6B,YAAoC;QAApC,iBAAY,GAAZ,YAAY,CAAwB;QAEjE,iDAAsC;IAF8B,CAAC;IAGrE,UAAU,CAAC,CAAkB;QAC5B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACd,0EAA0E,CAC1E,CAAC;QACH,CAAC;QACD,uBAAA,IAAI,kCAAY,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YAC9B,uBAAA,IAAI,kCAAY,SAAS,MAAA,CAAC;QAC3B,CAAC,CAAC,MAAA,CAAC;QACH,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,CAAC;CACD;;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,iBAAiB;IAK7B,IAAW,QAAQ;QAClB,OAAO,uBAAA,IAAI,mCAAU,CAAC;IACvB,CAAC;IAgBD,YACC,SAA+B,EACd,cAA6D,EAC7D,kBAA2B,EAC3B,qBAAoC,EACpC,mBAAwD,EACzE,wBAAiC;QAJhB,mBAAc,GAAd,cAAc,CAA+C;QAC7D,uBAAkB,GAAlB,kBAAkB,CAAS;QAC3B,0BAAqB,GAArB,qBAAqB,CAAe;QACpC,wBAAmB,GAAnB,mBAAmB,CAAqC;QAzB1E,sCAAqB,KAAK,EAAC;QAMV,mBAAc,GAAG,IAAI,qBAAqB;QAC1D,+DAA+D;QAC/D,CAAC,KAAK,EAAE,EAAE,CACT,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,CAC5B;YACC,SAAS,EAAE,6BAA6B;SACxC,EACD,KAAK,CACL,CACF,CAAC;QAEe,6BAAwB,GAAW,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC/D,4DAAiC;QAUzC,IAAI,CAAC,EAAE,GAAG,4BAA4B,CAAC;YACtC,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,wBAAwB;SACnC,CAAC,CAAC;QAEH,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,IAAI,IAAI,CAAC,wBAAwB,CAAC;QAE1F,uBAAA,IAAI,6CACH,IAAI,CAAC,kBAAkB;YACvB,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,8CAA8C,CAAC;gBACzE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,mCAAmC,CAAC,CAAC,KAAK,IAAI,MAAA,CAAC;QAE3E,IAAI,CAAC,YAAY,GAAG,uBAAA,IAAI,iDAAwB;YAC/C,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC3E,CAAC,CAAC,SAAS,CAAC;IACd,CAAC;IAEM,kBAAkB;QACxB,IACC,uBAAA,IAAI,iDAAwB;YAC5B,CAAC,uBAAA,IAAI,mCAAU;YACf,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU;YAC/B,IAAI,CAAC,cAAc,KAAK,SAAS,EAChC,CAAC;YACF,gHAAgH;YAChH,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,qBAAqB,CAAC,qBAA8B;QACjE,IAAI,CAAC,cAAc,GAAG,MAAM,qBAAqB,CAChD,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,cAAc,EACnB,qBAAqB,CACrB,CAAC;QAEF,IAAI,uBAAA,IAAI,mCAAU,EAAE,CAAC;YACpB,OAAO,CAAC,CAAC,CAAC;QACX,CAAC;QAED,wFAAwF;QACxF,sHAAsH;QACtH,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;QACnF,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5D,MAAM,CACL,IAAI,CAAC,cAAc,CAAC,WAAW,KAAK,SAAS,EAC7C,KAAK,CAAC,8BAA8B,CACpC,CAAC;YACF,kHAAkH;YAClH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;gBACtD,SAAS,EAAE,SAAS;gBACpB,YAAY,EAAE,uBAAuB;gBACrC,aAAa,EAAE,KAAK;gBACpB,eAAe,EAAE,kBAAkB;gBACnC,WAAW,EAAE,WAAW,CAAC,OAAO;aAChC,CAAC,CAAC;YACH,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;QACnE,CAAC;QAED,mFAAmF;QACnF,MAAM,MAAM,GACX,IAAI,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAExF,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,UAAU;QAChB,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACI,YAAY;QAClB,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAW,gBAAgB;QAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,OAAO;QACb,uBAAA,IAAI,+BAAa,IAAI,MAAA,CAAC;QACtB,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC;IAC5B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ITelemetryBaseLogger } from \"@fluidframework/core-interfaces\";\nimport type { IDisposable } from \"@fluidframework/core-interfaces/internal\";\nimport { assert, Timer } from \"@fluidframework/core-utils/internal\";\nimport { FetchSource } from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tcreateChildMonitoringContext,\n\ttype MonitoringContext,\n} from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\tgetLatestSnapshotInfo,\n\ttype ISerializedStateManagerDocumentStorageService,\n\ttype ISnapshotInfo,\n} from \"./serializedStateManager.js\";\n\nclass RefreshPromiseTracker {\n\tpublic get hasPromise(): boolean {\n\t\treturn this.#promise !== undefined;\n\t}\n\tpublic get promise(): Promise<number> | undefined {\n\t\treturn this.#promise;\n\t}\n\tconstructor(private readonly catchHandler: (error: Error) => void) {}\n\n\t#promise: Promise<number> | undefined;\n\tsetPromise(p: Promise<number>): void {\n\t\tif (this.hasPromise) {\n\t\t\tthrow new Error(\n\t\t\t\t\"Cannot start new snapshot refresh while a refresh is already in progress\",\n\t\t\t);\n\t\t}\n\t\tthis.#promise = p.finally(() => {\n\t\t\tthis.#promise = undefined;\n\t\t});\n\t\tp.catch(this.catchHandler);\n\t}\n}\n\n/**\n * Manages periodic refresh of the latest snapshot for a document.\n *\n * `SnapshotRefresher` polls the storage service for the most recent snapshot and, when a newer\n * snapshot is discovered, invokes the provided `onSnapshotRefreshed` callback with the updated\n * snapshot metadata. It is responsible for:\n *\n * - Tracking the most recent snapshot that has been observed.\n * - Scheduling and managing refresh attempts via an internal timer.\n * - Emitting telemetry for successful and failed refresh attempts.\n *\n * The refresh behavior can be configured via constructor arguments, including whether offline\n * loading and the `getSnapshot` API are supported, as well as the refresh timeout. Callers\n * should dispose this instance when snapshot refresh is no longer needed to stop any pending\n * timers and prevent further refresh attempts.\n */\nexport class SnapshotRefresher implements IDisposable {\n\tprivate readonly mc: MonitoringContext;\n\tprivate latestSnapshot: ISnapshotInfo | undefined;\n\t#disposed: boolean = false;\n\n\tpublic get disposed(): boolean {\n\t\treturn this.#disposed;\n\t}\n\n\tprivate readonly refreshTracker = new RefreshPromiseTracker(\n\t\t// eslint-disable-next-line unicorn/consistent-function-scoping\n\t\t(error) =>\n\t\t\tthis.mc.logger.sendErrorEvent(\n\t\t\t\t{\n\t\t\t\t\teventName: \"RefreshLatestSnapshotFailed\",\n\t\t\t\t},\n\t\t\t\terror,\n\t\t\t),\n\t);\n\tprivate readonly refreshTimer: Timer | undefined;\n\tprivate readonly snapshotRefreshTimeoutMs: number = 60 * 60 * 24 * 1000;\n\treadonly #snapshotRefreshEnabled: boolean;\n\n\tconstructor(\n\t\tsubLogger: ITelemetryBaseLogger,\n\t\tprivate readonly storageAdapter: ISerializedStateManagerDocumentStorageService,\n\t\tprivate readonly offlineLoadEnabled: boolean,\n\t\tprivate readonly supportGetSnapshotApi: () => boolean,\n\t\tprivate readonly onSnapshotRefreshed: (snapshot: ISnapshotInfo) => number,\n\t\tsnapshotRefreshTimeoutMs?: number,\n\t) {\n\t\tthis.mc = createChildMonitoringContext({\n\t\t\tlogger: subLogger,\n\t\t\tnamespace: \"serializedStateManager\",\n\t\t});\n\n\t\tthis.snapshotRefreshTimeoutMs = snapshotRefreshTimeoutMs ?? this.snapshotRefreshTimeoutMs;\n\n\t\tthis.#snapshotRefreshEnabled =\n\t\t\tthis.offlineLoadEnabled &&\n\t\t\t(this.mc.config.getBoolean(\"Fluid.Container.enableOfflineSnapshotRefresh\") ??\n\t\t\t\tthis.mc.config.getBoolean(\"Fluid.Container.enableOfflineFull\")) === true;\n\n\t\tthis.refreshTimer = this.#snapshotRefreshEnabled\n\t\t\t? new Timer(this.snapshotRefreshTimeoutMs, () => this.tryRefreshSnapshot())\n\t\t\t: undefined;\n\t}\n\n\tpublic tryRefreshSnapshot(): void {\n\t\tif (\n\t\t\tthis.#snapshotRefreshEnabled &&\n\t\t\t!this.#disposed &&\n\t\t\t!this.refreshTracker.hasPromise &&\n\t\t\tthis.latestSnapshot === undefined\n\t\t) {\n\t\t\t// Don't block on the refresh snapshot call - it is for the next time we serialize, not booting this incarnation\n\t\t\tthis.refreshTracker.setPromise(this.refreshLatestSnapshot(this.supportGetSnapshotApi()));\n\t\t}\n\t}\n\n\t/**\n\t * Fetch the latest snapshot for the container, including delay-loaded groupIds if pendingLocalState was provided and contained any groupIds.\n\t * Note that this will update the StorageAdapter's cached snapshots for the groupIds (if present)\n\t *\n\t * @param supportGetSnapshotApi - a boolean indicating whether to use the fetchISnapshot or fetchISnapshotTree (must be true to fetch by groupIds)\n\t */\n\tprivate async refreshLatestSnapshot(supportGetSnapshotApi: boolean): Promise<number> {\n\t\tthis.latestSnapshot = await getLatestSnapshotInfo(\n\t\t\tthis.mc,\n\t\t\tthis.storageAdapter,\n\t\t\tsupportGetSnapshotApi,\n\t\t);\n\n\t\tif (this.#disposed) {\n\t\t\treturn -1;\n\t\t}\n\n\t\t// These are loading groupIds that the containerRuntime has requested over its lifetime.\n\t\t// We will fetch the latest snapshot for the groupIds, which will update storageAdapter.loadedGroupIdSnapshots's cache\n\t\tconst downloadedGroupIds = Object.keys(this.storageAdapter.loadedGroupIdSnapshots);\n\t\tif (supportGetSnapshotApi && downloadedGroupIds.length > 0) {\n\t\t\tassert(\n\t\t\t\tthis.storageAdapter.getSnapshot !== undefined,\n\t\t\t\t0x972 /* getSnapshot should exist */,\n\t\t\t);\n\t\t\t// (This is a separate network call from above because it requires work for storage to add a special base groupId)\n\t\t\tconst snapshot = await this.storageAdapter.getSnapshot({\n\t\t\t\tversionId: undefined,\n\t\t\t\tscenarioName: \"getLatestSnapshotInfo\",\n\t\t\t\tcacheSnapshot: false,\n\t\t\t\tloadingGroupIds: downloadedGroupIds,\n\t\t\t\tfetchSource: FetchSource.noCache,\n\t\t\t});\n\t\t\tassert(snapshot !== undefined, 0x973 /* Snapshot should exist */);\n\t\t}\n\n\t\t// Notify the manager about the fetched snapshot - let it decide what to do with it\n\t\tconst result =\n\t\t\tthis.latestSnapshot === undefined ? -1 : this.onSnapshotRefreshed(this.latestSnapshot);\n\n\t\tthis.refreshTimer?.restart();\n\t\treturn result;\n\t}\n\n\t/**\n\t * Clears the latest snapshot after it's been consumed by the manager.\n\t * This allows the next refresh cycle to proceed.\n\t */\n\tpublic clearLatestSnapshot(): void {\n\t\tthis.latestSnapshot = undefined;\n\t}\n\n\t/**\n\t * Starts the refresh timer.\n\t */\n\tpublic startTimer(): void {\n\t\tthis.refreshTimer?.start();\n\t}\n\n\t/**\n\t * Restarts the refresh timer.\n\t */\n\tpublic restartTimer(): void {\n\t\tthis.refreshTimer?.restart();\n\t}\n\n\t/**\n\t * Gets the current refresh promise for testing purposes.\n\t * @returns The snapshot sequence number promise, or undefined if no refresh is in progress\n\t */\n\tpublic get refreshSnapshotP(): Promise<number> | undefined {\n\t\treturn this.refreshTracker.promise;\n\t}\n\n\t/**\n\t * Disposes the refresher and clears the timer.\n\t */\n\tpublic dispose(): void {\n\t\tthis.#disposed = true;\n\t\tthis.refreshTimer?.clear();\n\t}\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-loader",
-  "version": "2.74.0",
+  "version": "2.81.0-374083",
   "description": "Fluid container loader",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -129,13 +129,13 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.74.0",
-    "@fluidframework/container-definitions": "~2.74.0",
-    "@fluidframework/core-interfaces": "~2.74.0",
-    "@fluidframework/core-utils": "~2.74.0",
-    "@fluidframework/driver-definitions": "~2.74.0",
-    "@fluidframework/driver-utils": "~2.74.0",
-    "@fluidframework/telemetry-utils": "~2.74.0",
+    "@fluid-internal/client-utils": "2.81.0-374083",
+    "@fluidframework/container-definitions": "2.81.0-374083",
+    "@fluidframework/core-interfaces": "2.81.0-374083",
+    "@fluidframework/core-utils": "2.81.0-374083",
+    "@fluidframework/driver-definitions": "2.81.0-374083",
+    "@fluidframework/driver-utils": "2.81.0-374083",
+    "@fluidframework/telemetry-utils": "2.81.0-374083",
     "@types/events_pkg": "npm:@types/events@^3.0.0",
     "@ungap/structured-clone": "^1.2.0",
     "debug": "^4.3.4",
@@ -144,16 +144,16 @@
     "uuid": "^11.1.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
+    "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/client-utils": "~2.74.0",
-    "@fluid-internal/mocha-test-setup": "~2.74.0",
-    "@fluid-private/test-loader-utils": "~2.74.0",
-    "@fluid-tools/build-cli": "^0.61.0",
+    "@fluid-internal/client-utils": "2.81.0-374083",
+    "@fluid-internal/mocha-test-setup": "2.81.0-374083",
+    "@fluid-private/test-loader-utils": "2.81.0-374083",
+    "@fluid-tools/build-cli": "^0.63.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.61.0",
-    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.73.0",
-    "@fluidframework/eslint-config-fluid": "~2.74.0",
+    "@fluidframework/build-tools": "^0.63.0",
+    "@fluidframework/container-loader-previous": "npm:@fluidframework/container-loader@2.80.0",
+    "@fluidframework/eslint-config-fluid": "2.81.0-374083",
     "@microsoft/api-extractor": "7.52.11",
     "@types/debug": "^4.1.5",
     "@types/double-ended-queue": "^2.1.0",
@@ -162,14 +162,14 @@
     "@types/sinon": "^17.0.3",
     "@types/ungap__structured-clone": "^1.2.0",
     "c8": "^10.1.3",
-    "concurrently": "^8.2.1",
+    "concurrently": "^9.2.1",
     "copyfiles": "^2.4.1",
-    "cross-env": "^7.0.3",
-    "eslint": "~8.57.1",
+    "cross-env": "^10.1.0",
+    "eslint": "~9.39.1",
     "jiti": "^2.6.1",
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
-    "rimraf": "^4.4.0",
+    "rimraf": "^6.1.2",
     "sinon": "^18.0.1",
     "typescript": "~5.4.5"
   },

package/src/connectionManager.ts

@@ -564,6 +564,7 @@ export class ConnectionManager implements IConnectionManager {
 				this.logger.sendTelemetryEvent(
 					{
 						eventName: "ConnectionReceived",
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						connected: connection !== undefined && connection.disposed === false,
 					},
 					undefined,
@@ -573,6 +574,7 @@ export class ConnectionManager implements IConnectionManager {
 				this.logger.sendTelemetryEvent(
 					{
 						eventName: "ConnectToDeltaStreamException",
+						// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 						connected: connection !== undefined && connection.disposed === false,
 					},
 					undefined,

package/src/container.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-/* eslint-disable unicorn/consistent-function-scoping */
+/* eslint-disable unicorn/consistent-function-scoping, @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/prefer-optional-chain */
 
 import {
 	TypedEventEmitter,
@@ -751,7 +751,7 @@ export class Container
 		validateDriverCompatibility(
 			maybeDriverCompatDetails.ILayerCompatDetails,
 			(error) => {} /* disposeFn */, // There is nothing to dispose here, so just ignore the error.
-			subLogger,
+			createChildMonitoringContext({ logger: subLogger, namespace: "Container" }),
 		);
 
 		this.connectionTransitionTimes[ConnectionState.Disconnected] = performanceNow();
@@ -2440,10 +2440,7 @@ export class Container
 
 			// Validate that the Runtime is compatible with this Loader.
 			const maybeRuntimeCompatDetails = runtime as FluidObject<ILayerCompatDetails>;
-			validateRuntimeCompatibility(
-				maybeRuntimeCompatDetails.ILayerCompatDetails,
-				this.mc.logger,
-			);
+			validateRuntimeCompatibility(maybeRuntimeCompatDetails.ILayerCompatDetails, this.mc);
 
 			this._runtime = runtime;
 			this._lifecycleEvents.emit("runtimeInstantiated");

package/src/deltaManager.ts

@@ -30,6 +30,7 @@ import {
 	type ISignalMessage,
 	type IClientDetails,
 	type IClientConfiguration,
+	type ISequencedDocumentSystemMessage,
 } from "@fluidframework/driver-definitions/internal";
 import { NonRetryableError, isRuntimeMessage } from "@fluidframework/driver-utils/internal";
 import {
@@ -189,6 +190,12 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 	private lastProcessedSequenceNumber: number = 0;
 	private lastProcessedMessage: ISequencedDocumentMessage | undefined;
 
+	/**
+	 * Map of clientId to the last observed message from that client. This is used to validate
+	 * that clientSequenceNumbers are always increasing for a given clientId.
+	 */
+	private readonly lastObservedMessageByClient = new Map<string, ISequencedDocumentMessage>();
+
 	/**
 	 * Count the number of noops sent by the client which may not be acked
 	 */
@@ -661,6 +668,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 			throw new Error("Delta manager is not attached");
 		}
 
+		// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- using ??= could change behavior if value is falsy
 		if (this.deltaStorage === undefined) {
 			this.deltaStorage = await docService.connectToDeltaStorage();
 		}
@@ -861,7 +869,50 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 	// Also payload goes to telemetry, so no content or anything else that shouldn't be logged for privacy reasons
 	// Note: It's possible for a duplicate op to be broadcasted and have everything the same except the timestamp.
 	private comparableMessagePayload(m: ISequencedDocumentMessage): string {
-		return `${m.clientId}-${m.type}-${m.minimumSequenceNumber}-${m.referenceSequenceNumber}-${m.timestamp}`;
+		return `${m.clientId}-${m.type}-${m.sequenceNumber}-${m.minimumSequenceNumber}-${m.referenceSequenceNumber}-${m.timestamp}`;
+	}
+
+	/**
+	 * Validates that the clientSequenceNumber for a given clientId is always increasing.
+	 * @param message - The message to validate.
+	 */
+	private validateClientSequenceNumberConsistency(message: ISequencedDocumentMessage): void {
+		// Once client leaves, we no longer need to track its last observed message as the client won't send messages.
+		if (message.type === MessageType.ClientLeave) {
+			const systemLeaveMessage = message as ISequencedDocumentSystemMessage;
+			const clientId = JSON.parse(systemLeaveMessage.data) as string;
+			this.lastObservedMessageByClient.delete(clientId);
+		}
+
+		if (message.clientId === null) {
+			return;
+		}
+
+		const lastObservedClientMessage = this.lastObservedMessageByClient.get(message.clientId);
+		if (
+			lastObservedClientMessage !== undefined &&
+			message.clientSequenceNumber <= lastObservedClientMessage.clientSequenceNumber
+		) {
+			// This looks like a data corruption issue where the clientSequenceNumber for a given clientId is not
+			// increasing. The Fluid Service ensures that it only processes ops with contiguous increasing
+			// clientSequenceNumbers for a given clientId.
+			// So, if we see this error, it is likely a service issue.
+			// One example of this is if the service sequences the same op more than once. In this case, all the
+			// properties except the sequenceNumber will be the same.
+			// Note that we are not checking for gaps in clientSequenceNumber because very old clients may have gaps
+			// as per the op stream in the snapshot tests under test/snapshots/content.
+			const error = new DataCorruptionError(
+				"Found two messages with non-increasing clientSequenceNumber for a given client. Likely to be a service issue",
+				{
+					clientId: this.connectionManager.clientId,
+					sequenceNumber: message.sequenceNumber,
+					message1: this.comparableMessagePayload(lastObservedClientMessage),
+					message2: this.comparableMessagePayload(message),
+				},
+			);
+			this.close(error);
+		}
+		this.lastObservedMessageByClient.set(message.clientId, message);
 	}
 
 	private enqueueMessages(
@@ -914,6 +965,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 					duplicate++;
 				} else if (message.sequenceNumber !== prev + 1) {
 					gap++;
+					// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- using ??= could change behavior if value is falsy
 					if (firstMissing === undefined) {
 						firstMissing = prev + 1;
 					}
@@ -1002,6 +1054,7 @@ export class DeltaManager<TConnectionManager extends IConnectionManager>
 					}
 				}
 			} else if (message.sequenceNumber === this.lastQueuedSequenceNumber + 1) {
+				this.validateClientSequenceNumberConsistency(message);
 				this.lastQueuedSequenceNumber = message.sequenceNumber;
 				this.previouslyProcessedMessage = message;
 				this._inbound.push(message);

package/src/loaderLayerCompatState.ts

@@ -3,14 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import type {
-	ILayerCompatDetails,
-	ILayerCompatSupportRequirements,
+import {
+	generation,
+	type ILayerCompatDetails,
+	type ILayerCompatSupportRequirements,
 } from "@fluid-internal/client-utils";
 import type { ICriticalContainerError } from "@fluidframework/container-definitions";
 import {
 	validateLayerCompatibility,
-	type ITelemetryLoggerExt,
+	type MonitoringContext,
 } from "@fluidframework/telemetry-utils/internal";
 
 import { pkgVersion } from "./packageVersion.js";
@@ -27,7 +28,7 @@ export const loaderCoreCompatDetails = {
 	/**
 	 * The current generation of the Loader layer.
 	 */
-	generation: 3,
+	generation,
 };
 
 /**
@@ -80,7 +81,7 @@ export const driverSupportRequirementsForLoader: ILayerCompatSupportRequirements
  */
 export function validateRuntimeCompatibility(
 	maybeRuntimeCompatDetails: ILayerCompatDetails | undefined,
-	logger: ITelemetryLoggerExt,
+	mc: MonitoringContext,
 ): void {
 	validateLayerCompatibility(
 		"loader",
@@ -89,7 +90,7 @@ export function validateRuntimeCompatibility(
 		runtimeSupportRequirementsForLoader,
 		maybeRuntimeCompatDetails,
 		() => {} /* disposeFn - no op. This will be handled by the caller */,
-		logger,
+		mc,
 	);
 }
 
@@ -100,7 +101,7 @@ export function validateRuntimeCompatibility(
 export function validateDriverCompatibility(
 	maybeDriverCompatDetails: ILayerCompatDetails | undefined,
 	disposeFn: (error?: ICriticalContainerError) => void,
-	logger: ITelemetryLoggerExt,
+	mc: MonitoringContext,
 ): void {
 	validateLayerCompatibility(
 		"loader",
@@ -109,6 +110,6 @@ export function validateDriverCompatibility(
 		driverSupportRequirementsForLoader,
 		maybeDriverCompatDetails,
 		disposeFn,
-		logger,
+		mc,
 	);
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-loader";
-export const pkgVersion = "2.74.0";
+export const pkgVersion = "2.81.0-374083";