@fluidframework/container-runtime 2.0.0-internal.3.4.2 → 2.0.0-internal.4.0.1

package/dist/summary/summarizerNode/summarizerNode.js

@@ -0,0 +1,520 @@
+"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 runtime_utils_1 = require("@fluidframework/runtime-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+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(baseLogger, summarizeInternalFn, config, _changeSequenceNumber, 
+    /** Undefined means created without summary */
+    _latestSummary, initialSummary, wipSummaryLogger, 
+    /** A unique id of this node to be logged when sending telemetry. */
+    telemetryNodeId) {
+        var _a;
+        this.summarizeInternalFn = summarizeInternalFn;
+        this._changeSequenceNumber = _changeSequenceNumber;
+        this._latestSummary = _latestSummary;
+        this.initialSummary = initialSummary;
+        this.wipSummaryLogger = wipSummaryLogger;
+        this.telemetryNodeId = telemetryNodeId;
+        this.children = new Map();
+        this.pendingSummaries = new Map();
+        this.wipSkipRecursion = false;
+        this.canReuseHandle = (_a = config.canReuseHandle) !== null && _a !== void 0 ? _a : true;
+        // All logs posted by the summarizer node should include the telemetryNodeId.
+        this.logger = telemetry_utils_1.ChildLogger.create(baseLogger, undefined /* namespace */, {
+            all: {
+                id: {
+                    tag: telemetry_utils_1.TelemetryDataTag.CodeArtifact,
+                    value: this.telemetryNodeId,
+                },
+            },
+        });
+    }
+    /**
+     * 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.isSummaryInProgress(), 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, runtime_utils_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;
+            }
+        }
+        /**
+         * The absence of wip local path indicates that summarize was not called for this node. This can happen if:
+         * 1. A child node was created after summarize was already called on the parent. For example, a data store
+         * is realized (loaded) after summarize was called on it creating summarizer nodes for its DDSes. In this case,
+         * parentSkipRecursion will be true and the if block above would handle it.
+         * 2. A new node was created but summarize was never called on it. This can mean that the summary that is
+         * generated may not have the data from this node. We should not continue, log and throw an error. This
+         * will help us identify these cases and take appropriate action.
+         */
+        if (localPathsToUse === undefined) {
+            this.throwUnexpectedError({
+                eventName: "NodeNotSummarized",
+                proposalHandle,
+            });
+        }
+        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 fetch the latest snapshot 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 updated.
+     *
+     * 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, fetchLatestSnapshot, readAndParseBlob, correlatedSummaryLogger) {
+        const eventProps = {
+            proposalHandle,
+            summaryRefSeq,
+            referenceSequenceNumber: this.referenceSequenceNumber,
+        };
+        return telemetry_utils_1.PerformanceEvent.timedExecAsync(this.logger, Object.assign({ eventName: "refreshLatestSummary" }, eventProps), async (event) => {
+            var _a;
+            // Refresh latest summary should not happen while a summary is in progress. If it does, it can result
+            // in inconsistent state, so, we should not continue;
+            if (this.isSummaryInProgress()) {
+                throw new telemetry_utils_1.LoggingError("UnexpectedRefreshDuringSummarize", {
+                    inProgressSummaryRefSeq: this.wipReferenceSequenceNumber,
+                });
+            }
+            if (proposalHandle !== undefined) {
+                const maybeSummaryNode = this.pendingSummaries.get(proposalHandle);
+                if (maybeSummaryNode !== undefined) {
+                    this.refreshLatestSummaryFromPending(proposalHandle, maybeSummaryNode.referenceSequenceNumber);
+                    eventProps.wasSummaryTracked = true;
+                    eventProps.latestSummaryUpdated = true;
+                    event.end(eventProps);
+                    return {
+                        latestSummaryUpdated: true,
+                        wasSummaryTracked: true,
+                        summaryRefSeq,
+                    };
+                }
+                const props = {
+                    summaryRefSeq,
+                    pendingSize: (_a = this.pendingSummaries.size) !== null && _a !== void 0 ? _a : undefined,
+                };
+                this.logger.sendTelemetryEvent({
+                    eventName: "PendingSummaryNotFound",
+                    proposalHandle,
+                    referenceSequenceNumber: this.referenceSequenceNumber,
+                    details: JSON.stringify(props),
+                });
+            }
+            // If the summary for which refresh is called is older than the latest tracked summary, ignore it.
+            if (this.referenceSequenceNumber >= summaryRefSeq) {
+                eventProps.latestSummaryUpdated = false;
+                event.end(eventProps);
+                return { latestSummaryUpdated: false };
+            }
+            // Fetch the latest snapshot and refresh state from it. Note that we need to use the reference sequence number
+            // of the fetched snapshot and not the "summaryRefSeq" that was passed in.
+            const { snapshotTree, snapshotRefSeq: fetchedSnapshotRefSeq } = await fetchLatestSnapshot();
+            // Possible re-entrancy. We may have updated latest summary state while fetching the snapshot. If the fetched
+            // snapshot is older than the latest tracked summary, ignore it.
+            if (this.referenceSequenceNumber >= fetchedSnapshotRefSeq) {
+                eventProps.latestSummaryUpdated = false;
+                event.end(eventProps);
+                return { latestSummaryUpdated: false };
+            }
+            await this.refreshLatestSummaryFromSnapshot(fetchedSnapshotRefSeq, snapshotTree, undefined, summarizerNodeUtils_1.EscapedPath.create(""), correlatedSummaryLogger, readAndParseBlob);
+            eventProps.latestSummaryUpdated = true;
+            eventProps.wasSummaryTracked = false;
+            eventProps.summaryRefSeq = fetchedSnapshotRefSeq;
+            event.end(eventProps);
+            return {
+                latestSummaryUpdated: true,
+                wasSummaryTracked: false,
+                snapshotTree,
+                summaryRefSeq: fetchedSnapshotRefSeq,
+            };
+        }, { start: true, end: true, cancel: "error" });
+    }
+    /**
+     * 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.logger, summarizeInternalFn, config, createDetails.changeSequenceNumber, createDetails.latestSummary, createDetails.initialSummary, this.wipSummaryLogger, createDetails.telemetryNodeId);
+        // 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, id);
+        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, _b;
+        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, runtime_utils_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, runtime_utils_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}`);
+            }
+        }
+        const childtelemetryNodeId = `${(_b = this.telemetryNodeId) !== null && _b !== void 0 ? _b : ""}/${id}`;
+        return {
+            initialSummary,
+            latestSummary,
+            changeSequenceNumber,
+            telemetryNodeId: childtelemetryNodeId,
+        };
+    }
+    /**
+     * 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.
+     * @param id - Initial id or path part of this node
+     *
+     */
+    maybeUpdateChildState(child, id) {
+        // If a summary is in progress, this child was created after the summary started. So, we need to update the
+        // child's summary state as well.
+        if (this.isSummaryInProgress()) {
+            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.
+     */
+    isSummaryInProgress() {
+        return this.wipReferenceSequenceNumber !== undefined;
+    }
+    /**
+     * Creates and throws an error due to unexpected conditions.
+     */
+    throwUnexpectedError(eventProps) {
+        const error = new telemetry_utils_1.LoggingError(eventProps.eventName, Object.assign(Object.assign({}, eventProps), { referenceSequenceNumber: this.wipReferenceSequenceNumber, id: {
+                tag: telemetry_utils_1.TelemetryDataTag.CodeArtifact,
+                value: this.telemetryNodeId,
+            } }));
+        this.logger.sendErrorEvent(eventProps, error);
+        throw error;
+    }
+}
+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), undefined /* initialSummary */, undefined /* wipSummaryLogger */, "" /* telemetryNodeId */);
+exports.createRootSummarizerNode = createRootSummarizerNode;
+//# sourceMappingURL=summarizerNode.js.map

package/dist/summary/summarizerNode/summarizerNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarizerNode.js","sourceRoot":"","sources":["../../../src/summary/summarizerNode/summarizerNode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,6EAS6C;AAC7C,+EAK8C;AAE9C,+DAAuE;AACvE,iEAKuC;AACvC,qEAKyC;AACzC,+DAU+B;AAI/B;;;;;;;;;;;;GAYG;AACH,MAAa,cAAc;IAiB1B;;;OAGG;IACH,YACC,UAA4B,EACX,mBAAwC,EACzD,MAA6B,EACrB,qBAA6B;IACrC,8CAA8C;IACtC,cAA4B,EACnB,cAAgC,EACvC,gBAAmC;IAC7C,oEAAoE;IAC1D,eAAwB;;QARjB,wBAAmB,GAAnB,mBAAmB,CAAqB;QAEjD,0BAAqB,GAArB,qBAAqB,CAAQ;QAE7B,mBAAc,GAAd,cAAc,CAAc;QACnB,mBAAc,GAAd,cAAc,CAAkB;QACvC,qBAAgB,GAAhB,gBAAgB,CAAmB;QAEnC,oBAAe,GAAf,eAAe,CAAS;QAtBhB,aAAQ,GAAG,IAAI,GAAG,EAA0B,CAAC;QAC7C,qBAAgB,GAAG,IAAI,GAAG,EAAuB,CAAC;QAG7D,qBAAgB,GAAG,KAAK,CAAC;QAoBhC,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,cAAc,mCAAI,IAAI,CAAC;QACpD,6EAA6E;QAC7E,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,eAAe,EAAE;YACvE,GAAG,EAAE;gBACJ,EAAE,EAAE;oBACH,GAAG,EAAE,kCAAgB,CAAC,YAAY;oBAClC,KAAK,EAAE,IAAI,CAAC,eAAe;iBAC3B;aACD;SACD,CAAC,CAAC;IACJ,CAAC;IA1CD;;;OAGG;IACH,IAAW,uBAAuB;;QACjC,OAAO,MAAA,MAAA,IAAI,CAAC,cAAc,0CAAE,uBAAuB,mCAAI,CAAC,CAAC;IAC1D,CAAC;IAsCM,YAAY,CAAC,uBAA+B,EAAE,aAA+B;QACnF,IAAA,qBAAM,EACL,IAAI,CAAC,gBAAgB,KAAK,SAAS,EACnC,KAAK,CAAC,8DAA8D,CACpE,CAAC;QACF,IAAA,qBAAM,EACL,IAAI,CAAC,0BAA0B,KAAK,SAAS,EAC7C,KAAK,CAAC,kCAAkC,CACxC,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC;QAEtC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,YAAY,CAAC,uBAAuB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACnE;QACD,IAAI,CAAC,0BAA0B,GAAG,uBAAuB,CAAC;IAC3D,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,QAAiB,EACjB,aAAsB,IAAI,EAC1B,gBAAoC;QAEpC,IAAA,qBAAM,EACL,IAAI,CAAC,mBAAmB,EAAE,EAC1B,KAAK,CAAC,oEAAoE,CAC1E,CAAC;QACF,IAAA,qBAAM,EACL,IAAI,CAAC,gBAAgB,KAAK,SAAS,EACnC,KAAK,CAAC,qEAAqE,CAC3E,CAAC;QAEF,qCAAqC;QACrC,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YAC3D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;YAC1C,IAAI,aAAa,KAAK,SAAS,EAAE;gBAChC,IAAI,CAAC,aAAa,GAAG;oBACpB,SAAS,EAAE,aAAa,CAAC,SAAS;oBAClC,cAAc,EAAE,aAAa,CAAC,cAAc;iBAC5C,CAAC;gBACF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAA,0BAAU,GAAE,CAAC;gBAC3B,KAAK,CAAC,eAAe,EAAE,CAAC;gBACxB,OAAO;oBACN,OAAO,EAAE;wBACR,IAAI,EAAE,kCAAW,CAAC,MAAM;wBACxB,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,IAAI;wBACnC,UAAU,EAAE,kCAAW,CAAC,IAAI;qBAC5B;oBACD,KAAK;iBACL,CAAC;aACF;SACD;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,iCAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;QAClE,IAAI,MAAM,CAAC,oBAAoB,KAAK,SAAS,EAAE;YAC9C,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG,iCAAW,CAAC,eAAe,CAC9D,MAAM,CAAC,oBAAoB,CAC3B,CAAC;SACF;QACD,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC;IACzD,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,cAAsB;QAC5C,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACO,mBAAmB,CAC5B,cAAsB,EACtB,UAAmC,EACnC,mBAA4B;QAE5B,IAAA,qBAAM,EACL,IAAI,CAAC,gBAAgB,KAAK,SAAS,EACnC,KAAK,CAAC,qEAAqE,CAC3E,CAAC;QACF,IAAA,qBAAM,EAAC,IAAI,CAAC,0BAA0B,KAAK,SAAS,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC5F,IAAI,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,IAAI,mBAAmB,EAAE;YACxB,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;YAC1C,IAAI,aAAa,KAAK,SAAS,EAAE;gBAChC,qEAAqE;gBACrE,qEAAqE;gBACrE,2DAA2D;gBAC3D,qEAAqE;gBACrE,+CAA+C;gBAC/C,wEAAwE;gBACxE,eAAe,GAAG;oBACjB,SAAS,EAAE,aAAa,CAAC,SAAS;oBAClC,cAAc,EAAE,aAAa,CAAC,cAAc;iBAC5C,CAAC;aACF;iBAAM;gBACN,qEAAqE;gBACrE,qEAAqE;gBACrE,mCAAmC;gBACnC,uEAAuE;gBACvE,wEAAwE;gBACxE,uEAAuE;gBACvE,IAAI,CAAC,YAAY,EAAE,CAAC;gBACpB,OAAO;aACP;SACD;QAED;;;;;;;;WAQG;QACH,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,oBAAoB,CAAC;gBACzB,SAAS,EAAE,mBAAmB;gBAC9B,cAAc;aACd,CAAC,CAAC;SACH;QAED,MAAM,OAAO,GAAG,IAAI,iCAAW,iCAC3B,eAAe,KAClB,uBAAuB,EAAE,IAAI,CAAC,0BAA0B,EACxD,QAAQ,EAAE,UAAU,IACnB,CAAC;QACH,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QACxD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,mBAAmB,CACxB,cAAc,EACd,mBAAmB,EACnB,IAAI,CAAC,gBAAgB,IAAI,mBAAmB,CAC5C,CAAC;SACF;QACD,0DAA0D;QAC1D,+DAA+D;QAC/D,+DAA+D;QAC/D,8DAA8D;QAC9D,gEAAgE;QAChE,kEAAkE;QAClE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,YAAY,EAAE,CAAC;IACrB,CAAC;IAEM,YAAY;QAClB,IAAI,CAAC,0BAA0B,GAAG,SAAS,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAC9B,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,YAAY,EAAE,CAAC;SACrB;IACF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,oBAAoB,CAChC,cAAkC,EAClC,aAAqB,EACrB,mBAAwD,EACxD,gBAAkC,EAClC,uBAAyC;QAEzC,MAAM,UAAU,GAMZ;YACH,cAAc;YACd,aAAa;YACb,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACrD,CAAC;QACF,OAAO,kCAAgB,CAAC,cAAc,CACrC,IAAI,CAAC,MAAM,kBAEV,SAAS,EAAE,sBAAsB,IAC9B,UAAU,GAEd,KAAK,EAAE,KAAK,EAAE,EAAE;;YACf,qGAAqG;YACrG,qDAAqD;YACrD,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;gBAC/B,MAAM,IAAI,8BAAY,CAAC,kCAAkC,EAAE;oBAC1D,uBAAuB,EAAE,IAAI,CAAC,0BAA0B;iBACxD,CAAC,CAAC;aACH;YAED,IAAI,cAAc,KAAK,SAAS,EAAE;gBACjC,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBAEnE,IAAI,gBAAgB,KAAK,SAAS,EAAE;oBACnC,IAAI,CAAC,+BAA+B,CACnC,cAAc,EACd,gBAAgB,CAAC,uBAAuB,CACxC,CAAC;oBACF,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC;oBACpC,UAAU,CAAC,oBAAoB,GAAG,IAAI,CAAC;oBACvC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;oBACtB,OAAO;wBACN,oBAAoB,EAAE,IAAI;wBAC1B,iBAAiB,EAAE,IAAI;wBACvB,aAAa;qBACb,CAAC;iBACF;gBAED,MAAM,KAAK,GAAG;oBACb,aAAa;oBACb,WAAW,EAAE,MAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,mCAAI,SAAS;iBACpD,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC9B,SAAS,EAAE,wBAAwB;oBACnC,cAAc;oBACd,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;oBACrD,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;iBAC9B,CAAC,CAAC;aACH;YAED,kGAAkG;YAClG,IAAI,IAAI,CAAC,uBAAuB,IAAI,aAAa,EAAE;gBAClD,UAAU,CAAC,oBAAoB,GAAG,KAAK,CAAC;gBACxC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACtB,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;aACvC;YAED,8GAA8G;YAC9G,0EAA0E;YAC1E,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,qBAAqB,EAAE,GAC5D,MAAM,mBAAmB,EAAE,CAAC;YAE7B,6GAA6G;YAC7G,gEAAgE;YAChE,IAAI,IAAI,CAAC,uBAAuB,IAAI,qBAAqB,EAAE;gBAC1D,UAAU,CAAC,oBAAoB,GAAG,KAAK,CAAC;gBACxC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACtB,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;aACvC;YAED,MAAM,IAAI,CAAC,gCAAgC,CAC1C,qBAAqB,EACrB,YAAY,EACZ,SAAS,EACT,iCAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EACtB,uBAAuB,EACvB,gBAAgB,CAChB,CAAC;YAEF,UAAU,CAAC,oBAAoB,GAAG,IAAI,CAAC;YACvC,UAAU,CAAC,iBAAiB,GAAG,KAAK,CAAC;YACrC,UAAU,CAAC,aAAa,GAAG,qBAAqB,CAAC;YACjD,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACtB,OAAO;gBACN,oBAAoB,EAAE,IAAI;gBAC1B,iBAAiB,EAAE,KAAK;gBACxB,YAAY;gBACZ,aAAa,EAAE,qBAAqB;aACpC,CAAC;QACH,CAAC,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAC3C,CAAC;IACH,CAAC;IACD;;;;;OAKG;IACO,+BAA+B,CACxC,cAAsB,EACtB,uBAA+B;QAE/B,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9D,IAAI,WAAW,KAAK,SAAS,EAAE;YAC9B,oFAAoF;YACpF,IAAA,qBAAM,EACL,IAAI,CAAC,cAAc,KAAK,SAAS,EACjC,KAAK,CAAC,mFAAmF,CACzF,CAAC;YACF,OAAO;SACP;aAAM;YACN,IAAA,qBAAM,EACL,uBAAuB,KAAK,WAAW,CAAC,uBAAuB,EAC/D,KAAK,CAAC,oEAAoE,CAC1E,CAAC;YAEF,kCAAkC;YAClC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;SAC7C;QAED,IAAI,CAAC,wBAAwB,CAAC,uBAAuB,CAAC,CAAC;QAEvD,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC;QAClC,sCAAsC;QACtC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,+BAA+B,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;SAC/E;IACF,CAAC;IAES,KAAK,CAAC,gCAAgC,CAC/C,uBAA+B,EAC/B,YAA2B,EAC3B,QAAiC,EACjC,SAAsB,EACtB,uBAAyC,EACzC,gBAAkC;QAElC,0FAA0F;QAC1F,IAAI,IAAI,CAAC,uBAAuB,IAAI,uBAAuB,EAAE;YAC5D,OAAO;SACP;QAED,IAAI,CAAC,wBAAwB,CAAC,uBAAuB,CAAC,CAAC;QAEvD,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAW,CAAC;YACrC,uBAAuB;YACvB,QAAQ;YACR,SAAS;SACT,CAAC,CAAC;QAEH,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAA,6CAAuB,EAAC,YAAY,CAAC,CAAC;QACjF,IAAI,gBAAgB,KAAK,SAAS,EAAE;YACnC,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;SACjC;QAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,cAAc,CAAC,cAAc,GAAG,iCAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;SAC5E;QAED,sCAAsC;QACtC,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC;QAChE,MAAM,OAAO,CAAC,GAAG,CAChB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;aACvB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAChB,uEAAuE;YACvE,gEAAgE;YAChE,OAAO,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC;QAC7C,CAAC,CAAC;aACD,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE;YAC1B,OAAO,KAAK,CAAC,gCAAgC,CAC5C,uBAAuB,EACvB,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,EACtB,eAAe,EACf,iCAAW,CAAC,MAAM,CAAC,EAAE,CAAC,EACtB,uBAAuB,EACvB,gBAAgB,CAChB,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACH,CAAC;IAEO,wBAAwB,CAAC,uBAA+B;QAC/D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACjD,IAAI,KAAK,CAAC,uBAAuB,GAAG,uBAAuB,EAAE;gBAC5D,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aAClC;SACD;IACF,CAAC;IAEM,sBAAsB,CAAC,QAAuB;QACpD,gEAAgE;QAChE,mEAAmE;QACnE,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAA,6CAAuB,EAAC,QAAQ,CAAC,CAAC;QAC/D,IAAI,gBAAgB,KAAK,SAAS,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;YACxE,IAAI,CAAC,cAAc,CAAC,cAAc,GAAG,iCAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;SAC1E;IACF,CAAC;IAEM,YAAY,CAAC,EAA6B;QAChD,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;IACpC,CAAC;IAEM,UAAU,CAAC,cAAsB;QACvC,IAAI,cAAc,GAAG,IAAI,CAAC,qBAAqB,EAAE;YAChD,IAAI,CAAC,qBAAqB,GAAG,cAAc,CAAC;SAC5C;IACF,CAAC;IAED;;;;OAIG;IACO,UAAU;QACnB,OAAO,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC;IAClE,CAAC;IAED,IAAW,aAAa;QACvB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC5B,CAAC;IAIM,WAAW;IACjB,yBAAyB;IACzB,mBAAwC;IACxC,2CAA2C;IAC3C,EAAU;IACV;;;;OAIG;IACH,WAA2C,EAC3C,SAAgC,EAAE;QAElC,IAAA,qBAAM,EAAC,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,cAAc,CAC/B,IAAI,CAAC,MAAM,EACX,mBAAmB,EACnB,MAAM,EACN,aAAa,CAAC,oBAAoB,EAClC,aAAa,CAAC,aAAa,EAC3B,aAAa,CAAC,cAAc,EAC5B,IAAI,CAAC,gBAAgB,EACrB,aAAa,CAAC,eAAe,CAC7B,CAAC;QAEF,yGAAyG;QACzG,+GAA+G;QAC/G,iGAAiG;QACjG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAEtC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,QAAQ,CAAC,EAAU;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACO,wBAAwB,CACjC,EAAU,EACV,WAA2C;;QAE3C,IAAI,cAA2C,CAAC;QAChD,IAAI,aAAsC,CAAC;QAC3C,IAAI,oBAA4B,CAAC;QAEjC,MAAM,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAAC;QAChD,QAAQ,WAAW,CAAC,IAAI,EAAE;YACzB,KAAK,gDAA0B,CAAC,UAAU,CAAC,CAAC;gBAC3C,IACC,mBAAmB,KAAK,SAAS;oBACjC,WAAW,CAAC,cAAc,IAAI,mBAAmB,CAAC,uBAAuB,EACxE;oBACD,oEAAoE;oBACpE,aAAa,GAAG,mBAAmB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;iBACvD;qBAAM;oBACN,MAAM,OAAO,GAAG,IAAA,oCAAoB,EACnC,WAAW,CAAC,QAAQ,CACK,CAAC;oBAC3B,cAAc,GAAG;wBAChB,cAAc,EAAE,WAAW,CAAC,cAAc;wBAC1C,EAAE;wBACF,OAAO;qBACP,CAAC;iBACF;gBACD,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC;gBAClD,MAAM;aACN;YACD,KAAK,gDAA0B,CAAC,WAAW,CAAC,CAAC;gBAC5C,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;oBACtC,IAAA,qBAAM,EACL,CAAC,CAAC,mBAAmB,EACrB,KAAK,CAAC,+EAA+E,CACrF,CAAC;iBACF;gBACD,uBAAuB;aACvB;YACD,KAAK,gDAA0B,CAAC,KAAK,CAAC,CAAC;gBACtC,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC;gBACjD,IAAI,oBAAoB,KAAK,SAAS,EAAE;oBACvC,IAAI,YAAuC,CAAC;oBAC5C,IAAI,oBAAoB,CAAC,OAAO,KAAK,SAAS,EAAE;wBAC/C,MAAM,EAAE,YAAY,EAAE,GAAG,IAAA,iDAA2B,EACnD,oBAAoB,CAAC,OAAO,CAAC,OAAO,CACpC,CAAC;wBACF,IAAA,qBAAM,EACL,YAAY,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EACtC,KAAK,CAAC,2CAA2C,CACjD,CAAC;wBACF,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;qBACrC;oBACD,IAAI,WAAW,CAAC,IAAI,KAAK,gDAA0B,CAAC,WAAW,EAAE;wBAChE,uDAAuD;wBACvD,IAAA,qBAAM,EAAC,CAAC,CAAC,YAAY,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;qBACjE;oBACD,IAAI,qBAAwD,CAAC;oBAC7D,IAAI,YAAY,KAAK,SAAS,EAAE;wBAC/B,IAAA,qBAAM,EACL,YAAY,CAAC,IAAI,KAAK,kCAAW,CAAC,IAAI,EACtC,KAAK,CAAC,0CAA0C,CAChD,CAAC;wBACF,qBAAqB,GAAG;4BACvB,OAAO,EAAE,YAAY;4BACrB,KAAK,EAAE,IAAA,8BAAc,EAAC,YAAY,CAAC;yBACnC,CAAC;qBACF;oBACD,cAAc,GAAG;wBAChB,cAAc,EAAE,oBAAoB,CAAC,cAAc;wBACnD,EAAE;wBACF,OAAO,EAAE,qBAAqB;qBAC9B,CAAC;iBACF;gBACD,aAAa,GAAG,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,cAAc,CAAC,EAAE,CAAC,CAAC;gBACxD,oBAAoB,GAAG,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,uBAAuB,mCAAI,CAAC,CAAC,CAAC;gBAC1E,MAAM;aACN;YACD,OAAO,CAAC,CAAC;gBACR,MAAM,IAAI,GAAI,WAAyD,CAAC,IAAI,CAAC;gBAC7E,IAAA,8BAAe,EAAC,WAAW,EAAE,0CAA0C,IAAI,EAAE,CAAC,CAAC;aAC/E;SACD;QAED,MAAM,oBAAoB,GAAG,GAAG,MAAA,IAAI,CAAC,eAAe,mCAAI,EAAE,IAAI,EAAE,EAAE,CAAC;QAEnE,OAAO;YACN,cAAc;YACd,aAAa;YACb,oBAAoB;YACpB,eAAe,EAAE,oBAAoB;SACrC,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACO,qBAAqB,CAAC,KAAqB,EAAE,EAAU;QAChE,2GAA2G;QAC3G,iCAAiC;QACjC,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC/B,KAAK,CAAC,0BAA0B,GAAG,IAAI,CAAC,0BAA0B,CAAC;SACnE;QACD,qFAAqF;QACrF,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE;YACvC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,EAAE;gBAC3D,MAAM,oBAAoB,GAAG,IAAI,iCAAW,CAAC;oBAC5C,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;oBACtD,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,QAAQ;oBACvC,SAAS,EAAE,KAAK,CAAC,cAAc,CAAC,SAAS;iBACzC,CAAC,CAAC;gBAEH,KAAK,CAAC,iBAAiB,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;aACnD;SACD;IACF,CAAC;IAES,iBAAiB,CAAC,GAAW,EAAE,OAAoB;QAC5D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,mBAAmB;QACzB,OAAO,IAAI,CAAC,0BAA0B,KAAK,SAAS,CAAC;IACtD,CAAC;IAED;;OAEG;IACO,oBAAoB,CAAC,UAAgC;QAC9D,MAAM,KAAK,GAAG,IAAI,8BAAY,CAAC,UAAU,CAAC,SAAS,kCAC/C,UAAU,KACb,uBAAuB,EAAE,IAAI,CAAC,0BAA0B,EACxD,EAAE,EAAE;gBACH,GAAG,EAAE,kCAAgB,CAAC,YAAY;gBAClC,KAAK,EAAE,IAAI,CAAC,eAAe;aAC3B,IACA,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC9C,MAAM,KAAK,CAAC;IACb,CAAC;CACD;AA5oBD,wCA4oBC;AAED;;;;;;;;GAQG;AACI,MAAM,wBAAwB,GAAG,CACvC,MAAwB,EACxB,mBAAwC,EACxC,oBAA4B,EAC5B,uBAA2C,EAC3C,SAAgC,EAAE,EACZ,EAAE,CACxB,IAAI,cAAc,CACjB,MAAM,EACN,mBAAmB,EACnB,MAAM,EACN,oBAAoB,EACpB,uBAAuB,KAAK,SAAS;IACpC,CAAC,CAAC,SAAS;IACX,CAAC,CAAC,iCAAW,CAAC,aAAa,CAAC,uBAAuB,CAAC,EACrD,SAAS,CAAC,oBAAoB,EAC9B,SAAS,CAAC,sBAAsB,EAChC,EAAE,CAAC,qBAAqB,CACxB,CAAC;AAlBU,QAAA,wBAAwB,4BAkBlC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tISummarizerNode,\n\tISummarizerNodeConfig,\n\tISummarizeResult,\n\tISummaryTreeWithStats,\n\tCreateChildSummarizerNodeParam,\n\tCreateSummarizerNodeSource,\n\tSummarizeInternalFn,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport {\n\tISequencedDocumentMessage,\n\tSummaryType,\n\tISnapshotTree,\n\tSummaryObject,\n} from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryErrorEvent, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, unreachableCase } from \"@fluidframework/common-utils\";\nimport {\n\tconvertToSummaryTree,\n\tcalculateStats,\n\tmergeStats,\n\tReadAndParseBlob,\n} from \"@fluidframework/runtime-utils\";\nimport {\n\tChildLogger,\n\tLoggingError,\n\tPerformanceEvent,\n\tTelemetryDataTag,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n\tEscapedPath,\n\tICreateChildDetails,\n\tIFetchSnapshotResult,\n\tIInitialSummary,\n\tISummarizerNodeRootContract,\n\tparseSummaryForSubtrees,\n\tparseSummaryTreeForSubtrees,\n\tRefreshSummaryResult,\n\tSummaryNode,\n} from \"./summarizerNodeUtils\";\n\nexport interface IRootSummarizerNode extends ISummarizerNode, ISummarizerNodeRootContract {}\n\n/**\n * Encapsulates the summarizing work and state of an individual tree node in the\n * summary tree. It tracks changes and allows for optimizations when unchanged, or\n * can allow for fallback summaries to be generated when an error is encountered.\n * Usage is for the root node to call startSummary first to begin tracking a WIP\n * (work in progress) summary. Then all nodes will call summarize to summaries their\n * individual parts. Once completed and uploaded to storage, the root node will call\n * completeSummary or clearSummary to clear the WIP summary tracking state if something\n * went wrong. The SummarizerNodes will track all pending summaries that have been\n * recorded by the completeSummary call. When one of them is acked, the root node should\n * call refreshLatestSummary to inform the tree of SummarizerNodes of the new baseline\n * latest successful summary.\n */\nexport class SummarizerNode implements IRootSummarizerNode {\n\t/**\n\t * The reference sequence number of the most recent acked summary.\n\t * Returns 0 if there is not yet an acked summary.\n\t */\n\tpublic get referenceSequenceNumber() {\n\t\treturn this._latestSummary?.referenceSequenceNumber ?? 0;\n\t}\n\n\tprotected readonly children = new Map<string, SummarizerNode>();\n\tprotected readonly pendingSummaries = new Map<string, SummaryNode>();\n\tprotected wipReferenceSequenceNumber: number | undefined;\n\tprivate wipLocalPaths: { localPath: EscapedPath; additionalPath?: EscapedPath } | undefined;\n\tprivate wipSkipRecursion = false;\n\n\tprotected readonly logger: ITelemetryLogger;\n\n\t/**\n\t * Do not call constructor directly.\n\t * Use createRootSummarizerNode to create root node, or createChild to create child nodes.\n\t */\n\tpublic constructor(\n\t\tbaseLogger: ITelemetryLogger,\n\t\tprivate readonly summarizeInternalFn: SummarizeInternalFn,\n\t\tconfig: ISummarizerNodeConfig,\n\t\tprivate _changeSequenceNumber: number,\n\t\t/** Undefined means created without summary */\n\t\tprivate _latestSummary?: SummaryNode,\n\t\tprivate readonly initialSummary?: IInitialSummary,\n\t\tprotected wipSummaryLogger?: ITelemetryLogger,\n\t\t/** A unique id of this node to be logged when sending telemetry. */\n\t\tprotected telemetryNodeId?: string,\n\t) {\n\t\tthis.canReuseHandle = config.canReuseHandle ?? true;\n\t\t// All logs posted by the summarizer node should include the telemetryNodeId.\n\t\tthis.logger = ChildLogger.create(baseLogger, undefined /* namespace */, {\n\t\t\tall: {\n\t\t\t\tid: {\n\t\t\t\t\ttag: TelemetryDataTag.CodeArtifact,\n\t\t\t\t\tvalue: this.telemetryNodeId,\n\t\t\t\t},\n\t\t\t},\n\t\t});\n\t}\n\n\tpublic startSummary(referenceSequenceNumber: number, summaryLogger: ITelemetryLogger) {\n\t\tassert(\n\t\t\tthis.wipSummaryLogger === undefined,\n\t\t\t0x19f /* \"wipSummaryLogger should not be set yet in startSummary\" */,\n\t\t);\n\t\tassert(\n\t\t\tthis.wipReferenceSequenceNumber === undefined,\n\t\t\t0x1a0 /* \"Already tracking a summary\" */,\n\t\t);\n\n\t\tthis.wipSummaryLogger = summaryLogger;\n\n\t\tfor (const child of this.children.values()) {\n\t\t\tchild.startSummary(referenceSequenceNumber, this.wipSummaryLogger);\n\t\t}\n\t\tthis.wipReferenceSequenceNumber = referenceSequenceNumber;\n\t}\n\n\tpublic async summarize(\n\t\tfullTree: boolean,\n\t\ttrackState: boolean = true,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummarizeResult> {\n\t\tassert(\n\t\t\tthis.isSummaryInProgress(),\n\t\t\t0x1a1 /* \"summarize should not be called when not tracking the summary\" */,\n\t\t);\n\t\tassert(\n\t\t\tthis.wipSummaryLogger !== undefined,\n\t\t\t0x1a2 /* \"wipSummaryLogger should have been set in startSummary or ctor\" */,\n\t\t);\n\n\t\t// Try to reuse the tree if unchanged\n\t\tif (this.canReuseHandle && !fullTree && !this.hasChanged()) {\n\t\t\tconst latestSummary = this._latestSummary;\n\t\t\tif (latestSummary !== undefined) {\n\t\t\t\tthis.wipLocalPaths = {\n\t\t\t\t\tlocalPath: latestSummary.localPath,\n\t\t\t\t\tadditionalPath: latestSummary.additionalPath,\n\t\t\t\t};\n\t\t\t\tthis.wipSkipRecursion = true;\n\t\t\t\tconst stats = mergeStats();\n\t\t\t\tstats.handleNodeCount++;\n\t\t\t\treturn {\n\t\t\t\t\tsummary: {\n\t\t\t\t\t\ttype: SummaryType.Handle,\n\t\t\t\t\t\thandle: latestSummary.fullPath.path,\n\t\t\t\t\t\thandleType: SummaryType.Tree,\n\t\t\t\t\t},\n\t\t\t\t\tstats,\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\n\t\tconst result = await this.summarizeInternalFn(fullTree, true, telemetryContext);\n\t\tthis.wipLocalPaths = { localPath: EscapedPath.create(result.id) };\n\t\tif (result.pathPartsForChildren !== undefined) {\n\t\t\tthis.wipLocalPaths.additionalPath = EscapedPath.createAndConcat(\n\t\t\t\tresult.pathPartsForChildren,\n\t\t\t);\n\t\t}\n\t\treturn { summary: result.summary, stats: result.stats };\n\t}\n\n\t/**\n\t * Complete the WIP summary for the given proposalHandle\n\t */\n\tpublic completeSummary(proposalHandle: string) {\n\t\tthis.completeSummaryCore(proposalHandle, undefined, false);\n\t}\n\n\t/**\n\t * Recursive implementation for completeSummary, with additional internal-only parameters\n\t */\n\tprotected completeSummaryCore(\n\t\tproposalHandle: string,\n\t\tparentPath: EscapedPath | undefined,\n\t\tparentSkipRecursion: boolean,\n\t) {\n\t\tassert(\n\t\t\tthis.wipSummaryLogger !== undefined,\n\t\t\t0x1a3 /* \"wipSummaryLogger should have been set in startSummary or ctor\" */,\n\t\t);\n\t\tassert(this.wipReferenceSequenceNumber !== undefined, 0x1a4 /* \"Not tracking a summary\" */);\n\t\tlet localPathsToUse = this.wipLocalPaths;\n\n\t\tif (parentSkipRecursion) {\n\t\t\tconst latestSummary = this._latestSummary;\n\t\t\tif (latestSummary !== undefined) {\n\t\t\t\t// This case the parent node created a failure summary or was reused.\n\t\t\t\t// This node and all children should only try to reference their path\n\t\t\t\t// by its last known good state in the actual summary tree.\n\t\t\t\t// If parent fails or is reused, the child summarize is not called so\n\t\t\t\t// it did not get a chance to change its paths.\n\t\t\t\t// In this case, essentially only propagate the new summary ref seq num.\n\t\t\t\tlocalPathsToUse = {\n\t\t\t\t\tlocalPath: latestSummary.localPath,\n\t\t\t\t\tadditionalPath: latestSummary.additionalPath,\n\t\t\t\t};\n\t\t\t} else {\n\t\t\t\t// This case the child is added after the latest non-failure summary.\n\t\t\t\t// This node and all children should consider themselves as still not\n\t\t\t\t// having a successful summary yet.\n\t\t\t\t// We cannot \"reuse\" this node if unchanged since that summary, because\n\t\t\t\t// handles will be unable to point to that node. It never made it to the\n\t\t\t\t// tree itself, and only exists as an attach op in the _outstandingOps.\n\t\t\t\tthis.clearSummary();\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\n\t\t/**\n\t\t * The absence of wip local path indicates that summarize was not called for this node. This can happen if:\n\t\t * 1. A child node was created after summarize was already called on the parent. For example, a data store\n\t\t * is realized (loaded) after summarize was called on it creating summarizer nodes for its DDSes. In this case,\n\t\t * parentSkipRecursion will be true and the if block above would handle it.\n\t\t * 2. A new node was created but summarize was never called on it. This can mean that the summary that is\n\t\t * generated may not have the data from this node. We should not continue, log and throw an error. This\n\t\t * will help us identify these cases and take appropriate action.\n\t\t */\n\t\tif (localPathsToUse === undefined) {\n\t\t\tthis.throwUnexpectedError({\n\t\t\t\teventName: \"NodeNotSummarized\",\n\t\t\t\tproposalHandle,\n\t\t\t});\n\t\t}\n\n\t\tconst summary = new SummaryNode({\n\t\t\t...localPathsToUse,\n\t\t\treferenceSequenceNumber: this.wipReferenceSequenceNumber,\n\t\t\tbasePath: parentPath,\n\t\t});\n\t\tconst fullPathForChildren = summary.fullPathForChildren;\n\t\tfor (const child of this.children.values()) {\n\t\t\tchild.completeSummaryCore(\n\t\t\t\tproposalHandle,\n\t\t\t\tfullPathForChildren,\n\t\t\t\tthis.wipSkipRecursion || parentSkipRecursion,\n\t\t\t);\n\t\t}\n\t\t// Note that this overwrites existing pending summary with\n\t\t// the same proposalHandle. If proposalHandle is something like\n\t\t// a hash or unique identifier, this should be fine. If storage\n\t\t// can return the same proposalHandle for a different summary,\n\t\t// this should still be okay, because we should be proposing the\n\t\t// newer one later which would have to overwrite the previous one.\n\t\tthis.pendingSummaries.set(proposalHandle, summary);\n\t\tthis.clearSummary();\n\t}\n\n\tpublic clearSummary() {\n\t\tthis.wipReferenceSequenceNumber = undefined;\n\t\tthis.wipLocalPaths = undefined;\n\t\tthis.wipSkipRecursion = false;\n\t\tthis.wipSummaryLogger = undefined;\n\t\tfor (const child of this.children.values()) {\n\t\t\tchild.clearSummary();\n\t\t}\n\t}\n\n\t/**\n\t * Refreshes the latest summary tracked by this node. If we have a pending summary for the given proposal handle,\n\t * it becomes the latest summary. If the current summary is already ahead (e.g., loaded from a service summary),\n\t * we skip the update. Otherwise, we fetch the latest snapshot and update latest summary based off of that.\n\t *\n\t * @returns A RefreshSummaryResult type which returns information based on the following three scenarios:\n\t *\n\t * 1. The latest summary was not updated.\n\t *\n\t * 2. The latest summary was updated and the summary corresponding to the params was being tracked.\n\t *\n\t * 3. The latest summary was updated but the summary corresponding to the params was not tracked. In this\n\t * case, the latest summary is updated based on the downloaded snapshot which is also returned.\n\t */\n\tpublic async refreshLatestSummary(\n\t\tproposalHandle: string | undefined,\n\t\tsummaryRefSeq: number,\n\t\tfetchLatestSnapshot: () => Promise<IFetchSnapshotResult>,\n\t\treadAndParseBlob: ReadAndParseBlob,\n\t\tcorrelatedSummaryLogger: ITelemetryLogger,\n\t): Promise<RefreshSummaryResult> {\n\t\tconst eventProps: {\n\t\t\tproposalHandle: string | undefined;\n\t\t\tsummaryRefSeq: number;\n\t\t\treferenceSequenceNumber: number;\n\t\t\tlatestSummaryUpdated?: boolean;\n\t\t\twasSummaryTracked?: boolean;\n\t\t} = {\n\t\t\tproposalHandle,\n\t\t\tsummaryRefSeq,\n\t\t\treferenceSequenceNumber: this.referenceSequenceNumber,\n\t\t};\n\t\treturn PerformanceEvent.timedExecAsync(\n\t\t\tthis.logger,\n\t\t\t{\n\t\t\t\teventName: \"refreshLatestSummary\",\n\t\t\t\t...eventProps,\n\t\t\t},\n\t\t\tasync (event) => {\n\t\t\t\t// Refresh latest summary should not happen while a summary is in progress. If it does, it can result\n\t\t\t\t// in inconsistent state, so, we should not continue;\n\t\t\t\tif (this.isSummaryInProgress()) {\n\t\t\t\t\tthrow new LoggingError(\"UnexpectedRefreshDuringSummarize\", {\n\t\t\t\t\t\tinProgressSummaryRefSeq: this.wipReferenceSequenceNumber,\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\tif (proposalHandle !== undefined) {\n\t\t\t\t\tconst maybeSummaryNode = this.pendingSummaries.get(proposalHandle);\n\n\t\t\t\t\tif (maybeSummaryNode !== undefined) {\n\t\t\t\t\t\tthis.refreshLatestSummaryFromPending(\n\t\t\t\t\t\t\tproposalHandle,\n\t\t\t\t\t\t\tmaybeSummaryNode.referenceSequenceNumber,\n\t\t\t\t\t\t);\n\t\t\t\t\t\teventProps.wasSummaryTracked = true;\n\t\t\t\t\t\teventProps.latestSummaryUpdated = true;\n\t\t\t\t\t\tevent.end(eventProps);\n\t\t\t\t\t\treturn {\n\t\t\t\t\t\t\tlatestSummaryUpdated: true,\n\t\t\t\t\t\t\twasSummaryTracked: true,\n\t\t\t\t\t\t\tsummaryRefSeq,\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\n\t\t\t\t\tconst props = {\n\t\t\t\t\t\tsummaryRefSeq,\n\t\t\t\t\t\tpendingSize: this.pendingSummaries.size ?? undefined,\n\t\t\t\t\t};\n\t\t\t\t\tthis.logger.sendTelemetryEvent({\n\t\t\t\t\t\teventName: \"PendingSummaryNotFound\",\n\t\t\t\t\t\tproposalHandle,\n\t\t\t\t\t\treferenceSequenceNumber: this.referenceSequenceNumber,\n\t\t\t\t\t\tdetails: JSON.stringify(props),\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\t// If the summary for which refresh is called is older than the latest tracked summary, ignore it.\n\t\t\t\tif (this.referenceSequenceNumber >= summaryRefSeq) {\n\t\t\t\t\teventProps.latestSummaryUpdated = false;\n\t\t\t\t\tevent.end(eventProps);\n\t\t\t\t\treturn { latestSummaryUpdated: false };\n\t\t\t\t}\n\n\t\t\t\t// Fetch the latest snapshot and refresh state from it. Note that we need to use the reference sequence number\n\t\t\t\t// of the fetched snapshot and not the \"summaryRefSeq\" that was passed in.\n\t\t\t\tconst { snapshotTree, snapshotRefSeq: fetchedSnapshotRefSeq } =\n\t\t\t\t\tawait fetchLatestSnapshot();\n\n\t\t\t\t// Possible re-entrancy. We may have updated latest summary state while fetching the snapshot. If the fetched\n\t\t\t\t// snapshot is older than the latest tracked summary, ignore it.\n\t\t\t\tif (this.referenceSequenceNumber >= fetchedSnapshotRefSeq) {\n\t\t\t\t\teventProps.latestSummaryUpdated = false;\n\t\t\t\t\tevent.end(eventProps);\n\t\t\t\t\treturn { latestSummaryUpdated: false };\n\t\t\t\t}\n\n\t\t\t\tawait this.refreshLatestSummaryFromSnapshot(\n\t\t\t\t\tfetchedSnapshotRefSeq,\n\t\t\t\t\tsnapshotTree,\n\t\t\t\t\tundefined,\n\t\t\t\t\tEscapedPath.create(\"\"),\n\t\t\t\t\tcorrelatedSummaryLogger,\n\t\t\t\t\treadAndParseBlob,\n\t\t\t\t);\n\n\t\t\t\teventProps.latestSummaryUpdated = true;\n\t\t\t\teventProps.wasSummaryTracked = false;\n\t\t\t\teventProps.summaryRefSeq = fetchedSnapshotRefSeq;\n\t\t\t\tevent.end(eventProps);\n\t\t\t\treturn {\n\t\t\t\t\tlatestSummaryUpdated: true,\n\t\t\t\t\twasSummaryTracked: false,\n\t\t\t\t\tsnapshotTree,\n\t\t\t\t\tsummaryRefSeq: fetchedSnapshotRefSeq,\n\t\t\t\t};\n\t\t\t},\n\t\t\t{ start: true, end: true, cancel: \"error\" },\n\t\t);\n\t}\n\t/**\n\t * Called when we get an ack from the server for a summary we've just sent. Updates the reference state of this node\n\t * from the state in the pending summary queue.\n\t * @param proposalHandle - Handle for the current proposal.\n\t * @param referenceSequenceNumber -  reference sequence number of sent summary.\n\t */\n\tprotected refreshLatestSummaryFromPending(\n\t\tproposalHandle: string,\n\t\treferenceSequenceNumber: number,\n\t): void {\n\t\tconst summaryNode = this.pendingSummaries.get(proposalHandle);\n\t\tif (summaryNode === undefined) {\n\t\t\t// This should only happen if parent skipped recursion AND no prior summary existed.\n\t\t\tassert(\n\t\t\t\tthis._latestSummary === undefined,\n\t\t\t\t0x1a6 /* \"Not found pending summary, but this node has previously completed a summary\" */,\n\t\t\t);\n\t\t\treturn;\n\t\t} else {\n\t\t\tassert(\n\t\t\t\treferenceSequenceNumber === summaryNode.referenceSequenceNumber,\n\t\t\t\t0x1a7 /* Pending summary reference sequence number should be consistent */,\n\t\t\t);\n\n\t\t\t// Clear earlier pending summaries\n\t\t\tthis.pendingSummaries.delete(proposalHandle);\n\t\t}\n\n\t\tthis.refreshLatestSummaryCore(referenceSequenceNumber);\n\n\t\tthis._latestSummary = summaryNode;\n\t\t// Propagate update to all child nodes\n\t\tfor (const child of this.children.values()) {\n\t\t\tchild.refreshLatestSummaryFromPending(proposalHandle, referenceSequenceNumber);\n\t\t}\n\t}\n\n\tprotected async refreshLatestSummaryFromSnapshot(\n\t\treferenceSequenceNumber: number,\n\t\tsnapshotTree: ISnapshotTree,\n\t\tbasePath: EscapedPath | undefined,\n\t\tlocalPath: EscapedPath,\n\t\tcorrelatedSummaryLogger: ITelemetryLogger,\n\t\treadAndParseBlob: ReadAndParseBlob,\n\t): Promise<void> {\n\t\t// Possible re-entrancy. If we have already seen a summary later than this one, ignore it.\n\t\tif (this.referenceSequenceNumber >= referenceSequenceNumber) {\n\t\t\treturn;\n\t\t}\n\n\t\tthis.refreshLatestSummaryCore(referenceSequenceNumber);\n\n\t\tthis._latestSummary = new SummaryNode({\n\t\t\treferenceSequenceNumber,\n\t\t\tbasePath,\n\t\t\tlocalPath,\n\t\t});\n\n\t\tconst pathParts: string[] = [];\n\t\tconst { childrenTree, childrenPathPart } = parseSummaryForSubtrees(snapshotTree);\n\t\tif (childrenPathPart !== undefined) {\n\t\t\tpathParts.push(childrenPathPart);\n\t\t}\n\n\t\tif (pathParts.length > 0) {\n\t\t\tthis._latestSummary.additionalPath = EscapedPath.createAndConcat(pathParts);\n\t\t}\n\n\t\t// Propagate update to all child nodes\n\t\tconst pathForChildren = this._latestSummary.fullPathForChildren;\n\t\tawait Promise.all(\n\t\t\tArray.from(this.children)\n\t\t\t\t.filter(([id]) => {\n\t\t\t\t\t// Assuming subtrees missing from snapshot are newer than the snapshot,\n\t\t\t\t\t// but might be nice to assert this using earliest seq for node.\n\t\t\t\t\treturn childrenTree.trees[id] !== undefined;\n\t\t\t\t})\n\t\t\t\t.map(async ([id, child]) => {\n\t\t\t\t\treturn child.refreshLatestSummaryFromSnapshot(\n\t\t\t\t\t\treferenceSequenceNumber,\n\t\t\t\t\t\tchildrenTree.trees[id],\n\t\t\t\t\t\tpathForChildren,\n\t\t\t\t\t\tEscapedPath.create(id),\n\t\t\t\t\t\tcorrelatedSummaryLogger,\n\t\t\t\t\t\treadAndParseBlob,\n\t\t\t\t\t);\n\t\t\t\t}),\n\t\t);\n\t}\n\n\tprivate refreshLatestSummaryCore(referenceSequenceNumber: number): void {\n\t\tfor (const [key, value] of this.pendingSummaries) {\n\t\t\tif (value.referenceSequenceNumber < referenceSequenceNumber) {\n\t\t\t\tthis.pendingSummaries.delete(key);\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic updateBaseSummaryState(snapshot: ISnapshotTree) {\n\t\t// Check base summary to see if it has any additional path parts\n\t\t// separating child SummarizerNodes. Checks for .channels subtrees.\n\t\tconst { childrenPathPart } = parseSummaryForSubtrees(snapshot);\n\t\tif (childrenPathPart !== undefined && this._latestSummary !== undefined) {\n\t\t\tthis._latestSummary.additionalPath = EscapedPath.create(childrenPathPart);\n\t\t}\n\t}\n\n\tpublic recordChange(op: ISequencedDocumentMessage): void {\n\t\tthis.invalidate(op.sequenceNumber);\n\t}\n\n\tpublic invalidate(sequenceNumber: number): void {\n\t\tif (sequenceNumber > this._changeSequenceNumber) {\n\t\t\tthis._changeSequenceNumber = sequenceNumber;\n\t\t}\n\t}\n\n\t/**\n\t * True if a change has been recorded with sequence number exceeding\n\t * the latest successfully acked summary reference sequence number.\n\t * False implies that the previous summary can be reused.\n\t */\n\tprotected hasChanged(): boolean {\n\t\treturn this._changeSequenceNumber > this.referenceSequenceNumber;\n\t}\n\n\tpublic get latestSummary(): Readonly<SummaryNode> | undefined {\n\t\treturn this._latestSummary;\n\t}\n\n\tprotected readonly canReuseHandle: boolean;\n\n\tpublic createChild(\n\t\t/** Summarize function */\n\t\tsummarizeInternalFn: SummarizeInternalFn,\n\t\t/** Initial id or path part of this node */\n\t\tid: string,\n\t\t/**\n\t\t * Information needed to create the node.\n\t\t * If it is from a base summary, it will assert that a summary has been seen.\n\t\t * Attach information if it is created from an attach op.\n\t\t */\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t\tconfig: ISummarizerNodeConfig = {},\n\t): ISummarizerNode {\n\t\tassert(!this.children.has(id), 0x1ab /* \"Create SummarizerNode child already exists\" */);\n\n\t\tconst createDetails: ICreateChildDetails = this.getCreateDetailsForChild(id, createParam);\n\t\tconst child = new SummarizerNode(\n\t\t\tthis.logger,\n\t\t\tsummarizeInternalFn,\n\t\t\tconfig,\n\t\t\tcreateDetails.changeSequenceNumber,\n\t\t\tcreateDetails.latestSummary,\n\t\t\tcreateDetails.initialSummary,\n\t\t\tthis.wipSummaryLogger,\n\t\t\tcreateDetails.telemetryNodeId,\n\t\t);\n\n\t\t// There may be additional state that has to be updated in this child. For example, if a summary is being\n\t\t// tracked, the child's summary tracking state needs to be updated too. Same goes for pendingSummaries we might\n\t\t// have outstanding on the parent in case we realize nodes in between Summary Op and Summary Ack.\n\t\tthis.maybeUpdateChildState(child, id);\n\n\t\tthis.children.set(id, child);\n\t\treturn child;\n\t}\n\n\tpublic getChild(id: string): ISummarizerNode | undefined {\n\t\treturn this.children.get(id);\n\t}\n\n\t/**\n\t * Returns the details needed to create a child node.\n\t * @param id - Initial id or path part of the child node.\n\t * @param createParam - Information needed to create the node.\n\t * @returns the details needed to create the child node.\n\t */\n\tprotected getCreateDetailsForChild(\n\t\tid: string,\n\t\tcreateParam: CreateChildSummarizerNodeParam,\n\t): ICreateChildDetails {\n\t\tlet initialSummary: IInitialSummary | undefined;\n\t\tlet latestSummary: SummaryNode | undefined;\n\t\tlet changeSequenceNumber: number;\n\n\t\tconst parentLatestSummary = this._latestSummary;\n\t\tswitch (createParam.type) {\n\t\t\tcase CreateSummarizerNodeSource.FromAttach: {\n\t\t\t\tif (\n\t\t\t\t\tparentLatestSummary !== undefined &&\n\t\t\t\t\tcreateParam.sequenceNumber <= parentLatestSummary.referenceSequenceNumber\n\t\t\t\t) {\n\t\t\t\t\t// Prioritize latest summary if it was after this node was attached.\n\t\t\t\t\tlatestSummary = parentLatestSummary.createForChild(id);\n\t\t\t\t} else {\n\t\t\t\t\tconst summary = convertToSummaryTree(\n\t\t\t\t\t\tcreateParam.snapshot,\n\t\t\t\t\t) as ISummaryTreeWithStats;\n\t\t\t\t\tinitialSummary = {\n\t\t\t\t\t\tsequenceNumber: createParam.sequenceNumber,\n\t\t\t\t\t\tid,\n\t\t\t\t\t\tsummary,\n\t\t\t\t\t};\n\t\t\t\t}\n\t\t\t\tchangeSequenceNumber = createParam.sequenceNumber;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase CreateSummarizerNodeSource.FromSummary: {\n\t\t\t\tif (this.initialSummary === undefined) {\n\t\t\t\t\tassert(\n\t\t\t\t\t\t!!parentLatestSummary,\n\t\t\t\t\t\t0x1ac /* \"Cannot create child from summary if parent does not have latest summary\" */,\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\t// fallthrough to local\n\t\t\t}\n\t\t\tcase CreateSummarizerNodeSource.Local: {\n\t\t\t\tconst parentInitialSummary = this.initialSummary;\n\t\t\t\tif (parentInitialSummary !== undefined) {\n\t\t\t\t\tlet childSummary: SummaryObject | undefined;\n\t\t\t\t\tif (parentInitialSummary.summary !== undefined) {\n\t\t\t\t\t\tconst { childrenTree } = parseSummaryTreeForSubtrees(\n\t\t\t\t\t\t\tparentInitialSummary.summary.summary,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tchildrenTree.type === SummaryType.Tree,\n\t\t\t\t\t\t\t0x1d6 /* \"Parent summary object is not a tree\" */,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tchildSummary = childrenTree.tree[id];\n\t\t\t\t\t}\n\t\t\t\t\tif (createParam.type === CreateSummarizerNodeSource.FromSummary) {\n\t\t\t\t\t\t// Locally created would not have differential subtree.\n\t\t\t\t\t\tassert(!!childSummary, 0x1ad /* \"Missing child summary tree\" */);\n\t\t\t\t\t}\n\t\t\t\t\tlet childSummaryWithStats: ISummaryTreeWithStats | undefined;\n\t\t\t\t\tif (childSummary !== undefined) {\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tchildSummary.type === SummaryType.Tree,\n\t\t\t\t\t\t\t0x1ae /* \"Child summary object is not a tree\" */,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tchildSummaryWithStats = {\n\t\t\t\t\t\t\tsummary: childSummary,\n\t\t\t\t\t\t\tstats: calculateStats(childSummary),\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\t\t\t\t\tinitialSummary = {\n\t\t\t\t\t\tsequenceNumber: parentInitialSummary.sequenceNumber,\n\t\t\t\t\t\tid,\n\t\t\t\t\t\tsummary: childSummaryWithStats,\n\t\t\t\t\t};\n\t\t\t\t}\n\t\t\t\tlatestSummary = parentLatestSummary?.createForChild(id);\n\t\t\t\tchangeSequenceNumber = parentLatestSummary?.referenceSequenceNumber ?? -1;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tconst type = (createParam as unknown as CreateChildSummarizerNodeParam).type;\n\t\t\t\tunreachableCase(createParam, `Unexpected CreateSummarizerNodeSource: ${type}`);\n\t\t\t}\n\t\t}\n\n\t\tconst childtelemetryNodeId = `${this.telemetryNodeId ?? \"\"}/${id}`;\n\n\t\treturn {\n\t\t\tinitialSummary,\n\t\t\tlatestSummary,\n\t\t\tchangeSequenceNumber,\n\t\t\ttelemetryNodeId: childtelemetryNodeId,\n\t\t};\n\t}\n\n\t/**\n\t * Updates the state of the child if required. For example, if a summary is currently being  tracked, the child's\n\t * summary tracking state needs to be updated too.\n\t * Also, in case a child node gets realized in between Summary Op and Summary Ack, let's initialize the child's\n\t * pending summary as well.\n\t * @param child - The child node whose state is to be updated.\n\t * @param id - Initial id or path part of this node\n\t *\n\t */\n\tprotected maybeUpdateChildState(child: SummarizerNode, id: string) {\n\t\t// If a summary is in progress, this child was created after the summary started. So, we need to update the\n\t\t// child's summary state as well.\n\t\tif (this.isSummaryInProgress()) {\n\t\t\tchild.wipReferenceSequenceNumber = this.wipReferenceSequenceNumber;\n\t\t}\n\t\t// In case we have pending summaries on the parent, let's initialize it on the child.\n\t\tif (child._latestSummary !== undefined) {\n\t\t\tfor (const [key, value] of this.pendingSummaries.entries()) {\n\t\t\t\tconst newLatestSummaryNode = new SummaryNode({\n\t\t\t\t\treferenceSequenceNumber: value.referenceSequenceNumber,\n\t\t\t\t\tbasePath: child._latestSummary.basePath,\n\t\t\t\t\tlocalPath: child._latestSummary.localPath,\n\t\t\t\t});\n\n\t\t\t\tchild.addPendingSummary(key, newLatestSummaryNode);\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected addPendingSummary(key: string, summary: SummaryNode) {\n\t\tthis.pendingSummaries.set(key, summary);\n\t}\n\n\t/**\n\t * Tells whether summary tracking is in progress. True if \"startSummary\" API is called before summarize.\n\t */\n\tpublic isSummaryInProgress(): boolean {\n\t\treturn this.wipReferenceSequenceNumber !== undefined;\n\t}\n\n\t/**\n\t * Creates and throws an error due to unexpected conditions.\n\t */\n\tprotected throwUnexpectedError(eventProps: ITelemetryErrorEvent): never {\n\t\tconst error = new LoggingError(eventProps.eventName, {\n\t\t\t...eventProps,\n\t\t\treferenceSequenceNumber: this.wipReferenceSequenceNumber,\n\t\t\tid: {\n\t\t\t\ttag: TelemetryDataTag.CodeArtifact,\n\t\t\t\tvalue: this.telemetryNodeId,\n\t\t\t},\n\t\t});\n\t\tthis.logger.sendErrorEvent(eventProps, error);\n\t\tthrow error;\n\t}\n}\n\n/**\n * Creates a root summarizer node.\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 */\nexport const createRootSummarizerNode = (\n\tlogger: ITelemetryLogger,\n\tsummarizeInternalFn: SummarizeInternalFn,\n\tchangeSequenceNumber: number,\n\treferenceSequenceNumber: number | undefined,\n\tconfig: ISummarizerNodeConfig = {},\n): IRootSummarizerNode =>\n\tnew SummarizerNode(\n\t\tlogger,\n\t\tsummarizeInternalFn,\n\t\tconfig,\n\t\tchangeSequenceNumber,\n\t\treferenceSequenceNumber === undefined\n\t\t\t? undefined\n\t\t\t: SummaryNode.createForRoot(referenceSequenceNumber),\n\t\tundefined /* initialSummary */,\n\t\tundefined /* wipSummaryLogger */,\n\t\t\"\" /* telemetryNodeId */,\n\t);\n"]}