@fluidframework/container-runtime 2.0.0-dev-rc.5.0.0.271262 → 2.0.0-dev-rc.5.0.0.272251

package/lib/channelCollection.js

@@ -152,28 +152,21 @@ export function getLocalDataStoreType(localDataStore) {
  * @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());
+        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.entryPoint = new FluidObjectHandle(new LazyPromise(async () => provideEntryPoint(this)), "", this.parentContext.IFluidHandleContext);
@@ -250,8 +243,6 @@ 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);
     }
@@ -269,7 +260,7 @@ export class ChannelCollection {
         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.addedGCOutboundRoute(fromPath, toPath);
+            this.parentContext.addedGCOutboundRoute(fromPath, toPath, message.timestamp);
         });
         // Only log once per container to avoid noise/cost.
         // Allows longitudinal tracking of various state (e.g. foundGCData), and some sampled details
@@ -341,12 +332,12 @@ export class ChannelCollection {
             });
         }
         const resolve = localOpMetadata;
-        const aliasResult = this.processAliasMessageCore(aliasMessage.internalId, aliasMessage.alias);
+        const aliasResult = this.processAliasMessageCore(aliasMessage.internalId, aliasMessage.alias, message.timestamp);
         if (local) {
             resolve(aliasResult);
         }
     }
-    processAliasMessageCore(internalId, alias) {
+    processAliasMessageCore(internalId, alias, messageTimestampMs) {
         if (this.alreadyProcessed(alias)) {
             return false;
         }
@@ -363,7 +354,11 @@ export class ChannelCollection {
             });
             return false;
         }
-        this.parentContext.addedGCOutboundRoute("/", `/${internalId}`);
+        // If message timestamp doesn't exist, this is called in a detached container. Don't notify GC in that case
+        // because it doesn't run in detached container and doesn't need to know about this route.
+        if (messageTimestampMs) {
+            this.parentContext.addedGCOutboundRoute("/", `/${internalId}`, messageTimestampMs);
+        }
         this.aliasMap.set(alias, context.id);
         this.aliasedDataStores.add(context.id);
         context.setInMemoryRoot();
