@fluidframework/container-runtime 1.4.0-121020 → 2.0.0-dev-rc.1.0.0.225277

package/lib/summary/runningSummarizer.d.mts

@@ -0,0 +1,128 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IDisposable, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ISummaryConfiguration } from "../containerRuntime.mjs";
+import { IEnqueueSummarizeOptions, ISummarizeHeuristicData, IOnDemandSummarizeOptions, EnqueueSummarizeResult, SummarizerStopReason, ISubmitSummaryOptions, SubmitSummaryResult, ISummaryCancellationToken, ISummarizeResults, ISummarizerRuntime, IRefreshSummaryAckOptions, ISummarizerEvents } from "./summarizerTypes.mjs";
+import { IClientSummaryWatcher, SummaryCollection } from "./summaryCollection.mjs";
+import { SummarizeResultBuilder } from "./summaryGenerator.mjs";
+/**
+ * The maximum number of summarization attempts that will be done by default in case of failures
+ * that can be retried.
+ */
+export declare const defaultMaxAttempts = 2;
+/**
+ * The default value for maximum number of summarization attempts that will be done for summarization failures where
+ * submit fails and the failure can be retried.
+ */
+export declare const defaultMaxAttemptsForSubmitFailures = 5;
+/**
+ * An instance of RunningSummarizer manages the heuristics for summarizing.
+ * Until disposed, the instance of RunningSummarizer can assume that it is
+ * in a state of running, meaning it is connected and initialized.  It keeps
+ * track of summaries that it is generating as they are broadcast and acked/nacked.
+ * This object is created and controlled by Summarizer object.
+ */
+export declare class RunningSummarizer extends TypedEventEmitter<ISummarizerEvents> implements IDisposable {
+    private readonly summaryWatcher;
+    private readonly configuration;
+    private readonly submitSummaryCallback;
+    private readonly refreshLatestSummaryAckCallback;
+    private readonly heuristicData;
+    private readonly summaryCollection;
+    private readonly cancellationToken;
+    private readonly stopSummarizerCallback;
+    private readonly runtime;
+    static start(logger: ITelemetryBaseLogger, summaryWatcher: IClientSummaryWatcher, configuration: ISummaryConfiguration, submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>, refreshLatestSummaryAckCallback: (options: IRefreshSummaryAckOptions) => Promise<void>, heuristicData: ISummarizeHeuristicData, summaryCollection: SummaryCollection, cancellationToken: ISummaryCancellationToken, stopSummarizerCallback: (reason: SummarizerStopReason) => void, runtime: ISummarizerRuntime): Promise<RunningSummarizer>;
+    get disposed(): boolean;
+    private stopping;
+    private _disposed;
+    private summarizingLock;
+    private tryWhileSummarizing;
+    private readonly pendingAckTimer;
+    private heuristicRunner?;
+    private readonly generator;
+    private readonly mc;
+    private enqueuedSummary;
+    private summarizeCount;
+    private totalSuccessfulAttempts;
+    private initialized;
+    private readonly runtimeListener;
+    /** The maximum number of summary attempts to do when submit summary fails. */
+    private readonly maxAttemptsForSubmitFailures;
+    private constructor();
+    private handleSummaryAck;
+    /**
+     * Responsible for receiving and processing all the summaryAcks.
+     * In case there was a summary ack processed by the running summarizer before processIncomingSummaryAcks is called,
+     * it will wait for the summary ack that is newer than the one indicated by the lastAckRefSeq.
+     * @param lastAckRefSeq - Identifies the minimum reference sequence number the summarizer needs to wait for.
+     * In case of a negative number, the summarizer will wait for ANY summary ack that is greater than the deltaManager's initial sequence number,
+     * and, in case of a positive one, it will wait for a summary ack that is greater than this current reference sequence number.
+     */
+    private processIncomingSummaryAcks;
+    dispose(): void;
+    /**
+     * RunningSummarizer's logger includes the sequenced index of the current summary on each event.
+     * If some other Summarizer code wants that event on their logs they can get it here,
+     * but only if they're logging about that same summary.
+     * @param summaryOpRefSeq - RefSeq number of the summary op, to ensure the log correlation will be correct
+     */
+    tryGetCorrelatedLogger: (summaryOpRefSeq: any) => import("@fluidframework/telemetry-utils").ITelemetryLoggerExt | undefined;
+    /** We only want a single heuristic runner micro-task (will provide better optimized grouping of ops) */
+    private heuristicRunnerMicroTaskExists;
+    handleOp(op: ISequencedDocumentMessage, runtimeMessage: boolean): void;
+    /**
+     * Can the given op trigger a summary?
+     * # Currently always prevents summaries for Summarize and SummaryAck/Nack ops
+     * @param op - op to check
+     * @returns true if this op can trigger a summary
+     */
+    private opCanTriggerSummary;
+    private nonRuntimeOpCanTriggerSummary;
+    waitStop(allowLastSummary: boolean): Promise<void>;
+    private waitStart;
+    private beforeSummaryAction;
+    private afterSummaryAction;
+    /**
+     * Runs single summary action that prevents any other concurrent actions.
+     * Assumes that caller checked upfront for lack of concurrent action (this.summarizingLock)
+     * before calling this API. I.e. caller is responsible for either erroring out or waiting on this promise.
+     * @param before - set of instructions to run before running the action.
+     * @param action - action to perform.
+     * @param after - set of instructions to run after running the action.
+     * @returns The result of the action.
+     */
+    private lockedSummaryAction;
+    /**
+     * Runs single summarize attempt
+     * @param summarizeProps - props to log with each telemetry event associated with this attempt
+     * @param options - summary options
+     * @param cancellationToken - cancellation token to use to be able to cancel this summary, if needed
+     * @param resultsBuilder - optional, result builder to use.
+     * @returns ISummarizeResult - result of running a summary.
+     */
+    private trySummarizeOnce;
+    /** Heuristics summarize attempt. */
+    private trySummarize;
+    /**
+     * Tries to summarize 2 times with pre-defined summary options. If an attempt fails with "retryAfterSeconds"
+     * param, that attempt is tried once more.
+     */
+    private trySummarizeWithStaticAttempts;
+    /**
+     * Tries to summarize with retries where retry is based on the failure params.
+     * For example, summarization may be retried for failures with "retryAfterSeconds" param.
+     */
+    private trySummarizeWithRetries;
+    /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */
+    summarizeOnDemand(options: IOnDemandSummarizeOptions, resultsBuilder?: SummarizeResultBuilder): ISummarizeResults;
+    /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */
+    enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
+    private tryRunEnqueuedSummary;
+    private disposeEnqueuedSummary;
+}
+//# sourceMappingURL=runningSummarizer.d.mts.map

