@fluidframework/container-loader 2.0.0-internal.5.3.4 → 2.0.0-internal.5.4.2

package/lib/container.js

@@ -8,9 +8,9 @@ import { v4 as uuid } from "uuid";
 import { TypedEventEmitter, assert, performance, unreachableCase, } from "@fluidframework/common-utils";
 import { AttachState, isFluidCodeDetails, } from "@fluidframework/container-definitions";
 import { GenericError, UsageError } from "@fluidframework/container-utils";
-import { readAndParse, OnlineStatus, isOnline, combineAppAndProtocolSummary, runWithRetry, isCombinedAppAndProtocolSummary, MessageType2, canBeCoalescedByService, } from "@fluidframework/driver-utils";
+import { readAndParse, OnlineStatus, isOnline, combineAppAndProtocolSummary, runWithRetry, isCombinedAppAndProtocolSummary, MessageType2, } from "@fluidframework/driver-utils";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
-import { ChildLogger, EventEmitterWithErrorHandling, PerformanceEvent, raiseConnectedEvent, TelemetryLogger, connectedEventName, normalizeError, loggerToMonitoringContext, wrapError, } from "@fluidframework/telemetry-utils";
+import { createChildLogger, EventEmitterWithErrorHandling, PerformanceEvent, raiseConnectedEvent, connectedEventName, normalizeError, createChildMonitoringContext, wrapError, formatTick, } from "@fluidframework/telemetry-utils";
 import { Audience } from "./audience";
 import { ContainerContext } from "./containerContext";
 import { ReconnectMode, getPackageName } from "./contracts";
@@ -20,7 +20,7 @@ import { pkgVersion } from "./packageVersion";
 import { ContainerStorageAdapter, getBlobContentsFromTree, getBlobContentsFromTreeWithBlobContents, } from "./containerStorageAdapter";
 import { createConnectionStateHandler } from "./connectionStateHandler";
 import { getProtocolSnapshotTree, getSnapshotTreeFromSerializedContainer } from "./utils";
-import { initQuorumValuesFromCodeDetails, getCodeDetailsFromQuorumValues } from "./quorum";
+import { initQuorumValuesFromCodeDetails } from "./quorum";
 import { NoopHeuristic } from "./noopHeuristic";
 import { ConnectionManager } from "./connectionManager";
 import { ConnectionState } from "./connectionState";
