@fluidframework/container-runtime 0.58.2002 → 0.59.1000

package/dist/summarizerTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizerTypes.js","sourceRoot":"","sources":["../src/summarizerTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBH;;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 {\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/** Options that control the behavior of a running summarizer. */\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}\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}\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    stop(reason: SummarizerStopReason): void;\n\n    run(onBehalfOf: string, options?: Readonly<Partial<ISummarizerOptions>>): 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     * Initializes lastAttempt and lastSuccessfulAttempt based on the last summary.\n     * @param lastSummary - last ack summary\n     */\n    initialize(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    \"summarizeReason\";\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"]}
+{"version":3,"file":"summarizerTypes.js","sourceRoot":"","sources":["../src/summarizerTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAoBH;;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 {\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/** Options that control the behavior of a running summarizer. */\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 isSystemMessage */\n    readonly nonSystemOpsSinceLastSummary: 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    stop(reason: SummarizerStopReason): void;\n\n    run(onBehalfOf: string, options?: Readonly<Partial<ISummarizerOptions>>): 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     * Initializes lastAttempt and lastSuccessfulAttempt based on the last summary.\n     * @param lastSummary - last ack summary\n     */\n    initialize(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    \"summarizeReason\";\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"]}

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,EAAwB,MAAM,oCAAoC,CAAC;AAC5F,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,EAChC,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,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAAC;AAE5B,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;AAwCD,oBAAY,eAAe;AACvB;;;;;GAKG;AACD,MAAM;AACR;;;;GAIG;GACD,SAAS;AACX;;;;;;GAMG;GACD,QAAQ;AACV;;;;;;GAMG;GACD,aAAa;AACf,4DAA4D;GAC1D,QAAQ,MAAM,EAAE;AAClB,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;IAmO3B,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,EAAwB,MAAM,oCAAoC,CAAC;AAC5F,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,EAChC,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,CAAA;CAAE,GAC5B;IAAE,MAAM,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAAC;AAE5B,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;AA+CD,oBAAY,eAAe;AACvB;;;;;GAKG;AACD,MAAM;AACR;;;;GAIG;GACD,SAAS;AACX;;;;;;GAMG;GACD,QAAQ;AACV;;;;;;GAMG;GACD,aAAa;AACf,4DAA4D;GAC1D,QAAQ,MAAM,EAAE;AAClB,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;IAoO3B,OAAO,CAAC,qBAAqB;IAatB,OAAO;CAGjB"}

package/dist/summaryGenerator.js

@@ -144,7 +144,7 @@ class SummaryGenerator {
             // Cumulatively add telemetry properties based on how far generateSummary went.
             const referenceSequenceNumber = summaryData.referenceSequenceNumber;
             const opsSinceLastSummary = referenceSequenceNumber - this.heuristicData.lastSuccessfulSummary.refSequenceNumber;
-            summarizeTelemetryProps = Object.assign(Object.assign({}, summarizeTelemetryProps), { referenceSequenceNumber, opsSinceLastAttempt: referenceSequenceNumber - this.heuristicData.lastAttempt.refSequenceNumber, opsSinceLastSummary });
+            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") {

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;AAqBrE,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;AAyEhE,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,qBAAM,CAAC,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,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,4CAA6B,CAAC,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,MAAM,oBAAoB,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBACtD,SAAS,EAAE,WAAW,IACnB,uBAAuB,EAC5B,CAAC;YAEH,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,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,oBAAoB,CAAC,WAAW,CAAC,UAAU,oBAAM,uBAAuB,EAAE,CAAC;YAC3E,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,EACjC,OAAO,EAAE,YAAY,IACvB,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAC,CAAC,CAAC;aACP;iBAAM;gBACH,gDAAgD;gBAChD,qBAAM,CAAC,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;gBAC1F,MAAM,CAAC,cAAc,+BACf,SAAS,EAAE,aAAa,IAAK,uBAAuB,KAAE,iBAAiB,KAAI,KAAK,CAAC,CAAC;gBAExF,qBAAM,CAAC,4CAA6B,CAAC,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;AA3RD,4CA2RC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, ITelemetryProperties } 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} 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\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\";\ntype SummaryGeneratorOptionalTelemetryProperties =\n    /** Reference sequence number as of the generate summary attempt. */\n    \"referenceSequenceNumber\" |\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    /** 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\";\ntype SummaryGeneratorTelemetry =\n    Pick<ITelemetryProperties, SummaryGeneratorRequiredTelemetryProperties> &\n    Partial<Pick<ITelemetryProperties, SummaryGeneratorOptionalTelemetryProperties>>;\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    /** Previous summary attempt failed, and we are retrying. */\n    | `retry${number}`\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        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            const generateSummaryEvent = PerformanceEvent.start(logger, {\n                eventName: \"Summarize\",\n                ...summarizeTelemetryProps,\n            });\n\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                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            generateSummaryEvent.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                    message: \"summaryAck\",\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                logger.sendErrorEvent(\n                    { eventName: \"SummaryNack\", ...summarizeTelemetryProps, retryAfterSeconds }, error);\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;AAqBrE,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;AAgFhE,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,qBAAM,CAAC,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,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,4CAA6B,CAAC,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,MAAM,oBAAoB,GAAG,kCAAgB,CAAC,KAAK,CAAC,MAAM,kBACtD,SAAS,EAAE,WAAW,IACnB,uBAAuB,EAC5B,CAAC;YAEH,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,oBAAoB,CAAC,WAAW,CAAC,UAAU,oBAAM,uBAAuB,EAAE,CAAC;YAC3E,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,EACjC,OAAO,EAAE,YAAY,IACvB,CAAC;gBACH,cAAc,CAAC,wBAAwB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE;wBACnE,YAAY,EAAE,SAAS;wBACvB,eAAe;qBAClB,EAAC,CAAC,CAAC;aACP;iBAAM;gBACH,gDAAgD;gBAChD,qBAAM,CAAC,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;gBAC1F,MAAM,CAAC,cAAc,+BACf,SAAS,EAAE,aAAa,IAAK,uBAAuB,KAAE,iBAAiB,KAAI,KAAK,CAAC,CAAC;gBAExF,qBAAM,CAAC,4CAA6B,CAAC,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;AA5RD,4CA4RC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITelemetryLogger, ITelemetryProperties } 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} 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\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\";\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-system ops since the last summary @see isSystemMessage */\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\";\ntype SummaryGeneratorTelemetry =\n    Pick<ITelemetryProperties, SummaryGeneratorRequiredTelemetryProperties> &\n    Partial<Pick<ITelemetryProperties, SummaryGeneratorOptionalTelemetryProperties>>;\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    /** Previous summary attempt failed, and we are retrying. */\n    | `retry${number}`\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        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            const generateSummaryEvent = PerformanceEvent.start(logger, {\n                eventName: \"Summarize\",\n                ...summarizeTelemetryProps,\n            });\n\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            generateSummaryEvent.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                    message: \"summaryAck\",\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                logger.sendErrorEvent(\n                    { eventName: \"SummaryNack\", ...summarizeTelemetryProps, retryAfterSeconds }, error);\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"]}

