@fluidframework/container-runtime 2.12.0 → 2.20.0

package/lib/containerRuntime.js

@@ -23,12 +23,13 @@ import { ContainerFluidHandleContext } from "./containerHandleContext.js";
 import { channelToDataStore } from "./dataStore.js";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry.js";
 import { DeltaManagerPendingOpsProxy, DeltaManagerSummarizerProxy, } from "./deltaManagerProxies.js";
+import { DeltaScheduler } from "./deltaScheduler.js";
 import { GCNodeType, GarbageCollector, gcGenerationOptionName, } from "./gc/index.js";
+import { InboundBatchAggregator } from "./inboundBatchAggregator.js";
 import { ContainerMessageType, } from "./messageTypes.js";
 import { DuplicateBatchDetector, ensureContentsDeserialized, OpCompressor, OpDecompressor, OpGroupingManager, OpSplitter, Outbox, RemoteMessageProcessor, serializeOpContents, } from "./opLifecycle/index.js";
 import { pkgVersion } from "./packageVersion.js";
 import { PendingStateManager, } from "./pendingStateManager.js";
-import { ScheduleManager } from "./scheduleManager.js";
 import { DocumentsSchemaController, OrderedClientCollection, OrderedClientElection, RetriableSummaryError, RunWhileConnectedCoordinator, Summarizer, SummarizerClientElection, SummaryCollection, SummaryManager, aliasBlobName, chunksBlobName, recentBatchInfoBlobName, createRootSummarizerNodeWithGC, electedSummarizerBlobName, extractSummaryMetadataMessage, idCompressorBlobName, metadataBlobName, rootHasIsolatedChannels, summarizerClientType, wrapSummaryInChannelsTree, } from "./summary/index.js";
 import { Throttler, formExponentialFn } from "./throttler.js";
 /**
@@ -89,7 +90,9 @@ export const TombstoneResponseHeaderKey = "isTombstoned";
  * to this was experimental and is no longer supported.
  */
 export const InactiveResponseHeaderKey = "isInactive";
