@fluidframework/container-runtime 2.0.0-dev.4.4.0.162574 → 2.0.0-dev.5.3.2.178189

package/dist/containerRuntime.js

@@ -18,10 +18,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContainerRuntime = exports.getDeviceSpec = exports.agentSchedulerId = exports.isRuntimeMessage = exports.RuntimeMessage = exports.CompressionAlgorithms = exports.defaultRuntimeHeaderData = exports.TombstoneResponseHeaderKey = exports.AllowTombstoneRequestHeaderKey = exports.RuntimeHeaders = exports.DefaultSummaryConfiguration = exports.ContainerMessageType = void 0;
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const common_utils_1 = require("@fluidframework/common-utils");
+const core_utils_1 = require("@fluidframework/core-utils");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const driver_definitions_1 = require("@fluidframework/driver-definitions");
 const driver_utils_1 = require("@fluidframework/driver-utils");
@@ -175,7 +187,7 @@ class ContainerRuntime extends common_utils_1.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({}, exports.DefaultSummaryConfiguration), (_a = runtimeOptions.summaryOptions) === null || _a === void 0 ? void 0 : _a.summaryConfigOverrides); }
         super();
         this.context = context;
@@ -327,7 +339,6 @@ class ContainerRuntime extends common_utils_1.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) => (0, driver_utils_1.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,
@@ -372,8 +383,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             close: this.closeFn,
             connected: () => this.connected,
             reSubmit: this.reSubmit.bind(this),
-            rollback: this.rollback.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
@@ -393,6 +403,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 compressionOptions,
                 maxBatchSizeInBytes: runtimeOptions.maxBatchSizeInBytes,
                 disablePartialFlush: disablePartialFlush === true,
+                enableGroupedBatching: this.groupedBatchingEnabled,
             },
             logger: this.mc.logger,
             groupingManager: opGroupingManager,
@@ -400,13 +411,18 @@ class ContainerRuntime extends common_utils_1.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 summary_1.SummaryCollection(this.deltaManager, this.logger);
         this.dirtyContainer =
             this.context.attachState !== container_definitions_1.AttachState.Attached ||
@@ -490,7 +506,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             }), telemetryDocumentId: this.telemetryDocumentId, groupedBatchingEnabled: this.groupedBatchingEnabled }));
         (0, connectionTelemetry_1.ReportOpPerfTelemetry)(this.context.clientId, this.deltaManager, this.logger);
         (0, batchTracker_1.BindBatchTracker)(this, this.logger);
