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

package/lib/containerRuntime.js

@@ -3,7 +3,7 @@ import { assert, delay, LazyPromise } from "@fluidframework/core-utils";
 import { Trace, TypedEventEmitter } from "@fluid-internal/client-utils";
 import { createChildLogger, createChildMonitoringContext, DataCorruptionError, DataProcessingError, GenericError, raiseConnectedEvent, PerformanceEvent, 
 // eslint-disable-next-line import/no-deprecated
-TaggedLoggerAdapter, wrapError, UsageError, } from "@fluidframework/telemetry-utils";
+TaggedLoggerAdapter, wrapError, UsageError, LoggingError, } from "@fluidframework/telemetry-utils";
 import { DriverHeader, FetchSource, } from "@fluidframework/driver-definitions";
 import { readAndParse } from "@fluidframework/driver-utils";
 import { MessageType, SummaryType, } from "@fluidframework/protocol-definitions";
@@ -19,7 +19,7 @@ import { BlobManager } from "./blobManager";
 import { DataStores, getSummaryForDatastores } from "./dataStores";
 import { aliasBlobName, blobsTreeName, chunksBlobName, createRootSummarizerNodeWithGC, electedSummarizerBlobName, extractSummaryMetadataMessage, idCompressorBlobName, metadataBlobName, Summarizer, SummaryManager, wrapSummaryInChannelsTree, SummaryCollection, OrderedClientCollection, OrderedClientElection, SummarizerClientElection, summarizerClientType, RunWhileConnectedCoordinator, RetriableSummaryError, } from "./summary";
 import { formExponentialFn, Throttler } from "./throttler";
-import { GarbageCollector, GCNodeType, gcTombstoneGenerationOptionName, trimLeadingAndTrailingSlashes, } from "./gc";
+import { GarbageCollector, GCNodeType, gcGenerationOptionName, trimLeadingAndTrailingSlashes, } from "./gc";
 import { channelToDataStore, isDataStoreAliasMessage } from "./dataStore";
 import { BindBatchTracker } from "./batchTracker";
 import { ScheduleManager } from "./scheduleManager";
