@fluidframework/container-runtime 2.0.0-rc.4.0.6 → 2.0.0-rc.5.0.0

package/dist/channelCollection.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChannelCollectionFactory = exports.detectOutboundReferences = exports.getSummaryForDatastores = exports.ChannelCollection = exports.wrapContextForInnerChannel = exports.wrapContext = exports.AllowInactiveRequestHeaderKey = exports.AllowTombstoneRequestHeaderKey = exports.RuntimeHeaders = void 0;
+exports.ChannelCollectionFactory = exports.detectOutboundReferences = exports.getSummaryForDatastores = exports.ChannelCollection = exports.getLocalDataStoreType = exports.wrapContextForInnerChannel = exports.wrapContext = exports.AllowInactiveRequestHeaderKey = exports.AllowTombstoneRequestHeaderKey = exports.RuntimeHeaders = void 0;
 const container_definitions_1 = require("@fluidframework/container-definitions");
 const internal_1 = require("@fluidframework/core-utils/internal");
 const internal_2 = require("@fluidframework/datastore/internal");
@@ -59,7 +59,7 @@ function wrapContext(context) {
         },
         deltaManager: context.deltaManager,
         storage: context.storage,
-        logger: context.logger,
+        baseLogger: context.baseLogger,
         get clientDetails() {
             return context.clientDetails;
         },
@@ -99,8 +99,8 @@ 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);
@@ -145,6 +145,13 @@ function wrapContextForInnerChannel(id, parentContext) {
     return context;
 }
 exports.wrapContextForInnerChannel = wrapContextForInnerChannel;
+/**
+ * Returns the type of the given local data store from its package path.
+ */
+function getLocalDataStoreType(localDataStore) {
+    return localDataStore.packagePath[localDataStore.packagePath.length - 1];
+}
+exports.getLocalDataStoreType = getLocalDataStoreType;
 /**
  * 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.
@@ -162,16 +169,12 @@ class ChannelCollection {
         // 0.24 back-compat attachingBeforeSummary
         this.attachOpFiredForDataStore = new Set();
         this.disposeOnce = new internal_1.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 = (0, internal_6.createChildMonitoringContext)({ logger: baseLogger });
         this.contexts = new dataStoreContexts_js_1.DataStoreContexts(baseLogger);
-        this.containerRuntimeHandle = new internal_2.FluidObjectHandle(this.parentContext, "/", this.parentContext.IFluidHandleContext);
         this.entryPoint = new internal_2.FluidObjectHandle(new internal_1.LazyPromise(async () => provideEntryPoint(this)), "", this.parentContext.IFluidHandleContext);
         this.aliasedDataStores = new Set(aliasMap.values());
         // Extract stores stored inside the snapshot
@@ -259,12 +262,11 @@ 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 = (0, internal_5.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, message.timestamp);
         });
         // Only log once per container to avoid noise/cost.
         // Allows longitudinal tracking of various state (e.g. foundGCData), and some sampled details
@@ -336,12 +338,12 @@ 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;
         }
@@ -358,8 +360,11 @@ class ChannelCollection {
             });
             return false;
         }
-        const handle = new internal_2.FluidObjectHandle(context, internalId, this.parentContext.IFluidHandleContext);
-        this.parentContext.addedGCOutboundReference?.(this.containerRuntimeHandle, handle);
+        // 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();
@@ -370,14 +375,17 @@ 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();
+        (0, internal_5.addBlobToSummary)(attachSummary, internal_4.gcDataBlobKey, JSON.stringify(attachGCData));
         // Attach message needs the summary in ITree format. Convert the ISummaryTree into an ITree.
         const snapshot = (0, internal_5.convertSummaryTreeToITree)(attachSummary.summary);
         return {
             id: localContext.id,
             snapshot,
-            type,
+            type: getLocalDataStoreType(localContext),
         };
     }
     /**
@@ -459,7 +467,7 @@ class ChannelCollection {
             snapshotTree: undefined,
             createProps,
             loadingGroupId,
-            channelToDataStoreFn: (channel) => (0, dataStore_js_1.channelToDataStore)(channel, id, this, (0, internal_6.createChildLogger)({ logger: this.parentContext.logger })),
+            channelToDataStoreFn: (channel) => (0, dataStore_js_1.channelToDataStore)(channel, id, this, (0, internal_6.createChildLogger)({ logger: this.parentContext.baseLogger })),
         });
         this.contexts.addUnbound(context);
         return context;
@@ -571,7 +579,7 @@ class ChannelCollection {
             this.pendingAttach.set(message.id, message);
         }
     }
-    process(message, local, localMessageMetadata, addedOutboundReference) {
+    process(message, local, localMessageMetadata) {
         switch (message.type) {
             case messageTypes_js_1.ContainerMessageType.Attach:
                 this.processAttachMessage(message, local);
@@ -588,13 +596,8 @@ 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(index_js_1.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, message.timestamp));
                 break;
             }
             default:
@@ -675,13 +678,11 @@ class ChannelCollection {
         if (!this.isDataStoreDeleted(dataStoreNodePath)) {
             return false;
         }
-        const idToLog = originalRequest !== undefined
-            ? (0, index_js_1.urlToGCNodePath)(originalRequest.url)
-            : dataStoreNodePath;
+        const idToLog = originalRequest !== undefined ? (0, index_js_1.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("/");
@@ -767,80 +768,94 @@ class ChannelCollection {
     get size() {
         return this.contexts.size;
     }
-    async summarize(fullTree, trackState, telemetryContext) {
-        const summaryBuilder = new internal_5.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 === container_definitions_1.AttachState.Attaching) {
-                // Formerly assert 0x588
-                const error = internal_6.DataProcessingError.create("Local data store detected in attaching state during summarize", "summarize");
-                throw error;
-            }
-            return context.attachState === container_definitions_1.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 internal_5.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;
+        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.
+                (0, internal_1.assert)(!!this.baseSnapshot, 0x166 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
+                dataStoreSummary = (0, internal_5.convertSnapshotTreeToSummaryTree)((0, internal_3.getSnapshotTree)(this.baseSnapshot).trees[contextId]);
+            }
+            builder.addWithStats(contextId, dataStoreSummary);
+        });
+        return builder.getSummaryTree();
+    }
+    /**
+     * Gets the GC data. Used when attaching or serializing a detached container.
+     */
+    getAttachGCData(telemetryContext) {
+        const builder = new internal_5.GCDataBuilder();
+        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();
-            // 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.getAttachData(
-                    /* includeGCCData: */ false, telemetryContext).attachSummary;
+            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);
                 }