-        this.entryPoint = new common_utils_1.LazyPromise(async () => {
+        this.entryPoint = new core_utils_1.LazyPromise(async () => {
             if (this.context.clientDetails.type === summary_1.summarizerClientType) {
                 (0, common_utils_1.assert)(this._summarizer !== undefined, 0x5bf /* Summarizer object is undefined in a summarizer client */);
                 return this._summarizer;
@@ -498,9 +514,6 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             return initializeEntryPoint === null || initializeEntryPoint === void 0 ? void 0 : initializeEntryPoint(this);
         });
     }
-    get IContainerRuntime() {
-        return this;
-    }
     get IFluidRouter() {
         return this;
     }
@@ -649,7 +662,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
     }
     get reSubmitFn() {
         // eslint-disable-next-line @typescript-eslint/unbound-method
-        return this.reSubmit;
+        return this.reSubmitCore;
     }
     get disposeFn() {
         var _a;
@@ -657,6 +670,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         return (_a = this.context.disposeFn) !== null && _a !== void 0 ? _a : this.context.closeFn;
     }
     get closeFn() {
+        if (this._summarizer !== undefined) {
+            // In cases of summarizer, we want to dispose instead since consumer doesn't interact with this container
+            return this.disposeFn;
+        }
         // Also call disposeFn to retain functionality of runtime being disposed on close
         return (error) => {
             var _a, _b;
@@ -924,8 +941,14 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         }
         return this.consecutiveReconnects < this.maxConsecutiveReconnects;
     }
-    resetReconnectCount() {
-        this.consecutiveReconnects = 0;
+    resetReconnectCount(message) {
+        // Chunked ops don't count towards making progress as they are sent
+        // in their own batches before the originating batch is sent.
+        // Therefore, receiving them while attempting to send the originating batch
+        // does not mean that the container is making any progress.
+        if ((message === null || message === void 0 ? void 0 : message.type) !== ContainerMessageType.ChunkedOp) {
+            this.consecutiveReconnects = 0;
+        }
     }
     replayPendingStates() {
         // We need to be able to send ops to replay states
@@ -967,7 +990,19 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         const { IdCompressor } = await Promise.resolve().then(() => __importStar(require("./id-compressor")));
         this.idCompressor = IdCompressor.deserialize(op.stashedState);
     }
-    async applyStashedOp(type, contents) {
+    /**
+     * Parse an op's type and actual content from given serialized content
+     * ! Note: this format needs to be in-line with what is set in the "ContainerRuntime.submit(...)" method
+     */
+    parseOpContent(serializedContent) {
+        (0, common_utils_1.assert)(serializedContent !== undefined, 0x6d5 /* content must be defined */);
+        const parsed = JSON.parse(serializedContent);
+        (0, common_utils_1.assert)(parsed.type !== undefined, 0x6d6 /* incorrect op content format */);
+        return { type: parsed.type, contents: parsed.contents };
+    }
+    async applyStashedOp(op) {
+        // Need to parse from string for back-compat
+        const { type, contents } = this.parseOpContent(op);
         switch (type) {
             case ContainerMessageType.FluidDataStoreOp:
                 return this.dataStores.applyStashedOp(contents);
@@ -1126,7 +1161,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 // If we have processed a local op, this means that the container is
                 // making progress and we can reset the counter for how many times
                 // we have consecutively replayed the pending states
-                this.resetReconnectCount();
+                this.resetReconnectCount(message);
             }
         }
         catch (e) {
@@ -1226,7 +1261,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             if (checkpoint) {
                 // This will throw and close the container if rollback fails
                 try {
-                    checkpoint.rollback((message) => this.rollback(message.deserializedContent.type, message.deserializedContent.contents, message.localOpMetadata));
+                    checkpoint.rollback((message) => this.rollback(message.contents, message.localOpMetadata));
                 }
                 catch (err) {
                     const error2 = (0, telemetry_utils_1.wrapError)(err, (message) => {
@@ -1700,6 +1735,16 @@ class ContainerRuntime extends common_utils_1.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 summary_1.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 });
@@ -1760,7 +1805,13 @@ class ContainerRuntime extends common_utils_1.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 {
@@ -1831,10 +1882,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 };
                 idAllocationBatchMessage = {
                     contents: JSON.stringify(idAllocationMessage),
-                    deserializedContent: idAllocationMessage,
                     referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
                     metadata: undefined,
                     localOpMetadata: (_b = this.idCompressor) === null || _b === void 0 ? void 0 : _b.serialize(true),
+                    type: ContainerMessageType.IdAllocation,
                 };
             }
             if (idAllocationBatchMessage !== undefined) {
@@ -1858,7 +1909,7 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
         }
         const message = {
             contents: serializedContent,
-            deserializedContent: JSON.parse(serializedContent),
+            type,
             metadata,
             localOpMetadata,
             referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
@@ -1894,6 +1945,10 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 this.disableAttachReorder !== true) {
                 this.outbox.submitAttach(message);
             }
+            else 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);
             }
@@ -1970,7 +2025,7 @@ class ContainerRuntime extends common_utils_1.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 container_utils_1.UsageError(errorMessage));
+                (0, opLifecycle_1.getLongStack)(() => new container_utils_1.UsageError(errorMessage)));
                 this.opReentryCallsToReport--;
             }
             // Creating ops while processing ops can lead
@@ -1990,13 +2045,26 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
             }
         }
     }
+    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(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
      * reconnect and there are pending messages.
      * @param content - The content of the original message.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
-    reSubmit(type, content, localOpMetadata, opMetadata) {
+    reSubmitCore(type, content, localOpMetadata, opMetadata) {
         switch (type) {
             case ContainerMessageType.FluidDataStoreOp:
                 // For Operations, call resubmitDataStoreOp which will find the right store
@@ -2005,7 +2073,13 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 break;
             case ContainerMessageType.Attach:
             case ContainerMessageType.Alias:
+                this.submit(type, content, localOpMetadata);
+                break;
             case ContainerMessageType.IdAllocation:
+                // Remove the stashedState from the op if it's a stashed op
+                if (content.stashedState !== undefined) {
+                    delete content.stashedState;
+                }
                 this.submit(type, content, localOpMetadata);
                 break;
             case ContainerMessageType.ChunkedOp:
@@ -2020,12 +2094,14 @@ class ContainerRuntime extends common_utils_1.TypedEventEmitter {
                 (0, common_utils_1.unreachableCase)(type, `Unknown ContainerMessageType: ${type}`);
         }
     }
-    rollback(type, content, localOpMetadata) {
+    rollback(content, localOpMetadata) {
+        // Need to parse from string for back-compat
+        const { type, contents } = this.parseOpContent(content);
         switch (type) {
             case ContainerMessageType.FluidDataStoreOp:
                 // For operations, call rollbackDataStoreOp which will find the right store
                 // and trigger rollback on it.
-                this.dataStores.rollbackDataStoreOp(content, localOpMetadata);
+                this.dataStores.rollbackDataStoreOp(contents, localOpMetadata);
                 break;
             default:
                 throw new Error(`Can't rollback ${type}`);