@@ -152,7 +152,6 @@ export class Container extends EventEmitterWithErrorHandling {
         this.inboundQueuePausedFromInit = true;
         this.firstConnection = true;
         this.connectionTransitionTimes = [];
-        this.messageCountAfterDisconnection = 0;
         this.attachStarted = false;
         this._dirtyContainer = false;
         this.savedOps = [];
@@ -188,7 +187,7 @@ export class Container extends EventEmitterWithErrorHandling {
         this.scope = scope;
         this.detachedBlobStorage = detachedBlobStorage;
         this.protocolHandlerBuilder =
-            protocolHandlerBuilder !== null && protocolHandlerBuilder !== void 0 ? protocolHandlerBuilder : ((...args) => new ProtocolHandler(...args, new Audience()));
+            protocolHandlerBuilder !== null && protocolHandlerBuilder !== void 0 ? protocolHandlerBuilder : ((attributes, quorumSnapshot, sendProposal) => new ProtocolHandler(attributes, quorumSnapshot, sendProposal, new 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, Object.assign(Object.assign({}, createProps), createParamOverrides));
@@ -199,42 +198,45 @@ export class Container extends EventEmitterWithErrorHandling {
         const clientType = `${interactive ? "interactive" : "noninteractive"}${type !== undefined && type !== "" ? `/${type}` : ""}`;
         // Need to use the property getter for docId because for detached flow we don't have the docId initially.
         // We assign the id later so property getter is used.
-        this.subLogger = ChildLogger.create(subLogger, undefined, {
-            all: {
-                clientType,
-                containerId: uuid(),
-                docId: () => { var _a; return (_a = this.resolvedUrl) === null || _a === void 0 ? void 0 : _a.id; },
-                containerAttachState: () => this._attachState,
-                containerLifecycleState: () => this._lifecycleState,
-                containerConnectionState: () => ConnectionState[this.connectionState],
-                serializedContainer: pendingLocalState !== undefined,
-            },
-            // we need to be judicious with our logging here to avoid generating too much data
-            // all data logged here should be broadly applicable, and not specific to a
-            // specific error or class of errors
-            error: {
-                // load information to associate errors with the specific load point
-                dmInitialSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.initialSequenceNumber; },
-                dmLastProcessedSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.lastSequenceNumber; },
-                dmLastKnownSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.lastKnownSeqNumber; },
-                containerLoadedFromVersionId: () => { var _a; return (_a = this._loadedFromVersion) === null || _a === void 0 ? void 0 : _a.id; },
-                containerLoadedFromVersionDate: () => { var _a; return (_a = this._loadedFromVersion) === null || _a === void 0 ? void 0 : _a.date; },
-                // message information to associate errors with the specific execution state
-                // dmLastMsqSeqNumber: if present, same as dmLastProcessedSeqNumber
-                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, _c, _d;
-                    return ((_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.clientId) === null
-                        ? "null"
-                        : (_d = (_c = this.deltaManager) === null || _c === void 0 ? void 0 : _c.lastMessage) === null || _d === void 0 ? void 0 : _d.clientId;
+        this.subLogger = createChildLogger({
+            logger: subLogger,
+            properties: {
+                all: {
+                    clientType,
+                    containerId: uuid(),
+                    docId: () => { var _a; return (_a = this.resolvedUrl) === null || _a === void 0 ? void 0 : _a.id; },
+                    containerAttachState: () => this._attachState,
+                    containerLifecycleState: () => this._lifecycleState,
+                    containerConnectionState: () => ConnectionState[this.connectionState],
+                    serializedContainer: pendingLocalState !== undefined,
+                },
+                // we need to be judicious with our logging here to avoid generating too much data
+                // all data logged here should be broadly applicable, and not specific to a
+                // specific error or class of errors
+                error: {
+                    // load information to associate errors with the specific load point
+                    dmInitialSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.initialSequenceNumber; },
+                    dmLastProcessedSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.lastSequenceNumber; },
+                    dmLastKnownSeqNumber: () => { var _a; return (_a = this._deltaManager) === null || _a === void 0 ? void 0 : _a.lastKnownSeqNumber; },
+                    containerLoadedFromVersionId: () => { var _a; return (_a = this._loadedFromVersion) === null || _a === void 0 ? void 0 : _a.id; },
+                    containerLoadedFromVersionDate: () => { var _a; return (_a = this._loadedFromVersion) === null || _a === void 0 ? void 0 : _a.date; },
+                    // message information to associate errors with the specific execution state
+                    // dmLastMsqSeqNumber: if present, same as dmLastProcessedSeqNumber
+                    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, _c, _d;
+                        return ((_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.clientId) === null
+                            ? "null"
+                            : (_d = (_c = this.deltaManager) === null || _c === void 0 ? void 0 : _c.lastMessage) === null || _d === void 0 ? void 0 : _d.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: () => performance.now() - this.connectionTransitionTimes[this.connectionState],
                 },
-                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: () => performance.now() - this.connectionTransitionTimes[this.connectionState],
             },
         });
         // Prefix all events in this file with container-loader
-        this.mc = loggerToMonitoringContext(ChildLogger.create(this.subLogger, "Container"));
+        this.mc = createChildMonitoringContext({ logger: this.subLogger, namespace: "Container" });
         this._deltaManager = this.createDeltaManager();
         this.connectionStateHandler = createConnectionStateHandler({
             logger: this.mc.logger,
@@ -295,8 +297,8 @@ export class Container extends EventEmitterWithErrorHandling {
             document !== null &&
             typeof document.addEventListener === "function" &&
             document.addEventListener !== null;
-        // keep track of last time page was visible for telemetry
-        if (isDomAvailable) {
+        // keep track of last time page was visible for telemetry (on interactive clients only)
+        if (isDomAvailable && interactive) {
             this.lastVisible = document.hidden ? performance.now() : undefined;
             this.visibilityEventHandler = () => {
                 if (document.hidden) {
@@ -381,10 +383,10 @@ export class Container extends EventEmitterWithErrorHandling {
         }
     }
     get closed() {
-        return (this._lifecycleState === "closing" ||
-            this._lifecycleState === "closed" ||
-            this._lifecycleState === "disposing" ||
-            this._lifecycleState === "disposed");
+        return (this._lifecycleState === "closing" || this._lifecycleState === "closed" || this.disposed);
+    }
+    get disposed() {
+        return this._lifecycleState === "disposing" || this._lifecycleState === "disposed";
     }
     get runtime() {
         if (this._runtime === undefined) {
@@ -971,8 +973,7 @@ export class Container extends EventEmitterWithErrorHandling {
         // Initialize the protocol handler
         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);
+        await this.instantiateRuntime(codeDetails, snapshot, pendingLocalState === null || pendingLocalState === void 0 ? void 0 : pendingLocalState.pendingRuntimeState);
         // replay saved ops
         if (pendingLocalState) {
             for (const message of pendingLocalState.savedOps) {
@@ -1031,7 +1032,7 @@ export class Container extends EventEmitterWithErrorHandling {
             dmLastKnownSeqNumber: this._deltaManager.lastKnownSeqNumber,
         };
     }
-    async createDetached(source) {
+    async createDetached(codeDetails) {
         const attributes = {
             sequenceNumber: detachedContainerRefSeqNumber,
             term: OnlyValidTermValue,
@@ -1039,14 +1040,13 @@ export class Container extends EventEmitterWithErrorHandling {
         };
         await this.attachDeltaManagerOpHandler(attributes);
         // Need to just seed the source data in the code quorum. Quorum itself is empty
-        const qValues = initQuorumValuesFromCodeDetails(source);
+        const qValues = initQuorumValuesFromCodeDetails(codeDetails);
         this.initializeProtocolState(attributes, {
             members: [],
             proposals: [],
             values: qValues,
         });
-        // The load context - given we seeded the quorum - will be great
-        await this.instantiateContextDetached(false);
+        await this.instantiateRuntime(codeDetails, undefined);
         this.setLoaded();
     }
     async rehydrateDetachedFromSnapshot(detachedContainerSnapshot) {
@@ -1061,14 +1061,13 @@ export class Container extends EventEmitterWithErrorHandling {
         // Initialize the protocol handler
         const baseTree = getProtocolSnapshotTree(snapshotTree);
         const qValues = await readAndParse(this.storageAdapter, baseTree.blobs.quorumValues);
-        const codeDetails = getCodeDetailsFromQuorumValues(qValues);
         this.initializeProtocolState(attributes, {
             members: [],
             proposals: [],
-            values: codeDetails !== undefined ? initQuorumValuesFromCodeDetails(codeDetails) : [],
+            values: qValues,
         });
-        await this.instantiateContextDetached(true, // existing
-        snapshotTree);
+        const codeDetails = this.getCodeDetailsFromQuorum();
+        await this.instantiateRuntime(codeDetails, snapshotTree);
         this.setLoaded();
     }
     async getDocumentAttributes(storage, tree) {
@@ -1105,7 +1104,10 @@ export class Container extends EventEmitterWithErrorHandling {
     }
     initializeProtocolState(attributes, quorumSnapshot) {
         const protocol = this.protocolHandlerBuilder(attributes, quorumSnapshot, (key, value) => this.submitMessage(MessageType.Propose, JSON.stringify({ key, value })));
-        const protocolLogger = ChildLogger.create(this.subLogger, "ProtocolHandler");
+        const protocolLogger = createChildLogger({
+            logger: this.subLogger,
+            namespace: "ProtocolHandler",
+        });
         protocol.quorum.on("error", (error) => {
             protocolLogger.sendErrorEvent(error);
         });
@@ -1199,7 +1201,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.isDirty, this.client, this._canReconnect, ChildLogger.create(this.subLogger, "ConnectionManager"), props));
+        const deltaManager = new DeltaManager(serviceProvider, createChildLogger({ logger: this.subLogger, namespace: "DeltaManager" }), () => this.activeConnection(), (props) => new ConnectionManager(serviceProvider, () => this.isDirty, this.client, this._canReconnect, createChildLogger({ logger: this.subLogger, namespace: "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();
@@ -1269,7 +1271,7 @@ export class Container extends EventEmitterWithErrorHandling {
             if (value === ConnectionState.Connected) {
                 durationFromDisconnected =
                     time - this.connectionTransitionTimes[ConnectionState.Disconnected];
-                durationFromDisconnected = TelemetryLogger.formatTick(durationFromDisconnected);
+                durationFromDisconnected = formatTick(durationFromDisconnected);
             }
             else if (value === ConnectionState.CatchingUp) {
                 // This info is of most interesting while Catching Up.
@@ -1288,7 +1290,7 @@ export class Container extends EventEmitterWithErrorHandling {
             connectionInitiationReason, pendingClientId: this.connectionStateHandler.pendingClientId, clientId: this.clientId, autoReconnect,
             opsBehind, online: OnlineStatus[isOnline()], lastVisible: this.lastVisible !== undefined
                 ? performance.now() - this.lastVisible
-                : undefined, checkpointSequenceNumber, quorumSize: (_a = this._protocolHandler) === null || _a === void 0 ? void 0 : _a.quorum.getMembers().size }, this._deltaManager.connectionProps), error);
+                : undefined, checkpointSequenceNumber, quorumSize: (_a = this._protocolHandler) === null || _a === void 0 ? void 0 : _a.quorum.getMembers().size, isDirty: this.isDirty }, this._deltaManager.connectionProps), error);
         if (value === ConnectionState.Connected) {
             this.firstConnection = false;
         }
@@ -1304,22 +1306,10 @@ export class Container extends EventEmitterWithErrorHandling {
             return;
         }
         const state = this.connectionState === ConnectionState.Connected;
-        const logOpsOnReconnect = this.connectionState === ConnectionState.Connected &&
-            !this.firstConnection &&
-            this.connectionMode === "write";
-        if (logOpsOnReconnect) {
-            this.messageCountAfterDisconnection = 0;
-        }
         // Both protocol and context should not be undefined if we got so far.
         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) {
-            this.mc.logger.sendTelemetryEvent({
-                eventName: "OpsSentOnReconnect",
-                count: this.messageCountAfterDisconnection,
-            });
-        }
     }
     // back-compat: ADO #1385: Remove in the future, summary op should come through submitSummaryMessage()
     submitContainerMessage(type, contents, batch, metadata) {
@@ -1362,7 +1352,6 @@ export class Container extends EventEmitterWithErrorHandling {
             this.mc.logger.sendErrorEvent({ eventName: "SubmitMessageWithNoConnection", type });
             return -1;
         }
-        this.messageCountAfterDisconnection += 1;
         (_a = this.noopHeuristic) === null || _a === void 0 ? void 0 : _a.notifyMessageSent();
         return this._deltaManager.submit(type, contents, batch, metadata, compression, referenceSequenceNumber);
     }
@@ -1371,23 +1360,6 @@ export class Container extends 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 !== 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) &&
-                !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
@@ -1454,14 +1426,7 @@ export class Container extends EventEmitterWithErrorHandling {
         }
         return { snapshot, versionId: version === null || version === void 0 ? void 0 : version.id };
     }
-    async instantiateContextDetached(existing, snapshot) {
-        const codeDetails = this.getCodeDetailsFromQuorum();
-        if (codeDetails === undefined) {
-            throw new Error("pkg should be provided in create flow!!");
-        }
-        await this.instantiateContext(existing, codeDetails, snapshot);
-    }
-    async instantiateContext(existing, codeDetails, snapshot, pendingLocalState) {
+    async instantiateRuntime(codeDetails, snapshot, pendingLocalState) {
         var _a, _b;
         assert(((_a = this._runtime) === null || _a === void 0 ? void 0 : _a.disposed) !== false, 0x0dd /* "Existing runtime not disposed" */);
         // The relative loader will proxy requests to '/' to the loader itself assuming no non-cache flags
@@ -1485,6 +1450,7 @@ export class Container extends EventEmitterWithErrorHandling {
             var _a;
             return ((_a = this.protocolHandler.quorum.get("code")) !== null && _a !== void 0 ? _a : this.protocolHandler.quorum.get("code2"));
         };
+        const existing = snapshot !== undefined;
         const context = new 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, () => { var _a; return (_a = this.resolvedUrl) === null || _a === void 0 ? void 0 : _a.id; }, () => this.clientId, () => this._deltaManager.serviceConfiguration, () => this.attachState, () => this.connected, getSpecifiedCodeDetails, this._deltaManager.clientDetails, existing, this.subLogger, pendingLocalState);
         this._lifecycleEvents.once("disposed", () => {
             context.dispose();
@@ -1492,7 +1458,6 @@ export class Container extends EventEmitterWithErrorHandling {
         this._runtime = await PerformanceEvent.timedExecAsync(this.subLogger, { eventName: "InstantiateRuntime" }, async () => runtimeFactory.instantiateRuntime(context, existing));
         this._lifecycleEvents.emit("runtimeInstantiated");
         this._loadedCodeDetails = codeDetails;
-        this.emit("contextChanged", codeDetails);
     }
     /**
      * Set the connected state of the ContainerContext