@fluidframework/container-loader 2.0.0-internal.4.0.6 → 2.0.0-internal.4.1.1

package/lib/container.js

@@ -4,6 +4,8 @@
  */
 // eslint-disable-next-line import/no-internal-modules
 import merge from "lodash/merge";
+// eslint-disable-next-line import/no-internal-modules
+import cloneDeep from "lodash/cloneDeep";
 import { v4 as uuid } from "uuid";
 import { assert, performance, unreachableCase } from "@fluidframework/common-utils";
 import { AttachState, isFluidCodeDetails, } from "@fluidframework/container-definitions";
@@ -18,14 +20,14 @@ import { DeltaManager } from "./deltaManager";
 import { DeltaManagerProxy } from "./deltaManagerProxy";
 import { RelativeLoader } from "./loader";
 import { pkgVersion } from "./packageVersion";
-import { ContainerStorageAdapter } from "./containerStorageAdapter";
+import { ContainerStorageAdapter, getBlobContentsFromTree, getBlobContentsFromTreeWithBlobContents, } from "./containerStorageAdapter";
 import { createConnectionStateHandler } from "./connectionStateHandler";
 import { getProtocolSnapshotTree, getSnapshotTreeFromSerializedContainer } from "./utils";
 import { initQuorumValuesFromCodeDetails, getCodeDetailsFromQuorumValues, QuorumProxy, } from "./quorum";
 import { CollabWindowTracker } from "./collabWindowTracker";
 import { ConnectionManager } from "./connectionManager";
 import { ConnectionState } from "./connectionState";
-import { ProtocolHandler } from "./protocol";
+import { OnlyValidTermValue, ProtocolHandler, } from "./protocol";
 const detachedContainerRefSeqNumber = 0;
 const dirtyContainerEvent = "dirty";
 const savedContainerEvent = "saved";
