@fluidframework/container-runtime 2.0.0-internal.6.3.3 → 2.0.0-internal.7.0.0

package/lib/containerRuntime.js

@@ -8,7 +8,9 @@ import { DriverHeader, FetchSource, } from "@fluidframework/driver-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
 import { FlushMode, FlushModeExperimental, gcTreeKey, channelsTreeName, } from "@fluidframework/runtime-definitions";
-import { addBlobToSummary, addSummarizeResultToSummary, addTreeToSummary, RequestParser, create404Response, exceptionToResponse, GCDataBuilder, requestFluidObject, seqFromTree, calculateStats, TelemetryContext, } from "@fluidframework/runtime-utils";
+import { addBlobToSummary, addSummarizeResultToSummary, addTreeToSummary, RequestParser, create404Response, exceptionToResponse, GCDataBuilder, 
+// eslint-disable-next-line import/no-deprecated
+requestFluidObject, seqFromTree, calculateStats, TelemetryContext, } from "@fluidframework/runtime-utils";
 import { v4 as uuid } from "uuid";
 import { ContainerFluidHandleContext } from "./containerHandleContext";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry";
@@ -25,32 +27,12 @@ import { BindBatchTracker } from "./batchTracker";
 import { ScheduleManager } from "./scheduleManager";
 import { OpCompressor, OpDecompressor, Outbox, OpSplitter, RemoteMessageProcessor, OpGroupingManager, getLongStack, } from "./opLifecycle";
 import { DeltaManagerSummarizerProxy } from "./deltaManagerSummarizerProxy";
-export var ContainerMessageType;
-(function (ContainerMessageType) {
-    // An op to be delivered to store
-    ContainerMessageType["FluidDataStoreOp"] = "component";
-    // Creates a new store
-    ContainerMessageType["Attach"] = "attach";
-    // Chunked operation.
-    ContainerMessageType["ChunkedOp"] = "chunkedOp";
-    // Signifies that a blob has been attached and should not be garbage collected by storage
-    ContainerMessageType["BlobAttach"] = "blobAttach";
-    // Ties our new clientId to our old one on reconnect
-    ContainerMessageType["Rejoin"] = "rejoin";
-    // Sets the alias of a root data store
-    ContainerMessageType["Alias"] = "alias";
-    /**
-     * An op containing an IdRange of Ids allocated using the runtime's IdCompressor since
-     * the last allocation op was sent.
-     * See the [IdCompressor README](./id-compressor/README.md) for more details.
-     */
-    ContainerMessageType["IdAllocation"] = "idAllocation";
-})(ContainerMessageType || (ContainerMessageType = {}));
+import { ContainerMessageType, } from "./messageTypes";
 /**
  * Utility to implement compat behaviors given an unknown message type
  * The parameters are typed to support compile-time enforcement of handling all known types/behaviors
  *
- * @param _unknownContainerRuntimeMessageType - Typed as never, to ensure all known types have been
+ * @param _unknownContainerRuntimeMessageType - Typed as something unexpected, to ensure all known types have been
  * handled before calling this function (e.g. in a switch statement).
  * @param compatBehavior - Typed redundantly with CompatModeBehavior to ensure handling is added when updating that type
  */
@@ -58,6 +40,12 @@ function compatBehaviorAllowsMessageType(_unknownContainerRuntimeMessageType, co
     // undefined defaults to same behavior as "FailToProcess"
     return compatBehavior === "Ignore";
 }
+function prepareLocalContainerRuntimeIdAllocationMessageForTransit(message) {
+    // Remove the stashedState from the op if it's a stashed op
+    if ("stashedState" in message.contents) {
+        delete message.contents.stashedState;
+    }
+}
 export const DefaultSummaryConfiguration = {
     state: "enabled",
     minIdleTime: 0,
@@ -127,7 +115,7 @@ export const defaultPendingOpsRetryDelayMs = 1000;
  */
 const defaultCloseSummarizerDelayMs = 5000; // 5 seconds
 /**
- * @deprecated - use ContainerRuntimeMessage instead
+ * @deprecated - use ContainerRuntimeMessageType instead
  */
 export var RuntimeMessage;
 (function (RuntimeMessage) {
@@ -183,15 +171,227 @@ export const makeLegacySendBatchFn = (submitFn, deltaManager) => (batch) => {
  * It will define the store level mappings.
  */
 export class ContainerRuntime extends TypedEventEmitter {
+    /**
+     * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+     */
+    get IFluidRouter() {
+        return this;
+    }
+    /**
+     * @deprecated - use loadRuntime instead.
+     * Load the stores from a snapshot and returns the runtime.
+     * @param context - Context of the container.
+     * @param registryEntries - Mapping to the stores.
+     * @param requestHandler - Request handlers for the container runtime
+     * @param runtimeOptions - Additional options to be passed to the runtime
+     * @param existing - (optional) When loading from an existing snapshot. Precedes context.existing if provided
+     * @param containerRuntimeCtor - (optional) Constructor to use to create the ContainerRuntime instance. This
+     * allows mixin classes to leverage this method to define their own async initializer.
+     */
+    static async load(context, registryEntries, requestHandler, runtimeOptions = {}, containerScope = context.scope, existing, containerRuntimeCtor = ContainerRuntime) {
+        let existingFlag = true;
+        if (!existing) {
+            existingFlag = false;
+        }
+        return this.loadRuntime({
+            context,
+            registryEntries,
+            existing: existingFlag,
+            runtimeOptions,
+            containerScope,
+            containerRuntimeCtor,
+            requestHandler,
+            provideEntryPoint: () => {
+                throw new UsageError("ContainerRuntime.load is deprecated and should no longer be used");
+            },
+        });
+    }
+    /**
+     * Load the stores from a snapshot and returns the runtime.
+     * @param params - An object housing the runtime properties:
+     * - context - Context of the container.
+     * - registryEntries - Mapping from data store types to their corresponding factories.
+     * - existing - Pass 'true' if loading from an existing snapshot.
+     * - requestHandler - (optional) Request handler for the request() method of the container runtime.
+     * Only relevant for back-compat while we remove the request() method and move fully to entryPoint as the main pattern.
+     * - runtimeOptions - Additional options to be passed to the runtime
+     * - containerScope - runtime services provided with context
+     * - containerRuntimeCtor - Constructor to use to create the ContainerRuntime instance.
+     * This allows mixin classes to leverage this method to define their own async initializer.
+     * - provideEntryPoint - Promise that resolves to an object which will act as entryPoint for the Container.
+     * This object should provide all the functionality that the Container is expected to provide to the loader layer.
+     */
+    static async loadRuntime(params) {
+        const { context, registryEntries, existing, requestHandler, provideEntryPoint, runtimeOptions = {}, containerScope = {}, containerRuntimeCtor = ContainerRuntime, } = params;
+        // If taggedLogger exists, use it. Otherwise, wrap the vanilla logger:
+        // back-compat: Remove the TaggedLoggerAdapter fallback once all the host are using loader > 0.45
+        const backCompatContext = context;
+        const passLogger = backCompatContext.taggedLogger ??
+            // eslint-disable-next-line import/no-deprecated
+            new TaggedLoggerAdapter(backCompatContext.logger);
+        const logger = createChildLogger({
+            logger: passLogger,
+            properties: {
+                all: {
+                    runtimeVersion: pkgVersion,
+                },
+            },
+        });
+        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor = false, chunkSizeInBytes = defaultChunkSizeInBytes, enableOpReentryCheck = false, enableGroupedBatching = false, } = runtimeOptions;
+        const registry = new FluidDataStoreRegistry(registryEntries);
+        const tryFetchBlob = async (blobName) => {
+            const blobId = context.baseSnapshot?.blobs[blobName];
+            if (context.baseSnapshot && blobId) {
+                // IContainerContext storage api return type still has undefined in 0.39 package version.
+                // So once we release 0.40 container-defn package we can remove this check.
+                assert(context.storage !== undefined, 0x1f5 /* "Attached state should have storage" */);
+                return readAndParse(context.storage, blobId);
+            }
+        };
+        const [chunks, metadata, electedSummarizerData, aliases, serializedIdCompressor] = await Promise.all([
+            tryFetchBlob(chunksBlobName),
+            tryFetchBlob(metadataBlobName),
+            tryFetchBlob(electedSummarizerBlobName),
+            tryFetchBlob(aliasBlobName),
+            tryFetchBlob(idCompressorBlobName),
+        ]);
+        // read snapshot blobs needed for BlobManager to load
+        const blobManagerSnapshot = await BlobManager.load(context.baseSnapshot?.trees[blobsTreeName], async (id) => {
+            // IContainerContext storage api return type still has undefined in 0.39 package version.
+            // So once we release 0.40 container-defn package we can remove this check.
+            assert(context.storage !== undefined, 0x256 /* "storage undefined in attached container" */);
+            return readAndParse(context.storage, id);
+        });
+        // Verify summary runtime sequence number matches protocol sequence number.
+        const runtimeSequenceNumber = metadata?.message?.sequenceNumber;
+        // When we load with pending state, we reuse an old snapshot so we don't expect these numbers to match
+        if (!context.pendingLocalState && runtimeSequenceNumber !== undefined) {
+            const protocolSequenceNumber = context.deltaManager.initialSequenceNumber;
+            // Unless bypass is explicitly set, then take action when sequence numbers mismatch.
+            if (loadSequenceNumberVerification !== "bypass" &&
+                runtimeSequenceNumber !== protocolSequenceNumber) {
+                // "Load from summary, runtime metadata sequenceNumber !== initialSequenceNumber"
+                const error = new DataCorruptionError(
+                // pre-0.58 error message: SummaryMetadataMismatch
+                "Summary metadata mismatch", { runtimeVersion: pkgVersion, runtimeSequenceNumber, protocolSequenceNumber });
+                if (loadSequenceNumberVerification === "log") {
+                    logger.sendErrorEvent({ eventName: "SequenceNumberMismatch" }, error);
+                }
+                else {
+                    context.closeFn(error);
+                }
+            }
+        }
+        const idCompressorEnabled = metadata?.idCompressorEnabled ?? runtimeOptions.enableRuntimeIdCompressor ?? false;
+        let idCompressor;
+        if (idCompressorEnabled) {
+            const { IdCompressor, createSessionId } = await import("./id-compressor");
+            idCompressor =
+                serializedIdCompressor !== undefined
+                    ? IdCompressor.deserialize(serializedIdCompressor, createSessionId())
+                    : IdCompressor.create(logger);
+        }
+        const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], {
+            summaryOptions,
+            gcOptions,
+            loadSequenceNumberVerification,
+            flushMode,
+            compressionOptions,
+            maxBatchSizeInBytes,
+            chunkSizeInBytes,
+            enableRuntimeIdCompressor,
+            enableOpReentryCheck,
+            enableGroupedBatching,
+        }, containerScope, logger, existing, blobManagerSnapshot, context.storage, idCompressor, provideEntryPoint, requestHandler, undefined);
+        // 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);
+        // Initialize the base state of the runtime before it's returned.
+        await runtime.initializeBaseState();
+        return runtime;
+    }
+    get clientId() {
+        return this._getClientId();
+    }
+    get storage() {
+        return this._storage;
+    }
+    get flushMode() {
+        return this._flushMode;
+    }
+    get scope() {
+        return this.containerScope;
+    }
+    get IFluidDataStoreRegistry() {
+        return this.registry;
+    }
+    get attachState() {
+        return this._getAttachState();
+    }
+    get IFluidHandleContext() {
+        return this.handleContext;
+    }
+    /**
+     * Invokes the given callback and expects that no ops are submitted
+     * until execution finishes. If an op is submitted, an error will be raised.
+     *
+     * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`
+     *
+     * @param callback - the callback to be invoked
+     */
+    ensureNoDataModelChanges(callback) {
+        this.ensureNoDataModelChangesCalls++;
+        try {
+            return callback();
+        }
+        finally {
+            this.ensureNoDataModelChangesCalls--;
+        }
+    }
+    get connected() {
+        return this._connected;
+    }
+    /** clientId of parent (non-summarizing) container that owns summarizer container */
+    get summarizerClientId() {
+        return this.summarizerClientElection?.electedClientId;
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    get summarizer() {
+        assert(this._summarizer !== undefined, 0x257 /* "This is not summarizing container" */);
+        return this._summarizer;
+    }
+    isSummariesDisabled() {
+        return this.summaryConfiguration.state === "disabled";
+    }
+    isHeuristicsDisabled() {
+        return this.summaryConfiguration.state === "disableHeuristics";
+    }
+    getMaxOpsSinceLastSummary() {
+        return this.summaryConfiguration.state !== "disabled"
+            ? this.summaryConfiguration.maxOpsSinceLastSummary
+            : 0;
+    }
+    getInitialSummarizerDelayMs() {
+        // back-compat: initialSummarizerDelayMs was moved from ISummaryRuntimeOptions
+        //   to ISummaryConfiguration in 0.60.
+        if (this.runtimeOptions.summaryOptions.initialSummarizerDelayMs !== undefined) {
+            return this.runtimeOptions.summaryOptions.initialSummarizerDelayMs;
+        }
+        return this.summaryConfiguration.state !== "disabled"
+            ? this.summaryConfiguration.initialSummarizerDelayMs
+            : 0;
+    }
     /**
      * @internal
      */
-    constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, idCompressor, requestHandler, summaryConfiguration = {
+    constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, idCompressor, provideEntryPoint, requestHandler, summaryConfiguration = {
         // the defaults
         ...DefaultSummaryConfiguration,
         // the runtime configuration overrides
         ...runtimeOptions.summaryOptions?.summaryConfigOverrides,
-    }, initializeEntryPoint) {
+    }) {
         super();
         this.registry = registry;
         this.runtimeOptions = runtimeOptions;
@@ -495,26 +695,6 @@ export class ContainerRuntime extends TypedEventEmitter {
                 this.summaryManager.start();
             }
         }
-        this.deltaManager.on("readonly", (readonly) => {
-            // we accumulate ops while being in read-only state.
-            // once user gets write permissions and we have active connection, flush all pending ops.
-            // Note that the inner (non-proxy) delta manager is needed here to get the readonly information.
-            assert(readonly === this.innerDeltaManager.readOnlyInfo.readonly, 0x124 /* "inconsistent readonly property/event state" */);
-            // We need to be very careful with when we (re)send pending ops, to ensure that we only send ops
-            // when we either never send an op, or attempted to send it but we know for sure it was not
-            // sequenced by server and will never be sequenced (i.e. was lost)
-            // For loss of connection, we wait for our own "join" op and use it a a barrier to know all the
-            // ops that made it from previous connection, before switching clientId and raising "connected" event
-            // But with read-only permissions, if we transition between read-only and r/w states while on same
-            // connection, then we have no good signal to tell us when it's safe to send ops we accumulated while
-            // being in read-only state.
-            // For that reason, we support getting to read-only state only when disconnected. This ensures that we
-            // can rely on same safety mechanism and resend ops only when we establish new connection.
-            // This is applicable for read-only permissions (event is raised before connection is properly registered),
-            // but it's an extra requirement for Container.forceReadonly() API
-            assert(!readonly || !this.connected, 0x125 /* "Unsafe to transition to read-only state!" */);
-            this.replayPendingStates();
-        });
         // logging hardware telemetry
         logger.sendTelemetryEvent({
             eventName: "DeviceSpec",
@@ -548,233 +728,8 @@ export class ContainerRuntime extends TypedEventEmitter {
                 assert(this._summarizer !== undefined, 0x5bf /* Summarizer object is undefined in a summarizer client */);
                 return this._summarizer;
             }
-            return initializeEntryPoint?.(this);
-        });
-    }
-    /**
-     * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
-     */
-    get IFluidRouter() {
-        return this;
-    }
-    /**
-     * @deprecated - use loadRuntime instead.
-     * Load the stores from a snapshot and returns the runtime.
-     * @param context - Context of the container.
-     * @param registryEntries - Mapping to the stores.
-     * @param requestHandler - Request handlers for the container runtime
-     * @param runtimeOptions - Additional options to be passed to the runtime
-     * @param existing - (optional) When loading from an existing snapshot. Precedes context.existing if provided
-     * @param containerRuntimeCtor - (optional) Constructor to use to create the ContainerRuntime instance. This
-     * allows mixin classes to leverage this method to define their own async initializer.
-     */
-    static async load(context, registryEntries, requestHandler, runtimeOptions = {}, containerScope = context.scope, existing, containerRuntimeCtor = ContainerRuntime) {
-        let existingFlag = true;
-        if (!existing) {
-            existingFlag = false;
-        }
-        return this.loadRuntime({
-            context,
-            registryEntries,
-            existing: existingFlag,
-            requestHandler,
-            runtimeOptions,
-            containerScope,
-            containerRuntimeCtor,
-        });
-    }
-    /**
-     * Load the stores from a snapshot and returns the runtime.
-     * @param params - An object housing the runtime properties:
-     * - context - Context of the container.
-     * - registryEntries - Mapping from data store types to their corresponding factories.
-     * - existing - Pass 'true' if loading from an existing snapshot.
-     * - requestHandler - (optional) Request handler for the request() method of the container runtime.
-     * Only relevant for back-compat while we remove the request() method and move fully to entryPoint as the main pattern.
-     * - runtimeOptions - Additional options to be passed to the runtime
-     * - containerScope - runtime services provided with context
-     * - containerRuntimeCtor - Constructor to use to create the ContainerRuntime instance.
-     * This allows mixin classes to leverage this method to define their own async initializer.
-     * - initializeEntryPoint - Promise that resolves to an object which will act as entryPoint for the Container.
-     * This object should provide all the functionality that the Container is expected to provide to the loader layer.
-     */
-    static async loadRuntime(params) {
-        const { context, registryEntries, existing, requestHandler, runtimeOptions = {}, containerScope = {}, containerRuntimeCtor = ContainerRuntime, } = params;
-        const initializeEntryPoint = params.initializeEntryPoint ??
-            (async (containerRuntime) => ({
-                get IFluidRouter() {
-                    return this;
-                },
-                async request(req) {
-                    return containerRuntime.request(req);
-                },
-            }));
-        // If taggedLogger exists, use it. Otherwise, wrap the vanilla logger:
-        // back-compat: Remove the TaggedLoggerAdapter fallback once all the host are using loader > 0.45
-        const backCompatContext = context;
-        const passLogger = backCompatContext.taggedLogger ??
-            // eslint-disable-next-line import/no-deprecated
-            new TaggedLoggerAdapter(backCompatContext.logger);
-        const logger = createChildLogger({
-            logger: passLogger,
-            properties: {
-                all: {
-                    runtimeVersion: pkgVersion,
-                },
-            },
-        });
-        const { summaryOptions = {}, gcOptions = {}, loadSequenceNumberVerification = "close", flushMode = defaultFlushMode, compressionOptions = defaultCompressionConfig, maxBatchSizeInBytes = defaultMaxBatchSizeInBytes, enableRuntimeIdCompressor = false, chunkSizeInBytes = defaultChunkSizeInBytes, enableOpReentryCheck = false, enableGroupedBatching = false, } = runtimeOptions;
-        const registry = new FluidDataStoreRegistry(registryEntries);
-        const tryFetchBlob = async (blobName) => {
-            const blobId = context.baseSnapshot?.blobs[blobName];
-            if (context.baseSnapshot && blobId) {
-                // IContainerContext storage api return type still has undefined in 0.39 package version.
-                // So once we release 0.40 container-defn package we can remove this check.
-                assert(context.storage !== undefined, 0x1f5 /* "Attached state should have storage" */);
-                return readAndParse(context.storage, blobId);
-            }
-        };
-        const [chunks, metadata, electedSummarizerData, aliases, serializedIdCompressor] = await Promise.all([
-            tryFetchBlob(chunksBlobName),
-            tryFetchBlob(metadataBlobName),
-            tryFetchBlob(electedSummarizerBlobName),
-            tryFetchBlob(aliasBlobName),
-            tryFetchBlob(idCompressorBlobName),
-        ]);
-        // read snapshot blobs needed for BlobManager to load
-        const blobManagerSnapshot = await BlobManager.load(context.baseSnapshot?.trees[blobsTreeName], async (id) => {
-            // IContainerContext storage api return type still has undefined in 0.39 package version.
-            // So once we release 0.40 container-defn package we can remove this check.
-            assert(context.storage !== undefined, 0x256 /* "storage undefined in attached container" */);
-            return readAndParse(context.storage, id);
+            return provideEntryPoint(this);
         });
-        // Verify summary runtime sequence number matches protocol sequence number.
-        const runtimeSequenceNumber = metadata?.message?.sequenceNumber;
-        // When we load with pending state, we reuse an old snapshot so we don't expect these numbers to match
-        if (!context.pendingLocalState && runtimeSequenceNumber !== undefined) {
-            const protocolSequenceNumber = context.deltaManager.initialSequenceNumber;
-            // Unless bypass is explicitly set, then take action when sequence numbers mismatch.
-            if (loadSequenceNumberVerification !== "bypass" &&
-                runtimeSequenceNumber !== protocolSequenceNumber) {
-                // "Load from summary, runtime metadata sequenceNumber !== initialSequenceNumber"
-                const error = new DataCorruptionError(
-                // pre-0.58 error message: SummaryMetadataMismatch
-                "Summary metadata mismatch", { runtimeVersion: pkgVersion, runtimeSequenceNumber, protocolSequenceNumber });
-                if (loadSequenceNumberVerification === "log") {
-                    logger.sendErrorEvent({ eventName: "SequenceNumberMismatch" }, error);
-                }
-                else {
-                    context.closeFn(error);
-                }
-            }
-        }
-        const idCompressorEnabled = metadata?.idCompressorEnabled ?? runtimeOptions.enableRuntimeIdCompressor ?? false;
-        let idCompressor;
-        if (idCompressorEnabled) {
-            const { IdCompressor, createSessionId } = await import("./id-compressor");
-            idCompressor =
-                serializedIdCompressor !== undefined
-                    ? IdCompressor.deserialize(serializedIdCompressor, createSessionId())
-                    : IdCompressor.create(logger);
-        }
-        const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], {
-            summaryOptions,
-            gcOptions,
-            loadSequenceNumberVerification,
-            flushMode,
-            compressionOptions,
-            maxBatchSizeInBytes,
-            chunkSizeInBytes,
-            enableRuntimeIdCompressor,
-            enableOpReentryCheck,
-            enableGroupedBatching,
-        }, containerScope, logger, existing, blobManagerSnapshot, context.storage, idCompressor, requestHandler, undefined, // summaryConfiguration
-        initializeEntryPoint);
-        await runtime.blobManager.processStashedChanges();
-        // It's possible to have ops with a reference sequence number of 0. Op sequence numbers start
-        // at 1, so we won't see a replayed saved op with a sequence number of 0.
-        await runtime.pendingStateManager.applyStashedOpsAt(0);
-        // Initialize the base state of the runtime before it's returned.
-        await runtime.initializeBaseState();
-        return runtime;
-    }
-    get clientId() {
-        return this._getClientId();
-    }
-    get storage() {
-        return this._storage;
-    }
-    /** @deprecated - The functionality is no longer exposed publicly */
-    get reSubmitFn() {
-        return (type, contents, localOpMetadata, opMetadata) => this.reSubmitCore({ type, contents }, localOpMetadata, opMetadata);
-        // Note: compatDetails is not included in this deprecated API
-    }
-    get flushMode() {
-        return this._flushMode;
-    }
-    get scope() {
-        return this.containerScope;
-    }
-    get IFluidDataStoreRegistry() {
-        return this.registry;
-    }
-    get attachState() {
-        return this._getAttachState();
-    }
-    get IFluidHandleContext() {
-        return this.handleContext;
-    }
-    /**
-     * Invokes the given callback and expects that no ops are submitted
-     * until execution finishes. If an op is submitted, an error will be raised.
-     *
-     * Can be disabled by feature gate `Fluid.ContainerRuntime.DisableOpReentryCheck`
-     *
-     * @param callback - the callback to be invoked
-     */
-    ensureNoDataModelChanges(callback) {
-        this.ensureNoDataModelChangesCalls++;
-        try {
-            return callback();
-        }
-        finally {
-            this.ensureNoDataModelChangesCalls--;
-        }
-    }
-    get connected() {
-        return this._connected;
-    }
-    /** clientId of parent (non-summarizing) container that owns summarizer container */
-    get summarizerClientId() {
-        return this.summarizerClientElection?.electedClientId;
-    }
-    get disposed() {
-        return this._disposed;
-    }
-    get summarizer() {
-        assert(this._summarizer !== undefined, 0x257 /* "This is not summarizing container" */);
-        return this._summarizer;
-    }
-    isSummariesDisabled() {
-        return this.summaryConfiguration.state === "disabled";
-    }
-    isHeuristicsDisabled() {
-        return this.summaryConfiguration.state === "disableHeuristics";
-    }
-    getMaxOpsSinceLastSummary() {
-        return this.summaryConfiguration.state !== "disabled"
-            ? this.summaryConfiguration.maxOpsSinceLastSummary
-            : 0;
-    }
-    getInitialSummarizerDelayMs() {
-        // back-compat: initialSummarizerDelayMs was moved from ISummaryRuntimeOptions
-        //   to ISummaryConfiguration in 0.60.
-        if (this.runtimeOptions.summaryOptions.initialSummarizerDelayMs !== undefined) {
-            return this.runtimeOptions.summaryOptions.initialSummarizerDelayMs;
-        }
-        return this.summaryConfiguration.state !== "disabled"
-            ? this.summaryConfiguration.initialSummarizerDelayMs
-            : 0;
     }
     /**
      * Initializes the state from the base snapshot this container runtime loaded from.
@@ -1024,23 +979,24 @@ export class ContainerRuntime extends TypedEventEmitter {
      * 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) {
-        assert(serializedContent !== undefined, 0x6d5 /* content must be defined */);
-        const { type, contents, compatDetails } = JSON.parse(serializedContent);
-        assert(type !== undefined, 0x6d6 /* incorrect op content format */);
-        return { type, contents, compatDetails };
-    }
-    async applyStashedOp(op) {
+    // TODO: markfields: confirm Local- versus Outbound- ContainerRuntimeMessage typing
+    parseLocalOpContent(serializedContents) {
+        assert(serializedContents !== undefined, 0x6d5 /* content must be defined */);
+        const message = JSON.parse(serializedContents);
+        assert(message.type !== undefined, 0x6d6 /* incorrect op content format */);
+        return message;
+    }
+    async applyStashedOp(serializedOpContent) {
         // Need to parse from string for back-compat
-        const { type, contents, compatDetails } = this.parseOpContent(op);
-        switch (type) {
+        const opContents = this.parseLocalOpContent(serializedOpContent);
+        switch (opContents.type) {
             case ContainerMessageType.FluidDataStoreOp:
-                return this.dataStores.applyStashedOp(contents);
+                return this.dataStores.applyStashedOp(opContents.contents);
             case ContainerMessageType.Attach:
-                return this.dataStores.applyStashedAttachOp(contents);
+                return this.dataStores.applyStashedAttachOp(opContents.contents);
             case ContainerMessageType.IdAllocation:
                 assert(this.idCompressor !== undefined, 0x67b /* IdCompressor should be defined if enabled */);
-                return this.applyStashedIdAllocationOp(contents);
+                return this.applyStashedIdAllocationOp(opContents.contents);
             case ContainerMessageType.Alias:
             case ContainerMessageType.BlobAttach:
                 return;
@@ -1052,11 +1008,11 @@ export class ContainerRuntime extends TypedEventEmitter {
                 // This should be extremely rare for stashed ops.
                 // It would require a newer runtime stashing ops and then an older one applying them,
                 // e.g. if an app rolled back its container version
-                const compatBehavior = compatDetails?.behavior;
-                if (!compatBehaviorAllowsMessageType(type, compatBehavior)) {
+                const compatBehavior = opContents.compatDetails?.behavior;
+                if (!compatBehaviorAllowsMessageType(opContents.type, compatBehavior)) {
                     const error = DataProcessingError.create("Stashed runtime message of unknown type", "applyStashedOp", undefined /* sequencedMessage */, {
                         messageDetails: JSON.stringify({
-                            type,
+                            type: opContents.type,
                             compatBehavior,
                         }),
                     });
@@ -1075,6 +1031,23 @@ export class ContainerRuntime extends TypedEventEmitter {
             // Don't propagate "disconnected" event because we didn't propagate the previous "connected" event
             return;
         }
+        // If there are stashed blobs in the pending state, we need to delay
+        // propagation of the "connected" event until we have uploaded them to
+        // ensure we don't submit ops referencing a blob that has not been uploaded
+        const connecting = connected && !this._connected;
+        if (connecting && this.blobManager.hasPendingStashedBlobs()) {
+            assert(!this.delayConnectClientId, 0x791 /* Connect event delay must be canceled before subsequent connect event */);
+            assert(!!clientId, 0x792 /* Must have clientId when connecting */);
+            this.delayConnectClientId = clientId;
+            this.blobManager.processStashedChanges().then(() => {
+                // make sure we didn't reconnect before the promise resolved
+                if (this.delayConnectClientId === clientId && !this.disposed) {
+                    this.delayConnectClientId = undefined;
+                    this.setConnectionStateCore(connected, clientId);
+                }
+            }, (error) => this.closeFn(error));
+            return;
+        }
         this.setConnectionStateCore(connected, clientId);
     }
     setConnectionStateCore(connected, clientId) {
@@ -1127,18 +1100,33 @@ export class ContainerRuntime extends TypedEventEmitter {
         // or something different, like a system message.
         const modernRuntimeMessage = messageArg.type === MessageType.Operation;
         // Do shallow copy of message, as the processing flow will modify it.
+        // There might be multiple container instances receiving the same message.
+        // We do not need to make a deep copy. Each layer will just replace message.contents itself,
+        // but will not modify the contents object (likely it will replace it on the message).
         const messageCopy = { ...messageArg };
         for (const message of this.remoteMessageProcessor.process(messageCopy)) {
-            this.processCore(message, local, modernRuntimeMessage);
+            if (modernRuntimeMessage) {
+                this.processCore({
+                    // Cast it since we expect it to be this based on modernRuntimeMessage computation above.
+                    // There is nothing really ensuring that anytime original message.type is Operation that
+                    // the result messages will be so. In the end modern bool being true only directs to
+                    // throw error if ultimately unrecognized without compat details saying otherwise.
+                    message: message,
+                    local,
+                    modernRuntimeMessage,
+                });
+            }
+            else {
+                // Unrecognized message will be ignored.
+                this.processCore({ message, local, modernRuntimeMessage });
+            }
         }
     }
     /**
      * Direct the message to the correct subsystem for processing, and implement other side effects
-     * @param message - The unpacked message. Likely a ContainerRuntimeMessage, but could also be a system op
-     * @param local - Did this client send the op?
-     * @param modernRuntimeMessage - Does this appear like a current ContainerRuntimeMessage?
      */
-    processCore(message, local, modernRuntimeMessage) {
+    processCore(messageWithContext) {
+        const { message, local } = messageWithContext;
         // Surround the actual processing of the operation with messages to the schedule manager indicating
         // the beginning and end. This allows it to emit appropriate events and/or pause the processing of new
         // messages once a batch has been fully processed.
@@ -1146,16 +1134,18 @@ export class ContainerRuntime extends TypedEventEmitter {
         this._processedClientSequenceNumber = message.clientSequenceNumber;
         try {
             let localOpMetadata;
-            if (local && modernRuntimeMessage && message.type !== ContainerMessageType.ChunkedOp) {
-                localOpMetadata = this.pendingStateManager.processPendingLocalMessage(message);
+            if (local &&
+                messageWithContext.modernRuntimeMessage &&
+                message.type !== ContainerMessageType.ChunkedOp) {
+                localOpMetadata = this.pendingStateManager.processPendingLocalMessage(messageWithContext.message);
             }
             // If there are no more pending messages after processing a local message,
             // the document is no longer dirty.
             if (!this.hasPendingMessages()) {
                 this.updateDocumentDirtyState(false);
             }
-            this.validateAndProcessRuntimeMessage(message, localOpMetadata, local, modernRuntimeMessage);
-            this.emit("op", message, modernRuntimeMessage);
+            this.validateAndProcessRuntimeMessage(messageWithContext, localOpMetadata);
+            this.emit("op", message, messageWithContext.modernRuntimeMessage);
             this.scheduleManager.afterOpProcessing(undefined, message);
             if (local) {
                 // If we have processed a local op, this means that the container is
@@ -1170,29 +1160,29 @@ export class ContainerRuntime extends TypedEventEmitter {
         }
     }
     /**
-     * Assuming the given message is also a ContainerRuntimeMessage,
+     * Assuming the given message is also a TypedContainerRuntimeMessage,
      * checks its type and dispatches the message to the appropriate handler in the runtime.
-     * Throws a DataProcessingError if the message doesn't conform to the ContainerRuntimeMessage type.
+     * Throws a DataProcessingError if the message looks like but doesn't conform to a known TypedContainerRuntimeMessage type.
      */
-    validateAndProcessRuntimeMessage(message, localOpMetadata, local, expectRuntimeMessageType) {
-        // Optimistically extract ContainerRuntimeMessage-specific props from the message
-        const { type: maybeContainerMessageType, compatDetails } = message;
-        switch (maybeContainerMessageType) {
+    validateAndProcessRuntimeMessage(messageWithContext, localOpMetadata) {
+        // TODO: destructure message and modernRuntimeMessage once using typescript 5.2.2+
+        const { local } = messageWithContext;
+        switch (messageWithContext.message.type) {
             case ContainerMessageType.Attach:
-                this.dataStores.processAttachMessage(message, local);
+                this.dataStores.processAttachMessage(messageWithContext.message, local);
                 break;
             case ContainerMessageType.Alias:
-                this.dataStores.processAliasMessage(message, localOpMetadata, local);
+                this.dataStores.processAliasMessage(messageWithContext.message, localOpMetadata, local);
                 break;
             case ContainerMessageType.FluidDataStoreOp:
-                this.dataStores.processFluidDataStoreOp(message, local, localOpMetadata);
+                this.dataStores.processFluidDataStoreOp(messageWithContext.message, local, localOpMetadata);
                 break;
             case ContainerMessageType.BlobAttach:
-                this.blobManager.processBlobAttachOp(message, local);
+                this.blobManager.processBlobAttachOp(messageWithContext.message, local);
                 break;
             case ContainerMessageType.IdAllocation:
                 assert(this.idCompressor !== undefined, 0x67c /* IdCompressor should be defined if enabled */);
-                this.idCompressor.finalizeCreationRange(message.contents);
+                this.idCompressor.finalizeCreationRange(messageWithContext.message.contents);
                 break;
             case ContainerMessageType.ChunkedOp:
             case ContainerMessageType.Rejoin:
@@ -1200,11 +1190,12 @@ export class ContainerRuntime extends TypedEventEmitter {
             default: {
                 // If we didn't necessarily expect a runtime message type, then no worries - just return
                 // e.g. this case applies to system ops, or legacy ops that would have fallen into the above cases anyway.
-                if (!expectRuntimeMessageType) {
+                if (!messageWithContext.modernRuntimeMessage) {
                     return;
                 }
-                const compatBehavior = compatDetails?.behavior;
-                if (!compatBehaviorAllowsMessageType(maybeContainerMessageType, compatBehavior)) {
+                const compatBehavior = messageWithContext.message.compatDetails?.behavior;
+                if (!compatBehaviorAllowsMessageType(messageWithContext.message.type, compatBehavior)) {
+                    const { message } = messageWithContext;
                     const error = DataProcessingError.create(
                     // Former assert 0x3ce
                     "Runtime message of unknown type", "OpProcessing", message, {
@@ -1282,6 +1273,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * @param wait - True if you want to wait for it.
      * @deprecated - Use getAliasedDataStoreEntryPoint instead to get an aliased data store's entry point.
      */
+    // eslint-disable-next-line import/no-deprecated
     async getRootDataStore(id, wait = true) {
         return this.getRootDataStoreChannel(id, wait);
     }
@@ -1346,8 +1338,8 @@ export class ContainerRuntime extends TypedEventEmitter {
     /**
      * Returns the aliased data store's entryPoint, given the alias.
      * @param alias - The alias for the data store.
-     * @returns - The data store's entry point (IFluidHandle) if it exists and is aliased. Returns undefined if no
-     * data store has been assigned the given alias.
+     * @returns The data store's entry point ({@link @fluidframework/core-interfaces#IFluidHandle}) if it exists and is aliased.
+     * Returns undefined if no data store has been assigned the given alias.
      */
     async getAliasedDataStoreEntryPoint(alias) {
         await this.dataStores.waitIfPendingAlias(alias);
@@ -1586,7 +1578,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     /**
      * After GC has run and identified nodes that are sweep ready, this is called to delete the sweep ready nodes.
      * @param sweepReadyRoutes - The routes of nodes that are sweep ready and should be deleted.
-     * @returns - The routes of nodes that were deleted.
+     * @returns The routes of nodes that were deleted.
      */
     deleteSweepReadyNodes(sweepReadyRoutes) {
         const { dataStoreRoutes, blobManagerRoutes } = this.getDataStoreAndBlobManagerRoutes(sweepReadyRoutes);
@@ -1648,7 +1640,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     /**
      * From a given list of routes, separate and return routes that belong to blob manager and data stores.
      * @param routes - A list of routes that can belong to data stores or blob manager.
-     * @returns - Two route lists - One that contains routes for blob manager and another one that contains routes
+     * @returns Two route lists - One that contains routes for blob manager and another one that contains routes
      * for data stores.
      */
     getDataStoreAndBlobManagerRoutes(routes) {
@@ -1700,16 +1692,13 @@ 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
         let latestSnapshotVersionId;
-        if (refreshLatestAck) {
-            const latestSnapshotInfo = await this.refreshLatestSummaryAckFromServer(createChildLogger({
+        if (refreshLatestAck === true) {
+            return this.prefetchLatestSummaryThenClose(createChildLogger({
                 logger: summaryNumberLogger,
                 properties: { all: { safeSummary: true } },
             }));
-            const latestSnapshotRefSeq = latestSnapshotInfo.latestSnapshotRefSeq;
-            latestSnapshotVersionId = latestSnapshotInfo.latestSnapshotVersionId;
-            // We might need to catch up to the latest summary's reference sequence number before pausing.
-            await this.waitForDeltaManagerToCatchup(latestSnapshotRefSeq, summaryNumberLogger);
         }
         // If 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
@@ -2233,34 +2222,31 @@ export class ContainerRuntime extends TypedEventEmitter {
     }
     reSubmit(message) {
         // Need to parse from string for back-compat
-        const containerRuntimeMessage = this.parseOpContent(message.content);
+        const containerRuntimeMessage = this.parseLocalOpContent(message.content);
         this.reSubmitCore(containerRuntimeMessage, 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 message - The original ContainerRuntimeMessage.
+     * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
     reSubmitCore(message, localOpMetadata, opMetadata) {
-        const contents = message.contents;
         switch (message.type) {
             case ContainerMessageType.FluidDataStoreOp:
                 // For Operations, call resubmitDataStoreOp which will find the right store
                 // and trigger resubmission on it.
-                this.dataStores.resubmitDataStoreOp(contents, localOpMetadata);
+                this.dataStores.resubmitDataStoreOp(message.contents, localOpMetadata);
                 break;
             case ContainerMessageType.Attach:
             case ContainerMessageType.Alias:
                 this.submit(message, localOpMetadata);
                 break;
-            case ContainerMessageType.IdAllocation:
-                // Remove the stashedState from the op if it's a stashed op
-                if (contents.stashedState !== undefined) {
-                    delete contents.stashedState;
-                }
+            case ContainerMessageType.IdAllocation: {
+                prepareLocalContainerRuntimeIdAllocationMessageForTransit(message);
                 this.submit(message, localOpMetadata);
                 break;
+            }
             case ContainerMessageType.ChunkedOp:
                 throw new Error(`chunkedOp not expected here`);
             case ContainerMessageType.BlobAttach:
@@ -2294,7 +2280,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     }
     rollback(content, localOpMetadata) {
         // Need to parse from string for back-compat
-        const { type, contents } = this.parseOpContent(content);
+        const { type, contents } = this.parseLocalOpContent(content);
         switch (type) {
             case ContainerMessageType.FluidDataStoreOp:
                 // For operations, call rollbackDataStoreOp which will find the right store
@@ -2306,17 +2292,6 @@ export class ContainerRuntime extends TypedEventEmitter {
                 throw new Error(`Can't rollback ${type}`);
         }
     }
-    async waitForDeltaManagerToCatchup(latestSnapshotRefSeq, summaryLogger) {
-        if (latestSnapshotRefSeq > this.deltaManager.lastSequenceNumber) {
-            // We need to catch up to the latest summary's reference sequence number before proceeding.
-            await PerformanceEvent.timedExecAsync(summaryLogger, {
-                eventName: "WaitingForSeq",
-                lastSequenceNumber: this.deltaManager.lastSequenceNumber,
-                targetSequenceNumber: latestSnapshotRefSeq,
-                lastKnownSeqNumber: this.deltaManager.lastKnownSeqNumber,
-            }, async () => waitForSeq(this.deltaManager, latestSnapshotRefSeq), { start: true, end: true, cancel: "error" });
-        }
-    }
     /** Implementation of ISummarizerInternalsProvider.refreshLatestSummaryAck */
     async refreshLatestSummaryAck(options) {
         const { proposalHandle, ackHandle, summaryRefSeq, summaryLogger } = options;
@@ -2362,18 +2337,25 @@ export class ContainerRuntime extends TypedEventEmitter {
         await this.garbageCollector.refreshLatestSummary(result);
     }
     /**
-     * Fetches the latest snapshot from storage and uses it to refresh SummarizerNode's
-     * internal state as it should be considered the latest summary ack.
+     * 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 downloaded snapshot's reference sequence number
+     * @returns a generic summarization error
      */
-    async refreshLatestSummaryAckFromServer(summaryLogger) {
+    async prefetchLatestSummaryThenClose(summaryLogger) {
         const readAndParseBlob = async (id) => readAndParse(this.storage, id);
-        const { versionId, latestSnapshotRefSeq } = await this.fetchSnapshotFromStorage(summaryLogger, {
+        // 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.fetchSnapshotFromStorage(summaryLogger, {
             eventName: "RefreshLatestSummaryFromServerFetch",
         }, readAndParseBlob, null);
         await this.closeStaleSummarizer("RefreshLatestSummaryFromServerFetch");
-        return { latestSnapshotRefSeq, latestSnapshotVersionId: versionId };
+        return {
+            stage: "base",
+            error: "summary state stale - Unsupported option 'refreshLatestAck'",
+            referenceSequenceNumber: this.deltaManager.lastSequenceNumber,
+            minimumSequenceNumber: this.deltaManager.minimumSequenceNumber,
+        };
     }
     async closeStaleSummarizer(codePath) {
         this.mc.logger.sendTelemetryEvent({
@@ -2396,7 +2378,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         return PerformanceEvent.timedExecAsync(logger, event, async (perfEvent) => {
             const stats = {};
             const trace = Trace.start();
-            const versions = await this.storage.getVersions(versionId, 1, "refreshLatestSummaryAckFromServer", versionId === null ? FetchSource.noCache : undefined);
+            const versions = await this.storage.getVersions(versionId, 1, "prefetchLatestSummaryBeforeClose", versionId === null ? FetchSource.noCache : undefined);
             assert(!!versions && !!versions[0], 0x137 /* "Failed to get version from storage" */);
             stats.getVersionDuration = trace.trace().duration;
             const maybeSnapshot = await this.storage.getSnapshotTree(versions[0]);
@@ -2424,15 +2406,17 @@ export class ContainerRuntime extends TypedEventEmitter {
             if (this._orderSequentiallyCalls !== 0) {
                 throw new UsageError("can't get state during orderSequentially");
             }
-            const pendingAttachmentBlobs = await this.blobManager.getPendingBlobs(waitBlobsToAttach);
-            const pending = this.pendingStateManager.getLocalState();
-            if (!pendingAttachmentBlobs && !this.hasPendingMessages()) {
-                return; // no pending state to save
-            }
             // Flush pending batch.
             // getPendingLocalState() is only exposed through Container.closeAndGetPendingLocalState(), so it's safe
             // to close current batch.
             this.flush();
+            const pendingAttachmentBlobs = waitBlobsToAttach
+                ? await this.blobManager.attachAndGetPendingBlobs()
+                : undefined;
+            const pending = this.pendingStateManager.getLocalState();
+            if (!pendingAttachmentBlobs && !this.hasPendingMessages()) {
+                return; // no pending state to save
+            }
             const pendingState = {
                 pending,
                 pendingAttachmentBlobs,
@@ -2476,6 +2460,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * * Forms a function that will request a Summarizer.
      * @param loaderRouter - the loader acting as an IFluidRouter
      * */
+    // eslint-disable-next-line import/no-deprecated
     formRequestSummarizerFn(loaderRouter) {
         return async () => {
             const request = {
@@ -2490,6 +2475,7 @@ export class ContainerRuntime extends TypedEventEmitter {
                 },
                 url: "/_summarizer",
             };
+            // eslint-disable-next-line import/no-deprecated
             const fluidObject = await requestFluidObject(loaderRouter, request);
             const summarizer = fluidObject.ISummarizer;
             if (!summarizer) {
@@ -2514,26 +2500,4 @@ export class ContainerRuntime extends TypedEventEmitter {
         return killSwitch !== true && this.runtimeOptions.enableGroupedBatching;
     }
 }
-/**
- * Wait for a specific sequence number. Promise should resolve when we reach that number,
- * or reject if closed.
- */
-const waitForSeq = async (deltaManager, targetSeq) => new Promise((resolve, reject) => {
-    // TODO: remove cast to any when actual event is determined
-    deltaManager.on("closed", reject);
-    deltaManager.on("disposed", reject);
-    // If we already reached target sequence number, simply resolve the promise.
-    if (deltaManager.lastSequenceNumber >= targetSeq) {
-        resolve();
-    }
-    else {
-        const handleOp = (message) => {
-            if (message.sequenceNumber >= targetSeq) {
-                resolve();
-                deltaManager.off("op", handleOp);
-            }
-        };
-        deltaManager.on("op", handleOp);
-    }
-});
 //# sourceMappingURL=containerRuntime.js.map