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

package/dist/summarizerNode/summarizerNode.d.ts

@@ -1,140 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ISummarizerNode, ISummarizerNodeConfig, ISummarizeResult, CreateChildSummarizerNodeParam, SummarizeInternalFn, ITelemetryContext } from "@fluidframework/runtime-definitions";
-import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions";
-import { ITelemetryLogger } from "@fluidframework/common-definitions";
-import { ReadAndParseBlob } from "../utils";
-import { EscapedPath, ICreateChildDetails, IInitialSummary, ISummarizerNodeRootContract, RefreshSummaryResult, SummaryNode } from "./summarizerNodeUtils";
-export interface IRootSummarizerNode extends ISummarizerNode, ISummarizerNodeRootContract {
-}
-/**
- * Encapsulates the summarizing work and state of an individual tree node in the
- * summary tree. It tracks changes and allows for optimizations when unchanged, or
- * can allow for fallback summaries to be generated when an error is encountered.
- * Usage is for the root node to call startSummary first to begin tracking a WIP
- * (work in progress) summary. Then all nodes will call summarize to summaries their
- * individual parts. Once completed and uploaded to storage, the root node will call
- * completeSummary or clearSummary to clear the WIP summary tracking state if something
- * went wrong. The SummarizerNodes will track all pending summaries that have been
- * recorded by the completeSummary call. When one of them is acked, the root node should
- * call refreshLatestSummary to inform the tree of SummarizerNodes of the new baseline
- * latest successful summary.
- */
-export declare class SummarizerNode implements IRootSummarizerNode {
-    protected readonly defaultLogger: ITelemetryLogger;
-    private readonly summarizeInternalFn;
-    private _changeSequenceNumber;
-    /** Undefined means created without summary */
-    private _latestSummary?;
-    private readonly initialSummary?;
-    protected wipSummaryLogger?: ITelemetryLogger | undefined;
-    /**
-     * The reference sequence number of the most recent acked summary.
-     * Returns 0 if there is not yet an acked summary.
-     */
-    get referenceSequenceNumber(): number;
-    protected readonly children: Map<string, SummarizerNode>;
-    protected readonly pendingSummaries: Map<string, SummaryNode>;
-    private wipReferenceSequenceNumber;
-    private wipLocalPaths;
-    private wipSkipRecursion;
-    startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger): void;
-    summarize(fullTree: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;
-    /**
-     * Complete the WIP summary for the given proposalHandle
-     */
-    completeSummary(proposalHandle: string): void;
-    /**
-     * Recursive implementation for completeSummary, with additional internal-only parameters
-     */
-    protected completeSummaryCore(proposalHandle: string, parentPath: EscapedPath | undefined, parentSkipRecursion: boolean): void;
-    clearSummary(): void;
-    /**
-     * Refreshes the latest summary tracked by this node. If we have a pending summary for the given proposal handle,
-     * it becomes the latest summary. If the current summary is already ahead (e.g., loaded from a service summary),
-     * we skip the update. Otherwise, we get the snapshot by calling `getSnapshot` and update latest
-     * summary based off of that.
-     *
-     * @returns A RefreshSummaryResult type which returns information based on the following three scenarios:
-     *
-     * 1. The latest summary was not udpated.
-     *
-     * 2. The latest summary was updated and the summary corresponding to the params was being tracked.
-     *
-     * 3. The latest summary was updated but the summary corresponding to the params was not tracked. In this
-     * case, the latest summary is updated based on the downloaded snapshot which is also returned.
-     */
-    refreshLatestSummary(proposalHandle: string | undefined, summaryRefSeq: number, getSnapshot: () => Promise<ISnapshotTree>, readAndParseBlob: ReadAndParseBlob, correlatedSummaryLogger: ITelemetryLogger): Promise<RefreshSummaryResult>;
-    /**
-     * Called when we get an ack from the server for a summary we've just sent. Updates the reference state of this node
-     * from the state in the pending summary queue.
-     * @param proposalHandle - Handle for the current proposal.
-     * @param referenceSequenceNumber -  reference sequence number of sent summary.
-     */
-    protected refreshLatestSummaryFromPending(proposalHandle: string, referenceSequenceNumber: number): void;
-    protected refreshLatestSummaryFromSnapshot(referenceSequenceNumber: number, snapshotTree: ISnapshotTree, basePath: EscapedPath | undefined, localPath: EscapedPath, correlatedSummaryLogger: ITelemetryLogger, readAndParseBlob: ReadAndParseBlob): Promise<void>;
-    private refreshLatestSummaryCore;
-    updateBaseSummaryState(snapshot: ISnapshotTree): void;
-    recordChange(op: ISequencedDocumentMessage): void;
-    invalidate(sequenceNumber: number): void;
-    /**
-     * True if a change has been recorded with sequence number exceeding
-     * the latest successfully acked summary reference sequence number.
-     * False implies that the previous summary can be reused.
-     */
-    protected hasChanged(): boolean;
-    get latestSummary(): Readonly<SummaryNode> | undefined;
-    protected readonly canReuseHandle: boolean;
-    /**
-     * Do not call constructor directly.
-     * Use createRootSummarizerNode to create root node, or createChild to create child nodes.
-     */
-    constructor(defaultLogger: ITelemetryLogger, summarizeInternalFn: SummarizeInternalFn, config: ISummarizerNodeConfig, _changeSequenceNumber: number, 
-    /** Undefined means created without summary */
-    _latestSummary?: SummaryNode | undefined, initialSummary?: IInitialSummary | undefined, wipSummaryLogger?: ITelemetryLogger | undefined);
-    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?: ISummarizerNodeConfig): ISummarizerNode;
-    getChild(id: string): ISummarizerNode | undefined;
-    /**
-     * Returns the details needed to create a child node.
-     * @param id - Initial id or path part of the child node.
-     * @param createParam - Information needed to create the node.
-     * @returns the details needed to create the child node.
-     */
-    protected getCreateDetailsForChild(id: string, createParam: CreateChildSummarizerNodeParam): ICreateChildDetails;
-    /**
-     * Updates the state of the child if required. For example, if a summary is currently being  tracked, the child's
-     * summary tracking state needs to be updated too.
-     * Also, in case a child node gets realized in between Summary Op and Summary Ack, let's initialize the child's
-     * pending summary as well.
-     * @param child - The child node whose state is to be updated.
-     */
-    protected maybeUpdateChildState(child: SummarizerNode): void;
-    protected addPendingSummary(key: string, summary: SummaryNode): void;
-    /**
-     * Tells whether summary tracking is in progress. True if "startSummary" API is called before summarize.
-     */
-    protected isTrackingInProgress(): boolean;
-}
-/**
- * Creates a root summarizer node.
- * @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
- */
-export declare const createRootSummarizerNode: (logger: ITelemetryLogger, summarizeInternalFn: SummarizeInternalFn, changeSequenceNumber: number, referenceSequenceNumber: number | undefined, config?: ISummarizerNodeConfig) => IRootSummarizerNode;
-//# sourceMappingURL=summarizerNode.d.ts.map

