@fluidframework/container-runtime 0.52.1 → 0.53.0-46105

package/src/garbageCollection.ts

@@ -4,24 +4,49 @@
  */
 
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { runGarbageCollection } from "@fluidframework/garbage-collector";
+import { assert, LazyPromise, Timer } from "@fluidframework/common-utils";
+import {
+    concatGarbageCollectionStates,
+    unpackChildNodesGCDetails,
+    IGCResult,
+    runGarbageCollection,
+} from "@fluidframework/garbage-collector";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
-import { ReadAndParseBlob, RefreshSummaryResult } from "@fluidframework/runtime-utils";
+import {
+    gcBlobKey,
+    IGarbageCollectionData,
+    IGarbageCollectionNodeData,
+    IGarbageCollectionState,
+    IGarbageCollectionSummaryDetails,
+    ISummaryTreeWithStats,
+} from "@fluidframework/runtime-definitions";
+import {
+    ReadAndParseBlob,
+    RefreshSummaryResult,
+    SummaryTreeBuilder,
+} from "@fluidframework/runtime-utils";
 import { ChildLogger, PerformanceEvent } from "@fluidframework/telemetry-utils";
 
 import { IGCRuntimeOptions } from "./containerRuntime";
+import { getSummaryForDatastores } from "./dataStores";
 import { getLocalStorageFeatureGate } from "./localStorageFeatureGates";
 import {
     getGCVersion,
     GCVersion,
     IContainerRuntimeMetadata,
     metadataBlobName,
+    ReadFluidDataStoreAttributes,
+    dataStoreAttributesBlobName,
 } from "./summaryFormat";
 
 /** This is the current version of garbage collection. */
 const GCVersion = 1;
 
+// The key for the GC tree in summary.
+export const gcTreeKey = "gc";
+// They prefix for GC blobs in the GC tree in summary.
+export const gcBlobPrefix = "__gc";
+
 // Local storage key to turn GC on / off.
 const runGCKey = "FluidRunGC";
 // Local storage key to turn GC test mode on / off.
@@ -29,6 +54,8 @@ const gcTestModeKey = "FluidGCTestMode";
 // Local storage key to turn GC sweep on / off.
 const runSweepKey = "FluidRunSweep";
 
