@fluidframework/container-runtime 1.2.1 → 2.0.0-internal.1.0.0

package/dist/summarizerTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizerTypes.js","sourceRoot":"","sources":["../src/summarizerTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAqBH;;GAEG;AACU,QAAA,WAAW,GAA6B,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IEvent,\n    IEventProvider,\n    ITelemetryLogger,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { ITelemetryLoggerPropertyBag } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { ContainerWarning, IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    ISequencedDocumentMessage,\n    ISummaryTree,\n    IDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { ISummaryStats } from \"@fluidframework/runtime-definitions\";\nimport { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from \"./summaryCollection\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const ISummarizer: keyof IProvideSummarizer = \"ISummarizer\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideSummarizer {\n    /**\n     * @deprecated - This will be removed in a later release.\n     */\n    readonly ISummarizer: ISummarizer;\n}\n\n/**\n * Similar to AbortSignal, but using promise instead of events\n * @param T - cancellation reason type\n */\nexport interface ICancellationToken<T> {\n    /** Tells if this cancellable token is cancelled */\n    readonly cancelled: boolean;\n    /**\n     * Promise that gets fulfilled when this cancellable token is cancelled\n     * @returns reason of cancellation\n     */\n    readonly waitCancelled: Promise<T>;\n}\n\n/* Similar to AbortSignal, but using promise instead of events */\nexport type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;\n\nexport interface ISummarizerInternalsProvider {\n    /** Encapsulates the work to walk the internals of the running container to generate a summary */\n    submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;\n\n    /** Callback whenever a new SummaryAck is received, to update internal tracking state */\n    refreshLatestSummaryAck(\n        proposalHandle: string,\n        ackHandle: string,\n        summaryRefSeq: number,\n        summaryLogger: ITelemetryLogger,\n    ): Promise<void>;\n}\n\n/**\n * @deprecated Options that control the behavior of a running summarizer.\n * */\nexport interface ISummarizerOptions {\n    /**\n     * Set to true to disable the default heuristics from running; false by default.\n     * This affects only the heuristics around when a summarizer should\n     * submit summaries. So when it is disabled, summarizer clients should\n     * not be expected to summarize unless an on-demand summary is requested.\n     */\n    disableHeuristics: boolean;\n}\n\nexport interface ISummarizingWarning extends ContainerWarning {\n    readonly errorType: \"summarizingError\";\n    readonly logged: boolean;\n}\n\nexport interface IConnectableRuntime {\n    readonly disposed: boolean;\n    readonly connected: boolean;\n    readonly clientId: string | undefined;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    once(event: \"connected\" | \"disconnected\" | \"dispose\", listener: () => void): this;\n}\n\nexport interface ISummarizerRuntime extends IConnectableRuntime {\n    readonly logger: ITelemetryLogger;\n    /** clientId of parent (non-summarizing) container that owns summarizer container */\n    readonly summarizerClientId: string | undefined;\n    closeFn(): void;\n    on(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void): this;\n    removeListener(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void): this;\n}\n\n/** Options affecting summarize behavior. */\nexport interface ISummarizeOptions {\n    /** True to generate the full tree with no handle reuse optimizations; defaults to false */\n    readonly fullTree?: boolean;\n    /** True to ask the server what the latest summary is first; defaults to false */\n    readonly refreshLatestAck?: boolean;\n}\n\nexport interface ISubmitSummaryOptions extends ISummarizeOptions {\n    /** Logger to use for correlated summary events */\n    readonly summaryLogger: ITelemetryLogger;\n    /** Tells when summary process should be cancelled */\n    readonly cancellationToken: ISummaryCancellationToken;\n}\n\nexport interface IOnDemandSummarizeOptions extends ISummarizeOptions {\n    /** Reason for generating summary. */\n    readonly reason: string;\n}\n\n/** Options to use when enqueueing a summarize attempt. */\nexport interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {\n    /** If specified, The summarize attempt will not occur until after this sequence number. */\n    readonly afterSequenceNumber?: number;\n    /**\n     * True to override the existing enqueued summarize attempt if there is one.\n     * This will guarantee that this attempt gets enqueued. If override is false,\n     * than an existing enqueued summarize attempt will block a new one from being\n     * enqueued. There can only be one enqueued at a time. Defaults to false.\n     */\n    readonly override?: boolean;\n}\n\n/**\n * In addition to the normal summary tree + stats, this contains additional stats\n * only relevant at the root of the tree.\n */\nexport interface IGeneratedSummaryStats extends ISummaryStats {\n    /** The total number of data stores in the container. */\n    readonly dataStoreCount: number;\n    /** The number of data stores that were summarized in this summary. */\n    readonly summarizedDataStoreCount: number;\n    /** The number of data stores whose GC reference state was updated in this summary. */\n    readonly gcStateUpdatedDataStoreCount?: number;\n    /** The size of the gc blobs in this summary. */\n    readonly gcTotalBlobsSize?: number;\n    /** The number of gc blobs in this summary. */\n    readonly gcBlobNodeCount?: number;\n    /** Sum of the sizes of all op contents since the last summary */\n    readonly opsSizesSinceLastSummary: number;\n    /** Number of non-system ops since the last summary. See {@link @fluidframework/protocol-base#isSystemMessage} */\n    readonly nonSystemOpsSinceLastSummary: number;\n    /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */\n    readonly summaryNumber: number;\n}\n\n/** Base results for all submitSummary attempts. */\nexport interface IBaseSummarizeResult {\n    readonly stage: \"base\";\n    /** Error object related to failed summarize attempt. */\n    readonly error: any;\n    /** Reference sequence number as of the generate summary attempt. */\n    readonly referenceSequenceNumber: number;\n    readonly minimumSequenceNumber: number;\n}\n\n/** Results of submitSummary after generating the summary tree. */\nexport interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, \"stage\"> {\n    readonly stage: \"generate\";\n    /** Generated summary tree. */\n    readonly summaryTree: ISummaryTree;\n    /** Stats for generated summary tree. */\n    readonly summaryStats: IGeneratedSummaryStats;\n    /** Time it took to generate the summary tree and stats. */\n    readonly generateDuration: number;\n    /** True if the full tree regeneration with no handle reuse optimizations was forced. */\n    readonly forcedFullTree: boolean;\n}\n\n/** Results of submitSummary after uploading the tree to storage. */\nexport interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, \"stage\"> {\n    readonly stage: \"upload\";\n    /** The handle returned by storage pointing to the uploaded summary tree. */\n    readonly handle: string;\n    /** Time it took to upload the summary tree to storage. */\n    readonly uploadDuration: number;\n}\n\n/** Results of submitSummary after submitting the summarize op. */\nexport interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, \"stage\" | \"error\"> {\n    readonly stage: \"submit\";\n    /** The client sequence number of the summarize op submitted for the summary. */\n    readonly clientSequenceNumber: number;\n    /** Time it took to submit the summarize op to the broadcasting service. */\n    readonly submitOpDuration: number;\n}\n\n/**\n * Strict type representing result of a submitSummary attempt.\n * The result consists of 4 possible stages, each with its own data.\n * The data is cumulative, so each stage will contain the data from the previous stages.\n * If the final \"submitted\" stage is not reached, the result may contain the error object.\n * Stages:\n *  1. \"base\" - stopped before the summary tree was even generated, and the result only contains the base data\n *  2. \"generate\" - the summary tree was generated, and the result will contain that tree + stats\n *  3. \"upload\" - the summary was uploaded to storage, and the result contains the server-provided handle\n *  4. \"submit\" - the summarize op was submitted, and the result contains the op client sequence number.\n */\nexport type SubmitSummaryResult =\n    | IBaseSummarizeResult\n    | IGenerateSummaryTreeResult\n    | IUploadSummaryResult\n    | ISubmitSummaryOpResult;\n\nexport interface IBroadcastSummaryResult {\n    readonly summarizeOp: ISummaryOpMessage;\n    readonly broadcastDuration: number;\n}\n\nexport interface IAckSummaryResult {\n    readonly summaryAckOp: ISummaryAckMessage;\n    readonly ackNackDuration: number;\n}\n\nexport interface INackSummaryResult {\n    readonly summaryNackOp: ISummaryNackMessage;\n    readonly ackNackDuration: number;\n}\n\nexport type SummarizeResultPart<TSuccess, TFailure = undefined> = {\n    success: true;\n    data: TSuccess;\n} | {\n    success: false;\n    data: TFailure | undefined;\n    message: string;\n    error: any;\n    retryAfterSeconds?: number;\n};\n\nexport interface ISummarizeResults {\n    /** Resolves when we generate, upload, and submit the summary. */\n    readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult>>;\n    /** Resolves when we observe our summarize op broadcast. */\n    readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;\n    /** Resolves when we receive a summaryAck or summaryNack. */\n    readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;\n}\n\nexport type EnqueueSummarizeResult = (ISummarizeResults & {\n    /**\n     * Indicates that another summarize attempt is not already enqueued,\n     * and this attempt has been enqueued.\n     */\n    readonly alreadyEnqueued?: undefined;\n}) | (ISummarizeResults & {\n    /** Indicates that another summarize attempt was already enqueued. */\n    readonly alreadyEnqueued: true;\n    /**\n     * Indicates that the other enqueued summarize attempt was abandoned,\n     * and this attempt has been enqueued enqueued.\n     */\n    readonly overridden: true;\n}) | {\n    /** Indicates that another summarize attempt was already enqueued. */\n    readonly alreadyEnqueued: true;\n    /**\n     * Indicates that the other enqueued summarize attempt remains enqueued,\n     * and this attempt has not been enqueued.\n     */\n    readonly overridden?: undefined;\n};\n\nexport type SummarizerStopReason =\n    /** Summarizer client failed to summarize in all 3 consecutive attempts. */\n    | \"failToSummarize\"\n    /** Parent client reported that it is no longer connected. */\n    | \"parentNotConnected\"\n    /**\n     * Parent client reported that it is no longer elected the summarizer.\n     * This is the normal flow; a disconnect will always trigger the parent\n     * client to no longer be elected as responsible for summaries. Then it\n     * tries to stop its spawned summarizer client.\n     */\n    | \"parentShouldNotSummarize\"\n    /** Summarizer client was disconnected */\n    | \"summarizerClientDisconnected\"\n    /* running summarizer threw an exception */\n    | \"summarizerException\";\n\nexport interface ISummarizerEvents extends IEvent {\n    /**\n     * An event indicating that the Summarizer is having problems summarizing\n     */\n    (event: \"summarizingError\", listener: (error: ISummarizingWarning) => void);\n}\n\nexport interface ISummarizer extends\n    IEventProvider<ISummarizerEvents>, IFluidLoadable, Partial<IProvideSummarizer> {\n    /*\n     * Asks summarizer to move to exit.\n     * Summarizer will finish current processes, which may take a while.\n     * For example, summarizer may complete last summary before exiting.\n     */\n    stop(reason: SummarizerStopReason): void;\n\n    /* Closes summarizer. Any pending processes (summary in flight) are abandoned. */\n    close(): void;\n\n    run(onBehalfOf: string, disableHeuristics?: boolean): Promise<SummarizerStopReason>;\n\n    /**\n     * Attempts to generate a summary on demand. If already running, takes no action.\n     * @param options - options controlling the summarize attempt\n     * @returns an alreadyRunning promise if a summarize attempt is already in progress,\n     * which will resolve when the current attempt completes. At that point caller can\n     * decide to try again or not. Otherwise, it will return an object containing promises\n     * that resolve as the summarize attempt progresses. They will resolve with success\n     * false if a failure is encountered.\n     */\n    summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;\n    /**\n     * Enqueue an attempt to summarize after the specified sequence number.\n     * If afterSequenceNumber is provided, the summarize attempt is \"enqueued\"\n     * to run once an eligible op comes in with sequenceNumber \\>= afterSequenceNumber.\n     * @param options - options controlling the summarize attempt\n     * @returns an object containing an alreadyEnqueued flag to indicate if another\n     * summarize attempt has already been enqueued. It also may contain an overridden flag\n     * when alreadyEnqueued is true, that indicates whether this attempt forced the\n     * previous attempt to abort. If this attempt becomes enqueued, it returns an object\n     * containing promises that resolve as the summarize attempt progresses. They will\n     * resolve with success false if a failure is encountered.\n     */\n    enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;\n}\n\n/** Data about an attempt to summarize used for heuristics. */\nexport interface ISummarizeAttempt {\n    /** Reference sequence number when summary was generated or attempted */\n    readonly refSequenceNumber: number;\n\n    /** Time of summary attempt after it was sent or attempted */\n    readonly summaryTime: number;\n\n    /** Sequence number of summary op */\n    summarySequenceNumber?: number;\n}\n\n/** Data relevant for summary heuristics. */\nexport interface ISummarizeHeuristicData {\n    /** Latest received op sequence number */\n    lastOpSequenceNumber: number;\n\n    /** Most recent summary attempt from this client */\n    readonly lastAttempt: ISummarizeAttempt;\n\n    /** Most recent summary that received an ack */\n    readonly lastSuccessfulSummary: Readonly<ISummarizeAttempt>;\n\n    /**\n     * Updates lastAttempt and lastSuccessfulAttempt based on the last summary.\n     * @param lastSummary - last ack summary\n     */\n    updateWithLastSummaryAckInfo(lastSummary: ISummarizeAttempt): void;\n\n    /**\n     * Records a summary attempt. If the attempt was successfully sent,\n     * provide the reference sequence number, otherwise it will be set\n     * to the last seen op sequence number.\n     * @param referenceSequenceNumber - reference sequence number of sent summary\n     */\n    recordAttempt(referenceSequenceNumber?: number): void;\n\n    /** Mark that the last sent summary attempt has received an ack */\n    markLastAttemptAsSuccessful(): void;\n}\n\n/** Responsible for running heuristics determining when to summarize. */\nexport interface ISummarizeHeuristicRunner {\n    /** Runs the heuristic to determine if it should try to summarize */\n    run(): void;\n\n    /** Runs a different heuristic to check if it should summarize before closing */\n    shouldRunLastSummary(): boolean;\n\n    /** Disposes of resources */\n    dispose(): void;\n}\n\ntype ISummarizeTelemetryRequiredProperties =\n    /** Reason code for attempting to summarize */\n    \"reason\";\n\ntype ISummarizeTelemetryOptionalProperties =\n    /** Number of attempts within the last time window, used for calculating the throttle delay. */\n    \"summaryAttempts\" |\n    /** Number of attempts within the current phase (currently capped at 2 ) */\n    \"summaryAttemptsPerPhase\" |\n    /** One-based count of phases we've attempted (used to index into an array of ISummarizeOptions */\n    \"summaryAttemptPhase\" |\n    keyof ISummarizeOptions;\n\nexport type ISummarizeTelemetryProperties =\n    Pick<ITelemetryProperties, ISummarizeTelemetryRequiredProperties> &\n    Partial<Pick<ITelemetryProperties, ISummarizeTelemetryOptionalProperties>>;\n\ntype SummaryGeneratorRequiredTelemetryProperties =\n    /** True to generate the full tree with no handle reuse optimizations */\n    \"fullTree\" |\n    /** Time since we last attempted to generate a summary */\n    \"timeSinceLastAttempt\" |\n    /** Time since we last successfully generated a summary */\n    \"timeSinceLastSummary\";\n\ntype SummaryGeneratorOptionalTelemetryProperties =\n    /** Reference sequence number as of the generate summary attempt. */\n    \"referenceSequenceNumber\" |\n    /** minimum sequence number (at the reference sequence number) */\n    \"minimumSequenceNumber\" |\n    /** Delta between the current reference sequence number and the reference sequence number of the last attempt */\n    \"opsSinceLastAttempt\" |\n    /** Delta between the current reference sequence number and the reference sequence number of the last summary */\n    \"opsSinceLastSummary\" |\n    /** Delta in sum of op sizes between the current reference sequence number and the reference\n     *  sequence number of the last summary */\n    \"opsSizesSinceLastSummary\" |\n    /**\n     * Delta between the number of non-system ops since the last summary.\n     * See {@link @fluidframework/protocol-base#isSystemMessage}\n     */\n    \"nonSystemOpsSinceLastSummary\" |\n    /** Time it took to generate the summary tree and stats. */\n    \"generateDuration\" |\n    /** The handle returned by storage pointing to the uploaded summary tree. */\n    \"handle\" |\n    /** Time it took to upload the summary tree to storage. */\n    \"uploadDuration\" |\n    /** The client sequence number of the summarize op submitted for the summary. */\n    \"clientSequenceNumber\" |\n    /** Time it took for this summary to be acked after it was generated */\n    \"ackWaitDuration\" |\n    /** Reference sequence number of the ack/nack message */\n    \"ackNackSequenceNumber\" |\n    /** Actual sequence number of the summary op proposal. */\n    \"summarySequenceNumber\" |\n    /** Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying. */\n    \"nackRetryAfter\";\n\nexport type SummaryGeneratorTelemetry =\n    Pick<ITelemetryProperties, SummaryGeneratorRequiredTelemetryProperties> &\n    Partial<Pick<ITelemetryProperties, SummaryGeneratorOptionalTelemetryProperties>>;\n\nexport interface ISummarizeRunnerTelemetry extends ITelemetryLoggerPropertyBag {\n    /** Number of times the summarizer run. */\n    summarizeCount: () => number;\n    /** Number of successful attempts to summarize. */\n    summarizerSuccessfulAttempts: () => number;\n}\n"]}
+{"version":3,"file":"summarizerTypes.js","sourceRoot":"","sources":["../src/summarizerTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAuBH;;GAEG;AACU,QAAA,WAAW,GAA6B,aAAa,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    IEvent,\n    IEventProvider,\n    ITelemetryLogger,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { ITelemetryLoggerPropertyBag } from \"@fluidframework/telemetry-utils\";\nimport {\n    IFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { ContainerWarning, IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    ISequencedDocumentMessage,\n    ISummaryTree,\n    IDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { ISummaryStats } from \"@fluidframework/runtime-definitions\";\nimport { ISummaryAckMessage, ISummaryNackMessage, ISummaryOpMessage } from \"./summaryCollection\";\nimport { SummarizeReason } from \"./summaryGenerator\";\nimport { ISummaryConfigurationHeuristics } from \".\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport const ISummarizer: keyof IProvideSummarizer = \"ISummarizer\";\n\n/**\n * @deprecated - This will be removed in a later release.\n */\nexport interface IProvideSummarizer {\n    /**\n     * @deprecated - This will be removed in a later release.\n     */\n    readonly ISummarizer: ISummarizer;\n}\n\n/**\n * Similar to AbortSignal, but using promise instead of events\n * @param T - cancellation reason type\n */\nexport interface ICancellationToken<T> {\n    /** Tells if this cancellable token is cancelled */\n    readonly cancelled: boolean;\n    /**\n     * Promise that gets fulfilled when this cancellable token is cancelled\n     * @returns reason of cancellation\n     */\n    readonly waitCancelled: Promise<T>;\n}\n\n/* Similar to AbortSignal, but using promise instead of events */\nexport type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;\n\nexport interface ISummarizerInternalsProvider {\n    /** Encapsulates the work to walk the internals of the running container to generate a summary */\n    submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;\n\n    /** Callback whenever a new SummaryAck is received, to update internal tracking state */\n    refreshLatestSummaryAck(\n        proposalHandle: string,\n        ackHandle: string,\n        summaryRefSeq: number,\n        summaryLogger: ITelemetryLogger,\n    ): Promise<void>;\n}\n\n/**\n * @deprecated Options that control the behavior of a running summarizer.\n * */\nexport interface ISummarizerOptions {\n    /**\n     * Set to true to disable the default heuristics from running; false by default.\n     * This affects only the heuristics around when a summarizer should\n     * submit summaries. So when it is disabled, summarizer clients should\n     * not be expected to summarize unless an on-demand summary is requested.\n     */\n    disableHeuristics: boolean;\n}\n\nexport interface ISummarizingWarning extends ContainerWarning {\n    readonly errorType: \"summarizingError\";\n    readonly logged: boolean;\n}\n\nexport interface IConnectableRuntime {\n    readonly disposed: boolean;\n    readonly connected: boolean;\n    readonly clientId: string | undefined;\n    readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>;\n    once(event: \"connected\" | \"disconnected\" | \"dispose\", listener: () => void): this;\n}\n\nexport interface ISummarizerRuntime extends IConnectableRuntime {\n    readonly logger: ITelemetryLogger;\n    /** clientId of parent (non-summarizing) container that owns summarizer container */\n    readonly summarizerClientId: string | undefined;\n    closeFn(): void;\n    /** @deprecated 1.0, please remove all implementations and usage */\n    on(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void): this;\n    /** @deprecated 1.0, please remove all implementations and usage */\n    removeListener(event: \"batchEnd\", listener: (error: any, op: ISequencedDocumentMessage) => void): this;\n}\n\n/** Options affecting summarize behavior. */\nexport interface ISummarizeOptions {\n    /** True to generate the full tree with no handle reuse optimizations; defaults to false */\n    readonly fullTree?: boolean;\n    /** True to ask the server what the latest summary is first; defaults to false */\n    readonly refreshLatestAck?: boolean;\n}\n\nexport interface ISubmitSummaryOptions extends ISummarizeOptions {\n    /** Logger to use for correlated summary events */\n    readonly summaryLogger: ITelemetryLogger;\n    /** Tells when summary process should be cancelled */\n    readonly cancellationToken: ISummaryCancellationToken;\n}\n\nexport interface IOnDemandSummarizeOptions extends ISummarizeOptions {\n    /** Reason for generating summary. */\n    readonly reason: string;\n}\n\n/** Options to use when enqueueing a summarize attempt. */\nexport interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {\n    /** If specified, The summarize attempt will not occur until after this sequence number. */\n    readonly afterSequenceNumber?: number;\n    /**\n     * True to override the existing enqueued summarize attempt if there is one.\n     * This will guarantee that this attempt gets enqueued. If override is false,\n     * than an existing enqueued summarize attempt will block a new one from being\n     * enqueued. There can only be one enqueued at a time. Defaults to false.\n     */\n    readonly override?: boolean;\n}\n\n/**\n * In addition to the normal summary tree + stats, this contains additional stats\n * only relevant at the root of the tree.\n */\nexport interface IGeneratedSummaryStats extends ISummaryStats {\n    /** The total number of data stores in the container. */\n    readonly dataStoreCount: number;\n    /** The number of data stores that were summarized in this summary. */\n    readonly summarizedDataStoreCount: number;\n    /** The number of data stores whose GC reference state was updated in this summary. */\n    readonly gcStateUpdatedDataStoreCount?: number;\n    /** The size of the gc blobs in this summary. */\n    readonly gcTotalBlobsSize?: number;\n    /** The number of gc blobs in this summary. */\n    readonly gcBlobNodeCount?: number;\n    /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */\n    readonly summaryNumber: number;\n}\n\n/** Base results for all submitSummary attempts. */\nexport interface IBaseSummarizeResult {\n    readonly stage: \"base\";\n    /** Error object related to failed summarize attempt. */\n    readonly error: any;\n    /** Reference sequence number as of the generate summary attempt. */\n    readonly referenceSequenceNumber: number;\n    readonly minimumSequenceNumber: number;\n}\n\n/** Results of submitSummary after generating the summary tree. */\nexport interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, \"stage\"> {\n    readonly stage: \"generate\";\n    /** Generated summary tree. */\n    readonly summaryTree: ISummaryTree;\n    /** Stats for generated summary tree. */\n    readonly summaryStats: IGeneratedSummaryStats;\n    /** Time it took to generate the summary tree and stats. */\n    readonly generateDuration: number;\n    /** True if the full tree regeneration with no handle reuse optimizations was forced. */\n    readonly forcedFullTree: boolean;\n}\n\n/** Results of submitSummary after uploading the tree to storage. */\nexport interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, \"stage\"> {\n    readonly stage: \"upload\";\n    /** The handle returned by storage pointing to the uploaded summary tree. */\n    readonly handle: string;\n    /** Time it took to upload the summary tree to storage. */\n    readonly uploadDuration: number;\n}\n\n/** Results of submitSummary after submitting the summarize op. */\nexport interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, \"stage\" | \"error\"> {\n    readonly stage: \"submit\";\n    /** The client sequence number of the summarize op submitted for the summary. */\n    readonly clientSequenceNumber: number;\n    /** Time it took to submit the summarize op to the broadcasting service. */\n    readonly submitOpDuration: number;\n}\n\n/**\n * Strict type representing result of a submitSummary attempt.\n * The result consists of 4 possible stages, each with its own data.\n * The data is cumulative, so each stage will contain the data from the previous stages.\n * If the final \"submitted\" stage is not reached, the result may contain the error object.\n * Stages:\n *  1. \"base\" - stopped before the summary tree was even generated, and the result only contains the base data\n *  2. \"generate\" - the summary tree was generated, and the result will contain that tree + stats\n *  3. \"upload\" - the summary was uploaded to storage, and the result contains the server-provided handle\n *  4. \"submit\" - the summarize op was submitted, and the result contains the op client sequence number.\n */\nexport type SubmitSummaryResult =\n    | IBaseSummarizeResult\n    | IGenerateSummaryTreeResult\n    | IUploadSummaryResult\n    | ISubmitSummaryOpResult;\n\nexport interface IBroadcastSummaryResult {\n    readonly summarizeOp: ISummaryOpMessage;\n    readonly broadcastDuration: number;\n}\n\nexport interface IAckSummaryResult {\n    readonly summaryAckOp: ISummaryAckMessage;\n    readonly ackNackDuration: number;\n}\n\nexport interface INackSummaryResult {\n    readonly summaryNackOp: ISummaryNackMessage;\n    readonly ackNackDuration: number;\n}\n\nexport type SummarizeResultPart<TSuccess, TFailure = undefined> = {\n    success: true;\n    data: TSuccess;\n} | {\n    success: false;\n    data: TFailure | undefined;\n    message: string;\n    error: any;\n    retryAfterSeconds?: number;\n};\n\nexport interface ISummarizeResults {\n    /** Resolves when we generate, upload, and submit the summary. */\n    readonly summarySubmitted: Promise<SummarizeResultPart<SubmitSummaryResult>>;\n    /** Resolves when we observe our summarize op broadcast. */\n    readonly summaryOpBroadcasted: Promise<SummarizeResultPart<IBroadcastSummaryResult>>;\n    /** Resolves when we receive a summaryAck or summaryNack. */\n    readonly receivedSummaryAckOrNack: Promise<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>;\n}\n\nexport type EnqueueSummarizeResult = (ISummarizeResults & {\n    /**\n     * Indicates that another summarize attempt is not already enqueued,\n     * and this attempt has been enqueued.\n     */\n    readonly alreadyEnqueued?: undefined;\n}) | (ISummarizeResults & {\n    /** Indicates that another summarize attempt was already enqueued. */\n    readonly alreadyEnqueued: true;\n    /**\n     * Indicates that the other enqueued summarize attempt was abandoned,\n     * and this attempt has been enqueued enqueued.\n     */\n    readonly overridden: true;\n}) | {\n    /** Indicates that another summarize attempt was already enqueued. */\n    readonly alreadyEnqueued: true;\n    /**\n     * Indicates that the other enqueued summarize attempt remains enqueued,\n     * and this attempt has not been enqueued.\n     */\n    readonly overridden?: undefined;\n};\n\nexport type SummarizerStopReason =\n    /** Summarizer client failed to summarize in all 3 consecutive attempts. */\n    | \"failToSummarize\"\n    /** Parent client reported that it is no longer connected. */\n    | \"parentNotConnected\"\n    /**\n     * Parent client reported that it is no longer elected the summarizer.\n     * This is the normal flow; a disconnect will always trigger the parent\n     * client to no longer be elected as responsible for summaries. Then it\n     * tries to stop its spawned summarizer client.\n     */\n    | \"parentShouldNotSummarize\"\n    /** Summarizer client was disconnected */\n    | \"summarizerClientDisconnected\"\n    /* running summarizer threw an exception */\n    | \"summarizerException\";\n\nexport interface ISummarizerEvents extends IEvent {\n    /**\n     * An event indicating that the Summarizer is having problems summarizing\n     */\n    (event: \"summarizingError\", listener: (error: ISummarizingWarning) => void);\n}\n\nexport interface ISummarizer extends\n    IEventProvider<ISummarizerEvents>, IFluidLoadable, Partial<IProvideSummarizer> {\n    /*\n     * Asks summarizer to move to exit.\n     * Summarizer will finish current processes, which may take a while.\n     * For example, summarizer may complete last summary before exiting.\n     */\n    stop(reason: SummarizerStopReason): void;\n\n    /* Closes summarizer. Any pending processes (summary in flight) are abandoned. */\n    close(): void;\n\n    run(onBehalfOf: string, disableHeuristics?: boolean): Promise<SummarizerStopReason>;\n\n    /**\n     * Attempts to generate a summary on demand. If already running, takes no action.\n     * @param options - options controlling the summarize attempt\n     * @returns an alreadyRunning promise if a summarize attempt is already in progress,\n     * which will resolve when the current attempt completes. At that point caller can\n     * decide to try again or not. Otherwise, it will return an object containing promises\n     * that resolve as the summarize attempt progresses. They will resolve with success\n     * false if a failure is encountered.\n     */\n    summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;\n    /**\n     * Enqueue an attempt to summarize after the specified sequence number.\n     * If afterSequenceNumber is provided, the summarize attempt is \"enqueued\"\n     * to run once an eligible op comes in with sequenceNumber \\>= afterSequenceNumber.\n     * @param options - options controlling the summarize attempt\n     * @returns an object containing an alreadyEnqueued flag to indicate if another\n     * summarize attempt has already been enqueued. It also may contain an overridden flag\n     * when alreadyEnqueued is true, that indicates whether this attempt forced the\n     * previous attempt to abort. If this attempt becomes enqueued, it returns an object\n     * containing promises that resolve as the summarize attempt progresses. They will\n     * resolve with success false if a failure is encountered.\n     */\n    enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;\n}\n\n/** Data about an attempt to summarize used for heuristics. */\nexport interface ISummarizeAttempt {\n    /** Reference sequence number when summary was generated or attempted */\n    readonly refSequenceNumber: number;\n\n    /** Time of summary attempt after it was sent or attempted */\n    readonly summaryTime: number;\n\n    /** Sequence number of summary op */\n    summarySequenceNumber?: number;\n}\n\n/** Data relevant for summary heuristics. */\nexport interface ISummarizeHeuristicData {\n    /** Latest received op sequence number */\n    lastOpSequenceNumber: number;\n\n    /** Most recent summary attempt from this client */\n    readonly lastAttempt: ISummarizeAttempt;\n\n    /** Most recent summary that received an ack */\n    readonly lastSuccessfulSummary: Readonly<ISummarizeAttempt>;\n\n    /** Number of runtime ops since last summary */\n    numRuntimeOps: number;\n\n    /** Number of non-runtime ops since last summary */\n    numNonRuntimeOps: number;\n\n    /** Cumulative size in bytes of all the ops since the last summary */\n    totalOpsSize: number;\n\n    /** Wether or not this instance contains adjusted metrics due to missing op data */\n    hasMissingOpData: boolean;\n\n    /**\n     * Updates lastAttempt and lastSuccessfulAttempt based on the last summary.\n     * @param lastSummary - last ack summary\n     */\n    updateWithLastSummaryAckInfo(lastSummary: ISummarizeAttempt): void;\n\n    /**\n     * Records a summary attempt. If the attempt was successfully sent,\n     * provide the reference sequence number, otherwise it will be set\n     * to the last seen op sequence number.\n     * @param referenceSequenceNumber - reference sequence number of sent summary\n     */\n    recordAttempt(referenceSequenceNumber?: number): void;\n\n    /** Mark that the last sent summary attempt has received an ack */\n    markLastAttemptAsSuccessful(): void;\n}\n\n/** Responsible for running heuristics determining when to summarize. */\nexport interface ISummarizeHeuristicRunner {\n    /** Start specific heuristic trackers (ex: idle timer) */\n    start(): void;\n\n    /** Runs the heuristics to determine if it should try to summarize */\n    run(): void;\n\n    /** Runs a different heuristic to check if it should summarize before closing */\n    shouldRunLastSummary(): boolean;\n\n    /** Disposes of resources */\n    dispose(): void;\n}\n\ntype ISummarizeTelemetryRequiredProperties =\n    /** Reason code for attempting to summarize */\n    \"reason\";\n\ntype ISummarizeTelemetryOptionalProperties =\n    /** Number of attempts within the last time window, used for calculating the throttle delay. */\n    \"summaryAttempts\" |\n    /** Number of attempts within the current phase (currently capped at 2 ) */\n    \"summaryAttemptsPerPhase\" |\n    /** One-based count of phases we've attempted (used to index into an array of ISummarizeOptions */\n    \"summaryAttemptPhase\" |\n    keyof ISummarizeOptions;\n\nexport type ISummarizeTelemetryProperties =\n    Pick<ITelemetryProperties, ISummarizeTelemetryRequiredProperties> &\n    Partial<Pick<ITelemetryProperties, ISummarizeTelemetryOptionalProperties>>;\n\n/** Strategy used to heuristically determine when we should run a summary */\nexport interface ISummaryHeuristicStrategy {\n    /** Summarize reason for this summarize heuristic strategy (ex: \"maxTime\") */\n    summarizeReason: Readonly<SummarizeReason>;\n\n    /**\n     * Determines if this strategy's summarize criteria been met\n     * @param configuration - summary configuration we are to check against\n     * @param heuristicData - heuristic data used to confirm conditions are met\n     */\n    shouldRunSummary(configuration: ISummaryConfigurationHeuristics, heuristicData: ISummarizeHeuristicData): boolean;\n}\n\ntype SummaryGeneratorRequiredTelemetryProperties =\n    /** True to generate the full tree with no handle reuse optimizations */\n    \"fullTree\" |\n    /** Time since we last attempted to generate a summary */\n    \"timeSinceLastAttempt\" |\n    /** Time since we last successfully generated a summary */\n    \"timeSinceLastSummary\";\n\ntype SummaryGeneratorOptionalTelemetryProperties =\n    /** Reference sequence number as of the generate summary attempt. */\n    \"referenceSequenceNumber\" |\n    /** minimum sequence number (at the reference sequence number) */\n    \"minimumSequenceNumber\" |\n    /** Delta between the current reference sequence number and the reference sequence number of the last attempt */\n    \"opsSinceLastAttempt\" |\n    /** Delta between the current reference sequence number and the reference sequence number of the last summary */\n    \"opsSinceLastSummary\" |\n    /** Delta in sum of op sizes between the current reference sequence number and the reference\n     *  sequence number of the last summary */\n    \"opsSizesSinceLastSummary\" |\n    /** Delta between the number of non-runtime ops since the last summary */\n    \"nonRuntimeOpsSinceLastSummary\" |\n    /** Wether or not this instance contains adjusted metrics due to missing op data */\n    \"hasMissingOpData\" |\n    /** Time it took to generate the summary tree and stats. */\n    \"generateDuration\" |\n    /** The handle returned by storage pointing to the uploaded summary tree. */\n    \"handle\" |\n    /** Time it took to upload the summary tree to storage. */\n    \"uploadDuration\" |\n    /** The client sequence number of the summarize op submitted for the summary. */\n    \"clientSequenceNumber\" |\n    /** Time it took for this summary to be acked after it was generated */\n    \"ackWaitDuration\" |\n    /** Reference sequence number of the ack/nack message */\n    \"ackNackSequenceNumber\" |\n    /** Actual sequence number of the summary op proposal. */\n    \"summarySequenceNumber\" |\n    /** Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying. */\n    \"nackRetryAfter\";\n\nexport type SummaryGeneratorTelemetry =\n    Pick<ITelemetryProperties, SummaryGeneratorRequiredTelemetryProperties> &\n    Partial<Pick<ITelemetryProperties, SummaryGeneratorOptionalTelemetryProperties>>;\n\nexport interface ISummarizeRunnerTelemetry extends ITelemetryLoggerPropertyBag {\n    /** Number of times the summarizer run. */\n    summarizeCount: () => number;\n    /** Number of successful attempts to summarize. */\n    summarizerSuccessfulAttempts: () => number;\n}\n"]}

