@fluidframework/container-runtime 2.0.0-internal.7.1.0 → 2.0.0-internal.7.2.0

package/lib/containerRuntime.js

@@ -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, shouldAllowGcTombstoneEnforcement, trimLeadingAndTrailingSlashes, } from "./gc";
+import { GarbageCollector, GCNodeType, gcTombstoneGenerationOptionName, trimLeadingAndTrailingSlashes, } from "./gc";
 import { channelToDataStore, isDataStoreAliasMessage } from "./dataStore";
 import { BindBatchTracker } from "./batchTracker";
 import { ScheduleManager } from "./scheduleManager";
@@ -44,6 +44,9 @@ function prepareLocalContainerRuntimeIdAllocationMessageForTransit(message) {
         delete message.contents.stashedState;
     }
 }
+/**
+ * @public
+ */
 export const DefaultSummaryConfiguration = {
     state: "enabled",
     minIdleTime: 0,
@@ -60,6 +63,7 @@ export const DefaultSummaryConfiguration = {
 };
 /**
  * Accepted header keys for requests coming to the runtime.
+ * @public
  */
 export var RuntimeHeaders;
 (function (RuntimeHeaders) {
@@ -68,13 +72,24 @@ export var RuntimeHeaders;
     /** True if the request is coming from an IFluidHandle. */
     RuntimeHeaders["viaHandle"] = "viaHandle";
 })(RuntimeHeaders || (RuntimeHeaders = {}));
-/** True if a tombstoned object should be returned without erroring */
+/** True if a tombstoned object should be returned without erroring
+ * @public
+ */
 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 */
+/**
+ * [IRRELEVANT IF throwOnInactiveLoad OPTION NOT SET] True if an inactive object should be returned without erroring
+ * @public
+ */
 export const AllowInactiveRequestHeaderKey = "allowInactive"; // Belongs in the enum above, but avoiding the breaking change
-/** Tombstone error responses will have this header set to true */
+/**
+ * Tombstone error responses will have this header set to true
+ * @public
+ */
 export const TombstoneResponseHeaderKey = "isTombstoned";
-/** Inactive error responses will have this header set to true */
+/**
+ * Inactive error responses will have this header set to true
+ * @public
+ */
 export const InactiveResponseHeaderKey = "isInactive";
 /** Default values for Runtime Headers */
 export const defaultRuntimeHeaderData = {
@@ -84,6 +99,7 @@ export const defaultRuntimeHeaderData = {
 };
 /**
  * Available compression algorithms for op compression.
+ * @public
  */
 export var CompressionAlgorithms;
 (function (CompressionAlgorithms) {
@@ -113,7 +129,8 @@ export const defaultPendingOpsRetryDelayMs = 1000;
  */
 const defaultCloseSummarizerDelayMs = 5000; // 5 seconds
 /**
- * @deprecated - use ContainerRuntimeMessageType instead
+ * @deprecated use ContainerRuntimeMessageType instead
+ * @public
  */
 export var RuntimeMessage;
 (function (RuntimeMessage) {
@@ -126,7 +143,8 @@ export var RuntimeMessage;
     RuntimeMessage["Operation"] = "op";
 })(RuntimeMessage || (RuntimeMessage = {}));
 /**
- * @deprecated - please use version in driver-utils
+ * @deprecated please use version in driver-utils
+ * @public
  */
 export function isRuntimeMessage(message) {
     return Object.values(RuntimeMessage).includes(message.type);
@@ -135,6 +153,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
  */
 export const agentSchedulerId = "_scheduler";
 // safely check navigator and get the hardware spec value
@@ -202,6 +221,7 @@ async function createSummarizer(loader, url) {
 }
 /**
  * This function is not supported publicly and exists for e2e testing
+ * @internal
  */
 export async function TEST_requestSummarizer(loader, url) {
     return createSummarizer(loader, url);
@@ -209,16 +229,17 @@ export async function TEST_requestSummarizer(loader, url) {
 /**
  * Represents the runtime of the container. Contains helper functions/state of the container.
  * It will define the store level mappings.
+ * @public
  */
 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
+     * @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.
+     * @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.
@@ -423,6 +444,18 @@ export class ContainerRuntime extends TypedEventEmitter {
             ? this.summaryConfiguration.initialSummarizerDelayMs
             : 0;
     }
+    /** If false, loading or using a Tombstoned object should merely log, not fail */
+    get gcTombstoneEnforcementAllowed() {
+        return this.garbageCollector.tombstoneEnforcementAllowed;
+    }
+    /** If true, throw an error when a tombstone data store is retrieved */
+    get gcThrowOnTombstoneLoad() {
+        return this.garbageCollector.throwOnTombstoneLoad;
+    }
+    /** If true, throw an error when a tombstone data store is used. */
+    get gcThrowOnTombstoneUsage() {
+        return this.garbageCollector.throwOnTombstoneUsage;
+    }
     /**
      * @internal
      */
@@ -527,7 +560,6 @@ export class ContainerRuntime extends TypedEventEmitter {
         // Note that we only need to pull the *initial* connected state from the context.
         // Later updates come through calls to setConnectionState.
         this._connected = connected;
-        this.gcTombstoneEnforcementAllowed = shouldAllowGcTombstoneEnforcement(metadata?.gcFeatureMatrix?.tombstoneGeneration /* persisted */, this.runtimeOptions.gcOptions[gcTombstoneGenerationOptionName] /* current */);
         this.mc.logger.sendTelemetryEvent({
             eventName: "GCFeatureMatrix",
             metadataValue: JSON.stringify(metadata?.gcFeatureMatrix),
@@ -801,7 +833,7 @@ 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. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
      */
     async request(request) {
         try {
@@ -850,7 +882,9 @@ export class ContainerRuntime extends TypedEventEmitter {
                     : create404Response(request);
             }
             else if (requestParser.pathParts.length > 0) {
-                const dataStore = await this.getDataStoreFromRequest(id, request);
+                // Differentiate between requesting the dataStore directly, or one of its children
+                const requestForChild = !requestParser.isLeaf(1);
+                const dataStore = await this.getDataStoreFromRequest(id, request, requestForChild);
                 const subRequest = requestParser.createSubRequest(1);
                 // We always expect createSubRequest to include a leading slash, but asserting here to protect against
                 // unintentionally modifying the url if that changes.
@@ -873,7 +907,7 @@ export class ContainerRuntime extends TypedEventEmitter {
     internalId(maybeAlias) {
         return this.dataStores.aliases.get(maybeAlias) ?? maybeAlias;
     }
-    async getDataStoreFromRequest(id, request) {
+    async getDataStoreFromRequest(id, request, requestForChild) {
         const headerData = {};
         if (typeof request.headers?.[RuntimeHeaders.wait] === "boolean") {
             headerData.wait = request.headers[RuntimeHeaders.wait];
@@ -884,6 +918,10 @@ export class ContainerRuntime extends TypedEventEmitter {
         if (typeof request.headers?.[AllowTombstoneRequestHeaderKey] === "boolean") {
             headerData.allowTombstone = request.headers[AllowTombstoneRequestHeaderKey];
         }
+        // We allow Tombstone requests for sub-DataStore objects
+        if (requestForChild) {
+            headerData.allowTombstone = true;
+        }
         await this.dataStores.waitIfPendingAlias(id);
         const internalId = this.internalId(id);
         const dataStoreContext = await this.dataStores.getDataStore(internalId, headerData);
@@ -1314,7 +1352,7 @@ export class ContainerRuntime extends TypedEventEmitter {
      * 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.
+     * @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) {
@@ -1482,15 +1520,22 @@ export class ContainerRuntime extends TypedEventEmitter {
      * Submits the signal to be sent to other clients.
      * @param type - Type of the signal.
      * @param content - Content of the signal.
+     * @param targetClientId - When specified, the signal is only sent to the provided client id.
      */
-    submitSignal(type, content) {
+    submitSignal(type, content, targetClientId) {
         this.verifyNotClosed();
         const envelope = this.createNewSignalEnvelope(undefined /* address */, type, content);
-        return this.submitSignalFn(envelope);
+        return this.submitSignalFn(envelope, targetClientId);
     }
-    submitDataStoreSignal(address, type, content) {
+    /**
+     * Submits the signal to be sent to other clients.
+     * @param type - Type of the signal.
+     * @param content - Content of the signal.
+     * @param targetClientId - When specified, the signal is only sent to the provided client id.
+     */
+    submitDataStoreSignal(address, type, content, targetClientId) {
         const envelope = this.createNewSignalEnvelope(address, type, content);
-        return this.submitSignalFn(envelope);
+        return this.submitSignalFn(envelope, targetClientId);
     }
     setAttachState(attachState) {
         if (attachState === AttachState.Attaching) {
@@ -1613,7 +1658,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         this.dataStores.updateUnusedRoutes(dataStoreRoutes);
     }
     /**
-     * @deprecated - Replaced by deleteSweepReadyNodes.
+     * @deprecated Replaced by deleteSweepReadyNodes.
      */
     deleteUnusedNodes(unusedRoutes) {
         throw new Error("deleteUnusedRoutes should not be called");
@@ -2349,11 +2394,11 @@ export class ContainerRuntime extends TypedEventEmitter {
          * and then close as the current main client is likely to be re-elected as the parent summarizer again.
          */
         if (!result.isSummaryTracked && result.isSummaryNewer) {
-            const fetchResult = await this.fetchSnapshotFromStorage(summaryLogger, {
+            const fetchResult = await this.fetchLatestSnapshotFromStorage(summaryLogger, {
                 eventName: "RefreshLatestSummaryAckFetch",
                 ackHandle,
                 targetSequenceNumber: summaryRefSeq,
-            }, readAndParseBlob, null);
+            }, readAndParseBlob);
             /**
              * If the fetched snapshot is older than the one for which the ack was received, close the container.
              * This should never happen because an ack should be sent after the latest summary is updated in the server.
@@ -2389,9 +2434,9 @@ export class ContainerRuntime extends TypedEventEmitter {
         const readAndParseBlob = async (id) => readAndParse(this.storage, id);
         // 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, {
+        await this.fetchLatestSnapshotFromStorage(summaryLogger, {
             eventName: "RefreshLatestSummaryFromServerFetch",
-        }, readAndParseBlob, null);
+        }, readAndParseBlob);
         await this.closeStaleSummarizer("RefreshLatestSummaryFromServerFetch");
         return {
             stage: "base",
@@ -2401,27 +2446,21 @@ export class ContainerRuntime extends TypedEventEmitter {
         };
     }
     async closeStaleSummarizer(codePath) {
-        this.mc.logger.sendTelemetryEvent({
-            eventName: "ClosingSummarizerOnSummaryStale",
-            codePath,
-            message: "Stopping fetch from storage",
-            closeSummarizerDelayMs: this.closeSummarizerDelayMs,
-        }, new GenericError("Restarting summarizer instead of refreshing"));
         // Delay before restarting summarizer to prevent the summarizer from restarting too frequently.
         await delay(this.closeSummarizerDelayMs);
         this._summarizer?.stop("latestSummaryStateStale");
         this.disposeFn();
     }
     /**
-     * Downloads snapshot from storage with the given versionId or latest if versionId is null.
+     * Downloads the latest snapshot from storage.
      * By default, it also closes the container after downloading the snapshot. However, this may be
      * overridden via options.
      */
-    async fetchSnapshotFromStorage(logger, event, readAndParseBlob, versionId) {
+    async fetchLatestSnapshotFromStorage(logger, event, readAndParseBlob) {
         return PerformanceEvent.timedExecAsync(logger, event, async (perfEvent) => {
             const stats = {};
             const trace = Trace.start();
-            const versions = await this.storage.getVersions(versionId, 1, "prefetchLatestSummaryBeforeClose", versionId === null ? FetchSource.noCache : undefined);
+            const versions = await this.storage.getVersions(null, 1, "prefetchLatestSummaryBeforeClose", FetchSource.noCache);
             assert(!!versions && !!versions[0], 0x137 /* "Failed to get version from storage" */);
             stats.getVersionDuration = trace.trace().duration;
             const maybeSnapshot = await this.storage.getSnapshotTree(versions[0]);
@@ -2446,6 +2485,7 @@ export class ContainerRuntime extends TypedEventEmitter {
         }, async (event) => {
             this.verifyNotClosed();
             const waitBlobsToAttach = props?.notifyImminentClosure;
+            const stopBlobAttachingSignal = props?.stopBlobAttachingSignal;
             if (this._orderSequentiallyCalls !== 0) {
                 throw new UsageError("can't get state during orderSequentially");
             }
@@ -2454,7 +2494,7 @@ export class ContainerRuntime extends TypedEventEmitter {
             // to close current batch.
             this.flush();
             const pendingAttachmentBlobs = waitBlobsToAttach
-                ? await this.blobManager.attachAndGetPendingBlobs()
+                ? await this.blobManager.attachAndGetPendingBlobs(stopBlobAttachingSignal)
                 : undefined;
             const pending = this.pendingStateManager.getLocalState();
             if (!pendingAttachmentBlobs && !this.hasPendingMessages()) {