@fluidframework/container-runtime 2.91.0 → 2.92.0

package/dist/containerRuntime.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isContainerMessageDirtyable = exports.ContainerRuntime = exports.loadContainerRuntime = exports.getSingleUseLegacyLogCallback = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isUnpackedRuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.DeletedResponseHeaderKey = void 0;
+exports.isContainerMessageDirtyable = exports.ContainerRuntime = exports.loadContainerRuntimeAlpha = exports.loadContainerRuntime = exports.getSingleUseLegacyLogCallback = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isUnpackedRuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.DeletedResponseHeaderKey = void 0;
 const client_utils_1 = require("@fluid-internal/client-utils");
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/container-definitions/internal");
@@ -105,6 +105,15 @@ const maxConsecutiveReconnectsKey = "Fluid.ContainerRuntime.MaxConsecutiveReconn
 // - we do not stringify final op, thus we do not know how much escaping will be added.
 const defaultMaxBatchSizeInBytes = 700 * 1024;
 const defaultChunkSizeInBytes = 204800;
+/**
+ * Default maximum ops per staging-mode batch before automatic flush scheduling resumes.
+ *
+ * Chosen based on production telemetry: copy-paste operations routinely produce batches
+ * of 1000+ ops (435K instances over 30 days), and receivers on modern Fluid versions
+ * handle them without issues. Uses {@link largeBatchThreshold} to stay aligned with
+ * the existing "large batch" telemetry threshold ({@link OpGroupingManager}).
+ */
+const defaultStagingModeAutoFlushThreshold = index_js_3.largeBatchThreshold;
 /**
  * The default time to wait for pending ops to be processed during summarization
  */
@@ -206,6 +215,22 @@ async function loadContainerRuntime(params) {
     return ContainerRuntime.loadRuntime(params);
 }
 exports.loadContainerRuntime = loadContainerRuntime;