package/dist/summaryCollection.js

@@ -259,7 +259,7 @@ class SummaryCollection extends common_utils_1.TypedEventEmitter {
                 // Potential causes for it to be later than our initialSequenceNumber
                 // are that the summaryOp was nacked then acked, double-acked, or
                 // the summarySequenceNumber is incorrect.
-                this.logger.sendErrorEvent({
+                this.logger.sendTelemetryEvent({
                     eventName: "SummaryAckWithoutOp",
                     sequenceNumber: op.sequenceNumber,
                     summarySequenceNumber: seq,

package/dist/summaryCollection.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryCollection.js","sourceRoot":"","sources":["../src/summaryCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAmF;AAEnF,+EAO8C;AA6C9C,IAAK,YAKJ;AALD,WAAK,YAAY;IACb,iDAAS,CAAA;IACT,yDAAa,CAAA;IACb,iDAAS,CAAA;IACT,oDAAW,CAAA;AACf,CAAC,EALI,YAAY,KAAZ,YAAY,QAKhB;AAED,MAAM,OAAO;IAqBT,YACoB,QAAgB,EAChB,oBAA4B;QAD5B,aAAQ,GAAR,QAAQ,CAAQ;QAChB,yBAAoB,GAApB,oBAAoB,CAAQ;QAbxC,UAAK,GAAG,YAAY,CAAC,KAAK,CAAC;QAKlB,iBAAY,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QACpC,kBAAa,GAAG,IAAI,uBAAQ,EAAQ,CAAC;IAOF,CAAC;IAtB9C,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,oBAA4B;QACpE,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IACvD,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,EAAqB;QAC5C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC;QAClE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACtB,OAAO,OAAO,CAAC;IACnB,CAAC;IAUD,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAMrD,YAAY;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK,CAAC;IAC7C,CAAC;IAEM,SAAS,CAAC,EAAqB;QAClC,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAChH,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,OAAO,CAAC,EAA4C;QACvD,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,SAAS,EACxC,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC5E,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;QAChC,oEAAoE;QACpE,OAAO,IAAI,CAAC,UAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,WAAW;QACpB,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;QACjC,oEAAoE;QACpE,OAAO,IAAI,CAAC,eAAgB,CAAC;IACjC,CAAC;CACJ;AAUD;;;GAGG;AACH,MAAM,oBAAoB;IAOtB,YACoB,QAAgB,EACf,iBAAoC;QADrC,aAAQ,GAAR,QAAQ,CAAQ;QACf,sBAAiB,GAAjB,iBAAiB,CAAmB;QARzD,oBAAoB;QACH,mBAAc,GAAG,IAAI,GAAG,EAAmB,CAAC;QACrD,cAAS,GAAG,KAAK,CAAC;IAOtB,CAAC;IALL,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOhD;;;OAGG;IACI,YAAY,CAAC,oBAA4B;QAC5C,IAAI,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;YACnE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;SAClE;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,qEAAqE;IAC9D,WAAW;QACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,oBAA4B;QAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAAgB;QAC9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;CACJ;AAQD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,gCAA6C;IA+BhF,YACqB,YAAwE,EACxE,MAAwB;QAEzC,KAAK,EAAE,CAAC;QAHS,iBAAY,GAAZ,YAAY,CAA4D;QACxE,WAAM,GAAN,MAAM,CAAkB;QAhC7C,gBAAgB;QACC,oBAAe,GAAG,IAAI,GAAG,EAAgC,CAAC;QAC3E,qBAAqB;QACJ,qBAAgB,GAAG,IAAI,GAAG,EAAmB,CAAC;QACvD,uBAAkB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QA+B9C,IAAI,CAAC,YAAY,CAAC,EAAE,CAChB,IAAI,EACJ,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACnC,CAAC;IA3BD,IAAW,SAAS,KAAgC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEnE,IAAI,CAAC,KAAwB,EAAE,GAAG,IAAuC;QAC5E,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,eAAe;;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB;YACvC,CAAC,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,UAAU,CAAC,cAAc,mCAAI,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;IAC7F,CAAC;IAEM,aAAa,CAAC,QAAoB;QACrC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,gBAAgB,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAYD;;;;OAIG;IACI,aAAa,CAAC,QAAgB;QACjC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC;IACnB,CAAC;IAEM,aAAa,CAAC,QAAgB;QACjC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEM,iCAAiC,CAAC,cAAsB,EAAE,eAA2B;QACxF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,8BAA8B,GAAG,eAAe,CAAC;IAC1D,CAAC;IAEM,mCAAmC;QACtC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW;QACpB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,EAAE;YACnC,qEAAqE;YACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3F,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,uBAA+B;QACvD,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,uBAAuB,GAAG,uBAAuB,EAAE;YAC9F,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,QAAQ,CAAC,EAA6B;;QAC1C,QAAQ,EAAE,CAAC,IAAI,EAAE;YACb,KAAK,kCAAW,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,CAAC,eAAe,CAAC,EAAuB,CAAC,CAAC;gBAC9C,OAAO;aACV;YACD,KAAK,kCAAW,CAAC,UAAU,CAAC,CAAC;gBACzB,IAAI,CAAC,gBAAgB,CAAC,EAAwB,CAAC,CAAC;gBAChD,OAAO;aACV;YACD,KAAK,kCAAW,CAAC,WAAW,CAAC,CAAC;gBAC1B,IAAI,CAAC,iBAAiB,CAAC,EAAyB,CAAC,CAAC;gBAClD,OAAO;aACV;YACD,OAAO,CAAC,CAAC;gBACL,wFAAwF;gBACxF,kFAAkF;gBAClF,4DAA4D;gBAC5D,MAAM,eAAe,GAAG,EAAE,CAAC,SAAS,CAAC;gBACrC,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS;oBACvC,IAAI,CAAC,cAAc,KAAK,SAAS;oBACjC,eAAe,GAAG,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,cAAc,EACpE;oBACE,MAAA,IAAI,CAAC,8BAA8B,+CAAnC,IAAI,CAAmC,CAAC;iBAC3C;gBACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBAEzB,OAAO;aACV;SACJ;IACL,CAAC;IAEO,eAAe,CAAC,EAAqB;QACzC,IAAI,OAA4B,CAAC;QAEjC,0DAA0D;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACtD,IAAI,OAAO,EAAE;YACT,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;YACzD,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aACzB;SACJ;QAED,iCAAiC;QACjC,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;aAC/B;SACJ;QACD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,gBAAgB,CAAC,EAAsB;QAC3C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE;YAC7C,+DAA+D;YAC/D,8DAA8D;YAC9D,iEAAiE;YACjE,+DAA+D;YAC/D,4DAA4D;YAC5D,gEAAgE;YAChE,0BAA0B;YAC1B,IAAI,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE;gBAChD,qEAAqE;gBACrE,iEAAiE;gBACjE,0CAA0C;gBAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;oBACvB,SAAS,EAAE,qBAAqB;oBAChC,cAAc,EAAE,EAAE,CAAC,cAAc;oBACjC,qBAAqB,EAAE,GAAG;oBAC1B,qBAAqB,EAAE,IAAI,CAAC,YAAY,CAAC,qBAAqB;iBACjE,CAAC,CAAC;aACN;YACD,OAAO;SACV;QACD,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAElC,mBAAmB;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE;YAC/F,IAAI,CAAC,OAAO,GAAG;gBACX,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,UAAU,EAAE,EAAE;aACjB,CAAC;YACF,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;SACzC;IACL,CAAC;IAEO,iBAAiB,CAAC,EAAuB;QAC7C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,OAAO,EAAE;YACT,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;SAC1C;IACL,CAAC;CACJ;AAxMD,8CAwMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEvent, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { Deferred, assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISummaryAck,\n    ISummaryContent,\n    ISummaryNack,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Interface for summary op messages with typed contents.\n */\nexport interface ISummaryOpMessage extends ISequencedDocumentMessage {\n    type: MessageType.Summarize;\n    contents: ISummaryContent;\n}\n\n/**\n * Interface for summary ack messages with typed contents.\n */\nexport interface ISummaryAckMessage extends ISequencedDocumentMessage {\n    type: MessageType.SummaryAck;\n    contents: ISummaryAck;\n}\n\n/**\n * Interface for summary nack messages with typed contents.\n */\nexport interface ISummaryNackMessage extends ISequencedDocumentMessage {\n    type: MessageType.SummaryNack;\n    contents: ISummaryNack;\n}\n\n/**\n * A single summary which can be tracked as it goes through its life cycle.\n * The life cycle is: Local to Broadcast to Acked/Nacked.\n */\nexport interface ISummary {\n    readonly clientId: string;\n    readonly clientSequenceNumber: number;\n    waitBroadcast(): Promise<ISummaryOpMessage>;\n    waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;\n}\n\n/**\n * A single summary which has already been acked by the server.\n */\nexport interface IAckedSummary {\n    readonly summaryOp: ISummaryOpMessage;\n    readonly summaryAck: ISummaryAckMessage;\n}\n\nenum SummaryState {\n    Local = 0,\n    Broadcast = 1,\n    Acked = 2,\n    Nacked = -1,\n}\n\nclass Summary implements ISummary {\n    public static createLocal(clientId: string, clientSequenceNumber: number) {\n        return new Summary(clientId, clientSequenceNumber);\n    }\n    public static createFromOp(op: ISummaryOpMessage) {\n        const summary = new Summary(op.clientId, op.clientSequenceNumber);\n        summary.broadcast(op);\n        return summary;\n    }\n\n    private state = SummaryState.Local;\n\n    private _summaryOp?: ISummaryOpMessage;\n    private _summaryAckNack?: ISummaryAckMessage | ISummaryNackMessage;\n\n    private readonly defSummaryOp = new Deferred<void>();\n    private readonly defSummaryAck = new Deferred<void>();\n\n    public get summaryOp() { return this._summaryOp; }\n    public get summaryAckNack() { return this._summaryAckNack; }\n\n    private constructor(\n        public readonly clientId: string,\n        public readonly clientSequenceNumber: number) { }\n\n    public hasBeenAcked(): this is IAckedSummary {\n        return this.state === SummaryState.Acked;\n    }\n\n    public broadcast(op: ISummaryOpMessage) {\n        assert(this.state === SummaryState.Local, 0x175 /* \"Can only broadcast if summarizer starts in local state\" */);\n        this._summaryOp = op;\n        this.defSummaryOp.resolve();\n        this.state = SummaryState.Broadcast;\n        return true;\n    }\n\n    public ackNack(op: ISummaryAckMessage | ISummaryNackMessage) {\n        assert(this.state === SummaryState.Broadcast,\n            0x176 /* \"Can only ack/nack if summarizer is in broadcasting state\" */);\n        this._summaryAckNack = op;\n        this.defSummaryAck.resolve();\n        this.state = op.type === MessageType.SummaryAck ? SummaryState.Acked : SummaryState.Nacked;\n        return true;\n    }\n\n    public async waitBroadcast(): Promise<ISummaryOpMessage> {\n        await this.defSummaryOp.promise;\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        return this._summaryOp!;\n    }\n\n    public async waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage> {\n        await this.defSummaryAck.promise;\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        return this._summaryAckNack!;\n    }\n}\n\n/**\n * Watches summaries created by a specific client.\n */\nexport interface IClientSummaryWatcher extends IDisposable {\n    watchSummary(clientSequenceNumber: number): ISummary;\n    waitFlushed(): Promise<IAckedSummary | undefined>;\n}\n\n/**\n * This class watches summaries created by a specific client.\n * It should be created and managed from a SummaryCollection.\n */\nclass ClientSummaryWatcher implements IClientSummaryWatcher {\n    // key: clientSeqNum\n    private readonly localSummaries = new Map<number, Summary>();\n    private _disposed = false;\n\n    public get disposed() { return this._disposed; }\n\n    public constructor(\n        public readonly clientId: string,\n        private readonly summaryCollection: SummaryCollection,\n    ) { }\n\n    /**\n     * Watches for a specific sent summary op.\n     * @param clientSequenceNumber - client sequence number of sent summary op\n     */\n    public watchSummary(clientSequenceNumber: number): ISummary {\n        let summary = this.localSummaries.get(clientSequenceNumber);\n        if (!summary) {\n            summary = Summary.createLocal(this.clientId, clientSequenceNumber);\n            this.localSummaries.set(summary.clientSequenceNumber, summary);\n        }\n        return summary;\n    }\n\n    /**\n     * Waits until all of the pending summaries in the underlying SummaryCollection\n     * are acked/nacked.\n     */\n    // eslint-disable-next-line @typescript-eslint/promise-function-async\n    public waitFlushed() {\n        return this.summaryCollection.waitFlushed();\n    }\n\n    /**\n     * Gets a watched summary or returns undefined if not watched.\n     * @param clientSequenceNumber - client sequence number of sent summary op\n     */\n    public tryGetSummary(clientSequenceNumber: number) {\n        return this.localSummaries.get(clientSequenceNumber);\n    }\n\n    /**\n     * Starts watching a summary made by this client.\n     * @param summary - summary to start watching\n     */\n    public setSummary(summary: Summary) {\n        this.localSummaries.set(summary.clientSequenceNumber, summary);\n    }\n\n    public dispose() {\n        this.summaryCollection.removeWatcher(this.clientId);\n        this._disposed = true;\n    }\n}\n\nexport type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | \"default\";\nexport type OpActionEventListener = (op: ISequencedDocumentMessage) => void;\nexport interface ISummaryCollectionOpEvents extends IEvent {\n    (event: OpActionEventName, listener: OpActionEventListener);\n}\n\n/**\n * Data structure that looks at the op stream to track summaries as they\n * are broadcast, acked and nacked.\n * It provides functionality for watching specific summaries.\n */\nexport class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {\n    // key: clientId\n    private readonly summaryWatchers = new Map<string, ClientSummaryWatcher>();\n    // key: summarySeqNum\n    private readonly pendingSummaries = new Map<number, Summary>();\n    private refreshWaitNextAck = new Deferred<void>();\n\n    private lastSummaryTimestamp: number | undefined;\n    private maxAckWaitTime: number | undefined;\n    private pendingAckTimerTimeoutCallback: (() => void) | undefined;\n    private lastAck: IAckedSummary | undefined;\n\n    public get latestAck(): IAckedSummary | undefined { return this.lastAck; }\n\n    public emit(event: OpActionEventName, ...args: Parameters<OpActionEventListener>): boolean {\n        return super.emit(event, ...args);\n    }\n\n    public get opsSinceLastAck() {\n        return this.deltaManager.lastSequenceNumber -\n            (this.lastAck?.summaryAck.sequenceNumber ?? this.deltaManager.initialSequenceNumber);\n    }\n\n    public addOpListener(listener: () => void) {\n        this.deltaManager.on(\"op\", listener);\n    }\n\n    public removeOpListener(listener: () => void) {\n        this.deltaManager.off(\"op\", listener);\n    }\n\n    public constructor(\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        super();\n        this.deltaManager.on(\n            \"op\",\n            (op) => this.handleOp(op));\n    }\n\n    /**\n     * Creates and returns a summary watcher for a specific client.\n     * This will allow for local sent summaries to be better tracked.\n     * @param clientId - client id for watcher\n     */\n    public createWatcher(clientId: string): IClientSummaryWatcher {\n        const watcher = new ClientSummaryWatcher(clientId, this);\n        this.summaryWatchers.set(clientId, watcher);\n        return watcher;\n    }\n\n    public removeWatcher(clientId: string) {\n        this.summaryWatchers.delete(clientId);\n    }\n\n    public setPendingAckTimerTimeoutCallback(maxAckWaitTime: number, timeoutCallback: () => void) {\n        this.maxAckWaitTime = maxAckWaitTime;\n        this.pendingAckTimerTimeoutCallback = timeoutCallback;\n    }\n\n    public unsetPendingAckTimerTimeoutCallback() {\n        this.maxAckWaitTime = undefined;\n        this.pendingAckTimerTimeoutCallback = undefined;\n    }\n\n    /**\n     * Returns a promise that resolves once all pending summary ops\n     * have been acked or nacked.\n     */\n    public async waitFlushed(): Promise<IAckedSummary | undefined> {\n        while (this.pendingSummaries.size > 0) {\n            // eslint-disable-next-line @typescript-eslint/promise-function-async\n            const promises = Array.from(this.pendingSummaries, ([, summary]) => summary.waitAckNack());\n            await Promise.all(promises);\n        }\n        return this.lastAck;\n    }\n\n    /**\n     * Returns a promise that resolves once a summary is acked that has a reference\n     * sequence number greater than or equal to the passed in sequence number.\n     * @param referenceSequenceNumber - reference sequence number to wait for\n     * @returns The latest acked summary\n     */\n    public async waitSummaryAck(referenceSequenceNumber: number): Promise<IAckedSummary> {\n        while (!this.lastAck || this.lastAck.summaryOp.referenceSequenceNumber < referenceSequenceNumber) {\n            await this.refreshWaitNextAck.promise;\n        }\n        return this.lastAck;\n    }\n\n    /**\n     * Handler for ops; only handles ops relating to summaries.\n     * @param op - op message to handle\n     */\n    private handleOp(op: ISequencedDocumentMessage) {\n        switch (op.type) {\n            case MessageType.Summarize: {\n                this.handleSummaryOp(op as ISummaryOpMessage);\n                return;\n            }\n            case MessageType.SummaryAck: {\n                this.handleSummaryAck(op as ISummaryAckMessage);\n                return;\n            }\n            case MessageType.SummaryNack: {\n                this.handleSummaryNack(op as ISummaryNackMessage);\n                return;\n            }\n            default: {\n                // If the difference between timestamp of current op and last summary op is greater than\n                // the maxAckWaitTime, then we need to inform summarizer to not wait and summarize\n                // immediately as we have already waited for maxAckWaitTime.\n                const lastOpTimestamp = op.timestamp;\n                if (this.lastSummaryTimestamp !== undefined &&\n                    this.maxAckWaitTime !== undefined &&\n                    lastOpTimestamp - this.lastSummaryTimestamp >= this.maxAckWaitTime\n                ) {\n                    this.pendingAckTimerTimeoutCallback?.();\n                }\n                this.emit(\"default\", op);\n\n                return;\n            }\n        }\n    }\n\n    private handleSummaryOp(op: ISummaryOpMessage) {\n        let summary: Summary | undefined;\n\n        // Check if summary already being watched, broadcast if so\n        const watcher = this.summaryWatchers.get(op.clientId);\n        if (watcher) {\n            summary = watcher.tryGetSummary(op.clientSequenceNumber);\n            if (summary) {\n                summary.broadcast(op);\n            }\n        }\n\n        // If not watched, create from op\n        if (!summary) {\n            summary = Summary.createFromOp(op);\n            if (watcher) {\n                watcher.setSummary(summary);\n            }\n        }\n        this.pendingSummaries.set(op.sequenceNumber, summary);\n        this.lastSummaryTimestamp = op.timestamp;\n        this.emit(MessageType.Summarize, op);\n    }\n\n    private handleSummaryAck(op: ISummaryAckMessage) {\n        const seq = op.contents.summaryProposal.summarySequenceNumber;\n        const summary = this.pendingSummaries.get(seq);\n        if (!summary || summary.summaryOp === undefined) {\n            // Summary ack without an op should be rare. We could fetch the\n            // reference sequence number from the snapshot, but instead we\n            // will not emit this ack. It should be the case that the summary\n            // op that this ack is for is earlier than this file was loaded\n            // from. i.e. initialSequenceNumber > summarySequenceNumber.\n            // We really don't care about it for now, since it is older than\n            // the one we loaded from.\n            if (seq >= this.deltaManager.initialSequenceNumber) {\n                // Potential causes for it to be later than our initialSequenceNumber\n                // are that the summaryOp was nacked then acked, double-acked, or\n                // the summarySequenceNumber is incorrect.\n                this.logger.sendErrorEvent({\n                    eventName: \"SummaryAckWithoutOp\",\n                    sequenceNumber: op.sequenceNumber, // summary ack seq #\n                    summarySequenceNumber: seq, // missing summary seq #\n                    initialSequenceNumber: this.deltaManager.initialSequenceNumber,\n                });\n            }\n            return;\n        }\n        summary.ackNack(op);\n        this.pendingSummaries.delete(seq);\n\n        // Track latest ack\n        if (!this.lastAck || seq > this.lastAck.summaryAck.contents.summaryProposal.summarySequenceNumber) {\n            this.lastAck = {\n                summaryOp: summary.summaryOp,\n                summaryAck: op,\n            };\n            this.refreshWaitNextAck.resolve();\n            this.refreshWaitNextAck = new Deferred<void>();\n            this.emit(MessageType.SummaryAck, op);\n        }\n    }\n\n    private handleSummaryNack(op: ISummaryNackMessage) {\n        const seq = op.contents.summaryProposal.summarySequenceNumber;\n        const summary = this.pendingSummaries.get(seq);\n        if (summary) {\n            summary.ackNack(op);\n            this.pendingSummaries.delete(seq);\n            this.emit(MessageType.SummaryNack, op);\n        }\n    }\n}\n"]}
+{"version":3,"file":"summaryCollection.js","sourceRoot":"","sources":["../src/summaryCollection.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAAmF;AAEnF,+EAO8C;AA6C9C,IAAK,YAKJ;AALD,WAAK,YAAY;IACb,iDAAS,CAAA;IACT,yDAAa,CAAA;IACb,iDAAS,CAAA;IACT,oDAAW,CAAA;AACf,CAAC,EALI,YAAY,KAAZ,YAAY,QAKhB;AAED,MAAM,OAAO;IAqBT,YACoB,QAAgB,EAChB,oBAA4B;QAD5B,aAAQ,GAAR,QAAQ,CAAQ;QAChB,yBAAoB,GAApB,oBAAoB,CAAQ;QAbxC,UAAK,GAAG,YAAY,CAAC,KAAK,CAAC;QAKlB,iBAAY,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QACpC,kBAAa,GAAG,IAAI,uBAAQ,EAAQ,CAAC;IAOF,CAAC;IAtB9C,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,oBAA4B;QACpE,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;IACvD,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,EAAqB;QAC5C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC;QAClE,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACtB,OAAO,OAAO,CAAC;IACnB,CAAC;IAUD,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAClD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAMrD,YAAY;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK,CAAC;IAC7C,CAAC;IAEM,SAAS,CAAC,EAAqB;QAClC,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,8DAA8D,CAAC,CAAC;QAChH,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,OAAO,CAAC,EAA4C;QACvD,IAAA,qBAAM,EAAC,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC,SAAS,EACxC,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAC5E,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC;QAC3F,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,aAAa;QACtB,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;QAChC,oEAAoE;QACpE,OAAO,IAAI,CAAC,UAAW,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,WAAW;QACpB,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;QACjC,oEAAoE;QACpE,OAAO,IAAI,CAAC,eAAgB,CAAC;IACjC,CAAC;CACJ;AAUD;;;GAGG;AACH,MAAM,oBAAoB;IAOtB,YACoB,QAAgB,EACf,iBAAoC;QADrC,aAAQ,GAAR,QAAQ,CAAQ;QACf,sBAAiB,GAAjB,iBAAiB,CAAmB;QARzD,oBAAoB;QACH,mBAAc,GAAG,IAAI,GAAG,EAAmB,CAAC;QACrD,cAAS,GAAG,KAAK,CAAC;IAOtB,CAAC;IALL,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOhD;;;OAGG;IACI,YAAY,CAAC,oBAA4B;QAC5C,IAAI,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;YACnE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;SAClE;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,qEAAqE;IAC9D,WAAW;QACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,oBAA4B;QAC7C,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,UAAU,CAAC,OAAgB;QAC9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;CACJ;AAQD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,gCAA6C;IA+BhF,YACqB,YAAwE,EACxE,MAAwB;QAEzC,KAAK,EAAE,CAAC;QAHS,iBAAY,GAAZ,YAAY,CAA4D;QACxE,WAAM,GAAN,MAAM,CAAkB;QAhC7C,gBAAgB;QACC,oBAAe,GAAG,IAAI,GAAG,EAAgC,CAAC;QAC3E,qBAAqB;QACJ,qBAAgB,GAAG,IAAI,GAAG,EAAmB,CAAC;QACvD,uBAAkB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QA+B9C,IAAI,CAAC,YAAY,CAAC,EAAE,CAChB,IAAI,EACJ,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACnC,CAAC;IA3BD,IAAW,SAAS,KAAgC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEnE,IAAI,CAAC,KAAwB,EAAE,GAAG,IAAuC;QAC5E,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,eAAe;;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB;YACvC,CAAC,MAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,UAAU,CAAC,cAAc,mCAAI,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;IAC7F,CAAC;IAEM,aAAa,CAAC,QAAoB;QACrC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,gBAAgB,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAYD;;;;OAIG;IACI,aAAa,CAAC,QAAgB;QACjC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC;IACnB,CAAC;IAEM,aAAa,CAAC,QAAgB;QACjC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAEM,iCAAiC,CAAC,cAAsB,EAAE,eAA2B;QACxF,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,8BAA8B,GAAG,eAAe,CAAC;IAC1D,CAAC;IAEM,mCAAmC;QACtC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW;QACpB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,EAAE;YACnC,qEAAqE;YACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3F,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,uBAA+B;QACvD,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,uBAAuB,GAAG,uBAAuB,EAAE;YAC9F,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,QAAQ,CAAC,EAA6B;;QAC1C,QAAQ,EAAE,CAAC,IAAI,EAAE;YACb,KAAK,kCAAW,CAAC,SAAS,CAAC,CAAC;gBACxB,IAAI,CAAC,eAAe,CAAC,EAAuB,CAAC,CAAC;gBAC9C,OAAO;aACV;YACD,KAAK,kCAAW,CAAC,UAAU,CAAC,CAAC;gBACzB,IAAI,CAAC,gBAAgB,CAAC,EAAwB,CAAC,CAAC;gBAChD,OAAO;aACV;YACD,KAAK,kCAAW,CAAC,WAAW,CAAC,CAAC;gBAC1B,IAAI,CAAC,iBAAiB,CAAC,EAAyB,CAAC,CAAC;gBAClD,OAAO;aACV;YACD,OAAO,CAAC,CAAC;gBACL,wFAAwF;gBACxF,kFAAkF;gBAClF,4DAA4D;gBAC5D,MAAM,eAAe,GAAG,EAAE,CAAC,SAAS,CAAC;gBACrC,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS;oBACvC,IAAI,CAAC,cAAc,KAAK,SAAS;oBACjC,eAAe,GAAG,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,cAAc,EACpE;oBACE,MAAA,IAAI,CAAC,8BAA8B,+CAAnC,IAAI,CAAmC,CAAC;iBAC3C;gBACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBAEzB,OAAO;aACV;SACJ;IACL,CAAC;IAEO,eAAe,CAAC,EAAqB;QACzC,IAAI,OAA4B,CAAC;QAEjC,0DAA0D;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACtD,IAAI,OAAO,EAAE;YACT,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;YACzD,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aACzB;SACJ;QAED,iCAAiC;QACjC,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YACnC,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;aAC/B;SACJ;QACD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,gBAAgB,CAAC,EAAsB;QAC3C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,EAAE;YAC7C,+DAA+D;YAC/D,8DAA8D;YAC9D,iEAAiE;YACjE,+DAA+D;YAC/D,4DAA4D;YAC5D,gEAAgE;YAChE,0BAA0B;YAC1B,IAAI,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,qBAAqB,EAAE;gBAChD,qEAAqE;gBACrE,iEAAiE;gBACjE,0CAA0C;gBAC1C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,EAAE,qBAAqB;oBAChC,cAAc,EAAE,EAAE,CAAC,cAAc;oBACjC,qBAAqB,EAAE,GAAG;oBAC1B,qBAAqB,EAAE,IAAI,CAAC,YAAY,CAAC,qBAAqB;iBACjE,CAAC,CAAC;aACN;YACD,OAAO;SACV;QACD,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAElC,mBAAmB;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE;YAC/F,IAAI,CAAC,OAAO,GAAG;gBACX,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,UAAU,EAAE,EAAE;aACjB,CAAC;YACF,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,CAAC,kBAAkB,GAAG,IAAI,uBAAQ,EAAQ,CAAC;YAC/C,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;SACzC;IACL,CAAC;IAEO,iBAAiB,CAAC,EAAuB;QAC7C,MAAM,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,OAAO,EAAE;YACT,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACpB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,kCAAW,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;SAC1C;IACL,CAAC;CACJ;AAxMD,8CAwMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, IEvent, ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { Deferred, assert, TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport {\n    IDocumentMessage,\n    ISequencedDocumentMessage,\n    ISummaryAck,\n    ISummaryContent,\n    ISummaryNack,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\n\n/**\n * Interface for summary op messages with typed contents.\n */\nexport interface ISummaryOpMessage extends ISequencedDocumentMessage {\n    type: MessageType.Summarize;\n    contents: ISummaryContent;\n}\n\n/**\n * Interface for summary ack messages with typed contents.\n */\nexport interface ISummaryAckMessage extends ISequencedDocumentMessage {\n    type: MessageType.SummaryAck;\n    contents: ISummaryAck;\n}\n\n/**\n * Interface for summary nack messages with typed contents.\n */\nexport interface ISummaryNackMessage extends ISequencedDocumentMessage {\n    type: MessageType.SummaryNack;\n    contents: ISummaryNack;\n}\n\n/**\n * A single summary which can be tracked as it goes through its life cycle.\n * The life cycle is: Local to Broadcast to Acked/Nacked.\n */\nexport interface ISummary {\n    readonly clientId: string;\n    readonly clientSequenceNumber: number;\n    waitBroadcast(): Promise<ISummaryOpMessage>;\n    waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;\n}\n\n/**\n * A single summary which has already been acked by the server.\n */\nexport interface IAckedSummary {\n    readonly summaryOp: ISummaryOpMessage;\n    readonly summaryAck: ISummaryAckMessage;\n}\n\nenum SummaryState {\n    Local = 0,\n    Broadcast = 1,\n    Acked = 2,\n    Nacked = -1,\n}\n\nclass Summary implements ISummary {\n    public static createLocal(clientId: string, clientSequenceNumber: number) {\n        return new Summary(clientId, clientSequenceNumber);\n    }\n    public static createFromOp(op: ISummaryOpMessage) {\n        const summary = new Summary(op.clientId, op.clientSequenceNumber);\n        summary.broadcast(op);\n        return summary;\n    }\n\n    private state = SummaryState.Local;\n\n    private _summaryOp?: ISummaryOpMessage;\n    private _summaryAckNack?: ISummaryAckMessage | ISummaryNackMessage;\n\n    private readonly defSummaryOp = new Deferred<void>();\n    private readonly defSummaryAck = new Deferred<void>();\n\n    public get summaryOp() { return this._summaryOp; }\n    public get summaryAckNack() { return this._summaryAckNack; }\n\n    private constructor(\n        public readonly clientId: string,\n        public readonly clientSequenceNumber: number) { }\n\n    public hasBeenAcked(): this is IAckedSummary {\n        return this.state === SummaryState.Acked;\n    }\n\n    public broadcast(op: ISummaryOpMessage) {\n        assert(this.state === SummaryState.Local, 0x175 /* \"Can only broadcast if summarizer starts in local state\" */);\n        this._summaryOp = op;\n        this.defSummaryOp.resolve();\n        this.state = SummaryState.Broadcast;\n        return true;\n    }\n\n    public ackNack(op: ISummaryAckMessage | ISummaryNackMessage) {\n        assert(this.state === SummaryState.Broadcast,\n            0x176 /* \"Can only ack/nack if summarizer is in broadcasting state\" */);\n        this._summaryAckNack = op;\n        this.defSummaryAck.resolve();\n        this.state = op.type === MessageType.SummaryAck ? SummaryState.Acked : SummaryState.Nacked;\n        return true;\n    }\n\n    public async waitBroadcast(): Promise<ISummaryOpMessage> {\n        await this.defSummaryOp.promise;\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        return this._summaryOp!;\n    }\n\n    public async waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage> {\n        await this.defSummaryAck.promise;\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        return this._summaryAckNack!;\n    }\n}\n\n/**\n * Watches summaries created by a specific client.\n */\nexport interface IClientSummaryWatcher extends IDisposable {\n    watchSummary(clientSequenceNumber: number): ISummary;\n    waitFlushed(): Promise<IAckedSummary | undefined>;\n}\n\n/**\n * This class watches summaries created by a specific client.\n * It should be created and managed from a SummaryCollection.\n */\nclass ClientSummaryWatcher implements IClientSummaryWatcher {\n    // key: clientSeqNum\n    private readonly localSummaries = new Map<number, Summary>();\n    private _disposed = false;\n\n    public get disposed() { return this._disposed; }\n\n    public constructor(\n        public readonly clientId: string,\n        private readonly summaryCollection: SummaryCollection,\n    ) { }\n\n    /**\n     * Watches for a specific sent summary op.\n     * @param clientSequenceNumber - client sequence number of sent summary op\n     */\n    public watchSummary(clientSequenceNumber: number): ISummary {\n        let summary = this.localSummaries.get(clientSequenceNumber);\n        if (!summary) {\n            summary = Summary.createLocal(this.clientId, clientSequenceNumber);\n            this.localSummaries.set(summary.clientSequenceNumber, summary);\n        }\n        return summary;\n    }\n\n    /**\n     * Waits until all of the pending summaries in the underlying SummaryCollection\n     * are acked/nacked.\n     */\n    // eslint-disable-next-line @typescript-eslint/promise-function-async\n    public waitFlushed() {\n        return this.summaryCollection.waitFlushed();\n    }\n\n    /**\n     * Gets a watched summary or returns undefined if not watched.\n     * @param clientSequenceNumber - client sequence number of sent summary op\n     */\n    public tryGetSummary(clientSequenceNumber: number) {\n        return this.localSummaries.get(clientSequenceNumber);\n    }\n\n    /**\n     * Starts watching a summary made by this client.\n     * @param summary - summary to start watching\n     */\n    public setSummary(summary: Summary) {\n        this.localSummaries.set(summary.clientSequenceNumber, summary);\n    }\n\n    public dispose() {\n        this.summaryCollection.removeWatcher(this.clientId);\n        this._disposed = true;\n    }\n}\n\nexport type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | \"default\";\nexport type OpActionEventListener = (op: ISequencedDocumentMessage) => void;\nexport interface ISummaryCollectionOpEvents extends IEvent {\n    (event: OpActionEventName, listener: OpActionEventListener);\n}\n\n/**\n * Data structure that looks at the op stream to track summaries as they\n * are broadcast, acked and nacked.\n * It provides functionality for watching specific summaries.\n */\nexport class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {\n    // key: clientId\n    private readonly summaryWatchers = new Map<string, ClientSummaryWatcher>();\n    // key: summarySeqNum\n    private readonly pendingSummaries = new Map<number, Summary>();\n    private refreshWaitNextAck = new Deferred<void>();\n\n    private lastSummaryTimestamp: number | undefined;\n    private maxAckWaitTime: number | undefined;\n    private pendingAckTimerTimeoutCallback: (() => void) | undefined;\n    private lastAck: IAckedSummary | undefined;\n\n    public get latestAck(): IAckedSummary | undefined { return this.lastAck; }\n\n    public emit(event: OpActionEventName, ...args: Parameters<OpActionEventListener>): boolean {\n        return super.emit(event, ...args);\n    }\n\n    public get opsSinceLastAck() {\n        return this.deltaManager.lastSequenceNumber -\n            (this.lastAck?.summaryAck.sequenceNumber ?? this.deltaManager.initialSequenceNumber);\n    }\n\n    public addOpListener(listener: () => void) {\n        this.deltaManager.on(\"op\", listener);\n    }\n\n    public removeOpListener(listener: () => void) {\n        this.deltaManager.off(\"op\", listener);\n    }\n\n    public constructor(\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        super();\n        this.deltaManager.on(\n            \"op\",\n            (op) => this.handleOp(op));\n    }\n\n    /**\n     * Creates and returns a summary watcher for a specific client.\n     * This will allow for local sent summaries to be better tracked.\n     * @param clientId - client id for watcher\n     */\n    public createWatcher(clientId: string): IClientSummaryWatcher {\n        const watcher = new ClientSummaryWatcher(clientId, this);\n        this.summaryWatchers.set(clientId, watcher);\n        return watcher;\n    }\n\n    public removeWatcher(clientId: string) {\n        this.summaryWatchers.delete(clientId);\n    }\n\n    public setPendingAckTimerTimeoutCallback(maxAckWaitTime: number, timeoutCallback: () => void) {\n        this.maxAckWaitTime = maxAckWaitTime;\n        this.pendingAckTimerTimeoutCallback = timeoutCallback;\n    }\n\n    public unsetPendingAckTimerTimeoutCallback() {\n        this.maxAckWaitTime = undefined;\n        this.pendingAckTimerTimeoutCallback = undefined;\n    }\n\n    /**\n     * Returns a promise that resolves once all pending summary ops\n     * have been acked or nacked.\n     */\n    public async waitFlushed(): Promise<IAckedSummary | undefined> {\n        while (this.pendingSummaries.size > 0) {\n            // eslint-disable-next-line @typescript-eslint/promise-function-async\n            const promises = Array.from(this.pendingSummaries, ([, summary]) => summary.waitAckNack());\n            await Promise.all(promises);\n        }\n        return this.lastAck;\n    }\n\n    /**\n     * Returns a promise that resolves once a summary is acked that has a reference\n     * sequence number greater than or equal to the passed in sequence number.\n     * @param referenceSequenceNumber - reference sequence number to wait for\n     * @returns The latest acked summary\n     */\n    public async waitSummaryAck(referenceSequenceNumber: number): Promise<IAckedSummary> {\n        while (!this.lastAck || this.lastAck.summaryOp.referenceSequenceNumber < referenceSequenceNumber) {\n            await this.refreshWaitNextAck.promise;\n        }\n        return this.lastAck;\n    }\n\n    /**\n     * Handler for ops; only handles ops relating to summaries.\n     * @param op - op message to handle\n     */\n    private handleOp(op: ISequencedDocumentMessage) {\n        switch (op.type) {\n            case MessageType.Summarize: {\n                this.handleSummaryOp(op as ISummaryOpMessage);\n                return;\n            }\n            case MessageType.SummaryAck: {\n                this.handleSummaryAck(op as ISummaryAckMessage);\n                return;\n            }\n            case MessageType.SummaryNack: {\n                this.handleSummaryNack(op as ISummaryNackMessage);\n                return;\n            }\n            default: {\n                // If the difference between timestamp of current op and last summary op is greater than\n                // the maxAckWaitTime, then we need to inform summarizer to not wait and summarize\n                // immediately as we have already waited for maxAckWaitTime.\n                const lastOpTimestamp = op.timestamp;\n                if (this.lastSummaryTimestamp !== undefined &&\n                    this.maxAckWaitTime !== undefined &&\n                    lastOpTimestamp - this.lastSummaryTimestamp >= this.maxAckWaitTime\n                ) {\n                    this.pendingAckTimerTimeoutCallback?.();\n                }\n                this.emit(\"default\", op);\n\n                return;\n            }\n        }\n    }\n\n    private handleSummaryOp(op: ISummaryOpMessage) {\n        let summary: Summary | undefined;\n\n        // Check if summary already being watched, broadcast if so\n        const watcher = this.summaryWatchers.get(op.clientId);\n        if (watcher) {\n            summary = watcher.tryGetSummary(op.clientSequenceNumber);\n            if (summary) {\n                summary.broadcast(op);\n            }\n        }\n\n        // If not watched, create from op\n        if (!summary) {\n            summary = Summary.createFromOp(op);\n            if (watcher) {\n                watcher.setSummary(summary);\n            }\n        }\n        this.pendingSummaries.set(op.sequenceNumber, summary);\n        this.lastSummaryTimestamp = op.timestamp;\n        this.emit(MessageType.Summarize, op);\n    }\n\n    private handleSummaryAck(op: ISummaryAckMessage) {\n        const seq = op.contents.summaryProposal.summarySequenceNumber;\n        const summary = this.pendingSummaries.get(seq);\n        if (!summary || summary.summaryOp === undefined) {\n            // Summary ack without an op should be rare. We could fetch the\n            // reference sequence number from the snapshot, but instead we\n            // will not emit this ack. It should be the case that the summary\n            // op that this ack is for is earlier than this file was loaded\n            // from. i.e. initialSequenceNumber > summarySequenceNumber.\n            // We really don't care about it for now, since it is older than\n            // the one we loaded from.\n            if (seq >= this.deltaManager.initialSequenceNumber) {\n                // Potential causes for it to be later than our initialSequenceNumber\n                // are that the summaryOp was nacked then acked, double-acked, or\n                // the summarySequenceNumber is incorrect.\n                this.logger.sendTelemetryEvent({\n                    eventName: \"SummaryAckWithoutOp\",\n                    sequenceNumber: op.sequenceNumber, // summary ack seq #\n                    summarySequenceNumber: seq, // missing summary seq #\n                    initialSequenceNumber: this.deltaManager.initialSequenceNumber,\n                });\n            }\n            return;\n        }\n        summary.ackNack(op);\n        this.pendingSummaries.delete(seq);\n\n        // Track latest ack\n        if (!this.lastAck || seq > this.lastAck.summaryAck.contents.summaryProposal.summarySequenceNumber) {\n            this.lastAck = {\n                summaryOp: summary.summaryOp,\n                summaryAck: op,\n            };\n            this.refreshWaitNextAck.resolve();\n            this.refreshWaitNextAck = new Deferred<void>();\n            this.emit(MessageType.SummaryAck, op);\n        }\n    }\n\n    private handleSummaryNack(op: ISummaryNackMessage) {\n        const seq = op.contents.summaryProposal.summarySequenceNumber;\n        const summary = this.pendingSummaries.get(seq);\n        if (summary) {\n            summary.ackNack(op);\n            this.pendingSummaries.delete(seq);\n            this.emit(MessageType.SummaryNack, op);\n        }\n    }\n}\n"]}

package/dist/summaryFormat.d.ts

@@ -50,11 +50,6 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
     readonly disableIsolatedChannels?: true;
     /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */
     readonly summaryNumber?: number;
-    /**
-     * @deprecated - User summaryNumber instead.
-     * Counter of the last summary happened, increments every time we summarize
-     */
-    readonly summaryCount?: number;
 }
 export interface ICreateContainerMetadata {
     /** Runtime version of the container when it was first created */

package/dist/summaryFormat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summaryFormat.d.ts","sourceRoot":"","sources":["../src/summaryFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAe,MAAM,sCAAsC,CAAC;AAC7G,OAAO,EAAoB,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAG9F,aAAK,sBAAsB,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CAAC,CAAC;AAC3F,UAAU,0BAA0B;IAChC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,SAAS,CAAC;IAC3C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACtC;AACD,UAAU,0BAA2B,SAAQ,sBAAsB,CAAC,0BAA0B,CAAC;IAC3F,QAAQ,CAAC,qBAAqB,EAAE,KAAK,CAAC;IACtC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAC7C;AACD,UAAU,0BAA2B,SAAQ,sBAAsB,CAAC,0BAA0B,CAAC;IAC3F,gEAAgE;IAChE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,SAAS,CAAC;IAC3C,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,IAAI,CAAC;CAC3C;AACD;;;;GAIG;AACH,oBAAY,4BAA4B,GAClC,0BAA0B,GAC1B,0BAA0B,GAC1B,0BAA0B,CAAC;AACjC,oBAAY,6BAA6B,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAEpG,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,4BAA4B,GAAG,MAAM,CAmB3F;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,4BAA4B,GAAG,OAAO,CAErF;AAED,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB,EAAE,WAAW;IACpF,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACjC,iHAAiH;IACjH,QAAQ,CAAC,OAAO,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACtD,mFAAmF;IACnF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,IAAI,CAAC;IACxC,sGAAsG;IACtG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACrC,iEAAiE;IACjE,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,2DAA2D;IAC3D,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,WAAW,WAAW;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,kHAAkH;IAClH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IACzC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,mGAAmG;AACnG,oBAAY,uBAAuB,GAAG,IAAI,CAAC,yBAAyB,EAC9D,UAAU,GACV,sBAAsB,GACtB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,MAAM,CAAC,CAAC;AAEd;;;GAGG;AACH,eAAO,MAAM,6BAA6B,uDAEvC,uBAAuB,GAAG,SAQ5B,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,QAAQ,CAAC,EAAE,yBAAyB,GAAG,MAAM,CAYrF;AAED,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAC5C,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,yBAAyB,uBAAuB,CAAC;AAC9D,eAAO,MAAM,aAAa,WAAW,CAAC;AAEtC,wBAAgB,uBAAuB,CAAC,QAAQ,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAErF;AAED,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,SAAS,CAM9D;AAED,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,UAA+E,CAAC;AAE9G,eAAO,MAAM,2BAA2B,eAAe,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,yBAAyB,CAAC,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAMtF;AAED,wBAAsB,2BAA2B,CAC7C,OAAO,EAAE,uBAAuB,EAChC,QAAQ,EAAE,aAAa,GACxB,OAAO,CAAC,4BAA4B,CAAC,CAWvC"}
+{"version":3,"file":"summaryFormat.d.ts","sourceRoot":"","sources":["../src/summaryFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAe,MAAM,sCAAsC,CAAC;AAC7G,OAAO,EAAoB,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAG9F,aAAK,sBAAsB,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CAAC,CAAC;AAC3F,UAAU,0BAA0B;IAChC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,SAAS,CAAC;IAC3C,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;CACtC;AACD,UAAU,0BAA2B,SAAQ,sBAAsB,CAAC,0BAA0B,CAAC;IAC3F,QAAQ,CAAC,qBAAqB,EAAE,KAAK,CAAC;IACtC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,SAAS,CAAC;CAC7C;AACD,UAAU,0BAA2B,SAAQ,sBAAsB,CAAC,0BAA0B,CAAC;IAC3F,gEAAgE;IAChE,QAAQ,CAAC,qBAAqB,CAAC,EAAE,SAAS,CAAC;IAC3C,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,IAAI,CAAC;CAC3C;AACD;;;;GAIG;AACH,oBAAY,4BAA4B,GAClC,0BAA0B,GAC1B,0BAA0B,GAC1B,0BAA0B,CAAC;AACjC,oBAAY,6BAA6B,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAEpG,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,4BAA4B,GAAG,MAAM,CAmB3F;AAED,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,4BAA4B,GAAG,OAAO,CAErF;AACD,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB,EAAE,WAAW;IACpF,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACjC,iHAAiH;IACjH,QAAQ,CAAC,OAAO,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACtD,mFAAmF;IACnF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,IAAI,CAAC;IACxC,sGAAsG;IACtG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACrC,iEAAiE;IACjE,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,2DAA2D;IAC3D,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,WAAW,WAAW;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,kHAAkH;IAClH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IACzC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACnC;AAED,mGAAmG;AACnG,oBAAY,uBAAuB,GAAG,IAAI,CAAC,yBAAyB,EAC9D,UAAU,GACV,sBAAsB,GACtB,uBAAuB,GACvB,yBAAyB,GACzB,gBAAgB,GAChB,WAAW,GACX,MAAM,CAAC,CAAC;AAEd;;;GAGG;AACH,eAAO,MAAM,6BAA6B,uDAEvC,uBAAuB,GAAG,SAQ5B,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,QAAQ,CAAC,EAAE,yBAAyB,GAAG,MAAM,CAYrF;AAED,eAAO,MAAM,aAAa,aAAa,CAAC;AACxC,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAC5C,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,yBAAyB,uBAAuB,CAAC;AAC9D,eAAO,MAAM,aAAa,WAAW,CAAC;AAEtC,wBAAgB,uBAAuB,CAAC,QAAQ,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAErF;AAED,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,SAAS,CAM9D;AAED,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,UAA+E,CAAC;AAE9G,eAAO,MAAM,2BAA2B,eAAe,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,yBAAyB,CAAC,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAMtF;AAED,wBAAsB,2BAA2B,CAC7C,OAAO,EAAE,uBAAuB,EAChC,QAAQ,EAAE,aAAa,GACxB,OAAO,CAAC,4BAA4B,CAAC,CAWvC"}

package/dist/summaryFormat.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryFormat.js","sourceRoot":"","sources":["../src/summaryFormat.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAEtD,+DAA4D;AAC5D,+EAA6G;AAC7G,6EAA8F;AAC9F,2DAAgD;AAyChD,SAAgB,0BAA0B,CAAC,UAAwC;IAC/E,IAAI,UAAU,CAAC,oBAAoB,EAAE;QACjC;;;WAGG;QACH,OAAO,UAAU,CAAC,oBAAoB,CAAC;KAC1C;SAAM,IAAI,UAAU,CAAC,qBAAqB,KAAK,KAAK,EAAE;QACnD;;;WAGG;QACH,OAAO,CAAC,CAAC;KACZ;IACD;;;OAGG;IACH,OAAO,CAAC,CAAC;AACb,CAAC;AAnBD,gEAmBC;AAED,SAAgB,mBAAmB,CAAC,UAAwC;IACxE,OAAO,CAAC,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;AACpF,CAAC;AAFD,kDAEC;AAqDD;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CACzC,OAAmC,EACA,EAAE,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,QAAQ,EAAE,OAAO,CAAC,QAAQ;IAC1B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;IAClD,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;IACpD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;IACxD,cAAc,EAAE,OAAO,CAAC,cAAc;IACtC,SAAS,EAAE,OAAO,CAAC,SAAS;IAC5B,IAAI,EAAE,OAAO,CAAC,IAAI;CACrB,CAAC;AAVW,QAAA,6BAA6B,iCAUxC;AAEF,SAAgB,wBAAwB,CAAC,QAAoC;;IACzE;;;;;;;;;OASG;IACH,OAAO,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,oBAAoB,mCAAI,CAAC,CAAC;AAC/C,CAAC;AAZD,4DAYC;AAEY,QAAA,aAAa,GAAG,UAAU,CAAC;AAC3B,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC/B,QAAA,cAAc,GAAG,SAAS,CAAC;AAC3B,QAAA,yBAAyB,GAAG,oBAAoB,CAAC;AACjD,QAAA,aAAa,GAAG,QAAQ,CAAC;AAEtC,SAAgB,uBAAuB,CAAC,QAAoC;IACxE,OAAO,CAAC,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;AAC3D,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY,CAAC,QAAsB;;IAC/C,IAAI,CAAC,QAAQ,EAAE;QACX,0CAA0C;QAC1C,OAAO,CAAC,CAAC;KACZ;IACD,OAAO,MAAA,QAAQ,CAAC,SAAS,mCAAI,CAAC,CAAC;AACnC,CAAC;AAND,oCAMC;AAEY,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAE5C;;;;;GAKG;AACU,QAAA,iBAAiB,GAAG,CAAC,wBAAgB,EAAE,UAAU,EAAE,kBAAkB,EAAE,qBAAa,EAAE,6BAAS,CAAC,CAAC;AAEjG,QAAA,2BAA2B,GAAG,YAAY,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,yBAAyB,CAAC,eAAsC;IAC5E,eAAe,CAAC,OAAO,GAAG;QACtB,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,CAAC,sCAAgB,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE;KACxD,CAAC;IACF,eAAe,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1C,CAAC;AAND,8DAMC;AAEM,KAAK,UAAU,2BAA2B,CAC7C,OAAgC,EAChC,QAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,IAAA,2BAAY,EACjC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC,CAAC;IAC1D,qFAAqF;IACrF,mGAAmG;IACnG,uFAAuF;IACvF,0FAA0F;IAC1F,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC7D,IAAA,qBAAM,EAAC,aAAa,GAAG,CAAC,EACpB,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACjD,OAAO,UAAU,CAAC;AACtB,CAAC;AAdD,kEAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { channelsTreeName, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { gcTreeKey } from \"./garbageCollection\";\n\ntype OmitAttributesVersions<T> = Omit<T, \"snapshotFormatVersion\" | \"summaryFormatVersion\">;\ninterface IFluidDataStoreAttributes0 {\n    readonly snapshotFormatVersion?: undefined;\n    readonly summaryFormatVersion?: undefined;\n    pkg: string;\n    /**\n     * This tells whether a data store is root. Root data stores are never collected.\n     * Non-root data stores may be collected if they are not used. If this is not present, default it to\n     * true. This will ensure that older data stores are incorrectly collected.\n     */\n    readonly isRootDataStore?: boolean;\n}\ninterface IFluidDataStoreAttributes1 extends OmitAttributesVersions<IFluidDataStoreAttributes0> {\n    readonly snapshotFormatVersion: \"0.1\";\n    readonly summaryFormatVersion?: undefined;\n}\ninterface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFluidDataStoreAttributes1> {\n    /** Switch from snapshotFormatVersion to summaryFormatVersion */\n    readonly snapshotFormatVersion?: undefined;\n    readonly summaryFormatVersion: 2;\n    /**\n     * True if channels are not isolated in .channels subtrees, otherwise isolated.\n     * This is required in both datastore attributes as well as the root container,\n     * because reused summary handles may cause different format versions in each\n     * datastore subtree within the summary.\n     */\n    readonly disableIsolatedChannels?: true;\n}\n/**\n * Added IFluidDataStoreAttributes similar to IChannelAttributes which will tell the attributes of a\n * store like the package, snapshotFormatVersion to take different decisions based on a particular\n * snapshotFormatVersion.\n */\nexport type ReadFluidDataStoreAttributes =\n    | IFluidDataStoreAttributes0\n    | IFluidDataStoreAttributes1\n    | IFluidDataStoreAttributes2;\nexport type WriteFluidDataStoreAttributes = IFluidDataStoreAttributes1 | IFluidDataStoreAttributes2;\n\nexport function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttributes): number {\n    if (attributes.summaryFormatVersion) {\n        /**\n         * Version 2+: Introduces .channels trees for isolation of\n         * channel trees from data store objects.\n         */\n        return attributes.summaryFormatVersion;\n    } else if (attributes.snapshotFormatVersion === \"0.1\") {\n        /**\n         * Version 1: from this version the pkg within the data store\n         * attributes blob is a JSON array rather than a string.\n         */\n        return 1;\n    }\n    /**\n     * Version 0: format version is missing from summary.\n     * This indicates it is an older version.\n     */\n    return 0;\n}\n\nexport function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): boolean {\n    return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;\n}\n\nexport interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {\n    readonly summaryFormatVersion: 1;\n    /** The last message processed at the time of summary. Only primitive property types are added to the summary. */\n    readonly message: ISummaryMetadataMessage | undefined;\n    /** True if channels are not isolated in .channels subtrees, otherwise isolated. */\n    readonly disableIsolatedChannels?: true;\n    /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */\n    readonly summaryNumber?: number;\n    /**\n     * @deprecated - User summaryNumber instead.\n     * Counter of the last summary happened, increments every time we summarize\n     */\n    readonly summaryCount?: number;\n}\n\nexport interface ICreateContainerMetadata {\n    /** Runtime version of the container when it was first created */\n    createContainerRuntimeVersion?: string;\n    /** Timestamp of the container when it was first created */\n    createContainerTimestamp?: number;\n}\n\nexport type GCVersion = number;\nexport interface IGCMetadata {\n    /**\n     * The version of the GC code that was run to generate the GC data that is written in the summary.\n     * Also, used to determine whether GC is enabled for this container or not:\n     * - A value of 0 or undefined means GC is disabled.\n     * - A value greater than 0 means GC is enabled.\n     */\n    readonly gcFeature?: GCVersion;\n    /** If this is present, the session for this container will expire after this time and the container will close */\n    readonly sessionExpiryTimeoutMs?: number;\n    /**\n     * Tells whether the GC sweep phase is enabled for this container.\n     * - True means sweep phase is enabled.\n     * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.\n     */\n    readonly sweepEnabled?: boolean;\n}\n\n/** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */\nexport type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage,\n    | \"clientId\"\n    | \"clientSequenceNumber\"\n    | \"minimumSequenceNumber\"\n    | \"referenceSequenceNumber\"\n    | \"sequenceNumber\"\n    | \"timestamp\"\n    | \"type\">;\n\n/**\n * Extracts the properties from an ISequencedDocumentMessage as defined by ISummaryMetadataMessage. This message is\n * added to the metadata blob in summary.\n */\nexport const extractSummaryMetadataMessage = (\n    message?: ISequencedDocumentMessage,\n): ISummaryMetadataMessage | undefined => message === undefined ? undefined : {\n    clientId: message.clientId,\n    clientSequenceNumber: message.clientSequenceNumber,\n    minimumSequenceNumber: message.minimumSequenceNumber,\n    referenceSequenceNumber: message.referenceSequenceNumber,\n    sequenceNumber: message.sequenceNumber,\n    timestamp: message.timestamp,\n    type: message.type,\n};\n\nexport function getMetadataFormatVersion(metadata?: IContainerRuntimeMetadata): number {\n    /**\n     * Version 2+: Introduces runtime sequence number for data verification.\n     *\n     * Version 1+: Introduces .metadata blob and .channels trees for isolation of\n     * data store trees from container-level objects.\n     * Also introduces enableGC option stored in the summary.\n     *\n     * Version 0: metadata blob missing; format version is missing from summary.\n     * This indicates it is an older version.\n     */\n    return metadata?.summaryFormatVersion ?? 0;\n}\n\nexport const aliasBlobName = \".aliases\";\nexport const metadataBlobName = \".metadata\";\nexport const chunksBlobName = \".chunks\";\nexport const electedSummarizerBlobName = \".electedSummarizer\";\nexport const blobsTreeName = \".blobs\";\n\nexport function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {\n    return !!metadata && !metadata.disableIsolatedChannels;\n}\n\nexport function getGCVersion(metadata?: IGCMetadata): GCVersion {\n    if (!metadata) {\n        // Force to 0/disallowed in prior versions\n        return 0;\n    }\n    return metadata.gcFeature ?? 0;\n}\n\nexport const protocolTreeName = \".protocol\";\n\n/**\n * List of tree IDs at the container level which are reserved.\n * This is for older versions of summaries that do not yet have an\n * isolated data stores namespace. Without the namespace, this must\n * be used to prevent name collisions with data store IDs.\n */\nexport const nonDataStorePaths = [protocolTreeName, \".logTail\", \".serviceProtocol\", blobsTreeName, gcTreeKey];\n\nexport const dataStoreAttributesBlobName = \".component\";\n\n/**\n * Modifies summary tree and stats to put tree under .channels tree.\n *\n * @param summarizeResult - Summary tree and stats to modify\n *\n * @example\n * Converts from:\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: { a: {...}, b: {...}, c: {...} },\n * }\n * ```\n *\n * to:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: {\n *         \".channels\": {\n *             type: SummaryType.Tree,\n *             tree: { a: {...}, b: {...}, c: {...} }\n *         },\n *     },\n * }\n * ```\n * And adds +1 to treeNodeCount in stats.\n */\nexport function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats): void {\n    summarizeResult.summary = {\n        type: SummaryType.Tree,\n        tree: { [channelsTreeName]: summarizeResult.summary },\n    };\n    summarizeResult.stats.treeNodeCount++;\n}\n\nexport async function getFluidDataStoreAttributes(\n    storage: IDocumentStorageService,\n    snapshot: ISnapshotTree,\n): Promise<ReadFluidDataStoreAttributes> {\n    const attributes = await readAndParse<ReadFluidDataStoreAttributes>(\n        storage, snapshot.blobs[dataStoreAttributesBlobName]);\n    // Use the snapshotFormatVersion to determine how the pkg is encoded in the snapshot.\n    // For snapshotFormatVersion = \"0.1\" (1) or above, pkg is jsonified, otherwise it is just a string.\n    // However the feature of loading a detached container from snapshot, is added when the\n    // snapshotFormatVersion is at least \"0.1\" (1), so we don't expect it to be anything else.\n    const formatVersion = getAttributesFormatVersion(attributes);\n    assert(formatVersion > 0,\n        0x1d5 /* Invalid snapshot format version */);\n    return attributes;\n}\n"]}
+{"version":3,"file":"summaryFormat.js","sourceRoot":"","sources":["../src/summaryFormat.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAEtD,+DAA4D;AAC5D,+EAA6G;AAC7G,6EAA8F;AAC9F,2DAAgD;AAyChD,SAAgB,0BAA0B,CAAC,UAAwC;IAC/E,IAAI,UAAU,CAAC,oBAAoB,EAAE;QACjC;;;WAGG;QACH,OAAO,UAAU,CAAC,oBAAoB,CAAC;KAC1C;SAAM,IAAI,UAAU,CAAC,qBAAqB,KAAK,KAAK,EAAE;QACnD;;;WAGG;QACH,OAAO,CAAC,CAAC;KACZ;IACD;;;OAGG;IACH,OAAO,CAAC,CAAC;AACb,CAAC;AAnBD,gEAmBC;AAED,SAAgB,mBAAmB,CAAC,UAAwC;IACxE,OAAO,CAAC,CAAC,UAAU,CAAC,oBAAoB,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;AACpF,CAAC;AAFD,kDAEC;AA+CD;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CACzC,OAAmC,EACA,EAAE,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,QAAQ,EAAE,OAAO,CAAC,QAAQ;IAC1B,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;IAClD,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;IACpD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;IACxD,cAAc,EAAE,OAAO,CAAC,cAAc;IACtC,SAAS,EAAE,OAAO,CAAC,SAAS;IAC5B,IAAI,EAAE,OAAO,CAAC,IAAI;CACrB,CAAC;AAVW,QAAA,6BAA6B,iCAUxC;AAEF,SAAgB,wBAAwB,CAAC,QAAoC;;IACzE;;;;;;;;;OASG;IACH,OAAO,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,oBAAoB,mCAAI,CAAC,CAAC;AAC/C,CAAC;AAZD,4DAYC;AAEY,QAAA,aAAa,GAAG,UAAU,CAAC;AAC3B,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAC/B,QAAA,cAAc,GAAG,SAAS,CAAC;AAC3B,QAAA,yBAAyB,GAAG,oBAAoB,CAAC;AACjD,QAAA,aAAa,GAAG,QAAQ,CAAC;AAEtC,SAAgB,uBAAuB,CAAC,QAAoC;IACxE,OAAO,CAAC,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;AAC3D,CAAC;AAFD,0DAEC;AAED,SAAgB,YAAY,CAAC,QAAsB;;IAC/C,IAAI,CAAC,QAAQ,EAAE;QACX,0CAA0C;QAC1C,OAAO,CAAC,CAAC;KACZ;IACD,OAAO,MAAA,QAAQ,CAAC,SAAS,mCAAI,CAAC,CAAC;AACnC,CAAC;AAND,oCAMC;AAEY,QAAA,gBAAgB,GAAG,WAAW,CAAC;AAE5C;;;;;GAKG;AACU,QAAA,iBAAiB,GAAG,CAAC,wBAAgB,EAAE,UAAU,EAAE,kBAAkB,EAAE,qBAAa,EAAE,6BAAS,CAAC,CAAC;AAEjG,QAAA,2BAA2B,GAAG,YAAY,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,yBAAyB,CAAC,eAAsC;IAC5E,eAAe,CAAC,OAAO,GAAG;QACtB,IAAI,EAAE,kCAAW,CAAC,IAAI;QACtB,IAAI,EAAE,EAAE,CAAC,sCAAgB,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE;KACxD,CAAC;IACF,eAAe,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;AAC1C,CAAC;AAND,8DAMC;AAEM,KAAK,UAAU,2BAA2B,CAC7C,OAAgC,EAChC,QAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,IAAA,2BAAY,EACjC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,mCAA2B,CAAC,CAAC,CAAC;IAC1D,qFAAqF;IACrF,mGAAmG;IACnG,uFAAuF;IACvF,0FAA0F;IAC1F,MAAM,aAAa,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IAC7D,IAAA,qBAAM,EAAC,aAAa,GAAG,CAAC,EACpB,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACjD,OAAO,UAAU,CAAC;AACtB,CAAC;AAdD,kEAcC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { readAndParse } from \"@fluidframework/driver-utils\";\nimport { ISequencedDocumentMessage, ISnapshotTree, SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { channelsTreeName, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { gcTreeKey } from \"./garbageCollection\";\n\ntype OmitAttributesVersions<T> = Omit<T, \"snapshotFormatVersion\" | \"summaryFormatVersion\">;\ninterface IFluidDataStoreAttributes0 {\n    readonly snapshotFormatVersion?: undefined;\n    readonly summaryFormatVersion?: undefined;\n    pkg: string;\n    /**\n     * This tells whether a data store is root. Root data stores are never collected.\n     * Non-root data stores may be collected if they are not used. If this is not present, default it to\n     * true. This will ensure that older data stores are incorrectly collected.\n     */\n    readonly isRootDataStore?: boolean;\n}\ninterface IFluidDataStoreAttributes1 extends OmitAttributesVersions<IFluidDataStoreAttributes0> {\n    readonly snapshotFormatVersion: \"0.1\";\n    readonly summaryFormatVersion?: undefined;\n}\ninterface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFluidDataStoreAttributes1> {\n    /** Switch from snapshotFormatVersion to summaryFormatVersion */\n    readonly snapshotFormatVersion?: undefined;\n    readonly summaryFormatVersion: 2;\n    /**\n     * True if channels are not isolated in .channels subtrees, otherwise isolated.\n     * This is required in both datastore attributes as well as the root container,\n     * because reused summary handles may cause different format versions in each\n     * datastore subtree within the summary.\n     */\n    readonly disableIsolatedChannels?: true;\n}\n/**\n * Added IFluidDataStoreAttributes similar to IChannelAttributes which will tell the attributes of a\n * store like the package, snapshotFormatVersion to take different decisions based on a particular\n * snapshotFormatVersion.\n */\nexport type ReadFluidDataStoreAttributes =\n    | IFluidDataStoreAttributes0\n    | IFluidDataStoreAttributes1\n    | IFluidDataStoreAttributes2;\nexport type WriteFluidDataStoreAttributes = IFluidDataStoreAttributes1 | IFluidDataStoreAttributes2;\n\nexport function getAttributesFormatVersion(attributes: ReadFluidDataStoreAttributes): number {\n    if (attributes.summaryFormatVersion) {\n        /**\n         * Version 2+: Introduces .channels trees for isolation of\n         * channel trees from data store objects.\n         */\n        return attributes.summaryFormatVersion;\n    } else if (attributes.snapshotFormatVersion === \"0.1\") {\n        /**\n         * Version 1: from this version the pkg within the data store\n         * attributes blob is a JSON array rather than a string.\n         */\n        return 1;\n    }\n    /**\n     * Version 0: format version is missing from summary.\n     * This indicates it is an older version.\n     */\n    return 0;\n}\n\nexport function hasIsolatedChannels(attributes: ReadFluidDataStoreAttributes): boolean {\n    return !!attributes.summaryFormatVersion && !attributes.disableIsolatedChannels;\n}\nexport interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {\n    readonly summaryFormatVersion: 1;\n    /** The last message processed at the time of summary. Only primitive property types are added to the summary. */\n    readonly message: ISummaryMetadataMessage | undefined;\n    /** True if channels are not isolated in .channels subtrees, otherwise isolated. */\n    readonly disableIsolatedChannels?: true;\n    /** The summary number for a container's summary. Incremented on summaries throughout its lifetime. */\n    readonly summaryNumber?: number;\n}\n\nexport interface ICreateContainerMetadata {\n    /** Runtime version of the container when it was first created */\n    createContainerRuntimeVersion?: string;\n    /** Timestamp of the container when it was first created */\n    createContainerTimestamp?: number;\n}\n\nexport type GCVersion = number;\nexport interface IGCMetadata {\n    /**\n     * The version of the GC code that was run to generate the GC data that is written in the summary.\n     * Also, used to determine whether GC is enabled for this container or not:\n     * - A value of 0 or undefined means GC is disabled.\n     * - A value greater than 0 means GC is enabled.\n     */\n    readonly gcFeature?: GCVersion;\n    /** If this is present, the session for this container will expire after this time and the container will close */\n    readonly sessionExpiryTimeoutMs?: number;\n    /**\n     * Tells whether the GC sweep phase is enabled for this container.\n     * - True means sweep phase is enabled.\n     * - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.\n     */\n    readonly sweepEnabled?: boolean;\n}\n\n/** The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary. */\nexport type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage,\n    | \"clientId\"\n    | \"clientSequenceNumber\"\n    | \"minimumSequenceNumber\"\n    | \"referenceSequenceNumber\"\n    | \"sequenceNumber\"\n    | \"timestamp\"\n    | \"type\">;\n\n/**\n * Extracts the properties from an ISequencedDocumentMessage as defined by ISummaryMetadataMessage. This message is\n * added to the metadata blob in summary.\n */\nexport const extractSummaryMetadataMessage = (\n    message?: ISequencedDocumentMessage,\n): ISummaryMetadataMessage | undefined => message === undefined ? undefined : {\n    clientId: message.clientId,\n    clientSequenceNumber: message.clientSequenceNumber,\n    minimumSequenceNumber: message.minimumSequenceNumber,\n    referenceSequenceNumber: message.referenceSequenceNumber,\n    sequenceNumber: message.sequenceNumber,\n    timestamp: message.timestamp,\n    type: message.type,\n};\n\nexport function getMetadataFormatVersion(metadata?: IContainerRuntimeMetadata): number {\n    /**\n     * Version 2+: Introduces runtime sequence number for data verification.\n     *\n     * Version 1+: Introduces .metadata blob and .channels trees for isolation of\n     * data store trees from container-level objects.\n     * Also introduces enableGC option stored in the summary.\n     *\n     * Version 0: metadata blob missing; format version is missing from summary.\n     * This indicates it is an older version.\n     */\n    return metadata?.summaryFormatVersion ?? 0;\n}\n\nexport const aliasBlobName = \".aliases\";\nexport const metadataBlobName = \".metadata\";\nexport const chunksBlobName = \".chunks\";\nexport const electedSummarizerBlobName = \".electedSummarizer\";\nexport const blobsTreeName = \".blobs\";\n\nexport function rootHasIsolatedChannels(metadata?: IContainerRuntimeMetadata): boolean {\n    return !!metadata && !metadata.disableIsolatedChannels;\n}\n\nexport function getGCVersion(metadata?: IGCMetadata): GCVersion {\n    if (!metadata) {\n        // Force to 0/disallowed in prior versions\n        return 0;\n    }\n    return metadata.gcFeature ?? 0;\n}\n\nexport const protocolTreeName = \".protocol\";\n\n/**\n * List of tree IDs at the container level which are reserved.\n * This is for older versions of summaries that do not yet have an\n * isolated data stores namespace. Without the namespace, this must\n * be used to prevent name collisions with data store IDs.\n */\nexport const nonDataStorePaths = [protocolTreeName, \".logTail\", \".serviceProtocol\", blobsTreeName, gcTreeKey];\n\nexport const dataStoreAttributesBlobName = \".component\";\n\n/**\n * Modifies summary tree and stats to put tree under .channels tree.\n *\n * @param summarizeResult - Summary tree and stats to modify\n *\n * @example\n * Converts from:\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: { a: {...}, b: {...}, c: {...} },\n * }\n * ```\n *\n * to:\n *\n * ```typescript\n * {\n *     type: SummaryType.Tree,\n *     tree: {\n *         \".channels\": {\n *             type: SummaryType.Tree,\n *             tree: { a: {...}, b: {...}, c: {...} }\n *         },\n *     },\n * }\n * ```\n * And adds +1 to treeNodeCount in stats.\n */\nexport function wrapSummaryInChannelsTree(summarizeResult: ISummaryTreeWithStats): void {\n    summarizeResult.summary = {\n        type: SummaryType.Tree,\n        tree: { [channelsTreeName]: summarizeResult.summary },\n    };\n    summarizeResult.stats.treeNodeCount++;\n}\n\nexport async function getFluidDataStoreAttributes(\n    storage: IDocumentStorageService,\n    snapshot: ISnapshotTree,\n): Promise<ReadFluidDataStoreAttributes> {\n    const attributes = await readAndParse<ReadFluidDataStoreAttributes>(\n        storage, snapshot.blobs[dataStoreAttributesBlobName]);\n    // Use the snapshotFormatVersion to determine how the pkg is encoded in the snapshot.\n    // For snapshotFormatVersion = \"0.1\" (1) or above, pkg is jsonified, otherwise it is just a string.\n    // However the feature of loading a detached container from snapshot, is added when the\n    // snapshotFormatVersion is at least \"0.1\" (1), so we don't expect it to be anything else.\n    const formatVersion = getAttributesFormatVersion(attributes);\n    assert(formatVersion > 0,\n        0x1d5 /* Invalid snapshot format version */);\n    return attributes;\n}\n"]}

package/dist/summaryGenerator.d.ts

@@ -79,6 +79,7 @@ export declare class SummaryGenerator {
      */
     summarize(summarizeProps: ISummarizeTelemetryProperties, options: ISummarizeOptions, cancellationToken: ISummaryCancellationToken, resultsBuilder?: SummarizeResultBuilder): ISummarizeResults;
     private summarizeCore;
+    private addSummaryDataToTelemetryProps;
     private summarizeTimerHandler;
     dispose(): void;
 }

package/dist/summaryGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summaryGenerator.d.ts","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAEH,QAAQ,EACR,aAAa,EACb,mBAAmB,EAEtB,MAAM,8BAA8B,CAAC;AAKtC,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,6BAA6B,EAEhC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,oBAAY,eAAe,CAAC,CAAC,IACzB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,GAC7B;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CAAE,GAC/C;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAC;AAE7B,uEAAuE;AACvE,wBAAsB,SAAS,CAAC,CAAC,EAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,EACnC,iBAAiB,CAAC,EAAE,yBAAyB,GAC9C,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAS7B;AAMD,oBAAY,eAAe;AACvB;;;;;GAKG;AACD,MAAM;AACR;;;;GAIG;GACD,SAAS;AACX;;;;;;GAMG;GACD,QAAQ;AACV;;;;;;GAMG;GACD,aAAa;AACf,yDAAyD;GACvD,YAAY,MAAM,EAAE;AACtB,uDAAuD;GACrD,WAAW,MAAM,EAAE,CAAC;AA6B1B,qBAAa,sBAAsB;IAC/B,SAAgB,gBAAgB,gEAA4D;IAC5F,SAAgB,oBAAoB,oEAAgE;IACpG,SAAgB,wBAAwB,uEACuC;IAExE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,EAAE,MAAM;IAUpG,KAAK,IAAI,iBAAiB;CAOpC;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAGrB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,yBAAyB;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAR3B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;gBAElB,eAAe,EAAE,aAAa,EAC9B,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,qBAAqB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,EACrD,yBAAyB,EAAE,MAAM,IAAI,EACrC,cAAc,EAAE,IAAI,CAAC,qBAAqB,EAAE,cAAc,CAAC,EAC3D,MAAM,EAAE,gBAAgB;IAQ7C;;;;;;OAMG;IACI,SAAS,CACZ,cAAc,EAAE,6BAA6B,EAC7C,OAAO,EAAE,iBAAiB,EAC1B,iBAAiB,EAAE,yBAAyB,EAC5C,cAAc,yBAA+B,GAC9C,iBAAiB;YAWN,aAAa;IA8N3B,OAAO,CAAC,qBAAqB;IAatB,OAAO;CAGjB"}
+{"version":3,"file":"summaryGenerator.d.ts","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAEH,QAAQ,EACR,aAAa,EACb,mBAAmB,EAEtB,MAAM,8BAA8B,CAAC;AAKtC,OAAO,EACH,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,6BAA6B,EAEhC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,oBAAY,eAAe,CAAC,CAAC,IACzB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;CAAE,GAC7B;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CAAE,GAC/C;IAAE,MAAM,EAAE,WAAW,CAAC;CAAE,CAAC;AAE7B,uEAAuE;AACvE,wBAAsB,SAAS,CAAC,CAAC,EAC7B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,EACnC,iBAAiB,CAAC,EAAE,yBAAyB,GAC9C,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAS7B;AAMD,oBAAY,eAAe;AACvB;;;;;GAKG;AACD,MAAM;AACR;;;;GAIG;GACD,SAAS;AACX;;;;;;GAMG;GACD,QAAQ;AACV;;;;;;GAMG;GACD,aAAa;AACf,yDAAyD;GACvD,YAAY,MAAM,EAAE;AACtB,uDAAuD;GACrD,WAAW,MAAM,EAAE,CAAC;AA6B1B,qBAAa,sBAAsB;IAC/B,SAAgB,gBAAgB,gEAA4D;IAC5F,SAAgB,oBAAoB,oEAAgE;IACpG,SAAgB,wBAAwB,uEACuC;IAExE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,iBAAiB,CAAC,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,EAAE,MAAM;IAUpG,KAAK,IAAI,iBAAiB;CAOpC;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAGrB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,yBAAyB;IAC1C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAR3B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;gBAElB,eAAe,EAAE,aAAa,EAC9B,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,qBAAqB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,EACrD,yBAAyB,EAAE,MAAM,IAAI,EACrC,cAAc,EAAE,IAAI,CAAC,qBAAqB,EAAE,cAAc,CAAC,EAC3D,MAAM,EAAE,gBAAgB;IAQ7C;;;;;;OAMG;IACI,SAAS,CACZ,cAAc,EAAE,6BAA6B,EAC7C,OAAO,EAAE,iBAAiB,EAC1B,iBAAiB,EAAE,yBAAyB,EAC5C,cAAc,yBAA+B,GAC9C,iBAAiB;YAWN,aAAa;IAyM3B,OAAO,CAAC,8BAA8B;IAuCtC,OAAO,CAAC,qBAAqB;IAatB,OAAO;CAGjB"}

package/dist/summaryGenerator.js

@@ -146,15 +146,7 @@ class SummaryGenerator {
             const referenceSequenceNumber = summaryData.referenceSequenceNumber;
             const opsSinceLastSummary = referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;
             summarizeTelemetryProps = Object.assign(Object.assign({}, summarizeTelemetryProps), { referenceSequenceNumber, minimumSequenceNumber: summaryData.minimumSequenceNumber, opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber, opsSinceLastSummary });
-            if (summaryData.stage !== "base") {
-                summarizeTelemetryProps = Object.assign(Object.assign(Object.assign({}, summarizeTelemetryProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration });
-                if (summaryData.stage !== "generate") {
-                    summarizeTelemetryProps = Object.assign(Object.assign({}, summarizeTelemetryProps), { handle: summaryData.handle, uploadDuration: summaryData.uploadDuration });
-                    if (summaryData.stage !== "upload") {
-                        summarizeTelemetryProps = Object.assign(Object.assign({}, summarizeTelemetryProps), { clientSequenceNumber: summaryData.clientSequenceNumber });
-                    }
-                }
-            }
+            summarizeTelemetryProps = this.addSummaryDataToTelemetryProps(summaryData, summarizeTelemetryProps);
             if (summaryData.stage !== "submit") {
                 return fail("submitSummaryFailure", summaryData.error, summarizeTelemetryProps);
             }
@@ -255,6 +247,16 @@ class SummaryGenerator {
             this.pendingAckTimer.clear();
         }
     }
+    addSummaryDataToTelemetryProps(summaryData, initialProps) {
+        switch (summaryData.stage) {
+            case "base": return initialProps;
+            case "generate": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration });
+            case "upload": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration, handle: summaryData.handle, uploadDuration: summaryData.uploadDuration });
+            case "submit": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration, handle: summaryData.handle, uploadDuration: summaryData.uploadDuration, clientSequenceNumber: summaryData.clientSequenceNumber, hasMissingOpData: this.heuristicData.hasMissingOpData, opsSizesSinceLastSummary: this.heuristicData.totalOpsSize, nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps });
+            default: (0, common_utils_1.assert)(true, 0x397 /* Unexpected summary stage */);
+        }
+        return initialProps;
+    }
     summarizeTimerHandler(time, count) {
         this.logger.sendPerformanceEvent({
             eventName: "SummarizeTimeout",

package/dist/summaryGenerator.js.map

@@ -1 +1 @@
-{"version":3,"file":"summaryGenerator.js","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAMsC;AACtC,+EAAmE;AACnE,qEAA8F;AAC9F,+DAA6E;AAC7E,2EAAqE;AAsBrE,uEAAuE;AAChE,KAAK,UAAU,SAAS,CAC3B,OAAmB,EACnB,KAAmC,EACnC,iBAA6C;IAE7C,MAAM,QAAQ,GAAkC;QAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAY,CAAA,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAY,CAAA,CAAC;KACjE,CAAC;IACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAY,CAAA,CAAC,CAAC,CAAC;KACjG;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAbD,8BAaC;AAED,yDAAyD;AACzD,MAAM,uBAAuB,GAAG,KAAK,CAAC,CAAC,SAAS;AAChD,MAAM,wBAAwB,GAAG,CAAC,CAAC,CAAC,4BAA4B;AAqChE,MAAM,eAAe,GAAG;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,0DAA0D;IAChF;;;OAGG;IACH,oBAAoB,EAAE,kDAAkD;IACxE;;;;OAIG;IACH,qBAAqB,EAAE,qDAAqD;IAC5E;;;OAGG;IACH,WAAW,EAAE,4CAA4C;IAEzD,UAAU,EAAE,+DAA+D;CACrE,CAAC;AAEX,MAAa,sBAAsB;IAAnC;QACoB,qBAAgB,GAAG,IAAI,uBAAQ,EAA4C,CAAC;QAC5E,yBAAoB,GAAG,IAAI,uBAAQ,EAAgD,CAAC;QACpF,6BAAwB,GACpC,IAAI,uBAAQ,EAA8D,CAAC;IAmBnF,CAAC;IAjBU,IAAI,CAAC,OAAe,EAAE,KAAU,EAAE,iBAAsC,EAAE,iBAA0B;QACvG,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAC7C,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAE9E,MAAM,MAAM,GACR,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,EAAW,CAAC;QACpF,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,wBAAwB,CAAC,OAAO,iCAAM,MAAM,KAAE,IAAI,EAAE,iBAAiB,IAAG,CAAC;IAClF,CAAC;IACM,KAAK;QACR,OAAO;YACH,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO;YAC/C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO;YACvD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO;SACzD,CAAC;IACf,CAAC;CACJ;AAvBD,wDAuBC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAEzB,YACqB,eAA8B,EAC9B,aAAsC,EACtC,qBAAuF,EACvF,qBAAqD,EACrD,yBAAqC,EACrC,cAA2D,EAC3D,MAAwB;QANxB,oBAAe,GAAf,eAAe,CAAe;QAC9B,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,0BAAqB,GAArB,qBAAqB,CAAgC;QACrD,8BAAyB,GAAzB,yBAAyB,CAAY;QACrC,mBAAc,GAAd,cAAc,CAA6C;QAC3D,WAAM,GAAN,MAAM,CAAkB;QAEzC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAK,CAC3B,uBAAuB,EACvB,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAC/D,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACZ,cAA6C,EAC7C,OAA0B,EAC1B,iBAA4C,EAC5C,cAAc,GAAG,IAAI,sBAAsB,EAAE;QAE7C,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC;aAC7E,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,OAAO,GAAG,0BAA0B,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,cAAc,iBAAG,SAAS,EAAE,OAAO,IAAK,cAAc,GAAI,KAAK,CAAC,CAAC;YAC7E,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,cAA6C,EAC7C,OAA0B,EAC1B,cAAsC,EACtC,iBAA4C;QAE5C,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAEnF,8DAA8D;QAC9D,wEAAwE;QACxE,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QACrF,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,CAAC;QAC/F,IAAI,uBAAuB,GAA8B;YACrD,QAAQ;YACR,oBAAoB;YACpB,oBAAoB;SACvB,CAAC;QAEF,MAAM,cAAc,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBAChD,SAAS,EAAE,WAAW,EACtB,gBAAgB,IACb,uBAAuB,EAC5B,CAAC;QAEH,kDAAkD;QAClD,MAAM,cAAc,GAChB,CAAC,SAAuC,EAAE,EAAE,CAAC,GAAG,SAAS,KAAK,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,GAAG,CACT,SAAuC,EACvC,KAAW,EACX,UAAsC,EACtC,iBAAsC,EACxC,EAAE;YACA,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;YACvD,gEAAgE;YAChE,oFAAoF;YACpF,MAAM,iBAAiB,GAAG,IAAA,4CAA6B,EAAC,KAAK,CAAC,CAAC;YAE/D,+FAA+F;YAC/F,4FAA4F;YAC5F,oBAAoB;YACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,SAAS,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC;gBAC/F,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;YAExB,cAAc,CAAC,MAAM,iCACb,UAAU,KACb,MAAM,EAAE,SAAS,EACjB,QAAQ;gBACR,iBAAiB,KACnB,KAAK,CAAC,CAAC;YACV,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAChG,CAAC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,oDAAoD;QACpD,IAAI,WAA4C,CAAC;QACjD,IAAI;YACA,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC;gBAC3C,QAAQ;gBACR,gBAAgB;gBAChB,aAAa,EAAE,MAAM;gBACrB,iBAAiB;aACpB,CAAC,CAAC;YAEH,+EAA+E;YAC/E,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC;YACpE,MAAM,mBAAmB,GACrB,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACzF,uBAAuB,mCAChB,uBAAuB,KAC1B,uBAAuB,EACvB,qBAAqB,EAAE,WAAW,CAAC,qBAAqB,EACxD,mBAAmB,EAAE,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAC/F,mBAAmB,GACtB,CAAC;YACF,IAAI,WAAW,CAAC,KAAK,KAAK,MAAM,EAAE;gBAC9B,uBAAuB,iDAChB,uBAAuB,GACvB,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,GACjD,CAAC;gBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,UAAU,EAAE;oBAClC,uBAAuB,mCAChB,uBAAuB,KAC1B,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,cAAc,EAAE,WAAW,CAAC,cAAc,GAC7C,CAAC;oBAEF,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;wBAChC,uBAAuB,mCAChB,uBAAuB,KAC1B,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,GACzD,CAAC;qBACL;iBACJ;aACJ;YAED,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;aACnF;YAED;;;;;;;;;eASG;YACH,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;gBAC1C,MAAM,EAAE,wBAAwB,EAAE,4BAA4B,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,YAAY,CAAC;gBAChG,IAAI,wBAAwB,GAAG,4BAA4B,GAAG,mBAAmB,EAAE;oBAC/E,MAAM,CAAC,cAAc,CAAC;wBAClB,SAAS,EAAE,6BAA6B;wBACxC,wBAAwB;wBACxB,4BAA4B;wBAC5B,mBAAmB;qBACtB,CAAC,CAAC;iBACN;aACJ;YAED,0FAA0F;YAC1F,cAAc,CAAC,WAAW,CAAC,UAAU,oBAAO,uBAAuB,EAAG,CAAC;YACvE,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SACjF;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;SAC9C;gBAAS;YACN,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,uBAAuB,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;SAC/B;QAED,IAAI;YACA,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;YAEnF,qBAAqB;YACrB,MAAM,mBAAmB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACzG,IAAI,mBAAmB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC;aACvC;YACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAE9C,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAClF,cAAc,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACxC,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE;aAC3C,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,GAAG,WAAW,CAAC,cAAc,CAAC;YAClF,MAAM,CAAC,kBAAkB,CAAC;gBACtB,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,iBAAiB;gBAC3B,uBAAuB,EAAE,WAAW,CAAC,uBAAuB;gBAC5D,qBAAqB,EAAE,WAAW,CAAC,cAAc;gBACjD,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,MAAM;aACtC,CAAC,CAAC;YAEH,oBAAoB;YACpB,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACrG,IAAI,iBAAiB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACrC,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC;aACxC;YACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC;YAC1C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAE7B,6BAA6B;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAEhF,wBAAwB;YACxB,uBAAuB,mBACnB,eAAe,EAAE,eAAe,EAChC,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAC/C,qBAAqB,EAAE,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,IAC5E,uBAAuB,CAC7B,CAAC;YACF,IAAI,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,EAAE;gBAC3C,IAAI,CAAC,aAAa,CAAC,2BAA2B,EAAE,CAAC;gBACjD,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,cAAc,CAAC,GAAG,iCACX,uBAAuB,KAC1B,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,IACnC,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAE,CAAC,CAAC;aACR;iBAAM;gBACH,gDAAgD;gBAChD,IAAA,qBAAM,EAAC,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC7E,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC;gBACvC,MAAM,OAAO,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC;gBACrC,MAAM,iBAAiB,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC;gBAElD,6CAA6C;gBAC7C,MAAM,KAAK,GAAG,IAAI,8BAAY,CAAC,yBAAyB,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBAE1F,IAAA,qBAAM,EAAC,IAAA,4CAA6B,EAAC,KAAK,CAAC,KAAK,iBAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACpG,iGAAiG;gBACjG,OAAO,IAAI,CACP,aAAa,EACb,KAAK,kCACA,uBAAuB,KAAE,cAAc,EAAE,iBAAiB,KAC/D,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,CAChD,CAAC;aACL;SACJ;gBAAS;YACN,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SAChC;IACL,CAAC;IAEO,qBAAqB,CAAC,IAAY,EAAE,KAAa;QACrD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,kBAAkB;YAC7B,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,KAAK,GAAG,wBAAwB,EAAE;YAClC,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC1B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACJ;AAtRD,4CAsRC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    assert,\n    Deferred,\n    IPromiseTimer,\n    IPromiseTimerResult,\n    Timer,\n} from \"@fluidframework/common-utils\";\nimport { MessageType } from \"@fluidframework/protocol-definitions\";\nimport { PerformanceEvent, LoggingError, ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { getRetryDelaySecondsFromError } from \"@fluidframework/driver-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IAckSummaryResult,\n    INackSummaryResult,\n    ISummarizeOptions,\n    IBroadcastSummaryResult,\n    ISummarizeResults,\n    ISummarizeHeuristicData,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    ISummaryCancellationToken,\n    ISummarizeTelemetryProperties,\n    SummaryGeneratorTelemetry,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher } from \"./summaryCollection\";\n\nexport type raceTimerResult<T> =\n    { result: \"done\"; value: T; } |\n    { result: IPromiseTimerResult[\"timerResult\"]; } |\n    { result: \"cancelled\"; };\n\n/** Helper function to wait for a promise or PromiseTimer to elapse. */\nexport async function raceTimer<T>(\n    promise: Promise<T>,\n    timer: Promise<IPromiseTimerResult>,\n    cancellationToken?: ISummaryCancellationToken,\n): Promise<raceTimerResult<T>> {\n    const promises: Promise<raceTimerResult<T>>[] = [\n        promise.then((value) => ({ result: \"done\", value } as const)),\n        timer.then(({ timerResult: result }) => ({ result } as const)),\n    ];\n    if (cancellationToken !== undefined) {\n        promises.push(cancellationToken.waitCancelled.then(() => ({ result: \"cancelled\" } as const)));\n    }\n    return Promise.race(promises);\n}\n\n// Send some telemetry if generate summary takes too long\nconst maxSummarizeTimeoutTime = 20000; // 20 sec\nconst maxSummarizeTimeoutCount = 5; // Double and resend 5 times\n\nexport type SummarizeReason =\n    /**\n     * Attempt to summarize after idle timeout has elapsed.\n     * Idle timer restarts whenever an op is received. So this\n     * triggers only after some amount of time has passed with\n     * no ops being received.\n     */\n    | \"idle\"\n    /**\n     * Attempt to summarize after a maximum time since last\n     * successful summary has passed. This measures time since\n     * last summary ack op was processed.\n     */\n    | \"maxTime\"\n    /**\n     * Attempt to summarize after a maximum number of ops have\n     * passed since the last successful summary. This compares\n     * op sequence numbers with the reference sequence number\n     * of the summarize op corresponding to the last summary\n     * ack op.\n     */\n    | \"maxOps\"\n    /**\n     * Special case to attempt to summarize one last time before the\n     * summarizer client closes itself. This is to prevent cases where\n     * the summarizer client never gets a chance to summarize, because\n     * there are too many outstanding ops and/or parent client cannot\n     * stay connected long enough for summarizer client to catch up.\n     */\n    | \"lastSummary\"\n    /** On-demand summary requested with specified reason. */\n    | `onDemand;${string}`\n    /** Enqueue summarize attempt with specified reason. */\n    | `enqueue;${string}`;\n\nconst summarizeErrors = {\n    /**\n     * Error encountered while generating the summary tree, uploading\n     * it to storage, or submitting the op. It could be a result of\n     * the client becoming disconnected while generating or an actual error.\n     */\n    submitSummaryFailure: \"Error while generating, uploading, or submitting summary\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving the summarize op\n     * sent by this summarize attempt. It is expected to be broadcast quickly.\n     */\n    summaryOpWaitTimeout: \"Timeout while waiting for summarize op broadcast\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving either a\n     * summaryAck or summaryNack op from the server in response to this\n     * summarize attempt. It is expected that the server should respond.\n     */\n    summaryAckWaitTimeout: \"Timeout while waiting for summaryAck/summaryNack op\",\n    /**\n     * The server responded with a summaryNack op, thus rejecting this\n     * summarize attempt.\n     */\n    summaryNack: \"Server rejected summary via summaryNack op\",\n\n    disconnect: \"Summary cancelled due to summarizer or main client disconnect\",\n} as const;\n\nexport class SummarizeResultBuilder {\n    public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();\n    public readonly summaryOpBroadcasted = new Deferred<SummarizeResultPart<IBroadcastSummaryResult>>();\n    public readonly receivedSummaryAckOrNack =\n        new Deferred<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>();\n\n    public fail(message: string, error: any, nackSummaryResult?: INackSummaryResult, retryAfterSeconds?: number) {\n        assert(!this.receivedSummaryAckOrNack.isCompleted,\n            0x25e /* \"no reason to call fail if all promises have been completed\" */);\n\n        const result: SummarizeResultPart<undefined> =\n            { success: false, message, data: undefined, error, retryAfterSeconds } as const;\n        this.summarySubmitted.resolve(result);\n        this.summaryOpBroadcasted.resolve(result);\n        this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });\n    }\n    public build(): ISummarizeResults {\n        return {\n            summarySubmitted: this.summarySubmitted.promise,\n            summaryOpBroadcasted: this.summaryOpBroadcasted.promise,\n            receivedSummaryAckOrNack: this.receivedSummaryAckOrNack.promise,\n        } as const;\n    }\n}\n\n/**\n * This class generates and tracks a summary attempt.\n */\nexport class SummaryGenerator {\n    private readonly summarizeTimer: Timer;\n    constructor(\n        private readonly pendingAckTimer: IPromiseTimer,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly raiseSummarizingError: (errorMessage: string) => void,\n        private readonly successfulSummaryCallback: () => void,\n        private readonly summaryWatcher: Pick<IClientSummaryWatcher, \"watchSummary\">,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.summarizeTimer = new Timer(\n            maxSummarizeTimeoutTime,\n            () => this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),\n        );\n    }\n\n    /**\n     * Generates summary and listens for broadcast and ack/nack.\n     * Returns true for ack, false for nack, and undefined for failure or timeout.\n     * @param reason - reason for summarizing\n     * @param options - refreshLatestAck to fetch summary ack info from server,\n     * fullTree to generate tree without any summary handles even if unchanged\n     */\n    public summarize(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken: ISummaryCancellationToken,\n        resultsBuilder = new SummarizeResultBuilder(),\n    ): ISummarizeResults {\n        this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken)\n        .catch((error) => {\n            const message = \"UnexpectedSummarizeError\";\n            this.logger.sendErrorEvent({ eventName: message, ...summarizeProps }, error);\n            resultsBuilder.fail(message, error);\n        });\n\n        return resultsBuilder.build();\n    }\n\n    private async summarizeCore(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        resultsBuilder: SummarizeResultBuilder,\n        cancellationToken: ISummaryCancellationToken,\n    ): Promise<void> {\n        const { refreshLatestAck, fullTree } = options;\n        const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });\n\n        // Note: timeSinceLastAttempt and timeSinceLastSummary for the\n        // first summary are basically the time since the summarizer was loaded.\n        const timeSinceLastAttempt = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n        const timeSinceLastSummary = Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;\n        let summarizeTelemetryProps: SummaryGeneratorTelemetry = {\n            fullTree,\n            timeSinceLastAttempt,\n            timeSinceLastSummary,\n        };\n\n        const summarizeEvent = PerformanceEvent.start(logger, {\n            eventName: \"Summarize\",\n            refreshLatestAck,\n            ...summarizeTelemetryProps,\n        });\n\n        // Helper functions to report failures and return.\n        const getFailMessage =\n            (errorCode: keyof typeof summarizeErrors) => `${errorCode}: ${summarizeErrors[errorCode]}`;\n        const fail = (\n            errorCode: keyof typeof summarizeErrors,\n            error?: any,\n            properties?: SummaryGeneratorTelemetry,\n            nackSummaryResult?: INackSummaryResult,\n        ) => {\n            this.raiseSummarizingError(summarizeErrors[errorCode]);\n            // UploadSummary may fail with 429 and retryAfter - respect that\n            // Summary Nack also can have retryAfter, it's parsed below and comes as a property.\n            const retryAfterSeconds = getRetryDelaySecondsFromError(error);\n\n            // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n            // If failure happened on upload, we may not yet realized that socket disconnected, so check\n            // offlineError too.\n            const category = cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError ?\n                \"generic\" : \"error\";\n\n            summarizeEvent.cancel({\n                 ...properties,\n                 reason: errorCode,\n                 category,\n                 retryAfterSeconds,\n            }, error);\n            resultsBuilder.fail(getFailMessage(errorCode), error, nackSummaryResult, retryAfterSeconds);\n        };\n\n        // Wait to generate and send summary\n        this.summarizeTimer.start();\n\n        // Use record type to prevent unexpected value types\n        let summaryData: SubmitSummaryResult | undefined;\n        try {\n            summaryData = await this.submitSummaryCallback({\n                fullTree,\n                refreshLatestAck,\n                summaryLogger: logger,\n                cancellationToken,\n            });\n\n            // Cumulatively add telemetry properties based on how far generateSummary went.\n            const referenceSequenceNumber = summaryData.referenceSequenceNumber;\n            const opsSinceLastSummary =\n                referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;\n            summarizeTelemetryProps = {\n                ...summarizeTelemetryProps,\n                referenceSequenceNumber,\n                minimumSequenceNumber: summaryData.minimumSequenceNumber,\n                opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,\n                opsSinceLastSummary,\n            };\n            if (summaryData.stage !== \"base\") {\n                summarizeTelemetryProps = {\n                    ...summarizeTelemetryProps,\n                    ...summaryData.summaryStats,\n                    generateDuration: summaryData.generateDuration,\n                };\n\n                if (summaryData.stage !== \"generate\") {\n                    summarizeTelemetryProps = {\n                        ...summarizeTelemetryProps,\n                        handle: summaryData.handle,\n                        uploadDuration: summaryData.uploadDuration,\n                    };\n\n                    if (summaryData.stage !== \"upload\") {\n                        summarizeTelemetryProps = {\n                            ...summarizeTelemetryProps,\n                            clientSequenceNumber: summaryData.clientSequenceNumber,\n                        };\n                    }\n                }\n            }\n\n            if (summaryData.stage !== \"submit\") {\n                return fail(\"submitSummaryFailure\", summaryData.error, summarizeTelemetryProps);\n            }\n\n            /**\n             * With incremental summaries, if the full tree was not summarized, only data stores that changed should\n             * be summarized. A data store is considered changed if either or both of the following is true:\n             * - It has received an op.\n             * - Its reference state changed, i.e., it went from referenced to unreferenced or vice-versa.\n             *\n             * In the extreme case, every op can be for a different data store and each op can result in the reference\n             * state change of multiple data stores. So, the total number of data stores that are summarized should not\n             * exceed the number of ops since last summary + number of data store whose reference state changed.\n             */\n            if (!fullTree && !summaryData.forcedFullTree) {\n                const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } = summaryData.summaryStats;\n                if (summarizedDataStoreCount > gcStateUpdatedDataStoreCount + opsSinceLastSummary) {\n                    logger.sendErrorEvent({\n                        eventName: \"IncrementalSummaryViolation\",\n                        summarizedDataStoreCount,\n                        gcStateUpdatedDataStoreCount,\n                        opsSinceLastSummary,\n                    });\n                }\n            }\n\n            // Log event here on summary success only, as Summarize_cancel duplicates failure logging.\n            summarizeEvent.reportEvent(\"generate\", { ...summarizeTelemetryProps });\n            resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });\n        } catch (error) {\n            return fail(\"submitSummaryFailure\", error);\n        } finally {\n            this.heuristicData.recordAttempt(summaryData?.referenceSequenceNumber);\n            this.summarizeTimer.clear();\n        }\n\n        try {\n            const pendingTimeoutP = this.pendingAckTimer.start();\n            const summary = this.summaryWatcher.watchSummary(summaryData.clientSequenceNumber);\n\n            // Wait for broadcast\n            const waitBroadcastResult = await raceTimer(summary.waitBroadcast(), pendingTimeoutP, cancellationToken);\n            if (waitBroadcastResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitBroadcastResult.result !== \"done\") {\n                return fail(\"summaryOpWaitTimeout\");\n            }\n            const summarizeOp = waitBroadcastResult.value;\n\n            const broadcastDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n            resultsBuilder.summaryOpBroadcasted.resolve({\n                success: true,\n                data: { summarizeOp, broadcastDuration },\n            });\n\n            this.heuristicData.lastAttempt.summarySequenceNumber = summarizeOp.sequenceNumber;\n            logger.sendTelemetryEvent({\n                eventName: \"Summarize_Op\",\n                duration: broadcastDuration,\n                referenceSequenceNumber: summarizeOp.referenceSequenceNumber,\n                summarySequenceNumber: summarizeOp.sequenceNumber,\n                handle: summarizeOp.contents.handle,\n            });\n\n            // Wait for ack/nack\n            const waitAckNackResult = await raceTimer(summary.waitAckNack(), pendingTimeoutP, cancellationToken);\n            if (waitAckNackResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitAckNackResult.result !== \"done\") {\n                return fail(\"summaryAckWaitTimeout\");\n            }\n            const ackNackOp = waitAckNackResult.value;\n            this.pendingAckTimer.clear();\n\n            // Update for success/failure\n            const ackNackDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n\n            // adding new properties\n            summarizeTelemetryProps = {\n                ackWaitDuration: ackNackDuration,\n                ackNackSequenceNumber: ackNackOp.sequenceNumber,\n                summarySequenceNumber: ackNackOp.contents.summaryProposal.summarySequenceNumber,\n                ...summarizeTelemetryProps,\n            };\n            if (ackNackOp.type === MessageType.SummaryAck) {\n                this.heuristicData.markLastAttemptAsSuccessful();\n                this.successfulSummaryCallback();\n                summarizeEvent.end({\n                    ...summarizeTelemetryProps,\n                    handle: ackNackOp.contents.handle,\n                });\n                resultsBuilder.receivedSummaryAckOrNack.resolve({ success: true, data: {\n                    summaryAckOp: ackNackOp,\n                    ackNackDuration,\n                } });\n            } else {\n                // Check for retryDelay in summaryNack response.\n                assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* \"type check\" */);\n                const summaryNack = ackNackOp.contents;\n                const message = summaryNack?.message;\n                const retryAfterSeconds = summaryNack?.retryAfter;\n\n                // pre-0.58 error message prefix: summaryNack\n                const error = new LoggingError(`Received summaryNack: ${message}`, { retryAfterSeconds });\n\n                assert(getRetryDelaySecondsFromError(error) === retryAfterSeconds, 0x25f /* \"retryAfterSeconds\" */);\n                // This will only set resultsBuilder.receivedSummaryAckOrNack, as other promises are already set.\n                return fail(\n                    \"summaryNack\",\n                    error,\n                    { ...summarizeTelemetryProps, nackRetryAfter: retryAfterSeconds },\n                    { summaryNackOp: ackNackOp, ackNackDuration },\n                );\n            }\n        } finally {\n            this.pendingAckTimer.clear();\n        }\n    }\n\n    private summarizeTimerHandler(time: number, count: number) {\n        this.logger.sendPerformanceEvent({\n            eventName: \"SummarizeTimeout\",\n            timeoutTime: time,\n            timeoutCount: count,\n        });\n        if (count < maxSummarizeTimeoutCount) {\n            // Double and start a new timer\n            const nextTime = time * 2;\n            this.summarizeTimer.start(nextTime, () => this.summarizeTimerHandler(nextTime, count + 1));\n        }\n    }\n\n    public dispose() {\n        this.summarizeTimer.clear();\n    }\n}\n"]}
+{"version":3,"file":"summaryGenerator.js","sourceRoot":"","sources":["../src/summaryGenerator.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,+DAMsC;AACtC,+EAAmE;AACnE,qEAA8F;AAC9F,+DAA6E;AAC7E,2EAAqE;AAsBrE,uEAAuE;AAChE,KAAK,UAAU,SAAS,CAC3B,OAAmB,EACnB,KAAmC,EACnC,iBAA6C;IAE7C,MAAM,QAAQ,GAAkC;QAC5C,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAY,CAAA,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAY,CAAA,CAAC;KACjE,CAAC;IACF,IAAI,iBAAiB,KAAK,SAAS,EAAE;QACjC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAY,CAAA,CAAC,CAAC,CAAC;KACjG;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAClC,CAAC;AAbD,8BAaC;AAED,yDAAyD;AACzD,MAAM,uBAAuB,GAAG,KAAK,CAAC,CAAC,SAAS;AAChD,MAAM,wBAAwB,GAAG,CAAC,CAAC,CAAC,4BAA4B;AAqChE,MAAM,eAAe,GAAG;IACpB;;;;OAIG;IACH,oBAAoB,EAAE,0DAA0D;IAChF;;;OAGG;IACH,oBAAoB,EAAE,kDAAkD;IACxE;;;;OAIG;IACH,qBAAqB,EAAE,qDAAqD;IAC5E;;;OAGG;IACH,WAAW,EAAE,4CAA4C;IAEzD,UAAU,EAAE,+DAA+D;CACrE,CAAC;AAEX,MAAa,sBAAsB;IAAnC;QACoB,qBAAgB,GAAG,IAAI,uBAAQ,EAA4C,CAAC;QAC5E,yBAAoB,GAAG,IAAI,uBAAQ,EAAgD,CAAC;QACpF,6BAAwB,GACpC,IAAI,uBAAQ,EAA8D,CAAC;IAmBnF,CAAC;IAjBU,IAAI,CAAC,OAAe,EAAE,KAAU,EAAE,iBAAsC,EAAE,iBAA0B;QACvG,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,WAAW,EAC7C,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAE9E,MAAM,MAAM,GACR,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,EAAW,CAAC;QACpF,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,wBAAwB,CAAC,OAAO,iCAAM,MAAM,KAAE,IAAI,EAAE,iBAAiB,IAAG,CAAC;IAClF,CAAC;IACM,KAAK;QACR,OAAO;YACH,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO;YAC/C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO;YACvD,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,OAAO;SACzD,CAAC;IACf,CAAC;CACJ;AAvBD,wDAuBC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAEzB,YACqB,eAA8B,EAC9B,aAAsC,EACtC,qBAAuF,EACvF,qBAAqD,EACrD,yBAAqC,EACrC,cAA2D,EAC3D,MAAwB;QANxB,oBAAe,GAAf,eAAe,CAAe;QAC9B,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,0BAAqB,GAArB,qBAAqB,CAAgC;QACrD,8BAAyB,GAAzB,yBAAyB,CAAY;QACrC,mBAAc,GAAd,cAAc,CAA6C;QAC3D,WAAM,GAAN,MAAM,CAAkB;QAEzC,IAAI,CAAC,cAAc,GAAG,IAAI,oBAAK,CAC3B,uBAAuB,EACvB,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAC/D,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CACZ,cAA6C,EAC7C,OAA0B,EAC1B,iBAA4C,EAC5C,cAAc,GAAG,IAAI,sBAAsB,EAAE;QAE7C,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC;aAC7E,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,OAAO,GAAG,0BAA0B,CAAC;YAC3C,IAAI,CAAC,MAAM,CAAC,cAAc,iBAAG,SAAS,EAAE,OAAO,IAAK,cAAc,GAAI,KAAK,CAAC,CAAC;YAC7E,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,aAAa,CACvB,cAA6C,EAC7C,OAA0B,EAC1B,cAAsC,EACtC,iBAA4C;QAE5C,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAC/C,MAAM,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAEnF,8DAA8D;QAC9D,wEAAwE;QACxE,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QACrF,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,CAAC;QAC/F,IAAI,uBAAuB,GAA8B;YACrD,QAAQ;YACR,oBAAoB;YACpB,oBAAoB;SACvB,CAAC;QAEF,MAAM,cAAc,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBAChD,SAAS,EAAE,WAAW,EACtB,gBAAgB,IACb,uBAAuB,EAC5B,CAAC;QAEH,kDAAkD;QAClD,MAAM,cAAc,GAChB,CAAC,SAAuC,EAAE,EAAE,CAAC,GAAG,SAAS,KAAK,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,GAAG,CACT,SAAuC,EACvC,KAAW,EACX,UAAsC,EACtC,iBAAsC,EACxC,EAAE;YACA,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;YACvD,gEAAgE;YAChE,oFAAoF;YACpF,MAAM,iBAAiB,GAAG,IAAA,4CAA6B,EAAC,KAAK,CAAC,CAAC;YAE/D,+FAA+F;YAC/F,4FAA4F;YAC5F,oBAAoB;YACpB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,SAAS,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAK,oCAAe,CAAC,YAAY,CAAC,CAAC;gBAC/F,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;YAExB,cAAc,CAAC,MAAM,iCACb,UAAU,KACb,MAAM,EAAE,SAAS,EACjB,QAAQ;gBACR,iBAAiB,KACnB,KAAK,CAAC,CAAC;YACV,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;QAChG,CAAC,CAAC;QAEF,oCAAoC;QACpC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,oDAAoD;QACpD,IAAI,WAA4C,CAAC;QACjD,IAAI;YACA,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC;gBAC3C,QAAQ;gBACR,gBAAgB;gBAChB,aAAa,EAAE,MAAM;gBACrB,iBAAiB;aACpB,CAAC,CAAC;YAEH,+EAA+E;YAC/E,MAAM,uBAAuB,GAAG,WAAW,CAAC,uBAAuB,CAAC;YACpE,MAAM,mBAAmB,GACrB,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;YACzF,uBAAuB,mCAChB,uBAAuB,KAC1B,uBAAuB,EACvB,qBAAqB,EAAE,WAAW,CAAC,qBAAqB,EACxD,mBAAmB,EAAE,uBAAuB,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,EAC/F,mBAAmB,GACtB,CAAC;YACF,uBAAuB,GAAG,IAAI,CAAC,8BAA8B,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;YAEpG,IAAI,WAAW,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAChC,OAAO,IAAI,CAAC,sBAAsB,EAAE,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;aACnF;YAED;;;;;;;;;eASG;YACH,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE;gBAC1C,MAAM,EAAE,wBAAwB,EAAE,4BAA4B,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,YAAY,CAAC;gBAChG,IAAI,wBAAwB,GAAG,4BAA4B,GAAG,mBAAmB,EAAE;oBAC/E,MAAM,CAAC,cAAc,CAAC;wBAClB,SAAS,EAAE,6BAA6B;wBACxC,wBAAwB;wBACxB,4BAA4B;wBAC5B,mBAAmB;qBACtB,CAAC,CAAC;iBACN;aACJ;YAED,0FAA0F;YAC1F,cAAc,CAAC,WAAW,CAAC,UAAU,oBAAO,uBAAuB,EAAG,CAAC;YACvE,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SACjF;QAAC,OAAO,KAAK,EAAE;YACZ,OAAO,IAAI,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;SAC9C;gBAAS;YACN,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,uBAAuB,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;SAC/B;QAED,IAAI;YACA,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;YAEnF,qBAAqB;YACrB,MAAM,mBAAmB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACzG,IAAI,mBAAmB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,mBAAmB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACvC,OAAO,IAAI,CAAC,sBAAsB,CAAC,CAAC;aACvC;YACD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,CAAC;YAE9C,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAClF,cAAc,CAAC,oBAAoB,CAAC,OAAO,CAAC;gBACxC,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE;aAC3C,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB,GAAG,WAAW,CAAC,cAAc,CAAC;YAClF,MAAM,CAAC,kBAAkB,CAAC;gBACtB,SAAS,EAAE,cAAc;gBACzB,QAAQ,EAAE,iBAAiB;gBAC3B,uBAAuB,EAAE,WAAW,CAAC,uBAAuB;gBAC5D,qBAAqB,EAAE,WAAW,CAAC,cAAc;gBACjD,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,MAAM;aACtC,CAAC,CAAC;YAEH,oBAAoB;YACpB,MAAM,iBAAiB,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;YACrG,IAAI,iBAAiB,CAAC,MAAM,KAAK,WAAW,EAAE;gBAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;aAC7B;YACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,MAAM,EAAE;gBACrC,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC;aACxC;YACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,KAAK,CAAC;YAC1C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAE7B,6BAA6B;YAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;YAEhF,wBAAwB;YACxB,uBAAuB,mBACnB,eAAe,EAAE,eAAe,EAChC,qBAAqB,EAAE,SAAS,CAAC,cAAc,EAC/C,qBAAqB,EAAE,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,IAC5E,uBAAuB,CAC7B,CAAC;YACF,IAAI,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,UAAU,EAAE;gBAC3C,IAAI,CAAC,aAAa,CAAC,2BAA2B,EAAE,CAAC;gBACjD,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACjC,cAAc,CAAC,GAAG,iCACX,uBAAuB,KAC1B,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,IACnC,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAE,CAAC,CAAC;aACR;iBAAM;gBACH,gDAAgD;gBAChD,IAAA,qBAAM,EAAC,SAAS,CAAC,IAAI,KAAK,kCAAW,CAAC,WAAW,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC7E,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC;gBACvC,MAAM,OAAO,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC;gBACrC,MAAM,iBAAiB,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC;gBAElD,6CAA6C;gBAC7C,MAAM,KAAK,GAAG,IAAI,8BAAY,CAAC,yBAAyB,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;gBAE1F,IAAA,qBAAM,EAAC,IAAA,4CAA6B,EAAC,KAAK,CAAC,KAAK,iBAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;gBACpG,iGAAiG;gBACjG,OAAO,IAAI,CACP,aAAa,EACb,KAAK,kCACA,uBAAuB,KAAE,cAAc,EAAE,iBAAiB,KAC/D,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,CAChD,CAAC;aACL;SACJ;gBAAS;YACN,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;SAChC;IACL,CAAC;IAEO,8BAA8B,CAClC,WAAgC,EAChC,YAAuC;QAEvC,QAAQ,WAAW,CAAC,KAAK,EAAE;YACvB,KAAK,MAAM,CAAC,CAAC,OAAO,YAAY,CAAC;YAEjC,KAAK,UAAU,CAAC,CAAC,qDACV,YAAY,GACZ,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,IAChD;YAEF,KAAK,QAAQ,CAAC,CAAC,qDACR,YAAY,GACZ,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,EAC9C,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,cAAc,EAAE,WAAW,CAAC,cAAc,IAC5C;YAEF,KAAK,QAAQ,CAAC,CAAC,qDACR,YAAY,GACZ,WAAW,CAAC,YAAY,KAC3B,gBAAgB,EAAE,WAAW,CAAC,gBAAgB,EAC9C,MAAM,EAAE,WAAW,CAAC,MAAM,EAC1B,cAAc,EAAE,WAAW,CAAC,cAAc,EAC1C,oBAAoB,EAAE,WAAW,CAAC,oBAAoB,EACtD,gBAAgB,EAAE,IAAI,CAAC,aAAa,CAAC,gBAAgB,EACrD,wBAAwB,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,EACzD,6BAA6B,EAAE,IAAI,CAAC,aAAa,CAAC,gBAAgB,IACpE;YAEF,OAAO,CAAC,CAAC,IAAA,qBAAM,EAAC,IAAI,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;SAC/D;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;IAEO,qBAAqB,CAAC,IAAY,EAAE,KAAa;QACrD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;YAC7B,SAAS,EAAE,kBAAkB;YAC7B,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,KAAK;SACtB,CAAC,CAAC;QACH,IAAI,KAAK,GAAG,wBAAwB,EAAE;YAClC,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC;YAC1B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;SAC9F;IACL,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;CACJ;AAxSD,4CAwSC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport {\n    assert,\n    Deferred,\n    IPromiseTimer,\n    IPromiseTimerResult,\n    Timer,\n} from \"@fluidframework/common-utils\";\nimport { MessageType } from \"@fluidframework/protocol-definitions\";\nimport { PerformanceEvent, LoggingError, ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { getRetryDelaySecondsFromError } from \"@fluidframework/driver-utils\";\nimport { DriverErrorType } from \"@fluidframework/driver-definitions\";\nimport {\n    IAckSummaryResult,\n    INackSummaryResult,\n    ISummarizeOptions,\n    IBroadcastSummaryResult,\n    ISummarizeResults,\n    ISummarizeHeuristicData,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    SummarizeResultPart,\n    ISummaryCancellationToken,\n    ISummarizeTelemetryProperties,\n    SummaryGeneratorTelemetry,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher } from \"./summaryCollection\";\n\nexport type raceTimerResult<T> =\n    { result: \"done\"; value: T; } |\n    { result: IPromiseTimerResult[\"timerResult\"]; } |\n    { result: \"cancelled\"; };\n\n/** Helper function to wait for a promise or PromiseTimer to elapse. */\nexport async function raceTimer<T>(\n    promise: Promise<T>,\n    timer: Promise<IPromiseTimerResult>,\n    cancellationToken?: ISummaryCancellationToken,\n): Promise<raceTimerResult<T>> {\n    const promises: Promise<raceTimerResult<T>>[] = [\n        promise.then((value) => ({ result: \"done\", value } as const)),\n        timer.then(({ timerResult: result }) => ({ result } as const)),\n    ];\n    if (cancellationToken !== undefined) {\n        promises.push(cancellationToken.waitCancelled.then(() => ({ result: \"cancelled\" } as const)));\n    }\n    return Promise.race(promises);\n}\n\n// Send some telemetry if generate summary takes too long\nconst maxSummarizeTimeoutTime = 20000; // 20 sec\nconst maxSummarizeTimeoutCount = 5; // Double and resend 5 times\n\nexport type SummarizeReason =\n    /**\n     * Attempt to summarize after idle timeout has elapsed.\n     * Idle timer restarts whenever an op is received. So this\n     * triggers only after some amount of time has passed with\n     * no ops being received.\n     */\n    | \"idle\"\n    /**\n     * Attempt to summarize after a maximum time since last\n     * successful summary has passed. This measures time since\n     * last summary ack op was processed.\n     */\n    | \"maxTime\"\n    /**\n     * Attempt to summarize after a maximum number of ops have\n     * passed since the last successful summary. This compares\n     * op sequence numbers with the reference sequence number\n     * of the summarize op corresponding to the last summary\n     * ack op.\n     */\n    | \"maxOps\"\n    /**\n     * Special case to attempt to summarize one last time before the\n     * summarizer client closes itself. This is to prevent cases where\n     * the summarizer client never gets a chance to summarize, because\n     * there are too many outstanding ops and/or parent client cannot\n     * stay connected long enough for summarizer client to catch up.\n     */\n    | \"lastSummary\"\n    /** On-demand summary requested with specified reason. */\n    | `onDemand;${string}`\n    /** Enqueue summarize attempt with specified reason. */\n    | `enqueue;${string}`;\n\nconst summarizeErrors = {\n    /**\n     * Error encountered while generating the summary tree, uploading\n     * it to storage, or submitting the op. It could be a result of\n     * the client becoming disconnected while generating or an actual error.\n     */\n    submitSummaryFailure: \"Error while generating, uploading, or submitting summary\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving the summarize op\n     * sent by this summarize attempt. It is expected to be broadcast quickly.\n     */\n    summaryOpWaitTimeout: \"Timeout while waiting for summarize op broadcast\",\n    /**\n     * The summaryAckWaitTimeout time has elapsed before receiving either a\n     * summaryAck or summaryNack op from the server in response to this\n     * summarize attempt. It is expected that the server should respond.\n     */\n    summaryAckWaitTimeout: \"Timeout while waiting for summaryAck/summaryNack op\",\n    /**\n     * The server responded with a summaryNack op, thus rejecting this\n     * summarize attempt.\n     */\n    summaryNack: \"Server rejected summary via summaryNack op\",\n\n    disconnect: \"Summary cancelled due to summarizer or main client disconnect\",\n} as const;\n\nexport class SummarizeResultBuilder {\n    public readonly summarySubmitted = new Deferred<SummarizeResultPart<SubmitSummaryResult>>();\n    public readonly summaryOpBroadcasted = new Deferred<SummarizeResultPart<IBroadcastSummaryResult>>();\n    public readonly receivedSummaryAckOrNack =\n        new Deferred<SummarizeResultPart<IAckSummaryResult, INackSummaryResult>>();\n\n    public fail(message: string, error: any, nackSummaryResult?: INackSummaryResult, retryAfterSeconds?: number) {\n        assert(!this.receivedSummaryAckOrNack.isCompleted,\n            0x25e /* \"no reason to call fail if all promises have been completed\" */);\n\n        const result: SummarizeResultPart<undefined> =\n            { success: false, message, data: undefined, error, retryAfterSeconds } as const;\n        this.summarySubmitted.resolve(result);\n        this.summaryOpBroadcasted.resolve(result);\n        this.receivedSummaryAckOrNack.resolve({ ...result, data: nackSummaryResult });\n    }\n    public build(): ISummarizeResults {\n        return {\n            summarySubmitted: this.summarySubmitted.promise,\n            summaryOpBroadcasted: this.summaryOpBroadcasted.promise,\n            receivedSummaryAckOrNack: this.receivedSummaryAckOrNack.promise,\n        } as const;\n    }\n}\n\n/**\n * This class generates and tracks a summary attempt.\n */\nexport class SummaryGenerator {\n    private readonly summarizeTimer: Timer;\n    constructor(\n        private readonly pendingAckTimer: IPromiseTimer,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly raiseSummarizingError: (errorMessage: string) => void,\n        private readonly successfulSummaryCallback: () => void,\n        private readonly summaryWatcher: Pick<IClientSummaryWatcher, \"watchSummary\">,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.summarizeTimer = new Timer(\n            maxSummarizeTimeoutTime,\n            () => this.summarizeTimerHandler(maxSummarizeTimeoutTime, 1),\n        );\n    }\n\n    /**\n     * Generates summary and listens for broadcast and ack/nack.\n     * Returns true for ack, false for nack, and undefined for failure or timeout.\n     * @param reason - reason for summarizing\n     * @param options - refreshLatestAck to fetch summary ack info from server,\n     * fullTree to generate tree without any summary handles even if unchanged\n     */\n    public summarize(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken: ISummaryCancellationToken,\n        resultsBuilder = new SummarizeResultBuilder(),\n    ): ISummarizeResults {\n        this.summarizeCore(summarizeProps, options, resultsBuilder, cancellationToken)\n        .catch((error) => {\n            const message = \"UnexpectedSummarizeError\";\n            this.logger.sendErrorEvent({ eventName: message, ...summarizeProps }, error);\n            resultsBuilder.fail(message, error);\n        });\n\n        return resultsBuilder.build();\n    }\n\n    private async summarizeCore(\n        summarizeProps: ISummarizeTelemetryProperties,\n        options: ISummarizeOptions,\n        resultsBuilder: SummarizeResultBuilder,\n        cancellationToken: ISummaryCancellationToken,\n    ): Promise<void> {\n        const { refreshLatestAck, fullTree } = options;\n        const logger = ChildLogger.create(this.logger, undefined, { all: summarizeProps });\n\n        // Note: timeSinceLastAttempt and timeSinceLastSummary for the\n        // first summary are basically the time since the summarizer was loaded.\n        const timeSinceLastAttempt = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n        const timeSinceLastSummary = Date.now() - this.heuristicData.lastSuccessfulSummary.summaryTime;\n        let summarizeTelemetryProps: SummaryGeneratorTelemetry = {\n            fullTree,\n            timeSinceLastAttempt,\n            timeSinceLastSummary,\n        };\n\n        const summarizeEvent = PerformanceEvent.start(logger, {\n            eventName: \"Summarize\",\n            refreshLatestAck,\n            ...summarizeTelemetryProps,\n        });\n\n        // Helper functions to report failures and return.\n        const getFailMessage =\n            (errorCode: keyof typeof summarizeErrors) => `${errorCode}: ${summarizeErrors[errorCode]}`;\n        const fail = (\n            errorCode: keyof typeof summarizeErrors,\n            error?: any,\n            properties?: SummaryGeneratorTelemetry,\n            nackSummaryResult?: INackSummaryResult,\n        ) => {\n            this.raiseSummarizingError(summarizeErrors[errorCode]);\n            // UploadSummary may fail with 429 and retryAfter - respect that\n            // Summary Nack also can have retryAfter, it's parsed below and comes as a property.\n            const retryAfterSeconds = getRetryDelaySecondsFromError(error);\n\n            // Report any failure as an error unless it was due to cancellation (like \"disconnected\" error)\n            // If failure happened on upload, we may not yet realized that socket disconnected, so check\n            // offlineError too.\n            const category = cancellationToken.cancelled || error?.errorType === DriverErrorType.offlineError ?\n                \"generic\" : \"error\";\n\n            summarizeEvent.cancel({\n                 ...properties,\n                 reason: errorCode,\n                 category,\n                 retryAfterSeconds,\n            }, error);\n            resultsBuilder.fail(getFailMessage(errorCode), error, nackSummaryResult, retryAfterSeconds);\n        };\n\n        // Wait to generate and send summary\n        this.summarizeTimer.start();\n\n        // Use record type to prevent unexpected value types\n        let summaryData: SubmitSummaryResult | undefined;\n        try {\n            summaryData = await this.submitSummaryCallback({\n                fullTree,\n                refreshLatestAck,\n                summaryLogger: logger,\n                cancellationToken,\n            });\n\n            // Cumulatively add telemetry properties based on how far generateSummary went.\n            const referenceSequenceNumber = summaryData.referenceSequenceNumber;\n            const opsSinceLastSummary =\n                referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;\n            summarizeTelemetryProps = {\n                ...summarizeTelemetryProps,\n                referenceSequenceNumber,\n                minimumSequenceNumber: summaryData.minimumSequenceNumber,\n                opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber,\n                opsSinceLastSummary,\n            };\n            summarizeTelemetryProps = this.addSummaryDataToTelemetryProps(summaryData, summarizeTelemetryProps);\n\n            if (summaryData.stage !== \"submit\") {\n                return fail(\"submitSummaryFailure\", summaryData.error, summarizeTelemetryProps);\n            }\n\n            /**\n             * With incremental summaries, if the full tree was not summarized, only data stores that changed should\n             * be summarized. A data store is considered changed if either or both of the following is true:\n             * - It has received an op.\n             * - Its reference state changed, i.e., it went from referenced to unreferenced or vice-versa.\n             *\n             * In the extreme case, every op can be for a different data store and each op can result in the reference\n             * state change of multiple data stores. So, the total number of data stores that are summarized should not\n             * exceed the number of ops since last summary + number of data store whose reference state changed.\n             */\n            if (!fullTree && !summaryData.forcedFullTree) {\n                const { summarizedDataStoreCount, gcStateUpdatedDataStoreCount = 0 } = summaryData.summaryStats;\n                if (summarizedDataStoreCount > gcStateUpdatedDataStoreCount + opsSinceLastSummary) {\n                    logger.sendErrorEvent({\n                        eventName: \"IncrementalSummaryViolation\",\n                        summarizedDataStoreCount,\n                        gcStateUpdatedDataStoreCount,\n                        opsSinceLastSummary,\n                    });\n                }\n            }\n\n            // Log event here on summary success only, as Summarize_cancel duplicates failure logging.\n            summarizeEvent.reportEvent(\"generate\", { ...summarizeTelemetryProps });\n            resultsBuilder.summarySubmitted.resolve({ success: true, data: summaryData });\n        } catch (error) {\n            return fail(\"submitSummaryFailure\", error);\n        } finally {\n            this.heuristicData.recordAttempt(summaryData?.referenceSequenceNumber);\n            this.summarizeTimer.clear();\n        }\n\n        try {\n            const pendingTimeoutP = this.pendingAckTimer.start();\n            const summary = this.summaryWatcher.watchSummary(summaryData.clientSequenceNumber);\n\n            // Wait for broadcast\n            const waitBroadcastResult = await raceTimer(summary.waitBroadcast(), pendingTimeoutP, cancellationToken);\n            if (waitBroadcastResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitBroadcastResult.result !== \"done\") {\n                return fail(\"summaryOpWaitTimeout\");\n            }\n            const summarizeOp = waitBroadcastResult.value;\n\n            const broadcastDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n            resultsBuilder.summaryOpBroadcasted.resolve({\n                success: true,\n                data: { summarizeOp, broadcastDuration },\n            });\n\n            this.heuristicData.lastAttempt.summarySequenceNumber = summarizeOp.sequenceNumber;\n            logger.sendTelemetryEvent({\n                eventName: \"Summarize_Op\",\n                duration: broadcastDuration,\n                referenceSequenceNumber: summarizeOp.referenceSequenceNumber,\n                summarySequenceNumber: summarizeOp.sequenceNumber,\n                handle: summarizeOp.contents.handle,\n            });\n\n            // Wait for ack/nack\n            const waitAckNackResult = await raceTimer(summary.waitAckNack(), pendingTimeoutP, cancellationToken);\n            if (waitAckNackResult.result === \"cancelled\") {\n                return fail(\"disconnect\");\n            }\n            if (waitAckNackResult.result !== \"done\") {\n                return fail(\"summaryAckWaitTimeout\");\n            }\n            const ackNackOp = waitAckNackResult.value;\n            this.pendingAckTimer.clear();\n\n            // Update for success/failure\n            const ackNackDuration = Date.now() - this.heuristicData.lastAttempt.summaryTime;\n\n            // adding new properties\n            summarizeTelemetryProps = {\n                ackWaitDuration: ackNackDuration,\n                ackNackSequenceNumber: ackNackOp.sequenceNumber,\n                summarySequenceNumber: ackNackOp.contents.summaryProposal.summarySequenceNumber,\n                ...summarizeTelemetryProps,\n            };\n            if (ackNackOp.type === MessageType.SummaryAck) {\n                this.heuristicData.markLastAttemptAsSuccessful();\n                this.successfulSummaryCallback();\n                summarizeEvent.end({\n                    ...summarizeTelemetryProps,\n                    handle: ackNackOp.contents.handle,\n                });\n                resultsBuilder.receivedSummaryAckOrNack.resolve({ success: true, data: {\n                    summaryAckOp: ackNackOp,\n                    ackNackDuration,\n                } });\n            } else {\n                // Check for retryDelay in summaryNack response.\n                assert(ackNackOp.type === MessageType.SummaryNack, 0x274 /* \"type check\" */);\n                const summaryNack = ackNackOp.contents;\n                const message = summaryNack?.message;\n                const retryAfterSeconds = summaryNack?.retryAfter;\n\n                // pre-0.58 error message prefix: summaryNack\n                const error = new LoggingError(`Received summaryNack: ${message}`, { retryAfterSeconds });\n\n                assert(getRetryDelaySecondsFromError(error) === retryAfterSeconds, 0x25f /* \"retryAfterSeconds\" */);\n                // This will only set resultsBuilder.receivedSummaryAckOrNack, as other promises are already set.\n                return fail(\n                    \"summaryNack\",\n                    error,\n                    { ...summarizeTelemetryProps, nackRetryAfter: retryAfterSeconds },\n                    { summaryNackOp: ackNackOp, ackNackDuration },\n                );\n            }\n        } finally {\n            this.pendingAckTimer.clear();\n        }\n    }\n\n    private addSummaryDataToTelemetryProps(\n        summaryData: SubmitSummaryResult,\n        initialProps: SummaryGeneratorTelemetry,\n    ): SummaryGeneratorTelemetry {\n        switch (summaryData.stage) {\n            case \"base\": return initialProps;\n\n            case \"generate\": return {\n                ...initialProps,\n                ...summaryData.summaryStats,\n                generateDuration: summaryData.generateDuration,\n            };\n\n            case \"upload\": return {\n                ...initialProps,\n                ...summaryData.summaryStats,\n                generateDuration: summaryData.generateDuration,\n                handle: summaryData.handle,\n                uploadDuration: summaryData.uploadDuration,\n            };\n\n            case \"submit\": return {\n                ...initialProps,\n                ...summaryData.summaryStats,\n                generateDuration: summaryData.generateDuration,\n                handle: summaryData.handle,\n                uploadDuration: summaryData.uploadDuration,\n                clientSequenceNumber: summaryData.clientSequenceNumber,\n                hasMissingOpData: this.heuristicData.hasMissingOpData,\n                opsSizesSinceLastSummary: this.heuristicData.totalOpsSize,\n                nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps,\n            };\n\n            default: assert(true, 0x397 /* Unexpected summary stage */);\n        }\n\n        return initialProps;\n    }\n\n    private summarizeTimerHandler(time: number, count: number) {\n        this.logger.sendPerformanceEvent({\n            eventName: \"SummarizeTimeout\",\n            timeoutTime: time,\n            timeoutCount: count,\n        });\n        if (count < maxSummarizeTimeoutCount) {\n            // Double and start a new timer\n            const nextTime = time * 2;\n            this.summarizeTimer.start(nextTime, () => this.summarizeTimerHandler(nextTime, count + 1));\n        }\n    }\n\n    public dispose() {\n        this.summarizeTimer.clear();\n    }\n}\n"]}

package/lib/batchTracker.js

@@ -18,7 +18,7 @@ export class BatchTracker {
             assert(this.startBatchSequenceNumber !== undefined && this.batchProcessingStartTimeStamp !== undefined, 0x2ba /* "batchBegin must fire before batchEnd" */);
             const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;
             if (length >= batchLengthThreshold) {
-                this.logger.sendErrorEvent({
+                this.logger.sendPerformanceEvent({
                     eventName: "LengthTooBig",
                     length,
                     threshold: batchLengthThreshold,

package/lib/batchTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"batchTracker.js","sourceRoot":"","sources":["../src/batchTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D,MAAM,OAAO,YAAY;IAMrB,YACqB,iBAA+B,EAChD,MAAwB,EACxB,oBAA4B,EAC5B,sBAA8B,EAC9B,mBAAiC,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE;QAJvC,sBAAiB,GAAjB,iBAAiB,CAAc;QAJ5C,sBAAiB,GAAW,CAAC,CAAC;QAUlC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC3E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;YACvD,IAAI,CAAC,6BAA6B,GAAG,gBAAgB,EAAE,CAAC;YACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAsB,EAAE,OAAkC,EAAE,EAAE;YACjG,MAAM,CACF,IAAI,CAAC,wBAAwB,KAAK,SAAS,IAAI,IAAI,CAAC,6BAA6B,KAAK,SAAS,EAC/F,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAExD,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,GAAG,CAAC,CAAC;YAC1E,IAAI,MAAM,IAAI,oBAAoB,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;oBACvB,SAAS,EAAE,cAAc;oBACzB,MAAM;oBACN,SAAS,EAAE,oBAAoB;oBAC/B,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;oBACjE,UAAU,EAAE,KAAK,KAAK,SAAS;iBAClC,CAAC,CAAC;aACN;YAED,IAAI,IAAI,CAAC,iBAAiB,GAAG,sBAAsB,KAAK,CAAC,EAAE;gBACvD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,QAAQ;oBACnB,MAAM;oBACN,YAAY,EAAE,sBAAsB;oBACpC,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;iBACpE,CAAC,CAAC;aACN;YAED,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,6BAA6B,GAAG,SAAS,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,iBAA+B,EAC/B,MAAwB,EACxB,uBAA+B,IAAI,EACnC,yBAAiC,IAAI,EACvC,EAAE,CAAC,IAAI,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport EventEmitter from \"events\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\n\nexport class BatchTracker {\n    private readonly logger: ITelemetryLogger;\n    private startBatchSequenceNumber: number | undefined;\n    private trackedBatchCount: number = 0;\n    private batchProcessingStartTimeStamp: number | undefined;\n\n    constructor(\n        private readonly batchEventEmitter: EventEmitter,\n        logger: ITelemetryLogger,\n        batchLengthThreshold: number,\n        batchCountSamplingRate: number,\n        dateTimeProvider: () => number = () => performance.now(),\n    ) {\n        this.logger = ChildLogger.create(logger, \"Batching\");\n\n        this.batchEventEmitter.on(\"batchBegin\", (message: ISequencedDocumentMessage) => {\n            this.startBatchSequenceNumber = message.sequenceNumber;\n            this.batchProcessingStartTimeStamp = dateTimeProvider();\n            this.trackedBatchCount++;\n        });\n\n        this.batchEventEmitter.on(\"batchEnd\", (error: any | undefined, message: ISequencedDocumentMessage) => {\n            assert(\n                this.startBatchSequenceNumber !== undefined && this.batchProcessingStartTimeStamp !== undefined,\n                0x2ba /* \"batchBegin must fire before batchEnd\" */);\n\n            const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;\n            if (length >= batchLengthThreshold) {\n                this.logger.sendErrorEvent({\n                    eventName: \"LengthTooBig\",\n                    length,\n                    threshold: batchLengthThreshold,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                    batchError: error !== undefined,\n                });\n            }\n\n            if (this.trackedBatchCount % batchCountSamplingRate === 0) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"Length\",\n                    length,\n                    samplingRate: batchCountSamplingRate,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                });\n            }\n\n            this.startBatchSequenceNumber = undefined;\n            this.batchProcessingStartTimeStamp = undefined;\n        });\n    }\n}\n\n/**\n * Track batch sizes in terms of op counts and processing times\n *\n * @param batchEventEmitter - event emitter which tracks the lifecycle of batch operations\n * @param logger - logger\n * @param batchLengthThreshold - threshold for the length of a batch when to send an error event\n * @param batchCountSamplingRate - rate for batches for which to send an event with its characteristics\n * @returns\n */\nexport const BindBatchTracker = (\n    batchEventEmitter: EventEmitter,\n    logger: ITelemetryLogger,\n    batchLengthThreshold: number = 1000,\n    batchCountSamplingRate: number = 1000,\n) => new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);\n"]}
+{"version":3,"file":"batchTracker.js","sourceRoot":"","sources":["../src/batchTracker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D,MAAM,OAAO,YAAY;IAMrB,YACqB,iBAA+B,EAChD,MAAwB,EACxB,oBAA4B,EAC5B,sBAA8B,EAC9B,mBAAiC,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE;QAJvC,sBAAiB,GAAjB,iBAAiB,CAAc;QAJ5C,sBAAiB,GAAW,CAAC,CAAC;QAUlC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAErD,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,OAAkC,EAAE,EAAE;YAC3E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;YACvD,IAAI,CAAC,6BAA6B,GAAG,gBAAgB,EAAE,CAAC;YACxD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,KAAsB,EAAE,OAAkC,EAAE,EAAE;YACjG,MAAM,CACF,IAAI,CAAC,wBAAwB,KAAK,SAAS,IAAI,IAAI,CAAC,6BAA6B,KAAK,SAAS,EAC/F,KAAK,CAAC,4CAA4C,CAAC,CAAC;YAExD,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,GAAG,CAAC,CAAC;YAC1E,IAAI,MAAM,IAAI,oBAAoB,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,cAAc;oBACzB,MAAM;oBACN,SAAS,EAAE,oBAAoB;oBAC/B,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;oBACjE,UAAU,EAAE,KAAK,KAAK,SAAS;iBAClC,CAAC,CAAC;aACN;YAED,IAAI,IAAI,CAAC,iBAAiB,GAAG,sBAAsB,KAAK,CAAC,EAAE;gBACvD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC;oBAC7B,SAAS,EAAE,QAAQ;oBACnB,MAAM;oBACN,YAAY,EAAE,sBAAsB;oBACpC,sBAAsB,EAAE,OAAO,CAAC,cAAc;oBAC9C,QAAQ,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,6BAA6B;iBACpE,CAAC,CAAC;aACN;YAED,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,6BAA6B,GAAG,SAAS,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC5B,iBAA+B,EAC/B,MAAwB,EACxB,uBAA+B,IAAI,EACnC,yBAAiC,IAAI,EACvC,EAAE,CAAC,IAAI,YAAY,CAAC,iBAAiB,EAAE,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport EventEmitter from \"events\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\n\nexport class BatchTracker {\n    private readonly logger: ITelemetryLogger;\n    private startBatchSequenceNumber: number | undefined;\n    private trackedBatchCount: number = 0;\n    private batchProcessingStartTimeStamp: number | undefined;\n\n    constructor(\n        private readonly batchEventEmitter: EventEmitter,\n        logger: ITelemetryLogger,\n        batchLengthThreshold: number,\n        batchCountSamplingRate: number,\n        dateTimeProvider: () => number = () => performance.now(),\n    ) {\n        this.logger = ChildLogger.create(logger, \"Batching\");\n\n        this.batchEventEmitter.on(\"batchBegin\", (message: ISequencedDocumentMessage) => {\n            this.startBatchSequenceNumber = message.sequenceNumber;\n            this.batchProcessingStartTimeStamp = dateTimeProvider();\n            this.trackedBatchCount++;\n        });\n\n        this.batchEventEmitter.on(\"batchEnd\", (error: any | undefined, message: ISequencedDocumentMessage) => {\n            assert(\n                this.startBatchSequenceNumber !== undefined && this.batchProcessingStartTimeStamp !== undefined,\n                0x2ba /* \"batchBegin must fire before batchEnd\" */);\n\n            const length = message.sequenceNumber - this.startBatchSequenceNumber + 1;\n            if (length >= batchLengthThreshold) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"LengthTooBig\",\n                    length,\n                    threshold: batchLengthThreshold,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                    batchError: error !== undefined,\n                });\n            }\n\n            if (this.trackedBatchCount % batchCountSamplingRate === 0) {\n                this.logger.sendPerformanceEvent({\n                    eventName: \"Length\",\n                    length,\n                    samplingRate: batchCountSamplingRate,\n                    batchEndSequenceNumber: message.sequenceNumber,\n                    duration: dateTimeProvider() - this.batchProcessingStartTimeStamp,\n                });\n            }\n\n            this.startBatchSequenceNumber = undefined;\n            this.batchProcessingStartTimeStamp = undefined;\n        });\n    }\n}\n\n/**\n * Track batch sizes in terms of op counts and processing times\n *\n * @param batchEventEmitter - event emitter which tracks the lifecycle of batch operations\n * @param logger - logger\n * @param batchLengthThreshold - threshold for the length of a batch when to send an error event\n * @param batchCountSamplingRate - rate for batches for which to send an event with its characteristics\n * @returns\n */\nexport const BindBatchTracker = (\n    batchEventEmitter: EventEmitter,\n    logger: ITelemetryLogger,\n    batchLengthThreshold: number = 1000,\n    batchCountSamplingRate: number = 1000,\n) => new BatchTracker(batchEventEmitter, logger, batchLengthThreshold, batchCountSamplingRate);\n"]}