@fluidframework/runtime-utils 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/lib/summarizerNode/summarizerNodeUtils.js

@@ -1,125 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { channelsTreeName } from "@fluidframework/runtime-definitions";
-/** Path for nodes in a tree with escaped special characters */
-export class EscapedPath {
-    constructor(path) {
-        this.path = path;
-    }
-    static create(path) {
-        return new EscapedPath(encodeURIComponent(path));
-    }
-    static createAndConcat(pathParts) {
-        var _a;
-        let ret = EscapedPath.create((_a = pathParts[0]) !== null && _a !== void 0 ? _a : "");
-        for (let i = 1; i < pathParts.length; i++) {
-            ret = ret.concat(EscapedPath.create(pathParts[i]));
-        }
-        return ret;
-    }
-    toString() {
-        return this.path;
-    }
-    concat(path) {
-        return new EscapedPath(`${this.path}/${path.path}`);
-    }
-}
-/** Information about a summary relevant to a specific node in the tree */
-export class SummaryNode {
-    constructor(summary) {
-        this.summary = summary;
-    }
-    /** Creates an instance that is valid for the root with specific basePath and localPath */
-    static createForRoot(referenceSequenceNumber) {
-        return new SummaryNode({
-            referenceSequenceNumber,
-            basePath: undefined,
-            localPath: EscapedPath.create(""), // root hard-coded to ""
-        });
-    }
-    /** Summary reference sequence number, i.e. last sequence number seen when it was created */
-    get referenceSequenceNumber() {
-        return this.summary.referenceSequenceNumber;
-    }
-    /** Full path to parent node, or undefined if this is the root */
-    get basePath() {
-        return this.summary.basePath;
-    }
-    /** Relative path to this node from its parent node */
-    get localPath() {
-        return this.summary.localPath;
-    }
-    /** Relative path from this node to its node innermost base summary */
-    get additionalPath() {
-        return this.summary.additionalPath;
-    }
-    set additionalPath(additionalPath) {
-        this.summary.additionalPath = additionalPath;
-    }
-    /** Gets the full path to this node, to be used when sending a handle */
-    get fullPath() {
-        var _a, _b;
-        return (_b = (_a = this.basePath) === null || _a === void 0 ? void 0 : _a.concat(this.localPath)) !== null && _b !== void 0 ? _b : this.localPath;
-    }
-    /**
-     * Gets the full path to this node's innermost base summary.
-     * The children nodes can use this as their basePath to determine their path.
-     */
-    get fullPathForChildren() {
-        return this.additionalPath !== undefined
-            ? this.fullPath.concat(this.additionalPath)
-            : this.fullPath;
-    }
-    /**
-     * Creates a new node within the same summary for a child of this node.
-     * @param id - id of the child node
-     */
-    createForChild(id) {
-        return new SummaryNode({
-            referenceSequenceNumber: this.referenceSequenceNumber,
-            basePath: this.fullPathForChildren,
-            localPath: EscapedPath.create(id),
-        });
-    }
-}
-/**
- * Checks if the summary contains .channels subtree where the children subtrees
- * would be located if exists.
- * @param baseSummary - summary to check
- */
-export function parseSummaryForSubtrees(baseSummary) {
-    // New versions of snapshots have child nodes isolated in .channels subtree
-    const channelsSubtree = baseSummary.trees[channelsTreeName];
-    if (channelsSubtree !== undefined) {
-        return {
-            childrenTree: channelsSubtree,
-            childrenPathPart: channelsTreeName,
-        };
-    }
-    return {
-        childrenTree: baseSummary,
-        childrenPathPart: undefined,
-    };
-}
-/**
- * Checks if the summary contains .channels subtree where the children subtrees
- * would be located if exists.
- * @param baseSummary - summary to check
- */
-export function parseSummaryTreeForSubtrees(summary) {
-    // New versions of snapshots have child nodes isolated in .channels subtree
-    const channelsSubtree = summary.tree[channelsTreeName];
-    if (channelsSubtree !== undefined) {
-        return {
-            childrenTree: channelsSubtree,
-            childrenPathPart: channelsTreeName,
-        };
-    }
-    return {
-        childrenTree: summary,
-        childrenPathPart: undefined,
-    };
-}
-//# sourceMappingURL=summarizerNodeUtils.js.map

