@fluidframework/container-loader 1.2.2 → 2.0.0-internal.1.0.0.82159

package/lib/container.js

@@ -9,7 +9,6 @@ import { assert, performance, unreachableCase } from "@fluidframework/common-uti
 import { AttachState, isFluidCodeDetails, } from "@fluidframework/container-definitions";
 import { DataCorruptionError, extractSafePropertiesFromMessage, GenericError, UsageError, } from "@fluidframework/container-utils";
 import { readAndParse, OnlineStatus, isOnline, ensureFluidResolvedUrl, combineAppAndProtocolSummary, runWithRetry, isFluidResolvedUrl, isRuntimeMessage, isUnpackedRuntimeMessage, } from "@fluidframework/driver-utils";
-import { ProtocolOpHandlerWithClientValidation, } from "@fluidframework/protocol-base";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
 import { ChildLogger, EventEmitterWithErrorHandling, PerformanceEvent, raiseConnectedEvent, TelemetryLogger, connectedEventName, disconnectedEventName, normalizeError, loggerToMonitoringContext, wrapError, } from "@fluidframework/telemetry-utils";
 import { Audience } from "./audience";
@@ -28,6 +27,7 @@ import { initQuorumValuesFromCodeDetails, getCodeDetailsFromQuorumValues, Quorum
 import { CollabWindowTracker } from "./collabWindowTracker";
 import { ConnectionManager } from "./connectionManager";
 import { ConnectionState } from "./connectionState";
+import { ProtocolHandler, } from "./protocol";
 const detachedContainerRefSeqNumber = 0;
 const dirtyContainerEvent = "dirty";
 const savedContainerEvent = "saved";
@@ -57,6 +57,10 @@ export async function waitContainerToCatchUp(container) {
                 : new GenericError(baseMessage));
         };
         container.on("closed", closedCallback);
+        // Depending on config, transition to "connected" state may include the guarantee
+        // that all known ops have been processed.  If so, we may introduce additional wait here.
+        // 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 = () => {
             assert(container.connectionState === ConnectionState.CatchingUp
                 || container.connectionState === ConnectionState.Connected, 0x0cd /* "Container disconnected while waiting for ops!" */);
@@ -98,9 +102,22 @@ export async function waitContainerToCatchUp(container) {
 const getCodeProposal = 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-return
 (quorum) => { var _a; return (_a = quorum.get("code")) !== null && _a !== void 0 ? _a : quorum.get("code2"); };
+/**
+ * Helper function to report to telemetry cases where operation takes longer than expected (1s)
+ * @param logger - logger to use
+ * @param eventName - event name
+ * @param action - functor to call and measure
+ */
+async function ReportIfTooLong(logger, eventName, action) {
+    const event = PerformanceEvent.start(logger, { eventName });
+    const props = await action();
+    if (event.duration > 1000) {
+        event.end(props);
+    }
+}
 const summarizerClientType = "summarizer";
 export class Container extends EventEmitterWithErrorHandling {
-    constructor(loader, config) {
+    constructor(loader, config, protocolHandlerBuilder) {
         var _a, _b;
         super((name, error) => {
             this.mc.logger.sendErrorEvent({
@@ -109,6 +126,7 @@ export class Container extends EventEmitterWithErrorHandling {
             }, error);
         });
         this.loader = loader;
+        this.protocolHandlerBuilder = protocolHandlerBuilder;
         // Tells if container can reconnect on losing fist connection
         // If false, container gets closed on loss of connection.
         this._canReconnect = true;
@@ -122,7 +140,6 @@ export class Container extends EventEmitterWithErrorHandling {
         this.attachStarted = false;
         this._dirtyContainer = false;
         this.setAutoReconnectTime = performance.now();
-        this._audience = new Audience();
         this.clientDetailsOverride = config.clientDetailsOverride;
         this._resolvedUrl = config.resolvedUrl;
         if (config.canReconnect !== undefined) {
@@ -142,6 +159,7 @@ export class Container extends EventEmitterWithErrorHandling {
                 containerAttachState: () => this._attachState,
                 containerLifecycleState: () => this._lifecycleState,
                 containerConnectionState: () => ConnectionState[this.connectionState],
+                serializedContainer: config.serializedContainerState !== 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
@@ -154,6 +172,7 @@ export class Container extends EventEmitterWithErrorHandling {
                 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; return (_b = (_a = this.deltaManager) === null || _a === void 0 ? void 0 : _a.lastMessage) === null || _b === void 0 ? void 0 : _b.clientId; },
@@ -253,13 +272,13 @@ export class Container extends EventEmitterWithErrorHandling {
     /**
      * Load an existing container.
      */
-    static async load(loader, loadOptions, pendingLocalState) {
+    static async load(loader, loadOptions, pendingLocalState, protocolHandlerBuilder) {
         const container = new Container(loader, {
             clientDetailsOverride: loadOptions.clientDetailsOverride,
             resolvedUrl: loadOptions.resolvedUrl,
             canReconnect: loadOptions.canReconnect,
             serializedContainerState: pendingLocalState,
-        });
+        }, protocolHandlerBuilder);
         return PerformanceEvent.timedExecAsync(container.mc.logger, { eventName: "Load" }, async (event) => new Promise((resolve, reject) => {
             var _a, _b;
             const version = loadOptions.version;
@@ -293,8 +312,8 @@ export class Container extends EventEmitterWithErrorHandling {
     /**
      * Create a new container in a detached state.
      */
-    static async createDetached(loader, codeDetails) {
-        const container = new Container(loader, {});
+    static async createDetached(loader, codeDetails, protocolHandlerBuilder) {
+        const container = new Container(loader, {}, protocolHandlerBuilder);
         return PerformanceEvent.timedExecAsync(container.mc.logger, { eventName: "CreateDetached" }, async (_event) => {
             await container.createDetached(codeDetails);
             return container;
@@ -304,8 +323,8 @@ export class Container extends EventEmitterWithErrorHandling {
      * Create a new container in a detached state that is initialized with a
      * snapshot from a previous detached container.
      */
-    static async rehydrateDetachedFromSnapshot(loader, snapshot) {
-        const container = new Container(loader, {});
+    static async rehydrateDetachedFromSnapshot(loader, snapshot, protocolHandlerBuilder) {
+        const container = new Container(loader, {}, protocolHandlerBuilder);
         return PerformanceEvent.timedExecAsync(container.mc.logger, { eventName: "RehydrateDetachedFromSnapshot" }, async (_event) => {
             const deserializedSummary = JSON.parse(snapshot);
             await container.rehydrateDetachedFromSnapshot(deserializedSummary);
@@ -418,12 +437,12 @@ export class Container extends EventEmitterWithErrorHandling {
      * Retrieves the audience associated with the document
      */
     get audience() {
-        return this._audience;
+        return this.protocolHandler.audience;
     }
     /**
      * Returns true if container is dirty.
      * Which means data loss if container is closed at that same moment
-     * Most likely that happens when there is no network connection to ordering service
+     * Most likely that happens when there is no network connection to Relay Service
      */
     get isDirty() {
         return this._dirtyContainer;
@@ -489,7 +508,7 @@ export class Container extends EventEmitterWithErrorHandling {
         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, 0x30b /* Must have a valid protocol handler instance */);
+        assert(this._protocolHandler.attributes.term !== undefined, "Must have a valid protocol handler instance");
         const pendingState = {
             pendingRuntimeState: this.context.getPendingLocalState(),
             url: this.resolvedUrl.url,
@@ -788,20 +807,21 @@ export class Container extends EventEmitterWithErrorHandling {
         // ...load in the existing quorum
         // Initialize the protocol handler
         this._protocolHandler = pendingLocalState === undefined
-            ? await this.initializeProtocolStateFromSnapshot(attributes, this.storageService, snapshot)
-            : await this.initializeProtocolState(attributes, pendingLocalState.protocol.members, pendingLocalState.protocol.proposals, pendingLocalState.protocol.values);
+            ? await this.initializeProtocolStateFromSnapshot(attributes, this.storageService, snapshot) : await this.initializeProtocolState(attributes, {
+            members: pendingLocalState.protocol.members,
+            proposals: pendingLocalState.protocol.proposals,
+            values: pendingLocalState.protocol.values,
+        });
         const codeDetails = this.getCodeDetailsFromQuorum();
         await this.instantiateContext(true, // existing
         codeDetails, snapshot, pendingLocalState === null || pendingLocalState === void 0 ? void 0 : pendingLocalState.pendingRuntimeState);
-        // Internal context is fully loaded at this point
-        this.setLoaded();
         // 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) {
             if (opsBeforeReturnP !== undefined) {
                 this._deltaManager.inbound.resume();
-                await opsBeforeReturnP;
-                await this._deltaManager.inbound.waitTillProcessingDone();
+                await ReportIfTooLong(this.mc.logger, "WaitOps", async () => { await opsBeforeReturnP; return {}; });
+                await ReportIfTooLong(this.mc.logger, "WaitOpProcessing", async () => this._deltaManager.inbound.waitTillProcessingDone());
                 // eslint-disable-next-line @typescript-eslint/no-floating-promises
                 this._deltaManager.inbound.pause();
             }
@@ -827,9 +847,13 @@ export class Container extends EventEmitterWithErrorHandling {
         if (this.closed) {
             throw new Error("Container was closed while load()");
         }
+        // Internal context is fully loaded at this point
+        this.setLoaded();
         return {
             sequenceNumber: attributes.sequenceNumber,
             version: versionId,
+            dmLastProcessedSeqNumber: this._deltaManager.lastSequenceNumber,
+            dmLastKnownSeqNumber: this._deltaManager.lastKnownSeqNumber,
         };
     }
     async createDetached(source) {
@@ -841,9 +865,11 @@ 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);
-        this._protocolHandler = await this.initializeProtocolState(attributes, [], // members
-        [], // proposals
-        qValues);
+        this._protocolHandler = await this.initializeProtocolState(attributes, {
+            members: [],
+            proposals: [],
+            values: qValues,
+        });
         // The load context - given we seeded the quorum - will be great
         await this.instantiateContextDetached(false);
         this.setLoaded();
@@ -862,9 +888,11 @@ export class Container extends EventEmitterWithErrorHandling {
         const qValues = await readAndParse(this._storage, baseTree.blobs.quorumValues);
         const codeDetails = getCodeDetailsFromQuorumValues(qValues);
         this._protocolHandler =
-            await this.initializeProtocolState(attributes, [], // members
-            [], // proposals
-            codeDetails !== undefined ? initQuorumValuesFromCodeDetails(codeDetails) : []);
+            await this.initializeProtocolState(attributes, {
+                members: [],
+                proposals: [],
+                values: codeDetails !== undefined ? initQuorumValuesFromCodeDetails(codeDetails) : [],
+            });
         await this.instantiateContextDetached(true, // existing
         snapshotTree);
         this.setLoaded();
@@ -906,22 +934,27 @@ export class Container extends EventEmitterWithErrorHandling {
         return attributes;
     }
     async initializeProtocolStateFromSnapshot(attributes, storage, snapshot) {
-        let members = [];
-        let proposals = [];
-        let values = [];
+        const quorumSnapshot = {
+            members: [],
+            proposals: [],
+            values: [],
+        };
         if (snapshot !== undefined) {
             const baseTree = getProtocolSnapshotTree(snapshot);
-            [members, proposals, values] = await Promise.all([
+            [quorumSnapshot.members, quorumSnapshot.proposals, quorumSnapshot.values] = await Promise.all([
                 readAndParse(storage, baseTree.blobs.quorumMembers),
                 readAndParse(storage, baseTree.blobs.quorumProposals),
                 readAndParse(storage, baseTree.blobs.quorumValues),
             ]);
         }
-        const protocolHandler = await this.initializeProtocolState(attributes, members, proposals, values);
+        const protocolHandler = await this.initializeProtocolState(attributes, quorumSnapshot);
         return protocolHandler;
     }
-    async initializeProtocolState(attributes, members, proposals, values) {
-        const protocol = new ProtocolOpHandlerWithClientValidation(attributes.minimumSequenceNumber, attributes.sequenceNumber, attributes.term, members, proposals, values, (key, value) => this.submitMessage(MessageType.Propose, { key, value }));
+    async initializeProtocolState(attributes, quorumSnapshot) {
+        var _a, _b;
+        const protocolHandlerBuilder = (_a = this.protocolHandlerBuilder) !== null && _a !== void 0 ? _a : ((...args) => new ProtocolHandler(...args, new Audience()));
+        const protocol = protocolHandlerBuilder(attributes, quorumSnapshot, (key, value) => this.submitMessage(MessageType.Propose, { key, value }), (_b = this._initialClients) !== null && _b !== void 0 ? _b : []);
+        this._initialClients = undefined;
         const protocolLogger = ChildLogger.create(this.subLogger, "ProtocolHandler");
         protocol.quorum.on("error", (error) => {
             protocolLogger.sendErrorEvent(error);
@@ -1015,14 +1048,25 @@ export class Container extends EventEmitterWithErrorHandling {
         deltaManager.inbound.pause();
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         deltaManager.inboundSignal.pause();
-        deltaManager.on("connect", (details, opsBehind) => {
+        deltaManager.on("connect", (details, _opsBehind) => {
             var _a;
-            // Back-compat for new client and old server.
-            this._audience.clear();
-            for (const priorClient of (_a = details.initialClients) !== null && _a !== void 0 ? _a : []) {
-                this._audience.addMember(priorClient.clientId, priorClient.client);
+            if (this._protocolHandler === undefined) {
+                // Store the initial clients so that they can be submitted to the
+                // protocol handler when it is created.
+                this._initialClients = details.initialClients;
             }
-            this.connectionStateHandler.receivedConnectEvent(this.connectionMode, details);
+            else {
+                // When reconnecting, the protocol handler is already created,
+                // so we can update the audience right now.
+                this._protocolHandler.audience.clear();
+                for (const priorClient of (_a = details.initialClients) !== null && _a !== void 0 ? _a : []) {
+                    this._protocolHandler.audience.addMember(priorClient.clientId, priorClient.client);
+                }
+            }
+            const deltaManagerForCatchingUp = this.mc.config.getBoolean("Fluid.Container.CatchUpBeforeDeclaringConnected") === true ?
+                this.deltaManager
+                : undefined;
+            this.connectionStateHandler.receivedConnectEvent(this.connectionMode, details, deltaManagerForCatchingUp);
         });
         deltaManager.on("disconnect", (reason) => {
             var _a;
@@ -1194,15 +1238,7 @@ export class Container extends EventEmitterWithErrorHandling {
     processSignal(message) {
         // No clientId indicates a system signal message.
         if (message.clientId === null) {
-            const innerContent = message.content;
-            if (innerContent.type === MessageType.ClientJoin) {
-                const newClient = innerContent.content;
-                this._audience.addMember(newClient.clientId, newClient.client);
-            }
-            else if (innerContent.type === MessageType.ClientLeave) {
-                const leftClientId = innerContent.content;
-                this._audience.removeMember(leftClientId);
-            }
+            this.protocolHandler.processSignal(message);
         }
         else {
             const local = this.clientId === message.clientId;