@fluidframework/container-runtime 2.13.0 → 2.21.0

package/lib/channelCollection.js

@@ -10,11 +10,14 @@ import { CreateSummarizerNodeSource, channelsTreeName, gcDataBlobKey, } from "@f
 import { GCDataBuilder, RequestParser, SummaryTreeBuilder, addBlobToSummary, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, create404Response, createResponseError, encodeCompactIdToString, isSerializedHandle, processAttachMessageGCData, responseToException, unpackChildNodesUsedRoutes, } from "@fluidframework/runtime-utils/internal";
 import { DataCorruptionError, DataProcessingError, LoggingError, createChildLogger, createChildMonitoringContext, extractSafePropertiesFromMessage, tagCodeArtifacts, } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
-import { DeletedResponseHeaderKey, defaultRuntimeHeaderData, } from "./containerRuntime.js";
+import { 
+// eslint-disable-next-line import/no-deprecated
+DeletedResponseHeaderKey, defaultRuntimeHeaderData, } from "./containerRuntime.js";
 import { channelToDataStore, isDataStoreAliasMessage, } from "./dataStore.js";
 import { LocalDetachedFluidDataStoreContext, LocalFluidDataStoreContext, RemoteFluidDataStoreContext, createAttributesBlob, } from "./dataStoreContext.js";
 import { DataStoreContexts } from "./dataStoreContexts.js";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry.js";
+// eslint-disable-next-line import/no-deprecated
 import { GCNodeType, urlToGCNodePath } from "./gc/index.js";
 import { ContainerMessageType } from "./messageTypes.js";
 import { StorageServiceWithAttachBlobs } from "./storageServiceWithAttachBlobs.js";