package/lib/summarizerNode/summarizerNodeUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarizerNodeUtils.js","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAyB,MAAM,qCAAqC,CAAC;AAwC9F,+DAA+D;AAC/D,MAAM,OAAO,WAAW;IACvB,YAAoC,IAAY;QAAZ,SAAI,GAAJ,IAAI,CAAQ;IAAG,CAAC;IAC7C,MAAM,CAAC,MAAM,CAAC,IAAY;QAChC,OAAO,IAAI,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IAClD,CAAC;IACM,MAAM,CAAC,eAAe,CAAC,SAAmB;;QAChD,IAAI,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,MAAA,SAAS,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC1C,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACnD;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IACM,QAAQ;QACd,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IACM,MAAM,CAAC,IAAiB;QAC9B,OAAO,IAAI,WAAW,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;CACD;AAED,0EAA0E;AAC1E,MAAM,OAAO,WAAW;IA6BvB,YACkB,OAKhB;QALgB,YAAO,GAAP,OAAO,CAKvB;IACC,CAAC;IAnCJ,0FAA0F;IACnF,MAAM,CAAC,aAAa,CAAC,uBAA+B;QAC1D,OAAO,IAAI,WAAW,CAAC;YACtB,uBAAuB;YACvB,QAAQ,EAAE,SAAS;YACnB,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,wBAAwB;SAC3D,CAAC,CAAC;IACJ,CAAC;IAED,4FAA4F;IAC5F,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC;IAC7C,CAAC;IACD,iEAAiE;IACjE,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC9B,CAAC;IACD,sDAAsD;IACtD,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAC/B,CAAC;IACD,sEAAsE;IACtE,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;IACpC,CAAC;IACD,IAAW,cAAc,CAAC,cAAuC;QAChE,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;IAC9C,CAAC;IAUD,wEAAwE;IACxE,IAAW,QAAQ;;QAClB,OAAO,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,IAAW,mBAAmB;QAC7B,OAAO,IAAI,CAAC,cAAc,KAAK,SAAS;YACvC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;YAC3C,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,EAAU;QAC/B,OAAO,IAAI,WAAW,CAAC;YACtB,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;YACrD,QAAQ,EAAE,IAAI,CAAC,mBAAmB;YAClC,SAAS,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;SACjC,CAAC,CAAC;IACJ,CAAC;CACD;AA+CD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,WAA0B;IACjE,2EAA2E;IAC3E,MAAM,eAAe,GAAG,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC5D,IAAI,eAAe,KAAK,SAAS,EAAE;QAClC,OAAO;YACN,YAAY,EAAE,eAAe;YAC7B,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;KACF;IACD,OAAO;QACN,YAAY,EAAE,WAAW;QACzB,gBAAgB,EAAE,SAAS;KAC3B,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,OAAqB;IAChE,2EAA2E;IAC3E,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACvD,IAAI,eAAe,KAAK,SAAS,EAAE;QAClC,OAAO;YACN,YAAY,EAAE,eAAe;YAC7B,gBAAgB,EAAE,gBAAgB;SAClC,CAAC;KACF;IACD,OAAO;QACN,YAAY,EAAE,OAAO;QACrB,gBAAgB,EAAE,SAAS;KAC3B,CAAC;AACH,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 { ISnapshotTree, ISummaryTree, SummaryObject } from \"@fluidframework/protocol-definitions\";\nimport { channelsTreeName, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { ReadAndParseBlob } from \"../utils\";\n\n/**\n * Return value of refreshSummaryAck function. There can be three different scenarios based on the passed params:\n *\n * 1. The latest summary was not udpated.\n *\n * 2. The latest summary was updated and the summary corresponding to the params was tracked by this client.\n *\n * 3. The latest summary was updated but the summary corresponding to the params was not tracked. In this case, the\n * latest summary is updated based on the downloaded snapshot which is also returned.\n */\nexport type RefreshSummaryResult =\n\t| {\n\t\t\tlatestSummaryUpdated: false;\n\t  }\n\t| {\n\t\t\tlatestSummaryUpdated: true;\n\t\t\twasSummaryTracked: true;\n\t  }\n\t| {\n\t\t\tlatestSummaryUpdated: true;\n\t\t\twasSummaryTracked: false;\n\t\t\tsnapshot: ISnapshotTree;\n\t  };\n\nexport interface ISummarizerNodeRootContract {\n\tstartSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger): void;\n\tcompleteSummary(proposalHandle: string): void;\n\tclearSummary(): void;\n\trefreshLatestSummary(\n\t\tproposalHandle: string | undefined,\n\t\tsummaryRefSeq: number,\n\t\tgetSnapshot: () => Promise<ISnapshotTree>,\n\t\treadAndParseBlob: ReadAndParseBlob,\n\t\tcorrelatedSummaryLogger: ITelemetryLogger,\n\t): Promise<RefreshSummaryResult>;\n}\n\n/** Path for nodes in a tree with escaped special characters */\nexport class EscapedPath {\n\tprivate constructor(public readonly path: string) {}\n\tpublic static create(path: string): EscapedPath {\n\t\treturn new EscapedPath(encodeURIComponent(path));\n\t}\n\tpublic static createAndConcat(pathParts: string[]): EscapedPath {\n\t\tlet ret = EscapedPath.create(pathParts[0] ?? \"\");\n\t\tfor (let i = 1; i < pathParts.length; i++) {\n\t\t\tret = ret.concat(EscapedPath.create(pathParts[i]));\n\t\t}\n\t\treturn ret;\n\t}\n\tpublic toString(): string {\n\t\treturn this.path;\n\t}\n\tpublic concat(path: EscapedPath): EscapedPath {\n\t\treturn new EscapedPath(`${this.path}/${path.path}`);\n\t}\n}\n\n/** Information about a summary relevant to a specific node in the tree */\nexport class SummaryNode {\n\t/** Creates an instance that is valid for the root with specific basePath and localPath */\n\tpublic static createForRoot(referenceSequenceNumber: number): SummaryNode {\n\t\treturn new SummaryNode({\n\t\t\treferenceSequenceNumber,\n\t\t\tbasePath: undefined,\n\t\t\tlocalPath: EscapedPath.create(\"\"), // root hard-coded to \"\"\n\t\t});\n\t}\n\n\t/** Summary reference sequence number, i.e. last sequence number seen when it was created */\n\tpublic get referenceSequenceNumber(): number {\n\t\treturn this.summary.referenceSequenceNumber;\n\t}\n\t/** Full path to parent node, or undefined if this is the root */\n\tpublic get basePath(): EscapedPath | undefined {\n\t\treturn this.summary.basePath;\n\t}\n\t/** Relative path to this node from its parent node */\n\tpublic get localPath(): EscapedPath {\n\t\treturn this.summary.localPath;\n\t}\n\t/** Relative path from this node to its node innermost base summary */\n\tpublic get additionalPath(): EscapedPath | undefined {\n\t\treturn this.summary.additionalPath;\n\t}\n\tpublic set additionalPath(additionalPath: EscapedPath | undefined) {\n\t\tthis.summary.additionalPath = additionalPath;\n\t}\n\tconstructor(\n\t\tprivate readonly summary: {\n\t\t\treadonly referenceSequenceNumber: number;\n\t\t\treadonly basePath: EscapedPath | undefined;\n\t\t\treadonly localPath: EscapedPath;\n\t\t\tadditionalPath?: EscapedPath;\n\t\t},\n\t) {}\n\n\t/** Gets the full path to this node, to be used when sending a handle */\n\tpublic get fullPath(): EscapedPath {\n\t\treturn this.basePath?.concat(this.localPath) ?? this.localPath;\n\t}\n\n\t/**\n\t * Gets the full path to this node's innermost base summary.\n\t * The children nodes can use this as their basePath to determine their path.\n\t */\n\tpublic get fullPathForChildren(): EscapedPath {\n\t\treturn this.additionalPath !== undefined\n\t\t\t? this.fullPath.concat(this.additionalPath)\n\t\t\t: this.fullPath;\n\t}\n\n\t/**\n\t * Creates a new node within the same summary for a child of this node.\n\t * @param id - id of the child node\n\t */\n\tpublic createForChild(id: string): SummaryNode {\n\t\treturn new SummaryNode({\n\t\t\treferenceSequenceNumber: this.referenceSequenceNumber,\n\t\t\tbasePath: this.fullPathForChildren,\n\t\t\tlocalPath: EscapedPath.create(id),\n\t\t});\n\t}\n}\n\n/**\n * Parameter to help encode summary with conditional behavior.\n * When fromSummary is true, it will contain the SummaryNode of\n * its previous summary, which it can use to point to with a handle.\n * When fromSummary is false, it will use an actual summary tree\n * as its base summary in case the first summary is a differential summary.\n */\nexport type EncodeSummaryParam =\n\t| {\n\t\t\tfromSummary: true;\n\t\t\tsummaryNode: SummaryNode;\n\t  }\n\t| {\n\t\t\tfromSummary: false;\n\t\t\tinitialSummary: ISummaryTreeWithStats;\n\t  };\n\n/**\n * Information about the initial summary tree found from an attach op.\n */\nexport interface IInitialSummary {\n\tsequenceNumber: number;\n\tid: string;\n\tsummary: ISummaryTreeWithStats | undefined;\n}\n\n/**\n * Represents the details needed to create a child summarizer node.\n */\nexport interface ICreateChildDetails {\n\t/** Summary from attach op if known */\n\tinitialSummary: IInitialSummary | undefined;\n\t/** Latest summary from server node data */\n\tlatestSummary: SummaryNode | undefined;\n\t/** Sequence number of latest known change to the node */\n\tchangeSequenceNumber: number;\n}\n\nexport interface ISubtreeInfo<T extends ISnapshotTree | SummaryObject> {\n\t/** Tree to use to find children subtrees */\n\tchildrenTree: T;\n\t/** Additional path part where children are isolated */\n\tchildrenPathPart: string | undefined;\n}\n\n/**\n * Checks if the summary contains .channels subtree where the children subtrees\n * would be located if exists.\n * @param baseSummary - summary to check\n */\nexport function parseSummaryForSubtrees(baseSummary: ISnapshotTree): ISubtreeInfo<ISnapshotTree> {\n\t// New versions of snapshots have child nodes isolated in .channels subtree\n\tconst channelsSubtree = baseSummary.trees[channelsTreeName];\n\tif (channelsSubtree !== undefined) {\n\t\treturn {\n\t\t\tchildrenTree: channelsSubtree,\n\t\t\tchildrenPathPart: channelsTreeName,\n\t\t};\n\t}\n\treturn {\n\t\tchildrenTree: baseSummary,\n\t\tchildrenPathPart: undefined,\n\t};\n}\n\n/**\n * Checks if the summary contains .channels subtree where the children subtrees\n * would be located if exists.\n * @param baseSummary - summary to check\n */\nexport function parseSummaryTreeForSubtrees(summary: ISummaryTree): ISubtreeInfo<SummaryObject> {\n\t// New versions of snapshots have child nodes isolated in .channels subtree\n\tconst channelsSubtree = summary.tree[channelsTreeName];\n\tif (channelsSubtree !== undefined) {\n\t\treturn {\n\t\t\tchildrenTree: channelsSubtree,\n\t\t\tchildrenPathPart: channelsTreeName,\n\t\t};\n\t}\n\treturn {\n\t\tchildrenTree: summary,\n\t\tchildrenPathPart: undefined,\n\t};\n}\n"]}