-                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.
-                    (0, internal_1.assert)(!!this.baseSnapshot, 0x166 /* "BaseSnapshot should be there as detached container loaded from snapshot" */);
-                    dataStoreSummary = (0, internal_5.convertSnapshotTreeToSummaryTree)((0, internal_3.getSnapshotTree)(this.baseSnapshot).trees[key]);
-                }
-                builder.addWithStats(key, dataStoreSummary);
-            });
-        } while (notBoundContextsLength !== this.contexts.notBoundLength());
-        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.
+     * Helper method for preparing to summarize this channel.
+     * Runs the callback for each bound context to incorporate its data however the caller specifies
      */
-    async updateStateBeforeGC() {
-        for (const id of this.dataStoresSinceLastGC) {
-            const context = this.contexts.get(id);
-            (0, internal_1.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 internal_2.FluidObjectHandle(context, id, this.parentContext.IFluidHandleContext);
-                this.parentContext.addedGCOutboundReference?.(this.containerRuntimeHandle, handle);
+    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 === container_definitions_1.AttachState.Attaching) {
+                const error = internal_6.DataProcessingError.create("Local data store detected in attaching state", "summarize/getGCData");
+                throw error;
+            }
+            if (context.attachState === container_definitions_1.AttachState.Attached) {
+                await visitor(contextId, context);
             }
         }
-        this.dataStoresSinceLastGC = [];
+    }
+    async summarize(fullTree, trackState, telemetryContext) {
+        const summaryBuilder = new internal_5.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:
@@ -857,25 +872,12 @@ class ChannelCollection {
      */
     async getGCData(fullGC = false) {
         const builder = new internal_5.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 === container_definitions_1.AttachState.Attaching) {
-                const error = internal_6.DataProcessingError.create("Local data store detected in attaching state while running GC", "getGCData");
-                throw error;
-            }
-            return context.attachState === container_definitions_1.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();
@@ -1052,6 +1054,7 @@ 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);
@@ -1134,7 +1137,7 @@ class ChannelCollectionFactory {
     }
     async instantiateDataStore(context, _existing) {
         const runtime = this.ctor(context.baseSnapshot, context, // parentContext
-        context.logger, () => { }, // gcNodeUpdated
+        context.baseLogger, () => { }, // gcNodeUpdated
         (_nodePath) => false, // isDataStoreDeleted
         new Map(), // aliasMap
         this.provideEntryPoint);