@fluidframework/runtime-utils 2.0.0-internal.2.2.1 → 2.0.0-internal.2.3.1

package/lib/summarizerNode/summarizerNodeWithGc.js

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 import { assert, LazyPromise } from "@fluidframework/common-utils";
-import { cloneGCData } from "@fluidframework/garbage-collector";
-import { gcBlobKey, } from "@fluidframework/runtime-definitions";
+import { cloneGCData, getGCDataFromSnapshot, runGarbageCollection, unpackChildNodesGCDetails } from "@fluidframework/garbage-collector";
+import { gcTreeKey, } from "@fluidframework/runtime-definitions";
 import { SummarizerNode } from "./summarizerNode";
-import { SummaryNode, } from "./summarizerNodeUtils";
+import { parseSummaryForSubtrees, SummaryNode, } from "./summarizerNodeUtils";
 // Extend SummaryNode to add used routes tracking to it.
 class SummaryNodeWithGC extends SummaryNode {
     constructor(serializedUsedRoutes, summary) {
@@ -57,21 +57,26 @@ export class SummarizerNodeWithGC extends SummarizerNode {
      * - gcData: The garbage collection data of this node that is required for running GC.
      */
     async loadBaseGCDetails() {
-        var _a;
+        if (this.baseGCDetailsLoaded) {
+            return;
+        }
         const baseGCDetails = await this.baseGCDetailsP;
-        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update
+        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we update
         // the state from the base details only once.
         if (this.baseGCDetailsLoaded) {
             return;
         }
         this.baseGCDetailsLoaded = true;
+        // Update GC data, used routes and reference used routes. The used routes are sorted because they are compared
+        // across GC runs to check if they changed. Sorting ensures that the elements are in the same order.
         // If the GC details has GC data, initialize our GC data from it.
         if (baseGCDetails.gcData !== undefined) {
             this.gcData = cloneGCData(baseGCDetails.gcData);
         }
-        // Sort the used routes because we compare them with the current used routes to check if they changed between
-        // summaries. Both are sorted so that the order of elements is the same.
-        this.referenceUsedRoutes = (_a = baseGCDetails.usedRoutes) === null || _a === void 0 ? void 0 : _a.sort();
+        if (baseGCDetails.usedRoutes !== undefined) {
+            this.usedRoutes = Array.from(baseGCDetails.usedRoutes).sort();
+            this.referenceUsedRoutes = Array.from(baseGCDetails.usedRoutes).sort();
+        }
     }
     async summarize(fullTree, trackState = true, telemetryContext) {
         // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this
@@ -96,10 +101,11 @@ export class SummarizerNodeWithGC extends SummarizerNode {
         // Load GC details from the initial summary, if not already loaded. If this is the first time this function is
         // called and the node's data has not changed since last summary, the GC data in initial details is returned.
         await this.loadBaseGCDetails();
-        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not
-        // have data from previous GC run for clients with older summary format before GC was added. They won't have
-        // GC details in their initial summary.
-        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {
+        // If there is no new data since last summary and we have GC data from the previous run, return it. The previous
+        // GC data may not be available if loaded from a snapshot with either GC disabled or before GC was added.
+        // Note - canReuseHandle is checked to be consistent with summarize - generate GC data for nodes for which
+        // summary must be generated.
+        if (this.canReuseHandle && !fullGC && !this.hasDataChanged() && this.gcData !== undefined) {
             return cloneGCData(this.gcData);
         }
         const gcData = await this.getGCDataFn(fullGC);
@@ -160,23 +166,79 @@ export class SummarizerNodeWithGC extends SummarizerNode {
         return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);
     }
     /**
-     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state
-     * to upload from it.
+     * Called when we need to upload the reference state from the given summary.
      */
     async refreshLatestSummaryFromSnapshot(referenceSequenceNumber, snapshotTree, basePath, localPath, correlatedSummaryLogger, readAndParseBlob) {
-        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
-        if (!this.gcDisabled) {
-            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];
+        await this.refreshGCStateFromSnapshot(referenceSequenceNumber, snapshotTree, readAndParseBlob);
+        return super.refreshLatestSummaryFromSnapshot(referenceSequenceNumber, snapshotTree, basePath, localPath, correlatedSummaryLogger, readAndParseBlob);
+    }
+    /**
+     * Updates GC state from the given snapshot if GC is enabled and the snapshot is newer than the one this node
+     * is tracking.
+     */
+    async refreshGCStateFromSnapshot(referenceSequenceNumber, snapshotTree, readAndParseBlob) {
+        // If GC is disabled or we have seen a newer summary, skip updating GC state.
+        if (this.gcDisabled || this.referenceSequenceNumber >= referenceSequenceNumber) {
+            return;
+        }
+        // Load the base GC details before proceeding because if that happens later it can overwrite the GC details
+        // written by the following code.
+        await this.loadBaseGCDetails();
+        // Possible re-entrancy. We may already have processed this while loading base GC details.
+        if (this.referenceSequenceNumber >= referenceSequenceNumber) {
+            return;
+        }
+        /**
+         * GC data is written at root of the snapshot tree under "gc" sub-tree. This data needs to be propagated to
+         * all the nodes in the container.
+         * The root summarizer node reads the GC data from the "gc" sub-tree, runs GC on it to get used routes in
+         * the container and updates its GC data and referenced used routes. It then gets the GC data and used
+         * routes of all its children and adds it to their snapshot tree.
+         * All the other nodes gets the GC data and used routes from their snapshot tree and updates their state.
+         * They get the GC data and used routes of their children and add it to their snapshot tree and so on.
+         *
+         * Note that if the snapshot does not have GC tree, GC data will be set to undefined and used routes will be
+         * set to self-route (meaning referenced) for all nodes. This is important because the GC data needs to be
+         * regenerated in the next summary.
+         */
+        let gcDetails;
+        const gcSnapshotTree = snapshotTree.trees[gcTreeKey];
+        if (gcSnapshotTree !== undefined) {
+            // If there is a GC tree in the snapshot, this is the root summarizer node. Read GC data from the tree
+            // process it as explained above.
+            const gcSnapshotData = await getGCDataFromSnapshot(gcSnapshotTree, readAndParseBlob);
+            const gcNodes = {};
+            for (const [nodeId, nodeData] of Object.entries(gcSnapshotData.gcState.gcNodes)) {
+                gcNodes[nodeId] = Array.from(nodeData.outboundRoutes);
+            }
+            // Run GC on the nodes in the snapshot to get the used routes for each node in the container.
+            const usedRoutes = runGarbageCollection(gcNodes, ["/"]).referencedNodeIds;
+            gcDetails = { gcData: { gcNodes }, usedRoutes };
+        }
+        else {
+            // If there is a GC blob in the snapshot, it's a non-root summarizer nodes - The root summarizer node
+            // writes GC blob in the snapshot of child nodes. Get  GC data and used routes from the blob.
+            const gcDetailsBlob = snapshotTree.blobs[gcTreeKey];
             if (gcDetailsBlob !== undefined) {
-                const gcDetails = await readAndParseBlob(gcDetailsBlob);
-                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.
-                if (this.referenceSequenceNumber >= referenceSequenceNumber) {
-                    return;
-                }
-                this.referenceUsedRoutes = gcDetails.usedRoutes;
+                gcDetails = JSON.parse(gcDetailsBlob);
             }
         }
-        return super.refreshLatestSummaryFromSnapshot(referenceSequenceNumber, snapshotTree, basePath, localPath, correlatedSummaryLogger, readAndParseBlob);
+        // Update this node to the same GC state it was when the ack corresponding to this summary was processed.
+        this.gcData = (gcDetails === null || gcDetails === void 0 ? void 0 : gcDetails.gcData) !== undefined ? cloneGCData(gcDetails.gcData) : undefined;
+        this.referenceUsedRoutes = (gcDetails === null || gcDetails === void 0 ? void 0 : gcDetails.usedRoutes) !== undefined ? Array.from(gcDetails.usedRoutes) : undefined;
+        // If there are no used routes in the GC details, set it to have self route which will make the node
+        // referenced. This scenario can only happen if the snapshot is from a client where GC was not run or
+        // disabled. In both the cases, the node should be referenced.
+        this.usedRoutes = (gcDetails === null || gcDetails === void 0 ? void 0 : gcDetails.usedRoutes) !== undefined ? Array.from(gcDetails.usedRoutes) : [""];
+        if (gcDetails === undefined) {
+            return;
+        }
+        // Generate the GC data and used routes of children GC nodes and add it to their snapshot tree.
+        const gcDetailsMap = unpackChildNodesGCDetails(gcDetails);
+        const { childrenTree } = parseSummaryForSubtrees(snapshotTree);
+        gcDetailsMap.forEach((childGCDetails, childId) => {
+            childrenTree.trees[childId].blobs[gcTreeKey] = JSON.stringify(childGCDetails);
+        });
     }
     /**
      * Override the createChild method to return an instance of SummarizerNodeWithGC.
@@ -194,10 +256,24 @@ export class SummarizerNodeWithGC extends SummarizerNode {
     createParam, config = {}, getGCDataFn, getBaseGCDetailsFn) {
         var _a;
         assert(!this.children.has(id), 0x1b6 /* "Create SummarizerNode child already exists" */);
+        /**
+          * Update the child node's base GC details from this node's current GC details instead of updating from the base
+          * GC details of this node. This will handle scenarios where the GC details was updated during refresh from
+          * snapshot and the child node wasn't created then. If a child is created after that, its GC details should be
+          * the one from the downloaded snapshot and not the base GC details.
+          */
+        const getChildBaseGCDetailsP = new LazyPromise(async () => {
+            var _a;
+            // Ensure that the base GC details is loaded because a child can be created before GC runs which is when
+            // base GC details is usually loaded.
+            await this.loadBaseGCDetails();
+            const childBaseGCDetails = unpackChildNodesGCDetails({ gcData: this.gcData, usedRoutes: this.usedRoutes });
+            return (_a = childBaseGCDetails.get(id)) !== null && _a !== void 0 ? _a : {};
+        });
         const createDetails = this.getCreateDetailsForChild(id, createParam);
         const child = new SummarizerNodeWithGC(this.defaultLogger, summarizeInternalFn, Object.assign(Object.assign({}, config), { 
             // Propagate our gcDisabled state to the child if its not explicity specified in child's config.
-            gcDisabled: (_a = config.gcDisabled) !== null && _a !== void 0 ? _a : this.gcDisabled }), createDetails.changeSequenceNumber, createDetails.latestSummary, createDetails.initialSummary, this.wipSummaryLogger, getGCDataFn, getBaseGCDetailsFn);
+            gcDisabled: (_a = config.gcDisabled) !== null && _a !== void 0 ? _a : this.gcDisabled }), createDetails.changeSequenceNumber, createDetails.latestSummary, createDetails.initialSummary, this.wipSummaryLogger, getGCDataFn, async () => getChildBaseGCDetailsP);
         // There may be additional state that has to be updated in this child. For example, if a summary is being
         // tracked, the child's summary tracking state needs to be updated too.
         this.maybeUpdateChildState(child);

package/lib/summarizerNode/summarizerNodeWithGc.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAEhE,OAAO,EAEH,SAAS,GASZ,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAKH,WAAW,GACd,MAAM,uBAAuB,CAAC;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,WAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;;QAC3B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,8GAA8G;QAC9G,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,6GAA6G;QAC7G,wEAAwE;QACxE,IAAI,CAAC,mBAAmB,GAAG,MAAA,aAAa,CAAC,UAAU,0CAAE,IAAI,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,8GAA8G;QAC9G,4GAA4G;QAC5G,uCAAuC;QACvC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAChE,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,CACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,MAAM,CAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,oBAAoB,MAAK,SAAS,EAAE;gBACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAgC,aAAa,CAAC,CAAC;gBAEvF,0FAA0F;gBAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;oBACzD,OAAO;iBACV;gBAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC,UAAU,CAAC;aACnD;SACJ;QAED,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,kBAAkB,CACrB,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcBlobKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we only update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        // Sort the used routes because we compare them with the current used routes to check if they changed between\n        // summaries. Both are sorted so that the order of elements is the same.\n        this.referenceUsedRoutes = baseGCDetails.usedRoutes?.sort();\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. We may not\n        // have data from previous GC run for clients with older summary format before GC was added. They won't have\n        // GC details in their initial summary.\n        if (!fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode?.serializedUsedRoutes !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary. Read the GC blob and get the state\n     * to upload from it.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const gcDetailsBlob = snapshotTree.blobs[gcBlobKey];\n            if (gcDetailsBlob !== undefined) {\n                const gcDetails = await readAndParseBlob<IGarbageCollectionDetailsBase>(gcDetailsBlob);\n\n                // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n                if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n                    return;\n                }\n\n                this.referenceUsedRoutes = gcDetails.usedRoutes;\n            }\n        }\n\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            getBaseGCDetailsFn,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}
+{"version":3,"file":"summarizerNodeWithGc.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAExI,OAAO,EAEH,SAAS,GASZ,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAKH,uBAAuB,EACvB,WAAW,GACd,MAAM,uBAAuB,CAAC;AAI/B,wDAAwD;AACxD,MAAM,iBAAkB,SAAQ,WAAW;IACvC,YACoB,oBAA4B,EAC5C,OAKC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,yBAAoB,GAApB,oBAAoB,CAAQ;IAShD,CAAC;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,oBAAqB,SAAQ,cAAc;IAuBpD;;;OAGG;IACH,YACI,MAAwB,EACP,WAIqB,EACtC,MAAmC,EACnC,oBAA4B;IAC5B,8CAA8C;IAC9C,aAA2B,EAC3B,cAAgC,EAChC,gBAAmC,EAClB,WAAmE,EACpF,kBAAiE;QAEjE,KAAK,CACD,MAAM,EACN,KAAK,EAAE,QAAiB,EAAE,WAAoB,EAAE,gBAAoC,EAAE,EAAE,CACpF,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,EAClE,MAAM,EACN,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,gBAAgB,CACnB,CAAC;QAvBe,gBAAW,GAAX,WAAW,CAIU;QAOrB,gBAAW,GAAX,WAAW,CAAwD;QA9BxF,4FAA4F;QACpF,wBAAmB,GAAY,KAAK,CAAC;QAI7C,mHAAmH;QACnH,iHAAiH;QACjH,iHAAiH;QACzG,eAAU,GAAa,CAAC,EAAE,CAAC,CAAC;QAoChC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC;QAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,WAAW,CAAC,KAAK,IAAI,EAAE;;YAC7C,OAAO,MAAA,CAAC,MAAM,CAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,EAAI,CAAA,CAAC,mCAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,iBAAiB;QAC3B,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;QAEhD,yGAAyG;QACzG,6CAA6C;QAC7C,IAAI,IAAI,CAAC,mBAAmB,EAAE;YAC1B,OAAO;SACV;QACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAEhC,8GAA8G;QAC9G,oGAAoG;QACpG,iEAAiE;QACjE,IAAI,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,IAAI,aAAa,CAAC,UAAU,KAAK,SAAS,EAAE;YACxC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9D,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAA;SACzE;IACL,CAAC;IAEM,KAAK,CAAC,SAAS,CAClB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,+GAA+G;QAC/G,0EAA0E;QAC1E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,MAAM,CAAC,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC7C,KAAK,CAAC,2DAA2D,CAAC,CAAC;SAC1E;QAED,2FAA2F;QAC3F,8DAA8D;QAC9D,OAAO,UAAU;YACb,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YACpE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAAkB,KAAK;QAC1C,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;QAClG,MAAM,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAEtG,8GAA8G;QAC9G,6GAA6G;QAC7G,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,gHAAgH;QAChH,yGAAyG;QACzG,0GAA0G;QAC1G,6BAA6B;QAC7B,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YACvF,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACnC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QAChF,sFAAsF;QACtF,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,CACF,IAAI,CAAC,uBAAuB,KAAK,SAAS,EAC1C,KAAK,CAAC,iFAAiF,CAAC,CAAC;SAChG;QACD,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACO,mBAAmB,CACzB,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAI,uBAA2C,CAAC;QAChD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC;YACvD,MAAM,CAAC,uBAAuB,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACzG;QAED,KAAK,CAAC,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAE3E,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC3B,oEAAoE;gBACpE,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,uBAAwB,EAAE,WAAW,CAAC,CAAC;gBACvF,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;aAChE;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QACzC,KAAK,CAAC,YAAY,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACO,+BAA+B,CACrC,cAAsB,EACtB,uBAA+B;QAE/B,6FAA6F;QAC7F,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YAClB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAsB,CAAC;YACnF,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,oBAAoB,MAAK,SAAS,EAAE;gBACjD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;aAC3E;SACJ;QAED,OAAO,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;IAC1F,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,gCAAgC,CAC5C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,MAAM,IAAI,CAAC,0BAA0B,CAAC,uBAAuB,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;QAC/F,OAAO,KAAK,CAAC,gCAAgC,CACzC,uBAAuB,EACvB,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,0BAA0B,CACpC,uBAA+B,EAC/B,YAA2B,EAC3B,gBAAkC;QAElC,6EAA6E;QAC7E,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;YAC5E,OAAO;SACV;QAED,2GAA2G;QAC3G,iCAAiC;QACjC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE/B,0FAA0F;QAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;YACzD,OAAO;SACV;QAED;;;;;;;;;;;;WAYG;QACH,IAAI,SAAoD,CAAC;QACzD,MAAM,cAAc,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,cAAc,KAAK,SAAS,EAAE;YAC9B,sGAAsG;YACtG,iCAAiC;YACjC,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;YAErF,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC7E,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;aACzD;YACD,6FAA6F;YAC7F,MAAM,UAAU,GAAG,oBAAoB,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC;YAC1E,SAAS,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,CAAC;SACnD;aAAM;YACH,qGAAqG;YACrG,6FAA6F;YAC7F,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpD,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC7B,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAkC,CAAC;aAC1E;SACJ;QAED,yGAAyG;QACzG,IAAI,CAAC,MAAM,GAAG,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,MAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1F,IAAI,CAAC,mBAAmB,GAAG,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,MAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9G,oGAAoG;QACpG,qGAAqG;QACrG,8DAA8D;QAC9D,IAAI,CAAC,UAAU,GAAG,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,MAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAEhG,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,OAAO;SACV;QAED,+FAA+F;QAC/F,MAAM,YAAY,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,EAAE,YAAY,EAAE,GAAG,uBAAuB,CAAC,YAAY,CAAC,CAAC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,cAA6C,EAAE,OAAe,EAAE,EAAE;YACpF,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,WAAW;IACd,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE;;QAEjE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,kDAAkD,CAAC,CAAC;QAEzF;;;;;YAKI;QACJ,MAAM,sBAAsB,GAAG,IAAI,WAAW,CAAgC,KAAK,IAAI,EAAE;;YACrF,wGAAwG;YACxG,qCAAqC;YACrC,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC/B,MAAM,kBAAkB,GAAG,yBAAyB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC3G,OAAO,MAAA,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,mCAAI,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAwB,IAAI,CAAC,wBAAwB,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QAC1F,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAClC,IAAI,CAAC,aAAa,EAClB,mBAAmB,kCAEZ,MAAM;YACT,gGAAgG;YAChG,UAAU,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU,KAEpD,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,WAAW,EACX,KAAK,IAAI,EAAE,CAAC,sBAAsB,CACrC,CAAC;QAEF,yGAAyG;QACzG,uEAAuE;QACvE,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,EAAU;QACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAyB,CAAC;IACzD,CAAC;IAEM,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACzE,CAAC;IAEM,gBAAgB,CAAC,UAAoB;QACxC,4GAA4G;QAC5G,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAEpC,8GAA8G;QAC9G,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE;YACjD,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAClE;IACL,CAAC;IAED;;OAEG;IACO,UAAU;QAChB,OAAO,IAAI,CAAC,cAAc,EAAE,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,cAAc;QAClB,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACK,mBAAmB;QACvB,mEAAmE;QACnE,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,mBAAmB,KAAK,SAAS;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACrF,CAAC;CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC1C,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAsC,EAAE,EACxC,WAAmE,EACnE,kBAAiE,EACxC,EAAE,CAAC,IAAI,oBAAoB,CACpD,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACtG,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,WAAW,EACX,kBAAkB,CACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, LazyPromise } from \"@fluidframework/common-utils\";\nimport { cloneGCData, getGCDataFromSnapshot, runGarbageCollection, unpackChildNodesGCDetails } from \"@fluidframework/garbage-collector\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport {\n    CreateChildSummarizerNodeParam,\n    gcTreeKey,\n    IGarbageCollectionData,\n    IGarbageCollectionDetailsBase,\n    ISummarizeInternalResult,\n    ISummarizeResult,\n    ISummarizerNodeConfigWithGC,\n    ISummarizerNodeWithGC,\n    SummarizeInternalFn,\n    ITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\nimport { SummarizerNode } from \"./summarizerNode\";\nimport {\n    EscapedPath,\n    ICreateChildDetails,\n    IInitialSummary,\n    ISummarizerNodeRootContract,\n    parseSummaryForSubtrees,\n    SummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {}\n\n// Extend SummaryNode to add used routes tracking to it.\nclass SummaryNodeWithGC extends SummaryNode {\n    constructor(\n        public readonly serializedUsedRoutes: string,\n        summary: {\n            readonly referenceSequenceNumber: number;\n            readonly basePath: EscapedPath | undefined;\n            readonly localPath: EscapedPath;\n            additionalPath?: EscapedPath;\n        },\n    ) {\n        super(summary);\n    }\n}\n\n/**\n * Extends the functionality of SummarizerNode to manage this node's garbage collection data:\n *\n * - Adds a new API `getGCData` to return GC data of this node.\n *\n * - Caches the result of `getGCData` to be used if nothing changes between summaries.\n *\n * - Manages the used routes of this node. These are used to identify if this node is referenced in the document\n * and to determine if the node's used state changed since last summary.\n *\n * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls\n * directly into summarizeInternal method.\n */\nexport class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {\n    // Tracks the work-in-progress used routes during summary.\n    private wipSerializedUsedRoutes: string | undefined;\n\n    // This is the last known used routes of this node as seen by the server as part of a summary.\n    private referenceUsedRoutes: string[] | undefined;\n\n    // The base GC details of this node used to initialize the GC state.\n    private readonly baseGCDetailsP: LazyPromise<IGarbageCollectionDetailsBase>;\n\n    // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.\n    private baseGCDetailsLoaded: boolean = false;\n\n    private gcData: IGarbageCollectionData | undefined;\n\n    // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure\n    // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is\n    // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.\n    private usedRoutes: string[] = [\"\"];\n\n    // True if GC is disabled for this node. If so, do not track GC specific state for a summary.\n    private readonly gcDisabled: boolean;\n\n    /**\n     * Do not call constructor directly.\n     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.\n     */\n    public constructor(\n        logger: ITelemetryLogger,\n        private readonly summarizeFn: (\n            fullTree: boolean,\n            trackState: boolean,\n            telemetryContext?: ITelemetryContext,\n        ) => Promise<ISummarizeInternalResult>,\n        config: ISummarizerNodeConfigWithGC,\n        changeSequenceNumber: number,\n        /** Undefined means created without summary */\n        latestSummary?: SummaryNode,\n        initialSummary?: IInitialSummary,\n        wipSummaryLogger?: ITelemetryLogger,\n        private readonly getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ) {\n        super(\n            logger,\n            async (fullTree: boolean, _trackState: boolean, telemetryContext?: ITelemetryContext) =>\n                summarizeFn(fullTree, true /* trackState */, telemetryContext),\n            config,\n            changeSequenceNumber,\n            latestSummary,\n            initialSummary,\n            wipSummaryLogger,\n        );\n\n        this.gcDisabled = config.gcDisabled === true;\n\n        this.baseGCDetailsP = new LazyPromise(async () => {\n            return (await getBaseGCDetailsFn?.()) ?? { usedRoutes: [] };\n        });\n    }\n\n    /**\n     * Loads state from this node's initial GC summary details. This contains the following data from the last summary\n     * seen by the server for this client:\n     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.\n     * - gcData: The garbage collection data of this node that is required for running GC.\n     */\n    private async loadBaseGCDetails() {\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        const baseGCDetails = await this.baseGCDetailsP;\n\n        // Possible race - If there were parallel calls to loadBaseGCDetails, we want to make sure that we update\n        // the state from the base details only once.\n        if (this.baseGCDetailsLoaded) {\n            return;\n        }\n        this.baseGCDetailsLoaded = true;\n\n        // Update GC data, used routes and reference used routes. The used routes are sorted because they are compared\n        // across GC runs to check if they changed. Sorting ensures that the elements are in the same order.\n        // If the GC details has GC data, initialize our GC data from it.\n        if (baseGCDetails.gcData !== undefined) {\n            this.gcData = cloneGCData(baseGCDetails.gcData);\n        }\n        if (baseGCDetails.usedRoutes !== undefined) {\n            this.usedRoutes = Array.from(baseGCDetails.usedRoutes).sort();\n            this.referenceUsedRoutes = Array.from(baseGCDetails.usedRoutes).sort()\n        }\n    }\n\n    public async summarize(\n        fullTree: boolean,\n        trackState: boolean = true,\n        telemetryContext?: ITelemetryContext,\n    ): Promise<ISummarizeResult> {\n        // If GC is not disabled and we are tracking a summary, GC should have run and updated the used routes for this\n        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            assert(this.wipSerializedUsedRoutes !== undefined,\n                0x1b1 /* \"wip used routes should be set if tracking a summary\" */);\n        }\n\n        // If trackState is true, get summary from base summarizer node which tracks summary state.\n        // If trackState is false, get summary from summarizeInternal.\n        return trackState\n            ? super.summarize(fullTree, true /* trackState */, telemetryContext)\n            : this.summarizeFn(fullTree, trackState, telemetryContext);\n    }\n\n    /**\n     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from\n     * the previous summary. Else, it gets new GC data from the underlying Fluid object.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data.\n     */\n    public async getGCData(fullGC: boolean = false): Promise<IGarbageCollectionData> {\n        assert(!this.gcDisabled, 0x1b2 /* \"Getting GC data should not be called when GC is disabled!\" */);\n        assert(this.getGCDataFn !== undefined, 0x1b3 /* \"GC data cannot be retrieved without getGCDataFn\" */);\n\n        // Load GC details from the initial summary, if not already loaded. If this is the first time this function is\n        // called and the node's data has not changed since last summary, the GC data in initial details is returned.\n        await this.loadBaseGCDetails();\n\n        // If there is no new data since last summary and we have GC data from the previous run, return it. The previous\n        // GC data may not be available if loaded from a snapshot with either GC disabled or before GC was added.\n        // Note - canReuseHandle is checked to be consistent with summarize - generate GC data for nodes for which\n        // summary must be generated.\n        if (this.canReuseHandle && !fullGC && !this.hasDataChanged() && this.gcData !== undefined) {\n            return cloneGCData(this.gcData);\n        }\n\n        const gcData = await this.getGCDataFn(fullGC);\n        this.gcData = cloneGCData(gcData);\n        return gcData;\n    }\n\n    /**\n     * Called during the start of a summary. Updates the work-in-progress used routes.\n     */\n    public startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n        // If GC is disabled, skip setting wip used routes since we should not track GC state.\n        if (!this.gcDisabled) {\n            assert(\n                this.wipSerializedUsedRoutes === undefined,\n                0x1b4 /* \"We should not already be tracking used routes when to track a new summary\" */);\n        }\n        super.startSummary(referenceSequenceNumber, summaryLogger);\n    }\n\n    /**\n     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending\n     * summary queue. We track this until we get an ack from the server for this summary.\n     */\n    protected completeSummaryCore(\n        proposalHandle: string,\n        parentPath: EscapedPath | undefined,\n        parentSkipRecursion: boolean,\n    ) {\n        let wipSerializedUsedRoutes: string | undefined;\n        // If GC is disabled, don't set wip used routes.\n        if (!this.gcDisabled) {\n            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;\n            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* \"We should have been tracking used routes\" */);\n        }\n\n        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);\n\n        // If GC is disabled, skip setting pending summary with GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle);\n            if (summaryNode !== undefined) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const summaryNodeWithGC = new SummaryNodeWithGC(wipSerializedUsedRoutes!, summaryNode);\n                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);\n            }\n        }\n    }\n\n    /**\n     * Clears the work-in-progress state.\n     */\n    public clearSummary() {\n        this.wipSerializedUsedRoutes = undefined;\n        super.clearSummary();\n    }\n\n    /**\n     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node\n     * from the state in the pending summary queue.\n     */\n    protected refreshLatestSummaryFromPending(\n        proposalHandle: string,\n        referenceSequenceNumber: number,\n    ): void {\n        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.\n        if (!this.gcDisabled) {\n            const summaryNode = this.pendingSummaries.get(proposalHandle) as SummaryNodeWithGC;\n            if (summaryNode?.serializedUsedRoutes !== undefined) {\n                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);\n            }\n        }\n\n        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n    }\n\n    /**\n     * Called when we need to upload the reference state from the given summary.\n     */\n    protected async refreshLatestSummaryFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        basePath: EscapedPath | undefined,\n        localPath: EscapedPath,\n        correlatedSummaryLogger: ITelemetryLogger,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        await this.refreshGCStateFromSnapshot(referenceSequenceNumber, snapshotTree, readAndParseBlob);\n        return super.refreshLatestSummaryFromSnapshot(\n            referenceSequenceNumber,\n            snapshotTree,\n            basePath,\n            localPath,\n            correlatedSummaryLogger,\n            readAndParseBlob,\n        );\n    }\n\n    /**\n     * Updates GC state from the given snapshot if GC is enabled and the snapshot is newer than the one this node\n     * is tracking.\n     */\n    private async refreshGCStateFromSnapshot(\n        referenceSequenceNumber: number,\n        snapshotTree: ISnapshotTree,\n        readAndParseBlob: ReadAndParseBlob,\n    ): Promise<void> {\n        // If GC is disabled or we have seen a newer summary, skip updating GC state.\n        if (this.gcDisabled || this.referenceSequenceNumber >= referenceSequenceNumber) {\n            return;\n        }\n\n        // Load the base GC details before proceeding because if that happens later it can overwrite the GC details\n        // written by the following code.\n        await this.loadBaseGCDetails();\n\n        // Possible re-entrancy. We may already have processed this while loading base GC details.\n        if (this.referenceSequenceNumber >= referenceSequenceNumber) {\n            return;\n        }\n\n        /**\n         * GC data is written at root of the snapshot tree under \"gc\" sub-tree. This data needs to be propagated to\n         * all the nodes in the container.\n         * The root summarizer node reads the GC data from the \"gc\" sub-tree, runs GC on it to get used routes in\n         * the container and updates its GC data and referenced used routes. It then gets the GC data and used\n         * routes of all its children and adds it to their snapshot tree.\n         * All the other nodes gets the GC data and used routes from their snapshot tree and updates their state.\n         * They get the GC data and used routes of their children and add it to their snapshot tree and so on.\n         *\n         * Note that if the snapshot does not have GC tree, GC data will be set to undefined and used routes will be\n         * set to self-route (meaning referenced) for all nodes. This is important because the GC data needs to be\n         * regenerated in the next summary.\n         */\n        let gcDetails: IGarbageCollectionDetailsBase | undefined;\n        const gcSnapshotTree = snapshotTree.trees[gcTreeKey];\n        if (gcSnapshotTree !== undefined) {\n            // If there is a GC tree in the snapshot, this is the root summarizer node. Read GC data from the tree\n            // process it as explained above.\n            const gcSnapshotData = await getGCDataFromSnapshot(gcSnapshotTree, readAndParseBlob);\n\n            const gcNodes: { [id: string]: string[]; } = {};\n            for (const [nodeId, nodeData] of Object.entries(gcSnapshotData.gcState.gcNodes)) {\n                gcNodes[nodeId] = Array.from(nodeData.outboundRoutes);\n            }\n            // Run GC on the nodes in the snapshot to get the used routes for each node in the container.\n            const usedRoutes = runGarbageCollection(gcNodes, [\"/\"]).referencedNodeIds;\n            gcDetails = { gcData: { gcNodes }, usedRoutes };\n        } else {\n            // If there is a GC blob in the snapshot, it's a non-root summarizer nodes - The root summarizer node\n            // writes GC blob in the snapshot of child nodes. Get  GC data and used routes from the blob.\n            const gcDetailsBlob = snapshotTree.blobs[gcTreeKey];\n            if (gcDetailsBlob !== undefined) {\n                gcDetails = JSON.parse(gcDetailsBlob) as IGarbageCollectionDetailsBase;\n            }\n        }\n\n        // Update this node to the same GC state it was when the ack corresponding to this summary was processed.\n        this.gcData = gcDetails?.gcData !== undefined ? cloneGCData(gcDetails.gcData) : undefined;\n        this.referenceUsedRoutes = gcDetails?.usedRoutes !== undefined ? Array.from(gcDetails.usedRoutes) : undefined;\n        // If there are no used routes in the GC details, set it to have self route which will make the node\n        // referenced. This scenario can only happen if the snapshot is from a client where GC was not run or\n        // disabled. In both the cases, the node should be referenced.\n        this.usedRoutes = gcDetails?.usedRoutes !== undefined ? Array.from(gcDetails.usedRoutes) : [\"\"];\n\n        if (gcDetails === undefined) {\n            return;\n        }\n\n        // Generate the GC data and used routes of children GC nodes and add it to their snapshot tree.\n        const gcDetailsMap = unpackChildNodesGCDetails(gcDetails);\n        const { childrenTree } = parseSummaryForSubtrees(snapshotTree);\n        gcDetailsMap.forEach((childGCDetails: IGarbageCollectionDetailsBase, childId: string) => {\n            childrenTree.trees[childId].blobs[gcTreeKey] = JSON.stringify(childGCDetails);\n        });\n    }\n\n    /**\n     * Override the createChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public createChild(\n        /** Summarize function */\n        summarizeInternalFn: SummarizeInternalFn,\n        /** Initial id or path part of this node */\n        id: string,\n        /**\n         * Information needed to create the node.\n         * If it is from a base summary, it will assert that a summary has been seen.\n         * Attach information if it is created from an attach op.\n         */\n        createParam: CreateChildSummarizerNodeParam,\n        config: ISummarizerNodeConfigWithGC = {},\n        getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n        getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n    ): ISummarizerNodeWithGC {\n        assert(!this.children.has(id), 0x1b6 /* \"Create SummarizerNode child already exists\" */);\n\n        /**\n          * Update the child node's base GC details from this node's current GC details instead of updating from the base\n          * GC details of this node. This will handle scenarios where the GC details was updated during refresh from\n          * snapshot and the child node wasn't created then. If a child is created after that, its GC details should be\n          * the one from the downloaded snapshot and not the base GC details.\n          */\n        const getChildBaseGCDetailsP = new LazyPromise<IGarbageCollectionDetailsBase>(async () => {\n            // Ensure that the base GC details is loaded because a child can be created before GC runs which is when\n            // base GC details is usually loaded.\n            await this.loadBaseGCDetails();\n            const childBaseGCDetails = unpackChildNodesGCDetails({ gcData: this.gcData, usedRoutes: this.usedRoutes });\n            return childBaseGCDetails.get(id) ?? {};\n        });\n\n        const createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n        const child = new SummarizerNodeWithGC(\n            this.defaultLogger,\n            summarizeInternalFn,\n            {\n                ...config,\n                // Propagate our gcDisabled state to the child if its not explicity specified in child's config.\n                gcDisabled: config.gcDisabled ?? this.gcDisabled,\n            },\n            createDetails.changeSequenceNumber,\n            createDetails.latestSummary,\n            createDetails.initialSummary,\n            this.wipSummaryLogger,\n            getGCDataFn,\n            async () => getChildBaseGCDetailsP,\n        );\n\n        // There may be additional state that has to be updated in this child. For example, if a summary is being\n        // tracked, the child's summary tracking state needs to be updated too.\n        this.maybeUpdateChildState(child);\n\n        this.children.set(id, child);\n        return child;\n    }\n\n    /**\n     * Deletes the child node with the given id.\n     */\n    public deleteChild(id: string): void {\n        this.children.delete(id);\n    }\n\n    /**\n     * Override the getChild method to return an instance of SummarizerNodeWithGC.\n     */\n    public getChild(id: string): ISummarizerNodeWithGC | undefined {\n        return this.children.get(id) as SummarizerNodeWithGC;\n    }\n\n    public isReferenced(): boolean {\n        return this.usedRoutes.includes(\"\") || this.usedRoutes.includes(\"/\");\n    }\n\n    public updateUsedRoutes(usedRoutes: string[]) {\n        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()\n        // are in the same order.\n        this.usedRoutes = usedRoutes.sort();\n\n        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can\n        // be tracked for this summary.\n        if (!this.gcDisabled && this.isTrackingInProgress()) {\n            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);\n        }\n    }\n\n    /**\n     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.\n     */\n    protected hasChanged(): boolean {\n        return this.hasDataChanged() || this.hasUsedStateChanged();\n    }\n\n    /**\n     * This tells whether the data in this node has changed or not.\n     */\n    private hasDataChanged(): boolean {\n        return super.hasChanged();\n    }\n\n    /**\n     * This tells whether the used state of this node has changed since last successful summary. If the used routes\n     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes\n     * was previously used and became unused (or vice versa), its used state has changed.\n     */\n    private hasUsedStateChanged(): boolean {\n        // If GC is disabled, we are not tracking used state, return false.\n        if (this.gcDisabled) {\n            return false;\n        }\n\n        return this.referenceUsedRoutes === undefined ||\n            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes);\n    }\n}\n\n/**\n * Creates a root summarizer node with GC functionality built-in.\n * @param logger - Logger to use within SummarizerNode\n * @param summarizeInternalFn - Function to generate summary\n * @param changeSequenceNumber - Sequence number of latest change to new node/subtree\n * @param referenceSequenceNumber - Reference sequence number of last acked summary,\n * or undefined if not loaded from summary\n * @param config - Configure behavior of summarizer node\n * @param getGCDataFn - Function to get the GC data of this node\n * @param baseGCDetailsP - Function to get the initial GC details of this node\n */\nexport const createRootSummarizerNodeWithGC = (\n    logger: ITelemetryLogger,\n    summarizeInternalFn: SummarizeInternalFn,\n    changeSequenceNumber: number,\n    referenceSequenceNumber: number | undefined,\n    config: ISummarizerNodeConfigWithGC = {},\n    getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>,\n    getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>,\n): IRootSummarizerNodeWithGC => new SummarizerNodeWithGC(\n    logger,\n    summarizeInternalFn,\n    config,\n    changeSequenceNumber,\n    referenceSequenceNumber === undefined ? undefined : SummaryNode.createForRoot(referenceSequenceNumber),\n    undefined /* initialSummary */,\n    undefined /* wipSummaryLogger */,\n    getGCDataFn,\n    getBaseGCDetailsFn,\n);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/runtime-utils",
-  "version": "2.0.0-internal.2.2.1",
+  "version": "2.0.0-internal.2.3.1",
   "description": "Collection of utility functions for Fluid Runtime",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -64,23 +64,23 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/garbage-collector": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-definitions": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/garbage-collector": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
     "@fluidframework/protocol-base": "^0.1038.2000",
     "@fluidframework/protocol-definitions": "^1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0"
+    "@fluidframework/runtime-definitions": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0"
   },
   "devDependencies": {
     "@fluid-tools/build-cli": "^0.7.0",
     "@fluidframework/build-common": "^1.1.0",
     "@fluidframework/build-tools": "^0.7.0",
-    "@fluidframework/eslint-config-fluid": "^1.2.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.2.1 <2.0.0-internal.3.0.0",
-    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.2.2.0",
+    "@fluidframework/eslint-config-fluid": "^2.0.0",
+    "@fluidframework/mocha-test-setup": ">=2.0.0-internal.2.3.1 <2.0.0-internal.3.0.0",
+    "@fluidframework/runtime-utils-previous": "npm:@fluidframework/runtime-utils@2.0.0-internal.2.3.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",
@@ -98,8 +98,8 @@
     "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "2.0.0-internal.2.2.0",
-    "baselineRange": "2.0.0-internal.2.2.0",
+    "version": "2.0.0-internal.2.3.1",
+    "baselineRange": "2.0.0-internal.2.3.0",
     "broken": {}
   }
 }