-/** Default values for Runtime Headers */
+/**
+ * Default values for Runtime Headers
+ */
 export const defaultRuntimeHeaderData = {
     wait: true,
     viaHandle: false,
@@ -125,9 +128,13 @@ const defaultCompressionConfig = {
     compressionAlgorithm: CompressionAlgorithms.lz4,
 };
 const defaultChunkSizeInBytes = 204800;
-/** The default time to wait for pending ops to be processed during summarization */
+/**
+ * The default time to wait for pending ops to be processed during summarization
+ */
 export const defaultPendingOpsWaitTimeoutMs = 1000;
-/** The default time to delay a summarization retry attempt when there are pending ops */
+/**
+ * The default time to delay a summarization retry attempt when there are pending ops
+ */
 export const defaultPendingOpsRetryDelayMs = 1000;
 /**
  * Instead of refreshing from latest because we do not have 100% confidence in the state
@@ -153,6 +160,7 @@ export function getDeviceSpec() {
     try {
         if (typeof navigator === "object" && navigator !== null) {
             return {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
                 deviceMemory: navigator.deviceMemory,
                 hardwareConcurrency: navigator.hardwareConcurrency,
             };
@@ -203,12 +211,15 @@ async function createSummarizer(loader, url) {
         fluidObject = await resolvedContainer.getEntryPoint();
     }
     else {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
         const response = await resolvedContainer.request({
             url: `/${summarizerRequestUrl}`,
         });
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         if (response.status !== 200 || response.mimeType !== "fluid/object") {
             throw responseToException(response, request);
         }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
         fluidObject = response.value;
     }
     if (fluidObject?.ISummarizer === undefined) {
@@ -256,11 +267,7 @@ export async function loadContainerRuntime(params) {
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
  *
- * @deprecated To be removed from the Legacy-Alpha API in version 2.20.0.
- * Use the loadContainerRuntime function and interfaces IContainerRuntime / IRuntime instead.
- *
- * @legacy
- * @alpha
+ * @internal
  */
 export class ContainerRuntime extends TypedEventEmitter {
     /**
@@ -295,7 +302,9 @@ export class ContainerRuntime extends TypedEventEmitter {
             },
         });
         const mc = loggerToMonitoringContext(logger);
-        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor, chunkSizeInBytes = defaultChunkSizeInBytes, enableGroupedBatching = true, explicitSchemaControl = false, } = runtimeOptions;
+        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = runtimeOptions.enableGroupedBatching === false
+            ? disabledCompressionConfig // Compression must be disabled if Grouping is disabled
+            : defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor, chunkSizeInBytes = defaultChunkSizeInBytes, enableGroupedBatching = true, explicitSchemaControl = false, } = runtimeOptions;
         const registry = new FluidDataStoreRegistry(registryEntries);
         const tryFetchBlob = async (blobName) => {
             const blobId = context.baseSnapshot?.blobs[blobName];
@@ -424,6 +433,9 @@ export class ContainerRuntime extends TypedEventEmitter {
         }, (schema) => {
             runtime.onSchemaChange(schema);
         });
+        if (compressionLz4 && !enableGroupedBatching) {
+            throw new UsageError("If compression is enabled, op grouping must be enabled too");
+        }
         const featureGatesForTelemetry = {};
         // Make sure we've got all the options including internal ones
         const internalRuntimeOptions = {
@@ -484,7 +496,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * has to deal with compressed ops as other clients might send them.
      * And in reverse, session schema can have compression Off, but feature gates / runtime options want it On.
      * In such case it will be off in session schema, however this client will propose change to schema, and once / if
-     * this op rountrips, compression will be On. Client can't send compressed ops until it's change in schema.
+     * this op roundtrips, compression will be On. Client can't send compressed ops until it's change in schema.
      */
     get sessionSchema() {
         return this.documentsSchemaController.sessionSchema.runtime;
@@ -493,7 +505,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         return this.sessionSchema.idCompressorMode;
     }
     /**
-     * See IContainerRuntimeBase.idCompressor() for details.
+     * {@inheritDoc @fluidframework/runtime-definitions#IContainerRuntimeBase.idCompressor}
      */
     get idCompressor() {
         // Expose ID Compressor only if it's On from the start.
@@ -506,7 +518,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         }
     }
     /**
-     * See IContainerRuntimeBase.generateDocumentUniqueId() for details.
+     * {@inheritDoc @fluidframework/runtime-definitions#IContainerRuntimeBase.generateDocumentUniqueId}
      */
     generateDocumentUniqueId() {
         return this._idCompressor?.generateDocumentUniqueId() ?? uuid();
@@ -542,7 +554,9 @@ export class ContainerRuntime extends TypedEventEmitter {
     get connected() {
         return this._connected;
     }
-    /** clientId of parent (non-summarizing) container that owns summarizer container */
+    /**
+     * clientId of parent (non-summarizing) container that owns summarizer container
+     */
     get summarizerClientId() {
         return this.summarizerClientElection?.electedClientId;
     }
@@ -640,7 +654,6 @@ export class ContainerRuntime extends TypedEventEmitter {
         // Backfill in defaults for the internal runtimeOptions, since they may not be present on the provided runtimeOptions object
         this.runtimeOptions = {
             flushMode: defaultFlushMode,
-            enableGroupedBatching: true,
             ...runtimeOptions,
         };
         this.logger = createChildLogger({ logger: this.baseLogger });
@@ -719,6 +732,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             eventName: "GCFeatureMatrix",
             metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
             inputs: JSON.stringify({
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                 gcOptions_gcGeneration: this.runtimeOptions.gcOptions[gcGenerationOptionName],
             }),
         });
@@ -727,8 +741,6 @@ export class ContainerRuntime extends TypedEventEmitter {
         const opGroupingManager = new OpGroupingManager({
             groupedBatchingEnabled: this.groupedBatchingEnabled,
             opCountThreshold: this.mc.config.getNumber("Fluid.ContainerRuntime.GroupedBatchingOpCount") ?? 2,
-            reentrantBatchGroupingEnabled: this.mc.config.getBoolean("Fluid.ContainerRuntime.GroupedBatchingReentrancy") ??
-                true,
         }, this.mc.logger);
         const opSplitter = new OpSplitter(chunks, this.submitBatchFn, runtimeOptions.chunkSizeInBytes, runtimeOptions.maxBatchSizeInBytes, this.mc.logger);
         this.remoteMessageProcessor = new RemoteMessageProcessor(opSplitter, new OpDecompressor(this.mc.logger), opGroupingManager);
@@ -879,7 +891,8 @@ export class ContainerRuntime extends TypedEventEmitter {
             stashedBlobs: pendingRuntimeState?.pendingAttachmentBlobs,
             closeContainer: (error) => this.closeFn(error),
         });
-        this.scheduleManager = new ScheduleManager(this.innerDeltaManager, this, () => this.clientId, createChildLogger({ logger: this.logger, namespace: "ScheduleManager" }));
+        this.deltaScheduler = new DeltaScheduler(this.innerDeltaManager, this, createChildLogger({ logger: this.logger, namespace: "DeltaScheduler" }));
+        this.inboundBatchAggregator = new InboundBatchAggregator(this.innerDeltaManager, () => this.clientId, createChildLogger({ logger: this.logger, namespace: "InboundBatchAggregator" }));
         const disablePartialFlush = this.mc.config.getBoolean("Fluid.ContainerRuntime.DisablePartialFlush");
         const legacySendBatchFn = makeLegacySendBatchFn(this.submitFn, this.innerDeltaManager);
         this.outbox = new Outbox({
@@ -1061,13 +1074,14 @@ export class ContainerRuntime extends TypedEventEmitter {
     deleteChildSummarizerNode(id) {
         return this.summarizerNode.deleteChild(id);
     }
-    /* IFluidParentContext APIs that should not be called on Root */
+    // #region `IFluidParentContext` APIs that should not be called on Root
     makeLocallyVisible() {
         assert(false, 0x8eb /* should not be called */);
     }
     setChannelDirty(address) {
         assert(false, 0x909 /* should not be called */);
     }
+    // #endregion
     /**
      * Initializes the state from the base snapshot this container runtime loaded from.
      */
@@ -1098,6 +1112,8 @@ export class ContainerRuntime extends TypedEventEmitter {
         this._summarizer?.dispose();
         this.channelCollection.dispose();
         this.pendingStateManager.dispose();
+        this.inboundBatchAggregator.dispose();
+        this.deltaScheduler.dispose();
         this.emit("dispose");
         this.removeAllListeners();
     }
@@ -1270,7 +1286,9 @@ export class ContainerRuntime extends TypedEventEmitter {
     internalId(maybeAlias) {
         return this.channelCollection.internalId(maybeAlias);
     }
-    /** Adds the container's metadata to the given summary tree. */
+    /**
+     * Adds the container's metadata to the given summary tree.
+     */
     addMetadataToSummary(summaryTree) {
         // The last message processed at the time of summary. If there are no new messages, use the message from the
         // last summary.
@@ -1639,7 +1657,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         }
     }
     /**
-     * Processes inbound message(s). It calls schedule manager according to the messages' location in the batch.
+     * Processes inbound message(s). It calls delta scheduler according to the messages' location in the batch.
      * @param messagesWithMetadata - messages to process along with their metadata.
      * @param locationInBatch - Are we processing the start and/or end of a batch?
      * @param local - true if the messages were originally generated by the client receiving it.
@@ -1651,7 +1669,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         if (locationInBatch.batchStart) {
             const firstMessage = messagesWithMetadata[0]?.message;
             assert(firstMessage !== undefined, 0xa31 /* Batch must have at least one message */);
-            this.scheduleManager.batchBegin(firstMessage);
+            this.emit("batchBegin", firstMessage);
         }
         let error;
         try {
@@ -1663,7 +1681,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 });
                 return;
             }
-            // Helper that updates a message's minimum sequence number to the minimum sequence number that container
+            // Updates a message's minimum sequence number to the minimum sequence number that container
             // runtime is tracking and sets _processedClientSequenceNumber. It returns the updated message.
             const updateSequenceNumbers = (message) => {
                 // Set the minimum sequence number to the containerRuntime's understanding of minimum sequence number.
@@ -1694,7 +1712,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             }
             let bunchedMessagesContent = [];
             let previousMessage;
-            // Helper that processes the previous bunch of messages.
+            // Process the previous bunch of messages.
             const sendBunchedMessages = () => {
                 assert(previousMessage !== undefined, 0xa67 /* previous message must exist */);
                 this.ensureNoDataModelChanges(() => {
@@ -1736,7 +1754,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             if (locationInBatch.batchEnd) {
                 const lastMessage = messagesWithMetadata[messagesWithMetadata.length - 1]?.message;
                 assert(lastMessage !== undefined, 0xa32 /* Batch must have at least one message */);
-                this.scheduleManager.batchEnd(error, lastMessage);
+                this.emit("batchEnd", error, lastMessage);
             }
         }
     }
@@ -2043,15 +2061,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         return this.channelCollection.createDetachedDataStore(pkg, loadingGroupId);
     }
     async createDataStore(pkg, loadingGroupId) {
-        const context = this.channelCollection.createDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], undefined, // props
-        loadingGroupId);
-        return channelToDataStore(await context.realize(), context.id, this.channelCollection, this.mc.logger);
-    }
-    /**
-     * @deprecated 0.16 Issue #1537, #3631
-     */
-    async _createDataStoreWithProps(pkg, props) {
-        const context = this.channelCollection.createDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], props);
+        const context = this.channelCollection.createDataStoreContext(Array.isArray(pkg) ? pkg : [pkg], loadingGroupId);
         return channelToDataStore(await context.realize(), context.id, this.channelCollection, this.mc.logger);
     }
     canSendOps() {
@@ -2078,7 +2088,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     get isDirty() {
         return this.dirtyContainer;
     }
-    isContainerMessageDirtyable({ type, contents }) {
+    isContainerMessageDirtyable({ type, contents, }) {
         // Certain container runtime messages should not mark the container dirty such as the old built-in
         // AgentScheduler and Garbage collector messages.
         switch (type) {
@@ -2744,7 +2754,11 @@ export class ContainerRuntime extends TypedEventEmitter {
             this.emit(dirty ? "dirty" : "saved");
         }
     }
-    submitMessage(type, contents, localOpMetadata = undefined) {
+    submitMessage(type, 
+    // TODO: better typing
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
+    contents, localOpMetadata = undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         this.submit({ type, contents }, localOpMetadata);
     }
     async uploadBlob(blob, signal) {
@@ -2974,7 +2988,9 @@ export class ContainerRuntime extends TypedEventEmitter {
                 throw new Error(`Can't rollback ${type}`);
         }
     }
-    /** Implementation of ISummarizerInternalsProvider.refreshLatestSummaryAck */
+    /**
+     * Implementation of ISummarizerInternalsProvider.refreshLatestSummaryAck
+     */
     async refreshLatestSummaryAck(options) {
         const { proposalHandle, ackHandle, summaryRefSeq, summaryLogger } = options;
         // proposalHandle is always passed from RunningSummarizer.