@fluidframework/container-runtime 2.0.0-internal.3.0.5 → 2.0.0-internal.3.1.1

package/src/summarizerTypes.ts

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