+/**
+ * Alpha variant of {@link loadContainerRuntime} that returns the runtime in an
+ * extendable object, allowing additional properties to be added in the future.
+ *
+ * @param params - An object which specifies all required and optional params necessary to instantiate a runtime.
+ * @returns An object containing the runtime.
+ *
+ * @legacy @alpha
+ */
+async function loadContainerRuntimeAlpha(params) {
+    return ContainerRuntime.loadRuntime2({
+        ...params,
+        registry: new dataStoreRegistry_js_1.FluidDataStoreRegistry(params.registryEntries),
+    });
+}
+exports.loadContainerRuntimeAlpha = loadContainerRuntimeAlpha;
 const defaultMaxConsecutiveReconnects = 7;
 /**
  * These are the ONLY message types that are allowed to be submitted while in staging mode
@@ -245,13 +270,14 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         return ContainerRuntime.loadRuntime2({
             ...params,
             registry: new dataStoreRegistry_js_1.FluidDataStoreRegistry(params.registryEntries),
-        });
+        }).then((r) => r.runtime);
     }
     /**
-     * Load the stores from a snapshot and returns the runtime.
+     * Load the stores from a snapshot and returns an object containing the runtime.
      * @remarks
      * Same as {@link ContainerRuntime.loadRuntime},
      * but with `registry` instead of `registryEntries` and more `runtimeOptions`.
+     * Returns `{ runtime }` to allow future extensions (e.g. staging mode controls).
      */
     static async loadRuntime2(params) {
         const { context, registry, existing, requestHandler, provideEntryPoint, runtimeOptions = {}, containerScope = {}, containerRuntimeCtor = ContainerRuntime, minVersionForCollab = internal_7.defaultMinVersionForCollab, } = params;
@@ -288,6 +314,8 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             loadSequenceNumberVerification: "close",
             maxBatchSizeInBytes: defaultMaxBatchSizeInBytes,
             chunkSizeInBytes: defaultChunkSizeInBytes,
+            stagingModeAutoFlushThreshold: defaultStagingModeAutoFlushThreshold,
+            disableSchemaUpgrade: false,
         };
         const defaultConfigs = {
             ...defaultsAffectingDocSchema,
@@ -301,7 +329,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // is enabled via runtimeOptions, we will throw an error later.
         compressionOptions = enableGroupedBatching === false
             ? compressionDefinitions_js_1.disabledCompressionConfig
-            : defaultConfigs.compressionOptions, createBlobPayloadPending = defaultConfigs.createBlobPayloadPending, } = runtimeOptions;
+            : defaultConfigs.compressionOptions, createBlobPayloadPending = defaultConfigs.createBlobPayloadPending, stagingModeAutoFlushThreshold = defaultConfigs.stagingModeAutoFlushThreshold, disableSchemaUpgrade = defaultConfigs.disableSchemaUpgrade, } = runtimeOptions;
         // If explicitSchemaControl is off, ensure that options which require explicitSchemaControl are not enabled.
         if (!explicitSchemaControl) {
             const disallowedKeys = Object.keys(runtimeOptions).filter((key) => containerCompatibility_js_1.runtimeOptionKeysThatRequireExplicitSchemaControl.includes(key) && runtimeOptions[key] !== undefined);
@@ -408,6 +436,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         else {
             idCompressorMode = desiredIdCompressorMode;
         }
+        // eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
         const createIdCompressorFn = () => {
             /**
              * Because the IdCompressor emits so much telemetry, this function is used to sample
@@ -444,7 +473,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             disallowedVersions: [],
         }, (schema) => {
             runtime.onSchemaChange(schema);
-        }, { minVersionForCollab }, logger);
+        }, { minVersionForCollab }, logger, disableSchemaUpgrade);
         // If the minVersionForCollab for this client is greater than the existing one, we should use that one going forward.
         const existingMinVersionForCollab = documentSchemaController.sessionSchema.info.minVersionForCollab;
         const updatedMinVersionForCollab = existingMinVersionForCollab === undefined ||
@@ -468,6 +497,8 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             enableGroupedBatching,
             explicitSchemaControl,
             createBlobPayloadPending,
+            stagingModeAutoFlushThreshold,
+            disableSchemaUpgrade,
         };
         (0, internal_7.validateMinimumVersionForCollab)(updatedMinVersionForCollab);
         const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], internalRuntimeOptions, containerScope, logger, existing, blobManagerLoadInfo, context.storage, createIdCompressorFn, documentSchemaController, featureGatesForTelemetry, provideEntryPoint, updatedMinVersionForCollab, requestHandler, undefined, // summaryConfiguration
@@ -478,7 +509,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // Apply stashed ops with a reference sequence number equal to the sequence number of the snapshot,
         // or zero. This must be done before Container replays saved ops.
         await runtime.pendingStateManager.applyStashedOpsAt(runtimeSequenceNumber ?? 0);
-        return runtime;
+        return { runtime };
     }
     get clientId() {
         return this._getClientId();
@@ -517,6 +548,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * {@inheritDoc @fluidframework/runtime-definitions#IContainerRuntimeBase.idCompressor}
      */
+    // eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
     get idCompressor() {
         // Expose ID Compressor only if it's On from the start.
         // If container uses delayed mode, then we can only expose generateDocumentUniqueId() and nothing else.
@@ -595,7 +627,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /***/
     constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, 
     // Create a custom ITelemetryBaseLogger to output telemetry events.
-    baseLogger, existing, blobManagerLoadInfo, _storage, createIdCompressorFn, documentsSchemaController, featureGatesForTelemetry, provideEntryPoint, minVersionForCollab, requestHandler, 
+    baseLogger, existing, blobManagerLoadInfo, _storage, 
+    // eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
+    createIdCompressorFn, documentsSchemaController, featureGatesForTelemetry, provideEntryPoint, minVersionForCollab, requestHandler, 
     // // eslint-disable-next-line unicorn/no-object-as-default-parameter
     summaryConfiguration = {
         // the defaults
@@ -652,17 +686,28 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // Make sure Outbox is empty before entering staging mode,
             // since we mark whole batches as "staged" or not to indicate whether to submit them.
             this.flush();
-            const exitStagingMode = (discardOrCommit) => {
+            const exitStagingMode = (discardOrCommit, exitMethod) => {
                 try {
-                    // Final flush of any last staged changes
-                    // NOTE: We can't use this.flush() here, because orderSequentially uses StagingMode and in the rollback case we'll hit assert 0x24c
-                    this.outbox.flush();
-                    this.stageControls = undefined;
-                    // During Staging Mode, we avoid submitting any ID Allocation ops (apart from resubmitting pre-staging ops).
-                    // Now that we've exited, we need to submit an ID Allocation op for any IDs that were generated while in Staging Mode.
-                    this.submitIdAllocationOpIfNeeded({ staged: false });
-                    discardOrCommit();
-                    this.channelCollection.notifyStagingMode(false);
+                    internal_8.PerformanceEvent.timedExec(this.mc.logger, {
+                        eventName: `ExitStagingMode_${exitMethod}`,
+                    }, (event) => {
+                        // Final flush of any last staged changes
+                        // NOTE: We can't use this.flush() here, because orderSequentially uses StagingMode and in the rollback case we'll hit assert 0x24c
+                        this.outbox.flush();
+                        this.stageControls = undefined;
+                        // During Staging Mode, we avoid submitting any ID Allocation ops (apart from resubmitting pre-staging ops).
+                        // Now that we've exited, we need to submit an ID Allocation op for any IDs that were generated while in Staging Mode.
+                        this.submitIdAllocationOpIfNeeded({ staged: false });
+                        const batchInfos = discardOrCommit();
+                        event.reportProgress({
+                            details: {
+                                autoFlushThreshold: this.stagingModeAutoFlushThreshold,
+                                batches: batchInfos.length,
+                                batchesAtOrOverThreshold: batchInfos.filter((b) => b.length >= this.stagingModeAutoFlushThreshold).length,
+                            },
+                        });
+                        this.channelCollection.notifyStagingMode(false);
+                    });
                 }
                 catch (error) {
                     const normalizedError = (0, internal_8.normalizeError)(error);
@@ -673,21 +718,22 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             const stageControls = {
                 discardChanges: () => exitStagingMode(() => {
                     // Pop all staged batches from the PSM and roll them back in LIFO order
-                    this.pendingStateManager.popStagedBatches(({ runtimeOp, localOpMetadata }) => {
+                    const batchInfos = this.pendingStateManager.popStagedBatches(({ runtimeOp, localOpMetadata }) => {
                         this.rollbackStagedChange(runtimeOp, localOpMetadata);
                     });
                     this.updateDocumentDirtyState();
-                }),
+                    return batchInfos;
+                }, "discard"),
                 commitChanges: (options) => {
                     const { squash } = { ...defaultStagingCommitOptions, ...options };
                     exitStagingMode(() => {
                         // Replay all staged batches in typical FIFO order.
                         // We'll be out of staging mode so they'll be sent to the service finally.
-                        this.pendingStateManager.replayPendingStates({
+                        return this.pendingStateManager.replayPendingStates({
                             committingStagedBatches: true,
                             squash,
                         });
-                    });
+                    }, "commit");
                 },
             };
             this.stageControls = stageControls;
@@ -870,14 +916,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             ? this.getConnectionState() === internal_1.ConnectionState.Connected ||
                 this.getConnectionState() === internal_1.ConnectionState.CatchingUp
             : undefined;
-        this.mc.logger.sendTelemetryEvent({
-            eventName: "GCFeatureMatrix",
-            metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
-            inputs: JSON.stringify({
-                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                gcOptions_gcGeneration: runtimeOptions.gcOptions[index_js_2.gcGenerationOptionName],
-            }),
-        });
         this.telemetryDocumentId = metadata?.telemetryDocumentId ?? (0, uuid_1.v4)();
         const opGroupingManager = new index_js_3.OpGroupingManager({
             groupedBatchingEnabled: this.groupedBatchingEnabled,
@@ -925,6 +963,10 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             this.closeFn(error);
             throw error;
         }
+        this.stagingModeAutoFlushThreshold =
+            this.mc.config.getNumber("Fluid.ContainerRuntime.StagingModeAutoFlushThreshold") ??
+                runtimeOptions.stagingModeAutoFlushThreshold ??
+                defaultStagingModeAutoFlushThreshold;
         this.batchIdTrackingEnabled =
             this.mc.config.getBoolean("Fluid.Container.enableOfflineFull") ??
                 this.mc.config.getBoolean("Fluid.ContainerRuntime.enableBatchIdTracking") ??
@@ -1034,9 +1076,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         this.deltaScheduler = new deltaScheduler_js_1.DeltaScheduler(this.innerDeltaManager, this, (0, internal_8.createChildLogger)({ logger: this.baseLogger, namespace: "DeltaScheduler" }));
         this.inboundBatchAggregator = new inboundBatchAggregator_js_1.InboundBatchAggregator(this.innerDeltaManager, () => this.clientId, (0, internal_8.createChildLogger)({ logger: this.baseLogger, namespace: "InboundBatchAggregator" }));
         const legacySendBatchFn = (0, exports.makeLegacySendBatchFn)(submitFn, this.innerDeltaManager);
-        this.skipSafetyFlushDuringProcessStack =
-            // Keep the old flag name even though we renamed the class member (it shipped in 2.31.0)
-            this.mc.config.getBoolean("Fluid.ContainerRuntime.DisableFlushBeforeProcess") === true;
         this.outbox = new index_js_3.Outbox({
             shouldSend: () => this.shouldSendOps(),
             pendingStateManager: this.pendingStateManager,
@@ -1047,8 +1086,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             config: {
                 compressionOptions,
                 maxBatchSizeInBytes: runtimeOptions.maxBatchSizeInBytes,
-                // If we disable flush before process, we must be ready to flush partial batches
-                flushPartialBatches: this.skipSafetyFlushDuringProcessStack,
             },
             logger: this.mc.logger,
             groupingManager: opGroupingManager,
@@ -1092,14 +1129,12 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // We haven't emitted dirty/saved yet, but this is the baseline so we know to emit when it changes
         this.lastEmittedDirty = this.computeCurrentDirtyState();
         context.updateDirtyContainerState(this.lastEmittedDirty);
-        if (!this.skipSafetyFlushDuringProcessStack) {
-            // Reference Sequence Number may have just changed, and it must be consistent across a batch,
-            // so we should flush now to clear the way for the next ops.
-            // NOTE: This will be redundant whenever CR.process was called for the op (since we flush there too) -
-            // But we need this coverage for old loaders that don't call ContainerRuntime.process for non-runtime messages.
-            // (We have to call flush _before_ processing a runtime op, but after is ok for non-runtime op)
-            this.deltaManager.on("op", () => this.flush());
-        }
+        // Reference Sequence Number may have just changed, and it must be consistent across a batch,
+        // so we should flush now to clear the way for the next ops.
+        // NOTE: This will be redundant whenever CR.process was called for the op (since we flush there too) -
+        // But we need this coverage for old loaders that don't call ContainerRuntime.process for non-runtime messages.
+        // (We have to call flush _before_ processing a runtime op, but after is ok for non-runtime op)
+        this.deltaManager.on("op", () => this.flush());
         // logging hardware telemetry
         this.baseLogger.send({
             category: "generic",
@@ -1113,7 +1148,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             summaryNumber: loadSummaryNumber,
             summaryFormatVersion: metadata?.summaryFormatVersion,
             disableIsolatedChannels: metadata?.disableIsolatedChannels,
+            // This is useful even for interactive clients since they track unreferenced nodes and log errors.
             gcVersion: metadata?.gcFeature,
+            gcConfigs: this.garbageCollector.serializedConfigs,
             options: JSON.stringify(runtimeOptions),
             idCompressorModeMetadata: metadata?.documentSchema?.runtime?.idCompressorMode,
             idCompressorMode: this.sessionSchema.idCompressorMode,
@@ -1121,7 +1158,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             featureGates: JSON.stringify({
                 ...featureGatesForTelemetry,
                 closeSummarizerDelayOverride,
-                disableFlushBeforeProcess: this.skipSafetyFlushDuringProcessStack,
             }),
             telemetryDocumentId: this.telemetryDocumentId,
             groupedBatchingEnabled: this.groupedBatchingEnabled,
@@ -1578,12 +1614,10 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         (0, internal_2.assert)(this.emitDirtyDocumentEvent, 0x127 /* "dirty document event not set on replay" */);
         this.emitDirtyDocumentEvent = false;
         try {
-            // Any ID Allocation ops that failed to submit after the pending state was queued need to have
-            // the corresponding ranges resubmitted (note this call replaces the typical resubmit flow).
-            // Since we don't submit ID Allocation ops when staged, any outstanding ranges would be from
-            // before staging mode so we can simply say staged: false.
-            this.submitIdAllocationOpIfNeeded({ resubmitOutstandingRanges: true, staged: false });
-            this.scheduleFlush();
+            // Any ID Allocation ops that failed to submit need to have their ranges included
+            // in the next allocation op. Reset the compressor's unfinalized range cursor so that the next
+            // call to takeNextCreationRange (during replay) will include those unfinalized ranges.
+            this._idCompressor?.resetUnfinalizedCreationRange();
             // replay the ops
             this.pendingStateManager.replayPendingStates();
         }
@@ -1804,10 +1838,8 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         // spread operator above ensure we make a shallow copy of message, as the processing flow will modify it.
         // There might be multiple container instances receiving the same message.
         this.verifyNotClosed();
-        if (!this.skipSafetyFlushDuringProcessStack) {
-            // Reference Sequence Number may be about to change, and it must be consistent across a batch, so flush now
-            this.flush();
-        }
+        // Reference Sequence Number may be about to change, and it must be consistent across a batch, so flush now
+        this.flush();
         this.ensureNoDataModelChanges(() => {
             this.processInboundMessageOrBatch(messageCopy, local);
         });
@@ -3038,6 +3070,17 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         this.updateDocumentDirtyState();
     }
     scheduleFlush() {
+        // During staging mode, suppress automatic flush scheduling until the main batch
+        // reaches or exceeds the threshold.
+        // Incoming ops still break the batch via direct this.flush() calls elsewhere
+        // (deltaManager "op" handler, process(), connection changes, getPendingLocalState,
+        // exitStagingMode). Those all bypass scheduleFlush(), so they're unaffected by this check.
+        // Additionally, outbox.maybeFlushPartialBatch() (called on every submit) detects
+        // sequence number changes and throws if unexpected changes are detected.
+        if (this.inStagingMode &&
+            this.outbox.mainBatchMessageCount < this.stagingModeAutoFlushThreshold) {
+            return;
+        }
         if (this.flushScheduled) {
             return;
         }
@@ -3332,7 +3375,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         return internal_8.PerformanceEvent.timedExec(this.mc.logger, {
             eventName: "getPendingLocalState",
         }, (event) => {
-            const pending = this.pendingStateManager.getLocalState(props?.snapshotSequenceNumber);
+            const { pending } = this.pendingStateManager.getLocalState(props?.snapshotSequenceNumber);
             const sessionExpiryTimerStarted = props?.sessionExpiryTimerStarted ?? this.garbageCollector.sessionExpiryTimerStarted;
             const pendingIdCompressorState = this._idCompressor?.serialize(true);
             const pendingAttachmentBlobs = this.blobManager.getPendingBlobs();