package/lib/summarizerNode/summarizerNodeWithGc.d.ts

@@ -1,135 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { CreateChildSummarizerNodeParam, IGarbageCollectionData, IGarbageCollectionDetailsBase, ISummarizeInternalResult, ISummarizeResult, ISummarizerNodeConfigWithGC, ISummarizerNodeWithGC, SummarizeInternalFn, ITelemetryContext } from "@fluidframework/runtime-definitions";
-import { ReadAndParseBlob } from "../utils";
-import { SummarizerNode } from "./summarizerNode";
-import { EscapedPath, IInitialSummary, ISummarizerNodeRootContract, SummaryNode } from "./summarizerNodeUtils";
-export interface IRootSummarizerNodeWithGC extends ISummarizerNodeWithGC, ISummarizerNodeRootContract {
-}
-/**
- * Extends the functionality of SummarizerNode to manage this node's garbage collection data:
- *
- * - Adds a new API `getGCData` to return GC data of this node.
- *
- * - Caches the result of `getGCData` to be used if nothing changes between summaries.
- *
- * - Manages the used routes of this node. These are used to identify if this node is referenced in the document
- * and to determine if the node's used state changed since last summary.
- *
- * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls
- * directly into summarizeInternal method.
- */
-export declare class SummarizerNodeWithGC extends SummarizerNode implements IRootSummarizerNodeWithGC {
-    private readonly summarizeFn;
-    private readonly getGCDataFn?;
-    private wipSerializedUsedRoutes;
-    private referenceUsedRoutes;
-    private readonly baseGCDetailsP;
-    private baseGCDetailsLoaded;
-    private gcData;
-    private usedRoutes;
-    private readonly gcDisabled;
-    /**
-     * Do not call constructor directly.
-     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.
-     */
-    constructor(logger: ITelemetryLogger, summarizeFn: (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext) => Promise<ISummarizeInternalResult>, config: ISummarizerNodeConfigWithGC, changeSequenceNumber: number, 
-    /** Undefined means created without summary */
-    latestSummary?: SummaryNode, initialSummary?: IInitialSummary, wipSummaryLogger?: ITelemetryLogger, getGCDataFn?: ((fullGC?: boolean | undefined) => Promise<IGarbageCollectionData>) | undefined, getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>);
-    /**
-     * Loads state from this node's initial GC summary details. This contains the following data from the last summary
-     * seen by the server for this client:
-     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.
-     * - gcData: The garbage collection data of this node that is required for running GC.
-     */
-    private loadBaseGCDetails;
-    summarize(fullTree: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;
-    /**
-     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from
-     * the previous summary. Else, it gets new GC data from the underlying Fluid object.
-     * @param fullGC - true to bypass optimizations and force full generation of GC data.
-     */
-    getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
-    /**
-     * Called during the start of a summary. Updates the work-in-progress used routes.
-     */
-    startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger): void;
-    /**
-     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending
-     * summary queue. We track this until we get an ack from the server for this summary.
-     */
-    protected completeSummaryCore(proposalHandle: string, parentPath: EscapedPath | undefined, parentSkipRecursion: boolean): void;
-    /**
-     * Clears the work-in-progress state.
-     */
-    clearSummary(): void;
-    /**
-     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node
-     * from the state in the pending summary queue.
-     */
-    protected refreshLatestSummaryFromPending(proposalHandle: string, referenceSequenceNumber: number): void;
-    /**
-     * Called when we need to upload the reference state from the given summary.
-     */
-    protected refreshLatestSummaryFromSnapshot(referenceSequenceNumber: number, snapshotTree: ISnapshotTree, basePath: EscapedPath | undefined, localPath: EscapedPath, correlatedSummaryLogger: ITelemetryLogger, readAndParseBlob: ReadAndParseBlob): Promise<void>;
-    /**
-     * Updates GC state from the given snapshot if GC is enabled and the snapshot is newer than the one this node
-     * is tracking.
-     */
-    private refreshGCStateFromSnapshot;
-    /**
-     * Override the createChild method to return an instance of SummarizerNodeWithGC.
-     */
-    createChild(
-    /** Summarize function */
-    summarizeInternalFn: SummarizeInternalFn, 
-    /** Initial id or path part of this node */
-    id: string, 
-    /**
-     * Information needed to create the node.
-     * If it is from a base summary, it will assert that a summary has been seen.
-     * Attach information if it is created from an attach op.
-     */
-    createParam: CreateChildSummarizerNodeParam, config?: ISummarizerNodeConfigWithGC, getGCDataFn?: (fullGC?: boolean) => Promise<IGarbageCollectionData>, getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>): ISummarizerNodeWithGC;
-    /**
-     * Deletes the child node with the given id.
-     */
-    deleteChild(id: string): void;
-    /**
-     * Override the getChild method to return an instance of SummarizerNodeWithGC.
-     */
-    getChild(id: string): ISummarizerNodeWithGC | undefined;
-    isReferenced(): boolean;
-    updateUsedRoutes(usedRoutes: string[]): void;
-    /**
-     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.
-     */
-    protected hasChanged(): boolean;
-    /**
-     * This tells whether the data in this node has changed or not.
-     */
-    private hasDataChanged;
-    /**
-     * This tells whether the used state of this node has changed since last successful summary. If the used routes
-     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes
-     * was previously used and became unused (or vice versa), its used state has changed.
-     */
-    private hasUsedStateChanged;
-}
-/**
- * Creates a root summarizer node with GC functionality built-in.
- * @param logger - Logger to use within SummarizerNode
- * @param summarizeInternalFn - Function to generate summary
- * @param changeSequenceNumber - Sequence number of latest change to new node/subtree
- * @param referenceSequenceNumber - Reference sequence number of last acked summary,
- * or undefined if not loaded from summary
- * @param config - Configure behavior of summarizer node
- * @param getGCDataFn - Function to get the GC data of this node
- * @param baseGCDetailsP - Function to get the initial GC details of this node
- */
-export declare const createRootSummarizerNodeWithGC: (logger: ITelemetryLogger, summarizeInternalFn: SummarizeInternalFn, changeSequenceNumber: number, referenceSequenceNumber: number | undefined, config?: ISummarizerNodeConfigWithGC, getGCDataFn?: ((fullGC?: boolean | undefined) => Promise<IGarbageCollectionData>) | undefined, getBaseGCDetailsFn?: (() => Promise<IGarbageCollectionDetailsBase>) | undefined) => IRootSummarizerNodeWithGC;
-//# sourceMappingURL=summarizerNodeWithGc.d.ts.map

