@fluidframework/container-loader 2.0.0-internal.6.0.0 → 2.0.0-internal.6.1.1

package/dist/container.js

@@ -194,7 +194,8 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.scope = scope;
         this.detachedBlobStorage = detachedBlobStorage;
         this.protocolHandlerBuilder =
-            protocolHandlerBuilder ?? ((...args) => new protocol_1.ProtocolHandler(...args, new audience_1.Audience()));
+            protocolHandlerBuilder ??
+                ((attributes, quorumSnapshot, sendProposal) => new protocol_1.ProtocolHandler(attributes, quorumSnapshot, sendProposal, new audience_1.Audience(), (clientId) => this.clientsWhoShouldHaveLeft.has(clientId)));
         // Note that we capture the createProps here so we can replicate the creation call when we want to clone.
         this.clone = async (_loadProps, createParamOverrides) => {
             return Container.load(_loadProps, {
@@ -247,11 +248,11 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this._deltaManager = this.createDeltaManager();
         this.connectionStateHandler = (0, connectionStateHandler_1.createConnectionStateHandler)({
             logger: this.mc.logger,
-            connectionStateChanged: (value, oldState, reason, error) => {
+            connectionStateChanged: (value, oldState, reason) => {
                 if (value === connectionState_1.ConnectionState.Connected) {
                     this._clientId = this.connectionStateHandler.pendingClientId;
                 }
-                this.logConnectionStateChangeTelemetry(value, oldState, reason, error);
+                this.logConnectionStateChangeTelemetry(value, oldState, reason);
                 if (this._lifecycleState === "loaded") {
                     this.propagateConnectionState(false /* initial transition */, value === connectionState_1.ConnectionState.Disconnected
                         ? reason
@@ -284,8 +285,9 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 // Other possible recovery path - move to connected state (i.e. ConnectionStateHandler.joinOpTimer
                 // to call this.applyForConnectedState("addMemberEvent") for "read" connections)
                 if (mode === "read") {
-                    this.disconnect();
-                    this.connect();
+                    const reason = { text: "NoJoinSignal" };
+                    this.disconnectInternal(reason);
+                    this.connectInternal({ reason, fetchOpsFromStorage: false });
                 }
             },
             clientShouldHaveLeft: (clientId) => {
@@ -620,7 +622,7 @@ class Container extends telemetry_utils_1.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
-        this.disconnect(); // TODO https://dev.azure.com/fluidframework/internal/_workitems/edit/5127
+        this.disconnectInternal({ text: "closeAndGetPendingLocalState" }); // TODO https://dev.azure.com/fluidframework/internal/_workitems/edit/5127
         const pendingState = await this.getPendingLocalStateCore({ notifyImminentClosure: true });
         this.close();
         return pendingState;
@@ -754,7 +756,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
                 if (!this.closed) {
                     this.resumeInternal({
                         fetchOpsFromStorage: false,
-                        reason: "createDetached",
+                        reason: { text: "createDetached" },
                     });
                 }
             }
@@ -770,7 +772,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
     async request(path) {
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(this.mc.logger, { eventName: "Request" }, async () => this.runtime.request(path), { end: true, cancel: "error" });
     }
-    setAutoReconnectInternal(mode) {
+    setAutoReconnectInternal(mode, reason) {
         const currentMode = this._deltaManager.connectionManager.reconnectMode;
         if (currentMode === mode) {
             return;
@@ -784,7 +786,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             connectionState: connectionState_1.ConnectionState[this.connectionState],
             duration,
         });
-        this._deltaManager.connectionManager.setAutoReconnect(mode);
+        this._deltaManager.connectionManager.setAutoReconnect(mode, reason);
     }
     connect() {
         if (this.closed) {
@@ -797,7 +799,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             // Note: no need to fetch ops as we do it preemptively as part of DeltaManager.attachOpHandler().
             // If there is gap, we will learn about it once connected, but the gap should be small (if any),
             // assuming that connect() is called quickly after initial container boot.
-            this.connectInternal({ reason: "DocumentConnect", fetchOpsFromStorage: false });
+            this.connectInternal({
+                reason: { text: "DocumentConnect" },
+                fetchOpsFromStorage: false,
+            });
         }
     }
     connectInternal(args) {
@@ -807,21 +812,21 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         this.resumeInternal(args);
         // Set Auto Reconnect Mode
         const mode = contracts_1.ReconnectMode.Enabled;
-        this.setAutoReconnectInternal(mode);
+        this.setAutoReconnectInternal(mode, args.reason);
     }
     disconnect() {
         if (this.closed) {
             throw new container_utils_1.UsageError(`The Container is closed and cannot be disconnected`);
         }
         else {
-            this.disconnectInternal();
+            this.disconnectInternal({ text: "DocumentDisconnect" });
         }
     }
-    disconnectInternal() {
+    disconnectInternal(reason) {
         (0, common_utils_1.assert)(!this.closed, 0x2c7 /* "Attempting to disconnect() a closed Container" */);
         // Set Auto Reconnect Mode
         const mode = contracts_1.ReconnectMode.Disabled;
-        this.setAutoReconnectInternal(mode);
+        this.setAutoReconnectInternal(mode, reason);
     }
     resumeInternal(args) {
         (0, common_utils_1.assert)(!this.closed, 0x0d9 /* "Attempting to connect() a closed DeltaManager" */);
@@ -923,7 +928,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         // 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",
+            reason: { text: "DocumentOpen" },
             mode: "write",
             fetchOpsFromStorage: false,
         };
@@ -1285,10 +1290,10 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         deltaManager.on("cancelEstablishingConnection", (reason) => {
             this.connectionStateHandler.cancelEstablishingConnection(reason);
         });
-        deltaManager.on("disconnect", (reason, error) => {
+        deltaManager.on("disconnect", (reason) => {
             this.noopHeuristic?.notifyDisconnect();
             if (!this.closed) {
-                this.connectionStateHandler.receivedDisconnectEvent(reason, error);
+                this.connectionStateHandler.receivedDisconnectEvent(reason);
             }
         });
         deltaManager.on("throttled", (warning) => {
@@ -1320,7 +1325,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             },
         }, prefetchType);
     }
-    logConnectionStateChangeTelemetry(value, oldState, reason, error) {
+    logConnectionStateChangeTelemetry(value, oldState, reason) {
         // Log actual event
         const time = common_utils_1.performance.now();
         this.connectionTransitionTimes[value] = time;
@@ -1355,7 +1360,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             from: connectionState_1.ConnectionState[oldState],
             duration,
             durationFromDisconnected,
-            reason,
+            reason: reason?.text,
             connectionInitiationReason,
             pendingClientId: this.connectionStateHandler.pendingClientId,
             clientId: this.clientId,
@@ -1369,7 +1374,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             quorumSize: this._protocolHandler?.quorum.getMembers().size,
             isDirty: this.isDirty,
             ...this._deltaManager.connectionProps,
-        }, error);
+        }, reason?.error);
         if (value === connectionState_1.ConnectionState.Connected) {
             this.firstConnection = false;
         }
@@ -1387,7 +1392,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         // Both protocol and context should not be undefined if we got so far.
         this.setContextConnectedState(state, this.readOnlyInfo.readonly ?? false);
         this.protocolHandler.setConnectionState(state, this.clientId);
-        (0, telemetry_utils_1.raiseConnectedEvent)(this.mc.logger, this, state, this.clientId, disconnectedReason);
+        (0, telemetry_utils_1.raiseConnectedEvent)(this.mc.logger, this, state, this.clientId, disconnectedReason?.text);
     }
     // back-compat: ADO #1385: Remove in the future, summary op should come through submitSummaryMessage()
     submitContainerMessage(type, contents, batch, metadata) {
@@ -1437,23 +1442,6 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
             this.savedOps.push(message);
         }
         const local = this.clientId === message.clientId;
-        // Check and report if we're getting messages from a clientId that we previously
-        // flagged should have left, or from a client that's not in the quorum but should be
-        if (message.clientId != null) {
-            const client = this.protocolHandler.quorum.getMember(message.clientId);
-            if (client === undefined && message.type !== protocol_definitions_1.MessageType.ClientJoin) {
-                // pre-0.58 error message: messageClientIdMissingFromQuorum
-                throw new Error("Remote message's clientId is missing from the quorum");
-            }
-            // Here checking canBeCoalescedByService is used as an approximation of "is benign to process despite being unexpected".
-            // It's still not good to see these messages from unexpected clientIds, but since they don't harm the integrity of the
-            // document we don't need to blow up aggressively.
-            if (this.clientsWhoShouldHaveLeft.has(message.clientId) &&
-                !(0, driver_utils_1.canBeCoalescedByService)(message)) {
-                // pre-0.58 error message: messageClientIdShouldHaveLeft
-                throw new Error("Remote message's clientId already should have left");
-            }
-        }
         // Allow the protocol handler to process the message
         const result = this.protocolHandler.processMessage(message, local);
         // Forward messages to the loaded runtime for processing
@@ -1541,7 +1529,7 @@ class Container extends telemetry_utils_1.EventEmitterWithErrorHandling {
         const getSpecifiedCodeDetails = () => (this.protocolHandler.quorum.get("code") ??
             this.protocolHandler.quorum.get("code2"));
         const existing = snapshot !== undefined;
-        const context = new containerContext_1.ContainerContext(this.options, this.scope, snapshot, this._loadedFromVersion, this._deltaManager, this.storageAdapter, this.protocolHandler.quorum, this.protocolHandler.audience, loader, (type, contents, batch, metadata) => this.submitContainerMessage(type, contents, batch, metadata), (summaryOp, referenceSequenceNumber) => this.submitSummaryMessage(summaryOp, referenceSequenceNumber), (batch, referenceSequenceNumber) => this.submitBatch(batch, referenceSequenceNumber), (message) => this.submitSignal(message), (error) => this.dispose(error), (error) => this.close(error), this.updateDirtyContainerState, this.getAbsoluteUrl, () => this.clientId, () => this.attachState, () => this.connected, getSpecifiedCodeDetails, this._deltaManager.clientDetails, existing, this.subLogger, pendingLocalState);
+        const context = new containerContext_1.ContainerContext(this.options, this.scope, snapshot, this._loadedFromVersion, this._deltaManager, this.storageAdapter, this.protocolHandler.quorum, this.protocolHandler.audience, loader, (type, contents, batch, metadata) => this.submitContainerMessage(type, contents, batch, metadata), (summaryOp, referenceSequenceNumber) => this.submitSummaryMessage(summaryOp, referenceSequenceNumber), (batch, referenceSequenceNumber) => this.submitBatch(batch, referenceSequenceNumber), (message) => this.submitSignal(message), (error) => this.dispose(error), (error) => this.close(error), this.updateDirtyContainerState, this.getAbsoluteUrl, () => this.resolvedUrl?.id, () => this.clientId, () => this.attachState, () => this.connected, getSpecifiedCodeDetails, this._deltaManager.clientDetails, existing, this.subLogger, pendingLocalState);
         this._runtime = await telemetry_utils_1.PerformanceEvent.timedExecAsync(this.subLogger, { eventName: "InstantiateRuntime" }, async () => runtimeFactory.instantiateRuntime(context, existing));
         this._lifecycleEvents.emit("runtimeInstantiated");
         this._loadedCodeDetails = codeDetails;