@fluidframework/container-runtime 0.58.2002 → 0.58.3000-61081

package/lib/containerRuntime.js

@@ -6,7 +6,7 @@ import { readAndParse, BlobAggregationStorage } from "@fluidframework/driver-uti
 import { DataCorruptionError, GenericError, UsageError, extractSafePropertiesFromMessage, } from "@fluidframework/container-utils";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
 import { FlushMode, channelsTreeName, } from "@fluidframework/runtime-definitions";
-import { addBlobToSummary, addTreeToSummary, convertToSummaryTree, createRootSummarizerNodeWithGC, RequestParser, create404Response, exceptionToResponse, requestFluidObject, responseToException, seqFromTree, } from "@fluidframework/runtime-utils";
+import { addBlobToSummary, addTreeToSummary, createRootSummarizerNodeWithGC, RequestParser, create404Response, exceptionToResponse, requestFluidObject, responseToException, seqFromTree, calculateStats, } from "@fluidframework/runtime-utils";
 import { v4 as uuid } from "uuid";
 import { ContainerFluidHandleContext } from "./containerHandleContext";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry";
@@ -27,6 +27,7 @@ import { RunWhileConnectedCoordinator } from "./runWhileConnectedCoordinator";
 import { GarbageCollector, gcTreeKey, } from "./garbageCollection";
 import { channelToDataStore, isDataStoreAliasMessage, } from "./dataStore";
 import { BindBatchTracker } from "./batchTracker";
+import { OpTracker } from "./opTelemetry";
 export var ContainerMessageType;
 (function (ContainerMessageType) {
     // An op to be delivered to store
@@ -79,6 +80,11 @@ const maxOpSizeInBytesKey = "Fluid.ContainerRuntime.MaxOpSizeInBytes";
 // in order to account for some extra overhead from serialization
 // to not reach the 1MB limits in socket.io and Kafka.
 const defaultMaxOpSizeInBytes = 768000;
+// By default, the size of the contents for the incoming ops is tracked.
+// However, in certain situations, this may incur a performance hit.
+// The feature-gate below can be used to disable this feature.
+const disableOpTrackingKey = "Fluid.ContainerRuntime.DisableOpTracking";
+const defaultFlushMode = FlushMode.TurnBased;
 export var RuntimeMessage;
 (function (RuntimeMessage) {
     RuntimeMessage["FluidDataStoreOp"] = "component";
@@ -127,6 +133,7 @@ class ScheduleManagerCore {
         this.logger = logger;
         this.localPaused = false;
         this.timePaused = 0;
+        this.batchCount = 0;
         // Listen for delta manager sends and add batch metadata to messages
         this.deltaManager.on("prepareSend", (messages) => {
             if (messages.length === 0) {
@@ -193,13 +200,26 @@ class ScheduleManagerCore {
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         this.deltaManager.inbound.pause();
     }
-    resumeQueue(startBatch, endBatch) {
+    resumeQueue(startBatch, messageEndBatch) {
+        const endBatch = messageEndBatch.sequenceNumber;
+        const duration = performance.now() - this.timePaused;
+        this.batchCount++;
+        if (this.batchCount % 1000 === 1) {
+            this.logger.sendTelemetryEvent({
+                eventName: "BatchStats",
+                sequenceNumber: endBatch,
+                length: endBatch - startBatch + 1,
+                msnDistance: endBatch - messageEndBatch.minimumSequenceNumber,
+                duration,
+                batchCount: this.batchCount,
+                interrupted: this.localPaused,
+            });
+        }
         // Return early if no change in value
         if (!this.localPaused) {
             return;
         }
         this.localPaused = false;
-        const duration = performance.now() - this.timePaused;
         // Random round number - we want to know when batch waiting paused op processing.
         if (duration > latencyThreshold) {
             this.logger.sendErrorEvent({
@@ -260,7 +280,7 @@ class ScheduleManagerCore {
         else if (batchMetadata === false) {
             assert(this.pauseSequenceNumber !== undefined, 0x2a0 /* "batch presence was validated above" */);
             // Batch is complete, we can process it!
-            this.resumeQueue(this.pauseSequenceNumber, message.sequenceNumber);
+            this.resumeQueue(this.pauseSequenceNumber, message);
             this.pauseSequenceNumber = undefined;
             this.currentBatchClientId = undefined;
         }
@@ -363,7 +383,6 @@ export class ContainerRuntime extends TypedEventEmitter {
         this._storage = _storage;
         this.defaultMaxConsecutiveReconnects = 15;
         this._orderSequentiallyCalls = 0;
-        this._flushMode = FlushMode.TurnBased;
         this.needsFlush = false;
         this.flushTrigger = false;
         this.paused = false;
@@ -446,6 +465,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 ((_c = runtimeOptions.useDataStoreAliasing) !== null && _c !== void 0 ? _c : false);
         this._maxOpSizeInBytes = ((_d = this.mc.config.getNumber(maxOpSizeInBytesKey)) !== null && _d !== void 0 ? _d : defaultMaxOpSizeInBytes);
         this.maxConsecutiveReconnects = (_e = this.mc.config.getNumber(maxConsecutiveReconnectsKey)) !== null && _e !== void 0 ? _e : this.defaultMaxConsecutiveReconnects;
+        this._flushMode = runtimeOptions.flushMode;
         this.garbageCollector = GarbageCollector.create(this, this.runtimeOptions.gcOptions, (unusedRoutes) => this.dataStores.deleteUnusedRoutes(unusedRoutes), (nodePath) => this.dataStores.getNodePackagePath(nodePath), 
         /**
          * Returns the timestamp of the last message seen by this client. This is used by garbage collector as
@@ -560,6 +580,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         this.logger.sendTelemetryEvent(Object.assign(Object.assign(Object.assign({ eventName: "ContainerLoadStats" }, this.createContainerMetadata), this.dataStores.containerLoadStats), { summaryCount: this.summaryCount, summaryFormatVersion: metadata === null || metadata === void 0 ? void 0 : metadata.summaryFormatVersion, disableIsolatedChannels: metadata === null || metadata === void 0 ? void 0 : metadata.disableIsolatedChannels, gcVersion: metadata === null || metadata === void 0 ? void 0 : metadata.gcFeature }));
         ReportOpPerfTelemetry(this.context.clientId, this.deltaManager, this.logger);
         BindBatchTracker(this, this.logger);
+        this.opTracker = new OpTracker(this.deltaManager, this.mc.config.getBoolean(disableOpTrackingKey) === true);
     }
     get IContainerRuntime() { return this; }
     get IFluidRouter() { return this; }
@@ -582,7 +603,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 runtimeVersion: pkgVersion,
             },
         });
-        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", useDataStoreAliasing = false, } = runtimeOptions;
+        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", useDataStoreAliasing = false, flushMode = defaultFlushMode, } = runtimeOptions;
         // We pack at data store level only. If isolated channels are disabled,
         // then there are no .channel layers, we pack at level 1, otherwise we pack at level 2
         const packingLevel = summaryOptions.disableIsolatedChannels ? 1 : 2;
@@ -653,6 +674,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             gcOptions,
             loadSequenceNumberVerification,
             useDataStoreAliasing,
+            flushMode,
         }, containerScope, logger, loadExisting, blobManagerSnapshot, requestHandler, storage);
         return runtime;
     }
@@ -871,12 +893,11 @@ export class ContainerRuntime extends TypedEventEmitter {
             const electedSummarizerContent = JSON.stringify((_a = this.summarizerClientElection) === null || _a === void 0 ? void 0 : _a.serialize());
             addBlobToSummary(summaryTree, electedSummarizerBlobName, electedSummarizerContent);
         }
-        const snapshot = this.blobManager.snapshot();
+        const summary = this.blobManager.summarize();
         // 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
-        if (snapshot.entries.length !== 0) {
-            const blobsTree = convertToSummaryTree(snapshot, false);
-            addTreeToSummary(summaryTree, blobsTreeName, blobsTree);
+        if (Object.keys(summary.summary.tree).length > 0) {
+            addTreeToSummary(summaryTree, blobsTreeName, summary);
         }
         if (this.garbageCollector.writeDataAtRoot) {
             const gcSummary = this.garbageCollector.summarize();
@@ -1065,6 +1086,11 @@ export class ContainerRuntime extends TypedEventEmitter {
         if (mode === this._flushMode) {
             return;
         }
+        this.mc.logger.sendTelemetryEvent({
+            eventName: "FlushMode Updated",
+            old: this._flushMode,
+            new: mode,
+        });
         // Flush any pending batches if switching to immediate
         if (mode === FlushMode.Immediate) {
             this.flush();
@@ -1192,6 +1218,10 @@ export class ContainerRuntime extends TypedEventEmitter {
         const fluidDataStore = await this.dataStores._createFluidDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], id, isRoot, props).realize();
         if (isRoot) {
             fluidDataStore.bindToContext();
+            this.logger.sendTelemetryEvent({
+                eventName: "Root datastore with props",
+                hasProps: props !== undefined,
+            });
         }
         return channelToDataStore(fluidDataStore, id, this, this.dataStores, this.mc.logger);
     }
@@ -1315,9 +1345,9 @@ export class ContainerRuntime extends TypedEventEmitter {
         if (runGC) {
             gcStats = await this.collectGarbage({ logger: summaryLogger, runSweep, fullGC });
         }
-        const summarizeResult = await this.summarizerNode.summarize(fullTree, trackState);
-        assert(summarizeResult.summary.type === SummaryType.Tree, 0x12f /* "Container Runtime's summarize should always return a tree" */);
-        return Object.assign(Object.assign({}, summarizeResult), { gcStats });
+        const { stats, summary } = await this.summarizerNode.summarize(fullTree, trackState);
+        assert(summary.type === SummaryType.Tree, 0x12f /* "Container Runtime's summarize should always return a tree" */);
+        return { stats, summary, gcStats };
     }
     /**
      * Implementation of IGarbageCollectionRuntime::updateStateBeforeGC.
@@ -1392,6 +1422,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         try {
             await this.deltaManager.inbound.pause();
             const summaryRefSeqNum = this.deltaManager.lastSequenceNumber;
+            const minimumSequenceNumber = this.deltaManager.minimumSequenceNumber;
             const message = `Summary @${summaryRefSeqNum}:${this.deltaManager.minimumSequenceNumber}`;
             // We should be here is we haven't processed be here. If we are of if the last message's sequence number
             // doesn't match the last processed sequence number, log an error.
@@ -1431,7 +1462,12 @@ export class ContainerRuntime extends TypedEventEmitter {
             };
             let continueResult = checkContinue();
             if (!continueResult.continue) {
-                return { stage: "base", referenceSequenceNumber: summaryRefSeqNum, error: continueResult.error };
+                return {
+                    stage: "base",
+                    referenceSequenceNumber: summaryRefSeqNum,
+                    minimumSequenceNumber,
+                    error: continueResult.error,
+                };
             }
             // increment summary count
             if (this.summaryCount !== undefined) {
@@ -1454,7 +1490,12 @@ export class ContainerRuntime extends TypedEventEmitter {
                 });
             }
             catch (error) {
-                return { stage: "base", referenceSequenceNumber: summaryRefSeqNum, error };
+                return {
+                    stage: "base",
+                    referenceSequenceNumber: summaryRefSeqNum,
+                    minimumSequenceNumber,
+                    error,
+                };
             }
             const { summary: summaryTree, stats: partialStats } = summarizeResult;
             // Now that we have generated the summary, update the message at last summary to the last message processed.
@@ -1465,9 +1506,13 @@ export class ContainerRuntime extends TypedEventEmitter {
             const dataStoreTree = this.disableIsolatedChannels ? summaryTree : summaryTree.tree[channelsTreeName];
             assert(dataStoreTree.type === SummaryType.Tree, 0x1fc /* "summary is not a tree" */);
             const handleCount = Object.values(dataStoreTree.tree).filter((value) => value.type === SummaryType.Handle).length;
-            const summaryStats = Object.assign({ dataStoreCount: this.dataStores.size, summarizedDataStoreCount: this.dataStores.size - handleCount, gcStateUpdatedDataStoreCount: (_b = summarizeResult.gcStats) === null || _b === void 0 ? void 0 : _b.updatedDataStoreCount }, partialStats);
+            const gcSummaryTreeStats = summaryTree.tree[gcTreeKey]
+                ? calculateStats(summaryTree.tree[gcTreeKey])
+                : undefined;
+            const summaryStats = Object.assign({ dataStoreCount: this.dataStores.size, summarizedDataStoreCount: this.dataStores.size - handleCount, gcStateUpdatedDataStoreCount: (_b = summarizeResult.gcStats) === null || _b === void 0 ? void 0 : _b.updatedDataStoreCount, gcBlobNodeCount: gcSummaryTreeStats === null || gcSummaryTreeStats === void 0 ? void 0 : gcSummaryTreeStats.blobNodeCount, gcTotalBlobsSize: gcSummaryTreeStats === null || gcSummaryTreeStats === void 0 ? void 0 : gcSummaryTreeStats.totalBlobSize, opsSizesSinceLastSummary: this.opTracker.opsSizeAccumulator, nonSystemOpsSinceLastSummary: this.opTracker.nonSystemOpCount }, partialStats);
             const generateSummaryData = {
                 referenceSequenceNumber: summaryRefSeqNum,
+                minimumSequenceNumber,
                 summaryTree,
                 summaryStats,
                 generateDuration: trace.trace().duration,
@@ -1518,6 +1563,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
             const submitData = Object.assign(Object.assign({ stage: "submit" }, uploadData), { clientSequenceNumber, submitOpDuration: trace.trace().duration });
             this.summarizerNode.completeSummary(handle);
+            this.opTracker.reset();
             return submitData;
         }
         finally {