@fluidframework/container-loader 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/dist/container.js

@@ -71,8 +71,8 @@ async function waitContainerToCatchUp(container) {
         // Waiting for "connected" state in either case gets us at least to our own Join op
         // which is a reasonable approximation of "caught up"
         const waitForOps = () => {
-            (0, common_utils_1.assert)(container.connectionState === connectionState_1.ConnectionState.CatchingUp
-                || container.connectionState === connectionState_1.ConnectionState.Connected, 0x0cd /* "Container disconnected while waiting for ops!" */);
+            (0, common_utils_1.assert)(container.connectionState === connectionState_1.ConnectionState.CatchingUp ||
+                container.connectionState === connectionState_1.ConnectionState.Connected, 0x0cd /* "Container disconnected while waiting for ops!" */);
             const hasCheckpointSequenceNumber = deltaManager.hasCheckpointSequenceNumber;
             const connectionOpSeqNumber = deltaManager.lastKnownSeqNumber;
             (0, common_utils_1.assert)(deltaManager.lastSequenceNumber <= connectionOpSeqNumber, 0x266 /* "lastKnownSeqNumber should never be below last processed sequence number" */);
@@ -168,7 +168,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.setAutoReconnectTime = common_utils_1.performance.now();
         this._disposed = false;
         this.clientDetailsOverride = config.clientDetailsOverride;
-        this._scopeOverride = config.scopeOverride;
         this._resolvedUrl = config.resolvedUrl;
         if (config.canReconnect !== undefined) {
             this._canReconnect = config.canReconnect;
@@ -206,6 +205,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 dmLastMsqSeqNumber: () => { var _a, _b; return (_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.sequenceNumber; },
                 dmLastMsqSeqTimestamp: () => { var _a, _b; return (_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.timestamp; },
                 dmLastMsqSeqClientId: () => { var _a, _b; return (_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.clientId; },
+                dmLastMsgClientSeq: () => { var _a, _b; return (_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.clientSequenceNumber; },
                 connectionStateDuration: () => common_utils_1.performance.now() - this.connectionTransitionTimes[this.connectionState],
             },
         });
@@ -223,7 +223,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 }
                 this.logConnectionStateChangeTelemetry(value, oldState, reason);
                 if (this._lifecycleState === "loaded") {
-                    this.propagateConnectionState(false /* initial transition */, value === connectionState_1.ConnectionState.Disconnected ? reason : undefined /* disconnectedReason */);
+                    this.propagateConnectionState(false /* initial transition */, value === connectionState_1.ConnectionState.Disconnected
+                        ? reason
+                        : undefined /* disconnectedReason */);
                 }
             },
             shouldClientJoinWrite: () => this._deltaManager.connectionManager.shouldJoinWrite(),
@@ -236,7 +238,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 // so we always time-out processing of join op in cases where fetching snapshot takes a minute.
                 // It's not a problem with op processing itself - such issues should be tracked as part of boot perf monitoring instead.
                 this._deltaManager.logConnectionIssue(Object.assign({ eventName,
-                    mode, category: (this._lifecycleState === "loading") ? "generic" : category, duration: common_utils_1.performance.now() - this.connectionTransitionTimes[connectionState_1.ConnectionState.CatchingUp] }, (details === undefined ? {} : { details: JSON.stringify(details) })));
+                    mode, category: this._lifecycleState === "loading" ? "generic" : category, duration: common_utils_1.performance.now() -
+                        this.connectionTransitionTimes[connectionState_1.ConnectionState.CatchingUp] }, (details === undefined ? {} : { details: JSON.stringify(details) })));
                 // If this is "write" connection, it took too long to receive join op. But in most cases that's due
                 // to very slow op fetches and we will eventually get there.
                 // For "read" connections, we get here due to self join signal not arriving on time. We will need to
@@ -270,7 +273,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 }
                 else {
                     // settimeout so this will hopefully fire after disconnect event if being hidden caused it
-                    setTimeout(() => { this.lastVisible = undefined; }, 0);
+                    setTimeout(() => {
+                        this.lastVisible = undefined;
+                    }, 0);
                 }
             };
             document.addEventListener("visibilitychange", this.visibilityEventHandler);