package/lib/summarizerNode/summarizerNodeWithGc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarizerNodeWithGc.d.ts","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNodeWithGc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAQtE,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,EACN,8BAA8B,EAE9B,sBAAsB,EACtB,6BAA6B,EAC7B,wBAAwB,EACxB,gBAAgB,EAChB,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACN,WAAW,EAEX,eAAe,EACf,2BAA2B,EAE3B,WAAW,EACX,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,yBAChB,SAAQ,qBAAqB,EAC5B,2BAA2B;CAAG;AAiBhC;;;;;;;;;;;;GAYG;AACH,qBAAa,oBAAqB,SAAQ,cAAe,YAAW,yBAAyB;IA6B3F,OAAO,CAAC,QAAQ,CAAC,WAAW;IAW5B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAtC9B,OAAO,CAAC,uBAAuB,CAAqB;IAGpD,OAAO,CAAC,mBAAmB,CAAuB;IAGlD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6C;IAG5E,OAAO,CAAC,mBAAmB,CAAkB;IAE7C,OAAO,CAAC,MAAM,CAAqC;IAKnD,OAAO,CAAC,UAAU,CAAkB;IAGpC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IAErC;;;OAGG;gBAEF,MAAM,EAAE,gBAAgB,EACP,WAAW,EAAE,CAC7B,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,gBAAgB,CAAC,EAAE,iBAAiB,KAChC,OAAO,CAAC,wBAAwB,CAAC,EACtC,MAAM,EAAE,2BAA2B,EACnC,oBAAoB,EAAE,MAAM;IAC5B,8CAA8C;IAC9C,aAAa,CAAC,EAAE,WAAW,EAC3B,cAAc,CAAC,EAAE,eAAe,EAChC,gBAAgB,CAAC,EAAE,gBAAgB,EAClB,WAAW,CAAC,qCAAwB,QAAQ,sBAAsB,CAAC,aAAA,EACpF,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC;IAoBlE;;;;;OAKG;YACW,iBAAiB;IAyBlB,SAAS,CACrB,QAAQ,EAAE,OAAO,EACjB,UAAU,GAAE,OAAc,EAC1B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,gBAAgB,CAAC;IAiB5B;;;;OAIG;IACU,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA2BhF;;OAEG;IACI,YAAY,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,EAAE,gBAAgB;IAWpF;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAC5B,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,WAAW,GAAG,SAAS,EACnC,mBAAmB,EAAE,OAAO;IA4B7B;;OAEG;IACI,YAAY;IAKnB;;;OAGG;IACH,SAAS,CAAC,+BAA+B,CACxC,cAAc,EAAE,MAAM,EACtB,uBAAuB,EAAE,MAAM,GAC7B,IAAI;IAYP;;OAEG;cACa,gCAAgC,CAC/C,uBAAuB,EAAE,MAAM,EAC/B,YAAY,EAAE,aAAa,EAC3B,QAAQ,EAAE,WAAW,GAAG,SAAS,EACjC,SAAS,EAAE,WAAW,EACtB,uBAAuB,EAAE,gBAAgB,EACzC,gBAAgB,EAAE,gBAAgB,GAChC,OAAO,CAAC,IAAI,CAAC;IAgBhB;;;OAGG;YACW,0BAA0B;IA+ExC;;OAEG;IACI,WAAW;IACjB,yBAAyB;IACzB,mBAAmB,EAAE,mBAAmB;IACxC,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;OAIG;IACH,WAAW,EAAE,8BAA8B,EAC3C,MAAM,GAAE,2BAAgC,EACxC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,sBAAsB,CAAC,EACnE,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,6BAA6B,CAAC,GAC/D,qBAAqB;IA6CxB;;OAEG;IACI,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAIvD,YAAY,IAAI,OAAO;IAIvB,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE;IAY5C;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,OAAO;IAI/B;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;CAW3B;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,8BAA8B,WAClC,gBAAgB,uBACH,mBAAmB,wBAClB,MAAM,2BACH,MAAM,GAAG,SAAS,WACnC,2BAA2B,mDACC,QAAQ,sBAAsB,CAAC,2CACxC,QAAQ,6BAA6B,CAAC,kBAC/D,yBAaD,CAAC"}