@@ -25,12 +28,17 @@ import { nonDataStorePaths, rootHasIsolatedChannels, } from "./summary/index.js"
  */
 export var RuntimeHeaders;
 (function (RuntimeHeaders) {
-    /** True to wait for a data store to be created and loaded before returning it. */
+    /**
+     * True to wait for a data store to be created and loaded before returning it.
+     */
     RuntimeHeaders["wait"] = "wait";
-    /** True if the request is coming from an IFluidHandle. */
+    /**
+     * 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
  * @legacy
  * @alpha
  */
@@ -155,9 +163,12 @@ export class ChannelCollection {
         this.pendingAttach = new Map();
         // 0.24 back-compat attachingBeforeSummary
         this.attachOpFiredForDataStore = new Set();
+        // eslint-disable-next-line unicorn/consistent-function-scoping -- Property is defined once; no need to extract inner lambda
         this.disposeOnce = new Lazy(() => this.contexts.dispose());
         this.pendingAliasMap = new Map();
-        /** For sampling. Only log once per container */
+        /**
+         * For sampling. Only log once per container
+         */
         this.shouldSendAttachLog = true;
         this.dispose = () => this.disposeOnce.value;
         this.mc = createChildMonitoringContext({ logger: baseLogger });
@@ -181,42 +192,42 @@ export class ChannelCollection {
                 unreferencedDataStoreCount++;
             }
             // If we have a detached container, then create local data store contexts.
-            if (this.parentContext.attachState !== AttachState.Detached) {
-                let snapshotForRemoteFluidDatastoreContext = value;
-                if (isInstanceOfISnapshot(baseSnapshot)) {
-                    snapshotForRemoteFluidDatastoreContext = {
-                        ...baseSnapshot,
-                        snapshotTree: value,
-                    };
+            if (this.parentContext.attachState === AttachState.Detached) {
+                if (typeof value !== "object") {
+                    throw new LoggingError("Snapshot should be there to load from!!");
                 }
-                dataStoreContext = new RemoteFluidDataStoreContext({
+                const snapshotTree = value;
+                dataStoreContext = new LocalFluidDataStoreContext({
                     id: key,
-                    snapshot: snapshotForRemoteFluidDatastoreContext,
+                    pkg: undefined,
                     parentContext: this.wrapContextForInnerChannel(key),
                     storage: this.parentContext.storage,
                     scope: this.parentContext.scope,
                     createSummarizerNodeFn: this.parentContext.getCreateChildSummarizerNodeFn(key, {
                         type: CreateSummarizerNodeSource.FromSummary,
                     }),
-                    loadingGroupId: value.groupId,
+                    makeLocallyVisibleFn: () => this.makeDataStoreLocallyVisible(key),
+                    snapshotTree,
                 });
             }
             else {
-                if (typeof value !== "object") {
-                    throw new LoggingError("Snapshot should be there to load from!!");
+                let snapshotForRemoteFluidDatastoreContext = value;
+                if (isInstanceOfISnapshot(baseSnapshot)) {
+                    snapshotForRemoteFluidDatastoreContext = {
+                        ...baseSnapshot,
+                        snapshotTree: value,
+                    };
                 }
-                const snapshotTree = value;
-                dataStoreContext = new LocalFluidDataStoreContext({
+                dataStoreContext = new RemoteFluidDataStoreContext({
                     id: key,
-                    pkg: undefined,
+                    snapshot: snapshotForRemoteFluidDatastoreContext,
                     parentContext: this.wrapContextForInnerChannel(key),
                     storage: this.parentContext.storage,
                     scope: this.parentContext.scope,
                     createSummarizerNodeFn: this.parentContext.getCreateChildSummarizerNodeFn(key, {
                         type: CreateSummarizerNodeSource.FromSummary,
                     }),
-                    makeLocallyVisibleFn: () => this.makeDataStoreLocallyVisible(key),
-                    snapshotTree,
+                    loadingGroupId: value.groupId,
                 });
             }
             this.contexts.addBoundOrRemoted(dataStoreContext);
@@ -366,7 +377,9 @@ export class ChannelCollection {
     alreadyProcessed(id) {
         return this.aliasMap.get(id) !== undefined || this.contexts.get(id) !== undefined;
     }
-    /** Package up the context's attach summary etc into an IAttachMessage */
+    /**
+     * Package up the context's attach summary etc into an IAttachMessage
+     */
     generateAttachMessage(localContext) {
         // Get the attach summary.
         const attachSummary = localContext.getAttachSummary();
@@ -447,13 +460,12 @@ export class ChannelCollection {
         return uuid();
     }
     createDetachedDataStore(pkg, loadingGroupId) {
-        return this.createContext(this.createDataStoreId(), pkg, LocalDetachedFluidDataStoreContext, undefined, // props
-        loadingGroupId);
+        return this.createContext(this.createDataStoreId(), pkg, LocalDetachedFluidDataStoreContext, loadingGroupId);
     }
-    createDataStoreContext(pkg, props, loadingGroupId) {
-        return this.createContext(this.createDataStoreId(), pkg, LocalFluidDataStoreContext, props, loadingGroupId);
+    createDataStoreContext(pkg, loadingGroupId) {
+        return this.createContext(this.createDataStoreId(), pkg, LocalFluidDataStoreContext, loadingGroupId);
     }
-    createContext(id, pkg, contextCtor, createProps, loadingGroupId) {
+    createContext(id, pkg, contextCtor, loadingGroupId) {
         assert(loadingGroupId !== "", 0x974 /* loadingGroupId should not be the empty string */);
         const context = new contextCtor({
             id,
@@ -466,7 +478,6 @@ export class ChannelCollection {
             }),
             makeLocallyVisibleFn: () => this.makeDataStoreLocallyVisible(id),
             snapshotTree: undefined,
-            createProps,
             loadingGroupId,
             channelToDataStoreFn: (channel) => channelToDataStore(channel, id, this, createChildLogger({ logger: this.parentContext.baseLogger })),
         });
@@ -479,13 +490,16 @@ export class ChannelCollection {
     reSubmit(type, content, localOpMetadata) {
         switch (type) {
             case ContainerMessageType.Attach:
-            case ContainerMessageType.Alias:
+            case ContainerMessageType.Alias: {
                 this.parentContext.submitMessage(type, content, localOpMetadata);
                 return;
-            case ContainerMessageType.FluidDataStoreOp:
+            }
+            case ContainerMessageType.FluidDataStoreOp: {
                 return this.reSubmitChannelOp(type, content, localOpMetadata);
-            default:
+            }
+            default: {
                 assert(false, 0x907 /* unknown op type */);
+            }
         }
     }
     reSubmitChannelOp(type, content, localOpMetadata) {
@@ -522,14 +536,18 @@ export class ChannelCollection {
     async applyStashedOp(content) {
         const opContents = content;
         switch (opContents.type) {
-            case ContainerMessageType.Attach:
+            case ContainerMessageType.Attach: {
                 return this.applyStashedAttachOp(opContents.contents);
-            case ContainerMessageType.Alias:
+            }
+            case ContainerMessageType.Alias: {
                 return;
-            case ContainerMessageType.FluidDataStoreOp:
+            }
+            case ContainerMessageType.FluidDataStoreOp: {
                 return this.applyStashedChannelChannelOp(opContents.contents);
-            default:
+            }
+            default: {
                 assert(false, 0x908 /* unknon type of op */);
+            }
         }
     }
     async applyStashedChannelChannelOp(envelope) {
@@ -577,7 +595,7 @@ export class ChannelCollection {
             // if the client is not detached put in the pending attach list
             // so that on ack of the stashed op, the context is found.
             // detached client don't send ops, so should not expect and ack.
-            this.pendingAttach.set(message.id, message);
+            this.pendingAttach.set(id, message);
         }
     }
     /**
@@ -586,17 +604,21 @@ export class ChannelCollection {
      */
     processMessages(messageCollection) {
         switch (messageCollection.envelope.type) {
-            case ContainerMessageType.FluidDataStoreOp:
+            case ContainerMessageType.FluidDataStoreOp: {
                 this.processChannelMessages(messageCollection);
                 break;
-            case ContainerMessageType.Attach:
+            }
+            case ContainerMessageType.Attach: {
                 this.processAttachMessages(messageCollection);
                 break;
-            case ContainerMessageType.Alias:
+            }
+            case ContainerMessageType.Alias: {
                 this.processAliasMessages(messageCollection);
                 break;
-            default:
+            }
+            default: {
                 assert(false, 0x8e9 /* unreached */);
+            }
         }
     }
     /**
@@ -623,7 +645,7 @@ export class ChannelCollection {
      * @param messageCollection - The collection of messages to process.
      */
     processChannelMessages(messageCollection) {
-        const { messagesContent, local } = messageCollection;
+        const { envelope, messagesContent, local } = messageCollection;
         let currentMessageState;
         let currentMessagesContent = [];
         // Helper that sends the current bunch of messages to the data store. It validates that the data stores exists.
@@ -635,7 +657,7 @@ export class ChannelCollection {
             const currentContext = this.contexts.get(currentMessageState.address);
             assert(!!currentContext, 0xa66 /* Context not found */);
             currentContext.processMessages({
-                envelope: { ...messageCollection.envelope, type: currentMessageState.type },
+                envelope: { ...envelope, type: currentMessageState.type },
                 messagesContent: currentMessagesContent,
                 local,
             });
@@ -657,10 +679,10 @@ export class ChannelCollection {
             }
             if (context === undefined) {
                 // Former assert 0x162
-                throw DataProcessingError.create("No context for op", "processFluidDataStoreOp", messageCollection.envelope, {
+                throw DataProcessingError.create("No context for op", "processFluidDataStoreOp", envelope, {
                     local,
                     messageDetails: JSON.stringify({
-                        type: messageCollection.envelope.type,
+                        type: envelope.type,
                         contentType: typeof contents,
                     }),
                     ...tagCodeArtifacts({ address }),
@@ -682,10 +704,10 @@ export class ChannelCollection {
             this.gcNodeUpdated({
                 node: { type: "DataStore", path: `/${address}` },
                 reason: "Changed",
-                timestampMs: messageCollection.envelope.timestamp,
+                timestampMs: envelope.timestamp,
                 packagePath: context.isLoaded ? context.packagePath : undefined,
             });
-            detectOutboundReferences(address, contextContents, (fromPath, toPath) => this.parentContext.addedGCOutboundRoute(fromPath, toPath, messageCollection.envelope.timestamp));
+            detectOutboundReferences(address, contextContents, (fromPath, toPath) => this.parentContext.addedGCOutboundRoute(fromPath, toPath, envelope.timestamp));
         }
         // Process the last bunch of messages, if any. Note that there may not be any messages in case all of them are
         // ignored because the data store is deleted.
@@ -696,6 +718,7 @@ export class ChannelCollection {
         if (this.checkAndLogIfDeleted(id, this.contexts.get(id), "Requested", "getDataStore", requestHeaderData, originalRequest)) {
             // The requested data store has been deleted by gc. Create a 404 response exception.
             throw responseToException(createResponseError(404, "DataStore was deleted", originalRequest, {
+                // eslint-disable-next-line import/no-deprecated
                 [DeletedResponseHeaderKey]: true,
             }), originalRequest);
         }
@@ -737,7 +760,7 @@ export class ChannelCollection {
         if (!this.isDataStoreDeleted(dataStoreNodePath)) {
             return false;
         }
-        const idToLog = originalRequest !== undefined ? urlToGCNodePath(originalRequest.url) : dataStoreNodePath;
+        const idToLog = originalRequest === undefined ? dataStoreNodePath : urlToGCNodePath(originalRequest.url);
         // Log the package details asynchronously since getInitialSnapshotDetails is async
         const recentlyDeletedContext = this.contexts.getRecentlyDeletedContext(id);
         if (recentlyDeletedContext !== undefined) {
@@ -776,6 +799,7 @@ export class ChannelCollection {
     processSignal(messageArg, local) {
         const envelope = messageArg.content;
         const fluidDataStoreId = envelope.address;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const message = { ...messageArg, content: envelope.contents };
         const context = this.contexts.get(fluidDataStoreId);
         // If the data store has been deleted, log an error and ignore this message. This helps prevent document
@@ -859,7 +883,7 @@ export class ChannelCollection {
             builder.prefixAndAddNodes(contextId, contextGCData.gcNodes);
         });
         // Get the outbound routes (aliased data stores) and add a GC node for this channel.
-        builder.addNode("/", Array.from(this.aliasedDataStores));
+        builder.addNode("/", [...this.aliasedDataStores]);
         return builder.getGCData();
     }
     /**
@@ -1024,7 +1048,7 @@ export class ChannelCollection {
             }
             this.deleteChild(dataStoreId);
         }
-        return Array.from(sweepReadyDataStoreRoutes);
+        return [...sweepReadyDataStoreRoutes];
     }
     /**
      * This is called to update objects whose routes are tombstones.
@@ -1073,12 +1097,14 @@ export class ChannelCollection {
         // If the node belongs to a data store, return its package path. For DDSes, we return the package path of the
         // data store that contains it.
         const context = this.contexts.get(nodePath.split("/")[1]);
-        return (await context?.getInitialSnapshotDetails())?.pkg;
+        const initialSnapshotDetails = await context?.getInitialSnapshotDetails();
+        return initialSnapshotDetails?.pkg;
     }
     /**
      * Called by GC to determine if a node is for a data store or for an object within a data store (for e.g. DDS).
      * @returns the GC node type if the node belongs to a data store or object within data store, undefined otherwise.
      */
+    // eslint-disable-next-line import/no-deprecated
     getGCNodeType(nodePath) {
         const pathParts = nodePath.split("/");
         if (!this.contexts.has(pathParts[1])) {
@@ -1087,8 +1113,10 @@ export class ChannelCollection {
         // Data stores paths are of the format "/dataStoreId".
         // Sub data store paths are of the format "/dataStoreId/subPath/...".
         if (pathParts.length === 2) {
+            // eslint-disable-next-line import/no-deprecated
             return GCNodeType.DataStore;
         }
+        // eslint-disable-next-line import/no-deprecated
         return GCNodeType.SubDataStore;
     }
     internalId(maybeAlias) {
@@ -1136,7 +1164,9 @@ export class ChannelCollection {
         return dataStore.request(subRequest);
     }
 }
-export function getSummaryForDatastores(snapshot, metadata) {
+export function getSummaryForDatastores(snapshot, 
+// eslint-disable-next-line import/no-deprecated
+metadata) {
     if (!snapshot) {
         return undefined;
     }
@@ -1189,9 +1219,13 @@ export function detectOutboundReferences(address, contents, addedOutboundReferen
     // GC node paths are all absolute paths, hence the "" prefix.
     // e.g. this will yield "/dataStoreId/ddsId"
     const fromPath = ["", address, ddsAddress].join("/");
-    outboundPaths.forEach((toPath) => addedOutboundReference(fromPath, toPath));
+    for (const toPath of outboundPaths) {
+        addedOutboundReference(fromPath, toPath);
+    }
 }
-/** @internal */
+/**
+ * @internal
+ */
 export class ChannelCollectionFactory {
     constructor(registryEntries, 
     // ADO:7302 We need a better type here