@fluidframework/container-runtime 0.52.1 → 0.54.0

package/dist/index.d.ts

@@ -2,10 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export * from "./containerRuntime";
+export { ContainerMessageType, IChunkedOp, ContainerRuntimeMessage, IGCRuntimeOptions, ISummaryRuntimeOptions, IContainerRuntimeOptions, isRuntimeMessage, unpackRuntimeMessage, ScheduleManager, agentSchedulerId, ContainerRuntime, } from "./containerRuntime";
 export * from "./deltaScheduler";
 export * from "./dataStoreRegistry";
-export { IGarbageCollectionRuntime, IGCStats, IUsedStateStats } from "./garbageCollection";
+export { gcBlobPrefix, gcTreeKey, IGarbageCollectionRuntime, IGCStats, IUsedStateStats, } from "./garbageCollection";
 export * from "./pendingStateManager";
 export * from "./summarizer";
 export * from "./summarizerTypes";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,gCAAgC,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,oBAAoB,EACpB,UAAU,EACV,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,OAAO,EACH,YAAY,EACZ,SAAS,EACT,yBAAyB,EACzB,QAAQ,EACR,eAAe,GAClB,MAAM,qBAAqB,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,gCAAgC,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/index.js

@@ -14,10 +14,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.neverCancelledSummaryToken = void 0;
-__exportStar(require("./containerRuntime"), exports);
+exports.neverCancelledSummaryToken = exports.gcTreeKey = exports.gcBlobPrefix = exports.ContainerRuntime = exports.agentSchedulerId = exports.ScheduleManager = exports.unpackRuntimeMessage = exports.isRuntimeMessage = exports.ContainerMessageType = void 0;
+var containerRuntime_1 = require("./containerRuntime");
+Object.defineProperty(exports, "ContainerMessageType", { enumerable: true, get: function () { return containerRuntime_1.ContainerMessageType; } });
+Object.defineProperty(exports, "isRuntimeMessage", { enumerable: true, get: function () { return containerRuntime_1.isRuntimeMessage; } });
+Object.defineProperty(exports, "unpackRuntimeMessage", { enumerable: true, get: function () { return containerRuntime_1.unpackRuntimeMessage; } });
+Object.defineProperty(exports, "ScheduleManager", { enumerable: true, get: function () { return containerRuntime_1.ScheduleManager; } });
+Object.defineProperty(exports, "agentSchedulerId", { enumerable: true, get: function () { return containerRuntime_1.agentSchedulerId; } });
+Object.defineProperty(exports, "ContainerRuntime", { enumerable: true, get: function () { return containerRuntime_1.ContainerRuntime; } });
 __exportStar(require("./deltaScheduler"), exports);
 __exportStar(require("./dataStoreRegistry"), exports);
+var garbageCollection_1 = require("./garbageCollection");
+Object.defineProperty(exports, "gcBlobPrefix", { enumerable: true, get: function () { return garbageCollection_1.gcBlobPrefix; } });
+Object.defineProperty(exports, "gcTreeKey", { enumerable: true, get: function () { return garbageCollection_1.gcTreeKey; } });
 __exportStar(require("./pendingStateManager"), exports);
 __exportStar(require("./summarizer"), exports);
 __exportStar(require("./summarizerTypes"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH,qDAAmC;AACnC,mDAAiC;AACjC,sDAAoC;AAEpC,wDAAsC;AACtC,+CAA6B;AAC7B,oDAAkC;AAClC,sDAAoC;AACpC,+EAA8G;AAAnE,0IAAA,0BAA0B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport * from \"./containerRuntime\";\nexport * from \"./deltaScheduler\";\nexport * from \"./dataStoreRegistry\";\nexport { IGarbageCollectionRuntime, IGCStats, IUsedStateStats } from \"./garbageCollection\";\nexport * from \"./pendingStateManager\";\nexport * from \"./summarizer\";\nexport * from \"./summarizerTypes\";\nexport * from \"./summaryCollection\";\nexport { ICancellableSummarizerController, neverCancelledSummaryToken } from \"./runWhileConnectedCoordinator\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;AAEH,uDAY4B;AAXxB,wHAAA,oBAAoB,OAAA;AAMpB,oHAAA,gBAAgB,OAAA;AAChB,wHAAA,oBAAoB,OAAA;AACpB,mHAAA,eAAe,OAAA;AACf,oHAAA,gBAAgB,OAAA;AAChB,oHAAA,gBAAgB,OAAA;AAEpB,mDAAiC;AACjC,sDAAoC;AACpC,yDAM6B;AALzB,iHAAA,YAAY,OAAA;AACZ,8GAAA,SAAS,OAAA;AAKb,wDAAsC;AACtC,+CAA6B;AAC7B,oDAAkC;AAClC,sDAAoC;AACpC,+EAA8G;AAAnE,0IAAA,0BAA0B,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n    ContainerMessageType,\n    IChunkedOp,\n    ContainerRuntimeMessage,\n    IGCRuntimeOptions,\n    ISummaryRuntimeOptions,\n    IContainerRuntimeOptions,\n    isRuntimeMessage,\n    unpackRuntimeMessage,\n    ScheduleManager,\n    agentSchedulerId,\n    ContainerRuntime,\n} from \"./containerRuntime\";\nexport * from \"./deltaScheduler\";\nexport * from \"./dataStoreRegistry\";\nexport {\n    gcBlobPrefix,\n    gcTreeKey,\n    IGarbageCollectionRuntime,\n    IGCStats,\n    IUsedStateStats,\n} from \"./garbageCollection\";\nexport * from \"./pendingStateManager\";\nexport * from \"./summarizer\";\nexport * from \"./summarizerTypes\";\nexport * from \"./summaryCollection\";\nexport { ICancellableSummarizerController, neverCancelledSummaryToken } from \"./runWhileConnectedCoordinator\";\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/container-runtime";
-export declare const pkgVersion = "0.52.1";
+export declare const pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/container-runtime";
-exports.pkgVersion = "0.52.1";
+exports.pkgVersion = "0.54.0";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,mCAAmC,CAAC;AAC9C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-runtime\";\nexport const pkgVersion = \"0.52.1\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,mCAAmC,CAAC;AAC9C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/container-runtime\";\nexport const pkgVersion = \"0.54.0\";\n"]}

package/dist/runningSummarizer.d.ts

@@ -4,8 +4,9 @@
  */
 import { IDisposable, ITelemetryLogger } from "@fluidframework/common-definitions";
 import { ISequencedDocumentMessage, ISummaryConfiguration } from "@fluidframework/protocol-definitions";
-import { IEnqueueSummarizeOptions, ISummarizeHeuristicData, ISummarizerOptions, OnDemandSummarizeResult, IOnDemandSummarizeOptions, EnqueueSummarizeResult, SummarizerStopReason, ISubmitSummaryOptions, SubmitSummaryResult, ISummaryCancellationToken } from "./summarizerTypes";
+import { IEnqueueSummarizeOptions, ISummarizeHeuristicData, ISummarizerOptions, IOnDemandSummarizeOptions, EnqueueSummarizeResult, SummarizerStopReason, ISubmitSummaryOptions, SubmitSummaryResult, ISummaryCancellationToken, ISummarizeResults } from "./summarizerTypes";
 import { IClientSummaryWatcher, SummaryCollection } from "./summaryCollection";
+import { SummarizeResultBuilder } from "./summaryGenerator";
 /**
  * An instance of RunningSummarizer manages the heuristics for summarizing.
  * Until disposed, the instance of RunningSummarizer can assume that it is
@@ -67,7 +68,7 @@ export declare class RunningSummarizer implements IDisposable {
     /** Heuristics summarize attempt. */
     private trySummarize;
     /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */
-    summarizeOnDemand({ reason, ...options }: IOnDemandSummarizeOptions): OnDemandSummarizeResult;
+    summarizeOnDemand(resultsBuilder: SummarizeResultBuilder | undefined, { reason, ...options }: IOnDemandSummarizeOptions): ISummarizeResults;
     /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */
     enqueueSummarize({ reason, afterSequenceNumber, override, ...options }: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
     private tryRunEnqueuedSummary;

package/dist/runningSummarizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runningSummarizer.d.ts","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAwB,MAAM,oCAAoC,CAAC;AAEzG,OAAO,EACH,yBAAyB,EACzB,qBAAqB,EAExB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACH,wBAAwB,EAExB,uBAAuB,EAEvB,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EAE5B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAU/E;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IAoD7C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;WA1DvB,KAAK,CACrB,MAAM,EAAE,gBAAgB,EACxB,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,EAClD,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAChD,OAAO,CAAC,iBAAiB,CAAC;IAoB7B,IAAW,QAAQ,YAA6B;IAEhD,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,MAAM,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAKT;IACd,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO;IA+DA,OAAO,IAAI,IAAI;IAWtB;;;;;OAKG;IACI,sBAAsB,yDAGT;IAEb,cAAc,CAAC,EAAE,EAAE,yBAAyB;IAgB5C,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,yBAAyB;IAiBtF,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA4BjD,SAAS;IAqBvB;;;;;;OAMG;YACW,mBAAmB;IAuBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAwBxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAmFpB,8DAA8D;IACvD,iBAAiB,CAAC,EACrB,MAAM,EACN,GAAG,OAAO,EACb,EAAE,yBAAyB,GAAG,uBAAuB;IAmBtD,6DAA6D;IACtD,gBAAgB,CAAC,EACpB,MAAM,EACN,mBAAuB,EACvB,QAAgB,EAChB,GAAG,OAAO,EACb,EAAE,wBAAwB,GAAG,sBAAsB;IA8BpD,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAMjC"}
+{"version":3,"file":"runningSummarizer.d.ts","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAwB,MAAM,oCAAoC,CAAC;AAGzG,OAAO,EACH,yBAAyB,EACzB,qBAAqB,EAExB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACH,wBAAwB,EAExB,uBAAuB,EAEvB,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAGH,sBAAsB,EAEzB,MAAM,oBAAoB,CAAC;AAI5B;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IAoD7C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;WA1DvB,KAAK,CACrB,MAAM,EAAE,gBAAgB,EACxB,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,EAClD,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAChD,OAAO,CAAC,iBAAiB,CAAC;IAoB7B,IAAW,QAAQ,YAA6B;IAEhD,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,MAAM,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAKT;IACd,OAAO,CAAC,cAAc,CAAK;IAE3B,OAAO;IA+DA,OAAO,IAAI,IAAI;IAWtB;;;;;OAKG;IACI,sBAAsB,yDAGT;IAEb,cAAc,CAAC,EAAE,EAAE,yBAAyB;IAgB5C,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,yBAAyB;IAiBtF,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA4BjD,SAAS;IAqBvB;;;;;;OAMG;YACW,mBAAmB;IAuBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAwBxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAmFpB,8DAA8D;IACvD,iBAAiB,CACpB,cAAc,oCAAuD,EACrE,EACI,MAAM,EACN,GAAG,OAAO,EACb,EAAE,yBAAyB,GAAG,iBAAiB;IAmBpD,6DAA6D;IACtD,gBAAgB,CAAC,EACpB,MAAM,EACN,mBAAuB,EACvB,QAAgB,EAChB,GAAG,OAAO,EACb,EAAE,wBAAwB,GAAG,sBAAsB;IA8BpD,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAMjC"}

package/dist/runningSummarizer.js

@@ -17,6 +17,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunningSummarizer = void 0;
 const common_utils_1 = require("@fluidframework/common-utils");
+const container_utils_1 = require("@fluidframework/container-utils");
 const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
 const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const summarizerHeuristics_1 = require("./summarizerHeuristics");
@@ -283,20 +284,19 @@ class RunningSummarizer {
         });
     }
     /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */
-    summarizeOnDemand(_a) {
+    summarizeOnDemand(resultsBuilder = new summaryGenerator_1.SummarizeResultBuilder(), _a) {
         var { reason } = _a, options = __rest(_a, ["reason"]);
         if (this.stopping) {
-            const failBuilder = new summaryGenerator_1.SummarizeResultBuilder();
-            failBuilder.fail("RunningSummarizer stopped or disposed", undefined);
-            return failBuilder.build();
+            resultsBuilder.fail("RunningSummarizer stopped or disposed", undefined);
+            return resultsBuilder.build();
         }
         // Check for concurrent summary attempts. If one is found,
         // return a promise that caller can await before trying again.
         if (this.summarizingLock !== undefined) {
             // The heuristics are blocking concurrent summarize attempts.
-            return { alreadyRunning: this.summarizingLock };
+            throw new container_utils_1.UsageError("Attempted to run an already-running summarizer on demand");
         }
-        const result = this.trySummarizeOnce({ summarizeReason: `onDemand/${reason}` }, options, this.cancellationToken);
+        const result = this.trySummarizeOnce({ summarizeReason: `onDemand/${reason}` }, options, this.cancellationToken, resultsBuilder);
         return result;
     }
     /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */

package/dist/runningSummarizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"runningSummarizer.js","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;AAGH,+DAAqF;AACrF,+EAI8C;AAC9C,qEAA8D;AAC9D,iEAAkE;AAiBlE,yDAK4B;AAE5B,MAAM,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAE7D;;;;;;GAMG;AACH,MAAa,iBAAiB;IAkD1B,YACI,UAA4B,EACX,cAAqC,EACrC,aAAoC,EACpC,qBAAuF,EACvF,aAAsC,EACtC,qBAAkD,EAClD,iBAAoC,EACpC,iBAA4C,EAC5C,sBAA8D,EAC/E,EAAE,iBAAiB,GAAG,KAAK,KAA4C,EAAE;QARxD,mBAAc,GAAd,cAAc,CAAuB;QACrC,kBAAa,GAAb,aAAa,CAAuB;QACpC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAA6B;QAClD,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpC,sBAAiB,GAAjB,iBAAiB,CAA2B;QAC5C,2BAAsB,GAAtB,sBAAsB,CAAwC;QAzB3E,aAAQ,GAAG,KAAK,CAAC;QACjB,cAAS,GAAG,KAAK,CAAC;QAElB,wBAAmB,GAAG,KAAK,CAAC;QAW5B,mBAAc,GAAG,CAAC,CAAC;QA4E3B;;;;;WAKG;QACI,2BAAsB,GAAG,CAAC,eAAe,EAAE,EAAE,CAChD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,KAAK,eAAe;YAChE,CAAC,CAAC,IAAI,CAAC,MAAM;YACb,CAAC,CAAC,SAAS,CAAC;QAvEhB,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,UAAU,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAElF,IAAI,CAAC,iBAAiB,EAAE;YACpB,IAAI,CAAC,eAAe,GAAG,IAAI,+CAAwB,CAC/C,aAAa,EACb,aAAa,EACb,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;SAC9C;QAED,oGAAoG;QACpG,+FAA+F;QAC/F,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;QAE5F,IAAI,CAAC,eAAe,GAAG,IAAI,2BAAY,CACnC,cAAc,EACd,GAAG,EAAE;YACD,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;YACpD,8DAA8D;YAC9D,sEAAsE;YACtE,2DAA2D;YAC3D,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,uBAAuB;gBAClC,cAAc;gBACd,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB;gBACzE,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB;gBAC3E,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW;aACvE,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACP,iFAAiF;QACjF,iBAAiB,CAAC,iCAAiC,CAAC,cAAc,EAAE,GAAG,EAAE;YACrE,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;gBAC/B,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,EAAE,6BAA6B;oBACxC,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB;oBACzE,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB;iBAC9E,CAAC,CAAC;gBACH,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;aAChC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,IAAI,mCAAgB,CACjC,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,qBAAqB,EAC1B,IAAI,CAAC,qBAAqB,EAC1B,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,MAAM,CACd,CAAC;IACN,CAAC;IA9GM,MAAM,CAAC,KAAK,CAAC,KAAK,CACrB,MAAwB,EACxB,cAAqC,EACrC,aAAoC,EACpC,qBAAuF,EACvF,aAAsC,EACtC,qBAAkD,EAClD,iBAAoC,EACpC,iBAA4C,EAC5C,sBAA8D,EAC9D,OAA+C;;QAE/C,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,MAAM,EACN,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,OAAO,CAAC,CAAC;QAEb,MAAM,UAAU,CAAC,SAAS,EAAE,CAAC;QAE7B,oCAAoC;QACpC,MAAA,UAAU,CAAC,eAAe,0CAAE,GAAG,GAAG;QAClC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAiFzC,OAAO;;QACV,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAA,IAAI,CAAC,eAAe,0CAAE,OAAO,GAAG;QAChC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAaM,cAAc,CAAC,EAA6B;QAC/C,QAAQ,EAAE,CAAC,IAAI,EAAE;YACb,KAAK,kCAAW,CAAC,WAAW,CAAC;YAC7B,KAAK,kCAAW,CAAC,UAAU,CAAC;YAC5B,KAAK,kCAAW,CAAC,OAAO,CAAC;YACzB,KAAK,kCAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,mDAAmD;gBACnD,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBAC7B,OAAO;aACV;YACD,OAAO,CAAC,CAAC;gBACL,OAAO;aACV;SACJ;IACL,CAAC;IAEM,QAAQ,CAAC,KAAU,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAA6B;;QAC/F,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO;SACV;QACD,IAAI,CAAC,aAAa,CAAC,oBAAoB,GAAG,cAAc,CAAC;QAEzD,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE;YAC9B,mEAAmE;SACtE;aAAM,IAAI,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;YAClC,mCAAmC;YACnC,+DAA+D;YAC/D,IAAI,CAAC,YAAY,CAAC,QAAQ,QAAQ,KAAK,QAAQ,EAAW,CAAC,CAAC;SAC/D;aAAM;YACH,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,GAAG;SAC/B;IACL,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,gBAAyB;;QAC3C,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,OAAO;SACV;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,8CAA8C;QAC9C,IAAI,gBAAgB,WAAI,IAAI,CAAC,eAAe,0CAAE,oBAAoB,GAAE,EAAE;YAClE,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;gBACpC,IAAI,CAAC,gBAAgB;gBACjB,iBAAiB;gBACjB,EAAE,eAAe,EAAE,aAAa,EAAE;gBAClC,kFAAkF;gBAClF,EAAE,CAAC,CAAC;aACX;SACJ;QAED,+EAA+E;QAC/E,qFAAqF;QACrF,6FAA6F;QAC7F,0FAA0F;QAC1F,uEAAuE;QACvE,MAAM,IAAI,CAAC,eAAe,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,SAAS;QACnB,kDAAkD;QAClD,MAAM,eAAe,GAAG,MAAM,4BAAS,CACnC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,EACjC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAC/B,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7B,sEAAsE;QACtE,uEAAuE;QACvE,IAAI,CAAC,iBAAiB,CAAC,mCAAmC,EAAE,CAAC;QAE7D,IAAI,eAAe,CAAC,MAAM,KAAK,MAAM,IAAI,eAAe,CAAC,KAAK,KAAK,SAAS,EAAE;YAC1E,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;gBAC1B,iBAAiB,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,uBAAuB;gBAC1E,WAAW,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS;gBACtD,qBAAqB,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc;aACxE,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,mBAAmB,CAAI,MAAwB;QACzD,qBAAM,CAAE,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAEnG,MAAM,eAAe,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC;QAE/C,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;;YACzB,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YAEjC,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC;YACvC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;YAEjC,2EAA2E;YAC3E,yDAAyD;YACzD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,KAAK,EAAE;gBAC1D,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,GAAG;aAC/B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CACpB,cAAoC,EACpC,OAA0B,EAC1B,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAC1C,cAAc,GAAG,IAAI,yCAAsB,EAAE;QAE7C,IAAI,CAAC,mBAAmB,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAC5C,cAAc,EACd,OAAO,EACP,iBAAiB,EACjB,cAAc,CAAC,CAAC;YACpB,6CAA6C;YAC7C,OAAO,eAAe,CAAC,wBAAwB,CAAC;QACpD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,6FAA6F;YAC7F,oBAAoB;YACpB,4FAA4F;YAC5F,iCAAiC;QACrC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,oCAAoC;IAC5B,YAAY,CAChB,eAAgC,EAChC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB;QAE1C,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,yFAAyF;YACzF,uBAAuB;YACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAChC,OAAO;SACV;QAED,IAAI,CAAC,mBAAmB,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,QAAQ,GAAsD;gBAChE,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;gBAC5C,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;gBAC3C,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE;gBACjE,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,EAAE;aACpE,CAAC;YACF,IAAI,oBAAwC,CAAC;YAC7C,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,IAAI,eAAe,GAAG,CAAC,CAAC;YAExB,IAAI,UAAwD,CAAC;YAE7D,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC,MAAM,GAAG;gBACxD,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;oBAClC,OAAO;iBACV;gBAED,aAAa,EAAE,CAAC;gBAChB,eAAe,EAAE,CAAC;gBAElB,MAAM,KAAwD,QAAQ,CAAC,YAAY,CAAC,EAA9E,EAAE,YAAY,EAAE,mBAAmB,GAAG,CAAC,OAAuC,EAAlC,OAAO,cAAnD,gBAAqD,CAAyB,CAAC;gBACrF,MAAM,YAAY,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,mBAAmB,CAAC;gBAEjE,MAAM,cAAc,mBAChB,eAAe,EACf,sBAAsB,EAAE,aAAa,EACrC,yBAAyB,EAAE,eAAe,EAC1C,qBAAqB,EAAE,YAAY,GAAG,CAAC,IACpC,OAAO,CACb,CAAC;gBAEF,IAAI,YAAY,GAAG,CAAC,EAAE;oBAClB,IAAI,CAAC,MAAM,CAAC,oBAAoB,iBAC5B,SAAS,EAAE,uBAAuB,EAClC,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,IAC5E,cAAc,EACnB,CAAC;oBACH,MAAM,oBAAK,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;iBACpC;gBACD,wEAAwE;gBACxE,2FAA2F;gBAC3F,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;gBAC7F,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,wBAAwB,CAAC;gBAE9D,IAAI,MAAM,CAAC,OAAO,EAAE;oBAChB,OAAO;iBACV;gBACD,8EAA8E;gBAC9E,yDAAyD;gBACzD,oBAAoB,GAAG,MAAM,CAAC,iBAAiB,CAAC;gBAChD,IAAI,oBAAoB,KAAK,SAAS,IAAI,eAAe,GAAG,CAAC,EAAE;oBAC3D,YAAY,EAAE,CAAC;oBACf,eAAe,GAAG,CAAC,CAAC;iBACvB;gBACD,UAAU,GAAG,MAAM,CAAC;aACvB;YAED,gGAAgG;YAChG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,iBAAiB;gBAC5B,eAAe;gBACf,OAAO,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO;aAC/B,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,CAAC;YAEtB,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,KAAK,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IAED,8DAA8D;IACvD,iBAAiB,CAAC,EAGG;YAHH,EACrB,MAAM,OAEkB,EADrB,OAAO,cAFW,UAGxB,CADa;QAEV,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,MAAM,WAAW,GAAG,IAAI,yCAAsB,EAAE,CAAC;YACjD,WAAW,CAAC,IAAI,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YACrE,OAAO,WAAW,CAAC,KAAK,EAAE,CAAC;SAC9B;QACD,0DAA0D;QAC1D,8DAA8D;QAC9D,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,6DAA6D;YAC7D,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;SACnD;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAChC,EAAE,eAAe,EAAE,YAAY,MAAM,EAAE,EAAE,EACzC,OAAO,EACP,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,6DAA6D;IACtD,gBAAgB,CAAC,EAKG;YALH,EACpB,MAAM,EACN,mBAAmB,GAAG,CAAC,EACvB,QAAQ,GAAG,KAAK,OAEO,EADpB,OAAO,cAJU,6CAKvB,CADa;QAEV,MAAM,cAAc,GAAG,WAAW,MAAM,EAAW,CAAC;QACpD,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,QAAQ,EAAE;gBACX,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;aACpC;YACD,gDAAgD;YAChD,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CACpC,0DAA0D,EAC1D,SAAS,CACZ,CAAC;YACF,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YACjC,UAAU,GAAG,IAAI,CAAC;SACrB;QACD,IAAI,CAAC,eAAe,GAAG;YACnB,MAAM,EAAE,cAAc;YACtB,mBAAmB;YACnB,OAAO;YACP,cAAc,EAAE,IAAI,yCAAsB,EAAE;SAC/C,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5D,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC,CAAC,iCACZ,OAAO,KACV,eAAe,EAAE,IAAI,EACrB,UAAU,EAAE,IAAI,IAClB,CAAC,CAAC,OAAO,CAAC;IAChB,CAAC;IAEO,qBAAqB;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;SAChB;QACD,IACI,IAAI,CAAC,eAAe,KAAK,SAAS;eAC/B,IAAI,CAAC,aAAa,CAAC,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,mBAAmB;eAClF,IAAI,CAAC,eAAe,KAAK,SAAS,EACvC;YACE,uFAAuF;YACvF,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC;QACjE,+FAA+F;QAC/F,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,CACjB,EAAE,eAAe,EAAE,mBAAmB,MAAM,EAAE,EAAE,EAChD,OAAO,EACP,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,sBAAsB;QAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YAC7F,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SACpC;IACL,CAAC;CACJ;AApcD,8CAocC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, ITelemetryLogger, ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { assert, delay, Deferred, PromiseTimer } from \"@fluidframework/common-utils\";\nimport {\n    ISequencedDocumentMessage,\n    ISummaryConfiguration,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { SummarizeHeuristicRunner } from \"./summarizerHeuristics\";\nimport {\n    IEnqueueSummarizeOptions,\n    ISummarizeOptions,\n    ISummarizeHeuristicData,\n    ISummarizeHeuristicRunner,\n    ISummarizerOptions,\n    OnDemandSummarizeResult,\n    IOnDemandSummarizeOptions,\n    EnqueueSummarizeResult,\n    SummarizerStopReason,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    ISummaryCancellationToken,\n    ISummarizeResults,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher, SummaryCollection } from \"./summaryCollection\";\nimport {\n    raceTimer,\n    SummarizeReason,\n    SummarizeResultBuilder,\n    SummaryGenerator,\n} from \"./summaryGenerator\";\n\nconst maxSummarizeAckWaitTime = 10 * 60 * 1000; // 10 minutes\n\n/**\n * An instance of RunningSummarizer manages the heuristics for summarizing.\n * Until disposed, the instance of RunningSummarizer can assume that it is\n * in a state of running, meaning it is connected and initialized.  It keeps\n * track of summaries that it is generating as they are broadcast and acked/nacked.\n * This object is created and controlled by Summarizer object.\n */\nexport class RunningSummarizer implements IDisposable {\n    public static async start(\n        logger: ITelemetryLogger,\n        summaryWatcher: IClientSummaryWatcher,\n        configuration: ISummaryConfiguration,\n        submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        heuristicData: ISummarizeHeuristicData,\n        raiseSummarizingError: (errorCode: string) => void,\n        summaryCollection: SummaryCollection,\n        cancellationToken: ISummaryCancellationToken,\n        stopSummarizerCallback: (reason: SummarizerStopReason) => void,\n        options?: Readonly<Partial<ISummarizerOptions>>,\n    ): Promise<RunningSummarizer> {\n        const summarizer = new RunningSummarizer(\n            logger,\n            summaryWatcher,\n            configuration,\n            submitSummaryCallback,\n            heuristicData,\n            raiseSummarizingError,\n            summaryCollection,\n            cancellationToken,\n            stopSummarizerCallback,\n            options);\n\n        await summarizer.waitStart();\n\n        // Run the heuristics after starting\n        summarizer.heuristicRunner?.run();\n        return summarizer;\n    }\n\n    public get disposed() { return this._disposed; }\n\n    private stopping = false;\n    private _disposed = false;\n    private summarizingLock: Promise<void> | undefined;\n    private tryWhileSummarizing = false;\n    private readonly pendingAckTimer: PromiseTimer;\n    private heuristicRunner?: ISummarizeHeuristicRunner;\n    private readonly generator: SummaryGenerator;\n    private readonly logger: ITelemetryLogger;\n    private enqueuedSummary: {\n        reason: SummarizeReason;\n        afterSequenceNumber: number;\n        options: ISummarizeOptions;\n        readonly resultsBuilder: SummarizeResultBuilder;\n    } | undefined;\n    private summarizeCount = 0;\n\n    private constructor(\n        baseLogger: ITelemetryLogger,\n        private readonly summaryWatcher: IClientSummaryWatcher,\n        private readonly configuration: ISummaryConfiguration,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly raiseSummarizingError: (errorCode: string) => void,\n        private readonly summaryCollection: SummaryCollection,\n        private readonly cancellationToken: ISummaryCancellationToken,\n        private readonly stopSummarizerCallback: (reason: SummarizerStopReason) => void,\n        { disableHeuristics = false }: Readonly<Partial<ISummarizerOptions>> = {},\n    ) {\n        this.logger = ChildLogger.create(\n            baseLogger, \"Running\", { all: { summaryGenTag: () => this.summarizeCount } });\n\n        if (!disableHeuristics) {\n            this.heuristicRunner = new SummarizeHeuristicRunner(\n                heuristicData,\n                configuration,\n                (reason) => this.trySummarize(reason));\n        }\n\n        // Cap the maximum amount of time client will wait for a summarize op ack to maxSummarizeAckWaitTime\n        // configuration.maxAckWaitTime is composed from defaults, server values, and runtime overrides\n        const maxAckWaitTime = Math.min(this.configuration.maxAckWaitTime, maxSummarizeAckWaitTime);\n\n        this.pendingAckTimer = new PromiseTimer(\n            maxAckWaitTime,\n            () => {\n                this.raiseSummarizingError(\"summaryAckWaitTimeout\");\n                // Note: summaryGenTag (from ChildLogger definition) may be 0,\n                // since this code path is hit when RunningSummarizer first starts up,\n                // before this instance has kicked off a new summarize run.\n                this.logger.sendErrorEvent({\n                    eventName: \"SummaryAckWaitTimeout\",\n                    maxAckWaitTime,\n                    referenceSequenceNumber: this.heuristicData.lastAttempt.refSequenceNumber,\n                    summarySequenceNumber: this.heuristicData.lastAttempt.summarySequenceNumber,\n                    timePending: Date.now() - this.heuristicData.lastAttempt.summaryTime,\n                });\n            });\n        // Set up pending ack timeout by op timestamp differences for previous summaries.\n        summaryCollection.setPendingAckTimerTimeoutCallback(maxAckWaitTime, () => {\n            if (this.pendingAckTimer.hasTimer) {\n                this.logger.sendTelemetryEvent({\n                    eventName: \"MissingSummaryAckFoundByOps\",\n                    referenceSequenceNumber: this.heuristicData.lastAttempt.refSequenceNumber,\n                    summarySequenceNumber: this.heuristicData.lastAttempt.summarySequenceNumber,\n                });\n                this.pendingAckTimer.clear();\n            }\n        });\n\n        this.generator = new SummaryGenerator(\n            this.pendingAckTimer,\n            this.heuristicData,\n            this.submitSummaryCallback,\n            this.raiseSummarizingError,\n            this.summaryWatcher,\n            this.logger,\n        );\n    }\n\n    public dispose(): void {\n        this.summaryWatcher.dispose();\n        this.heuristicRunner?.dispose();\n        this.heuristicRunner = undefined;\n        this.generator.dispose();\n        this.pendingAckTimer.clear();\n        this.disposeEnqueuedSummary();\n        this._disposed = true;\n        this.stopping = true;\n    }\n\n    /**\n     * RunningSummarizer's logger includes the sequenced index of the current summary on each event.\n     * If some other Summarizer code wants that event on their logs they can get it here,\n     * but only if they're logging about that same summary.\n     * @param summaryOpRefSeq - RefSeq number of the summary op, to ensure the log correlation will be correct\n     */\n    public tryGetCorrelatedLogger = (summaryOpRefSeq) =>\n        this.heuristicData.lastAttempt.refSequenceNumber === summaryOpRefSeq\n            ? this.logger\n            : undefined;\n\n    public handleSystemOp(op: ISequencedDocumentMessage) {\n        switch (op.type) {\n            case MessageType.ClientLeave:\n            case MessageType.ClientJoin:\n            case MessageType.Propose:\n            case MessageType.Reject: {\n                // Synchronously handle quorum ops like regular ops\n                this.handleOp(undefined, op);\n                return;\n            }\n            default: {\n                return;\n            }\n        }\n    }\n\n    public handleOp(error: any, { sequenceNumber, type, clientId, contents }: ISequencedDocumentMessage) {\n        if (error !== undefined) {\n            return;\n        }\n        this.heuristicData.lastOpSequenceNumber = sequenceNumber;\n\n        if (this.tryRunEnqueuedSummary()) {\n            // Intentionally do nothing; check for enqueued on-demand summaries\n        } else if (type === MessageType.Save) {\n            // Check for ops requesting summary\n            // Note: as const is only required until TypeScript version 4.3\n            this.trySummarize(`save;${clientId}: ${contents}` as const);\n        } else {\n            this.heuristicRunner?.run();\n        }\n    }\n\n    public async waitStop(allowLastSummary: boolean): Promise<void> {\n        if (this.stopping) {\n            return;\n        }\n\n        this.stopping = true;\n\n        this.disposeEnqueuedSummary();\n\n        // This will try to run lastSummary if needed.\n        if (allowLastSummary && this.heuristicRunner?.shouldRunLastSummary()) {\n            if (this.summarizingLock === undefined) {\n                this.trySummarizeOnce(\n                    // summarizeProps\n                    { summarizeReason: \"lastSummary\" },\n                    // ISummarizeOptions, using defaults: { refreshLatestAck: false, fullTree: false }\n                    {});\n            }\n        }\n\n        // Note that trySummarizeOnce() call above returns right away, without waiting.\n        // So we need to wait for its completion, otherwise it would be destroyed right away.\n        // That said, if summary lock was taken upfront, this wait might wait on  multiple retries to\n        // submit summary. We should reconsider this flow and make summarizer move to exit faster.\n        // This resolves when the current pending summary gets an ack or fails.\n        await this.summarizingLock;\n    }\n\n    private async waitStart() {\n        // Wait no longer than ack timeout for all pending\n        const waitStartResult = await raceTimer(\n            this.summaryWatcher.waitFlushed(),\n            this.pendingAckTimer.start(),\n        );\n        this.pendingAckTimer.clear();\n\n        // Remove pending ack wait timeout by op timestamp comparison, because\n        // it has race conditions with summaries submitted by this same client.\n        this.summaryCollection.unsetPendingAckTimerTimeoutCallback();\n\n        if (waitStartResult.result === \"done\" && waitStartResult.value !== undefined) {\n            this.heuristicData.initialize({\n                refSequenceNumber: waitStartResult.value.summaryOp.referenceSequenceNumber,\n                summaryTime: waitStartResult.value.summaryOp.timestamp,\n                summarySequenceNumber: waitStartResult.value.summaryOp.sequenceNumber,\n            });\n        }\n    }\n\n    /**\n     * Runs single summary action that prevents any other concurrent actions.\n     * Assumes that caller checked upfront for lack of concurrent action (this.summarizingLock)\n     * before calling this API. I.e. caller is responsible for either erroring out or waiting on this promise.\n     * @param action - action to perform.\n     * @returns - result of action.\n     */\n    private async lockedSummaryAction<T>(action: () => Promise<T>) {\n        assert (this.summarizingLock === undefined, 0x25b /* \"Caller is responsible for checking lock\" */);\n\n        const summarizingLock = new Deferred<void>();\n        this.summarizingLock = summarizingLock.promise;\n\n        this.summarizeCount++;\n\n        return action().finally(() => {\n            summarizingLock.resolve();\n            this.summarizingLock = undefined;\n\n            const retry = this.tryWhileSummarizing;\n            this.tryWhileSummarizing = false;\n\n            // After summarizing, we should check to see if we need to summarize again.\n            // Rerun the heuristics and check for enqueued summaries.\n            if (!this.stopping && !this.tryRunEnqueuedSummary() && retry) {\n                this.heuristicRunner?.run();\n            }\n        });\n    }\n\n    /**\n     * Runs single summarize attempt\n     * @param summarizeProps - props to log with each telemetry event associated with this attempt\n     * @param options - summary options\n     * @param cancellationToken - cancellation token to use to be able to cancel this summary, if needed\n     * @param resultsBuilder - optional, result builder to use.\n     * @returns ISummarizeResult - result of running a summary.\n     */\n    private trySummarizeOnce(\n        summarizeProps: ITelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken = this.cancellationToken,\n        resultsBuilder = new SummarizeResultBuilder()): ISummarizeResults\n    {\n        this.lockedSummaryAction(async () => {\n            const summarizeResult = this.generator.summarize(\n                summarizeProps,\n                options,\n                cancellationToken,\n                resultsBuilder);\n            // ensure we wait till the end of the process\n            return summarizeResult.receivedSummaryAckOrNack;\n        }).catch((error) => {\n            // SummaryGenerator.summarize() does not throw exceptions - it converts them to failed result\n            // on resultsBuilder\n            // We do not care about exceptions on receivedSummaryAckOrNack - caller should check results\n            // and take a appropriate action.\n        });\n\n        return resultsBuilder.build();\n    }\n\n    /** Heuristics summarize attempt. */\n    private trySummarize(\n        summarizeReason: SummarizeReason,\n        cancellationToken = this.cancellationToken): void\n    {\n        if (this.summarizingLock !== undefined) {\n            // lockedSummaryAction() will retry heuristic-based summary at the end of current attempt\n            // if it's still needed\n            this.tryWhileSummarizing = true;\n            return;\n        }\n\n        this.lockedSummaryAction(async () => {\n            const attempts: (ISummarizeOptions & { delaySeconds?: number })[] = [\n                { refreshLatestAck: false, fullTree: false },\n                { refreshLatestAck: true, fullTree: false },\n                { refreshLatestAck: true, fullTree: false, delaySeconds: 2 * 60 },\n                { refreshLatestAck: true, fullTree: true, delaySeconds: 10 * 60 },\n            ];\n            let overrideDelaySeconds: number | undefined;\n            let totalAttempts = 0;\n            let attemptPerPhase = 0;\n\n            let lastResult: { message: string; error: any; } | undefined;\n\n            for (let attemptPhase = 0; attemptPhase < attempts.length;) {\n                if (this.cancellationToken.cancelled) {\n                    return;\n                }\n\n                totalAttempts++;\n                attemptPerPhase++;\n\n                const { delaySeconds: regularDelaySeconds = 0, ...options } = attempts[attemptPhase];\n                const delaySeconds = overrideDelaySeconds ?? regularDelaySeconds;\n\n                const summarizeProps: ITelemetryProperties = {\n                    summarizeReason,\n                    summarizeTotalAttempts: totalAttempts,\n                    summarizeAttemptsPerPhase: attemptPerPhase,\n                    summarizeAttemptPhase: attemptPhase + 1, // make everything 1-based\n                    ...options,\n                };\n\n                if (delaySeconds > 0) {\n                    this.logger.sendPerformanceEvent({\n                        eventName: \"SummarizeAttemptDelay\",\n                        duration: delaySeconds,\n                        reason: overrideDelaySeconds !== undefined ? \"nack with retryAfter\" : undefined,\n                        ...summarizeProps,\n                    });\n                    await delay(delaySeconds * 1000);\n                }\n                // Note: no need to account for cancellationToken.waitCancelled here, as\n                // this is accounted SummaryGenerator.summarizeCore that controls receivedSummaryAckOrNack.\n                const resultSummarize = this.generator.summarize(summarizeProps, options, cancellationToken);\n                const result = await resultSummarize.receivedSummaryAckOrNack;\n\n                if (result.success) {\n                    return;\n                }\n                // Check for retryDelay that can come from summaryNack or upload summary flow.\n                // Retry the same step only once per retryAfter response.\n                overrideDelaySeconds = result.retryAfterSeconds;\n                if (overrideDelaySeconds === undefined || attemptPerPhase > 1) {\n                    attemptPhase++;\n                    attemptPerPhase = 0;\n                }\n                lastResult = result;\n            }\n\n            // If all attempts failed, log error (with last attempt info) and close the summarizer container\n            this.logger.sendErrorEvent({\n                eventName: \"FailToSummarize\",\n                summarizeReason,\n                message: lastResult?.message,\n            }, lastResult?.error);\n\n            this.stopSummarizerCallback(\"failToSummarize\");\n        }).catch((error) => {\n            this.logger.sendErrorEvent({ eventName: \"UnexpectedSummarizeError\" }, error);\n        });\n    }\n\n    /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */\n    public summarizeOnDemand({\n        reason,\n        ...options\n    }: IOnDemandSummarizeOptions): OnDemandSummarizeResult {\n        if (this.stopping) {\n            const failBuilder = new SummarizeResultBuilder();\n            failBuilder.fail(\"RunningSummarizer stopped or disposed\", undefined);\n            return failBuilder.build();\n        }\n        // Check for concurrent summary attempts. If one is found,\n        // return a promise that caller can await before trying again.\n        if (this.summarizingLock !== undefined) {\n            // The heuristics are blocking concurrent summarize attempts.\n            return { alreadyRunning: this.summarizingLock };\n        }\n        const result = this.trySummarizeOnce(\n            { summarizeReason: `onDemand/${reason}` },\n            options,\n            this.cancellationToken);\n        return result;\n    }\n\n    /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */\n    public enqueueSummarize({\n        reason,\n        afterSequenceNumber = 0,\n        override = false,\n        ...options\n    }: IEnqueueSummarizeOptions): EnqueueSummarizeResult {\n        const onDemandReason = `enqueue;${reason}` as const;\n        let overridden = false;\n        if (this.enqueuedSummary !== undefined) {\n            if (!override) {\n                return { alreadyEnqueued: true };\n            }\n            // Override existing enqueued summarize attempt.\n            this.enqueuedSummary.resultsBuilder.fail(\n                \"Aborted; overridden by another enqueue summarize attempt\",\n                undefined,\n            );\n            this.enqueuedSummary = undefined;\n            overridden = true;\n        }\n        this.enqueuedSummary = {\n            reason: onDemandReason,\n            afterSequenceNumber,\n            options,\n            resultsBuilder: new SummarizeResultBuilder(),\n        };\n        const results = this.enqueuedSummary.resultsBuilder.build();\n        this.tryRunEnqueuedSummary();\n        return overridden ? {\n            ...results,\n            alreadyEnqueued: true,\n            overridden: true,\n        } : results;\n    }\n\n    private tryRunEnqueuedSummary() {\n        if (this.stopping) {\n            this.disposeEnqueuedSummary();\n            return false;\n        }\n        if (\n            this.enqueuedSummary === undefined\n            || this.heuristicData.lastOpSequenceNumber < this.enqueuedSummary.afterSequenceNumber\n            || this.summarizingLock !== undefined\n        ) {\n            // If no enqueued summary is ready or a summary is already in progress, take no action.\n            return false;\n        }\n        const { reason, resultsBuilder, options } = this.enqueuedSummary;\n        // Set to undefined first, so that subsequent enqueue attempt while summarize will occur later.\n        this.enqueuedSummary = undefined;\n        this.trySummarizeOnce(\n            { summarizeReason: `enqueuedSummary/${reason}` },\n            options,\n            this.cancellationToken,\n            resultsBuilder);\n        return true;\n    }\n\n    private disposeEnqueuedSummary() {\n        if (this.enqueuedSummary !== undefined) {\n            this.enqueuedSummary.resultsBuilder.fail(\"RunningSummarizer stopped or disposed\", undefined);\n            this.enqueuedSummary = undefined;\n        }\n    }\n}\n"]}
+{"version":3,"file":"runningSummarizer.js","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;AAGH,+DAAqF;AACrF,qEAA6D;AAC7D,+EAI8C;AAC9C,qEAA8D;AAC9D,iEAAkE;AAgBlE,yDAK4B;AAE5B,MAAM,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAE7D;;;;;;GAMG;AACH,MAAa,iBAAiB;IAkD1B,YACI,UAA4B,EACX,cAAqC,EACrC,aAAoC,EACpC,qBAAuF,EACvF,aAAsC,EACtC,qBAAkD,EAClD,iBAAoC,EACpC,iBAA4C,EAC5C,sBAA8D,EAC/E,EAAE,iBAAiB,GAAG,KAAK,KAA4C,EAAE;QARxD,mBAAc,GAAd,cAAc,CAAuB;QACrC,kBAAa,GAAb,aAAa,CAAuB;QACpC,0BAAqB,GAArB,qBAAqB,CAAkE;QACvF,kBAAa,GAAb,aAAa,CAAyB;QACtC,0BAAqB,GAArB,qBAAqB,CAA6B;QAClD,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpC,sBAAiB,GAAjB,iBAAiB,CAA2B;QAC5C,2BAAsB,GAAtB,sBAAsB,CAAwC;QAzB3E,aAAQ,GAAG,KAAK,CAAC;QACjB,cAAS,GAAG,KAAK,CAAC;QAElB,wBAAmB,GAAG,KAAK,CAAC;QAW5B,mBAAc,GAAG,CAAC,CAAC;QA4E3B;;;;;WAKG;QACI,2BAAsB,GAAG,CAAC,eAAe,EAAE,EAAE,CAChD,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,KAAK,eAAe;YAChE,CAAC,CAAC,IAAI,CAAC,MAAM;YACb,CAAC,CAAC,SAAS,CAAC;QAvEhB,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAC5B,UAAU,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAElF,IAAI,CAAC,iBAAiB,EAAE;YACpB,IAAI,CAAC,eAAe,GAAG,IAAI,+CAAwB,CAC/C,aAAa,EACb,aAAa,EACb,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;SAC9C;QAED,oGAAoG;QACpG,+FAA+F;QAC/F,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;QAE5F,IAAI,CAAC,eAAe,GAAG,IAAI,2BAAY,CACnC,cAAc,EACd,GAAG,EAAE;YACD,IAAI,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;YACpD,8DAA8D;YAC9D,sEAAsE;YACtE,2DAA2D;YAC3D,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,uBAAuB;gBAClC,cAAc;gBACd,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB;gBACzE,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB;gBAC3E,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW;aACvE,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACP,iFAAiF;QACjF,iBAAiB,CAAC,iCAAiC,CAAC,cAAc,EAAE,GAAG,EAAE;YACrE,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;gBAC/B,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;oBAC3B,SAAS,EAAE,6BAA6B;oBACxC,uBAAuB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB;oBACzE,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,qBAAqB;iBAC9E,CAAC,CAAC;gBACH,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;aAChC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,IAAI,mCAAgB,CACjC,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,qBAAqB,EAC1B,IAAI,CAAC,qBAAqB,EAC1B,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,MAAM,CACd,CAAC;IACN,CAAC;IA9GM,MAAM,CAAC,KAAK,CAAC,KAAK,CACrB,MAAwB,EACxB,cAAqC,EACrC,aAAoC,EACpC,qBAAuF,EACvF,aAAsC,EACtC,qBAAkD,EAClD,iBAAoC,EACpC,iBAA4C,EAC5C,sBAA8D,EAC9D,OAA+C;;QAE/C,MAAM,UAAU,GAAG,IAAI,iBAAiB,CACpC,MAAM,EACN,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,OAAO,CAAC,CAAC;QAEb,MAAM,UAAU,CAAC,SAAS,EAAE,CAAC;QAE7B,oCAAoC;QACpC,MAAA,UAAU,CAAC,eAAe,0CAAE,GAAG,GAAG;QAClC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAiFzC,OAAO;;QACV,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAA,IAAI,CAAC,eAAe,0CAAE,OAAO,GAAG;QAChC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAaM,cAAc,CAAC,EAA6B;QAC/C,QAAQ,EAAE,CAAC,IAAI,EAAE;YACb,KAAK,kCAAW,CAAC,WAAW,CAAC;YAC7B,KAAK,kCAAW,CAAC,UAAU,CAAC;YAC5B,KAAK,kCAAW,CAAC,OAAO,CAAC;YACzB,KAAK,kCAAW,CAAC,MAAM,CAAC,CAAC;gBACrB,mDAAmD;gBACnD,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;gBAC7B,OAAO;aACV;YACD,OAAO,CAAC,CAAC;gBACL,OAAO;aACV;SACJ;IACL,CAAC;IAEM,QAAQ,CAAC,KAAU,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAA6B;;QAC/F,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO;SACV;QACD,IAAI,CAAC,aAAa,CAAC,oBAAoB,GAAG,cAAc,CAAC;QAEzD,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE;YAC9B,mEAAmE;SACtE;aAAM,IAAI,IAAI,KAAK,kCAAW,CAAC,IAAI,EAAE;YAClC,mCAAmC;YACnC,+DAA+D;YAC/D,IAAI,CAAC,YAAY,CAAC,QAAQ,QAAQ,KAAK,QAAQ,EAAW,CAAC,CAAC;SAC/D;aAAM;YACH,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,GAAG;SAC/B;IACL,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,gBAAyB;;QAC3C,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,OAAO;SACV;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,8CAA8C;QAC9C,IAAI,gBAAgB,WAAI,IAAI,CAAC,eAAe,0CAAE,oBAAoB,GAAE,EAAE;YAClE,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;gBACpC,IAAI,CAAC,gBAAgB;gBACjB,iBAAiB;gBACjB,EAAE,eAAe,EAAE,aAAa,EAAE;gBAClC,kFAAkF;gBAClF,EAAE,CAAC,CAAC;aACX;SACJ;QAED,+EAA+E;QAC/E,qFAAqF;QACrF,6FAA6F;QAC7F,0FAA0F;QAC1F,uEAAuE;QACvE,MAAM,IAAI,CAAC,eAAe,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,SAAS;QACnB,kDAAkD;QAClD,MAAM,eAAe,GAAG,MAAM,4BAAS,CACnC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,EACjC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAC/B,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7B,sEAAsE;QACtE,uEAAuE;QACvE,IAAI,CAAC,iBAAiB,CAAC,mCAAmC,EAAE,CAAC;QAE7D,IAAI,eAAe,CAAC,MAAM,KAAK,MAAM,IAAI,eAAe,CAAC,KAAK,KAAK,SAAS,EAAE;YAC1E,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;gBAC1B,iBAAiB,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,uBAAuB;gBAC1E,WAAW,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS;gBACtD,qBAAqB,EAAE,eAAe,CAAC,KAAK,CAAC,SAAS,CAAC,cAAc;aACxE,CAAC,CAAC;SACN;IACL,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,mBAAmB,CAAI,MAAwB;QACzD,qBAAM,CAAE,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAEnG,MAAM,eAAe,GAAG,IAAI,uBAAQ,EAAQ,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC;QAE/C,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,OAAO,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;;YACzB,eAAe,CAAC,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YAEjC,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC;YACvC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;YAEjC,2EAA2E;YAC3E,yDAAyD;YACzD,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,KAAK,EAAE;gBAC1D,MAAA,IAAI,CAAC,eAAe,0CAAE,GAAG,GAAG;aAC/B;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CACpB,cAAoC,EACpC,OAA0B,EAC1B,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAC1C,cAAc,GAAG,IAAI,yCAAsB,EAAE;QAE7C,IAAI,CAAC,mBAAmB,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAC5C,cAAc,EACd,OAAO,EACP,iBAAiB,EACjB,cAAc,CAAC,CAAC;YACpB,6CAA6C;YAC7C,OAAO,eAAe,CAAC,wBAAwB,CAAC;QACpD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,6FAA6F;YAC7F,oBAAoB;YACpB,4FAA4F;YAC5F,iCAAiC;QACrC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,oCAAoC;IAC5B,YAAY,CAChB,eAAgC,EAChC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB;QAE1C,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,yFAAyF;YACzF,uBAAuB;YACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;YAChC,OAAO;SACV;QAED,IAAI,CAAC,mBAAmB,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,QAAQ,GAAsD;gBAChE,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;gBAC5C,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE;gBAC3C,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE;gBACjE,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,EAAE;aACpE,CAAC;YACF,IAAI,oBAAwC,CAAC;YAC7C,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,IAAI,eAAe,GAAG,CAAC,CAAC;YAExB,IAAI,UAAwD,CAAC;YAE7D,KAAK,IAAI,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC,MAAM,GAAG;gBACxD,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;oBAClC,OAAO;iBACV;gBAED,aAAa,EAAE,CAAC;gBAChB,eAAe,EAAE,CAAC;gBAElB,MAAM,KAAwD,QAAQ,CAAC,YAAY,CAAC,EAA9E,EAAE,YAAY,EAAE,mBAAmB,GAAG,CAAC,OAAuC,EAAlC,OAAO,cAAnD,gBAAqD,CAAyB,CAAC;gBACrF,MAAM,YAAY,GAAG,oBAAoB,aAApB,oBAAoB,cAApB,oBAAoB,GAAI,mBAAmB,CAAC;gBAEjE,MAAM,cAAc,mBAChB,eAAe,EACf,sBAAsB,EAAE,aAAa,EACrC,yBAAyB,EAAE,eAAe,EAC1C,qBAAqB,EAAE,YAAY,GAAG,CAAC,IACpC,OAAO,CACb,CAAC;gBAEF,IAAI,YAAY,GAAG,CAAC,EAAE;oBAClB,IAAI,CAAC,MAAM,CAAC,oBAAoB,iBAC5B,SAAS,EAAE,uBAAuB,EAClC,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,SAAS,IAC5E,cAAc,EACnB,CAAC;oBACH,MAAM,oBAAK,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;iBACpC;gBACD,wEAAwE;gBACxE,2FAA2F;gBAC3F,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;gBAC7F,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,wBAAwB,CAAC;gBAE9D,IAAI,MAAM,CAAC,OAAO,EAAE;oBAChB,OAAO;iBACV;gBACD,8EAA8E;gBAC9E,yDAAyD;gBACzD,oBAAoB,GAAG,MAAM,CAAC,iBAAiB,CAAC;gBAChD,IAAI,oBAAoB,KAAK,SAAS,IAAI,eAAe,GAAG,CAAC,EAAE;oBAC3D,YAAY,EAAE,CAAC;oBACf,eAAe,GAAG,CAAC,CAAC;iBACvB;gBACD,UAAU,GAAG,MAAM,CAAC;aACvB;YAED,gGAAgG;YAChG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,iBAAiB;gBAC5B,eAAe;gBACf,OAAO,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO;aAC/B,EAAE,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,CAAC;YAEtB,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAAE,KAAK,CAAC,CAAC;QACjF,CAAC,CAAC,CAAC;IACP,CAAC;IAED,8DAA8D;IACvD,iBAAiB,CACpB,iBAAyC,IAAI,yCAAsB,EAAE,EACrE,EAG4B;YAH5B,EACI,MAAM,OAEkB,EADrB,OAAO,cAFd,UAGC,CADa;QAEd,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,cAAc,CAAC,IAAI,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YACxE,OAAO,cAAc,CAAC,KAAK,EAAE,CAAC;SACjC;QACD,0DAA0D;QAC1D,8DAA8D;QAC9D,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,6DAA6D;YAC7D,MAAM,IAAI,4BAAU,CAAC,0DAA0D,CAAC,CAAC;SACpF;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAChC,EAAE,eAAe,EAAE,YAAY,MAAM,EAAE,EAAE,EACzC,OAAO,EACP,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,CAAC;QACpB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,6DAA6D;IACtD,gBAAgB,CAAC,EAKG;YALH,EACpB,MAAM,EACN,mBAAmB,GAAG,CAAC,EACvB,QAAQ,GAAG,KAAK,OAEO,EADpB,OAAO,cAJU,6CAKvB,CADa;QAEV,MAAM,cAAc,GAAG,WAAW,MAAM,EAAW,CAAC;QACpD,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,QAAQ,EAAE;gBACX,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;aACpC;YACD,gDAAgD;YAChD,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CACpC,0DAA0D,EAC1D,SAAS,CACZ,CAAC;YACF,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YACjC,UAAU,GAAG,IAAI,CAAC;SACrB;QACD,IAAI,CAAC,eAAe,GAAG;YACnB,MAAM,EAAE,cAAc;YACtB,mBAAmB;YACnB,OAAO;YACP,cAAc,EAAE,IAAI,yCAAsB,EAAE;SAC/C,CAAC;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5D,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC,CAAC,iCACZ,OAAO,KACV,eAAe,EAAE,IAAI,EACrB,UAAU,EAAE,IAAI,IAClB,CAAC,CAAC,OAAO,CAAC;IAChB,CAAC;IAEO,qBAAqB;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;SAChB;QACD,IACI,IAAI,CAAC,eAAe,KAAK,SAAS;eAC/B,IAAI,CAAC,aAAa,CAAC,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,mBAAmB;eAClF,IAAI,CAAC,eAAe,KAAK,SAAS,EACvC;YACE,uFAAuF;YACvF,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC;QACjE,+FAA+F;QAC/F,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,gBAAgB,CACjB,EAAE,eAAe,EAAE,mBAAmB,MAAM,EAAE,EAAE,EAChD,OAAO,EACP,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,sBAAsB;QAC1B,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE;YACpC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,CAAC,uCAAuC,EAAE,SAAS,CAAC,CAAC;YAC7F,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;SACpC;IACL,CAAC;CACJ;AAtcD,8CAscC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable, ITelemetryLogger, ITelemetryProperties } from \"@fluidframework/common-definitions\";\nimport { assert, delay, Deferred, PromiseTimer } from \"@fluidframework/common-utils\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport {\n    ISequencedDocumentMessage,\n    ISummaryConfiguration,\n    MessageType,\n} from \"@fluidframework/protocol-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { SummarizeHeuristicRunner } from \"./summarizerHeuristics\";\nimport {\n    IEnqueueSummarizeOptions,\n    ISummarizeOptions,\n    ISummarizeHeuristicData,\n    ISummarizeHeuristicRunner,\n    ISummarizerOptions,\n    IOnDemandSummarizeOptions,\n    EnqueueSummarizeResult,\n    SummarizerStopReason,\n    ISubmitSummaryOptions,\n    SubmitSummaryResult,\n    ISummaryCancellationToken,\n    ISummarizeResults,\n} from \"./summarizerTypes\";\nimport { IClientSummaryWatcher, SummaryCollection } from \"./summaryCollection\";\nimport {\n    raceTimer,\n    SummarizeReason,\n    SummarizeResultBuilder,\n    SummaryGenerator,\n} from \"./summaryGenerator\";\n\nconst maxSummarizeAckWaitTime = 10 * 60 * 1000; // 10 minutes\n\n/**\n * An instance of RunningSummarizer manages the heuristics for summarizing.\n * Until disposed, the instance of RunningSummarizer can assume that it is\n * in a state of running, meaning it is connected and initialized.  It keeps\n * track of summaries that it is generating as they are broadcast and acked/nacked.\n * This object is created and controlled by Summarizer object.\n */\nexport class RunningSummarizer implements IDisposable {\n    public static async start(\n        logger: ITelemetryLogger,\n        summaryWatcher: IClientSummaryWatcher,\n        configuration: ISummaryConfiguration,\n        submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        heuristicData: ISummarizeHeuristicData,\n        raiseSummarizingError: (errorCode: string) => void,\n        summaryCollection: SummaryCollection,\n        cancellationToken: ISummaryCancellationToken,\n        stopSummarizerCallback: (reason: SummarizerStopReason) => void,\n        options?: Readonly<Partial<ISummarizerOptions>>,\n    ): Promise<RunningSummarizer> {\n        const summarizer = new RunningSummarizer(\n            logger,\n            summaryWatcher,\n            configuration,\n            submitSummaryCallback,\n            heuristicData,\n            raiseSummarizingError,\n            summaryCollection,\n            cancellationToken,\n            stopSummarizerCallback,\n            options);\n\n        await summarizer.waitStart();\n\n        // Run the heuristics after starting\n        summarizer.heuristicRunner?.run();\n        return summarizer;\n    }\n\n    public get disposed() { return this._disposed; }\n\n    private stopping = false;\n    private _disposed = false;\n    private summarizingLock: Promise<void> | undefined;\n    private tryWhileSummarizing = false;\n    private readonly pendingAckTimer: PromiseTimer;\n    private heuristicRunner?: ISummarizeHeuristicRunner;\n    private readonly generator: SummaryGenerator;\n    private readonly logger: ITelemetryLogger;\n    private enqueuedSummary: {\n        reason: SummarizeReason;\n        afterSequenceNumber: number;\n        options: ISummarizeOptions;\n        readonly resultsBuilder: SummarizeResultBuilder;\n    } | undefined;\n    private summarizeCount = 0;\n\n    private constructor(\n        baseLogger: ITelemetryLogger,\n        private readonly summaryWatcher: IClientSummaryWatcher,\n        private readonly configuration: ISummaryConfiguration,\n        private readonly submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>,\n        private readonly heuristicData: ISummarizeHeuristicData,\n        private readonly raiseSummarizingError: (errorCode: string) => void,\n        private readonly summaryCollection: SummaryCollection,\n        private readonly cancellationToken: ISummaryCancellationToken,\n        private readonly stopSummarizerCallback: (reason: SummarizerStopReason) => void,\n        { disableHeuristics = false }: Readonly<Partial<ISummarizerOptions>> = {},\n    ) {\n        this.logger = ChildLogger.create(\n            baseLogger, \"Running\", { all: { summaryGenTag: () => this.summarizeCount } });\n\n        if (!disableHeuristics) {\n            this.heuristicRunner = new SummarizeHeuristicRunner(\n                heuristicData,\n                configuration,\n                (reason) => this.trySummarize(reason));\n        }\n\n        // Cap the maximum amount of time client will wait for a summarize op ack to maxSummarizeAckWaitTime\n        // configuration.maxAckWaitTime is composed from defaults, server values, and runtime overrides\n        const maxAckWaitTime = Math.min(this.configuration.maxAckWaitTime, maxSummarizeAckWaitTime);\n\n        this.pendingAckTimer = new PromiseTimer(\n            maxAckWaitTime,\n            () => {\n                this.raiseSummarizingError(\"summaryAckWaitTimeout\");\n                // Note: summaryGenTag (from ChildLogger definition) may be 0,\n                // since this code path is hit when RunningSummarizer first starts up,\n                // before this instance has kicked off a new summarize run.\n                this.logger.sendErrorEvent({\n                    eventName: \"SummaryAckWaitTimeout\",\n                    maxAckWaitTime,\n                    referenceSequenceNumber: this.heuristicData.lastAttempt.refSequenceNumber,\n                    summarySequenceNumber: this.heuristicData.lastAttempt.summarySequenceNumber,\n                    timePending: Date.now() - this.heuristicData.lastAttempt.summaryTime,\n                });\n            });\n        // Set up pending ack timeout by op timestamp differences for previous summaries.\n        summaryCollection.setPendingAckTimerTimeoutCallback(maxAckWaitTime, () => {\n            if (this.pendingAckTimer.hasTimer) {\n                this.logger.sendTelemetryEvent({\n                    eventName: \"MissingSummaryAckFoundByOps\",\n                    referenceSequenceNumber: this.heuristicData.lastAttempt.refSequenceNumber,\n                    summarySequenceNumber: this.heuristicData.lastAttempt.summarySequenceNumber,\n                });\n                this.pendingAckTimer.clear();\n            }\n        });\n\n        this.generator = new SummaryGenerator(\n            this.pendingAckTimer,\n            this.heuristicData,\n            this.submitSummaryCallback,\n            this.raiseSummarizingError,\n            this.summaryWatcher,\n            this.logger,\n        );\n    }\n\n    public dispose(): void {\n        this.summaryWatcher.dispose();\n        this.heuristicRunner?.dispose();\n        this.heuristicRunner = undefined;\n        this.generator.dispose();\n        this.pendingAckTimer.clear();\n        this.disposeEnqueuedSummary();\n        this._disposed = true;\n        this.stopping = true;\n    }\n\n    /**\n     * RunningSummarizer's logger includes the sequenced index of the current summary on each event.\n     * If some other Summarizer code wants that event on their logs they can get it here,\n     * but only if they're logging about that same summary.\n     * @param summaryOpRefSeq - RefSeq number of the summary op, to ensure the log correlation will be correct\n     */\n    public tryGetCorrelatedLogger = (summaryOpRefSeq) =>\n        this.heuristicData.lastAttempt.refSequenceNumber === summaryOpRefSeq\n            ? this.logger\n            : undefined;\n\n    public handleSystemOp(op: ISequencedDocumentMessage) {\n        switch (op.type) {\n            case MessageType.ClientLeave:\n            case MessageType.ClientJoin:\n            case MessageType.Propose:\n            case MessageType.Reject: {\n                // Synchronously handle quorum ops like regular ops\n                this.handleOp(undefined, op);\n                return;\n            }\n            default: {\n                return;\n            }\n        }\n    }\n\n    public handleOp(error: any, { sequenceNumber, type, clientId, contents }: ISequencedDocumentMessage) {\n        if (error !== undefined) {\n            return;\n        }\n        this.heuristicData.lastOpSequenceNumber = sequenceNumber;\n\n        if (this.tryRunEnqueuedSummary()) {\n            // Intentionally do nothing; check for enqueued on-demand summaries\n        } else if (type === MessageType.Save) {\n            // Check for ops requesting summary\n            // Note: as const is only required until TypeScript version 4.3\n            this.trySummarize(`save;${clientId}: ${contents}` as const);\n        } else {\n            this.heuristicRunner?.run();\n        }\n    }\n\n    public async waitStop(allowLastSummary: boolean): Promise<void> {\n        if (this.stopping) {\n            return;\n        }\n\n        this.stopping = true;\n\n        this.disposeEnqueuedSummary();\n\n        // This will try to run lastSummary if needed.\n        if (allowLastSummary && this.heuristicRunner?.shouldRunLastSummary()) {\n            if (this.summarizingLock === undefined) {\n                this.trySummarizeOnce(\n                    // summarizeProps\n                    { summarizeReason: \"lastSummary\" },\n                    // ISummarizeOptions, using defaults: { refreshLatestAck: false, fullTree: false }\n                    {});\n            }\n        }\n\n        // Note that trySummarizeOnce() call above returns right away, without waiting.\n        // So we need to wait for its completion, otherwise it would be destroyed right away.\n        // That said, if summary lock was taken upfront, this wait might wait on  multiple retries to\n        // submit summary. We should reconsider this flow and make summarizer move to exit faster.\n        // This resolves when the current pending summary gets an ack or fails.\n        await this.summarizingLock;\n    }\n\n    private async waitStart() {\n        // Wait no longer than ack timeout for all pending\n        const waitStartResult = await raceTimer(\n            this.summaryWatcher.waitFlushed(),\n            this.pendingAckTimer.start(),\n        );\n        this.pendingAckTimer.clear();\n\n        // Remove pending ack wait timeout by op timestamp comparison, because\n        // it has race conditions with summaries submitted by this same client.\n        this.summaryCollection.unsetPendingAckTimerTimeoutCallback();\n\n        if (waitStartResult.result === \"done\" && waitStartResult.value !== undefined) {\n            this.heuristicData.initialize({\n                refSequenceNumber: waitStartResult.value.summaryOp.referenceSequenceNumber,\n                summaryTime: waitStartResult.value.summaryOp.timestamp,\n                summarySequenceNumber: waitStartResult.value.summaryOp.sequenceNumber,\n            });\n        }\n    }\n\n    /**\n     * Runs single summary action that prevents any other concurrent actions.\n     * Assumes that caller checked upfront for lack of concurrent action (this.summarizingLock)\n     * before calling this API. I.e. caller is responsible for either erroring out or waiting on this promise.\n     * @param action - action to perform.\n     * @returns - result of action.\n     */\n    private async lockedSummaryAction<T>(action: () => Promise<T>) {\n        assert (this.summarizingLock === undefined, 0x25b /* \"Caller is responsible for checking lock\" */);\n\n        const summarizingLock = new Deferred<void>();\n        this.summarizingLock = summarizingLock.promise;\n\n        this.summarizeCount++;\n\n        return action().finally(() => {\n            summarizingLock.resolve();\n            this.summarizingLock = undefined;\n\n            const retry = this.tryWhileSummarizing;\n            this.tryWhileSummarizing = false;\n\n            // After summarizing, we should check to see if we need to summarize again.\n            // Rerun the heuristics and check for enqueued summaries.\n            if (!this.stopping && !this.tryRunEnqueuedSummary() && retry) {\n                this.heuristicRunner?.run();\n            }\n        });\n    }\n\n    /**\n     * Runs single summarize attempt\n     * @param summarizeProps - props to log with each telemetry event associated with this attempt\n     * @param options - summary options\n     * @param cancellationToken - cancellation token to use to be able to cancel this summary, if needed\n     * @param resultsBuilder - optional, result builder to use.\n     * @returns ISummarizeResult - result of running a summary.\n     */\n    private trySummarizeOnce(\n        summarizeProps: ITelemetryProperties,\n        options: ISummarizeOptions,\n        cancellationToken = this.cancellationToken,\n        resultsBuilder = new SummarizeResultBuilder()): ISummarizeResults\n    {\n        this.lockedSummaryAction(async () => {\n            const summarizeResult = this.generator.summarize(\n                summarizeProps,\n                options,\n                cancellationToken,\n                resultsBuilder);\n            // ensure we wait till the end of the process\n            return summarizeResult.receivedSummaryAckOrNack;\n        }).catch((error) => {\n            // SummaryGenerator.summarize() does not throw exceptions - it converts them to failed result\n            // on resultsBuilder\n            // We do not care about exceptions on receivedSummaryAckOrNack - caller should check results\n            // and take a appropriate action.\n        });\n\n        return resultsBuilder.build();\n    }\n\n    /** Heuristics summarize attempt. */\n    private trySummarize(\n        summarizeReason: SummarizeReason,\n        cancellationToken = this.cancellationToken): void\n    {\n        if (this.summarizingLock !== undefined) {\n            // lockedSummaryAction() will retry heuristic-based summary at the end of current attempt\n            // if it's still needed\n            this.tryWhileSummarizing = true;\n            return;\n        }\n\n        this.lockedSummaryAction(async () => {\n            const attempts: (ISummarizeOptions & { delaySeconds?: number })[] = [\n                { refreshLatestAck: false, fullTree: false },\n                { refreshLatestAck: true, fullTree: false },\n                { refreshLatestAck: true, fullTree: false, delaySeconds: 2 * 60 },\n                { refreshLatestAck: true, fullTree: true, delaySeconds: 10 * 60 },\n            ];\n            let overrideDelaySeconds: number | undefined;\n            let totalAttempts = 0;\n            let attemptPerPhase = 0;\n\n            let lastResult: { message: string; error: any; } | undefined;\n\n            for (let attemptPhase = 0; attemptPhase < attempts.length;) {\n                if (this.cancellationToken.cancelled) {\n                    return;\n                }\n\n                totalAttempts++;\n                attemptPerPhase++;\n\n                const { delaySeconds: regularDelaySeconds = 0, ...options } = attempts[attemptPhase];\n                const delaySeconds = overrideDelaySeconds ?? regularDelaySeconds;\n\n                const summarizeProps: ITelemetryProperties = {\n                    summarizeReason,\n                    summarizeTotalAttempts: totalAttempts,\n                    summarizeAttemptsPerPhase: attemptPerPhase,\n                    summarizeAttemptPhase: attemptPhase + 1, // make everything 1-based\n                    ...options,\n                };\n\n                if (delaySeconds > 0) {\n                    this.logger.sendPerformanceEvent({\n                        eventName: \"SummarizeAttemptDelay\",\n                        duration: delaySeconds,\n                        reason: overrideDelaySeconds !== undefined ? \"nack with retryAfter\" : undefined,\n                        ...summarizeProps,\n                    });\n                    await delay(delaySeconds * 1000);\n                }\n                // Note: no need to account for cancellationToken.waitCancelled here, as\n                // this is accounted SummaryGenerator.summarizeCore that controls receivedSummaryAckOrNack.\n                const resultSummarize = this.generator.summarize(summarizeProps, options, cancellationToken);\n                const result = await resultSummarize.receivedSummaryAckOrNack;\n\n                if (result.success) {\n                    return;\n                }\n                // Check for retryDelay that can come from summaryNack or upload summary flow.\n                // Retry the same step only once per retryAfter response.\n                overrideDelaySeconds = result.retryAfterSeconds;\n                if (overrideDelaySeconds === undefined || attemptPerPhase > 1) {\n                    attemptPhase++;\n                    attemptPerPhase = 0;\n                }\n                lastResult = result;\n            }\n\n            // If all attempts failed, log error (with last attempt info) and close the summarizer container\n            this.logger.sendErrorEvent({\n                eventName: \"FailToSummarize\",\n                summarizeReason,\n                message: lastResult?.message,\n            }, lastResult?.error);\n\n            this.stopSummarizerCallback(\"failToSummarize\");\n        }).catch((error) => {\n            this.logger.sendErrorEvent({ eventName: \"UnexpectedSummarizeError\" }, error);\n        });\n    }\n\n    /** {@inheritdoc (ISummarizer:interface).summarizeOnDemand} */\n    public summarizeOnDemand(\n        resultsBuilder: SummarizeResultBuilder = new SummarizeResultBuilder(),\n        {\n            reason,\n            ...options\n        }: IOnDemandSummarizeOptions): ISummarizeResults {\n        if (this.stopping) {\n            resultsBuilder.fail(\"RunningSummarizer stopped or disposed\", undefined);\n            return resultsBuilder.build();\n        }\n        // Check for concurrent summary attempts. If one is found,\n        // return a promise that caller can await before trying again.\n        if (this.summarizingLock !== undefined) {\n            // The heuristics are blocking concurrent summarize attempts.\n            throw new UsageError(\"Attempted to run an already-running summarizer on demand\");\n        }\n        const result = this.trySummarizeOnce(\n            { summarizeReason: `onDemand/${reason}` },\n            options,\n            this.cancellationToken,\n            resultsBuilder);\n        return result;\n    }\n\n    /** {@inheritdoc (ISummarizer:interface).enqueueSummarize} */\n    public enqueueSummarize({\n        reason,\n        afterSequenceNumber = 0,\n        override = false,\n        ...options\n    }: IEnqueueSummarizeOptions): EnqueueSummarizeResult {\n        const onDemandReason = `enqueue;${reason}` as const;\n        let overridden = false;\n        if (this.enqueuedSummary !== undefined) {\n            if (!override) {\n                return { alreadyEnqueued: true };\n            }\n            // Override existing enqueued summarize attempt.\n            this.enqueuedSummary.resultsBuilder.fail(\n                \"Aborted; overridden by another enqueue summarize attempt\",\n                undefined,\n            );\n            this.enqueuedSummary = undefined;\n            overridden = true;\n        }\n        this.enqueuedSummary = {\n            reason: onDemandReason,\n            afterSequenceNumber,\n            options,\n            resultsBuilder: new SummarizeResultBuilder(),\n        };\n        const results = this.enqueuedSummary.resultsBuilder.build();\n        this.tryRunEnqueuedSummary();\n        return overridden ? {\n            ...results,\n            alreadyEnqueued: true,\n            overridden: true,\n        } : results;\n    }\n\n    private tryRunEnqueuedSummary() {\n        if (this.stopping) {\n            this.disposeEnqueuedSummary();\n            return false;\n        }\n        if (\n            this.enqueuedSummary === undefined\n            || this.heuristicData.lastOpSequenceNumber < this.enqueuedSummary.afterSequenceNumber\n            || this.summarizingLock !== undefined\n        ) {\n            // If no enqueued summary is ready or a summary is already in progress, take no action.\n            return false;\n        }\n        const { reason, resultsBuilder, options } = this.enqueuedSummary;\n        // Set to undefined first, so that subsequent enqueue attempt while summarize will occur later.\n        this.enqueuedSummary = undefined;\n        this.trySummarizeOnce(\n            { summarizeReason: `enqueuedSummary/${reason}` },\n            options,\n            this.cancellationToken,\n            resultsBuilder);\n        return true;\n    }\n\n    private disposeEnqueuedSummary() {\n        if (this.enqueuedSummary !== undefined) {\n            this.enqueuedSummary.resultsBuilder.fail(\"RunningSummarizer stopped or disposed\", undefined);\n            this.enqueuedSummary = undefined;\n        }\n    }\n}\n"]}