package/dist/summarizerNode/summarizerNode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"summarizerNode.d.ts","sourceRoot":"","sources":["../../src/summarizerNode/summarizerNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAEhB,8BAA8B,EAE9B,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACN,yBAAyB,EAEzB,aAAa,EAEb,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EACN,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,2BAA2B,EAG3B,oBAAoB,EACpB,WAAW,EACX,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,mBAAoB,SAAQ,eAAe,EAAE,2BAA2B;CAAG;AAE5F;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IAiXxD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,gBAAgB;IAClD,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IAEpC,OAAO,CAAC,qBAAqB;IAC7B,8CAA8C;IAC9C,OAAO,CAAC,cAAc,CAAC;IACvB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,SAAS,CAAC,gBAAgB,CAAC;IAvX5B;;;OAGG;IACH,IAAW,uBAAuB,WAEjC;IAED,SAAS,CAAC,QAAQ,CAAC,QAAQ,8BAAqC;IAChE,SAAS,CAAC,QAAQ,CAAC,gBAAgB,2BAAkC;IACrE,OAAO,CAAC,0BAA0B,CAAqB;IACvD,OAAO,CAAC,aAAa,CAAuE;IAC5F,OAAO,CAAC,gBAAgB,CAAS;IAE1B,YAAY,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,EAAE,gBAAgB;IAkBvE,SAAS,CACrB,QAAQ,EAAE,OAAO,EACjB,UAAU,GAAE,OAAc,EAC1B,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,gBAAgB,CAAC;IA0C5B;;OAEG;IACI,eAAe,CAAC,cAAc,EAAE,MAAM;IAI7C;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAC5B,cAAc,EAAE,MAAM,EACtB,UAAU,EAAE,WAAW,GAAG,SAAS,EACnC,mBAAmB,EAAE,OAAO;IA8DtB,YAAY;IAUnB;;;;;;;;;;;;;;OAcG;IACU,oBAAoB,CAChC,cAAc,EAAE,MAAM,GAAG,SAAS,EAClC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,OAAO,CAAC,aAAa,CAAC,EACzC,gBAAgB,EAAE,gBAAgB,EAClC,uBAAuB,EAAE,gBAAgB,GACvC,OAAO,CAAC,oBAAoB,CAAC;IA+ChC;;;;;OAKG;IACH,SAAS,CAAC,+BAA+B,CACxC,cAAc,EAAE,MAAM,EACtB,uBAAuB,EAAE,MAAM,GAC7B,IAAI;cA4BS,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;IA8ChB,OAAO,CAAC,wBAAwB;IAQzB,sBAAsB,CAAC,QAAQ,EAAE,aAAa;IAS9C,YAAY,CAAC,EAAE,EAAE,yBAAyB,GAAG,IAAI;IAIjD,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI;IAM/C;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,OAAO;IAI/B,IAAW,aAAa,IAAI,QAAQ,CAAC,WAAW,CAAC,GAAG,SAAS,CAE5D;IAED,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IAE3C;;;OAGG;gBAEiB,aAAa,EAAE,gBAAgB,EACjC,mBAAmB,EAAE,mBAAmB,EACzD,MAAM,EAAE,qBAAqB,EACrB,qBAAqB,EAAE,MAAM;IACrC,8CAA8C;IACtC,cAAc,CAAC,yBAAa,EACnB,cAAc,CAAC,6BAAiB,EACvC,gBAAgB,CAAC,8BAAkB;IAKvC,WAAW;IACjB,yBAAyB;IACzB,mBAAmB,EAAE,mBAAmB;IACxC,2CAA2C;IAC3C,EAAE,EAAE,MAAM;IACV;;;;OAIG;IACH,WAAW,EAAE,8BAA8B,EAC3C,MAAM,GAAE,qBAA0B,GAChC,eAAe;IAuBX,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIxD;;;;;OAKG;IACH,SAAS,CAAC,wBAAwB,CACjC,EAAE,EAAE,MAAM,EACV,WAAW,EAAE,8BAA8B,GACzC,mBAAmB;IAwFtB;;;;;;OAMG;IACH,SAAS,CAAC,qBAAqB,CAAC,KAAK,EAAE,cAAc;IAoBrD,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW;IAG7D;;OAEG;IACH,SAAS,CAAC,oBAAoB,IAAI,OAAO;CAGzC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,WAC5B,gBAAgB,uBACH,mBAAmB,wBAClB,MAAM,2BACH,MAAM,GAAG,SAAS,WACnC,qBAAqB,KAC3B,mBASD,CAAC"}