@@ -281,7 +286,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         // if we are in connecting stage.
         this.on("newListener", (event, listener) => {
             // Fire events on the end of JS turn, giving a chance for caller to be in consistent state.
-            Promise.resolve().then(() => {
+            Promise.resolve()
+                .then(() => {
                 switch (event) {
                     case dirtyContainerEvent:
                         if (this._dirtyContainer) {
@@ -305,7 +311,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                         break;
                     default:
                 }
-            }).catch((error) => {
+            })
+                .catch((error) => {
                 this.mc.logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
             });
         });
@@ -320,7 +327,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             canReconnect: loadOptions.canReconnect,
             serializedContainerState: pendingLocalState,
             baseLogger: loadOptions.baseLogger,
-            scopeOverride: loadOptions.scopeOverride,
         }, protocolHandlerBuilder);
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(container.mc.logger, { eventName: "Load" }, async (event) => new Promise((resolve, reject) => {
             var _a, _b;
@@ -335,7 +341,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 reject(err !== null && err !== void 0 ? err : new container_utils_1.GenericError("Container closed without error during load"));
             };
             container.on("closed", onClosed);
-            container.load(version, mode, pendingLocalState)
+            container
+                .load(version, mode, pendingLocalState)
                 .finally(() => {
                 container.removeListener("closed", onClosed);
             })
@@ -384,8 +391,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         }
     }
     get closed() {
-        return (this._lifecycleState === "closing" || this._lifecycleState === "closed"
-            || this._lifecycleState === "disposing" || this._lifecycleState === "disposed");
+        return (this._lifecycleState === "closing" ||
+            this._lifecycleState === "closed" ||
+            this._lifecycleState === "disposing" ||
+            this._lifecycleState === "disposed");
     }
     get storage() {
         return this.storageService;
@@ -402,8 +411,12 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         }
         return this._protocolHandler;
     }
-    get connectionMode() { return this._deltaManager.connectionManager.connectionMode; }
-    get IFluidRouter() { return this; }
+    get connectionMode() {
+        return this._deltaManager.connectionManager.connectionMode;
+    }
+    get IFluidRouter() {
+        return this;
+    }
     get resolvedUrl() {
         return this._resolvedUrl;
     }
@@ -485,10 +498,18 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     get isDirty() {
         return this._dirtyContainer;
     }
-    get serviceFactory() { return this.loader.services.documentServiceFactory; }
-    get urlResolver() { return this.loader.services.urlResolver; }
-    get scope() { var _a; return (_a = this._scopeOverride) !== null && _a !== void 0 ? _a : this.loader.services.scope; }
-    get codeLoader() { return this.loader.services.codeLoader; }
+    get serviceFactory() {
+        return this.loader.services.documentServiceFactory;
+    }
+    get urlResolver() {
+        return this.loader.services.urlResolver;
+    }
+    get scope() {
+        return this.loader.services.scope;
+    }
+    get codeLoader() {
+        return this.loader.services.codeLoader;
+    }
     /**
      * Retrieves the quorum associated with the document
      */