package/dist/summarizer.d.ts

@@ -5,8 +5,9 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
 import { ITelemetryLogger } from "@fluidframework/common-definitions";
+import { ILoader } from "@fluidframework/container-definitions";
 import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
-import { IRequest, IResponse, IFluidHandleContext, IFluidHandle } from "@fluidframework/core-interfaces";
+import { IFluidHandleContext, IFluidHandle } from "@fluidframework/core-interfaces";
 import { ISummaryConfiguration } from "@fluidframework/protocol-definitions";
 import { ICancellableSummarizerController } from "./runWhileConnectedCoordinator";
 import { SummaryCollection } from "./summaryCollection";
@@ -39,13 +40,13 @@ export declare class Summarizer extends EventEmitter implements ISummarizer {
     readonly summaryCollection: SummaryCollection;
     private readonly runCoordinatorCreateFn;
     get IFluidLoadable(): this;
-    get IFluidRouter(): this;
     get ISummarizer(): this;
     private readonly logger;
     private runningSummarizer?;
     private systemOpListener?;
     private opListener?;
     private _disposed;
+    private starting;
     private readonly innerHandle;
     get handle(): IFluidHandle<this>;
     private readonly stopDeferred;
@@ -58,6 +59,16 @@ export declare class Summarizer extends EventEmitter implements ISummarizer {
      * In practical terms, it's same runtime (this.runtime) with clientType === "summarizer".
     */
     internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);
+    /**
+     * Creates a Summarizer and its underlying client.
+     * Note that different implementations of ILoader will handle the URL differently.
+     * ILoader provided by a ContainerRuntime is a RelativeLoader, which will treat URL's
+     * starting with "/" as relative to the Container. The general ILoader
+     * interface will expect an absolute URL and will not handle "/".
+     * @param loader - the loader that resolves the request
+     * @param url - the URL used to resolve the container
+     */
+    static create(loader: ILoader, url: string): Promise<ISummarizer>;
     run(onBehalfOf: string, options?: Readonly<Partial<ISummarizerOptions>>): Promise<SummarizerStopReason>;
     /**
      * Stops the summarizer from running.  This will complete
@@ -65,8 +76,17 @@ export declare class Summarizer extends EventEmitter implements ISummarizer {
      * @param reason - reason code for stopping
      */
     stop(reason: SummarizerStopReason): void;
-    request(request: IRequest): Promise<IResponse>;
     private runCore;
+    /**
+     * Put the summarizer in a started state, including creating and initializing the RunningSummarizer.
+     * The start request can come either from the SummaryManager (in the auto-summarize case) or from the user
+     * (in the on-demand case).
+     * @param onBehalfOf - ID of the client that requested that the summarizer start
+     * @param runCoordinator - cancellation token
+     * @param options - options to forward to the RunningSummarizer
+     * @returns - Promise that is fulfilled when the RunningSummarizer is ready
+     */
+    private start;
     /**
      * Disposes of resources after running.  This cleanup will
      * clear any outstanding timers and reset some of the state

package/dist/summarizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"summarizer.d.ts","sourceRoot":"","sources":["../src/summarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAe,eAAe,EAAE,YAAY,EAAmB,MAAM,iCAAiC,CAAC;AAC9G,OAAO,EACH,QAAQ,EACR,SAAS,EACT,mBAAmB,EACnB,YAAY,EACf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEH,qBAAqB,EACxB,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,OAAO,EACH,WAAW,EACX,4BAA4B,EAC5B,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,GAAG,CAAC;AAIxC,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC/B,QAAQ,CAAC,MAAM,EAAE,OAAO;IAN5B,QAAQ,CAAC,SAAS,sBAAoB;IACtC,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,YAAY,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,OAAe;IAKpC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAI/F;AAED,eAAO,MAAM,wBAAwB,cACrB,MAAM,UAAU,OAAO,uBAAyD,CAAC;AAEjG;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW;IAkB3D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC;;MAEE;IACF,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAElB,iBAAiB,EAAE,iBAAiB;IACpD,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IA5B3C,IAAW,cAAc,SAAmB;IAC5C,IAAW,YAAY,SAAmB;IAC1C,IAAW,WAAW,SAAmB;IAEzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAC9C,OAAO,CAAC,gBAAgB,CAAC,CAA0C;IACnE,OAAO,CAAC,UAAU,CAAC,CAAsD;IACzE,OAAO,CAAC,SAAS,CAAkB;IAEnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IAEjD,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAA6B;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwC;gBAGjE,GAAG,EAAE,MAAM;IACX;;OAEG;IACc,OAAO,EAAE,kBAAkB,EAC3B,mBAAmB,EAAE,MAAM,qBAAqB;IACjE;;MAEE;IACe,iBAAiB,EAAE,4BAA4B,EAChE,aAAa,EAAE,mBAAmB,EAClB,iBAAiB,EAAE,iBAAiB,EACnC,sBAAsB,EACnC,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,gCAAgC,CAAC;IAOtE,GAAG,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAYnF;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,oBAAoB;IAI3B,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;YAW7C,OAAO;IAiGrB;;;;;OAKG;IACI,OAAO;IAiBd,SAAgB,iBAAiB,EAAE,WAAW,CAAC,mBAAmB,CAAC,CAKjE;IAEF,SAAgB,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAK/D;YAEY,iBAAiB;CAuBlC"}
+{"version":3,"file":"summarizer.d.ts","sourceRoot":"","sources":["../src/summarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAgB,MAAM,uCAAuC,CAAC;AAI9E,OAAO,EAAe,eAAe,EAAE,YAAY,EAAmB,MAAM,iCAAiC,CAAC;AAC9G,OAAO,EAEH,mBAAmB,EACnB,YAAY,EAEf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEH,qBAAqB,EACxB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAElF,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,OAAO,EACH,WAAW,EACX,4BAA4B,EAC5B,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,GAAG,CAAC;AAIxC,qBAAa,kBAAmB,SAAQ,YAAa,YAAW,mBAAmB,EAAE,eAAe;IAM5F,QAAQ,CAAC,cAAc,EAAE,MAAM;IAC/B,QAAQ,CAAC,MAAM,EAAE,OAAO;IAN5B,QAAQ,CAAC,SAAS,sBAAoB;IACtC,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,YAAY,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,EACtB,MAAM,GAAE,OAAe;IAKpC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAI/F;AAED,eAAO,MAAM,wBAAwB,cACrB,MAAM,UAAU,OAAO,uBAAyD,CAAC;AAEjG;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW;IAkB3D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC;;MAEE;IACF,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAElB,iBAAiB,EAAE,iBAAiB;IACpD,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IA5B3C,IAAW,cAAc,SAAmB;IAC5C,IAAW,WAAW,SAAmB;IAEzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAC9C,OAAO,CAAC,gBAAgB,CAAC,CAA0C;IACnE,OAAO,CAAC,UAAU,CAAC,CAAsD;IACzE,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,QAAQ,CAAkB;IAElC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IAEjD,IAAW,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,CAA6B;IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwC;gBAGjE,GAAG,EAAE,MAAM;IACX;;OAEG;IACc,OAAO,EAAE,kBAAkB,EAC3B,mBAAmB,EAAE,MAAM,qBAAqB;IACjE;;MAEE;IACe,iBAAiB,EAAE,4BAA4B,EAChE,aAAa,EAAE,mBAAmB,EAClB,iBAAiB,EAAE,iBAAiB,EACnC,sBAAsB,EACnC,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,gCAAgC,CAAC;IAOnF;;;;;;;;OAQG;WACiB,MAAM,CACtB,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAuBzB,GAAG,CACZ,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAYnF;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,oBAAoB;YAI1B,OAAO;IAiDrB;;;;;;;;OAQG;YACW,KAAK;IAoEnB;;;;;OAKG;IACI,OAAO;IAiBd,SAAgB,iBAAiB,EAAE,WAAW,CAAC,mBAAmB,CAAC,CAiDjE;IAEF,SAAgB,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAK/D;YAEY,iBAAiB;CAuBlC"}

package/dist/summarizer.js

@@ -7,11 +7,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Summarizer = exports.createSummarizingWarning = exports.SummarizingWarning = void 0;
 const events_1 = require("events");
 const common_utils_1 = require("@fluidframework/common-utils");
-const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const container_definitions_1 = require("@fluidframework/container-definitions");
+const container_utils_1 = require("@fluidframework/container-utils");
+const driver_definitions_1 = require("@fluidframework/driver-definitions");
 const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const summarizerClientElection_1 = require("./summarizerClientElection");
 const summarizerHandle_1 = require("./summarizerHandle");
 const runningSummarizer_1 = require("./runningSummarizer");
 const summarizerHeuristics_1 = require("./summarizerHeuristics");
+const summaryGenerator_1 = require("./summaryGenerator");
 const summarizingError = "summarizingError";
 class SummarizingWarning extends telemetry_utils_1.LoggingError {
     constructor(errorMessage, fluidErrorCode, logged = false) {
@@ -51,16 +56,59 @@ class Summarizer extends events_1.EventEmitter {
         this.summaryCollection = summaryCollection;
         this.runCoordinatorCreateFn = runCoordinatorCreateFn;
         this._disposed = false;
+        this.starting = false;
         this.stopDeferred = new common_utils_1.Deferred();
         this.summarizeOnDemand = (...args) => {
-            if (this._disposed || this.runningSummarizer === undefined || this.runningSummarizer.disposed) {
-                throw Error("Summarizer is not running or already disposed.");
+            var _a;
+            try {
+                if (this._disposed || ((_a = this.runningSummarizer) === null || _a === void 0 ? void 0 : _a.disposed)) {
+                    throw new container_utils_1.UsageError("Summarizer is already disposed.");
+                }
+                if (this.runtime.summarizerClientId !== undefined &&
+                    this.runtime.summarizerClientId !== this.runtime.clientId) {
+                    // If there is an elected summarizer, and it's not this one, don't allow on-demand summary.
+                    // This is to prevent the on-demand summary and heuristic-based summary from stepping on
+                    // each other.
+                    throw new container_utils_1.UsageError("On-demand summary attempted while an elected summarizer is present");
+                }
+                const builder = new summaryGenerator_1.SummarizeResultBuilder();
+                if (this.runningSummarizer) {
+                    // Summarizer is already running. Go ahead and start.
+                    return this.runningSummarizer.summarizeOnDemand(builder, ...args);
+                }
+                // Summarizer isn't running, so we need to start it, which is an async operation.
+                // Manage the promise related to creating the cancellation token here.
+                // The promises related to starting, summarizing,
+                // and submitting are communicated to the caller through the results builder.
+                const coordinatorCreateP = this.runCoordinatorCreateFn(this.runtime);
+                coordinatorCreateP.then((runCoordinator) => {
+                    // Successully created the cancellation token. Start the summarizer.
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const startP = this.start(this.runtime.clientId, runCoordinator, { disableHeuristics: true });
+                    startP.then(async (runningSummarizer) => {
+                        // Successfully started the summarizer. Run it.
+                        runningSummarizer.summarizeOnDemand(builder, ...args);
+                        // Wait for a command to stop or loss of connectivity before tearing down the summarizer and client.
+                        const stopReason = await Promise.race([this.stopDeferred.promise, runCoordinator.waitCancelled]);
+                        await runningSummarizer.waitStop(false);
+                        runCoordinator.stop(stopReason);
+                        this.dispose();
+                        this.runtime.closeFn();
+                    }).catch((reason) => {
+                        builder.fail("Failed to start summarizer", reason);
+                    });
+                }).catch((reason) => {
+                    builder.fail("Failed to create cancellation token", reason);
+                });
+                return builder.build();
+            }
+            catch (error) {
+                throw SummarizingWarning.wrap(error, "summarizerRun", false /* logged */, this.logger);
             }