@@ -123,8 +125,11 @@ const summarizerClientType = "summarizer";
  * @deprecated - In the next release Container will no longer be exported, IContainer should be used in its place.
  */
 export class Container extends EventEmitterWithErrorHandling {
+    /**
+     * @internal
+     */
     constructor(loader, config, protocolHandlerBuilder) {
-        var _a, _b;
+        var _a, _b, _c;
         super((name, error) => {
             this.mc.logger.sendErrorEvent({
                 eventName: "ContainerEventHandlerException",
@@ -160,6 +165,7 @@ export class Container extends EventEmitterWithErrorHandling {
         this.messageCountAfterDisconnection = 0;
         this.attachStarted = false;
         this._dirtyContainer = false;
+        this.savedOps = [];
         this.setAutoReconnectTime = performance.now();
         this._disposed = false;
         this.clientDetailsOverride = config.clientDetailsOverride;
@@ -204,9 +210,8 @@ export class Container extends EventEmitterWithErrorHandling {
         });
         // Prefix all events in this file with container-loader
         this.mc = loggerToMonitoringContext(ChildLogger.create(this.subLogger, "Container"));
-        this.options = Object.assign({}, this.loader.services.options);
+        this.options = cloneDeep(this.loader.services.options);
         this._deltaManager = this.createDeltaManager();
-        this._clientId = (_a = config.serializedContainerState) === null || _a === void 0 ? void 0 : _a.clientId;
         this.connectionStateHandler = createConnectionStateHandler({
             logger: this.mc.logger,
             connectionStateChanged: (value, oldState, reason) => {
@@ -245,7 +250,7 @@ export class Container extends EventEmitterWithErrorHandling {
                     this.connect();
                 }
             },
-        }, this.deltaManager, this._clientId);
+        }, this.deltaManager, (_a = config.serializedContainerState) === null || _a === void 0 ? void 0 : _a.clientId);
         this.on(savedContainerEvent, () => {
             this.connectionStateHandler.containerSaved();
         });
@@ -258,7 +263,7 @@ export class Container extends EventEmitterWithErrorHandling {
         // Whether the combined summary tree has been forced on by either the loader option or the monitoring context.
         // Even if not forced on via this flag, combined summaries may still be enabled by service policy.
         const forceEnableSummarizeProtocolTree = (_b = this.mc.config.getBoolean("Fluid.Container.summarizeProtocolTree2")) !== null && _b !== void 0 ? _b : this.loader.services.options.summarizeProtocolTree;
-        this.storageAdapter = new ContainerStorageAdapter(this.loader.services.detachedBlobStorage, this.mc.logger, addProtocolSummaryIfMissing, forceEnableSummarizeProtocolTree);
+        this.storageAdapter = new ContainerStorageAdapter(this.loader.services.detachedBlobStorage, this.mc.logger, (_c = config.serializedContainerState) === null || _c === void 0 ? void 0 : _c.snapshotBlobs, addProtocolSummaryIfMissing, forceEnableSummarizeProtocolTree);
         const isDomAvailable = typeof document === "object" &&
             document !== null &&
             typeof document.addEventListener === "function" &&
@@ -282,6 +287,7 @@ export class Container extends EventEmitterWithErrorHandling {
     }
     /**
      * Load an existing container.
+     * @internal
      */
     static async load(loader, loadOptions, pendingLocalState, protocolHandlerBuilder) {
         const container = new Container(loader, {
@@ -430,6 +436,12 @@ export class Container extends EventEmitterWithErrorHandling {
     get clientDetails() {
         return this._deltaManager.clientDetails;
     }
+    get offlineLoadEnabled() {
+        var _a;
+        // summarizer will not have any pending state we want to save
+        return (((_a = this.mc.config.getBoolean("Fluid.Container.enableOfflineLoad")) !== null && _a !== void 0 ? _a : false) &&
+            this.clientDetails.capabilities.interactive);
+    }
     /**
      * Get the code details that are currently specified for the container.
      * @returns The current code details if any are specified, undefined if none are specified.
@@ -607,15 +619,21 @@ export class Container extends EventEmitterWithErrorHandling {
         // runtime matches pending ops to successful ones by clientId and client seq num, so we need to close the
         // container at the same time we get pending state, otherwise this container could reconnect and resubmit with
         // a new clientId and a future container using stale pending state without the new clientId would resubmit them
+        if (!this.offlineLoadEnabled) {
+            throw new UsageError("Can't get pending local state unless offline load is enabled");
+        }
         assert(this.attachState === AttachState.Attached, 0x0d1 /* "Container should be attached before close" */);
         assert(this.resolvedUrl !== undefined && this.resolvedUrl.type === "fluid", 0x0d2 /* "resolved url should be valid Fluid url" */);
         assert(!!this._protocolHandler, 0x2e3 /* "Must have a valid protocol handler instance" */);
-        assert(this._protocolHandler.attributes.term !== undefined, 0x37e /* Must have a valid protocol handler instance */);
+        assert(!!this.baseSnapshot, 0x5d4 /* no base snapshot */);
+        assert(!!this.baseSnapshotBlobs, 0x5d5 /* no snapshot blobs */);
         const pendingState = {
             pendingRuntimeState: this.context.getPendingLocalState(),
+            baseSnapshot: this.baseSnapshot,
+            snapshotBlobs: this.baseSnapshotBlobs,
+            savedOps: this.savedOps,
             url: this.resolvedUrl.url,
-            protocol: this.protocolHandler.getProtocolState(),
-            term: this._protocolHandler.attributes.term,
+            term: OnlyValidTermValue,
             clientId: this.clientId,
         };
         this.mc.logger.sendTelemetryEvent({ eventName: "CloseAndGetPendingLocalState" });
@@ -667,7 +685,13 @@ export class Container extends EventEmitterWithErrorHandling {
                     // starting to attach the container to storage.
                     // Also, this should only be fired in detached container.
                     this._attachState = AttachState.Attaching;
-                    this.context.notifyAttaching(getSnapshotTreeFromSerializedContainer(summary));
+                    this.emit("attaching");
+                    if (this.offlineLoadEnabled) {
+                        const snapshot = getSnapshotTreeFromSerializedContainer(summary);
+                        this.baseSnapshot = snapshot;
+                        this.baseSnapshotBlobs =
+                            getBlobContentsFromTreeWithBlobContents(snapshot);
+                    }
                 }
                 // Actually go and create the resolved document
                 const createNewResolvedUrl = await this.urlResolver.resolve(request);
@@ -704,7 +728,13 @@ export class Container extends EventEmitterWithErrorHandling {
                     const protocolSummary = this.captureProtocolSummary();
                     summary = combineAppAndProtocolSummary(appSummary, protocolSummary);
                     this._attachState = AttachState.Attaching;
-                    this.context.notifyAttaching(getSnapshotTreeFromSerializedContainer(summary));
+                    this.emit("attaching");
+                    if (this.offlineLoadEnabled) {
+                        const snapshot = getSnapshotTreeFromSerializedContainer(summary);
+                        this.baseSnapshot = snapshot;
+                        this.baseSnapshotBlobs =
+                            getBlobContentsFromTreeWithBlobContents(snapshot);
+                    }
                     await this.storageAdapter.uploadSummaryWithContext(summary, {
                         referenceSequenceNumber: 0,
                         ackHandle: undefined,
@@ -862,6 +892,7 @@ export class Container extends EventEmitterWithErrorHandling {
      * @param specifiedVersion - Version SHA to load snapshot. If not specified, will fetch the latest snapshot.
      */
     async load(specifiedVersion, loadMode, pendingLocalState) {
+        var _a;
         if (this._resolvedUrl === undefined) {
             throw new Error("Attempting to load without a resolved url");
         }
@@ -882,7 +913,7 @@ export class Container extends EventEmitterWithErrorHandling {
         };
         // Start websocket connection as soon as possible. Note that there is no op handler attached yet, but the
         // DeltaManager is resilient to this and will wait to start processing ops until after it is attached.
-        if (loadMode.deltaConnection === undefined) {
+        if (loadMode.deltaConnection === undefined && !pendingLocalState) {
             this.connectToDeltaStream(connectionArgs);
         }
         if (!pendingLocalState) {
@@ -900,15 +931,23 @@ export class Container extends EventEmitterWithErrorHandling {
         // Fetch specified snapshot.
         const { snapshot, versionId } = pendingLocalState === undefined
             ? await this.fetchSnapshotTree(specifiedVersion)
-            : { snapshot: undefined, versionId: undefined };
-        assert(snapshot !== undefined || pendingLocalState !== undefined, 0x237 /* "Snapshot should exist" */);
-        const attributes = pendingLocalState === undefined
-            ? await this.getDocumentAttributes(this.storageAdapter, snapshot)
-            : {
-                sequenceNumber: pendingLocalState.protocol.sequenceNumber,
-                minimumSequenceNumber: pendingLocalState.protocol.minimumSequenceNumber,
-                term: pendingLocalState.term,
-            };
+            : { snapshot: pendingLocalState.baseSnapshot, versionId: undefined };
+        if (pendingLocalState) {
+            this.baseSnapshot = pendingLocalState.baseSnapshot;
+            this.baseSnapshotBlobs = pendingLocalState.snapshotBlobs;
+        }
+        else {
+            assert(snapshot !== undefined, 0x237 /* "Snapshot should exist" */);
+            if (this.offlineLoadEnabled) {
+                this.baseSnapshot = snapshot;
+                // Save contents of snapshot now, otherwise closeAndGetPendingLocalState() must be async
+                this.baseSnapshotBlobs = await getBlobContentsFromTree(snapshot, this.storage);
+            }
+        }
+        const attributes = await this.getDocumentAttributes(this.storageAdapter, snapshot);
+        // If we saved ops, we will replay them and don't need DeltaManager to fetch them
+        const sequenceNumber = (_a = pendingLocalState === null || pendingLocalState === void 0 ? void 0 : pendingLocalState.savedOps[pendingLocalState.savedOps.length - 1]) === null || _a === void 0 ? void 0 : _a.sequenceNumber;
+        const dmAttributes = sequenceNumber !== undefined ? Object.assign(Object.assign({}, attributes), { sequenceNumber }) : attributes;
         let opsBeforeReturnP;
         // Attach op handlers to finish initialization and be able to start processing ops
         // Kick off any ops fetching if required.
@@ -916,32 +955,35 @@ export class Container extends EventEmitterWithErrorHandling {
             case undefined:
                 // Start prefetch, but not set opsBeforeReturnP - boot is not blocked by it!
                 // eslint-disable-next-line @typescript-eslint/no-floating-promises
-                this.attachDeltaManagerOpHandler(attributes, loadMode.deltaConnection !== "none" ? "all" : "none");
+                this.attachDeltaManagerOpHandler(dmAttributes, loadMode.deltaConnection !== "none" ? "all" : "none");
                 break;
             case "cached":
-                opsBeforeReturnP = this.attachDeltaManagerOpHandler(attributes, "cached");
+                opsBeforeReturnP = this.attachDeltaManagerOpHandler(dmAttributes, "cached");
                 break;
             case "all":
-                opsBeforeReturnP = this.attachDeltaManagerOpHandler(attributes, "all");
+                opsBeforeReturnP = this.attachDeltaManagerOpHandler(dmAttributes, "all");
                 break;
             default:
                 unreachableCase(loadMode.opsBeforeReturn);
         }
         // ...load in the existing quorum
         // Initialize the protocol handler
-        if (pendingLocalState === undefined) {
-            await this.initializeProtocolStateFromSnapshot(attributes, this.storageAdapter, snapshot);
-        }
-        else {
-            this.initializeProtocolState(attributes, {
-                members: pendingLocalState.protocol.members,
-                proposals: pendingLocalState.protocol.proposals,
-                values: pendingLocalState.protocol.values,
-            });
-        }
+        await this.initializeProtocolStateFromSnapshot(attributes, this.storageAdapter, snapshot);
         const codeDetails = this.getCodeDetailsFromQuorum();
         await this.instantiateContext(true, // existing
         codeDetails, snapshot, pendingLocalState === null || pendingLocalState === void 0 ? void 0 : pendingLocalState.pendingRuntimeState);
+        // replay saved ops
+        if (pendingLocalState) {
+            for (const message of pendingLocalState.savedOps) {
+                this.processRemoteMessage(message);
+                // allow runtime to apply stashed ops at this op's sequence number
+                await this.context.notifyOpReplay(message);
+            }
+            pendingLocalState.savedOps = [];
+            // now set clientId to stashed clientId so live ops are correctly processed as local
+            assert(this.clientId === undefined, 0x5d6 /* Unexpected clientId when setting stashed clientId */);
+            this._clientId = pendingLocalState === null || pendingLocalState === void 0 ? void 0 : pendingLocalState.clientId;
+        }
         // We might have hit some failure that did not manifest itself in exception in this flow,
         // do not start op processing in such case - static version of Container.load() will handle it correctly.
         if (!this.closed) {
@@ -954,6 +996,11 @@ export class Container extends EventEmitterWithErrorHandling {
             }
             switch (loadMode.deltaConnection) {
                 case undefined:
+                    if (pendingLocalState) {
+                        // connect to delta stream now since we did not before
+                        this.connectToDeltaStream(connectionArgs);
+                    }
+                // intentional fallthrough
                 case "delayed":
                     assert(this.inboundQueuePausedFromInit, 0x346 /* inboundQueuePausedFromInit should be true */);
                     this.inboundQueuePausedFromInit = false;
@@ -986,7 +1033,7 @@ export class Container extends EventEmitterWithErrorHandling {
     async createDetached(source) {
         const attributes = {
             sequenceNumber: detachedContainerRefSeqNumber,
-            term: 1,
+            term: OnlyValidTermValue,
             minimumSequenceNumber: 0,
         };
         await this.attachDeltaManagerOpHandler(attributes);
@@ -1029,7 +1076,7 @@ export class Container extends EventEmitterWithErrorHandling {
             return {
                 minimumSequenceNumber: 0,
                 sequenceNumber: 0,
-                term: 1,
+                term: OnlyValidTermValue,
             };
         }
         // Backward compatibility: old docs would have ".attributes" instead of "attributes"
@@ -1037,10 +1084,6 @@ export class Container extends EventEmitterWithErrorHandling {
             ? tree.trees[".protocol"].blobs.attributes
             : tree.blobs[".attributes"];
         const attributes = await readAndParse(storage, attributesHash);
-        // Backward compatibility for older summaries with no term
-        if (attributes.term === undefined) {
-            attributes.term = 1;
-        }
         return attributes;
     }
     async initializeProtocolStateFromSnapshot(attributes, storage, snapshot) {
@@ -1160,7 +1203,7 @@ export class Container extends EventEmitterWithErrorHandling {
     }
     createDeltaManager() {
         const serviceProvider = () => this.service;
-        const deltaManager = new DeltaManager(serviceProvider, ChildLogger.create(this.subLogger, "DeltaManager"), () => this.activeConnection(), (props) => new ConnectionManager(serviceProvider, this.client, this._canReconnect, ChildLogger.create(this.subLogger, "ConnectionManager"), props));
+        const deltaManager = new DeltaManager(serviceProvider, ChildLogger.create(this.subLogger, "DeltaManager"), () => this.activeConnection(), (props) => new ConnectionManager(serviceProvider, () => this.isDirty, this.client, this._canReconnect, ChildLogger.create(this.subLogger, "ConnectionManager"), props));
         // Disable inbound queues as Container is not ready to accept any ops until we are fully loaded!
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         deltaManager.inbound.pause();
@@ -1199,8 +1242,7 @@ export class Container extends EventEmitterWithErrorHandling {
         return deltaManager;
     }
     async attachDeltaManagerOpHandler(attributes, prefetchType) {
-        var _a;
-        return this._deltaManager.attachOpHandler(attributes.minimumSequenceNumber, attributes.sequenceNumber, (_a = attributes.term) !== null && _a !== void 0 ? _a : 1, {
+        return this._deltaManager.attachOpHandler(attributes.minimumSequenceNumber, attributes.sequenceNumber, {
             process: (message) => this.processRemoteMessage(message),
             processSignal: (message) => {
                 this.processSignal(message);
@@ -1263,7 +1305,7 @@ export class Container extends EventEmitterWithErrorHandling {
             this.messageCountAfterDisconnection = 0;
         }
         // Both protocol and context should not be undefined if we got so far.
-        this.setContextConnectedState(state, (_a = this._deltaManager.connectionManager.readOnlyInfo.readonly) !== null && _a !== void 0 ? _a : false);
+        this.setContextConnectedState(state, (_a = this.readOnlyInfo.readonly) !== null && _a !== void 0 ? _a : false);
         this.protocolHandler.setConnectionState(state, this.clientId);
         raiseConnectedEvent(this.mc.logger, this, state, this.clientId, disconnectedReason);
         if (logOpsOnReconnect) {
@@ -1321,6 +1363,9 @@ export class Container extends EventEmitterWithErrorHandling {
         return this._deltaManager.submit(type, contents, batch, metadata, compression, referenceSequenceNumber);
     }
     processRemoteMessage(message) {
+        if (this.offlineLoadEnabled) {
+            this.savedOps.push(message);
+        }
         const local = this.clientId === message.clientId;
         // Allow the protocol handler to process the message
         const result = this.protocolHandler.processMessage(message, local);