@@ -556,7 +577,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 // This gives us a chance to know what errors happened on open vs. on fully loaded container.
                 this.mc.logger.sendTelemetryEvent({
                     eventName: "ContainerDispose",
-                    category: error === undefined ? "generic" : "error",
+                    category: "generic",
                 }, error);
                 // ! Progressing from "closed" to "disposing" is not allowed
                 if (this._lifecycleState !== "closed") {
@@ -612,8 +633,12 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const appSummary = this.context.createSummary();
         const protocolSummary = this.captureProtocolSummary();
         const combinedSummary = (0, driver_utils_1.combineAppAndProtocolSummary)(appSummary, protocolSummary);
-        if (this.loader.services.detachedBlobStorage && this.loader.services.detachedBlobStorage.size > 0) {
-            combinedSummary.tree[".hasAttachmentBlobs"] = { type: protocol_definitions_1.SummaryType.Blob, content: "true" };
+        if (this.loader.services.detachedBlobStorage &&
+            this.loader.services.detachedBlobStorage.size > 0) {
+            combinedSummary.tree[".hasAttachmentBlobs"] = {
+                type: protocol_definitions_1.SummaryType.Blob,
+                content: "true",
+            };
         }
         return JSON.stringify(combinedSummary);
     }
@@ -628,8 +653,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             (0, common_utils_1.assert)(this._attachState === container_definitions_1.AttachState.Detached && !this.attachStarted, 0x205 /* "attach() called more than once" */);
             this.attachStarted = true;
             // If attachment blobs were uploaded in detached state we will go through a different attach flow
-            const hasAttachmentBlobs = this.loader.services.detachedBlobStorage !== undefined
-                && this.loader.services.detachedBlobStorage.size > 0;
+            const hasAttachmentBlobs = this.loader.services.detachedBlobStorage !== undefined &&
+                this.loader.services.detachedBlobStorage.size > 0;
             try {
                 (0, common_utils_1.assert)(this.deltaManager.inbound.length === 0, 0x0d6 /* "Inbound queue should be empty when attaching" */);
                 let summary;
@@ -667,7 +692,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                     const redirectTable = new Map();
                     // if new blobs are added while uploading, upload them too
                     while (redirectTable.size < this.loader.services.detachedBlobStorage.size) {
-                        const newIds = this.loader.services.detachedBlobStorage.getBlobIds().filter((id) => !redirectTable.has(id));
+                        const newIds = this.loader.services.detachedBlobStorage
+                            .getBlobIds()
+                            .filter((id) => !redirectTable.has(id));
                         for (const id of newIds) {
                             const blob = await this.loader.services.detachedBlobStorage.readBlob(id);
                             const response = await this.storageService.createBlob(blob);
@@ -689,7 +716,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 this._attachState = container_definitions_1.AttachState.Attached;
                 this.emit("attached");
                 if (!this.closed) {
-                    this.resumeInternal({ fetchOpsFromStorage: false, reason: "createDetached" });
+                    this.resumeInternal({
+                        fetchOpsFromStorage: false,
+                        reason: "createDetached",
+                    });
                 }
             }
             catch (error) {
@@ -789,7 +819,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 throw new Error("Proposed code details should be greater than the current");
             }
         }
-        return this.protocolHandler.quorum.propose("code", codeDetails)
+        return this.protocolHandler.quorum
+            .propose("code", codeDetails)
             .then(() => true)
             .catch(() => false);
     }
@@ -798,9 +829,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const codeDetails = this.getCodeDetailsFromQuorum();
         await Promise.all([
             this.deltaManager.inbound.pause(),
-            this.deltaManager.inboundSignal.pause()
+            this.deltaManager.inboundSignal.pause(),
         ]);
-        if ((await this.context.satisfies(codeDetails) === true)) {
+        if ((await this.context.satisfies(codeDetails)) === true) {
             this.deltaManager.inbound.resume();
             this.deltaManager.inboundSignal.resume();
             return;
@@ -846,7 +877,11 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         // connections to same file) in two ways:
         // A) creation flow breaks (as one of the clients "sees" file as existing, and hits #2 above)
         // B) Once file is created, transition from view-only connection to write does not work - some bugs to be fixed.
-        const connectionArgs = { reason: "DocumentOpen", mode: "write", fetchOpsFromStorage: false };
+        const connectionArgs = {
+            reason: "DocumentOpen",
+            mode: "write",
+            fetchOpsFromStorage: false,
+        };
         // 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) {
@@ -970,7 +1005,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     }
     async rehydrateDetachedFromSnapshot(detachedContainerSnapshot) {
         if (detachedContainerSnapshot.tree[".hasAttachmentBlobs"] !== undefined) {
-            (0, common_utils_1.assert)(!!this.loader.services.detachedBlobStorage && this.loader.services.detachedBlobStorage.size > 0, 0x250 /* "serialized container with attachment blobs must be rehydrated with detached blob storage" */);
+            (0, common_utils_1.assert)(!!this.loader.services.detachedBlobStorage &&
+                this.loader.services.detachedBlobStorage.size > 0, 0x250 /* "serialized container with attachment blobs must be rehydrated with detached blob storage" */);
             delete detachedContainerSnapshot.tree[".hasAttachmentBlobs"];
         }
         const snapshotTree = (0, utils_1.getSnapshotTreeFromSerializedContainer)(detachedContainerSnapshot);
@@ -1017,11 +1053,12 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         };
         if (snapshot !== undefined) {
             const baseTree = (0, utils_1.getProtocolSnapshotTree)(snapshot);
-            [quorumSnapshot.members, quorumSnapshot.proposals, quorumSnapshot.values] = await Promise.all([
-                (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumMembers),
-                (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumProposals),
-                (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumValues),
-            ]);
+            [quorumSnapshot.members, quorumSnapshot.proposals, quorumSnapshot.values] =
+                await Promise.all([
+                    (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumMembers),
+                    (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumProposals),
+                    (0, driver_utils_1.readAndParse)(storage, baseTree.blobs.quorumValues),
+                ]);
         }
         this.initializeProtocolState(attributes, quorumSnapshot);
     }
@@ -1108,7 +1145,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         if (this.clientDetailsOverride !== undefined) {
             (0, merge_1.default)(client.details, this.clientDetailsOverride);
         }
-        client.details.environment = [client.details.environment, ` loaderVersion:${packageVersion_1.pkgVersion}`].join(";");
+        client.details.environment = [
+            client.details.environment,
+            ` loaderVersion:${packageVersion_1.pkgVersion}`,
+        ].join(";");
         return client;
     }
     /**
@@ -1118,8 +1158,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
      * If it's not true, runtime is not in position to send ops.
      */
     activeConnection() {
-        return this.connectionState === connectionState_1.ConnectionState.Connected &&
-            this.connectionMode === "write";
+        return (this.connectionState === connectionState_1.ConnectionState.Connected && this.connectionMode === "write");
     }
     createDeltaManager() {
         const serviceProvider = () => this.service;
@@ -1186,7 +1225,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         }
         else {
             if (value === connectionState_1.ConnectionState.Connected) {
-                durationFromDisconnected = time - this.connectionTransitionTimes[connectionState_1.ConnectionState.Disconnected];
+                durationFromDisconnected =
+                    time - this.connectionTransitionTimes[connectionState_1.ConnectionState.Disconnected];
                 durationFromDisconnected = telemetry_utils_1.TelemetryLogger.formatTick(durationFromDisconnected);
             }
             else {
@@ -1229,7 +1269,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.protocolHandler.setConnectionState(state, this.clientId);
         (0, telemetry_utils_1.raiseConnectedEvent)(this.mc.logger, this, state, this.clientId, disconnectedReason);
         if (logOpsOnReconnect) {
-            this.mc.logger.sendTelemetryEvent({ eventName: "OpsSentOnReconnect", count: this.messageCountAfterDisconnection });
+            this.mc.logger.sendTelemetryEvent({
+                eventName: "OpsSentOnReconnect",
+                count: this.messageCountAfterDisconnection,
+            });
         }
     }
     // back-compat: ADO #1385: Remove in the future, summary op should come through submitSummaryMessage()
@@ -1266,8 +1309,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         if (summary.details === undefined) {
             summary.details = {};
         }
-        summary.details.includesProtocolTree =
-            this.options.summarizeProtocolTree === true;
+        summary.details.includesProtocolTree = this.options.summarizeProtocolTree === true;
         return this.submitMessage(protocol_definitions_1.MessageType.Summarize, JSON.stringify(summary), false /* batch */);
     }
     submitMessage(type, contents, batch, metadata, compression) {
@@ -1326,10 +1368,13 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const version = await this.getVersion(specifiedVersion !== null && specifiedVersion !== void 0 ? specifiedVersion : null);
         if (version === undefined && specifiedVersion !== undefined) {
             // We should have a defined version to load from if specified version requested
-            this.mc.logger.sendErrorEvent({ eventName: "NoVersionFoundWhenSpecified", id: specifiedVersion });
+            this.mc.logger.sendErrorEvent({
+                eventName: "NoVersionFoundWhenSpecified",
+                id: specifiedVersion,
+            });
         }
         this._loadedFromVersion = version;
-        const snapshot = (_a = await this.storageService.getSnapshotTree(version)) !== null && _a !== void 0 ? _a : undefined;
+        const snapshot = (_a = (await this.storageService.getSnapshotTree(version))) !== null && _a !== void 0 ? _a : undefined;
         if (snapshot === undefined && version !== undefined) {
             this.mc.logger.sendErrorEvent({ eventName: "getSnapshotTreeFailed", id: version.id });
         }