-            return this.runningSummarizer.summarizeOnDemand(...args);
         };
         this.enqueueSummarize = (...args) => {
             if (this._disposed || this.runningSummarizer === undefined || this.runningSummarizer.disposed) {
-                throw Error("Summarizer is not running or already disposed.");
+                throw new container_utils_1.UsageError("Summarizer is not running or already disposed.");
             }
             return this.runningSummarizer.enqueueSummarize(...args);
         };
@@ -68,9 +116,37 @@ class Summarizer extends events_1.EventEmitter {
         this.innerHandle = new summarizerHandle_1.SummarizerHandle(this, url, handleContext);
     }
     get IFluidLoadable() { return this; }
-    get IFluidRouter() { return this; }
     get ISummarizer() { return this; }
     get handle() { return this.innerHandle; }
+    /**
+     * Creates a Summarizer and its underlying client.
+     * Note that different implementations of ILoader will handle the URL differently.
+     * ILoader provided by a ContainerRuntime is a RelativeLoader, which will treat URL's
+     * starting with "/" as relative to the Container. The general ILoader
+     * interface will expect an absolute URL and will not handle "/".
+     * @param loader - the loader that resolves the request
+     * @param url - the URL used to resolve the container
+     */
+    static async create(loader, url) {
+        const request = {
+            headers: {
+                [container_definitions_1.LoaderHeader.cache]: false,
+                [container_definitions_1.LoaderHeader.clientDetails]: {
+                    capabilities: { interactive: false },
+                    type: summarizerClientElection_1.summarizerClientType,
+                },
+                [driver_definitions_1.DriverHeader.summarizingClient]: true,
+                [container_definitions_1.LoaderHeader.reconnect]: false,
+            },
+            url,
+        };
+        const resolvedContainer = await loader.resolve(request);
+        const fluidObject = await runtime_utils_1.requestFluidObject(resolvedContainer, { url: "_summarizer" });
+        if (fluidObject.ISummarizer === undefined) {
+            throw new container_utils_1.UsageError("Fluid object does not implement ISummarizer");
+        }
+        return fluidObject.ISummarizer;
+    }
     async run(onBehalfOf, options) {
         try {
             return await this.runCore(onBehalfOf, options);
@@ -92,23 +168,7 @@ class Summarizer extends events_1.EventEmitter {
     stop(reason) {
         this.stopDeferred.resolve(reason);
     }
-    async request(request) {
-        if (request.url === "/" || request.url === "") {
-            return {
-                mimeType: "fluid/object",
-                status: 200,
-                value: this,
-            };
-        }
-        return runtime_utils_1.create404Response(request);
-    }
     async runCore(onBehalfOf, options) {
-        // Initialize values and first ack (time is not exact)
-        this.logger.sendTelemetryEvent({
-            eventName: "RunningSummarizer",
-            onBehalfOf,
-            initSummarySeqNumber: this.runtime.deltaManager.initialSequenceNumber,
-        });
         const runCoordinator = await this.runCoordinatorCreateFn(this.runtime);
         // Wait for either external signal to cancel, or loss of connectivity.
         const stopP = Promise.race([runCoordinator.waitCancelled, this.stopDeferred.promise]);
@@ -122,10 +182,60 @@ class Summarizer extends events_1.EventEmitter {
         if (runCoordinator.cancelled) {
             return runCoordinator.waitCancelled;
         }
+        const runningSummarizer = await this.start(onBehalfOf, runCoordinator, options);
+        // Wait for either external signal to cancel, or loss of connectivity.
+        const stopReason = await stopP;
+        // There are two possible approaches here:
+        // 1. Propagate cancellation from this.stopDeferred to runCoordinator. This will ensure that we move to the exit
+        //    faster, including breaking out of the RunningSummarizer.trySummarize() faster.
+        //    We could create new coordinator and pass it to waitStop() -> trySummarizeOnce("lastSummary") flow.
+        //    The con of this approach is that we might cancel active summary, and lastSummary will fail because it
+        //    did not wait for ack/nack from previous summary. Plus we disregard any 429 kind of info from service
+        //    that way (i.e. trySummarize() loop might have been waiting for 5 min because storage told us so).
+        //    In general, it's more wasted resources.
+        // 2. We can not do it and make waitStop() do last summary only if there was no active summary. This ensures
+        //    that client behaves properly (from server POV) and we do not waste resources. But, it may mean we wait
+        //    substantially longer for trySummarize() retries to play out and thus this summary loop may run into
+        //    conflict with new summarizer client starting on different client.
+        // As of now, #2 is implemented. It's more forward looking, as issue #7279 suggests changing design for new
+        // summarizer client to not be created until current summarizer fully moves to exit, and that would reduce
+        // cons of #2 substantially.
+        // Cleanup after running
+        await runningSummarizer.waitStop(!runCoordinator.cancelled /* allowLastSummary */);
+        // Propagate reason and ensure that if someone is waiting for cancellation token, they are moving to exit
+        runCoordinator.stop(stopReason);
+        return stopReason;
+    }
+    /**
+     * Put the summarizer in a started state, including creating and initializing the RunningSummarizer.
+     * The start request can come either from the SummaryManager (in the auto-summarize case) or from the user
+     * (in the on-demand case).
+     * @param onBehalfOf - ID of the client that requested that the summarizer start
+     * @param runCoordinator - cancellation token
+     * @param options - options to forward to the RunningSummarizer
+     * @returns - Promise that is fulfilled when the RunningSummarizer is ready
+     */
+    async start(onBehalfOf, runCoordinator, options) {
+        if (this.runningSummarizer) {
+            if (this.runningSummarizer.disposed) {
+                throw new container_utils_1.UsageError("Starting a disposed summarizer");
+            }
+            return this.runningSummarizer;
+        }
+        if (this.starting) {
+            throw new container_utils_1.UsageError("Attempting to start a summarizer that is already starting");
+        }
+        this.starting = true;
+        // Initialize values and first ack (time is not exact)
+        this.logger.sendTelemetryEvent({
+            eventName: "RunningSummarizer",
+            onBehalfOf,
+            initSummarySeqNumber: this.runtime.deltaManager.initialSequenceNumber,
+        });
         // Summarizing container ID (with clientType === "summarizer")
         const clientId = this.runtime.clientId;
         if (clientId === undefined) {
-            throw Error("clientId should be defined if connected.");
+            throw new container_utils_1.UsageError("clientId should be defined if connected.");
         }
         const runningSummarizer = await runningSummarizer_1.RunningSummarizer.start(this.logger, this.summaryCollection.createWatcher(clientId), this.configurationGetter(), async (...args) => this.internalsProvider.submitSummary(...args), // submitSummaryCallback
         new summarizerHeuristics_1.SummarizeHeuristicData(this.runtime.deltaManager.lastSequenceNumber, {
@@ -137,6 +247,7 @@ class Summarizer extends events_1.EventEmitter {
             }
         }, this.summaryCollection, runCoordinator /* cancellationToken */, (reason) => runCoordinator.stop(reason), /* stopSummarizerCallback */ options);
         this.runningSummarizer = runningSummarizer;
+        this.starting = false;
         // Handle summary acks
         // Note: no exceptions are thrown from handleSummaryAcks handler as it handles all exceptions
         this.handleSummaryAcks().catch((error) => {
@@ -147,28 +258,7 @@ class Summarizer extends events_1.EventEmitter {
         this.runtime.deltaManager.inbound.on("op", this.systemOpListener);
         this.opListener = (error, op) => runningSummarizer.handleOp(error, op);
         this.runtime.on("batchEnd", this.opListener);
-        // Wait for either external signal to cancel, or loss of connectivity.
-        const stopReason = await stopP;
-        // There are two possible approaches here:
-        // 1. Propagate cancellation from this.stopDeferred to runCoordinator. This will ensure that we move to the exit
-        //    faster, including breaking out of the RunningSummarizer.trySummarize() faster.
-        //    We could create new coordinator and pass it to waitStop() -> trySummarizeOnce("lastSummary") flow.
-        //    The con of this approach is that we might cancel active summary, and lastSummary will fail because it
-        //    did not wait for ack/nack from previous summary. Plus we disregard any 429 kind of info from service
-        //    that way (i.e. trySummarize() loop might have been waiting for 5 min because storage told us so).
-        //    In general, it's more wasted resources.
-        // 2. We can not do it and make waitStop() do last summary only if there was no active summary. This ensures
-        //    that client behaves properly (from server POV) and we do not waste resources. But, it may mean we wait
-        //    substantially longer for trySummarize() retries to play out and thus this summary loop may run into
-        //    conflict with new summarizer client starting on different client.
-        // As of now, #2 is implemented. It's more forward looking, as issue #7279 suggests changing design for new
-        // summarizer client to not be created until current summarizer fully moves to exit, and that would reduce
-        // cons of #2 substantially.
-        // Cleanup after running
-        await runningSummarizer.waitStop(!runCoordinator.cancelled /* allowLastSummary */);
-        // Propagate reason and ensure that if someone is waiting for cancellation token, they are moving to exit
-        runCoordinator.stop(stopReason);
-        return stopReason;
+        return runningSummarizer;
     }
     /**
      * Disposes of resources after running.  This cleanup will