@fluidframework/container-runtime 2.0.0-internal.5.1.0 → 2.0.0-internal.5.2.0

package/lib/containerRuntime.js

@@ -1,3 +1,14 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { AttachState, LoaderHeader, } from "@fluidframework/container-definitions";
 import { assert, delay, LazyPromise, Trace, TypedEventEmitter, unreachableCase, } from "@fluidframework/common-utils";
 import { ChildLogger, raiseConnectedEvent, PerformanceEvent, TaggedLoggerAdapter, loggerToMonitoringContext, wrapError, } from "@fluidframework/telemetry-utils";
@@ -11,17 +22,17 @@ import { v4 as uuid } from "uuid";
 import { ContainerFluidHandleContext } from "./containerHandleContext";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry";
 import { ReportOpPerfTelemetry } from "./connectionTelemetry";
-import { PendingStateManager } from "./pendingStateManager";
+import { PendingStateManager, } from "./pendingStateManager";
 import { pkgVersion } from "./packageVersion";
 import { BlobManager } from "./blobManager";
 import { DataStores, getSummaryForDatastores } from "./dataStores";
-import { aliasBlobName, blobsTreeName, chunksBlobName, createRootSummarizerNodeWithGC, electedSummarizerBlobName, extractSummaryMetadataMessage, idCompressorBlobName, metadataBlobName, Summarizer, SummaryManager, wrapSummaryInChannelsTree, SummaryCollection, OrderedClientCollection, OrderedClientElection, SummarizerClientElection, summarizerClientType, RunWhileConnectedCoordinator, } from "./summary";
+import { aliasBlobName, blobsTreeName, chunksBlobName, createRootSummarizerNodeWithGC, electedSummarizerBlobName, extractSummaryMetadataMessage, idCompressorBlobName, metadataBlobName, Summarizer, SummaryManager, wrapSummaryInChannelsTree, SummaryCollection, OrderedClientCollection, OrderedClientElection, SummarizerClientElection, summarizerClientType, RunWhileConnectedCoordinator, RetriableSummaryError, } from "./summary";
 import { formExponentialFn, Throttler } from "./throttler";
 import { GarbageCollector, GCNodeType, gcTombstoneGenerationOptionName, shouldAllowGcTombstoneEnforcement, trimLeadingAndTrailingSlashes, } from "./gc";
 import { channelToDataStore, isDataStoreAliasMessage } from "./dataStore";
 import { BindBatchTracker } from "./batchTracker";
 import { ScheduleManager } from "./scheduleManager";
-import { OpCompressor, OpDecompressor, Outbox, OpSplitter, RemoteMessageProcessor, OpGroupingManager, } from "./opLifecycle";
+import { OpCompressor, OpDecompressor, Outbox, OpSplitter, RemoteMessageProcessor, OpGroupingManager, getLongStack, } from "./opLifecycle";
 import { DeltaManagerSummarizerProxy } from "./deltaManagerSummarizerProxy";
 export var ContainerMessageType;
 (function (ContainerMessageType) {
@@ -151,7 +162,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * @internal
      */
     constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, idCompressor, requestHandler, summaryConfiguration, initializeEntryPoint) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         if (summaryConfiguration === void 0) { summaryConfiguration = Object.assign(Object.assign({}, DefaultSummaryConfiguration), (_a = runtimeOptions.summaryOptions) === null || _a === void 0 ? void 0 : _a.summaryConfigOverrides); }
         super();
         this.context = context;
@@ -303,7 +314,6 @@ export class ContainerRuntime extends TypedEventEmitter {
             getNodePackagePath: async (nodePath) => this.getGCNodePackagePath(nodePath),
             getLastSummaryTimestampMs: () => { var _a; return (_a = this.messageAtLastSummary) === null || _a === void 0 ? void 0 : _a.timestamp; },
             readAndParseBlob: async (id) => readAndParse(this.storage, id),
-            getContainerDiagnosticId: () => this.context.id,
             // GC runs in summarizer client and needs access to the real (non-proxy) active information. The proxy
             // delta manager would always return false for summarizer client.
             activeConnection: () => this.innerDeltaManager.active,
@@ -348,7 +358,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             close: this.closeFn,
             connected: () => this.connected,
             reSubmit: this.reSubmit.bind(this),
-            orderSequentially: this.orderSequentially.bind(this),
+            reSubmitBatch: this.reSubmitBatch.bind(this),
         }, pendingRuntimeState === null || pendingRuntimeState === void 0 ? void 0 : pendingRuntimeState.pending);
         const disableCompression = this.mc.config.getBoolean("Fluid.ContainerRuntime.CompressionDisabled");
         const compressionOptions = disableCompression === true
@@ -358,6 +368,8 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
             : runtimeOptions.compressionOptions;
         const disablePartialFlush = this.mc.config.getBoolean("Fluid.ContainerRuntime.DisablePartialFlush");
+        const enableBatchRebasing = runtimeOptions.enableBatchRebasing &&
+            this.mc.config.getBoolean("Fluid.ContainerRuntime.DisableBatchRebasing") !== true;
         this.outbox = new Outbox({
             shouldSend: () => this.canSendOps(),
             pendingStateManager: this.pendingStateManager,
@@ -368,6 +380,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 compressionOptions,
                 maxBatchSizeInBytes: runtimeOptions.maxBatchSizeInBytes,
                 disablePartialFlush: disablePartialFlush === true,
+                enableBatchRebasing,
             },
             logger: this.mc.logger,
             groupingManager: opGroupingManager,
@@ -375,13 +388,18 @@ export class ContainerRuntime extends TypedEventEmitter {
                 referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                 clientSequenceNumber: this._processedClientSequenceNumber,
             }),