package/lib/summarizerNode/summarizerNodeWithGc.js

@@ -1,356 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { assert, LazyPromise } from "@fluidframework/common-utils";
-import { cloneGCData, getGCDataFromSnapshot, runGarbageCollection, unpackChildNodesGCDetails, } from "@fluidframework/garbage-collector";
-import { gcTreeKey, } from "@fluidframework/runtime-definitions";
-import { SummarizerNode } from "./summarizerNode";
-import { parseSummaryForSubtrees, SummaryNode, } from "./summarizerNodeUtils";
-// Extend SummaryNode to add used routes tracking to it.
-class SummaryNodeWithGC extends SummaryNode {
-    constructor(serializedUsedRoutes, summary) {
-        super(summary);
-        this.serializedUsedRoutes = serializedUsedRoutes;
-    }
-}
-/**
- * Extends the functionality of SummarizerNode to manage this node's garbage collection data:
- *
- * - Adds a new API `getGCData` to return GC data of this node.
- *
- * - Caches the result of `getGCData` to be used if nothing changes between summaries.
- *
- * - Manages the used routes of this node. These are used to identify if this node is referenced in the document
- * and to determine if the node's used state changed since last summary.
- *
- * - Adds trackState param to summarize. If trackState is false, it bypasses the SummarizerNode and calls
- * directly into summarizeInternal method.
- */
-export class SummarizerNodeWithGC extends SummarizerNode {
-    /**
-     * Do not call constructor directly.
-     * Use createRootSummarizerNodeWithGC to create root node, or createChild to create child nodes.
-     */
-    constructor(logger, summarizeFn, config, changeSequenceNumber, 
-    /** Undefined means created without summary */
-    latestSummary, initialSummary, wipSummaryLogger, getGCDataFn, getBaseGCDetailsFn) {
-        super(logger, async (fullTree, _trackState, telemetryContext) => summarizeFn(fullTree, true /* trackState */, telemetryContext), config, changeSequenceNumber, latestSummary, initialSummary, wipSummaryLogger);
-        this.summarizeFn = summarizeFn;
-        this.getGCDataFn = getGCDataFn;
-        // Keeps track of whether we have loaded the base details to ensure that we on;y do it once.
-        this.baseGCDetailsLoaded = false;
-        // Set used routes to have self route by default. This makes the node referenced by default. This is done to ensure
-        // that this node is not marked as collected when running GC has been disabled. Once, the option to disable GC is
-        // removed (from runGC flag in IContainerRuntimeOptions), this should be changed to be have no routes by default.
-        this.usedRoutes = [""];
-        this.gcDisabled = config.gcDisabled === true;
-        this.baseGCDetailsP = new LazyPromise(async () => {
-            var _a;
-            return (_a = (await (getBaseGCDetailsFn === null || getBaseGCDetailsFn === void 0 ? void 0 : getBaseGCDetailsFn()))) !== null && _a !== void 0 ? _a : { usedRoutes: [] };
-        });
-    }
-    /**
-     * Loads state from this node's initial GC summary details. This contains the following data from the last summary
-     * seen by the server for this client:
-     * - usedRoutes: This is used to figure out if the used state of this node changed since last summary.
-     * - gcData: The garbage collection data of this node that is required for running GC.
-     */
-    async loadBaseGCDetails() {
-        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 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);
-        }
-        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
-        // summary by calling updateUsedRoutes which sets wipSerializedUsedRoutes.
-        if (!this.gcDisabled && this.isTrackingInProgress()) {
-            assert(this.wipSerializedUsedRoutes !== undefined, 0x1b1 /* "wip used routes should be set if tracking a summary" */);
-        }
-        // If trackState is true, get summary from base summarizer node which tracks summary state.
-        // If trackState is false, get summary from summarizeInternal.
-        return trackState
-            ? super.summarize(fullTree, true /* trackState */, telemetryContext)
-            : this.summarizeFn(fullTree, trackState, telemetryContext);
-    }
-    /**
-     * Returns the GC data of this node. If nothing has changed since last summary, it tries to reuse the data from
-     * the previous summary. Else, it gets new GC data from the underlying Fluid object.
-     * @param fullGC - true to bypass optimizations and force full generation of GC data.
-     */
-    async getGCData(fullGC = false) {
-        assert(!this.gcDisabled, 0x1b2 /* "Getting GC data should not be called when GC is disabled!" */);
-        assert(this.getGCDataFn !== undefined, 0x1b3 /* "GC data cannot be retrieved without getGCDataFn" */);
-        // 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. 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);
-        this.gcData = cloneGCData(gcData);
-        return gcData;
-    }
-    /**
-     * Called during the start of a summary. Updates the work-in-progress used routes.
-     */
-    startSummary(referenceSequenceNumber, summaryLogger) {
-        // If GC is disabled, skip setting wip used routes since we should not track GC state.
-        if (!this.gcDisabled) {
-            assert(this.wipSerializedUsedRoutes === undefined, 0x1b4 /* "We should not already be tracking used routes when to track a new summary" */);
-        }
-        super.startSummary(referenceSequenceNumber, summaryLogger);
-    }
-    /**
-     * Called after summary has been uploaded to the server. Add the work-in-progress state to the pending
-     * summary queue. We track this until we get an ack from the server for this summary.
-     */
-    completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion) {
-        let wipSerializedUsedRoutes;
-        // If GC is disabled, don't set wip used routes.
-        if (!this.gcDisabled) {
-            wipSerializedUsedRoutes = this.wipSerializedUsedRoutes;
-            assert(wipSerializedUsedRoutes !== undefined, 0x1b5 /* "We should have been tracking used routes" */);
-        }
-        super.completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion);
-        // If GC is disabled, skip setting pending summary with GC state.
-        if (!this.gcDisabled) {
-            const summaryNode = this.pendingSummaries.get(proposalHandle);
-            if (summaryNode !== undefined) {
-                const summaryNodeWithGC = new SummaryNodeWithGC(
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                wipSerializedUsedRoutes, summaryNode);
-                this.pendingSummaries.set(proposalHandle, summaryNodeWithGC);
-            }
-        }
-    }
-    /**
-     * Clears the work-in-progress state.
-     */
-    clearSummary() {
-        this.wipSerializedUsedRoutes = undefined;
-        super.clearSummary();
-    }
-    /**
-     * Called when we get an ack from the server for a summary we sent. Update the reference state of this node
-     * from the state in the pending summary queue.
-     */
-    refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber) {
-        // If GC is disabled, skip setting referenced used routes since we are not tracking GC state.
-        if (!this.gcDisabled) {
-            const summaryNode = this.pendingSummaries.get(proposalHandle);
-            if ((summaryNode === null || summaryNode === void 0 ? void 0 : summaryNode.serializedUsedRoutes) !== undefined) {
-                this.referenceUsedRoutes = JSON.parse(summaryNode.serializedUsedRoutes);
-            }
-        }
-        return super.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);
-    }
-    /**
-     * Called when we need to upload the reference state from the given summary.
-     */
-    async refreshLatestSummaryFromSnapshot(referenceSequenceNumber, snapshotTree, basePath, localPath, correlatedSummaryLogger, readAndParseBlob) {
-        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) {
-                gcDetails = JSON.parse(gcDetailsBlob);
-            }
-        }
-        // 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) => {
-            if (childrenTree.trees[childId] !== undefined) {
-                childrenTree.trees[childId].blobs[gcTreeKey] = JSON.stringify(childGCDetails);
-            }
-        });
-    }
-    /**
-     * Override the createChild method to return an instance of SummarizerNodeWithGC.
-     */
-    createChild(
-    /** Summarize function */
-    summarizeInternalFn, 
-    /** Initial id or path part of this node */
-    id, 
-    /**
-     * Information needed to create the node.
-     * If it is from a base summary, it will assert that a summary has been seen.
-     * Attach information if it is created from an attach op.
-     */
-    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, 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);
-        this.children.set(id, child);
-        return child;
-    }
-    /**
-     * Deletes the child node with the given id.
-     */
-    deleteChild(id) {
-        this.children.delete(id);
-    }
-    /**
-     * Override the getChild method to return an instance of SummarizerNodeWithGC.
-     */
-    getChild(id) {
-        return this.children.get(id);
-    }
-    isReferenced() {
-        return this.usedRoutes.includes("") || this.usedRoutes.includes("/");
-    }
-    updateUsedRoutes(usedRoutes) {
-        // Sort the given routes before updating. This will ensure that the routes compared in hasUsedStateChanged()
-        // are in the same order.
-        this.usedRoutes = usedRoutes.sort();
-        // If GC is not disabled and we are tracking a summary, update the work-in-progress used routes so that it can
-        // be tracked for this summary.
-        if (!this.gcDisabled && this.isTrackingInProgress()) {
-            this.wipSerializedUsedRoutes = JSON.stringify(this.usedRoutes);
-        }
-    }
-    /**
-     * Override the hasChanged method. If this node data or its used state changed, the node is considered changed.
-     */
-    hasChanged() {
-        return this.hasDataChanged() || this.hasUsedStateChanged();
-    }
-    /**
-     * This tells whether the data in this node has changed or not.
-     */
-    hasDataChanged() {
-        return super.hasChanged();
-    }
-    /**
-     * This tells whether the used state of this node has changed since last successful summary. If the used routes
-     * of this node changed, its used state is considered changed. Basically, if this node or any of its child nodes
-     * was previously used and became unused (or vice versa), its used state has changed.
-     */
-    hasUsedStateChanged() {
-        // If GC is disabled, we are not tracking used state, return false.
-        if (this.gcDisabled) {
-            return false;
-        }
-        return (this.referenceUsedRoutes === undefined ||
-            JSON.stringify(this.usedRoutes) !== JSON.stringify(this.referenceUsedRoutes));
-    }
-}
-/**
- * Creates a root summarizer node with GC functionality built-in.
- * @param logger - Logger to use within SummarizerNode
- * @param summarizeInternalFn - Function to generate summary
- * @param changeSequenceNumber - Sequence number of latest change to new node/subtree
- * @param referenceSequenceNumber - Reference sequence number of last acked summary,
- * or undefined if not loaded from summary
- * @param config - Configure behavior of summarizer node
- * @param getGCDataFn - Function to get the GC data of this node
- * @param baseGCDetailsP - Function to get the initial GC details of this node
- */
-export const createRootSummarizerNodeWithGC = (logger, summarizeInternalFn, changeSequenceNumber, referenceSequenceNumber, config = {}, getGCDataFn, getBaseGCDetailsFn) => new SummarizerNodeWithGC(logger, summarizeInternalFn, config, changeSequenceNumber, referenceSequenceNumber === undefined
-    ? undefined
-    : SummaryNode.createForRoot(referenceSequenceNumber), undefined /* initialSummary */, undefined /* wipSummaryLogger */, getGCDataFn, getBaseGCDetailsFn);
-//# sourceMappingURL=summarizerNodeWithGc.js.map