package/dist/summarizerNode/summarizerNode.js

@@ -1,448 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRootSummarizerNode = exports.SummarizerNode = void 0;
-const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
-const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
-const common_utils_1 = require("@fluidframework/common-utils");
-const summaryUtils_1 = require("../summaryUtils");
-const summarizerNodeUtils_1 = require("./summarizerNodeUtils");
-/**
- * Encapsulates the summarizing work and state of an individual tree node in the
- * summary tree. It tracks changes and allows for optimizations when unchanged, or
- * can allow for fallback summaries to be generated when an error is encountered.
- * Usage is for the root node to call startSummary first to begin tracking a WIP
- * (work in progress) summary. Then all nodes will call summarize to summaries their
- * individual parts. Once completed and uploaded to storage, the root node will call
- * completeSummary or clearSummary to clear the WIP summary tracking state if something
- * went wrong. The SummarizerNodes will track all pending summaries that have been
- * recorded by the completeSummary call. When one of them is acked, the root node should
- * call refreshLatestSummary to inform the tree of SummarizerNodes of the new baseline
- * latest successful summary.
- */
-class SummarizerNode {
-    /**
-     * Do not call constructor directly.
-     * Use createRootSummarizerNode to create root node, or createChild to create child nodes.
-     */
-    constructor(defaultLogger, summarizeInternalFn, config, _changeSequenceNumber, 
-    /** Undefined means created without summary */
-    _latestSummary, initialSummary, wipSummaryLogger) {
-        var _a;
-        this.defaultLogger = defaultLogger;
-        this.summarizeInternalFn = summarizeInternalFn;
-        this._changeSequenceNumber = _changeSequenceNumber;
-        this._latestSummary = _latestSummary;
-        this.initialSummary = initialSummary;
-        this.wipSummaryLogger = wipSummaryLogger;
-        this.children = new Map();
-        this.pendingSummaries = new Map();
-        this.wipSkipRecursion = false;
-        this.canReuseHandle = (_a = config.canReuseHandle) !== null && _a !== void 0 ? _a : true;
-    }
-    /**
-     * The reference sequence number of the most recent acked summary.
-     * Returns 0 if there is not yet an acked summary.
-     */
-    get referenceSequenceNumber() {
-        var _a, _b;
-        return (_b = (_a = this._latestSummary) === null || _a === void 0 ? void 0 : _a.referenceSequenceNumber) !== null && _b !== void 0 ? _b : 0;
-    }
-    startSummary(referenceSequenceNumber, summaryLogger) {
-        (0, common_utils_1.assert)(this.wipSummaryLogger === undefined, 0x19f /* "wipSummaryLogger should not be set yet in startSummary" */);
-        (0, common_utils_1.assert)(this.wipReferenceSequenceNumber === undefined, 0x1a0 /* "Already tracking a summary" */);
-        this.wipSummaryLogger = summaryLogger;
-        for (const child of this.children.values()) {
-            child.startSummary(referenceSequenceNumber, this.wipSummaryLogger);
-        }
-        this.wipReferenceSequenceNumber = referenceSequenceNumber;
-    }
-    async summarize(fullTree, trackState = true, telemetryContext) {
-        (0, common_utils_1.assert)(this.isTrackingInProgress(), 0x1a1 /* "summarize should not be called when not tracking the summary" */);
-        (0, common_utils_1.assert)(this.wipSummaryLogger !== undefined, 0x1a2 /* "wipSummaryLogger should have been set in startSummary or ctor" */);
-        // Try to reuse the tree if unchanged
-        if (this.canReuseHandle && !fullTree && !this.hasChanged()) {
-            const latestSummary = this._latestSummary;
-            if (latestSummary !== undefined) {
-                this.wipLocalPaths = {
-                    localPath: latestSummary.localPath,
-                    additionalPath: latestSummary.additionalPath,
-                };
-                this.wipSkipRecursion = true;
-                const stats = (0, summaryUtils_1.mergeStats)();
-                stats.handleNodeCount++;
-                return {
-                    summary: {
-                        type: protocol_definitions_1.SummaryType.Handle,
-                        handle: latestSummary.fullPath.path,
-                        handleType: protocol_definitions_1.SummaryType.Tree,
-                    },
-                    stats,
-                };
-            }
-        }
-        const result = await this.summarizeInternalFn(fullTree, true, telemetryContext);
-        this.wipLocalPaths = { localPath: summarizerNodeUtils_1.EscapedPath.create(result.id) };
-        if (result.pathPartsForChildren !== undefined) {
-            this.wipLocalPaths.additionalPath = summarizerNodeUtils_1.EscapedPath.createAndConcat(result.pathPartsForChildren);
-        }
-        return { summary: result.summary, stats: result.stats };
-    }
-    /**
-     * Complete the WIP summary for the given proposalHandle
-     */
-    completeSummary(proposalHandle) {
-        this.completeSummaryCore(proposalHandle, undefined, false);
-    }
-    /**
-     * Recursive implementation for completeSummary, with additional internal-only parameters
-     */
-    completeSummaryCore(proposalHandle, parentPath, parentSkipRecursion) {
-        (0, common_utils_1.assert)(this.wipSummaryLogger !== undefined, 0x1a3 /* "wipSummaryLogger should have been set in startSummary or ctor" */);
-        (0, common_utils_1.assert)(this.wipReferenceSequenceNumber !== undefined, 0x1a4 /* "Not tracking a summary" */);
-        let localPathsToUse = this.wipLocalPaths;
-        if (parentSkipRecursion) {
-            const latestSummary = this._latestSummary;
-            if (latestSummary !== undefined) {
-                // This case the parent node created a failure summary or was reused.
-                // This node and all children should only try to reference their path
-                // by its last known good state in the actual summary tree.
-                // If parent fails or is reused, the child summarize is not called so
-                // it did not get a chance to change its paths.
-                // In this case, essentially only propagate the new summary ref seq num.
-                localPathsToUse = {
-                    localPath: latestSummary.localPath,
-                    additionalPath: latestSummary.additionalPath,
-                };
-            }
-            else {
-                // This case the child is added after the latest non-failure summary.
-                // This node and all children should consider themselves as still not
-                // having a successful summary yet.
-                // We cannot "reuse" this node if unchanged since that summary, because
-                // handles will be unable to point to that node. It never made it to the
-                // tree itself, and only exists as an attach op in the _outstandingOps.
-                this.clearSummary();
-                return;
-            }
-        }
-        // This should come from wipLocalPaths in normal cases, or from the latestSummary
-        // if parentIsFailure or parentIsReused is true.
-        // If there is no latestSummary, clearSummary and return before reaching this code.
-        (0, common_utils_1.assert)(!!localPathsToUse, 0x1a5 /* "Tracked summary local paths not set" */);
-        const summary = new summarizerNodeUtils_1.SummaryNode(Object.assign(Object.assign({}, localPathsToUse), { referenceSequenceNumber: this.wipReferenceSequenceNumber, basePath: parentPath }));
-        const fullPathForChildren = summary.fullPathForChildren;
-        for (const child of this.children.values()) {
-            child.completeSummaryCore(proposalHandle, fullPathForChildren, this.wipSkipRecursion || parentSkipRecursion);
-        }
-        // Note that this overwrites existing pending summary with
-        // the same proposalHandle. If proposalHandle is something like
-        // a hash or unique identifier, this should be fine. If storage
-        // can return the same proposalHandle for a different summary,
-        // this should still be okay, because we should be proposing the
-        // newer one later which would have to overwrite the previous one.
-        this.pendingSummaries.set(proposalHandle, summary);
-        this.clearSummary();
-    }
-    clearSummary() {
-        this.wipReferenceSequenceNumber = undefined;
-        this.wipLocalPaths = undefined;
-        this.wipSkipRecursion = false;
-        this.wipSummaryLogger = undefined;
-        for (const child of this.children.values()) {
-            child.clearSummary();
-        }
-    }
-    /**
-     * Refreshes the latest summary tracked by this node. If we have a pending summary for the given proposal handle,
-     * it becomes the latest summary. If the current summary is already ahead (e.g., loaded from a service summary),
-     * we skip the update. Otherwise, we get the snapshot by calling `getSnapshot` and update latest
-     * summary based off of that.
-     *
-     * @returns A RefreshSummaryResult type which returns information based on the following three scenarios:
-     *
-     * 1. The latest summary was not udpated.
-     *
-     * 2. The latest summary was updated and the summary corresponding to the params was being tracked.
-     *
-     * 3. The latest summary was updated but the summary corresponding to the params was not tracked. In this
-     * case, the latest summary is updated based on the downloaded snapshot which is also returned.
-     */
-    async refreshLatestSummary(proposalHandle, summaryRefSeq, getSnapshot, readAndParseBlob, correlatedSummaryLogger) {
-        var _a;
-        this.defaultLogger.sendTelemetryEvent({
-            eventName: "refreshLatestSummary_start",
-            proposalHandle,
-            referenceSequenceNumber: this.referenceSequenceNumber,
-            summaryRefSeq,
-        });
-        if (proposalHandle !== undefined) {
-            const maybeSummaryNode = this.pendingSummaries.get(proposalHandle);
-            if (maybeSummaryNode !== undefined) {
-                this.refreshLatestSummaryFromPending(proposalHandle, maybeSummaryNode.referenceSequenceNumber);
-                return { latestSummaryUpdated: true, wasSummaryTracked: true };
-            }
-            const props = {
-                summaryRefSeq,
-                pendingSize: (_a = this.pendingSummaries.size) !== null && _a !== void 0 ? _a : undefined,
-            };
-            this.defaultLogger.sendTelemetryEvent({
-                eventName: "PendingSummaryNotFound",
-                proposalHandle,
-                referenceSequenceNumber: this.referenceSequenceNumber,
-                details: JSON.stringify(props),
-            });
-        }
-        // If we have seen a summary same or later as the current one, ignore it.
-        if (this.referenceSequenceNumber >= summaryRefSeq) {
-            return { latestSummaryUpdated: false };
-        }
-        const snapshotTree = await getSnapshot();
-        await this.refreshLatestSummaryFromSnapshot(summaryRefSeq, snapshotTree, undefined, summarizerNodeUtils_1.EscapedPath.create(""), correlatedSummaryLogger, readAndParseBlob);
-        return { latestSummaryUpdated: true, wasSummaryTracked: false, snapshot: snapshotTree };
-    }
-    /**
-     * Called when we get an ack from the server for a summary we've just sent. Updates the reference state of this node
-     * from the state in the pending summary queue.
-     * @param proposalHandle - Handle for the current proposal.
-     * @param referenceSequenceNumber -  reference sequence number of sent summary.
-     */
-    refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber) {
-        const summaryNode = this.pendingSummaries.get(proposalHandle);
-        if (summaryNode === undefined) {
-            // This should only happen if parent skipped recursion AND no prior summary existed.
-            (0, common_utils_1.assert)(this._latestSummary === undefined, 0x1a6 /* "Not found pending summary, but this node has previously completed a summary" */);
-            return;
-        }
-        else {
-            (0, common_utils_1.assert)(referenceSequenceNumber === summaryNode.referenceSequenceNumber, 0x1a7 /* Pending summary reference sequence number should be consistent */);
-            // Clear earlier pending summaries
-            this.pendingSummaries.delete(proposalHandle);
-        }
-        this.refreshLatestSummaryCore(referenceSequenceNumber);
-        this._latestSummary = summaryNode;
-        // Propagate update to all child nodes
-        for (const child of this.children.values()) {
-            child.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);
-        }
-    }
-    async refreshLatestSummaryFromSnapshot(referenceSequenceNumber, snapshotTree, basePath, localPath, correlatedSummaryLogger, readAndParseBlob) {
-        // Possible re-entrancy. If we have already seen a summary later than this one, ignore it.
-        if (this.referenceSequenceNumber >= referenceSequenceNumber) {
-            return;
-        }
-        this.refreshLatestSummaryCore(referenceSequenceNumber);
-        this._latestSummary = new summarizerNodeUtils_1.SummaryNode({
-            referenceSequenceNumber,
-            basePath,
-            localPath,
-        });
-        const pathParts = [];
-        const { childrenTree, childrenPathPart } = (0, summarizerNodeUtils_1.parseSummaryForSubtrees)(snapshotTree);
-        if (childrenPathPart !== undefined) {
-            pathParts.push(childrenPathPart);
-        }
-        if (pathParts.length > 0) {
-            this._latestSummary.additionalPath = summarizerNodeUtils_1.EscapedPath.createAndConcat(pathParts);
-        }
-        // Propagate update to all child nodes
-        const pathForChildren = this._latestSummary.fullPathForChildren;
-        await Promise.all(Array.from(this.children)
-            .filter(([id]) => {
-            // Assuming subtrees missing from snapshot are newer than the snapshot,
-            // but might be nice to assert this using earliest seq for node.
-            return childrenTree.trees[id] !== undefined;
-        })
-            .map(async ([id, child]) => {
-            return child.refreshLatestSummaryFromSnapshot(referenceSequenceNumber, childrenTree.trees[id], pathForChildren, summarizerNodeUtils_1.EscapedPath.create(id), correlatedSummaryLogger, readAndParseBlob);
-        }));
-    }
-    refreshLatestSummaryCore(referenceSequenceNumber) {
-        for (const [key, value] of this.pendingSummaries) {
-            if (value.referenceSequenceNumber < referenceSequenceNumber) {
-                this.pendingSummaries.delete(key);
-            }
-        }
-    }
-    updateBaseSummaryState(snapshot) {
-        // Check base summary to see if it has any additional path parts
-        // separating child SummarizerNodes. Checks for .channels subtrees.
-        const { childrenPathPart } = (0, summarizerNodeUtils_1.parseSummaryForSubtrees)(snapshot);
-        if (childrenPathPart !== undefined && this._latestSummary !== undefined) {
-            this._latestSummary.additionalPath = summarizerNodeUtils_1.EscapedPath.create(childrenPathPart);
-        }
-    }
-    recordChange(op) {
-        this.invalidate(op.sequenceNumber);
-    }
-    invalidate(sequenceNumber) {
-        if (sequenceNumber > this._changeSequenceNumber) {
-            this._changeSequenceNumber = sequenceNumber;
-        }
-    }
-    /**
-     * True if a change has been recorded with sequence number exceeding
-     * the latest successfully acked summary reference sequence number.
-     * False implies that the previous summary can be reused.
-     */
-    hasChanged() {
-        return this._changeSequenceNumber > this.referenceSequenceNumber;
-    }
-    get latestSummary() {
-        return this._latestSummary;
-    }
-    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 = {}) {
-        (0, common_utils_1.assert)(!this.children.has(id), 0x1ab /* "Create SummarizerNode child already exists" */);
-        const createDetails = this.getCreateDetailsForChild(id, createParam);
-        const child = new SummarizerNode(this.defaultLogger, summarizeInternalFn, config, createDetails.changeSequenceNumber, createDetails.latestSummary, createDetails.initialSummary, this.wipSummaryLogger);
-        // 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. Same goes for pendingSummaries we might
-        // have outstanding on the parent in case we realize nodes in between Summary Op and Summary Ack.
-        this.maybeUpdateChildState(child);
-        this.children.set(id, child);
-        return child;
-    }
-    getChild(id) {
-        return this.children.get(id);
-    }
-    /**
-     * Returns the details needed to create a child node.
-     * @param id - Initial id or path part of the child node.
-     * @param createParam - Information needed to create the node.
-     * @returns the details needed to create the child node.
-     */
-    getCreateDetailsForChild(id, createParam) {
-        var _a;
-        let initialSummary;
-        let latestSummary;
-        let changeSequenceNumber;
-        const parentLatestSummary = this._latestSummary;
-        switch (createParam.type) {
-            case runtime_definitions_1.CreateSummarizerNodeSource.FromAttach: {
-                if (parentLatestSummary !== undefined &&
-                    createParam.sequenceNumber <= parentLatestSummary.referenceSequenceNumber) {
-                    // Prioritize latest summary if it was after this node was attached.
-                    latestSummary = parentLatestSummary.createForChild(id);
-                }
-                else {
-                    const summary = (0, summaryUtils_1.convertToSummaryTree)(createParam.snapshot);
-                    initialSummary = {
-                        sequenceNumber: createParam.sequenceNumber,
-                        id,
-                        summary,
-                    };
-                }
-                changeSequenceNumber = createParam.sequenceNumber;
-                break;
-            }
-            case runtime_definitions_1.CreateSummarizerNodeSource.FromSummary: {
-                if (this.initialSummary === undefined) {
-                    (0, common_utils_1.assert)(!!parentLatestSummary, 0x1ac /* "Cannot create child from summary if parent does not have latest summary" */);
-                }
-                // fallthrough to local
-            }
-            case runtime_definitions_1.CreateSummarizerNodeSource.Local: {
-                const parentInitialSummary = this.initialSummary;
-                if (parentInitialSummary !== undefined) {
-                    let childSummary;
-                    if (parentInitialSummary.summary !== undefined) {
-                        const { childrenTree } = (0, summarizerNodeUtils_1.parseSummaryTreeForSubtrees)(parentInitialSummary.summary.summary);
-                        (0, common_utils_1.assert)(childrenTree.type === protocol_definitions_1.SummaryType.Tree, 0x1d6 /* "Parent summary object is not a tree" */);
-                        childSummary = childrenTree.tree[id];
-                    }
-                    if (createParam.type === runtime_definitions_1.CreateSummarizerNodeSource.FromSummary) {
-                        // Locally created would not have differential subtree.
-                        (0, common_utils_1.assert)(!!childSummary, 0x1ad /* "Missing child summary tree" */);
-                    }
-                    let childSummaryWithStats;
-                    if (childSummary !== undefined) {
-                        (0, common_utils_1.assert)(childSummary.type === protocol_definitions_1.SummaryType.Tree, 0x1ae /* "Child summary object is not a tree" */);
-                        childSummaryWithStats = {
-                            summary: childSummary,
-                            stats: (0, summaryUtils_1.calculateStats)(childSummary),
-                        };
-                    }
-                    initialSummary = {
-                        sequenceNumber: parentInitialSummary.sequenceNumber,
-                        id,
-                        summary: childSummaryWithStats,
-                    };
-                }
-                latestSummary = parentLatestSummary === null || parentLatestSummary === void 0 ? void 0 : parentLatestSummary.createForChild(id);
-                changeSequenceNumber = (_a = parentLatestSummary === null || parentLatestSummary === void 0 ? void 0 : parentLatestSummary.referenceSequenceNumber) !== null && _a !== void 0 ? _a : -1;
-                break;
-            }
-            default: {
-                const type = createParam.type;
-                (0, common_utils_1.unreachableCase)(createParam, `Unexpected CreateSummarizerNodeSource: ${type}`);
-            }
-        }
-        return {
-            initialSummary,
-            latestSummary,
-            changeSequenceNumber,
-        };
-    }
-    /**
-     * Updates the state of the child if required. For example, if a summary is currently being  tracked, the child's
-     * summary tracking state needs to be updated too.
-     * Also, in case a child node gets realized in between Summary Op and Summary Ack, let's initialize the child's
-     * pending summary as well.
-     * @param child - The child node whose state is to be updated.
-     */
-    maybeUpdateChildState(child) {
-        // If we are tracking a summary, this child was created after the tracking started. So, we need to update the
-        // child's tracking state as well.
-        if (this.isTrackingInProgress()) {
-            child.wipReferenceSequenceNumber = this.wipReferenceSequenceNumber;
-        }
-        // In case we have pending summaries on the parent, let's initialize it on the child.
-        if (child._latestSummary !== undefined) {
-            for (const [key, value] of this.pendingSummaries.entries()) {
-                const newLatestSummaryNode = new summarizerNodeUtils_1.SummaryNode({
-                    referenceSequenceNumber: value.referenceSequenceNumber,
-                    basePath: child._latestSummary.basePath,
-                    localPath: child._latestSummary.localPath,
-                });
-                child.addPendingSummary(key, newLatestSummaryNode);
-            }
-        }
-    }
-    addPendingSummary(key, summary) {
-        this.pendingSummaries.set(key, summary);
-    }
-    /**
-     * Tells whether summary tracking is in progress. True if "startSummary" API is called before summarize.
-     */
-    isTrackingInProgress() {
-        return this.wipReferenceSequenceNumber !== undefined;
-    }
-}
-exports.SummarizerNode = SummarizerNode;
-/**
- * Creates a root summarizer node.
- * @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
- */
-const createRootSummarizerNode = (logger, summarizeInternalFn, changeSequenceNumber, referenceSequenceNumber, config = {}) => new SummarizerNode(logger, summarizeInternalFn, config, changeSequenceNumber, referenceSequenceNumber === undefined
-    ? undefined
-    : summarizerNodeUtils_1.SummaryNode.createForRoot(referenceSequenceNumber));
-exports.createRootSummarizerNode = createRootSummarizerNode;
-//# sourceMappingURL=summarizerNode.js.map