package/lib/summary/runningSummarizer.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runningSummarizer.d.mts","sourceRoot":"","sources":["../../src/summary/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,iCAAiC;OAS5E,EAAE,iBAAiB,EAAE,MAAM,8BAA8B;OAEzD,EAAE,yBAAyB,EAAe,MAAM,sCAAsC;OACtF,EAAE,qBAAqB,EAAE;OAGzB,EACN,wBAAwB,EAExB,uBAAuB,EAEvB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAEjB,kBAAkB,EAElB,yBAAyB,EACzB,iBAAiB,EAEjB;OACM,EAAiB,qBAAqB,EAAE,iBAAiB,EAAE;OAC3D,EAGN,sBAAsB,EAEtB;AAID;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC;;;GAGG;AACH,eAAO,MAAM,mCAAmC,IAAI,CAAC;AAErD;;;;;;GAMG;AACH,qBAAa,iBAAkB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAE,YAAW,WAAW;IAqGhG,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IAGtC,OAAO,CAAC,QAAQ,CAAC,+BAA+B;IAGhD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO;WAhHL,KAAK,CACxB,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,+BAA+B,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,EACtF,aAAa,EAAE,uBAAuB,EACtC,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,EAAE,kBAAkB,GACzB,OAAO,CAAC,iBAAiB,CAAC;IA0D7B,IAAW,QAAQ,YAElB;IACD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,eAAe,CAAC,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAoB;IAEvC,OAAO,CAAC,eAAe,CAOV;IACb,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,uBAAuB,CAAK;IACpC,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;IAEjC,8EAA8E;IAC9E,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAS;IAEtD,OAAO;YA4GO,gBAAgB;IA6D9B;;;;;;;OAOG;YACW,0BAA0B;IAsBjC,OAAO,IAAI,IAAI;IAYtB;;;;;OAKG;IACI,sBAAsB,sGAGf;IAEd,wGAAwG;IACxG,OAAO,CAAC,8BAA8B,CAAS;IAExC,QAAQ,CAAC,EAAE,EAAE,yBAAyB,EAAE,cAAc,EAAE,OAAO;IA8BtE;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,6BAA6B;IAWxB,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA6BjD,SAAS;IAuBvB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,kBAAkB;IAW1B;;;;;;;;OAQG;YACW,mBAAmB;IAsBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAoCxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAyBpB;;;OAGG;YACW,8BAA8B;IAsE5C;;;OAGG;YACW,uBAAuB;IAoIrC,8DAA8D;IACvD,iBAAiB,CACvB,OAAO,EAAE,yBAAyB,EAClC,cAAc,GAAE,sBAAqD,GACnE,iBAAiB;IAqBpB,6DAA6D;IACtD,gBAAgB,CAAC,OAAO,EAAE,wBAAwB,GAAG,sBAAsB;IAiClF,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAS9B"}