@@ -474,7 +469,6 @@ export class ChannelCollection {
     get disposed() {
         return this.disposeOnce.evaluated;
     }
-    dispose = () => this.disposeOnce.value;
     reSubmit(type, content, localOpMetadata) {
         switch (type) {
             case ContainerMessageType.Attach:
@@ -597,7 +591,7 @@ export class ChannelCollection {
                 };
                 this.processChannelOp(envelope.address, transformed, local, localMessageMetadata);
                 // Notify GC of any outbound references that were added by this op.
-                detectOutboundReferences(envelope.address, transformed.contents, (fromPath, toPath) => this.parentContext.addedGCOutboundRoute(fromPath, toPath));
+                detectOutboundReferences(envelope.address, transformed.contents, (fromPath, toPath) => this.parentContext.addedGCOutboundRoute(fromPath, toPath, message.timestamp));
                 break;
             }
             default:
@@ -770,61 +764,24 @@ export class ChannelCollection {
     get size() {
         return this.contexts.size;
     }
-    async summarize(fullTree, trackState, telemetryContext) {
-        const summaryBuilder = new SummaryTreeBuilder();
-        // Iterate over each store and ask it to snapshot
-        await Promise.all(Array.from(this.contexts)
-            .filter(([_, context]) => {
-            // Summarizer works only with clients with no local changes. A data store in attaching
-            // state indicates an op was sent to attach a local data store, and the the attach op
-            // had not yet round tripped back to the client.
-            if (context.attachState === AttachState.Attaching) {
-                // Formerly assert 0x588
-                const error = DataProcessingError.create("Local data store detected in attaching state during summarize", "summarize");
-                throw error;
-            }
-            return context.attachState === AttachState.Attached;
-        })
-            .map(async ([contextId, context]) => {
-            const contextSummary = await context.summarize(fullTree, trackState, telemetryContext);
-            summaryBuilder.addWithStats(contextId, contextSummary);
-        }));
-        return summaryBuilder.getSummaryTree();
-    }
     /**
      * Create a summary. Used when attaching or serializing a detached container.
      */
     getAttachSummary(telemetryContext) {
         const builder = new SummaryTreeBuilder();
-        // 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 {
-            const builderTree = builder.summary.tree;
-            notBoundContextsLength = this.contexts.notBoundLength();
-            // Iterate over each data store and ask it to snapshot
-            Array.from(this.contexts)
-                .filter(([key, _]) => 
-            // Take summary of bounded data stores only, make sure we haven't summarized them already
-            // and no attach op has been fired for that data store because for loader versions <= 0.24
-            // we set attach state as "attaching" before taking createNew summary.
-            !(this.contexts.isNotBound(key) ||
-                builderTree[key] ||
-                this.attachOpFiredForDataStore.has(key)))
-                .map(([key, value]) => {
-                let dataStoreSummary;
-                if (value.isLoaded) {
-                    dataStoreSummary = value.getAttachSummary(telemetryContext);
-                }
-                else {
-                    // If this data store is not yet loaded, then there should be no changes in the snapshot from
-                    // which it was created as it is detached container. So just use the previous snapshot.
-                    assert(!!this.baseSnapshot, 0x166 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
-                    dataStoreSummary = convertSnapshotTreeToSummaryTree(getSnapshotTree(this.baseSnapshot).trees[key]);
-                }
-                builder.addWithStats(key, dataStoreSummary);
-            });
-        } while (notBoundContextsLength !== this.contexts.notBoundLength());
+        this.visitLocalBoundContextsDuringAttach((contextId, context) => {
+            let dataStoreSummary;
+            if (context.isLoaded) {
+                dataStoreSummary = context.getAttachSummary(telemetryContext);
+            }
+            else {
+                // If this data store is not yet loaded, then there should be no changes in the snapshot from
+                // which it was created as it is detached container. So just use the previous snapshot.
+                assert(!!this.baseSnapshot, 0x166 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
+                dataStoreSummary = convertSnapshotTreeToSummaryTree(getSnapshotTree(this.baseSnapshot).trees[contextId]);
+            }
+            builder.addWithStats(contextId, dataStoreSummary);
+        });
         return builder.getSummaryTree();
     }
     /**
@@ -832,27 +789,70 @@ export class ChannelCollection {
      */
     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());
+        this.visitLocalBoundContextsDuringAttach((contextId, context) => {
+            const contextGCData = context.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(contextId, contextGCData.gcNodes);
+        });
         // Get the outbound routes (aliased data stores) and add a GC node for this channel.
         builder.addNode("/", Array.from(this.aliasedDataStores));
         return builder.getGCData();
     }
+    /**
+     * Helper method for preparing to attach this channel.
+     * Runs the callback for each bound context to incorporate its data however the caller specifies
+     */
+    visitLocalBoundContextsDuringAttach(visitor) {
+        const visitedContexts = new Set();
+        let visitedLength = -1;
+        let notBoundContextsLength = -1;
+        while (visitedLength !== visitedContexts.size &&
+            notBoundContextsLength !== this.contexts.notBoundLength()) {
+            // detect changes in the visitedContexts set, as on visiting a context
+            // it could could make contexts available by removing other contexts
+            // from the not bound context list, so we need to ensure those get processed as well.
+            // only once the loop can run with no new contexts added to the visitedContexts set do we
+            // know for sure all possible contexts have been visited.
+            visitedLength = visitedContexts.size;
+            notBoundContextsLength = this.contexts.notBoundLength();
+            for (const [contextId, context] of this.contexts) {
+                if (!(visitedContexts.has(contextId) ||
+                    this.contexts.isNotBound(contextId) ||
+                    this.attachOpFiredForDataStore.has(contextId))) {
+                    visitor(contextId, context);
+                    visitedContexts.add(contextId);
+                }
+            }
+        }
+    }
+    /**
+     * Helper method for preparing to summarize this channel.
+     * Runs the callback for each bound context to incorporate its data however the caller specifies
+     */
+    async visitContextsDuringSummary(visitor) {
+        for (const [contextId, context] of this.contexts) {
+            // Summarizer client and hence GC works only with clients with no local changes. A data store in
+            // attaching state indicates an op was sent to attach a local data store, and the the attach op
+            // had not yet round tripped back to the client.
+            // Formerly assert 0x589
+            if (context.attachState === AttachState.Attaching) {
+                const error = DataProcessingError.create("Local data store detected in attaching state", "summarize/getGCData");
+                throw error;
+            }
+            if (context.attachState === AttachState.Attached) {
+                await visitor(contextId, context);
+            }
+        }
+    }
+    async summarize(fullTree, trackState, telemetryContext) {
+        const summaryBuilder = new SummaryTreeBuilder();
+        await this.visitContextsDuringSummary(async (contextId, context) => {
+            const contextSummary = await context.summarize(fullTree, trackState, telemetryContext);
+            summaryBuilder.addWithStats(contextId, contextSummary);
+        });
+        return summaryBuilder.getSummaryTree();
+    }
     /**
      * Generates data used for garbage collection. It does the following:
      *
@@ -868,25 +868,12 @@ export class ChannelCollection {
      */
     async getGCData(fullGC = false) {
         const builder = new GCDataBuilder();
-        // Iterate over each store and get their GC data.
-        await Promise.all(Array.from(this.contexts)
-            .filter(([_, context]) => {
-            // Summarizer client and hence GC works only with clients with no local changes. A data store in
-            // attaching state indicates an op was sent to attach a local data store, and the the attach op
-            // had not yet round tripped back to the client.
-            // Formerly assert 0x589
-            if (context.attachState === AttachState.Attaching) {
-                const error = DataProcessingError.create("Local data store detected in attaching state while running GC", "getGCData");
-                throw error;
-            }
-            return context.attachState === AttachState.Attached;
-        })
-            .map(async ([contextId, context]) => {
+        await this.visitContextsDuringSummary(async (contextId, context) => {
             const contextGCData = await context.getGCData(fullGC);
             // 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(contextId, contextGCData.gcNodes);
-        }));
+        });
         // Get the outbound routes and add a GC node for this channel.
         builder.addNode("/", await this.getOutboundRoutes());
         return builder.getGCData();
@@ -1063,6 +1050,7 @@ export class ChannelCollection {
             packagePath: details.pkg,
             request,
             headerData,
+            timestampMs: undefined, // This will be added by the parent context if needed.
         });
         const dataStore = await dataStoreContext.realize();
         const subRequest = requestParser.createSubRequest(1);
@@ -1129,15 +1117,12 @@ 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() {