@fluidframework/container-runtime 2.0.0-dev-rc.5.0.0.263932 → 2.0.0-dev-rc.5.0.0.267932

package/lib/containerRuntime.js

@@ -6,9 +6,9 @@ import { Trace, TypedEventEmitter } from "@fluid-internal/client-utils";
 import { AttachState, } from "@fluidframework/container-definitions";
 import { LoaderHeader, } from "@fluidframework/container-definitions/internal";
 import { assert, Deferred, LazyPromise, PromiseCache, delay, } from "@fluidframework/core-utils/internal";
-import { DriverHeader, FetchSource, } from "@fluidframework/driver-definitions/internal";
+import { SummaryType, } from "@fluidframework/driver-definitions";
+import { DriverHeader, FetchSource, MessageType, } from "@fluidframework/driver-definitions/internal";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
-import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
 import { FlushMode, FlushModeExperimental, channelsTreeName, gcTreeKey, } from "@fluidframework/runtime-definitions/internal";
 import { GCDataBuilder, RequestParser, TelemetryContext, addBlobToSummary, addSummarizeResultToSummary, calculateStats, create404Response, exceptionToResponse, responseToException, seqFromTree, } from "@fluidframework/runtime-utils/internal";
 import { DataCorruptionError, DataProcessingError, GenericError, LoggingError, PerformanceEvent, 
@@ -49,13 +49,13 @@ function compatBehaviorAllowsMessageType(_unknownContainerRuntimeMessageType, co
 export const DefaultSummaryConfiguration = {
     state: "enabled",
     minIdleTime: 0,
-    maxIdleTime: 30 * 1000,
-    maxTime: 60 * 1000,
-    maxOps: 100,
+    maxIdleTime: 30 * 1000, // 30 secs.
+    maxTime: 60 * 1000, // 1 min.
+    maxOps: 100, // Summarize if 100 weighted ops received since last snapshot.
     minOpsForLastSummaryAttempt: 10,
-    maxAckWaitTime: 3 * 60 * 1000,
+    maxAckWaitTime: 3 * 60 * 1000, // 3 mins.
     maxOpsSinceLastSummary: 7000,
-    initialSummarizerDelayMs: 5 * 1000,
+    initialSummarizerDelayMs: 5 * 1000, // 5 secs.
     nonRuntimeOpWeight: 0.1,
     runtimeOpWeight: 1.0,
     nonRuntimeHeuristicThreshold: 20,
@@ -528,7 +528,9 @@ export class ContainerRuntime extends TypedEventEmitter {
         return this.garbageCollector.throwOnTombstoneUsage;
     }
     /***/
-    constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, createIdCompressor, documentsSchemaController, featureGatesForTelemetry, provideEntryPoint, requestHandler, summaryConfiguration = {
+    constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, 
+    // Create a custom ITelemetryBaseLogger to output telemetry events.
+    baseLogger, existing, blobManagerSnapshot, _storage, createIdCompressor, documentsSchemaController, featureGatesForTelemetry, provideEntryPoint, requestHandler, summaryConfiguration = {
         // the defaults
         ...DefaultSummaryConfiguration,
         // the runtime configuration overrides
@@ -539,7 +541,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         this.metadata = metadata;
         this.runtimeOptions = runtimeOptions;
         this.containerScope = containerScope;
-        this.logger = logger;
+        this.baseLogger = baseLogger;
         this._storage = _storage;
         this.createIdCompressor = createIdCompressor;
         this.documentsSchemaController = documentsSchemaController;
@@ -571,6 +573,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             expiry: { policy: "absolute", durationMs: 60000 },
         });
         const { options, clientDetails, connected, baseSnapshot, submitFn, submitBatchFn, submitSummaryFn, submitSignalFn, disposeFn, closeFn, deltaManager, quorum, audience, loader, pendingLocalState, supportedFeatures, snapshotWithContents, } = context;
+        this.logger = createChildLogger({ logger: this.baseLogger });
         this.mc = createChildMonitoringContext({
             logger: this.logger,
             namespace: "ContainerRuntime",
@@ -853,7 +856,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 namespace: "OrderedClientElection",
             });
             const orderedClientCollection = new OrderedClientCollection(orderedClientLogger, this.innerDeltaManager, this._quorum);
-            const orderedClientElectionForSummarizer = new OrderedClientElection(orderedClientLogger, orderedClientCollection, electedSummarizerData ?? this.innerDeltaManager.lastSequenceNumber, SummarizerClientElection.isClientEligible);
+            const orderedClientElectionForSummarizer = new OrderedClientElection(orderedClientLogger, orderedClientCollection, electedSummarizerData ?? this.innerDeltaManager.lastSequenceNumber, SummarizerClientElection.isClientEligible, this.mc.config.getBoolean("Fluid.ContainerRuntime.OrderedClientElection.EnablePerformanceEvents"));
             this.summarizerClientElection = new SummarizerClientElection(orderedClientLogger, this.summaryCollection, orderedClientElectionForSummarizer, this.maxOpsSinceLastSummary);
             if (this.isSummarizerClient) {
                 this._summarizer = new Summarizer(this /* ISummarizerRuntime */, () => this.summaryConfiguration, this /* ISummarizerInternalsProvider */, this.handleContext, this.summaryCollection, async (runtime) => RunWhileConnectedCoordinator.create(runtime, 
@@ -897,7 +900,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
         }
         // logging hardware telemetry
-        logger.sendTelemetryEvent({
+        this.logger.sendTelemetryEvent({
             eventName: "DeviceSpec",
             ...getDeviceSpec(),
         });
@@ -1060,7 +1063,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             const props = {
                 eventName: "GroupIdSnapshotCatchup",
                 loadingGroupIds: sortedLoadingGroupIds.join(","),
-                targetSequenceNumber: snapshotSeqNumber,
+                targetSequenceNumber: snapshotSeqNumber, // This is so we reuse some columns in telemetry
                 sequenceNumber: this.deltaManager.lastSequenceNumber, // This is so we reuse some columns in telemetry
             };
             const event = PerformanceEvent.start(this.mc.logger, {
@@ -1178,7 +1181,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             this.messageAtLastSummary;
         const documentSchema = this.documentsSchemaController.summarizeDocumentSchema(this.deltaManager.lastSequenceNumber);
         // Is document schema explicit control on?
-        const explitiSchemaControl = documentSchema?.runtime.explicitSchemaControl;
+        const explicitSchemaControl = documentSchema?.runtime.explicitSchemaControl;
         const metadata = {
             ...this.createContainerMetadata,
             // Increment the summary number for the next summary that will be generated.
@@ -1191,10 +1194,10 @@ export class ContainerRuntime extends TypedEventEmitter {
             // runtimes (that preceed document schema control capabilities) to close container on load due to mismatch in
             // last message's sequence number.
             // See also lastMessageFromMetadata()
-            message: explitiSchemaControl
+            message: explicitSchemaControl
                 ? { sequenceNumber: -1 }
                 : message,
-            lastMessage: explitiSchemaControl ? message : undefined,
+            lastMessage: explicitSchemaControl ? message : undefined,
             documentSchema,
         };
         addBlobToSummary(summaryTree, metadataBlobName, JSON.stringify(metadata));
@@ -2076,7 +2079,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * @param options - options controlling how the summary is generated or submitted
      */
     async submitSummary(options) {
-        const { fullTree = false, finalAttempt = false, refreshLatestAck, summaryLogger, latestSummaryRefSeqNum, } = options;
+        const { fullTree = false, finalAttempt = false, summaryLogger, latestSummaryRefSeqNum, } = options;
         // The summary number for this summary. This will be updated during the summary process, so get it now and
         // use it for all events logged during this summary.
         const summaryNumber = this.nextSummaryNumber;
@@ -2091,13 +2094,6 @@ export class ContainerRuntime extends TypedEventEmitter {
             },
         });
         assert(this.outbox.isEmpty, 0x3d1 /* Can't trigger summary in the middle of a batch */);
-        // We close the summarizer and download a new snapshot and reload the container
-        if (refreshLatestAck === true) {
-            return this.prefetchLatestSummaryThenClose(createChildLogger({
-                logger: summaryNumberLogger,
-                properties: { all: { safeSummary: true } },
-            }));
-        }
         // If the container is dirty, i.e., there are pending unacked ops, the summary will not be eventual consistent
         // and it may even be incorrect. So, wait for the container to be saved with a timeout. If the container is not
         // saved within the timeout, check if it should be failed or can continue.
@@ -2166,7 +2162,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                         stage: "base",
                         referenceSequenceNumber: summaryRefSeqNum,
                         minimumSequenceNumber,
-                        error: new LoggingError(`Summarizer node state inconsistent with summarizer state.`),
+                        error: new RetriableSummaryError(`Summarizer node state inconsistent with summarizer state.`),
                     };
                 }
             }
@@ -2209,17 +2205,14 @@ export class ContainerRuntime extends TypedEventEmitter {
                     stage: "base",
                     referenceSequenceNumber: summaryRefSeqNum,
                     minimumSequenceNumber,
-                    error: new LoggingError(continueResult.error),
+                    error: new RetriableSummaryError(continueResult.error),
                 };
             }
             const trace = Trace.start();
             let summarizeResult;
-            // If the GC state needs to be reset, we need to force a full tree summary and update the unreferenced
-            // state of all the nodes.
-            const forcedFullTree = this.garbageCollector.summaryStateNeedsReset;
             try {
                 summarizeResult = await this.summarize({
-                    fullTree: fullTree || forcedFullTree,
+                    fullTree,
                     trackState: true,
                     summaryLogger: summaryNumberLogger,
                     runGC: this.garbageCollector.shouldRunGC,
@@ -2230,7 +2223,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                     stage: "base",
                     referenceSequenceNumber: summaryRefSeqNum,
                     minimumSequenceNumber,
-                    error: wrapError(error, (msg) => new LoggingError(msg)),
+                    error: wrapError(error, (msg) => new RetriableSummaryError(msg)),
                 };
             }
             // Validate that the summary generated by summarizer nodes is correct before uploading.
@@ -2278,14 +2271,13 @@ export class ContainerRuntime extends TypedEventEmitter {
                 summaryTree,
                 summaryStats,
                 generateDuration: trace.trace().duration,
-                forcedFullTree,
             };
             continueResult = checkContinue();
             if (!continueResult.continue) {
                 return {
                     stage: "generate",
                     ...generateSummaryData,
-                    error: new LoggingError(continueResult.error),
+                    error: new RetriableSummaryError(continueResult.error),
                 };
             }
             const summaryContext = lastAck === undefined
@@ -2307,7 +2299,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 return {
                     stage: "generate",
                     ...generateSummaryData,
-                    error: wrapError(error, (msg) => new LoggingError(msg)),
+                    error: wrapError(error, (msg) => new RetriableSummaryError(msg)),
                 };
             }
             const parent = summaryContext.ackHandle;
@@ -2328,7 +2320,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 return {
                     stage: "upload",
                     ...uploadData,
-                    error: new LoggingError(continueResult.error),
+                    error: new RetriableSummaryError(continueResult.error),
                 };
             }
             let clientSequenceNumber;
@@ -2339,7 +2331,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 return {
                     stage: "upload",
                     ...uploadData,
-                    error: wrapError(error, (msg) => new LoggingError(msg)),
+                    error: wrapError(error, (msg) => new RetriableSummaryError(msg)),
                 };
             }
             const submitData = {
@@ -2355,7 +2347,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 return {
                     stage: "upload",
                     ...uploadData,
-                    error: wrapError(error, (msg) => new LoggingError(msg)),
+                    error: wrapError(error, (msg) => new RetriableSummaryError(msg)),
                 };
             }
             return submitData;
@@ -2445,13 +2437,13 @@ export class ContainerRuntime extends TypedEventEmitter {
         this.verifyNotClosed();
         return this.blobManager.createBlob(blob, signal);
     }
-    submitIdAllocationOpIfNeeded(resubmitOutstandingRanges = false) {
+    submitIdAllocationOpIfNeeded(resubmitOutstandingRanges) {
         if (this._idCompressor) {
             const idRange = resubmitOutstandingRanges
-                ? this.idCompressor?.takeUnfinalizedCreationRange()
+                ? this._idCompressor.takeUnfinalizedCreationRange()
                 : this._idCompressor.takeNextCreationRange();
             // Don't include the idRange if there weren't any Ids allocated
-            if (idRange?.ids !== undefined) {
+            if (idRange.ids !== undefined) {
                 const idAllocationMessage = {
                     type: ContainerMessageType.IdAllocation,
                     contents: idRange,
@@ -2480,6 +2472,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             });
         }
         const type = containerRuntimeMessage.type;
+        assert(type !== ContainerMessageType.IdAllocation, "IdAllocation should be submitted directly to outbox.");
         const message = {
             contents: serializedContent,
             metadata,
@@ -2487,44 +2480,35 @@ export class ContainerRuntime extends TypedEventEmitter {
             referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
         };
         try {
-            // If `message` is an allocation op, then we are in the resubmit path and we must redirect the allocation
-            // op into the correct batch to avoid ranges being finalized out of order.
-            // Otherwise, submit an IdAllocation op if any IDs have been generated since the last op was submitted, as
-            // any of the other op types may contain those IDs and thus depend on the allocation op being sent first.
-            if (type === ContainerMessageType.IdAllocation) {
-                this.outbox.submitIdAllocation(message);
+            this.submitIdAllocationOpIfNeeded(false);
+            // Allow document schema controller to send a message if it needs to propose change in document schema.
+            // If it needs to send a message, it will call provided callback with payload of such message and rely
+            // on this callback to do actual sending.
+            const contents = this.documentsSchemaController.maybeSendSchemaMessage();
+            if (contents) {
+                this.logger.sendTelemetryEvent({
+                    eventName: "SchemaChangeProposal",
+                    refSeq: contents.refSeq,
+                    version: contents.version,
+                    newRuntimeSchema: JSON.stringify(contents.runtime),
+                    sessionRuntimeSchema: JSON.stringify(this.sessionSchema),
+                    oldRuntimeSchema: JSON.stringify(this.metadata?.documentSchema?.runtime),
+                });
+                const msg = {
+                    type: ContainerMessageType.DocumentSchemaChange,
+                    contents,
+                };
+                this.outbox.submit({
+                    contents: JSON.stringify(msg),
+                    referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
+                });
+            }
+            if (type === ContainerMessageType.BlobAttach) {
+                // BlobAttach ops must have their metadata visible and cannot be grouped (see opGroupingManager.ts)
+                this.outbox.submitBlobAttach(message);
             }
             else {
-                this.submitIdAllocationOpIfNeeded();
-                // Allow document schema controller to send a message if it needs to propose change in document schema.
-                // If it needs to send a message, it will call provided callback with payload of such message and rely
-                // on this callback to do actual sending.
-                const contents = this.documentsSchemaController.maybeSendSchemaMessage();
-                if (contents) {
-                    this.logger.sendTelemetryEvent({
-                        eventName: "SchemaChangeProposal",
-                        refSeq: contents.refSeq,
-                        version: contents.version,
-                        newRuntimeSchema: JSON.stringify(contents.runtime),
-                        sessionRuntimeSchema: JSON.stringify(this.sessionSchema),
-                        oldRuntimeSchema: JSON.stringify(this.metadata?.documentSchema?.runtime),
-                    });
-                    const msg = {
-                        type: ContainerMessageType.DocumentSchemaChange,
-                        contents,
-                    };
-                    this.outbox.submit({
-                        contents: JSON.stringify(msg),
-                        referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
-                    });
-                }
-                if (type === ContainerMessageType.BlobAttach) {
-                    // BlobAttach ops must have their metadata visible and cannot be grouped (see opGroupingManager.ts)
-                    this.outbox.submitBlobAttach(message);
-                }
-                else {
-                    this.outbox.submit(message);
-                }
+                this.outbox.submit(message);
             }
             if (!this.currentlyBatching()) {
                 this.flush();
@@ -2699,51 +2683,23 @@ export class ContainerRuntime extends TypedEventEmitter {
          * and then close as the current main client is likely to be re-elected as the parent summarizer again.
          */
         if (!result.isSummaryTracked && result.isSummaryNewer) {
-            await this.fetchLatestSnapshotFromStorage(summaryLogger, {
+            await this.fetchLatestSnapshotAndClose(summaryLogger, {
                 eventName: "RefreshLatestSummaryAckFetch",
                 ackHandle,
                 targetSequenceNumber: summaryRefSeq,
             }, readAndParseBlob);
-            await this.closeStaleSummarizer();
             return;
         }
         // Notify the garbage collector so it can update its latest summary state.
         await this.garbageCollector.refreshLatestSummary(result);
     }
     /**
-     * Fetches the latest snapshot from storage to refresh the cache as a performance optimization and closes the
-     * summarizer to reload from new state.
-     * @param summaryLogger - logger to use when fetching snapshot from storage
-     * @returns a generic summarization error
+     * Fetches the latest snapshot from storage and closes the container. This is done in cases where
+     * the last known snapshot is older than the latest one. This will ensure that the latest snapshot
+     * is downloaded and we don't end up loading snapshot from cache.
      */
-    async prefetchLatestSummaryThenClose(summaryLogger) {
-        const readAndParseBlob = async (id) => readAndParse(this.storage, id);
-        // This is a performance optimization as the same parent is likely to be elected again, and would use its
-        // cache to fetch the snapshot instead of the network.
-        await this.fetchLatestSnapshotFromStorage(summaryLogger, {
-            eventName: "RefreshLatestSummaryFromServerFetch",
-        }, readAndParseBlob);
-        await this.closeStaleSummarizer();
-        return {
-            stage: "base",
-            error: new LoggingError("summary state stale - Unsupported option 'refreshLatestAck'"),
-            referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
-            minimumSequenceNumber: this.deltaManager.minimumSequenceNumber,
-        };
-    }
-    async closeStaleSummarizer() {
-        // Delay before restarting summarizer to prevent the summarizer from restarting too frequently.
-        await delay(this.closeSummarizerDelayMs);
-        this._summarizer?.stop("latestSummaryStateStale");
-        this.disposeFn();
-    }
-    /**
-     * Downloads the latest snapshot from storage.
-     * By default, it also closes the container after downloading the snapshot. However, this may be
-     * overridden via options.
-     */
-    async fetchLatestSnapshotFromStorage(logger, event, readAndParseBlob) {
-        return PerformanceEvent.timedExecAsync(logger, event, async (perfEvent) => {
+    async fetchLatestSnapshotAndClose(logger, event, readAndParseBlob) {
+        await PerformanceEvent.timedExecAsync(logger, event, async (perfEvent) => {
             const stats = {};
             const trace = Trace.start();
             const versions = await this.storage.getVersions(null, 1, "prefetchLatestSummaryBeforeClose", FetchSource.noCache);
@@ -2756,12 +2712,10 @@ export class ContainerRuntime extends TypedEventEmitter {
             stats.snapshotRefSeq = latestSnapshotRefSeq;
             stats.snapshotVersion = versions[0].id;
             perfEvent.end(stats);
-            return {
-                snapshotTree: maybeSnapshot,
-                versionId: versions[0].id,
-                latestSnapshotRefSeq,
-            };
         });
+        await delay(this.closeSummarizerDelayMs);
+        this._summarizer?.stop("latestSummaryStateStale");
+        this.disposeFn();
     }
     getPendingLocalState(props) {
         this.verifyNotClosed();