+const defaultDeleteTimeoutMs = 7 * 24 * 60 * 60 * 1000; // 7 days
+
 /** The used state statistics of a node. */
 export interface IUsedStateStats {
     totalNodeCount: number;
@@ -48,7 +75,7 @@ export interface IGarbageCollectionRuntime {
     /** Returns the garbage collection data of the runtime. */
     getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
     /** After GC has run, called to notify the runtime of routes that are used in it. */
-    updateUsedRoutes(usedRoutes: string[]): IUsedStateStats;
+    updateUsedRoutes(usedRoutes: string[], gcTimestamp?: number): IUsedStateStats;
 }
 
 /** Defines the contract for the garbage collector. */
@@ -57,18 +84,77 @@ export interface IGarbageCollector {
     readonly shouldRunGC: boolean;
     /**
      * This tracks two things:
-     * 1. Whether GC is enabled - If this is 0, GC is disabled. If this is > 0, GC is enabled.
+     * 1. Whether GC is enabled - If this is 0, GC is disabled. If this is greater than 0, GC is enabled.
      * 2. If GC is enabled, the version of GC used to generate the GC data written in a summary.
      */
     readonly gcSummaryFeatureVersion: number;
     /** Tells whether the GC version has changed compared to the version in the latest summary. */
     readonly hasGCVersionChanged: boolean;
+    /** Tells whether GC data should be written to the root of the summary tree. */
+    readonly writeDataAtRoot: boolean;
     /** Run garbage collection and update the reference / used state of the system. */
     collectGarbage(
         options: { logger?: ITelemetryLogger, runGC?: boolean, runSweep?: boolean, fullGC?: boolean },
     ): Promise<IGCStats>;
+    /** Summarizes the GC data and returns it as a summary tree. */
+    summarize(): ISummaryTreeWithStats | undefined;
+    /** Returns a map of each data store id to its GC details in the base summary. */
+    getDataStoreBaseGCDetails(): Promise<Map<string, IGarbageCollectionSummaryDetails>>;
     /** Called when the latest summary of the system has been refreshed. */
     latestSummaryStateRefreshed(result: RefreshSummaryResult, readAndParseBlob: ReadAndParseBlob): Promise<void>;
+    /** Called when a node is changed. Used to detect and log when an inactive node is changed. */
+    nodeChanged(id: string): void;
+}
+
+/**
+ * Helper class that tracks the state of an unreferenced node such as the time it was unreferenced. It also sets
+ * the node's state to inactive if it remains unreferenced for a given amount of time (inactiveTimeoutMs).
+ */
+class UnreferencedStateTracker {
+    private inactive: boolean = false;
+    // Keeps track of all inactive events that are logged. This is used to limit the log generation for each event to 1
+    // so that it is not noisy.
+    private readonly inactiveEventsLogged: Set<string> = new Set();
+    private readonly timer: Timer | undefined;
+
+    constructor(
+        public readonly unreferencedTimestampMs: number,
+        inactiveTimeoutMs: number,
+    ) {
+        // If the timeout has already expired, the node should become inactive immediately. Otherwise, start a timer of
+        // inactiveTimeoutMs after which the node will become inactive.
+        if (inactiveTimeoutMs <= 0) {
+            this.inactive = true;
+        } else {
+            this.timer = new Timer(inactiveTimeoutMs, () => { this.inactive = true; });
+            this.timer.start();
+        }
+    }
+
+    /** Stop tracking this node. Reset the unreferenced timer, if any, and reset inactive state. */
+    public stopTracking() {
+        this.timer?.clear();
+        this.inactive = false;
+    }
+
+    /** Logs an error with the given properties if the node  is inactive. */
+    public logIfInactive(
+        logger: ITelemetryLogger,
+        eventName: string,
+        currentTimestampMs: number,
+        deleteTimeoutMs: number,
+        inactiveNodeId: string,
+    ) {
+        if (this.inactive && !this.inactiveEventsLogged.has(eventName)) {
+            logger.sendErrorEvent({
+                eventName,
+                unreferencedDuratonMs: currentTimestampMs - this.unreferencedTimestampMs,
+                deleteTimeoutMs,
+                inactiveNodeId,
+            });
+            this.inactiveEventsLogged.add(eventName);
+        }
+    }
 }
 
 /**
@@ -80,11 +166,24 @@ export class GarbageCollector implements IGarbageCollector {
         provider: IGarbageCollectionRuntime,
         gcOptions: IGCRuntimeOptions,
         deleteUnusedRoutes: (unusedRoutes: string[]) => void,
+        getCurrentTimestampMs: () => number,
+        baseSnapshot: ISnapshotTree | undefined,
+        readAndParseBlob: ReadAndParseBlob,
         baseLogger: ITelemetryLogger,
         existing: boolean,
         metadata?: IContainerRuntimeMetadata,
     ): IGarbageCollector {
-        return new GarbageCollector(provider, gcOptions, deleteUnusedRoutes, baseLogger, existing, metadata);
+        return new GarbageCollector(
+            provider,
+            gcOptions,
+            deleteUnusedRoutes,
+            getCurrentTimestampMs,
+            baseSnapshot,
+            readAndParseBlob,
+            baseLogger,
+            existing,
+            metadata,
+        );
     }
 
     /**
@@ -94,7 +193,7 @@ export class GarbageCollector implements IGarbageCollector {
 
     /**
      * This tracks two things:
-     * 1. Whether GC is enabled - If this is 0, GC is disabled. If this is > 0, GC is enabled.
+     * 1. Whether GC is enabled - If this is 0, GC is disabled. If this is greater than 0, GC is enabled.
      * 2. If GC is enabled, the version of GC used to generate the GC data written in a summary.
      */
     public get gcSummaryFeatureVersion(): number {
@@ -120,25 +219,51 @@ export class GarbageCollector implements IGarbageCollector {
     private readonly testMode: boolean;
     private readonly logger: ITelemetryLogger;
 
+    /**
+     * Tells whether the GC data should be written to the root of the summary tree. We do this under 2 conditions:
+     * 1. If `writeDataAtRoot` GC option is enabled.
+     * 2. If the base summary has the GC data written at the root. This is to support forward compatibility where when
+     *    we start writing the GC data at root, older versions can detect that and write at root too.
+     */
+    private _writeDataAtRoot: boolean = false;
+    public get writeDataAtRoot(): boolean {
+        return this._writeDataAtRoot;
+    }
+
     // The current GC version that this container is running.
     private readonly currentGCVersion = GCVersion;
     // This is the version of GC data in the latest summary being tracked.
     private latestSummaryGCVersion: GCVersion;
 
+    // The current state - each node's GC data and unreferenced timestamp.
+    private currentGCState: IGarbageCollectionState | undefined;
+
+    // Promise when resolved initializes the base state of the nodes from the base summary state.
+    private readonly initializeBaseStateP: Promise<void>;
+    // The map of data store ids to their GC details in the base summary returned in getDataStoreGCDetails().
+    private readonly dataStoreGCDetailsP: Promise<Map<string, IGarbageCollectionSummaryDetails>>;
+    // The time after which an unreferenced node can be deleted. Currently, we only set the node's state to expired.
+    private readonly deleteTimeoutMs: number;
+    // Map of node ids to their unreferenced state tracker.
+    private readonly unreferencedNodesState: Map<string, UnreferencedStateTracker> = new Map();
+
     protected constructor(
         private readonly provider: IGarbageCollectionRuntime,
         private readonly gcOptions: IGCRuntimeOptions,
-        /**
-         * After GC has run, called to delete objects in the runtime whose routes are unused. This is not part of the
-         * provider because its specific to this garbage collector implementation and is not part of the contract.
-         */
+        /** After GC has run, called to delete objects in the runtime whose routes are unused. */
         private readonly deleteUnusedRoutes: (unusedRoutes: string[]) => void,
+        /** Returns the current timestamp to be assigned to nodes that become unreferenced. */
+        private readonly getCurrentTimestampMs: () => number,
+        baseSnapshot: ISnapshotTree | undefined,
+        readAndParseBlob: ReadAndParseBlob,
         baseLogger: ITelemetryLogger,
         existing: boolean,
         metadata?: IContainerRuntimeMetadata,
     ) {
         this.logger = ChildLogger.create(baseLogger, "GarbageCollector");
 
+        this.deleteTimeoutMs = this.gcOptions.deleteTimeoutMs ?? defaultDeleteTimeoutMs;
+
         let prevSummaryGCVersion: number | undefined;
         // GC can only be enabled during creation. After that, it can never be enabled again. So, for existing
         // documents, we get this information from the metadata blob.
@@ -170,6 +295,127 @@ export class GarbageCollector implements IGarbageCollector {
 
         // Whether we are running in test mode. In this mode, unreferenced nodes are immediately deleted.
         this.testMode = getLocalStorageFeatureGate(gcTestModeKey) ?? gcOptions.runGCInTestMode === true;
+
+        // If `writeDataAtRoot` GC option is true, we should write the GC data into the root of the summary tree. This
+        // GC option is used for testing only. It will be removed once we start writing GC data into root by default.
+        this._writeDataAtRoot = this.gcOptions.writeDataAtRoot === true;
+
+        // Get the GC state from the GC blob in the base snapshot. Use LazyPromise because we only want to do
+        // this once since it involves fetching blobs from storage which is expensive.
+        const baseSummaryStateP = new LazyPromise<IGarbageCollectionState>(async () => {
+            if (baseSnapshot === undefined) {
+                return { gcNodes: {} };
+            }
+
+            // For newer documents, GC data should be present in the GC tree in the root of the snapshot.
+            const gcSnapshotTree = baseSnapshot.trees[gcTreeKey];
+            if (gcSnapshotTree !== undefined) {
+                // forward-compat - If a newer version has written the GC tree at root, we should also do the same.
+                this._writeDataAtRoot = true;
+                return getGCStateFromSnapshot(gcSnapshotTree, readAndParseBlob);
+            }
+
+            // back-compat - Older documents will have the GC blobs in each data store's summary tree. Get them and
+            // consolidate into IGarbageCollectionState format.
+            const gcState: IGarbageCollectionState = { gcNodes: { "/": { outboundRoutes: [] } } };
+            const dataStoreSnaphotTree = getSummaryForDatastores(baseSnapshot, metadata);
+            assert(dataStoreSnaphotTree !== undefined,
+                0x2a8 /* "Expected data store snapshot tree in base snapshot" */);
+            for (const [dsId, dsSnapshotTree] of Object.entries(dataStoreSnaphotTree.trees)) {
+                const blobId = dsSnapshotTree.blobs[gcBlobKey];
+                if (blobId === undefined) {
+                    continue;
+                }
+
+                const gcSummaryDetails = await readAndParseBlob<IGarbageCollectionSummaryDetails>(blobId);
+                // If there are no nodes for this data store, skip it.
+                if (gcSummaryDetails.gcData?.gcNodes === undefined) {
+                    continue;
+                }
+
+                const dsRootId = `/${dsId}`;
+                // Since we used to write GC data at data store level, we won't have an entry for the root ("/").
+                // Construct that entry by adding root data store ids to its outbound routes.
+                const initialSnapshotDetails = await readAndParseBlob<ReadFluidDataStoreAttributes>(
+                    dsSnapshotTree.blobs[dataStoreAttributesBlobName],
+                );
+                if (initialSnapshotDetails.isRootDataStore) {
+                    gcState.gcNodes["/"].outboundRoutes.push(dsRootId);
+                }
+
+                for (const [id, outboundRoutes] of Object.entries(gcSummaryDetails.gcData.gcNodes)) {
+                    // Prefix the data store id to the GC node ids to make them relative to the root from being
+                    // relative to the data store. Similar to how its done in DataStore::getGCData.
+                    const rootId = id === "/" ? dsRootId : `${dsRootId}${id}`;
+                    gcState.gcNodes[rootId] = { outboundRoutes: Array.from(outboundRoutes) };
+                }
+                assert(gcState.gcNodes[dsRootId] !== undefined,
+                    0x2a9 /* `GC nodes for data store ${dsId} not in GC blob` */);
+                gcState.gcNodes[dsRootId].unreferencedTimestampMs = gcSummaryDetails.unrefTimestamp;
+            }
+            return gcState;
+        });
+
+        // Set up the initializer which initializes the base GC state from the base snapshot. Use lazy promise because
+        // we only do this once - the very first time we run GC.
+        this.initializeBaseStateP = new LazyPromise<void>(async () => {
+            const baseState = await baseSummaryStateP;
+
+            const gcNodes: { [ id: string ]: IGarbageCollectionNodeData } = {};
+            // Set up tracking for the nodes in the base summary state and add them to GC nodes.
+            for (const [nodeId, nodeData] of Object.entries(baseState.gcNodes)) {
+                const unreferencedTimestampMs = nodeData.unreferencedTimestampMs;
+                if (unreferencedTimestampMs !== undefined) {
+                    // Get how long it has been since the node was unreferenced. Start a timeout for the remaining time
+                    // left for it to be eligible for deletion.
+                    const unreferencedDurationMs = this.getCurrentTimestampMs() - unreferencedTimestampMs;
+                    this.unreferencedNodesState.set(
+                        nodeId,
+                        new UnreferencedStateTracker(
+                            unreferencedTimestampMs,
+                            this.deleteTimeoutMs - unreferencedDurationMs,
+                        ),
+                    );
+                }
+
+                gcNodes[nodeId] = {
+                    outboundRoutes: Array.from(nodeData.outboundRoutes),
+                    unreferencedTimestampMs,
+                };
+            }
+            this.currentGCState = { gcNodes };
+        });
+
+        // Get the GC details for each data store from the GC state in the base summary. This is returned in
+        // getDataStoreBaseGCDetails and is used to initialize each data store's base GC details.
+        this.dataStoreGCDetailsP = new LazyPromise<Map<string, IGarbageCollectionSummaryDetails>>(async () => {
+            const gcNodes: { [ id: string ]: string[] } = {};
+            const baseState = await baseSummaryStateP;
+            for (const [nodeId, nodeData] of Object.entries(baseState.gcNodes)) {
+                gcNodes[nodeId] = Array.from(nodeData.outboundRoutes);
+            }
+            // Run GC on the nodes in the base summary to get the routes used in each node in the container.
+            // This is an optimization for space (vs performance) wherein we don't need to store the used routes of
+            // each node in the summary.
+            const usedRoutes = runGarbageCollection(
+                gcNodes,
+                [ "/" ],
+                this.logger,
+            ).referencedNodeIds;
+
+            const dataStoreGCDetailsMap = unpackChildNodesGCDetails({ gcData: { gcNodes }, usedRoutes });
+            // Currently, the data stores write the GC data. So, we need to update it's base GC details with the
+            // unreferenced timestamp. Once we start writing the GC data here, we won't need to do this anymore.
+            for (const [nodeId, nodeData] of Object.entries(baseState.gcNodes)) {
+                if (nodeData.unreferencedTimestampMs !== undefined) {
+                    const dataStoreGCDetails = dataStoreGCDetailsMap.get(nodeId.slice(1));
+                    if (dataStoreGCDetails !== undefined) {
+                        dataStoreGCDetails.unrefTimestamp = nodeData.unreferencedTimestampMs;
+                    }
+                }
+            }
+            return dataStoreGCDetailsMap;
+        });
     }
 
     /**
@@ -193,6 +439,8 @@ export class GarbageCollector implements IGarbageCollector {
         } = options;
 
         return PerformanceEvent.timedExecAsync(logger, { eventName: "GarbageCollection" }, async (event) => {
+            await this.initializeBaseStateP;
+
             const gcStats: {
                 deletedNodes?: number,
                 totalNodes?: number,
@@ -202,30 +450,33 @@ export class GarbageCollector implements IGarbageCollector {
 
             // Get the runtime's GC data and run GC on the reference graph in it.
             const gcData = await this.provider.getGCData(fullGC);
-            const { referencedNodeIds, deletedNodeIds } = runGarbageCollection(
+            const gcResult = runGarbageCollection(
                 gcData.gcNodes,
                 [ "/" ],
                 logger,
             );
 
-            // Remove this node's route ("/") and notify data stores of routes that are used in it.
-            const usedRoutes = referencedNodeIds.filter((id: string) => { return id !== "/"; });
-            const dataStoreUsedStateStats = this.provider.updateUsedRoutes(usedRoutes);
+            const currentTimestampMs = this.getCurrentTimestampMs();
+            // Update the current state of the system based on the GC run.
+            this.updateCurrentState(gcData, gcResult, currentTimestampMs);
+
+            const dataStoreUsedStateStats =
+                this.provider.updateUsedRoutes(gcResult.referencedNodeIds, currentTimestampMs);
 
             if (runSweep) {
                 // Placeholder for running sweep logic.
             }
 
             // Update stats to be reported in the peformance event.
-            gcStats.deletedNodes = deletedNodeIds.length;
-            gcStats.totalNodes = referencedNodeIds.length + deletedNodeIds.length;
+            gcStats.deletedNodes = gcResult.deletedNodeIds.length;
+            gcStats.totalNodes = gcResult.referencedNodeIds.length + gcResult.deletedNodeIds.length;
             gcStats.deletedDataStores = dataStoreUsedStateStats.unusedNodeCount;
             gcStats.totalDataStores = dataStoreUsedStateStats.totalNodeCount;
 
             // If we are running in GC test mode, delete objects for unused routes. This enables testing scenarios
             // involving access to deleted data.
             if (this.testMode) {
-                this.deleteUnusedRoutes(deletedNodeIds);
+                this.deleteUnusedRoutes(gcResult.deletedNodeIds);
             }
             event.end(gcStats);
             return gcStats as IGCStats;
@@ -233,6 +484,29 @@ export class GarbageCollector implements IGarbageCollector {
         { end: true, cancel: "error" });
     }
 
+    /**
+     * Summarizes the GC data and returns it as a summary tree.
+     * We current write the entire GC state in a single blob. This can be modified later to write multiple
+     * blobs. All the blob keys should start with `gcBlobPrefix`.
+     */
+     public summarize(): ISummaryTreeWithStats | undefined {
+        if (!this.shouldRunGC || this.currentGCState === undefined) {
+            return;
+        }
+
+        const builder = new SummaryTreeBuilder();
+        builder.addBlob(`${gcBlobPrefix}_root`, JSON.stringify(this.currentGCState));
+        return builder.getSummaryTree();
+    }
+
+    /**
+     * Returns a map of data store ids to their base GC details generated from the base summary.This is used to
+     * initialize the data stores with their base GC state.
+     */
+    public async getDataStoreBaseGCDetails(): Promise<Map<string, IGarbageCollectionSummaryDetails>> {
+        return this.dataStoreGCDetailsP;
+    }
+
     /**
      * Called when the latest summary of the system has been refreshed. This will be used to update the state of the
      * latest summary tracked.
@@ -256,6 +530,21 @@ export class GarbageCollector implements IGarbageCollector {
         await this.updateSummaryGCVersionFromSnapshot(result.snapshot, readAndParseBlob);
     }
 
+    /**
+     * Called when a node with the given id is changed. If the node is inactive, log an error.
+     */
+    public nodeChanged(id: string) {
+        // Prefix "/" if needed to make it relative to the root.
+        const nodeId = id.startsWith("/") ? id : `/${id}`;
+        this.unreferencedNodesState.get(nodeId)?.logIfInactive(
+            this.logger,
+            "inactiveObjectChanged",
+            this.getCurrentTimestampMs(),
+            this.deleteTimeoutMs,
+            nodeId,
+        );
+    }
+
     /**
      * Update the latest summary GC version from the metadata blob in the given snapshot.
      */
@@ -266,4 +555,87 @@ export class GarbageCollector implements IGarbageCollector {
             this.latestSummaryGCVersion = getGCVersion(metadata);
         }
     }
+
+    /**
+     * Updates the state of the system as per the current GC run. It does the following:
+     * 1. Sets up the current GC state as per the gcData.
+     * 2. Starts tracking for nodes that have become unreferenced in this run.
+     * 3. Clears tracking for nodes that were unreferenced but became referenced in this run.
+     * @param gcData - The data representing the reference graph on which GC is run.
+     * @param gcResult - The result of the GC run on the gcData.
+     * @param currentTimestampMs - The current timestamp to be used for unreferenced nodes' timestamp.
+     */
+    private updateCurrentState(gcData: IGarbageCollectionData, gcResult: IGCResult, currentTimestampMs: number) {
+        this.currentGCState = { gcNodes: {} };
+        for (const [id, outboundRoutes] of Object.entries(gcData.gcNodes)) {
+            this.currentGCState.gcNodes[id] = { outboundRoutes: Array.from(outboundRoutes) };
+        }
+
+        // Iterate through the deleted nodes and start tracking if they became unreferenced in this run.
+        for (const nodeId of gcResult.deletedNodeIds) {
+            assert(this.currentGCState.gcNodes[nodeId] !== undefined, 0x2aa /* "Unexpected node when running GC" */);
+
+            // The time when the node became unreferenced. This is added to the current GC state.
+            let unreferencedTimestampMs: number = currentTimestampMs;
+            const nodeStateTracker = this.unreferencedNodesState.get(nodeId);
+            if (nodeStateTracker !== undefined) {
+                unreferencedTimestampMs = nodeStateTracker.unreferencedTimestampMs;
+            } else {
+                // Start tracking this node as it became unreferenced in this run.
+                this.unreferencedNodesState.set(
+                    nodeId,
+                    new UnreferencedStateTracker(unreferencedTimestampMs, this.deleteTimeoutMs),
+                );
+            }
+            this.currentGCState.gcNodes[nodeId].unreferencedTimestampMs = unreferencedTimestampMs;
+        }
+
+        // Iterate through the referenced nodes and stop tracking if they were unreferenced before.
+        for (const nodeId of gcResult.referencedNodeIds) {
+            assert(this.currentGCState.gcNodes[nodeId] !== undefined, 0x2ab /* "Unexpected node when running GC" */);
+            const nodeStateTracker = this.unreferencedNodesState.get(nodeId);
+            if (nodeStateTracker !== undefined) {
+                // If this node has been unreferenced for longer than deleteTimeoutMs and is being referenced,
+                // log an error as this may mean the deleteTimeoutMs is not long enough.
+                nodeStateTracker.logIfInactive(
+                    this.logger,
+                    "inactiveObjectRevived",
+                    currentTimestampMs,
+                    this.deleteTimeoutMs,
+                    nodeId,
+                );
+                // Stop tracking so as to clear out any running timers.
+                nodeStateTracker.stopTracking();
+                // Delete the node as we don't need to track it any more.
+                this.unreferencedNodesState.delete(nodeId);
+            }
+        }
+    }
+}
+
+/**
+ * Gets the garbage collection state from the given snapshot tree. The GC state may be written into multiple blobs.
+ * Merge the GC state from all such blobs and return the merged GC state.
+*/
+async function getGCStateFromSnapshot(
+    gcSnapshotTree: ISnapshotTree,
+    readAndParseBlob: ReadAndParseBlob,
+): Promise<IGarbageCollectionState> {
+    let rootGCState: IGarbageCollectionState = { gcNodes: {} };
+    for (const key of Object.keys(gcSnapshotTree.blobs)) {
+        // Skip blobs that do not stsart with the GC prefix.
+        if (!key.startsWith(gcBlobPrefix)) {
+            continue;
+        }
+
+        const blobId = gcSnapshotTree.blobs[key];
+        if (blobId === undefined) {
+            continue;
+        }
+        const gcState = await readAndParseBlob<IGarbageCollectionState>(blobId);
+        assert(gcState !== undefined, 0x2ad /* "GC blob missing from snapshot" */);
+        // Merge the GC state of this blob into the root GC state.
+        rootGCState = concatGarbageCollectionStates(rootGCState, gcState);
+    }
+    return rootGCState;
 }

package/src/index.ts

@@ -3,10 +3,28 @@
  * Licensed under the MIT License.
  */
 
-export * from "./containerRuntime";
+export {
+    ContainerMessageType,
+    IChunkedOp,
+    ContainerRuntimeMessage,
+    IGCRuntimeOptions,
+    ISummaryRuntimeOptions,
+    IContainerRuntimeOptions,
+    isRuntimeMessage,
+    unpackRuntimeMessage,
+    ScheduleManager,
+    agentSchedulerId,
+    ContainerRuntime,
+} from "./containerRuntime";
 export * from "./deltaScheduler";
 export * from "./dataStoreRegistry";
-export { IGarbageCollectionRuntime, IGCStats, IUsedStateStats } from "./garbageCollection";
+export {
+    gcBlobPrefix,
+    gcTreeKey,
+    IGarbageCollectionRuntime,
+    IGCStats,
+    IUsedStateStats,
+} from "./garbageCollection";
 export * from "./pendingStateManager";
 export * from "./summarizer";
 export * from "./summarizerTypes";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "0.52.1";
+export const pkgVersion = "0.53.0-46105";

package/src/summarizer.ts

@@ -8,8 +8,6 @@ import { Deferred } from "@fluidframework/common-utils";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { ChildLogger, IFluidErrorBase, LoggingError, wrapErrorAndLog } from "@fluidframework/telemetry-utils";
 import {
-    IRequest,
-    IResponse,
     IFluidHandleContext,
     IFluidHandle,
 } from "@fluidframework/core-interfaces";
@@ -17,7 +15,6 @@ import {
     ISequencedDocumentMessage,
     ISummaryConfiguration,
 } from "@fluidframework/protocol-definitions";
-import { create404Response } from "@fluidframework/runtime-utils";
 import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator";
 import { SummaryCollection } from "./summaryCollection";
 import { SummarizerHandle } from "./summarizerHandle";
@@ -63,7 +60,6 @@ export const createSummarizingWarning =
  */
 export class Summarizer extends EventEmitter implements ISummarizer {
     public get IFluidLoadable() { return this; }
-    public get IFluidRouter() { return this; }
     public get ISummarizer() { return this; }
 
     private readonly logger: ITelemetryLogger;
@@ -121,17 +117,6 @@ export class Summarizer extends EventEmitter implements ISummarizer {
         this.stopDeferred.resolve(reason);
     }
 
-    public async request(request: IRequest): Promise<IResponse> {
-        if (request.url === "/" || request.url === "") {
-            return {
-                mimeType: "fluid/object",
-                status: 200,
-                value: this,
-            };
-        }
-        return create404Response(request);
-    }
-
     private async runCore(
         onBehalfOf: string,
         options?: Readonly<Partial<ISummarizerOptions>>): Promise<SummarizerStopReason> {

package/src/summarizerTypes.ts

@@ -9,7 +9,6 @@ import {
     ITelemetryLogger,
 } from "@fluidframework/common-definitions";
 import {
-    IFluidRouter,
     IFluidLoadable,
 } from "@fluidframework/core-interfaces";
 import { ContainerWarning, IDeltaManager } from "@fluidframework/container-definitions";
@@ -296,7 +295,7 @@ export interface ISummarizerEvents extends IEvent {
 }
 
 export interface ISummarizer extends
-    IEventProvider<ISummarizerEvents>, IFluidRouter, IFluidLoadable, Partial<IProvideSummarizer>{
+    IEventProvider<ISummarizerEvents>, IFluidLoadable, Partial<IProvideSummarizer>{
     stop(reason: SummarizerStopReason): void;
     run(onBehalfOf: string, options?: Readonly<Partial<ISummarizerOptions>>): Promise<SummarizerStopReason>;
 

package/src/summaryFormat.ts

@@ -75,7 +75,7 @@ export function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): b
 }
 
 export type GCVersion = number;
-export interface IContainerRuntimeMetadata {
+export interface IContainerRuntimeMetadata extends ICreateContainerMetadata {
     readonly summaryFormatVersion: 1;
     /** The last message processed at the time of summary. Only primitive propertiy types are added to the summary. */
     readonly message: ISummaryMetadataMessage | undefined;
@@ -83,6 +83,15 @@ export interface IContainerRuntimeMetadata {
     readonly disableIsolatedChannels?: true;
     /** 0 to disable GC, > 0 to enable GC, undefined defaults to disabled. */
     readonly gcFeature?: GCVersion;
+    /** Counter of the last summary happened, increments every time we summarize */
+    readonly summaryCount?: number;
+}
+
+export interface ICreateContainerMetadata {
+    /** Runtime version of the container when it was first created */
+    createContainerRuntimeVersion?: string;
+    /** Timestamp of the container when it was first created */
+    createContainerTimestamp?: number;
 }
 
 /** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */