@fluidframework/container-runtime 0.49.2 → 0.50.1

package/lib/containerRuntime.js

@@ -29,6 +29,7 @@ import { getLocalStorageFeatureGate } from "./localStorageFeatureGates";
 import { OrderedClientCollection, OrderedClientElection } from "./orderedClientElection";
 import { SummarizerClientElection, summarizerClientType } from "./summarizerClientElection";
 import { formExponentialFn, Throttler } from "./throttler";
+import { RunWhileConnectedCoordinator } from "./runWhileConnectedCoordinator";
 export var ContainerMessageType;
 (function (ContainerMessageType) {
     // An op to be delivered to store
@@ -291,6 +292,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 this.closeFn(normalizeError(error));
             });
         };
+        // @deprecated Needs to become private
         this.raiseContainerWarning = (warning) => {
             this.context.raiseContainerWarning(warning);
         };
@@ -384,40 +386,45 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
         });
         this.summaryCollection = new SummaryCollection(this.deltaManager, this.logger);
-        const maxOpsSinceLastSummary = (_d = this.runtimeOptions.summaryOptions.maxOpsSinceLastSummary) !== null && _d !== void 0 ? _d : 7000;
-        const defaultAction = () => {
-            if (this.summaryCollection.opsSinceLastAck > maxOpsSinceLastSummary) {
-                this.logger.sendErrorEvent({ eventName: "SummaryStatus:Behind" });
-                // unregister default to no log on every op after falling behind
-                // and register summary ack handler to re-register this handler
-                // after successful summary
-                this.summaryCollection.once(MessageType.SummaryAck, () => {
-                    this.logger.sendTelemetryEvent({ eventName: "SummaryStatus:CaughtUp" });
-                    // we've caught up, so re-register the default action to monitor for
-                    // falling behind, and unregister ourself
-                    this.summaryCollection.on("default", defaultAction);
-                });
-                this.summaryCollection.off("default", defaultAction);
-            }
-        };
-        this.summaryCollection.on("default", defaultAction);
-        const orderedClientLogger = ChildLogger.create(this.logger, "OrderedClientElection");
-        const orderedClientCollection = new OrderedClientCollection(orderedClientLogger, this.context.deltaManager, this.context.quorum);
-        const orderedClientElectionForSummarizer = new OrderedClientElection(orderedClientLogger, orderedClientCollection, electedSummarizerData !== null && electedSummarizerData !== void 0 ? electedSummarizerData : this.context.deltaManager.lastSequenceNumber, SummarizerClientElection.isClientEligible);
-        const summarizerClientElectionEnabled = (_e = getLocalStorageFeatureGate("summarizerClientElection")) !== null && _e !== void 0 ? _e : ((_f = this.runtimeOptions.summaryOptions) === null || _f === void 0 ? void 0 : _f.summarizerClientElection) === true;
-        this.summarizerClientElection = new SummarizerClientElection(orderedClientLogger, this.summaryCollection, orderedClientElectionForSummarizer, maxOpsSinceLastSummary, summarizerClientElectionEnabled);
         // Only create a SummaryManager if summaries are enabled and we are not the summarizer client
         if (this.runtimeOptions.summaryOptions.generateSummaries === false) {
             this._logger.sendTelemetryEvent({ eventName: "SummariesDisabled" });
         }
         else {
+            const maxOpsSinceLastSummary = (_d = this.runtimeOptions.summaryOptions.maxOpsSinceLastSummary) !== null && _d !== void 0 ? _d : 7000;
+            const defaultAction = () => {
+                if (this.summaryCollection.opsSinceLastAck > maxOpsSinceLastSummary) {
+                    this.logger.sendErrorEvent({ eventName: "SummaryStatus:Behind" });
+                    // unregister default to no log on every op after falling behind
+                    // and register summary ack handler to re-register this handler
+                    // after successful summary
+                    this.summaryCollection.once(MessageType.SummaryAck, () => {
+                        this.logger.sendTelemetryEvent({ eventName: "SummaryStatus:CaughtUp" });
+                        // we've caught up, so re-register the default action to monitor for
+                        // falling behind, and unregister ourself
+                        this.summaryCollection.on("default", defaultAction);
+                    });
+                    this.summaryCollection.off("default", defaultAction);
+                }
+            };
+            this.summaryCollection.on("default", defaultAction);
+            const orderedClientLogger = ChildLogger.create(this.logger, "OrderedClientElection");
+            const orderedClientCollection = new OrderedClientCollection(orderedClientLogger, this.context.deltaManager, this.context.quorum);
+            const orderedClientElectionForSummarizer = new OrderedClientElection(orderedClientLogger, orderedClientCollection, electedSummarizerData !== null && electedSummarizerData !== void 0 ? electedSummarizerData : this.context.deltaManager.lastSequenceNumber, SummarizerClientElection.isClientEligible);
+            const summarizerClientElectionEnabled = (_e = getLocalStorageFeatureGate("summarizerClientElection")) !== null && _e !== void 0 ? _e : ((_f = this.runtimeOptions.summaryOptions) === null || _f === void 0 ? void 0 : _f.summarizerClientElection) === true;
+            this.summarizerClientElection = new SummarizerClientElection(orderedClientLogger, this.summaryCollection, orderedClientElectionForSummarizer, maxOpsSinceLastSummary, summarizerClientElectionEnabled);
             if (this.context.clientDetails.type === summarizerClientType) {
-                this._summarizer = new Summarizer("/_summarizer", this /* ISummarizerRuntime */, () => this.summaryConfiguration, this /* ISummarizerInternalsProvider */, this.IFluidHandleContext, this.summaryCollection);
+                this._summarizer = new Summarizer("/_summarizer", this /* ISummarizerRuntime */, () => this.summaryConfiguration, this /* ISummarizerInternalsProvider */, this.IFluidHandleContext, this.summaryCollection, async (runtime) => RunWhileConnectedCoordinator.create(runtime));
             }
             else if (SummarizerClientElection.clientDetailsPermitElection(this.context.clientDetails)) {
                 // Create the SummaryManager and mark the initial state
+                const requestOptions = {
+                    cache: false,
+                    reconnect: false,
+                    summarizingClient: true,
+                };
                 this.summaryManager = new SummaryManager(this.summarizerClientElection, this, // IConnectedState
-                this.summaryCollection, this.logger, formRequestSummarizerFn(this.context.loader, this.context.deltaManager), new Throttler(60 * 1000, // 60 sec delay window
+                this.summaryCollection, this.logger, formRequestSummarizerFn(this.context.loader, this.context.deltaManager.lastSequenceNumber, requestOptions), new Throttler(60 * 1000, // 60 sec delay window
                 30 * 1000, // 30 sec max delay
                 // throttling function increases exponentially (0ms, 40ms, 80ms, 160ms, etc)
                 formExponentialFn({ coefficient: 20, initialDelay: 0 })), {
@@ -592,7 +599,8 @@ export class ContainerRuntime extends TypedEventEmitter {
     }
     /** clientId of parent (non-summarizing) container that owns summarizer container */
     get summarizerClientId() {
-        return this.summarizerClientElection.electedClientId;
+        var _a;
+        return (_a = this.summarizerClientElection) === null || _a === void 0 ? void 0 : _a.electedClientId;
     }
     get summaryConfiguration() {
         var _a, _b, _c;
@@ -790,6 +798,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         return root;
     }
     addContainerBlobsToSummary(summaryTree) {
+        var _a;
         if (this.shouldWriteMetadata) {
             addBlobToSummary(summaryTree, metadataBlobName, JSON.stringify(this.formMetadata()));
         }
@@ -797,8 +806,10 @@ export class ContainerRuntime extends TypedEventEmitter {
             const content = JSON.stringify([...this.chunkMap]);
             addBlobToSummary(summaryTree, chunksBlobName, content);
         }
-        const electedSummarizerContent = JSON.stringify(this.summarizerClientElection.serialize());
-        addBlobToSummary(summaryTree, electedSummarizerBlobName, electedSummarizerContent);
+        if (this.summarizerClientElection) {
+            const electedSummarizerContent = JSON.stringify((_a = this.summarizerClientElection) === null || _a === void 0 ? void 0 : _a.serialize());
+            addBlobToSummary(summaryTree, electedSummarizerBlobName, electedSummarizerContent);
+        }
         const snapshot = this.blobManager.snapshot();
         // Some storage (like git) doesn't allow empty tree, so we can omit it.
         // and the blob manager can handle the tree not existing when loading
@@ -1007,7 +1018,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     }
     async createRootDataStore(pkg, rootDataStoreId) {
         const fluidDataStore = await this._createDataStore(pkg, true /* isRoot */, rootDataStoreId);
-        fluidDataStore.bindToContext();
+        fluidDataStore.attachGraph();
         return fluidDataStore;
     }
     createDetachedRootDataStore(pkg, rootDataStoreId) {
@@ -1017,7 +1028,11 @@ export class ContainerRuntime extends TypedEventEmitter {
         return this.dataStores.createDetachedDataStoreCore(pkg, false);
     }
     async _createDataStoreWithProps(pkg, props, id = uuid(), isRoot = false) {
-        return this.dataStores._createFluidDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], id, isRoot, props).realize();
+        const fluidDataStore = await this.dataStores._createFluidDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], id, isRoot, props).realize();
+        if (isRoot) {
+            fluidDataStore.attachGraph();
+        }
+        return fluidDataStore;
     }
     async _createDataStore(pkg, isRoot, id = uuid()) {
         return this.dataStores._createFluidDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], id, isRoot).realize();
@@ -1116,39 +1131,33 @@ export class ContainerRuntime extends TypedEventEmitter {
         return PerformanceEvent.timedExecAsync(logger, { eventName: "GarbageCollection" }, async (event) => {
             var _a;
             const gcStats = {};
-            try {
-                // Get the container's GC data and run GC on the reference graph in it.
-                const gcData = await this.dataStores.getGCData(fullGC);
-                const { referencedNodeIds, deletedNodeIds } = runGarbageCollection(gcData.gcNodes, ["/"], this.logger);
-                // Update our summarizer node's used routes. Updating used routes in summarizer node before
-                // summarizing is required and asserted by the the summarizer node. We are the root and are
-                // always referenced, so the used routes is only self-route (empty string).
-                this.summarizerNode.updateUsedRoutes([""]);
-                // Remove this node's route ("/") and notify data stores of routes that are used in it.
-                const usedRoutes = referencedNodeIds.filter((id) => { return id !== "/"; });
-                const { dataStoreCount, unusedDataStoreCount } = this.dataStores.updateUsedRoutes(usedRoutes, (_a = 
-                // For now, we use the timestamp of the last op for gcTimestamp. However, there can be cases where
-                // we don't have an op (on demand summaries for instance). In those cases, we will use the timestamp
-                // of this client's connection - https://github.com/microsoft/FluidFramework/issues/7152.
-                this.deltaManager.lastMessage) === null || _a === void 0 ? void 0 : _a.timestamp);
-                // Update stats to be reported in the peformance event.
-                gcStats.deletedNodes = deletedNodeIds.length;
-                gcStats.totalNodes = referencedNodeIds.length + deletedNodeIds.length;
-                gcStats.deletedDataStores = unusedDataStoreCount;
-                gcStats.totalDataStores = dataStoreCount;
-                // If we are running in GC test mode, delete objects for unused routes. This enables testing scenarios
-                // involving access to deleted data.
-                if (this.gcTestMode) {
-                    this.dataStores.deleteUnusedRoutes(deletedNodeIds);
-                }
-            }
-            catch (error) {
-                event.cancel(gcStats, error);
-                throw error;
+            // Get the container's GC data and run GC on the reference graph in it.
+            const gcData = await this.dataStores.getGCData(fullGC);
+            const { referencedNodeIds, deletedNodeIds } = runGarbageCollection(gcData.gcNodes, ["/"], this.logger);
+            // Update our summarizer node's used routes. Updating used routes in summarizer node before
+            // summarizing is required and asserted by the the summarizer node. We are the root and are
+            // always referenced, so the used routes is only self-route (empty string).
+            this.summarizerNode.updateUsedRoutes([""]);
+            // Remove this node's route ("/") and notify data stores of routes that are used in it.
+            const usedRoutes = referencedNodeIds.filter((id) => { return id !== "/"; });
+            const { dataStoreCount, unusedDataStoreCount } = this.dataStores.updateUsedRoutes(usedRoutes, (_a = 
+            // For now, we use the timestamp of the last op for gcTimestamp. However, there can be cases where
+            // we don't have an op (on demand summaries for instance). In those cases, we will use the timestamp
+            // of this client's connection - https://github.com/microsoft/FluidFramework/issues/7152.
+            this.deltaManager.lastMessage) === null || _a === void 0 ? void 0 : _a.timestamp);
+            // Update stats to be reported in the peformance event.
+            gcStats.deletedNodes = deletedNodeIds.length;
+            gcStats.totalNodes = referencedNodeIds.length + deletedNodeIds.length;
+            gcStats.deletedDataStores = unusedDataStoreCount;
+            gcStats.totalDataStores = dataStoreCount;
+            // If we are running in GC test mode, delete objects for unused routes. This enables testing scenarios
+            // involving access to deleted data.
+            if (this.gcTestMode) {
+                this.dataStores.deleteUnusedRoutes(deletedNodeIds);
             }
             event.end(gcStats);
             return gcStats;
-        });
+        }, { end: true, cancel: "error" });
     }
     async summarizeInternal(fullTree, trackState) {
         const summarizeResult = await this.dataStores.summarize(fullTree, trackState);
@@ -1544,10 +1553,8 @@ export class ContainerRuntime extends TypedEventEmitter {
         }
     }
     async fetchSnapshotFromStorage(versionId, logger, event) {
-        const perfEvent = PerformanceEvent.start(logger, event);
-        const stats = {};
-        let snapshot;
-        try {
+        return PerformanceEvent.timedExecAsync(logger, event, async (perfEvent) => {
+            const stats = {};
             const trace = Trace.start();
             const versions = await this.storage.getVersions(versionId, 1);
             assert(!!versions && !!versions[0], 0x137 /* "Failed to get version from storage" */);
@@ -1555,14 +1562,9 @@ export class ContainerRuntime extends TypedEventEmitter {
             const maybeSnapshot = await this.storage.getSnapshotTree(versions[0]);
             assert(!!maybeSnapshot, 0x138 /* "Failed to get snapshot from storage" */);
             stats.getSnapshotDuration = trace.trace().duration;
-            snapshot = maybeSnapshot;
-        }
-        catch (error) {
-            perfEvent.cancel(stats, error);
-            throw error;
-        }
-        perfEvent.end(stats);
-        return snapshot;
+            perfEvent.end(stats);
+            return maybeSnapshot;
+        });
     }
     getPendingLocalState() {
         return this.pendingStateManager.getLocalState();