@fluidframework/container-runtime 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/dist/containerRuntime.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContainerRuntime = exports.TEST_requestSummarizer = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isRuntimeMessage = exports.RuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.CompressionAlgorithms = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.AllowInactiveRequestHeaderKey = exports.AllowTombstoneRequestHeaderKey = exports.RuntimeHeaders = exports.DefaultSummaryConfiguration = void 0;
+exports.ContainerRuntime = exports.makeLegacySendBatchFn = exports.getDeviceSpec = exports.agentSchedulerId = exports.isRuntimeMessage = exports.RuntimeMessage = exports.defaultPendingOpsRetryDelayMs = exports.defaultPendingOpsWaitTimeoutMs = exports.CompressionAlgorithms = exports.defaultRuntimeHeaderData = exports.InactiveResponseHeaderKey = exports.TombstoneResponseHeaderKey = exports.AllowInactiveRequestHeaderKey = exports.AllowTombstoneRequestHeaderKey = exports.RuntimeHeaders = exports.DefaultSummaryConfiguration = void 0;
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const core_utils_1 = require("@fluidframework/core-utils");
 const client_utils_1 = require("@fluid-internal/client-utils");
@@ -63,7 +63,7 @@ function compatBehaviorAllowsMessageType(_unknownContainerRuntimeMessageType, co
     return compatBehavior === "Ignore";
 }
 /**
- * @public
+ * @internal
  */
 exports.DefaultSummaryConfiguration = {
     state: "enabled",
@@ -81,7 +81,7 @@ exports.DefaultSummaryConfiguration = {
 };
 /**
  * Accepted header keys for requests coming to the runtime.
- * @public
+ * @internal
  */
 var RuntimeHeaders;
 (function (RuntimeHeaders) {
@@ -91,22 +91,22 @@ var RuntimeHeaders;
     RuntimeHeaders["viaHandle"] = "viaHandle";
 })(RuntimeHeaders || (exports.RuntimeHeaders = RuntimeHeaders = {}));
 /** True if a tombstoned object should be returned without erroring
- * @public
+ * @internal
  */
 exports.AllowTombstoneRequestHeaderKey = "allowTombstone"; // Belongs in the enum above, but avoiding the breaking change
 /**
  * [IRRELEVANT IF throwOnInactiveLoad OPTION NOT SET] True if an inactive object should be returned without erroring
- * @public
+ * @internal
  */
 exports.AllowInactiveRequestHeaderKey = "allowInactive"; // Belongs in the enum above, but avoiding the breaking change
 /**
  * Tombstone error responses will have this header set to true
- * @public
+ * @internal
  */
 exports.TombstoneResponseHeaderKey = "isTombstoned";
 /**
  * Inactive error responses will have this header set to true
- * @public
+ * @internal
  */
 exports.InactiveResponseHeaderKey = "isInactive";
 /** Default values for Runtime Headers */
@@ -118,7 +118,7 @@ exports.defaultRuntimeHeaderData = {
 };
 /**
  * Available compression algorithms for op compression.
- * @public
+ * @alpha
  */
 var CompressionAlgorithms;
 (function (CompressionAlgorithms) {
@@ -149,7 +149,7 @@ exports.defaultPendingOpsRetryDelayMs = 1000;
 const defaultCloseSummarizerDelayMs = 5000; // 5 seconds
 /**
  * @deprecated use ContainerRuntimeMessageType instead
- * @public
+ * @internal
  */
 var RuntimeMessage;
 (function (RuntimeMessage) {
@@ -163,7 +163,7 @@ var RuntimeMessage;
 })(RuntimeMessage || (exports.RuntimeMessage = RuntimeMessage = {}));
 /**
  * @deprecated please use version in driver-utils
- * @public
+ * @internal
  */
 function isRuntimeMessage(message) {
     return Object.values(RuntimeMessage).includes(message.type);
@@ -173,7 +173,7 @@ exports.isRuntimeMessage = isRuntimeMessage;
  * Legacy ID for the built-in AgentScheduler.  To minimize disruption while removing it, retaining this as a
  * special-case for document dirty state.  Ultimately we should have no special-cases from the
  * ContainerRuntime's perspective.
- * @public
+ * @internal
  */
 exports.agentSchedulerId = "_scheduler";
 // safely check navigator and get the hardware spec value
@@ -230,7 +230,9 @@ async function createSummarizer(loader, url) {
         fluidObject = await resolvedContainer.getEntryPoint();
     }
     else {
-        const response = await resolvedContainer.request({ url: `/${summarizerRequestUrl}` });
+        const response = await resolvedContainer.request({
+            url: `/${summarizerRequestUrl}`,
+        });
         if (response.status !== 200 || response.mimeType !== "fluid/object") {
             throw (0, runtime_utils_1.responseToException)(response, request);
         }
@@ -241,55 +243,12 @@ async function createSummarizer(loader, url) {
     }
     return fluidObject.ISummarizer;
 }
-/**
- * This function is not supported publicly and exists for e2e testing
- * @internal
- */
-async function TEST_requestSummarizer(loader, url) {
-    return createSummarizer(loader, url);
-}
-exports.TEST_requestSummarizer = TEST_requestSummarizer;
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
- * @public
+ * @alpha
  */
 class ContainerRuntime extends client_utils_1.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 telemetry_utils_1.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:
@@ -369,16 +328,16 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         const idCompressorEnabled = metadata?.idCompressorEnabled ?? runtimeOptions.enableRuntimeIdCompressor ?? false;
         let idCompressor;
         if (idCompressorEnabled) {
-            const { IdCompressor, createSessionId } = await Promise.resolve().then(() => __importStar(require("./id-compressor")));
+            const { createIdCompressor, deserializeIdCompressor, createSessionId } = await Promise.resolve().then(() => __importStar(require("@fluidframework/id-compressor")));
             const pendingLocalState = context.pendingLocalState;
             if (pendingLocalState?.pendingIdCompressorState !== undefined) {
-                idCompressor = IdCompressor.deserialize(pendingLocalState.pendingIdCompressorState);
+                idCompressor = deserializeIdCompressor(pendingLocalState.pendingIdCompressorState);
             }
             else if (serializedIdCompressor !== undefined) {
-                idCompressor = IdCompressor.deserialize(serializedIdCompressor, createSessionId());
+                idCompressor = deserializeIdCompressor(serializedIdCompressor, createSessionId());
             }
             else {
-                idCompressor = IdCompressor.create(logger);
+                idCompressor = createIdCompressor(logger);
             }
         }
         const runtime = new containerRuntimeCtor(context, registry, metadata, electedSummarizerData, chunks ?? [], aliases ?? [], {
@@ -481,9 +440,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     get gcThrowOnTombstoneUsage() {
         return this.garbageCollector.throwOnTombstoneUsage;
     }
-    /**
-     * @internal
-     */
+    /***/
     constructor(context, registry, metadata, electedSummarizerData, chunks, dataStoreAliasMap, runtimeOptions, containerScope, logger, existing, blobManagerSnapshot, _storage, idCompressor, provideEntryPoint, requestHandler, summaryConfiguration = {
         // the defaults
         ...exports.DefaultSummaryConfiguration,
@@ -498,6 +455,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         this._storage = _storage;
         this.requestHandler = requestHandler;
         this.summaryConfiguration = summaryConfiguration;
+        this.imminentClosure = false;
         this.defaultMaxConsecutiveReconnects = 7;
         this._orderSequentiallyCalls = 0;
         this.flushTaskExists = false;
@@ -589,7 +547,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             eventName: "GCFeatureMatrix",
             metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
             inputs: JSON.stringify({
-                gcOptions_gcTombstoneGeneration: this.runtimeOptions.gcOptions[gc_1.gcTombstoneGenerationOptionName],
+                gcOptions_gcGeneration: this.runtimeOptions.gcOptions[gc_1.gcGenerationOptionName],
             }),
         });
         this.telemetryDocumentId = metadata?.telemetryDocumentId ?? (0, uuid_1.v4)();
@@ -655,6 +613,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // GC runs in summarizer client and needs access to the real (non-proxy) active information. The proxy
             // delta manager would always return false for summarizer client.
             activeConnection: () => this.innerDeltaManager.active,
+            submitMessage: (message) => this.submit(message),
         });
         const loadedFromSequenceNumber = this.deltaManager.initialSequenceNumber;
         this.summarizerNode = (0, summary_1.createRootSummarizerNodeWithGC)((0, telemetry_utils_1.createChildLogger)({ logger: this.logger, namespace: "SummarizerNode" }), 
@@ -862,8 +821,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * Notifies this object about the request made to the container.
      * @param request - Request made to the handler.
-     * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
+     * @deprecated Will be removed in future major release. This method needs to stay private until LTS version of Loader moves to "2.0.0-internal.7.0.0".
      */
+    // @ts-expect-error expected to be used by LTS Loaders and Containers
     async request(request) {
         try {
             const parser = runtime_utils_1.RequestParser.create(request);
@@ -1107,6 +1067,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 throw new Error("chunkedOp not expected here");
             case messageTypes_1.ContainerMessageType.Rejoin:
                 throw new Error("rejoin not expected here");
+            case messageTypes_1.ContainerMessageType.GC:
+                // GC op is only sent in summarizer which should never have stashed ops.
+                throw new telemetry_utils_1.LoggingError("GC op not expected to be stashed in summarizer");
             default: {
                 // This should be extremely rare for stashed ops.
                 // It would require a newer runtime stashing ops and then an older one applying them,
@@ -1291,6 +1254,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                     this.idCompressor.finalizeCreationRange(messageWithContext.message.contents);
                 }
                 break;
+            case messageTypes_1.ContainerMessageType.GC:
+                this.garbageCollector.processMessage(messageWithContext.message, local);
+                break;
             case messageTypes_1.ContainerMessageType.ChunkedOp:
             case messageTypes_1.ContainerMessageType.Rejoin:
                 break;
@@ -1374,23 +1340,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         }
         this.dataStores.processSignal(envelope.address, transformed, local);
     }
-    /**
-     * Returns the runtime of the data store.
-     * @param id - Id supplied during creating the data store.
-     * @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);
-    }
-    async getRootDataStoreChannel(id, wait = true) {
-        await this.dataStores.waitIfPendingAlias(id);
-        const internalId = this.internalId(id);
-        const context = await this.dataStores.getDataStore(internalId, { wait });
-        (0, core_utils_1.assert)(await context.isRoot(), 0x12b /* "did not get root data store" */);
-        return context.realize();
-    }
     /**
      * Flush the pending ops manually.
      * This method is expected to be called at the end of a batch.
@@ -1480,7 +1429,6 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     }
     /**
      * @deprecated 0.16 Issue #1537, #3631
-     * @internal
      */
     async _createDataStoreWithProps(pkg, props, id = (0, uuid_1.v4)()) {
         return (0, dataStore_1.channelToDataStore)(await this.dataStores
@@ -1490,7 +1438,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     canSendOps() {
         // Note that the real (non-proxy) delta manager is needed here to get the readonly info. This is because
         // container runtime's ability to send ops depend on the actual readonly state of the delta manager.
-        return this.connected && !this.innerDeltaManager.readOnlyInfo.readonly;
+        return (this.connected && !this.innerDeltaManager.readOnlyInfo.readonly && !this.imminentClosure);
     }
     /**
      * Are we in the middle of batching ops together?
@@ -1512,19 +1460,28 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         return this.dirtyContainer;
     }
     isContainerMessageDirtyable({ type, contents }) {
-        // For legacy purposes, exclude the old built-in AgentScheduler from dirty consideration as a special-case.
-        // Ultimately we should have no special-cases from the ContainerRuntime's perspective.
-        if (type === messageTypes_1.ContainerMessageType.Attach) {
-            const attachMessage = contents;
-            if (attachMessage.id === exports.agentSchedulerId) {
-                return false;
+        // Certain container runtime messages should not mark the container dirty such as the old built-in
+        // AgentScheduler and Garbage collector messages.
+        switch (type) {
+            case messageTypes_1.ContainerMessageType.Attach: {
+                const attachMessage = contents;
+                if (attachMessage.id === exports.agentSchedulerId) {
+                    return false;
+                }
+                break;
             }
-        }
-        else if (type === messageTypes_1.ContainerMessageType.FluidDataStoreOp) {
-            const envelope = contents;
-            if (envelope.address === exports.agentSchedulerId) {
+            case messageTypes_1.ContainerMessageType.FluidDataStoreOp: {
+                const envelope = contents;
+                if (envelope.address === exports.agentSchedulerId) {
+                    return false;
+                }
+                break;
+            }
+            case messageTypes_1.ContainerMessageType.GC: {
                 return false;
             }
+            default:
+                break;
         }
         return true;
     }
@@ -1815,10 +1772,10 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
                 properties: { all: { safeSummary: true } },
             }));
         }
-        // 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
-        // within the timeout, check if it should be failed or can continue.
-        if (this.validateSummaryBeforeUpload && this.hasPendingMessages()) {
+        // If the container is dirty, i.e., 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 within the timeout, check if it should be failed or can continue.
+        if (this.validateSummaryBeforeUpload && this.isDirty) {
             const countBefore = this.pendingMessagesCount;
             // The timeout for waiting for pending ops can be overridden via configurations.
             const pendingOpsTimeout = this.mc.config.getNumber("Fluid.Summarizer.waitForPendingOpsTimeoutMs") ??
@@ -1838,7 +1795,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // happens, whether we attempted to wait for these ops to be acked and what was the result.
             summaryNumberLogger.sendTelemetryEvent({
                 eventName: "PendingOpsWhileSummarizing",
-                saved: this.hasPendingMessages() ? false : true,
+                saved: !this.isDirty,
                 timeout: pendingOpsTimeout,
                 countBefore,
                 countAfter: this.pendingMessagesCount,
@@ -2063,7 +2020,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
         }
     }
     /**
-     * This helper is called during summarization. If there are pending ops, it will return a failed summarize result
+     * This helper is called during summarization. If the container is dirty, it will return a failed summarize result
      * (IBaseSummarizeResult) unless this is the final summarize attempt and SkipFailingIncorrectSummary option is set.
      * @param logger - The logger to be used for sending telemetry.
      * @param referenceSequenceNumber - The reference sequence number of the summary attempt.
@@ -2073,7 +2030,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
      * @returns failed summarize result (IBaseSummarizeResult) if summary should be failed, undefined otherwise.
      */
     async shouldFailSummaryOnPendingOps(logger, referenceSequenceNumber, minimumSequenceNumber, finalAttempt, beforeSummaryGeneration) {
-        if (!this.hasPendingMessages()) {
+        if (!this.isDirty) {
             return;
         }
         // If "SkipFailingIncorrectSummary" option is true, don't fail the summary in the last attempt.
@@ -2343,6 +2300,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
     /**
      * Finds the right store and asks it to resubmit the message. This typically happens when we
      * reconnect and there are pending messages.
+     * ! Note: successfully resubmitting an op that has been successfully sequenced is not possible due to checks in the ConnectionStateHandler (Loader layer)
      * @param message - The original LocalContainerRuntimeMessage.
      * @param localOpMetadata - The local metadata associated with the original message.
      */
@@ -2367,6 +2325,9 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             case messageTypes_1.ContainerMessageType.Rejoin:
                 this.submit(message);
                 break;
+            case messageTypes_1.ContainerMessageType.GC:
+                // GC op is only sent in summarizer which should never reconnect.
+                throw new telemetry_utils_1.LoggingError("GC op not expected to be resubmitted in summarizer");
             default: {
                 // This case should be very rare - it would imply an op was stashed from a
                 // future version of runtime code and now is being applied on an older version
@@ -2501,14 +2462,17 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             };
         });
     }
-    notifyAttaching() { } // do nothing (deprecated method)
     async getPendingLocalState(props) {
         return telemetry_utils_1.PerformanceEvent.timedExecAsync(this.mc.logger, {
             eventName: "getPendingLocalState",
             notifyImminentClosure: props?.notifyImminentClosure,
         }, async (event) => {
             this.verifyNotClosed();
-            const waitBlobsToAttach = props?.notifyImminentClosure;
+            // in case imminentClosure is set to true by future code, we don't
+            // try to change its value
+            if (!this.imminentClosure) {
+                this.imminentClosure = props?.notifyImminentClosure ?? this.imminentClosure;
+            }
             const stopBlobAttachingSignal = props?.stopBlobAttachingSignal;
             if (this._orderSequentiallyCalls !== 0) {
                 throw new telemetry_utils_1.UsageError("can't get state during orderSequentially");
@@ -2517,7 +2481,7 @@ class ContainerRuntime extends client_utils_1.TypedEventEmitter {
             // getPendingLocalState() is only exposed through Container.closeAndGetPendingLocalState(), so it's safe
             // to close current batch.
             this.flush();
-            const pendingAttachmentBlobs = waitBlobsToAttach
+            const pendingAttachmentBlobs = this.imminentClosure
                 ? await this.blobManager.attachAndGetPendingBlobs(stopBlobAttachingSignal)
                 : undefined;
             const pending = this.pendingStateManager.getLocalState();