@@ -39,7 +39,7 @@ function compatBehaviorAllowsMessageType(_unknownContainerRuntimeMessageType, co
     return compatBehavior === "Ignore";
 }
 /**
- * @public
+ * @internal
  */
 export const DefaultSummaryConfiguration = {
     state: "enabled",
@@ -57,7 +57,7 @@ export const DefaultSummaryConfiguration = {
 };
 /**
  * Accepted header keys for requests coming to the runtime.
- * @public
+ * @internal
  */
 export var RuntimeHeaders;
 (function (RuntimeHeaders) {
@@ -67,22 +67,22 @@ export var RuntimeHeaders;
     RuntimeHeaders["viaHandle"] = "viaHandle";
 })(RuntimeHeaders || (RuntimeHeaders = {}));
 /** True if a tombstoned object should be returned without erroring
- * @public
+ * @internal
  */
 export const 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
  */
 export const AllowInactiveRequestHeaderKey = "allowInactive"; // Belongs in the enum above, but avoiding the breaking change
 /**
  * Tombstone error responses will have this header set to true
- * @public
+ * @internal
  */
 export const TombstoneResponseHeaderKey = "isTombstoned";
 /**
  * Inactive error responses will have this header set to true
- * @public
+ * @internal
  */
 export const InactiveResponseHeaderKey = "isInactive";
 /** Default values for Runtime Headers */
@@ -94,7 +94,7 @@ export const defaultRuntimeHeaderData = {
 };
 /**
  * Available compression algorithms for op compression.
- * @public
+ * @alpha
  */
 export var CompressionAlgorithms;
 (function (CompressionAlgorithms) {
@@ -125,7 +125,7 @@ export const defaultPendingOpsRetryDelayMs = 1000;
 const defaultCloseSummarizerDelayMs = 5000; // 5 seconds
 /**
  * @deprecated use ContainerRuntimeMessageType instead
- * @public
+ * @internal
  */
 export var RuntimeMessage;
 (function (RuntimeMessage) {
@@ -139,7 +139,7 @@ export var RuntimeMessage;
 })(RuntimeMessage || (RuntimeMessage = {}));
 /**
  * @deprecated please use version in driver-utils
- * @public
+ * @internal
  */
 export function isRuntimeMessage(message) {
     return Object.values(RuntimeMessage).includes(message.type);
@@ -148,7 +148,7 @@ export function isRuntimeMessage(message) {
  * 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
  */
 export const agentSchedulerId = "_scheduler";
 // safely check navigator and get the hardware spec value
@@ -203,7 +203,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 responseToException(response, request);
         }
@@ -214,54 +216,12 @@ async function createSummarizer(loader, url) {
     }
     return fluidObject.ISummarizer;
 }
-/**
- * This function is not supported publicly and exists for e2e testing
- * @internal
- */
-export async function TEST_requestSummarizer(loader, url) {
-    return createSummarizer(loader, url);
-}
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
- * @public
+ * @alpha
  */
 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:
@@ -341,16 +301,16 @@ export class ContainerRuntime extends TypedEventEmitter {
         const idCompressorEnabled = metadata?.idCompressorEnabled ?? runtimeOptions.enableRuntimeIdCompressor ?? false;
         let idCompressor;
         if (idCompressorEnabled) {
-            const { IdCompressor, createSessionId } = await import("./id-compressor");
+            const { createIdCompressor, deserializeIdCompressor, createSessionId } = await import("@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 ?? [], {
@@ -453,9 +413,7 @@ export class ContainerRuntime extends 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
         ...DefaultSummaryConfiguration,
@@ -470,6 +428,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         this._storage = _storage;
         this.requestHandler = requestHandler;
         this.summaryConfiguration = summaryConfiguration;
+        this.imminentClosure = false;
         this.defaultMaxConsecutiveReconnects = 7;
         this._orderSequentiallyCalls = 0;
         this.flushTaskExists = false;
@@ -561,7 +520,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             eventName: "GCFeatureMatrix",
             metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
             inputs: JSON.stringify({
-                gcOptions_gcTombstoneGeneration: this.runtimeOptions.gcOptions[gcTombstoneGenerationOptionName],
+                gcOptions_gcGeneration: this.runtimeOptions.gcOptions[gcGenerationOptionName],
             }),
         });
         this.telemetryDocumentId = metadata?.telemetryDocumentId ?? uuid();
@@ -627,6 +586,7 @@ export class ContainerRuntime extends 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 = createRootSummarizerNodeWithGC(createChildLogger({ logger: this.logger, namespace: "SummarizerNode" }), 
@@ -834,8 +794,9 @@ export class ContainerRuntime extends 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 = RequestParser.create(request);
@@ -1079,6 +1040,9 @@ export class ContainerRuntime extends TypedEventEmitter {
                 throw new Error("chunkedOp not expected here");
             case ContainerMessageType.Rejoin:
                 throw new Error("rejoin not expected here");
+            case ContainerMessageType.GC:
+                // GC op is only sent in summarizer which should never have stashed ops.
+                throw new 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,
@@ -1263,6 +1227,9 @@ export class ContainerRuntime extends TypedEventEmitter {
                     this.idCompressor.finalizeCreationRange(messageWithContext.message.contents);
                 }
                 break;
+            case ContainerMessageType.GC:
+                this.garbageCollector.processMessage(messageWithContext.message, local);
+                break;
             case ContainerMessageType.ChunkedOp:
             case ContainerMessageType.Rejoin:
                 break;
@@ -1346,23 +1313,6 @@ export class ContainerRuntime extends 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 });
-        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.
@@ -1452,7 +1402,6 @@ export class ContainerRuntime extends TypedEventEmitter {
     }
     /**
      * @deprecated 0.16 Issue #1537, #3631
-     * @internal
      */
     async _createDataStoreWithProps(pkg, props, id = uuid()) {
         return channelToDataStore(await this.dataStores
@@ -1462,7 +1411,7 @@ export class ContainerRuntime extends 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?
@@ -1484,19 +1433,28 @@ export class ContainerRuntime extends 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 === ContainerMessageType.Attach) {
-            const attachMessage = contents;
-            if (attachMessage.id === 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 ContainerMessageType.Attach: {
+                const attachMessage = contents;
+                if (attachMessage.id === agentSchedulerId) {
+                    return false;
+                }
+                break;
             }
-        }
-        else if (type === ContainerMessageType.FluidDataStoreOp) {
-            const envelope = contents;
-            if (envelope.address === agentSchedulerId) {
+            case ContainerMessageType.FluidDataStoreOp: {
+                const envelope = contents;
+                if (envelope.address === agentSchedulerId) {
+                    return false;
+                }
+                break;
+            }
+            case ContainerMessageType.GC: {
                 return false;
             }
+            default:
+                break;
         }
         return true;
     }
@@ -1787,10 +1745,10 @@ export class ContainerRuntime extends 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") ??
@@ -1810,7 +1768,7 @@ export class ContainerRuntime extends 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,
@@ -2035,7 +1993,7 @@ export class ContainerRuntime extends 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.
@@ -2045,7 +2003,7 @@ export class ContainerRuntime extends 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.
@@ -2315,6 +2273,7 @@ export class ContainerRuntime extends 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.
      */
@@ -2339,6 +2298,9 @@ export class ContainerRuntime extends TypedEventEmitter {
             case ContainerMessageType.Rejoin:
                 this.submit(message);
                 break;
+            case ContainerMessageType.GC:
+                // GC op is only sent in summarizer which should never reconnect.
+                throw new 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
@@ -2473,14 +2435,17 @@ export class ContainerRuntime extends TypedEventEmitter {
             };
         });
     }
-    notifyAttaching() { } // do nothing (deprecated method)
     async getPendingLocalState(props) {
         return 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 UsageError("can't get state during orderSequentially");
@@ -2489,7 +2454,7 @@ export class ContainerRuntime extends 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();