package/lib/blobManager.d.ts

@@ -4,9 +4,10 @@
  */
 import { IFluidHandle, IFluidHandleContext } from "@fluidframework/core-interfaces";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
-import { ISnapshotTree, ITree } from "@fluidframework/protocol-definitions";
+import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
+import { IGarbageCollectionData, ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
 /**
  * This class represents blob (long string)
  * This object is used only when creating (writing) new blob and serialization purposes.
@@ -69,7 +70,19 @@ export declare class BlobManager {
      * attachment types returned in snapshot() with blobs.
      */
     private load;
-    snapshot(): ITree;
+    /**
+     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be
+     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.
+     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care
+     * about this for now because the data is a simple list of blob ids.
+     */
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    /**
+     * When running GC in test mode, this is called to delete blobs that are unused.
+     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.
+     */
+    deleteUnusedRoutes(unusedRoutes: string[]): void;
+    summarize(): ISummaryTreeWithStats;
     setRedirectTable(table: Map<string, string>): void;
 }
 //# sourceMappingURL=blobManager.d.ts.map

package/lib/blobManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blobManager.d.ts","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,OAAO,EAAE,aAAa,EAAE,KAAK,EAAc,MAAM,sCAAsC,CAAC;AAExF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAGlF;;;;;;GAMG;AACH,qBAAa,UAAW,YAAW,YAAY,CAAC,eAAe,CAAC;aAYxC,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;IAblC,OAAO,CAAC,QAAQ,CAAkB;IAElC,IAAW,YAAY,IAAI,YAAY,CAAiB;IAExD,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,SAAgB,YAAY,EAAE,MAAM,CAAC;gBAGjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB,EAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;IAK3B,WAAW;IAIX,IAAI,CAAC,MAAM,EAAE,YAAY;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CACtC;AAED,qBAAa,WAAW;IAchB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAlB3B,gBAAuB,QAAQ,YAAY;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAoB;IAEjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAGlD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0C;IAEzE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAE1D,OAAO,CAAC,aAAa,CAAkC;gBAGlC,YAAY,EAAE,mBAAmB,EAClD,QAAQ,EAAE,oBAAoB,EACb,UAAU,EAAE,MAAM,uBAAuB,EACzC,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,EAC5C,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,gBAAgB;IAU7C,OAAO,CAAC,OAAO;IAIF,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAsB/D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAmC/E,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAOzD;;OAEG;WACiB,IAAI,CACpB,SAAS,EAAE,aAAa,GAAG,SAAS,EACpC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,GAC1D,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAI;IAeL,QAAQ,IAAI,KAAK;IAejB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAWrD"}
+{"version":3,"file":"blobManager.d.ts","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAEpG;;;;;;GAMG;AACH,qBAAa,UAAW,YAAW,YAAY,CAAC,eAAe,CAAC;aAYxC,IAAI,EAAE,MAAM;aACZ,YAAY,EAAE,mBAAmB;IAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;IAblC,OAAO,CAAC,QAAQ,CAAkB;IAElC,IAAW,YAAY,IAAI,YAAY,CAAiB;IAExD,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,SAAgB,YAAY,EAAE,MAAM,CAAC;gBAGjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,mBAAmB,EAC1C,GAAG,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC;IAK3B,WAAW;IAIX,IAAI,CAAC,MAAM,EAAE,YAAY;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;CACtC;AAED,qBAAa,WAAW;IAchB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAlB3B,gBAAuB,QAAQ,YAAY;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAoB;IAEjE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAGlD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0C;IAEzE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAE1D,OAAO,CAAC,aAAa,CAAkC;gBAGlC,YAAY,EAAE,mBAAmB,EAClD,QAAQ,EAAE,oBAAoB,EACb,UAAU,EAAE,MAAM,uBAAuB,EACzC,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,EAC5C,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,gBAAgB;IAU7C,OAAO,CAAC,OAAO;IAIF,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAsB/D,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAmC/E,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;IAUzD;;OAEG;WACiB,IAAI,CACpB,SAAS,EAAE,aAAa,GAAG,SAAS,EACpC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,GAC1D,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAI;IAeZ;;;;;OAKG;IACI,SAAS,CAAC,MAAM,GAAE,OAAe,GAAG,sBAAsB;IA6BjE;;;OAGG;IACI,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI;IAoBhD,SAAS,IAAI,qBAAqB;IAoBlC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAWrD"}