package/src/dataStoreHelpers.ts

@@ -23,6 +23,7 @@ interface IResponseException extends Error {
     message: string;
     code: number;
     stack?: string;
+    underlyingResponseHeaders?: { [key: string]: any; };
 }
 
 export function exceptionToResponse(err: any): IResponse {
@@ -34,6 +35,7 @@ export function exceptionToResponse(err: any): IResponse {
             status: responseErr.code,
             value: responseErr.message,
             get stack() { return responseErr.stack; },
+            headers: responseErr.underlyingResponseHeaders,
         };
     }
 
@@ -57,6 +59,7 @@ export function responseToException(response: IResponse, request: IRequest): Err
         name: "Error",
         code: response.status,
         get stack() { return response.stack ?? errWithStack.stack; },
+        underlyingResponseHeaders: response.headers,
     };
 
     return responseErr;
@@ -86,7 +89,7 @@ export async function requestFluidObject<T = FluidObject>(
 
 export const create404Response = (request: IRequest) => createResponseError(404, "not found", request);
 
-export function createResponseError(status: number, value: string, request: IRequest): IResponse {
+export function createResponseError(status: number, value: string, request: IRequest, headers?: { [key: string]: any }): IResponse {
     assert(status !== 200, 0x19b /* "Cannot not create response error on 200 status" */);
     // Omit query string which could contain personal data (aka "PII")
     const urlNoQuery = request.url?.split("?")[0];
@@ -99,6 +102,7 @@ export function createResponseError(status: number, value: string, request: IReq
         status,
         value: urlNoQuery === undefined ? value : `${value}: ${urlNoQuery}`,
         get stack() { return errWithStack.stack; },
+        headers,
     };
 }
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/runtime-utils";
-export const pkgVersion = "2.0.0-internal.2.2.1";
+export const pkgVersion = "2.0.0-internal.2.3.1";

package/src/summarizerNode/summarizerNode.ts

@@ -384,7 +384,7 @@ export class SummarizerNode implements IRootSummarizerNode {
         return this._latestSummary;
     }
 
-    private readonly canReuseHandle: boolean;
+    protected readonly canReuseHandle: boolean;
 
     /**
      * Do not call constructor directly.