+            reSubmit: this.reSubmit.bind(this),
+            opReentrancy: () => this.ensureNoDataModelChangesCalls > 0,
+            closeContainer: this.closeFn,
         });
         this.context.quorum.on("removeMember", (clientId) => {
             this.remoteMessageProcessor.clearPartialMessagesFor(clientId);
         });
-        this.summaryStateUpdateMethod = this.mc.config.getString("Fluid.ContainerRuntime.Test.SummaryStateUpdateMethod");
+        this.summaryStateUpdateMethod = this.mc.config.getString("Fluid.ContainerRuntime.Test.SummaryStateUpdateMethodV2");
         const closeSummarizerDelayOverride = this.mc.config.getNumber("Fluid.ContainerRuntime.Test.CloseSummarizerDelayOverrideMs");
         this.closeSummarizerDelayMs = closeSummarizerDelayOverride !== null && closeSummarizerDelayOverride !== void 0 ? closeSummarizerDelayOverride : defaultCloseSummarizerDelayMs;
+        this.validateSummaryBeforeUpload =
+            (_l = this.mc.config.getBoolean("Fluid.ContainerRuntime.Test.ValidateSummaryBeforeUpload")) !== null && _l !== void 0 ? _l : false;
         this.summaryCollection = new SummaryCollection(this.deltaManager, this.logger);
         this.dirtyContainer =
             this.context.attachState !== AttachState.Attached ||
@@ -462,6 +480,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 idCompressorEnabled: this.idCompressorEnabled,
                 summaryStateUpdateMethod: this.summaryStateUpdateMethod,
                 closeSummarizerDelayOverride,
+                enableBatchRebasing,
             }), telemetryDocumentId: this.telemetryDocumentId, groupedBatchingEnabled: this.groupedBatchingEnabled }));
         ReportOpPerfTelemetry(this.context.clientId, this.deltaManager, this.logger);
         BindBatchTracker(this, this.logger);
@@ -529,7 +548,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 runtimeVersion: pkgVersion,
             },
         });
-        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor = false, chunkSizeInBytes = defaultChunkSizeInBytes, enableOpReentryCheck = false, enableGroupedBatching = false, } = runtimeOptions;
+        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor = false, chunkSizeInBytes = defaultChunkSizeInBytes, enableOpReentryCheck = false, enableGroupedBatching = false, enableBatchRebasing = false, } = runtimeOptions;
         const registry = new FluidDataStoreRegistry(registryEntries);
         const tryFetchBlob = async (blobName) => {
             var _a;
@@ -598,6 +617,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             enableRuntimeIdCompressor,
             enableOpReentryCheck,
             enableGroupedBatching,
+            enableBatchRebasing,
         }, containerScope, logger, loadExisting, blobManagerSnapshot, context.storage, idCompressor, requestHandler, undefined, // summaryConfiguration
         initializeEntryPoint);
         // It's possible to have ops with a reference sequence number of 0. Op sequence numbers start
@@ -1690,6 +1710,16 @@ export class ContainerRuntime extends TypedEventEmitter {
                 generateDuration: trace.trace().duration,
                 forcedFullTree,
             };
+            // If validateSummaryBeforeUpload is true, validate that the summary generated by the summarizer nodes is
+            // correct before this summary is uploaded.
+            if (this.validateSummaryBeforeUpload) {
+                const validateResult = this.summarizerNode.validateSummary();
+                if (!validateResult.success) {
+                    const { success } = validateResult, loggingProps = __rest(validateResult, ["success"]);
+                    const error = new RetriableSummaryError(validateResult.reason, validateResult.retryAfterSeconds, Object.assign({}, loggingProps));
+                    return Object.assign(Object.assign({ stage: "base" }, generateSummaryData), { error });
+                }
+            }
             continueResult = checkContinue();
             if (!continueResult.continue) {
                 return Object.assign(Object.assign({ stage: "generate" }, generateSummaryData), { error: continueResult.error });
@@ -1750,7 +1780,13 @@ export class ContainerRuntime extends TypedEventEmitter {
                 return Object.assign(Object.assign({ stage: "upload" }, uploadData), { error });
             }
             const submitData = Object.assign(Object.assign({ stage: "submit" }, uploadData), { clientSequenceNumber, submitOpDuration: trace.trace().duration });
-            this.summarizerNode.completeSummary(handle);
+            try {
+                // If validateSummaryBeforeUpload is false, the summary should be validated in this step.
+                this.summarizerNode.completeSummary(handle, !this.validateSummaryBeforeUpload /* validate */);
+            }
+            catch (error) {
+                return Object.assign(Object.assign({ stage: "upload" }, uploadData), { error });
+            }
             return submitData;
         }
         finally {
@@ -1960,7 +1996,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             if (this.opReentryCallsToReport > 0) {
                 this.mc.logger.sendTelemetryEvent({ eventName: "OpReentry" }, 
                 // We need to capture the call stack in order to inspect the source of this usage pattern
-                new UsageError(errorMessage));
+                getLongStack(() => new UsageError(errorMessage)));
                 this.opReentryCallsToReport--;
             }
             // Creating ops while processing ops can lead
@@ -1980,10 +2016,18 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
         }
     }
-    reSubmit(content, localOpMetadata, opMetadata) {
+    reSubmitBatch(batch) {
+        this.orderSequentially(() => {
+            for (const message of batch) {
+                this.reSubmit(message);
+            }
+        });
+        this.flush();
+    }
+    reSubmit(message) {
         // Need to parse from string for back-compat
-        const { contents, type } = this.parseOpContent(content);
-        this.reSubmitCore(type, contents, localOpMetadata, opMetadata);
+        const { contents, type } = this.parseOpContent(message.content);
+        this.reSubmitCore(type, contents, message.localOpMetadata, message.opMetadata);
     }
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we