package/lib/blobManager.js

@@ -2,8 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { AttachmentTreeEntry, BlobTreeEntry } from "@fluidframework/protocol-base";
-import { generateHandleContextPath } from "@fluidframework/runtime-utils";
+import { generateHandleContextPath, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
 import { assert, Deferred } from "@fluidframework/common-utils";
 import { AttachState } from "@fluidframework/container-definitions";
 /**
@@ -99,10 +98,12 @@ export class BlobManager {
         return handle;
     }
     processBlobAttachOp(blobId, local) {
-        var _a;
-        assert(!local || this.pendingBlobIds.has(blobId), 0x1f8 /* "local BlobAttach op with no pending blob" */);
-        (_a = this.pendingBlobIds.get(blobId)) === null || _a === void 0 ? void 0 : _a.resolve();
-        this.pendingBlobIds.delete(blobId);
+        if (local) {
+            const pendingBlobP = this.pendingBlobIds.get(blobId);
+            assert(pendingBlobP !== undefined, 0x1f8 /* "local BlobAttach op with no pending blob" */);
+            pendingBlobP.resolve();
+            this.pendingBlobIds.delete(blobId);
+        }
         this.blobIds.add(blobId);
     }
     /**
@@ -150,16 +151,71 @@ export class BlobManager {
             redirectTable: (_c = snapshot.redirectTable) === null || _c === void 0 ? void 0 : _c.length,
         });
     }
-    snapshot() {
+    /**
+     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be
+     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.
+     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care
+     * about this for now because the data is a simple list of blob ids.
+     */
+    getGCData(fullGC = false) {
+        const getGCNodePath = (blobId) => { return `/${BlobManager.basePath}/${blobId}`; };
+        const gcData = { gcNodes: {} };
+        /**
+          * The node path is of the format `/_blobs/blobId`. This path must match the path of the blob handle returned
+          * by the createBlob API because blobs are marked referenced by storing these handles in a referenced DDS.
+          */
+        this.blobIds.forEach((blobId) => {
+            gcData.gcNodes[getGCNodePath(blobId)] = [];
+        });
+        /**
+         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these
+         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node
+         * must also be marked referenced. So, we add a route from the localId node to the storageId node.
+         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or
+         * a blob may be referenced via its storageId handle.
+         */
+        if (this.redirectTable !== undefined) {
+            for (const [localId, storageId] of this.redirectTable) {
+                // Add node for the localId and add a route to the storageId node. The storageId node will have been
+                // added above when adding nodes for this.blobIds.
+                gcData.gcNodes[getGCNodePath(localId)] = [getGCNodePath(storageId)];
+            }
+        }
+        return gcData;
+    }
+    /**
+     * When running GC in test mode, this is called to delete blobs that are unused.
+     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.
+     */
+    deleteUnusedRoutes(unusedRoutes) {
+        var _a;
+        // The routes or blob node paths are in the same format as returned in getGCData - `/_blobs/blobId`.
+        for (const route of unusedRoutes) {
+            const pathParts = route.split("/");
+            assert(pathParts.length === 3 && pathParts[1] === BlobManager.basePath, 0x2d5 /* "Invalid blob node id in unused routes." */);
+            const blobId = pathParts[2];
+            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The
+            // corresponding storageId may still be used either directly or via other localIds.
+            if ((_a = this.redirectTable) === null || _a === void 0 ? void 0 : _a.has(blobId)) {
+                this.redirectTable.delete(blobId);
+                continue;
+            }
+            this.blobIds.delete(blobId);
+        }
+    }
+    summarize() {
         // If we have a redirect table it means the container is about to transition to "Attaching" state, so we need
         // to return an actual snapshot containing all the real storage IDs we know about.
         const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;
         const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;
-        const entries = [...blobIds].map((id) => new AttachmentTreeEntry(id, id));
+        const builder = new SummaryTreeBuilder();
+        blobIds.forEach((blobId) => {
+            builder.addAttachment(blobId);
+        });
         if (this.redirectTable && this.redirectTable.size > 0) {
-            entries.push(new BlobTreeEntry(BlobManager.redirectTableBlobName, JSON.stringify(Array.from(this.redirectTable.entries()))));
+            builder.addBlob(BlobManager.redirectTableBlobName, JSON.stringify(Array.from(this.redirectTable.entries())));
         }
-        return { entries };
+        return builder.getSummaryTree();
     }
     setRedirectTable(table) {
         assert(this.runtime.attachState === AttachState.Detached, 0x252 /* "redirect table can only be set in detached container" */);

package/lib/blobManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAEpE;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAWnB,YACoB,IAAY,EACZ,YAAiC,EAC1C,GAAuB;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAC1C,QAAG,GAAH,GAAG,CAAoB;QAb1B,aAAQ,GAAY,KAAK,CAAC;QAe9B,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAdD,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,CAAC,CAAC;IAExD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAYM,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;CACJ;AAUD,MAAM,OAAO,WAAW;IAapB,YACqB,YAAiC,EAClD,QAA8B,EACb,UAAyC,EACzC,kBAA4C,EAC5C,OAA0B,EAC1B,MAAwB;QALxB,iBAAY,GAAZ,YAAY,CAAqB;QAEjC,eAAU,GAAV,UAAU,CAA+B;QACzC,uBAAkB,GAAlB,kBAAkB,CAA0B;QAC5C,YAAO,GAAP,OAAO,CAAmB;QAC1B,WAAM,GAAN,MAAM,CAAkB;QAhB7C,oBAAoB;QACH,YAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClD,+GAA+G;QAC/G,mCAAmC;QAClB,mBAAc,GAAgC,IAAI,GAAG,EAAE,CAAC;QACzE,qDAAqD;QACpC,oBAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;QAYtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE;gBAChD,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;aAC/E;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAc;;QAC/B,MAAM,SAAS,eAAG,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,oCAAK,MAAM,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAExE,OAAO,IAAI,UAAU,CACjB,GAAG,WAAW,CAAC,QAAQ,IAAI,SAAS,EAAE,EACtC,IAAI,CAAC,YAAY,EACjB,KAAK,IAAI,EAAE;YACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,EAAC,yBAAyB;oBACnC,EAAE,EAAE,SAAS;iBAChB,EACD,KAAK,CACR,CAAC;gBACF,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,SAAS,EAAE;YACpD,oDAAoD;YACpD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAChF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,CACzB,GAAG,WAAW,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EACxC,IAAI,CAAC,YAAY;QACjB,oGAAoG;QACpG,oDAAoD;QACpD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CACnE,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACtC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;aAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,QAAQ,EAAQ,CAAC,CAAC;YAE3D,oEAAoE;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,mBAAmB,CAAC,MAAc,EAAE,KAAc;;QACrD,MAAM,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAC1G,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,0CAAE,OAAO,GAAG;QAC3C,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,SAAoC,EACpC,YAAyD;QAEzD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,EAAE,CAAC;SACb;QACD,IAAI,aAAa,CAAC;QAClB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE;YACT,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,QAA8B;;QACvC,IAAI,QAAQ,CAAC,GAAG,EAAE;YACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SACrG;QACD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,uBAAuB;YAClC,KAAK,cAAE,QAAQ,CAAC,GAAG,0CAAE,MAAM,mCAAI,CAAC;YAChC,aAAa,QAAE,QAAQ,CAAC,aAAa,0CAAE,MAAM;SAChD,CAAC,CAAC;IACP,CAAC;IAEM,QAAQ;QACX,6GAA6G;QAC7G,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;QACtG,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC1E,MAAM,OAAO,GAAiB,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACxF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAC1B,WAAW,CAAC,qBAAqB,EACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAC5D,CAAC;SACL;QACD,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC9F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AA1KsB,oBAAQ,GAAG,QAAQ,CAAC;AACnB,iCAAqB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { AttachmentTreeEntry, BlobTreeEntry } from \"@fluidframework/protocol-base\";\nimport { ISnapshotTree, ITree, ITreeEntry } from \"@fluidframework/protocol-definitions\";\nimport { generateHandleContextPath } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\n\n/**\n * This class represents blob (long string)\n * This object is used only when creating (writing) new blob and serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * DataObject.request() recognizes requests in the form of `/blobs/<id>`\n * and loads blob.\n */\nexport class BlobHandle implements IFluidHandle<ArrayBufferLike> {\n    private attached: boolean = false;\n\n    public get IFluidHandle(): IFluidHandle { return this; }\n\n    public get isAttached(): boolean {\n        return this.attached;\n    }\n\n    public readonly absolutePath: string;\n\n    constructor(\n        public readonly path: string,\n        public readonly routeContext: IFluidHandleContext,\n        public get: () => Promise<any>,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph() {\n        this.attached = true;\n    }\n\n    public bind(handle: IFluidHandle) {\n        throw new Error(\"Cannot bind to blob handle\");\n    }\n}\n\n/**\n * Information from a snapshot needed to load BlobManager\n */\nexport interface IBlobManagerLoadInfo {\n    ids?: string[],\n    redirectTable?: [string, string][],\n}\n\nexport class BlobManager {\n    public static readonly basePath = \"_blobs\";\n    private static readonly redirectTableBlobName = \".redirectTable\";\n    // uploaded blob IDs\n    private readonly blobIds: Set<string> = new Set();\n    // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a\n    // BlobAttach op has round-tripped.\n    private readonly pendingBlobIds: Map<string, Deferred<void>> = new Map();\n    // blobs uploaded while detached; cleared upon attach\n    private readonly detachedBlobIds: Set<string> = new Set();\n    // map of detached blob IDs to IDs used by storage. used to support blob handles given out while detached\n    private redirectTable: Map<string, string> | undefined;\n\n    constructor(\n        private readonly routeContext: IFluidHandleContext,\n        snapshot: IBlobManagerLoadInfo,\n        private readonly getStorage: () => IDocumentStorageService,\n        private readonly attachBlobCallback: (blobId: string) => void,\n        private readonly runtime: IContainerRuntime,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.runtime.once(\"dispose\", () => {\n            for (const promise of this.pendingBlobIds.values()) {\n                promise.reject(new Error(\"runtime disposed while blobAttach op in flight\"));\n            }\n        });\n        this.load(snapshot);\n    }\n\n    private hasBlob(id: string): boolean {\n        return this.blobIds.has(id) || this.detachedBlobIds.has(id);\n    }\n\n    public async getBlob(blobId: string): Promise<IFluidHandle<ArrayBufferLike>> {\n        const storageId = this.redirectTable?.get(blobId) ?? blobId;\n        assert(this.hasBlob(storageId), 0x11f /* \"requesting unknown blobs\" */);\n\n        return new BlobHandle(\n            `${BlobManager.basePath}/${storageId}`,\n            this.routeContext,\n            async () => {\n                return this.getStorage().readBlob(storageId).catch((error) => {\n                    this.logger.sendErrorEvent(\n                        {\n                            eventName:\"AttachmentReadBlobError\",\n                            id: storageId,\n                        },\n                        error,\n                    );\n                    throw error;\n                });\n            },\n        );\n    }\n\n    public async createBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n        if (this.runtime.attachState === AttachState.Attaching) {\n            // blob upload is not supported in \"Attaching\" state\n            this.logger.sendTelemetryEvent({ eventName: \"CreateBlobWhileAttaching\" });\n            await new Promise<void>((resolve) => this.runtime.once(\"attached\", resolve));\n        }\n\n        const response = await this.getStorage().createBlob(blob);\n        const handle = new BlobHandle(\n            `${BlobManager.basePath}/${response.id}`,\n            this.routeContext,\n            // get() should go through BlobManager.getBlob() so handles created while detached can be redirected\n            // to the correct storage id after they are uploaded\n            async () => this.getBlob(response.id).then(async (h) => h.get()),\n        );\n\n        if (this.runtime.attachState === AttachState.Detached) {\n            this.detachedBlobIds.add(response.id);\n            return handle;\n        }\n\n        // Note - server will de-dup blobs, so we might get existing blobId!\n        if (this.pendingBlobIds.has(response.id)) {\n            await this.pendingBlobIds.get(response.id)?.promise;\n        } else if (!this.blobIds.has(response.id)) {\n            this.pendingBlobIds.set(response.id, new Deferred<void>());\n\n            // send blob attach op and wait until we see it to return the handle\n            this.attachBlobCallback(response.id);\n            await this.pendingBlobIds.get(response.id)?.promise;\n        }\n\n        return handle;\n    }\n\n    public processBlobAttachOp(blobId: string, local: boolean) {\n        assert(!local || this.pendingBlobIds.has(blobId), 0x1f8 /* \"local BlobAttach op with no pending blob\" */);\n        this.pendingBlobIds.get(blobId)?.resolve();\n        this.pendingBlobIds.delete(blobId);\n        this.blobIds.add(blobId);\n    }\n\n    /**\n     * Reads blobs needed to load BlobManager from storage.\n     */\n    public static async load(\n        blobsTree: ISnapshotTree | undefined,\n        tryFetchBlob: (id: string) => Promise<[string, string][]>,\n    ): Promise<IBlobManagerLoadInfo> {\n        if (!blobsTree) {\n            return {};\n        }\n        let redirectTable;\n        const tableId = blobsTree.blobs[this.redirectTableBlobName];\n        if (tableId) {\n            redirectTable = await tryFetchBlob(tableId);\n        }\n        const ids = Object.entries(blobsTree.blobs)\n            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);\n        return { ids, redirectTable };\n    }\n\n    /**\n     * Load a set of previously attached blob IDs from a previous snapshot. Note\n     * that BlobManager tracking and reporting attached blobs is a temporary\n     * solution since storage expects attached blobs to be reported and any that\n     * are not reported as attached may be GCed. In the future attached blob\n     * IDs will be collected at summarization time, and runtime will not care\n     * about the existence or specific formatting of this tree in returned\n     * snapshots.\n     *\n     * @param blobsTree - Tree containing IDs of previously attached blobs. This\n     * corresponds to snapshot() below. We look for the IDs in the blob entries\n     * of the tree since the both the r11s and SPO drivers replace the\n     * attachment types returned in snapshot() with blobs.\n     */\n    private load(snapshot: IBlobManagerLoadInfo): void {\n        if (snapshot.ids) {\n            const detached = this.runtime.attachState === AttachState.Detached;\n            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));\n        }\n        if (snapshot.redirectTable) {\n            this.redirectTable = new Map(snapshot.redirectTable);\n        }\n        this.logger.sendTelemetryEvent({\n            eventName: \"AttachmentBlobsLoaded\",\n            count: snapshot.ids?.length ?? 0,\n            redirectTable: snapshot.redirectTable?.length,\n        });\n    }\n\n    public snapshot(): ITree {\n        // If we have a redirect table it means the container is about to transition to \"Attaching\" state, so we need\n        // to return an actual snapshot containing all the real storage IDs we know about.\n        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;\n        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;\n        const entries: ITreeEntry[] = [...blobIds].map((id) => new AttachmentTreeEntry(id, id));\n        if (this.redirectTable && this.redirectTable.size > 0) {\n            entries.push(new BlobTreeEntry(\n                BlobManager.redirectTableBlobName,\n                JSON.stringify(Array.from(this.redirectTable.entries()))),\n            );\n        }\n        return { entries };\n    }\n\n    public setRedirectTable(table: Map<string, string>) {\n        assert(this.runtime.attachState === AttachState.Detached,\n            0x252 /* \"redirect table can only be set in detached container\" */);\n        assert(!this.redirectTable, 0x253 /* \"redirect table already exists\" */);\n        for (const [localId, storageId] of table) {\n            assert(this.detachedBlobIds.delete(localId), 0x254 /* \"unrecognized id in redirect table\" */);\n            this.blobIds.add(storageId);\n        }\n        assert(this.detachedBlobIds.size === 0, 0x255 /* \"detached blob id absent in redirect table\" */);\n        this.redirectTable = table;\n    }\n}\n"]}
+{"version":3,"file":"blobManager.js","sourceRoot":"","sources":["../src/blobManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAE9F,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAGpE;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAWnB,YACoB,IAAY,EACZ,YAAiC,EAC1C,GAAuB;QAFd,SAAI,GAAJ,IAAI,CAAQ;QACZ,iBAAY,GAAZ,YAAY,CAAqB;QAC1C,QAAG,GAAH,GAAG,CAAoB;QAb1B,aAAQ,GAAY,KAAK,CAAC;QAe9B,IAAI,CAAC,YAAY,GAAG,yBAAyB,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,CAAC;IAdD,IAAW,YAAY,KAAmB,OAAO,IAAI,CAAC,CAAC,CAAC;IAExD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAYM,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAoB;QAC5B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAClD,CAAC;CACJ;AAUD,MAAM,OAAO,WAAW;IAapB,YACqB,YAAiC,EAClD,QAA8B,EACb,UAAyC,EACzC,kBAA4C,EAC5C,OAA0B,EAC1B,MAAwB;QALxB,iBAAY,GAAZ,YAAY,CAAqB;QAEjC,eAAU,GAAV,UAAU,CAA+B;QACzC,uBAAkB,GAAlB,kBAAkB,CAA0B;QAC5C,YAAO,GAAP,OAAO,CAAmB;QAC1B,WAAM,GAAN,MAAM,CAAkB;QAhB7C,oBAAoB;QACH,YAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClD,+GAA+G;QAC/G,mCAAmC;QAClB,mBAAc,GAAgC,IAAI,GAAG,EAAE,CAAC;QACzE,qDAAqD;QACpC,oBAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;QAYtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;YAC9B,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE;gBAChD,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC,CAAC;aAC/E;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAEO,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,MAAc;;QAC/B,MAAM,SAAS,eAAG,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,oCAAK,MAAM,CAAC;QAC5D,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAExE,OAAO,IAAI,UAAU,CACjB,GAAG,WAAW,CAAC,QAAQ,IAAI,SAAS,EAAE,EACtC,IAAI,CAAC,YAAY,EACjB,KAAK,IAAI,EAAE;YACP,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACzD,IAAI,CAAC,MAAM,CAAC,cAAc,CACtB;oBACI,SAAS,EAAC,yBAAyB;oBACnC,EAAE,EAAE,SAAS;iBAChB,EACD,KAAK,CACR,CAAC;gBACF,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;;QACzC,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,SAAS,EAAE;YACpD,oDAAoD;YACpD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC,CAAC;YAC1E,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;SAChF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,CACzB,GAAG,WAAW,CAAC,QAAQ,IAAI,QAAQ,CAAC,EAAE,EAAE,EACxC,IAAI,CAAC,YAAY;QACjB,oGAAoG;QACpG,oDAAoD;QACpD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CACnE,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EAAE;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACtC,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACtC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;aAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,QAAQ,EAAQ,CAAC,CAAC;YAE3D,oEAAoE;YACpE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,OAAO,CAAA,CAAC;SACvD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,mBAAmB,CAAC,MAAc,EAAE,KAAc;QACrD,IAAI,KAAK,EAAE;YACP,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;YAC3F,YAAY,CAAC,OAAO,EAAE,CAAC;YACvB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,SAAoC,EACpC,YAAyD;QAEzD,IAAI,CAAC,SAAS,EAAE;YACZ,OAAO,EAAE,CAAC;SACb;QACD,IAAI,aAAa,CAAC;QAClB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE;YACT,aAAa,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;SAC/C;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QAC7E,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,IAAI,CAAC,QAA8B;;QACvC,IAAI,QAAQ,CAAC,GAAG,EAAE;YACd,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;YACnE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SACrG;QACD,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,uBAAuB;YAClC,KAAK,cAAE,QAAQ,CAAC,GAAG,0CAAE,MAAM,mCAAI,CAAC;YAChC,aAAa,QAAE,QAAQ,CAAC,aAAa,0CAAE,MAAM;SAChD,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,SAAkB,KAAK;QACpC,MAAM,aAAa,GAAG,CAAC,MAAc,EAAE,EAAE,GAAG,OAAO,IAAI,WAAW,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC3F,MAAM,MAAM,GAA2B,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QACvD;;;YAGI;QACJ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACpC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH;;;;;;WAMG;QACH,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE;YAClC,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE;gBACnD,oGAAoG;gBACpG,kDAAkD;gBAClD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;aACvE;SACJ;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,YAAsB;;QAC5C,oGAAoG;QACpG,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE;YAC9B,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,MAAM,CACF,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,QAAQ,EAC/D,KAAK,CAAC,8CAA8C,CACvD,CAAC;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;YAE5B,mGAAmG;YACnG,mFAAmF;YACnF,UAAI,IAAI,CAAC,aAAa,0CAAE,GAAG,CAAC,MAAM,GAAG;gBACjC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAClC,SAAS;aACZ;YACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;IACL,CAAC;IAEM,SAAS;QACZ,6GAA6G;QAC7G,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAC;QACtG,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAC1E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,EAAE;YACnD,OAAO,CAAC,OAAO,CACX,WAAW,CAAC,qBAAqB,EACjC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAC3D,CAAC;SACL;QAED,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACpC,CAAC;IAEM,gBAAgB,CAAC,KAA0B;QAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,QAAQ,EACpD,KAAK,CAAC,4DAA4D,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzE,KAAK,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,KAAK,EAAE;YACtC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;YAC9F,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC/B;QACD,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,CAAC,EAAE,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACjG,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC/B,CAAC;;AA7OsB,oBAAQ,GAAG,QAAQ,CAAC;AACnB,iCAAqB,GAAG,gBAAgB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle, IFluidHandleContext } from \"@fluidframework/core-interfaces\";\nimport { IDocumentStorageService } from \"@fluidframework/driver-definitions\";\nimport { ISnapshotTree } from \"@fluidframework/protocol-definitions\";\nimport { generateHandleContextPath, SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { assert, Deferred } from \"@fluidframework/common-utils\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { AttachState } from \"@fluidframework/container-definitions\";\nimport { IGarbageCollectionData, ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\n\n/**\n * This class represents blob (long string)\n * This object is used only when creating (writing) new blob and serialization purposes.\n * De-serialization process goes through FluidObjectHandle and request flow:\n * DataObject.request() recognizes requests in the form of `/blobs/<id>`\n * and loads blob.\n */\nexport class BlobHandle implements IFluidHandle<ArrayBufferLike> {\n    private attached: boolean = false;\n\n    public get IFluidHandle(): IFluidHandle { return this; }\n\n    public get isAttached(): boolean {\n        return this.attached;\n    }\n\n    public readonly absolutePath: string;\n\n    constructor(\n        public readonly path: string,\n        public readonly routeContext: IFluidHandleContext,\n        public get: () => Promise<any>,\n    ) {\n        this.absolutePath = generateHandleContextPath(path, this.routeContext);\n    }\n\n    public attachGraph() {\n        this.attached = true;\n    }\n\n    public bind(handle: IFluidHandle) {\n        throw new Error(\"Cannot bind to blob handle\");\n    }\n}\n\n/**\n * Information from a snapshot needed to load BlobManager\n */\nexport interface IBlobManagerLoadInfo {\n    ids?: string[],\n    redirectTable?: [string, string][],\n}\n\nexport class BlobManager {\n    public static readonly basePath = \"_blobs\";\n    private static readonly redirectTableBlobName = \".redirectTable\";\n    // uploaded blob IDs\n    private readonly blobIds: Set<string> = new Set();\n    // blobs for which upload is pending. maps to a promise that will resolve once the blob has been uploaded and a\n    // BlobAttach op has round-tripped.\n    private readonly pendingBlobIds: Map<string, Deferred<void>> = new Map();\n    // blobs uploaded while detached; cleared upon attach\n    private readonly detachedBlobIds: Set<string> = new Set();\n    // map of detached blob IDs to IDs used by storage. used to support blob handles given out while detached\n    private redirectTable: Map<string, string> | undefined;\n\n    constructor(\n        private readonly routeContext: IFluidHandleContext,\n        snapshot: IBlobManagerLoadInfo,\n        private readonly getStorage: () => IDocumentStorageService,\n        private readonly attachBlobCallback: (blobId: string) => void,\n        private readonly runtime: IContainerRuntime,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.runtime.once(\"dispose\", () => {\n            for (const promise of this.pendingBlobIds.values()) {\n                promise.reject(new Error(\"runtime disposed while blobAttach op in flight\"));\n            }\n        });\n        this.load(snapshot);\n    }\n\n    private hasBlob(id: string): boolean {\n        return this.blobIds.has(id) || this.detachedBlobIds.has(id);\n    }\n\n    public async getBlob(blobId: string): Promise<IFluidHandle<ArrayBufferLike>> {\n        const storageId = this.redirectTable?.get(blobId) ?? blobId;\n        assert(this.hasBlob(storageId), 0x11f /* \"requesting unknown blobs\" */);\n\n        return new BlobHandle(\n            `${BlobManager.basePath}/${storageId}`,\n            this.routeContext,\n            async () => {\n                return this.getStorage().readBlob(storageId).catch((error) => {\n                    this.logger.sendErrorEvent(\n                        {\n                            eventName:\"AttachmentReadBlobError\",\n                            id: storageId,\n                        },\n                        error,\n                    );\n                    throw error;\n                });\n            },\n        );\n    }\n\n    public async createBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n        if (this.runtime.attachState === AttachState.Attaching) {\n            // blob upload is not supported in \"Attaching\" state\n            this.logger.sendTelemetryEvent({ eventName: \"CreateBlobWhileAttaching\" });\n            await new Promise<void>((resolve) => this.runtime.once(\"attached\", resolve));\n        }\n\n        const response = await this.getStorage().createBlob(blob);\n        const handle = new BlobHandle(\n            `${BlobManager.basePath}/${response.id}`,\n            this.routeContext,\n            // get() should go through BlobManager.getBlob() so handles created while detached can be redirected\n            // to the correct storage id after they are uploaded\n            async () => this.getBlob(response.id).then(async (h) => h.get()),\n        );\n\n        if (this.runtime.attachState === AttachState.Detached) {\n            this.detachedBlobIds.add(response.id);\n            return handle;\n        }\n\n        // Note - server will de-dup blobs, so we might get existing blobId!\n        if (this.pendingBlobIds.has(response.id)) {\n            await this.pendingBlobIds.get(response.id)?.promise;\n        } else if (!this.blobIds.has(response.id)) {\n            this.pendingBlobIds.set(response.id, new Deferred<void>());\n\n            // send blob attach op and wait until we see it to return the handle\n            this.attachBlobCallback(response.id);\n            await this.pendingBlobIds.get(response.id)?.promise;\n        }\n\n        return handle;\n    }\n\n    public processBlobAttachOp(blobId: string, local: boolean) {\n        if (local) {\n            const pendingBlobP = this.pendingBlobIds.get(blobId);\n            assert(pendingBlobP !== undefined, 0x1f8 /* \"local BlobAttach op with no pending blob\" */);\n            pendingBlobP.resolve();\n            this.pendingBlobIds.delete(blobId);\n        }\n        this.blobIds.add(blobId);\n    }\n\n    /**\n     * Reads blobs needed to load BlobManager from storage.\n     */\n    public static async load(\n        blobsTree: ISnapshotTree | undefined,\n        tryFetchBlob: (id: string) => Promise<[string, string][]>,\n    ): Promise<IBlobManagerLoadInfo> {\n        if (!blobsTree) {\n            return {};\n        }\n        let redirectTable;\n        const tableId = blobsTree.blobs[this.redirectTableBlobName];\n        if (tableId) {\n            redirectTable = await tryFetchBlob(tableId);\n        }\n        const ids = Object.entries(blobsTree.blobs)\n            .filter(([k, _]) => k !== this.redirectTableBlobName).map(([_, v]) => v);\n        return { ids, redirectTable };\n    }\n\n    /**\n     * Load a set of previously attached blob IDs from a previous snapshot. Note\n     * that BlobManager tracking and reporting attached blobs is a temporary\n     * solution since storage expects attached blobs to be reported and any that\n     * are not reported as attached may be GCed. In the future attached blob\n     * IDs will be collected at summarization time, and runtime will not care\n     * about the existence or specific formatting of this tree in returned\n     * snapshots.\n     *\n     * @param blobsTree - Tree containing IDs of previously attached blobs. This\n     * corresponds to snapshot() below. We look for the IDs in the blob entries\n     * of the tree since the both the r11s and SPO drivers replace the\n     * attachment types returned in snapshot() with blobs.\n     */\n    private load(snapshot: IBlobManagerLoadInfo): void {\n        if (snapshot.ids) {\n            const detached = this.runtime.attachState === AttachState.Detached;\n            snapshot.ids.map((entry) => detached ? this.detachedBlobIds.add(entry) : this.blobIds.add(entry));\n        }\n        if (snapshot.redirectTable) {\n            this.redirectTable = new Map(snapshot.redirectTable);\n        }\n        this.logger.sendTelemetryEvent({\n            eventName: \"AttachmentBlobsLoaded\",\n            count: snapshot.ids?.length ?? 0,\n            redirectTable: snapshot.redirectTable?.length,\n        });\n    }\n\n    /**\n     * Generates data used for garbage collection. Each blob uploaded represents a node in the GC graph as it can be\n     * individually referenced by storing its handle in a referenced DDS. Returns the list of blob ids as GC nodes.\n     * @param fullGC - true to bypass optimizations and force full generation of GC data. BlobManager doesn't care\n     * about this for now because the data is a simple list of blob ids.\n     */\n    public getGCData(fullGC: boolean = false): IGarbageCollectionData {\n        const getGCNodePath = (blobId: string) => { return `/${BlobManager.basePath}/${blobId}`; };\n        const gcData: IGarbageCollectionData = { gcNodes: {} };\n        /**\n          * The node path is of the format `/_blobs/blobId`. This path must match the path of the blob handle returned\n          * by the createBlob API because blobs are marked referenced by storing these handles in a referenced DDS.\n          */\n        this.blobIds.forEach((blobId: string) => {\n            gcData.gcNodes[getGCNodePath(blobId)] = [];\n        });\n\n        /**\n         * For all blobs in the redirect table, the handle returned on creation is based off of the localId. So, these\n         * nodes can be referenced by storing the localId handle. When that happens, the corresponding storageId node\n         * must also be marked referenced. So, we add a route from the localId node to the storageId node.\n         * Note that because of de-duping, there can be multiple localIds that all redirect to the same storageId or\n         * a blob may be referenced via its storageId handle.\n         */\n        if (this.redirectTable !== undefined) {\n            for (const [localId, storageId] of this.redirectTable) {\n                // Add node for the localId and add a route to the storageId node. The storageId node will have been\n                // added above when adding nodes for this.blobIds.\n                gcData.gcNodes[getGCNodePath(localId)] = [getGCNodePath(storageId)];\n            }\n        }\n\n        return gcData;\n    }\n\n    /**\n     * When running GC in test mode, this is called to delete blobs that are unused.\n     * @param unusedRoutes - These are the blob node ids that are unused and should be deleted.\n     */\n    public deleteUnusedRoutes(unusedRoutes: string[]): void {\n        // The routes or blob node paths are in the same format as returned in getGCData - `/_blobs/blobId`.\n        for (const route of unusedRoutes) {\n            const pathParts = route.split(\"/\");\n            assert(\n                pathParts.length === 3 && pathParts[1] === BlobManager.basePath,\n                0x2d5 /* \"Invalid blob node id in unused routes.\" */,\n            );\n            const blobId = pathParts[2];\n\n            // The unused blobId could be a localId. If so, remove it from the redirect table and continue. The\n            // corresponding storageId may still be used either directly or via other localIds.\n            if (this.redirectTable?.has(blobId)) {\n                this.redirectTable.delete(blobId);\n                continue;\n            }\n            this.blobIds.delete(blobId);\n        }\n    }\n\n    public summarize(): ISummaryTreeWithStats {\n        // If we have a redirect table it means the container is about to transition to \"Attaching\" state, so we need\n        // to return an actual snapshot containing all the real storage IDs we know about.\n        const attachingOrAttached = !!this.redirectTable || this.runtime.attachState !== AttachState.Detached;\n        const blobIds = attachingOrAttached ? this.blobIds : this.detachedBlobIds;\n        const builder = new SummaryTreeBuilder();\n        blobIds.forEach((blobId) => {\n            builder.addAttachment(blobId);\n        });\n\n        if (this.redirectTable && this.redirectTable.size > 0) {\n            builder.addBlob(\n                BlobManager.redirectTableBlobName,\n                JSON.stringify(Array.from(this.redirectTable.entries())),\n            );\n        }\n\n        return builder.getSummaryTree();\n    }\n\n    public setRedirectTable(table: Map<string, string>) {\n        assert(this.runtime.attachState === AttachState.Detached,\n            0x252 /* \"redirect table can only be set in detached container\" */);\n        assert(!this.redirectTable, 0x253 /* \"redirect table already exists\" */);\n        for (const [localId, storageId] of table) {\n            assert(this.detachedBlobIds.delete(localId), 0x254 /* \"unrecognized id in redirect table\" */);\n            this.blobIds.add(storageId);\n        }\n        assert(this.detachedBlobIds.size === 0, 0x255 /* \"detached blob id absent in redirect table\" */);\n        this.redirectTable = table;\n    }\n}\n"]}

package/lib/connectionTelemetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connectionTelemetry.d.ts","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAC5B,MAAM,sCAAsC,CAAC;AAG9C;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAyJrC,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,MAAM,EAAE,gBAAgB,QAE3B"}
+{"version":3,"file":"connectionTelemetry.d.ts","sourceRoot":"","sources":["../src/connectionTelemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAG9C;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAmPrC,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,MAAM,EAAE,gBAAgB,QAE3B"}