@fluidframework/container-runtime 2.0.0-dev-rc.5.0.0.268409 → 2.0.0-dev-rc.5.0.0.270987

package/lib/channelCollection.js

@@ -6,15 +6,15 @@ import { AttachState } from "@fluidframework/container-definitions";
 import { assert, Lazy, LazyPromise } from "@fluidframework/core-utils/internal";
 import { FluidObjectHandle } from "@fluidframework/datastore/internal";
 import { buildSnapshotTree, getSnapshotTree, isInstanceOfISnapshot, } from "@fluidframework/driver-utils/internal";
-import { CreateSummarizerNodeSource, channelsTreeName, } from "@fluidframework/runtime-definitions/internal";
-import { GCDataBuilder, RequestParser, SummaryTreeBuilder, convertSnapshotTreeToSummaryTree, convertSummaryTreeToITree, create404Response, createResponseError, encodeCompactIdToString, isSerializedHandle, processAttachMessageGCData, responseToException, unpackChildNodesUsedRoutes, } from "@fluidframework/runtime-utils/internal";
+import { CreateSummarizerNodeSource, channelsTreeName, gcDataBlobKey, } from "@fluidframework/runtime-definitions/internal";
+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 { 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";
-import { GCNodeType, detectOutboundRoutesViaDDSKey, urlToGCNodePath, } from "./gc/index.js";
+import { GCNodeType, urlToGCNodePath } from "./gc/index.js";
 import { ContainerMessageType } from "./messageTypes.js";
 import { StorageServiceWithAttachBlobs } from "./storageServiceWithAttachBlobs.js";
 import { nonDataStorePaths, rootHasIsolatedChannels, } from "./summary/index.js";
@@ -96,8 +96,8 @@ export function wrapContext(context) {
         uploadBlob: async (...args) => {
             return context.uploadBlob(...args);
         },
-        addedGCOutboundReference: (...args) => {
-            return context.addedGCOutboundReference?.(...args);
+        addedGCOutboundRoute: (...args) => {
+            return context.addedGCOutboundRoute(...args);
         },
         getCreateChildSummarizerNodeFn: (...args) => {
             return context.getCreateChildSummarizerNodeFn?.(...args);
@@ -140,33 +140,42 @@ export function wrapContextForInnerChannel(id, parentContext) {
     };
     return context;
 }
+/**
+ * Returns the type of the given local data store from its package path.
+ */
+export function getLocalDataStoreType(localDataStore) {
+    return localDataStore.packagePath[localDataStore.packagePath.length - 1];
+}
 /**
  * This class encapsulates data store handling. Currently it is only used by the container runtime,
  * but eventually could be hosted on any channel once we formalize the channel api boundary.
  * @internal
  */
 export class ChannelCollection {
+    baseSnapshot;
+    parentContext;
+    gcNodeUpdated;
+    isDataStoreDeleted;
+    aliasMap;
+    // Stores tracked by the Domain
+    pendingAttach = new Map();
+    // 0.24 back-compat attachingBeforeSummary
+    attachOpFiredForDataStore = new Set();
+    mc;
+    disposeOnce = new Lazy(() => this.contexts.dispose());
+    entryPoint;
+    containerLoadStats;
+    pendingAliasMap = new Map();
+    contexts;
+    aliasedDataStores;
     constructor(baseSnapshot, parentContext, baseLogger, gcNodeUpdated, isDataStoreDeleted, aliasMap, provideEntryPoint) {
         this.baseSnapshot = baseSnapshot;
         this.parentContext = parentContext;
         this.gcNodeUpdated = gcNodeUpdated;
         this.isDataStoreDeleted = isDataStoreDeleted;
         this.aliasMap = aliasMap;
-        // Stores tracked by the Domain
-        this.pendingAttach = new Map();
-        // 0.24 back-compat attachingBeforeSummary
-        this.attachOpFiredForDataStore = new Set();
-        this.disposeOnce = new Lazy(() => this.contexts.dispose());
-        // Stores the ids of new data stores between two GC runs. This is used to notify the garbage collector of new
-        // root data stores that are added.
-        this.dataStoresSinceLastGC = [];
-        this.pendingAliasMap = new Map();
-        /** For sampling. Only log once per container */
-        this.shouldSendAttachLog = true;
-        this.dispose = () => this.disposeOnce.value;
         this.mc = createChildMonitoringContext({ logger: baseLogger });
         this.contexts = new DataStoreContexts(baseLogger);
-        this.containerRuntimeHandle = new FluidObjectHandle(this.parentContext, "/", this.parentContext.IFluidHandleContext);
         this.entryPoint = new FluidObjectHandle(new LazyPromise(async () => provideEntryPoint(this)), "", this.parentContext.IFluidHandleContext);
         this.aliasedDataStores = new Set(aliasMap.values());
         // Extract stores stored inside the snapshot
@@ -241,6 +250,8 @@ export class ChannelCollection {
         const pendingAliasPromise = this.pendingAliases.get(maybeAlias);
         return pendingAliasPromise ?? "Success";
     }
+    /** For sampling. Only log once per container */
+    shouldSendAttachLog = true;
     wrapContextForInnerChannel(id) {
         return wrapContextForInnerChannel(id, this.parentContext);
     }
@@ -254,12 +265,11 @@ export class ChannelCollection {
     }
     processAttachMessage(message, local) {
         const attachMessage = message.contents;
-        this.dataStoresSinceLastGC.push(attachMessage.id);
         // We need to process the GC Data for both local and remote attach messages
         const foundGCData = processAttachMessageGCData(attachMessage.snapshot, (nodeId, toPath) => {
             // nodeId is the relative path under the node being attached. Always starts with "/", but no trailing "/" after an id
             const fromPath = `/${attachMessage.id}${nodeId === "/" ? "" : nodeId}`;
-            this.parentContext.addedGCOutboundReference?.({ absolutePath: fromPath }, { absolutePath: toPath });
+            this.parentContext.addedGCOutboundRoute(fromPath, toPath);
         });
         // Only log once per container to avoid noise/cost.
         // Allows longitudinal tracking of various state (e.g. foundGCData), and some sampled details
@@ -353,8 +363,7 @@ export class ChannelCollection {
             });
             return false;
         }
-        const handle = new FluidObjectHandle(context, internalId, this.parentContext.IFluidHandleContext);
-        this.parentContext.addedGCOutboundReference?.(this.containerRuntimeHandle, handle);
+        this.parentContext.addedGCOutboundRoute("/", `/${internalId}`);
         this.aliasMap.set(alias, context.id);
         this.aliasedDataStores.add(context.id);
         context.setInMemoryRoot();
@@ -365,14 +374,17 @@ export class ChannelCollection {
     }
     /** Package up the context's attach summary etc into an IAttachMessage */
     generateAttachMessage(localContext) {
-        const { attachSummary } = localContext.getAttachData(/* includeGCData: */ true);
-        const type = localContext.packagePath[localContext.packagePath.length - 1];
+        // Get the attach summary.
+        const attachSummary = localContext.getAttachSummary();
+        // Get the GC data and add it to the attach summary.
+        const attachGCData = localContext.getAttachGCData();
+        addBlobToSummary(attachSummary, gcDataBlobKey, JSON.stringify(attachGCData));
         // Attach message needs the summary in ITree format. Convert the ISummaryTree into an ITree.
         const snapshot = convertSummaryTreeToITree(attachSummary.summary);
         return {
             id: localContext.id,
             snapshot,
-            type,
+            type: getLocalDataStoreType(localContext),
         };
     }
     /**
@@ -462,6 +474,7 @@ export class ChannelCollection {
     get disposed() {
         return this.disposeOnce.evaluated;
     }
+    dispose = () => this.disposeOnce.value;
     reSubmit(type, content, localOpMetadata) {
         switch (type) {
             case ContainerMessageType.Attach:
@@ -566,7 +579,7 @@ export class ChannelCollection {
             this.pendingAttach.set(message.id, message);
         }
     }
-    process(message, local, localMessageMetadata, addedOutboundReference) {
+    process(message, local, localMessageMetadata) {
         switch (message.type) {
             case ContainerMessageType.Attach:
                 this.processAttachMessage(message, local);
@@ -583,13 +596,8 @@ export class ChannelCollection {
                     contents: innerContents.content,
                 };
                 this.processChannelOp(envelope.address, transformed, local, localMessageMetadata);
-                // By default, we use the new behavior of detecting outbound routes here.
-                // If this setting is true, then DataStoreContext would be notifying GC instead.
-                if (this.mc.config.getBoolean(detectOutboundRoutesViaDDSKey) !== true &&
-                    addedOutboundReference !== undefined) {
-                    // Notify GC of any outbound references that were added by this op.
-                    detectOutboundReferences(envelope.address, transformed.contents, addedOutboundReference);
-                }
+                // Notify GC of any outbound references that were added by this op.
+                detectOutboundReferences(envelope.address, transformed.contents, (fromPath, toPath) => this.parentContext.addedGCOutboundRoute(fromPath, toPath));
                 break;
             }
             default:
@@ -674,9 +682,9 @@ export class ChannelCollection {
             ? urlToGCNodePath(originalRequest.url)
             : dataStoreNodePath;
         // Log the package details asynchronously since getInitialSnapshotDetails is async
-        const recentelyDeletedContext = this.contexts.getRecentlyDeletedContext(id);
-        if (recentelyDeletedContext !== undefined) {
-            recentelyDeletedContext
+        const recentlyDeletedContext = this.contexts.getRecentlyDeletedContext(id);
+        if (recentlyDeletedContext !== undefined) {
+            recentlyDeletedContext
                 .getInitialSnapshotDetails()
                 .then((details) => {
                 return details.pkg.join("/");
@@ -806,8 +814,7 @@ export class ChannelCollection {
                 .map(([key, value]) => {
                 let dataStoreSummary;
                 if (value.isLoaded) {
-                    dataStoreSummary = value.getAttachData(
-                    /* includeGCCData: */ false, telemetryContext).attachSummary;
+                    dataStoreSummary = value.getAttachSummary(telemetryContext);
                 }
                 else {
                     // If this data store is not yet loaded, then there should be no changes in the snapshot from
@@ -821,21 +828,30 @@ export class ChannelCollection {
         return builder.getSummaryTree();
     }
     /**
-     * Before GC runs, called by the garbage collector to update any pending GC state.
-     * The garbage collector needs to know all outbound references that are added. Since root data stores are not
-     * explicitly marked as referenced, notify GC of new root data stores that were added since the last GC run.
+     * Gets the GC data. Used when attaching or serializing a detached container.
      */
-    async updateStateBeforeGC() {
-        for (const id of this.dataStoresSinceLastGC) {
-            const context = this.contexts.get(id);
-            assert(context !== undefined, 0x2b6 /* Missing data store context */);
-            if (await context.isRoot()) {
-                // A root data store is basically a reference from the container runtime to the data store.
-                const handle = new FluidObjectHandle(context, id, this.parentContext.IFluidHandleContext);
-                this.parentContext.addedGCOutboundReference?.(this.containerRuntimeHandle, handle);
-            }
-        }
-        this.dataStoresSinceLastGC = [];
+    getAttachGCData(telemetryContext) {
+        const builder = new GCDataBuilder();
+        // Attaching graph of some stores can cause other stores to get bound too.
+        // So keep taking summary until no new stores get bound.
+        let notBoundContextsLength;
+        do {
+            notBoundContextsLength = this.contexts.notBoundLength();
+            // Iterate over each data store and ask for its GC data.
+            Array.from(this.contexts)
+                .filter(([key, _]) => 
+            // Take GC data of bounded data stores only.
+            !this.contexts.isNotBound(key))
+                .map(([key, value]) => {
+                const contextGCData = value.getAttachGCData(telemetryContext);
+                // Prefix the child's id to the ids of its GC nodes so they can be identified as belonging to the child.
+                // This also gradually builds the id of each node to be a path from the root.
+                builder.prefixAndAddNodes(key, contextGCData.gcNodes);
+            });
+        } while (notBoundContextsLength !== this.contexts.notBoundLength());
+        // Get the outbound routes (aliased data stores) and add a GC node for this channel.
+        builder.addNode("/", Array.from(this.aliasedDataStores));
+        return builder.getGCData();
     }
     /**
      * Generates data used for garbage collection. It does the following:
@@ -1113,12 +1129,15 @@ export function detectOutboundReferences(address, contents, addedOutboundReferen
 }
 /** @internal */
 export class ChannelCollectionFactory {
+    provideEntryPoint;
+    ctor;
+    type = "ChannelCollectionChannel";
+    IFluidDataStoreRegistry;
     constructor(registryEntries, 
     // ADO:7302 We need a better type here
     provideEntryPoint, ctor) {
         this.provideEntryPoint = provideEntryPoint;
         this.ctor = ctor;
-        this.type = "ChannelCollectionChannel";
         this.IFluidDataStoreRegistry = new FluidDataStoreRegistry(registryEntries);
     }
     get IFluidDataStoreFactory() {