@fluidframework/container-runtime 2.0.0-internal.6.4.0 → 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";
@@ -169,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;
@@ -514,233 +728,9 @@ export class ContainerRuntime extends TypedEventEmitter {
                 assert(this._summarizer !== undefined, 0x5bf /* Summarizer object is undefined in a summarizer client */);
                 return this._summarizer;
             }
-            return initializeEntryPoint?.(this);
+            return provideEntryPoint(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);
-        });
-        // 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);
-        // 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;
-    }
-    /** @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.
      */
@@ -1283,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);
     }
@@ -2469,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 = {
@@ -2483,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) {