@fluidframework/container-runtime 2.0.0-internal.1.0.0.83139 → 2.0.0-internal.1.1.1

package/dist/scheduleManager.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleManager = void 0;
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const common_utils_1 = require("@fluidframework/common-utils");
+const driver_utils_1 = require("@fluidframework/driver-utils");
+const container_utils_1 = require("@fluidframework/container-utils");
+const deltaScheduler_1 = require("./deltaScheduler");
+const packageVersion_1 = require("./packageVersion");
+const connectionTelemetry_1 = require("./connectionTelemetry");
+/**
+ * This class has the following responsibilities:
+ * 1. It tracks batches as we process ops and raises "batchBegin" and "batchEnd" events.
+ *    As part of it, it validates batch correctness (i.e. no system ops in the middle of batch)
+ * 2. It creates instance of ScheduleManagerCore that ensures we never start processing ops from batch
+ *    unless all ops of the batch are in.
+ */
+class ScheduleManager {
+    constructor(deltaManager, emitter, logger) {
+        this.deltaManager = deltaManager;
+        this.emitter = emitter;
+        this.logger = logger;
+        this.hitError = false;
+        this.deltaScheduler = new deltaScheduler_1.DeltaScheduler(this.deltaManager, telemetry_utils_1.ChildLogger.create(this.logger, "DeltaScheduler"));
+        void new ScheduleManagerCore(deltaManager, logger);
+    }
+    beforeOpProcessing(message) {
+        var _a;
+        if (this.batchClientId !== message.clientId) {
+            (0, common_utils_1.assert)(this.batchClientId === undefined, 0x2a2 /* "Batch is interrupted by other client op. Should be caught by trackPending()" */);
+            // This could be the beginning of a new batch or an individual message.
+            this.emitter.emit("batchBegin", message);
+            this.deltaScheduler.batchBegin(message);
+            const batch = (_a = message === null || message === void 0 ? void 0 : message.metadata) === null || _a === void 0 ? void 0 : _a.batch;
+            if (batch) {
+                this.batchClientId = message.clientId;
+            }
+            else {
+                this.batchClientId = undefined;
+            }
+        }
+    }
+    afterOpProcessing(error, message) {
+        var _a;
+        // If this is no longer true, we need to revisit what we do where we set this.hitError.
+        (0, common_utils_1.assert)(!this.hitError, 0x2a3 /* "container should be closed on any error" */);
+        if (error) {
+            // We assume here that loader will close container and stop processing all future ops.
+            // This is implicit dependency. If this flow changes, this code might no longer be correct.
+            this.hitError = true;
+            this.batchClientId = undefined;
+            this.emitter.emit("batchEnd", error, message);
+            this.deltaScheduler.batchEnd(message);
+            return;
+        }
+        const batch = (_a = message === null || message === void 0 ? void 0 : message.metadata) === null || _a === void 0 ? void 0 : _a.batch;
+        // If no batchClientId has been set then we're in an individual batch. Else, if we get
+        // batch end metadata, this is end of the current batch.
+        if (this.batchClientId === undefined || batch === false) {
+            this.batchClientId = undefined;
+            this.emitter.emit("batchEnd", undefined, message);
+            this.deltaScheduler.batchEnd(message);
+            return;
+        }
+    }
+}
+exports.ScheduleManager = ScheduleManager;
+/**
+ * This class controls pausing and resuming of inbound queue to ensure that we never
+ * start processing ops in a batch IF we do not have all ops in the batch.
+ */
+class ScheduleManagerCore {
+    constructor(deltaManager, logger) {
+        this.deltaManager = deltaManager;
+        this.logger = logger;
+        this.localPaused = false;
+        this.timePaused = 0;
+        this.batchCount = 0;
+        // Listen for delta manager sends and add batch metadata to messages
+        this.deltaManager.on("prepareSend", (messages) => {
+            if (messages.length === 0) {
+                return;
+            }
+            // First message will have the batch flag set to true if doing a batched send
+            const firstMessageMetadata = messages[0].metadata;
+            if (!(firstMessageMetadata === null || firstMessageMetadata === void 0 ? void 0 : firstMessageMetadata.batch)) {
+                return;
+            }
+            // If the batch contains only a single op, clear the batch flag.
+            if (messages.length === 1) {
+                delete firstMessageMetadata.batch;
+                return;
+            }
+            // Set the batch flag to false on the last message to indicate the end of the send batch
+            const lastMessage = messages[messages.length - 1];
+            lastMessage.metadata = Object.assign(Object.assign({}, lastMessage.metadata), { batch: false });
+        });
+        // Listen for updates and peek at the inbound
+        this.deltaManager.inbound.on("push", (message) => {
+            this.trackPending(message);
+        });
+        // Start with baseline - empty inbound queue.
+        (0, common_utils_1.assert)(!this.localPaused, 0x293 /* "initial state" */);
+        const allPending = this.deltaManager.inbound.toArray();
+        for (const pending of allPending) {
+            this.trackPending(pending);
+        }
+        // We are intentionally directly listening to the "op" to inspect system ops as well.
+        // If we do not observe system ops, we are likely to hit 0x296 assert when system ops
+        // precedes start of incomplete batch.
+        this.deltaManager.on("op", (message) => this.afterOpProcessing(message.sequenceNumber));
+    }
+    /**
+     * The only public function in this class - called when we processed an op,
+     * to make decision if op processing should be paused or not after that.
+     */
+    afterOpProcessing(sequenceNumber) {
+        (0, common_utils_1.assert)(!this.localPaused, 0x294 /* "can't have op processing paused if we are processing an op" */);
+        // If the inbound queue is ever empty, nothing to do!
+        if (this.deltaManager.inbound.length === 0) {
+            (0, common_utils_1.assert)(this.pauseSequenceNumber === undefined, 0x295 /* "there should be no pending batch if we have no ops" */);
+            return;
+        }
+        // The queue is
+        // 1. paused only when the next message to be processed is the beginning of a batch. Done in two places:
+        //    - here (processing ops until reaching start of incomplete batch)
+        //    - in trackPending(), when queue was empty and start of batch showed up.
+        // 2. resumed when batch end comes in (in trackPending())
+        // do we have incomplete batch to worry about?
+        if (this.pauseSequenceNumber !== undefined) {
+            (0, common_utils_1.assert)(sequenceNumber < this.pauseSequenceNumber, 0x296 /* "we should never start processing incomplete batch!" */);
+            // If the next op is the start of incomplete batch, then we can't process it until it's fully in - pause!
+            if (sequenceNumber + 1 === this.pauseSequenceNumber) {
+                this.pauseQueue();
+            }
+        }
+    }
+    pauseQueue() {
+        (0, common_utils_1.assert)(!this.localPaused, 0x297 /* "always called from resumed state" */);
+        this.localPaused = true;
+        this.timePaused = common_utils_1.performance.now();
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.deltaManager.inbound.pause();
+    }
+    resumeQueue(startBatch, messageEndBatch) {
+        const endBatch = messageEndBatch.sequenceNumber;
+        const duration = this.localPaused ? (common_utils_1.performance.now() - this.timePaused) : undefined;
+        this.batchCount++;
+        if (this.batchCount % 1000 === 1) {
+            this.logger.sendTelemetryEvent({
+                eventName: "BatchStats",
+                sequenceNumber: endBatch,
+                length: endBatch - startBatch + 1,
+                msnDistance: endBatch - messageEndBatch.minimumSequenceNumber,
+                duration,
+                batchCount: this.batchCount,
+                interrupted: this.localPaused,
+            });
+        }
+        // Return early if no change in value
+        if (!this.localPaused) {
+            return;
+        }
+        this.localPaused = false;
+        // Random round number - we want to know when batch waiting paused op processing.
+        if (duration !== undefined && duration > connectionTelemetry_1.latencyThreshold) {
+            this.logger.sendErrorEvent({
+                eventName: "MaxBatchWaitTimeExceeded",
+                duration,
+                sequenceNumber: endBatch,
+                length: endBatch - startBatch,
+            });
+        }
+        this.deltaManager.inbound.resume();
+    }
+    /**
+     * Called for each incoming op (i.e. inbound "push" notification)
+     */
+    trackPending(message) {
+        (0, common_utils_1.assert)(this.deltaManager.inbound.length !== 0, 0x298 /* "we have something in the queue that generates this event" */);
+        (0, common_utils_1.assert)((this.currentBatchClientId === undefined) === (this.pauseSequenceNumber === undefined), 0x299 /* "non-synchronized state" */);
+        const metadata = message.metadata;
+        const batchMetadata = metadata === null || metadata === void 0 ? void 0 : metadata.batch;
+        // Protocol messages are never part of a runtime batch of messages
+        if (!(0, driver_utils_1.isUnpackedRuntimeMessage)(message)) {
+            // Protocol messages should never show up in the middle of the batch!
+            (0, common_utils_1.assert)(this.currentBatchClientId === undefined, 0x29a /* "System message in the middle of batch!" */);
+            (0, common_utils_1.assert)(batchMetadata === undefined, 0x29b /* "system op in a batch?" */);
+            (0, common_utils_1.assert)(!this.localPaused, 0x29c /* "we should be processing ops when there is no active batch" */);
+            return;
+        }
+        if (this.currentBatchClientId === undefined && batchMetadata === undefined) {
+            (0, common_utils_1.assert)(!this.localPaused, 0x29d /* "we should be processing ops when there is no active batch" */);
+            return;
+        }
+        // If the client ID changes then we can move the pause point. If it stayed the same then we need to check.
+        // If batchMetadata is not undefined then if it's true we've begun a new batch - if false we've ended
+        // the previous one
+        if (this.currentBatchClientId !== undefined || batchMetadata === false) {
+            if (this.currentBatchClientId !== message.clientId) {
+                // "Batch not closed, yet message from another client!"
+                throw new container_utils_1.DataCorruptionError("OpBatchIncomplete", Object.assign({ runtimeVersion: packageVersion_1.pkgVersion, batchClientId: this.currentBatchClientId }, (0, container_utils_1.extractSafePropertiesFromMessage)(message)));
+            }
+        }
+        // The queue is
+        // 1. paused only when the next message to be processed is the beginning of a batch. Done in two places:
+        //    - in afterOpProcessing() - processing ops until reaching start of incomplete batch
+        //    - here (batchMetadata == false below), when queue was empty and start of batch showed up.
+        // 2. resumed when batch end comes in (batchMetadata === true case below)
+        if (batchMetadata) {
+            (0, common_utils_1.assert)(this.currentBatchClientId === undefined, 0x29e /* "there can't be active batch" */);
+            (0, common_utils_1.assert)(!this.localPaused, 0x29f /* "we should be processing ops when there is no active batch" */);
+            this.pauseSequenceNumber = message.sequenceNumber;
+            this.currentBatchClientId = message.clientId;
+            // Start of the batch
+            // Only pause processing if queue has no other ops!
+            // If there are any other ops in the queue, processing will be stopped when they are processed!
+            if (this.deltaManager.inbound.length === 1) {
+                this.pauseQueue();
+            }
+        }
+        else if (batchMetadata === false) {
+            (0, common_utils_1.assert)(this.pauseSequenceNumber !== undefined, 0x2a0 /* "batch presence was validated above" */);
+            // Batch is complete, we can process it!
+            this.resumeQueue(this.pauseSequenceNumber, message);
+            this.pauseSequenceNumber = undefined;
+            this.currentBatchClientId = undefined;
+        }
+        else {
+            // Continuation of current batch. Do nothing
+            (0, common_utils_1.assert)(this.currentBatchClientId !== undefined, 0x2a1 /* "logic error" */);
+        }
+    }
+}
+//# sourceMappingURL=scheduleManager.js.map

package/dist/scheduleManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduleManager.js","sourceRoot":"","sources":["../src/scheduleManager.ts"],"names":[],"mappings":";;;AAQA,qEAA8D;AAC9D,+DAAmE;AACnE,+DAAwE;AACxE,qEAAwG;AACxG,qDAAkD;AAClD,qDAA8C;AAC9C,+DAAyD;AAMzD;;;;;;GAMG;AACH,MAAa,eAAe;IAKxB,YACqB,YAAwE,EACxE,OAAqB,EACrB,MAAwB;QAFxB,iBAAY,GAAZ,YAAY,CAA4D;QACxE,YAAO,GAAP,OAAO,CAAc;QACrB,WAAM,GAAN,MAAM,CAAkB;QALrC,aAAQ,GAAG,KAAK,CAAC;QAOrB,IAAI,CAAC,cAAc,GAAG,IAAI,+BAAc,CACpC,IAAI,CAAC,YAAY,EACjB,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,CACpD,CAAC;QACF,KAAK,IAAI,mBAAmB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAEM,kBAAkB,CAAC,OAAkC;;QACxD,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,CAAC,QAAQ,EAAE;YACzC,IAAA,qBAAM,EAAC,IAAI,CAAC,aAAa,KAAK,SAAS,EACnC,KAAK,CAAC,mFAAmF,CAAC,CAAC;YAE/F,uEAAuE;YACvE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACzC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAExC,MAAM,KAAK,GAAG,MAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAoC,0CAAE,KAAK,CAAC;YACpE,IAAI,KAAK,EAAE;gBACP,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC;aACzC;iBAAM;gBACH,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;aAClC;SACJ;IACL,CAAC;IAEM,iBAAiB,CAAC,KAAsB,EAAE,OAAkC;;QAC/E,uFAAuF;QACvF,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAE9E,IAAI,KAAK,EAAE;YACP,sFAAsF;YACtF,2FAA2F;YAC3F,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACtC,OAAO;SACV;QAED,MAAM,KAAK,GAAG,MAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAoC,0CAAE,KAAK,CAAC;QACpE,sFAAsF;QACtF,wDAAwD;QACxD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,KAAK,KAAK,KAAK,EAAE;YACrD,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YACtC,OAAO;SACV;IACL,CAAC;CACJ;AA3DD,0CA2DC;AAED;;;GAGG;AACH,MAAM,mBAAmB;IAOrB,YACqB,YAAwE,EACxE,MAAwB;QADxB,iBAAY,GAAZ,YAAY,CAA4D;QACxE,WAAM,GAAN,MAAM,CAAkB;QANrC,gBAAW,GAAG,KAAK,CAAC;QACpB,eAAU,GAAG,CAAC,CAAC;QACf,eAAU,GAAG,CAAC,CAAC;QAMnB,oEAAoE;QACpE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,QAA4B,EAAE,EAAE;YACjE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO;aACV;YAED,6EAA6E;YAC7E,MAAM,oBAAoB,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAmC,CAAC;YAC7E,IAAI,CAAC,CAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,KAAK,CAAA,EAAE;gBAC9B,OAAO;aACV;YAED,gEAAgE;YAChE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO,oBAAoB,CAAC,KAAK,CAAC;gBAClC,OAAO;aACV;YAED,wFAAwF;YACxF,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAClD,WAAW,CAAC,QAAQ,mCAAQ,WAAW,CAAC,QAAQ,KAAE,KAAK,EAAE,KAAK,GAAE,CAAC;QACrE,CAAC,CAAC,CAAC;QAEH,6CAA6C;QAC7C,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CACxB,MAAM,EACN,CAAC,OAAkC,EAAE,EAAE;YACnC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEP,6CAA6C;QAC7C,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAEvD,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvD,KAAK,MAAM,OAAO,IAAI,UAAU,EAAE;YAC9B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;SAC9B;QAED,qFAAqF;QACrF,qFAAqF;QACrF,sCAAsC;QACtC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACI,iBAAiB,CAAC,cAAsB;QAC3C,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,kEAAkE,CAAC,CAAC;QAEpG,qDAAqD;QACrD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YACxC,IAAA,qBAAM,EAAC,IAAI,CAAC,mBAAmB,KAAK,SAAS,EACzC,KAAK,CAAC,0DAA0D,CAAC,CAAC;YACtE,OAAO;SACV;QAED,eAAe;QACf,wGAAwG;QACxG,sEAAsE;QACtE,6EAA6E;QAC7E,yDAAyD;QAEzD,8CAA8C;QAC9C,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YACxC,IAAA,qBAAM,EAAC,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAC5C,KAAK,CAAC,0DAA0D,CAAC,CAAC;YACtE,yGAAyG;YACzG,IAAI,cAAc,GAAG,CAAC,KAAK,IAAI,CAAC,mBAAmB,EAAE;gBACjD,IAAI,CAAC,UAAU,EAAE,CAAC;aACrB;SACJ;IACL,CAAC;IAEO,UAAU;QACd,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,0BAAW,CAAC,GAAG,EAAE,CAAC;QACpC,mEAAmE;QACnE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAEO,WAAW,CAAC,UAAkB,EAAE,eAA0C;QAC9E,MAAM,QAAQ,GAAG,eAAe,CAAC,cAAc,CAAC;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,0BAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEtF,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,CAAC,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC3B,SAAS,EAAE,YAAY;gBACvB,cAAc,EAAE,QAAQ;gBACxB,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,CAAC;gBACjC,WAAW,EAAE,QAAQ,GAAG,eAAe,CAAC,qBAAqB;gBAC7D,QAAQ;gBACR,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;aAChC,CAAC,CAAC;SACN;QAED,qCAAqC;QACrC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACnB,OAAO;SACV;QAED,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,iFAAiF;QACjF,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,GAAG,sCAAgB,EAAE;YACvD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC;gBACvB,SAAS,EAAE,0BAA0B;gBACrC,QAAQ;gBACR,cAAc,EAAE,QAAQ;gBACxB,MAAM,EAAE,QAAQ,GAAG,UAAU;aAChC,CAAC,CAAC;SACN;QACD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,OAAkC;QACnD,IAAA,qBAAM,EAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EACzC,KAAK,CAAC,gEAAgE,CAAC,CAAC;QAE5E,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,KAAK,SAAS,CAAC,EACzF,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAmC,CAAC;QAC7D,MAAM,aAAa,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAC;QAEtC,kEAAkE;QAClE,IAAI,CAAC,IAAA,uCAAwB,EAAC,OAAO,CAAC,EAAE;YACpC,qEAAqE;YACrE,IAAA,qBAAM,EAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;YACtG,IAAA,qBAAM,EAAC,aAAa,KAAK,SAAS,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;YACzE,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACnG,OAAO;SACV;QAED,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE;YACxE,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACnG,OAAO;SACV;QAED,0GAA0G;QAC1G,qGAAqG;QACrG,mBAAmB;QACnB,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,IAAI,aAAa,KAAK,KAAK,EAAE;YACpE,IAAI,IAAI,CAAC,oBAAoB,KAAK,OAAO,CAAC,QAAQ,EAAE;gBAChD,uDAAuD;gBACvD,MAAM,IAAI,qCAAmB,CACzB,mBAAmB,kBAEf,cAAc,EAAE,2BAAU,EAC1B,aAAa,EAAE,IAAI,CAAC,oBAAoB,IACrC,IAAA,kDAAgC,EAAC,OAAO,CAAC,EAC9C,CAAC;aACV;SACJ;QAED,eAAe;QACf,wGAAwG;QACxG,wFAAwF;QACxF,+FAA+F;QAC/F,yEAAyE;QAEzE,IAAI,aAAa,EAAE;YACf,IAAA,qBAAM,EAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;YAC3F,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACnG,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,cAAc,CAAC;YAClD,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;YAC7C,qBAAqB;YACrB,mDAAmD;YACnD,+FAA+F;YAC/F,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxC,IAAI,CAAC,UAAU,EAAE,CAAC;aACrB;SACJ;aAAM,IAAI,aAAa,KAAK,KAAK,EAAE;YAChC,IAAA,qBAAM,EAAC,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;YACjG,wCAAwC;YACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACpD,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;YACrC,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;SACzC;aAAM;YACH,4CAA4C;YAC5C,IAAA,qBAAM,EAAC,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;SAC9E;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { EventEmitter } from \"events\";\nimport { IDeltaManager } from \"@fluidframework/container-definitions\";\nimport { IDocumentMessage, ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ChildLogger } from \"@fluidframework/telemetry-utils\";\nimport { assert, performance } from \"@fluidframework/common-utils\";\nimport { isUnpackedRuntimeMessage } from \"@fluidframework/driver-utils\";\nimport { DataCorruptionError, extractSafePropertiesFromMessage } from \"@fluidframework/container-utils\";\nimport { DeltaScheduler } from \"./deltaScheduler\";\nimport { pkgVersion } from \"./packageVersion\";\nimport { latencyThreshold } from \"./connectionTelemetry\";\n\ntype IRuntimeMessageMetadata = undefined | {\n    batch?: boolean;\n};\n\n/**\n * This class has the following responsibilities:\n * 1. It tracks batches as we process ops and raises \"batchBegin\" and \"batchEnd\" events.\n *    As part of it, it validates batch correctness (i.e. no system ops in the middle of batch)\n * 2. It creates instance of ScheduleManagerCore that ensures we never start processing ops from batch\n *    unless all ops of the batch are in.\n */\nexport class ScheduleManager {\n    private readonly deltaScheduler: DeltaScheduler;\n    private batchClientId: string | undefined;\n    private hitError = false;\n\n    constructor(\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        private readonly emitter: EventEmitter,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        this.deltaScheduler = new DeltaScheduler(\n            this.deltaManager,\n            ChildLogger.create(this.logger, \"DeltaScheduler\"),\n        );\n        void new ScheduleManagerCore(deltaManager, logger);\n    }\n\n    public beforeOpProcessing(message: ISequencedDocumentMessage) {\n        if (this.batchClientId !== message.clientId) {\n            assert(this.batchClientId === undefined,\n                0x2a2 /* \"Batch is interrupted by other client op. Should be caught by trackPending()\" */);\n\n            // This could be the beginning of a new batch or an individual message.\n            this.emitter.emit(\"batchBegin\", message);\n            this.deltaScheduler.batchBegin(message);\n\n            const batch = (message?.metadata as IRuntimeMessageMetadata)?.batch;\n            if (batch) {\n                this.batchClientId = message.clientId;\n            } else {\n                this.batchClientId = undefined;\n            }\n        }\n    }\n\n    public afterOpProcessing(error: any | undefined, message: ISequencedDocumentMessage) {\n        // If this is no longer true, we need to revisit what we do where we set this.hitError.\n        assert(!this.hitError, 0x2a3 /* \"container should be closed on any error\" */);\n\n        if (error) {\n            // We assume here that loader will close container and stop processing all future ops.\n            // This is implicit dependency. If this flow changes, this code might no longer be correct.\n            this.hitError = true;\n            this.batchClientId = undefined;\n            this.emitter.emit(\"batchEnd\", error, message);\n            this.deltaScheduler.batchEnd(message);\n            return;\n        }\n\n        const batch = (message?.metadata as IRuntimeMessageMetadata)?.batch;\n        // If no batchClientId has been set then we're in an individual batch. Else, if we get\n        // batch end metadata, this is end of the current batch.\n        if (this.batchClientId === undefined || batch === false) {\n            this.batchClientId = undefined;\n            this.emitter.emit(\"batchEnd\", undefined, message);\n            this.deltaScheduler.batchEnd(message);\n            return;\n        }\n    }\n}\n\n/**\n * This class controls pausing and resuming of inbound queue to ensure that we never\n * start processing ops in a batch IF we do not have all ops in the batch.\n */\nclass ScheduleManagerCore {\n    private pauseSequenceNumber: number | undefined;\n    private currentBatchClientId: string | undefined;\n    private localPaused = false;\n    private timePaused = 0;\n    private batchCount = 0;\n\n    constructor(\n        private readonly deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>,\n        private readonly logger: ITelemetryLogger,\n    ) {\n        // Listen for delta manager sends and add batch metadata to messages\n        this.deltaManager.on(\"prepareSend\", (messages: IDocumentMessage[]) => {\n            if (messages.length === 0) {\n                return;\n            }\n\n            // First message will have the batch flag set to true if doing a batched send\n            const firstMessageMetadata = messages[0].metadata as IRuntimeMessageMetadata;\n            if (!firstMessageMetadata?.batch) {\n                return;\n            }\n\n            // If the batch contains only a single op, clear the batch flag.\n            if (messages.length === 1) {\n                delete firstMessageMetadata.batch;\n                return;\n            }\n\n            // Set the batch flag to false on the last message to indicate the end of the send batch\n            const lastMessage = messages[messages.length - 1];\n            lastMessage.metadata = { ...lastMessage.metadata, batch: false };\n        });\n\n        // Listen for updates and peek at the inbound\n        this.deltaManager.inbound.on(\n            \"push\",\n            (message: ISequencedDocumentMessage) => {\n                this.trackPending(message);\n            });\n\n        // Start with baseline - empty inbound queue.\n        assert(!this.localPaused, 0x293 /* \"initial state\" */);\n\n        const allPending = this.deltaManager.inbound.toArray();\n        for (const pending of allPending) {\n            this.trackPending(pending);\n        }\n\n        // We are intentionally directly listening to the \"op\" to inspect system ops as well.\n        // If we do not observe system ops, we are likely to hit 0x296 assert when system ops\n        // precedes start of incomplete batch.\n        this.deltaManager.on(\"op\", (message) => this.afterOpProcessing(message.sequenceNumber));\n    }\n\n    /**\n     * The only public function in this class - called when we processed an op,\n     * to make decision if op processing should be paused or not after that.\n     */\n    public afterOpProcessing(sequenceNumber: number) {\n        assert(!this.localPaused, 0x294 /* \"can't have op processing paused if we are processing an op\" */);\n\n        // If the inbound queue is ever empty, nothing to do!\n        if (this.deltaManager.inbound.length === 0) {\n            assert(this.pauseSequenceNumber === undefined,\n                0x295 /* \"there should be no pending batch if we have no ops\" */);\n            return;\n        }\n\n        // The queue is\n        // 1. paused only when the next message to be processed is the beginning of a batch. Done in two places:\n        //    - here (processing ops until reaching start of incomplete batch)\n        //    - in trackPending(), when queue was empty and start of batch showed up.\n        // 2. resumed when batch end comes in (in trackPending())\n\n        // do we have incomplete batch to worry about?\n        if (this.pauseSequenceNumber !== undefined) {\n            assert(sequenceNumber < this.pauseSequenceNumber,\n                0x296 /* \"we should never start processing incomplete batch!\" */);\n            // If the next op is the start of incomplete batch, then we can't process it until it's fully in - pause!\n            if (sequenceNumber + 1 === this.pauseSequenceNumber) {\n                this.pauseQueue();\n            }\n        }\n    }\n\n    private pauseQueue() {\n        assert(!this.localPaused, 0x297 /* \"always called from resumed state\" */);\n        this.localPaused = true;\n        this.timePaused = performance.now();\n        // eslint-disable-next-line @typescript-eslint/no-floating-promises\n        this.deltaManager.inbound.pause();\n    }\n\n    private resumeQueue(startBatch: number, messageEndBatch: ISequencedDocumentMessage) {\n        const endBatch = messageEndBatch.sequenceNumber;\n        const duration = this.localPaused ? (performance.now() - this.timePaused) : undefined;\n\n        this.batchCount++;\n        if (this.batchCount % 1000 === 1) {\n            this.logger.sendTelemetryEvent({\n                eventName: \"BatchStats\",\n                sequenceNumber: endBatch,\n                length: endBatch - startBatch + 1,\n                msnDistance: endBatch - messageEndBatch.minimumSequenceNumber,\n                duration,\n                batchCount: this.batchCount,\n                interrupted: this.localPaused,\n            });\n        }\n\n        // Return early if no change in value\n        if (!this.localPaused) {\n            return;\n        }\n\n        this.localPaused = false;\n\n        // Random round number - we want to know when batch waiting paused op processing.\n        if (duration !== undefined && duration > latencyThreshold) {\n            this.logger.sendErrorEvent({\n                eventName: \"MaxBatchWaitTimeExceeded\",\n                duration,\n                sequenceNumber: endBatch,\n                length: endBatch - startBatch,\n            });\n        }\n        this.deltaManager.inbound.resume();\n    }\n\n    /**\n     * Called for each incoming op (i.e. inbound \"push\" notification)\n     */\n    private trackPending(message: ISequencedDocumentMessage) {\n        assert(this.deltaManager.inbound.length !== 0,\n            0x298 /* \"we have something in the queue that generates this event\" */);\n\n        assert((this.currentBatchClientId === undefined) === (this.pauseSequenceNumber === undefined),\n            0x299 /* \"non-synchronized state\" */);\n\n        const metadata = message.metadata as IRuntimeMessageMetadata;\n        const batchMetadata = metadata?.batch;\n\n        // Protocol messages are never part of a runtime batch of messages\n        if (!isUnpackedRuntimeMessage(message)) {\n            // Protocol messages should never show up in the middle of the batch!\n            assert(this.currentBatchClientId === undefined, 0x29a /* \"System message in the middle of batch!\" */);\n            assert(batchMetadata === undefined, 0x29b /* \"system op in a batch?\" */);\n            assert(!this.localPaused, 0x29c /* \"we should be processing ops when there is no active batch\" */);\n            return;\n        }\n\n        if (this.currentBatchClientId === undefined && batchMetadata === undefined) {\n            assert(!this.localPaused, 0x29d /* \"we should be processing ops when there is no active batch\" */);\n            return;\n        }\n\n        // If the client ID changes then we can move the pause point. If it stayed the same then we need to check.\n        // If batchMetadata is not undefined then if it's true we've begun a new batch - if false we've ended\n        // the previous one\n        if (this.currentBatchClientId !== undefined || batchMetadata === false) {\n            if (this.currentBatchClientId !== message.clientId) {\n                // \"Batch not closed, yet message from another client!\"\n                throw new DataCorruptionError(\n                    \"OpBatchIncomplete\",\n                    {\n                        runtimeVersion: pkgVersion,\n                        batchClientId: this.currentBatchClientId,\n                        ...extractSafePropertiesFromMessage(message),\n                    });\n            }\n        }\n\n        // The queue is\n        // 1. paused only when the next message to be processed is the beginning of a batch. Done in two places:\n        //    - in afterOpProcessing() - processing ops until reaching start of incomplete batch\n        //    - here (batchMetadata == false below), when queue was empty and start of batch showed up.\n        // 2. resumed when batch end comes in (batchMetadata === true case below)\n\n        if (batchMetadata) {\n            assert(this.currentBatchClientId === undefined, 0x29e /* \"there can't be active batch\" */);\n            assert(!this.localPaused, 0x29f /* \"we should be processing ops when there is no active batch\" */);\n            this.pauseSequenceNumber = message.sequenceNumber;\n            this.currentBatchClientId = message.clientId;\n            // Start of the batch\n            // Only pause processing if queue has no other ops!\n            // If there are any other ops in the queue, processing will be stopped when they are processed!\n            if (this.deltaManager.inbound.length === 1) {\n                this.pauseQueue();\n            }\n        } else if (batchMetadata === false) {\n            assert(this.pauseSequenceNumber !== undefined, 0x2a0 /* \"batch presence was validated above\" */);\n            // Batch is complete, we can process it!\n            this.resumeQueue(this.pauseSequenceNumber, message);\n            this.pauseSequenceNumber = undefined;\n            this.currentBatchClientId = undefined;\n        } else {\n            // Continuation of current batch. Do nothing\n            assert(this.currentBatchClientId !== undefined, 0x2a1 /* \"logic error\" */);\n        }\n    }\n}\n"]}

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,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,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAElF,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGvE,OAAO,EACH,WAAW,EACX,4BAA4B,EAC5B,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,MAAM,EAAE,OAAO;IAL5B,QAAQ,CAAC,SAAS,sBAAoB;IACtC,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,YAAY,EAAE,MAAM,EACX,MAAM,GAAE,OAAe;IAKpC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,qBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAI5E;AAED,eAAO,MAAM,wBAAwB,iBAClB,MAAM,UAAU,OAAO,uBAAiD,CAAC;AAE5F;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW;IAgB3D;;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;IA1B3C,IAAW,cAAc,SAAmB;IAC5C,IAAW,WAAW,SAAmB;IAEzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAC9C,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,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWnE;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,oBAAoB;IAIjC,KAAK;YAOE,OAAO;IAgDrB;;;;;OAKG;WACW,2BAA2B,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO;IAIpF;;;;;;;;OAQG;YACW,KAAK;IA8DnB;;;;;OAKG;IACI,OAAO;IAWd,SAAgB,iBAAiB,EAAE,WAAW,CAAC,mBAAmB,CAAC,CA+CjE;IAEF,SAAgB,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAK/D;YAEY,iBAAiB;CAkClC"}
+{"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,EAEH,eAAe,EAEf,YAAY,EAEf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEH,mBAAmB,EACnB,YAAY,EAEf,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAElF,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGvE,OAAO,EACH,WAAW,EACX,4BAA4B,EAC5B,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,MAAM,EAAE,OAAO;IAL5B,QAAQ,CAAC,SAAS,sBAAoB;IACtC,QAAQ,CAAC,QAAQ,QAAQ;gBAGrB,YAAY,EAAE,MAAM,EACX,MAAM,GAAE,OAAe;IAKpC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,qBAAiB,EAAE,MAAM,EAAE,gBAAgB;CAI5E;AAED,eAAO,MAAM,wBAAwB,iBAClB,MAAM,UAAU,OAAO,uBAAiD,CAAC;AAE5F;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW;IAgB3D;;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;IA1B3C,IAAW,cAAc,SAAmB;IAC5C,IAAW,WAAW,SAAmB;IAEzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAC9C,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,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWnE;;;;OAIG;IACI,IAAI,CAAC,MAAM,EAAE,oBAAoB;IAIjC,KAAK;YAOE,OAAO;IAgDrB;;;;;OAKG;WACW,2BAA2B,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO;IAIpF;;;;;;;;OAQG;YACW,KAAK;IA8DnB;;;;;OAKG;IACI,OAAO;IAWd,SAAgB,iBAAiB,EAAE,WAAW,CAAC,mBAAmB,CAAC,CA+CjE;IAEF,SAAgB,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAK/D;YAEY,iBAAiB;CAqDlC"}

package/dist/summarizer.js

@@ -300,7 +300,26 @@ class Summarizer extends events_1.EventEmitter {
                 // Make sure we block any summarizer from being executed/enqueued while
                 // executing the refreshLatestSummaryAck.
                 // https://dev.azure.com/fluidframework/internal/_workitems/edit/779
-                await this.runningSummarizer.lockedRefreshSummaryAckAction(async () => this.internalsProvider.refreshLatestSummaryAck(summaryOpHandle, summaryAckHandle, refSequenceNumber, summaryLogger));
+                await this.runningSummarizer.lockedRefreshSummaryAckAction(async () => this.internalsProvider.refreshLatestSummaryAck(summaryOpHandle, summaryAckHandle, refSequenceNumber, summaryLogger).catch(async (error) => {
+                    // If the error is 404, so maybe the fetched version no longer exists on server. We just
+                    // ignore this error in that case, as that means we will have another summaryAck for the
+                    // latest version with which we will refresh the state. However in case of single commit
+                    // summary, we might me missing a summary ack, so in that case we are still fine as the
+                    // code in `submitSummary` function in container runtime, will refresh the latest state
+                    // by calling `refreshLatestSummaryAckFromServer` and we will be fine.
+                    if ((0, telemetry_utils_1.isFluidError)(error)
+                        && error.errorType === driver_definitions_1.DriverErrorType.fileNotFoundOrAccessDeniedError) {
+                        summaryLogger.sendTelemetryEvent({
+                            eventName: "HandleSummaryAckErrorIgnored",
+                            referenceSequenceNumber: refSequenceNumber,
+                            proposalHandle: summaryOpHandle,
+                            ackHandle: summaryAckHandle,
+                        }, error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }));
             }
             catch (error) {
                 summaryLogger.sendErrorEvent({

package/dist/summarizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"summarizer.js","sourceRoot":"","sources":["../src/summarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mCAAsC;AACtC,+DAAwD;AAExD,iFAA8E;AAC9E,qEAA6D;AAC7D,2EAAkE;AAClE,iEAAmE;AACnE,qEAA8G;AAS9G,yEAAkE;AAElE,yDAAsD;AACtD,2DAAwD;AAQxD,iEAAgE;AAChE,yDAA4D;AAG5D,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAE5C,MAAa,kBAAmB,SAAQ,8BAAY;IAIhD,YACI,YAAoB,EACX,SAAkB,KAAK;QAEhC,KAAK,CAAC,YAAY,CAAC,CAAC;QAFX,WAAM,GAAN,MAAM,CAAiB;QAL3B,cAAS,GAAG,gBAAgB,CAAC;QAC7B,aAAQ,GAAG,IAAI,CAAC;IAOzB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAU,EAAE,SAAkB,KAAK,EAAE,MAAwB;QACrE,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9E,OAAO,IAAA,iCAAe,EAAqB,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;CACJ;AAfD,gDAeC;AAEM,MAAM,wBAAwB,GACjC,CAAC,YAAoB,EAAE,MAAe,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAD/E,QAAA,wBAAwB,4BACuD;AAE5F;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qBAAY;IAcxC,YACI,GAAW;IACX;;OAEG;IACc,OAA2B,EAC3B,mBAAgD;IACjE;;MAEE;IACe,iBAA+C,EAChE,aAAkC,EAClB,iBAAoC,EACnC,sBAC8D;QAE/E,KAAK,EAAE,CAAC;QAXS,YAAO,GAAP,OAAO,CAAoB;QAC3B,wBAAmB,GAAnB,mBAAmB,CAA6B;QAIhD,sBAAiB,GAAjB,iBAAiB,CAA8B;QAEhD,sBAAiB,GAAjB,iBAAiB,CAAmB;QACnC,2BAAsB,GAAtB,sBAAsB,CACwC;QAtB3E,cAAS,GAAY,KAAK,CAAC;QAC3B,aAAQ,GAAY,KAAK,CAAC;QAKjB,iBAAY,GAAG,IAAI,uBAAQ,EAAwB,CAAC;QAsOrD,sBAAiB,GAAqC,CAAC,GAAG,IAAI,EAAE,EAAE;;YAC9E,IAAI;gBACA,IAAI,IAAI,CAAC,SAAS,KAAI,MAAA,IAAI,CAAC,iBAAiB,0CAAE,QAAQ,CAAA,EAAE;oBACpD,MAAM,IAAI,4BAAU,CAAC,iCAAiC,CAAC,CAAC;iBAC3D;gBACD,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,KAAK,SAAS;oBAC7C,IAAI,CAAC,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBAC3D,2FAA2F;oBAC3F,wFAAwF;oBACxF,cAAc;oBACd,MAAM,IAAI,4BAAU,CAAC,oEAAoE,CAAC,CAAC;iBAC9F;gBACD,MAAM,OAAO,GAAG,IAAI,yCAAsB,EAAE,CAAC;gBAC7C,IAAI,IAAI,CAAC,iBAAiB,EAAE;oBACxB,qDAAqD;oBACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;iBACrE;gBAED,iFAAiF;gBACjF,sEAAsE;gBACtE,iDAAiD;gBACjD,6EAA6E;gBAC7E,MAAM,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAErE,kBAAkB,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;oBACvC,oEAAoE;oBACpE,oEAAoE;oBACpE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAS,EAAE,cAAc,CAAC,CAAC;oBAClE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,EAAE;wBACpC,+CAA+C;wBAC/C,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;wBACtD,oGAAoG;wBACpG,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;wBACjG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;wBACxC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;wBAChC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACjB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;wBAChB,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;oBACvD,CAAC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;oBAChB,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;gBAChE,CAAC,CAAC,CAAC;gBAEH,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;aAC1B;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,kBAAkB,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACzE;QACL,CAAC,CAAC;QAEc,qBAAgB,GAAoC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC5E,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC3F,MAAM,IAAI,4BAAU,CAAC,gDAAgD,CAAC,CAAC;aAC1E;YACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5D,CAAC,CAAC;QAzQE,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACpE,IAAI,CAAC,WAAW,GAAG,IAAI,mCAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAhCD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC5C,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IASzC,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAwBpE;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,MAAe,EACf,GAAW;QACX,MAAM,OAAO,GAAa;YACtB,OAAO,EAAE;gBACL,CAAC,oCAAY,CAAC,KAAK,CAAC,EAAE,KAAK;gBAC3B,CAAC,oCAAY,CAAC,aAAa,CAAC,EAAE;oBAC1B,YAAY,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;oBACpC,IAAI,EAAE,+CAAoB;iBAC7B;gBACD,CAAC,iCAAY,CAAC,iBAAiB,CAAC,EAAE,IAAI;gBACtC,CAAC,oCAAY,CAAC,SAAS,CAAC,EAAE,KAAK;aAClC;YACD,GAAG;SACN,CAAC;QAEF,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,WAAW,GACb,MAAM,IAAA,kCAAkB,EAA2B,iBAAiB,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QAClG,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,EAAE;YACvC,MAAM,IAAI,4BAAU,CAAC,6CAA6C,CAAC,CAAC;SACvE;QACD,OAAO,WAAW,CAAC,WAAW,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAkB;QAC/B,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;SACzC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACjC,MAAM,kBAAkB,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACzE;gBAAS;YACN,IAAI,CAAC,KAAK,EAAE,CAAC;SAChB;IACL,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,MAA4B;QACpC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK;QACR,wFAAwF;QACxF,mCAAmC;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,UAAkB;QACpC,MAAM,cAAc,GAAqC,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEzG,sEAAsE;QACtE,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;QACtF,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC3B,SAAS,EAAE,oBAAoB;gBAC/B,UAAU;gBACV,MAAM;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,cAAc,CAAC,SAAS,EAAE;YAC1B,OAAO,cAAc,CAAC,aAAa,CAAC;SACvC;QAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAEvE,sEAAsE;QACtE,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC;QAE/B,0CAA0C;QAC1C,gHAAgH;QAChH,oFAAoF;QACpF,wGAAwG;QACxG,2GAA2G;QAC3G,0GAA0G;QAC1G,uGAAuG;QACvG,6CAA6C;QAC7C,4GAA4G;QAC5G,4GAA4G;QAC5G,yGAAyG;QACzG,uEAAuE;QACvE,2GAA2G;QAC3G,0GAA0G;QAC1G,4BAA4B;QAE5B,wBAAwB;QACxB,MAAM,iBAAiB,CAAC,QAAQ,CAC5B,CAAC,cAAc,CAAC,SAAS,IAAI,UAAU,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC,CAAC;QAErF,yGAAyG;QACzG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,2BAA2B,CAAC,UAAgC;QACtE,OAAO,UAAU,KAAK,oBAAoB,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,KAAK,CACf,UAAkB,EAClB,cAAgD;QAChD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBACjC,MAAM,IAAI,4BAAU,CAAC,gCAAgC,CAAC,CAAC;aAC1D;YACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;SACjC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,MAAM,IAAI,4BAAU,CAAC,2DAA2D,CAAC,CAAC;SACrF;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,sDAAsD;QACtD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,mBAAmB;YAC9B,UAAU;YACV,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB;YACrE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;SACrD,CAAC,CAAC;QAEH,8DAA8D;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,4BAAU,CAAC,0CAA0C,CAAC,CAAC;SACpE;QAED,MAAM,iBAAiB,GAAG,MAAM,qCAAiB,CAAC,KAAK,CACnD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAC9C,IAAI,CAAC,mBAAmB,EAAE,EAC1B,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,EAAE,wBAAwB;QAC1F,IAAI,6CAAsB,CACtB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAC5C;YACI,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB;YAClE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;SACjB,CACb,EACD,CAAC,YAAoB,EAAE,EAAE;YACrB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,EACxD,IAAA,gCAAwB,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;aACrD;QACL,CAAC,EACD,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,uBAAuB,EACtC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,4BAA4B,CACrE,IAAI,CAAC,OAAO,CACf,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,sBAAsB;QACtB,6FAA6F;QAC7F,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,4BAA4B,EAAE,EAAE,KAAK,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,OAAO;QACV,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAE1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACtC;IACL,CAAC;IA0DO,KAAK,CAAC,iBAAiB;;QAC3B,IAAI,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB,CAAC;QACxE,IAAI,GAA8B,CAAC;QACnC,OAAO,IAAI,CAAC,iBAAiB,EAAE;YAC3B,MAAM,aAAa,GAAG,MAAA,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,mCAAI,IAAI,CAAC,MAAM,CAAC;YACtG,IAAI;gBACA,mGAAmG;gBACnG,6CAA6C;gBAC7C,GAAG,GAAG,SAAS,CAAC;gBAChB,GAAG,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;gBACrE,iBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC,uBAAuB,CAAC;gBAC1D,MAAM,eAAe,GAAG,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACtD,MAAM,gBAAgB,GAAG,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACxD,uEAAuE;gBACvE,yCAAyC;gBACzC,oEAAoE;gBACpE,MAAM,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,KAAK,IAAI,EAAE,CAClE,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAC1C,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,CAChB,CAAC,CAAC;aACV;YAAC,OAAO,KAAK,EAAE;gBACZ,aAAa,CAAC,cAAc,CAAC;oBACzB,SAAS,EAAE,uBAAuB;oBAClC,uBAAuB,EAAE,iBAAiB;oBAC1C,MAAM,EAAE,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,0CAAE,QAAQ,0CAAE,MAAM;oBACxC,SAAS,EAAE,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,QAAQ,0CAAE,MAAM;iBAC/C,EAAE,KAAK,CAAC,CAAC;aACb;YACD,iBAAiB,EAAE,CAAC;SACvB;IACL,CAAC;CACJ;AA5UD,gCA4UC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ILoader, LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport { DriverHeader } from \"@fluidframework/driver-definitions\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport { ChildLogger, IFluidErrorBase, LoggingError, wrapErrorAndLog } from \"@fluidframework/telemetry-utils\";\nimport {\n    FluidObject,\n    IFluidHandleContext,\n    IFluidHandle,\n    IRequest,\n} from \"@fluidframework/core-interfaces\";\nimport { ISummaryConfiguration } from \"./containerRuntime\";\nimport { ICancellableSummarizerController } from \"./runWhileConnectedCoordinator\";\nimport { summarizerClientType } from \"./summarizerClientElection\";\nimport { IAckedSummary, SummaryCollection } from \"./summaryCollection\";\nimport { SummarizerHandle } from \"./summarizerHandle\";\nimport { RunningSummarizer } from \"./runningSummarizer\";\nimport {\n    ISummarizer,\n    ISummarizerInternalsProvider,\n    ISummarizerRuntime,\n    ISummarizingWarning,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nimport { SummarizeHeuristicData } from \"./summarizerHeuristics\";\nimport { SummarizeResultBuilder } from \"./summaryGenerator\";\nimport { IConnectableRuntime } from \".\";\n\nconst summarizingError = \"summarizingError\";\n\nexport class SummarizingWarning extends LoggingError implements ISummarizingWarning, IFluidErrorBase {\n    readonly errorType = summarizingError;\n    readonly canRetry = true;\n\n    constructor(\n        errorMessage: string,\n        readonly logged: boolean = false,\n    ) {\n        super(errorMessage);\n    }\n\n    static wrap(error: any, logged: boolean = false, logger: ITelemetryLogger) {\n        const newErrorFn = (errMsg: string) => new SummarizingWarning(errMsg, logged);\n        return wrapErrorAndLog<SummarizingWarning>(error, newErrorFn, logger);\n    }\n}\n\nexport const createSummarizingWarning =\n    (errorMessage: string, logged: boolean) => new SummarizingWarning(errorMessage, logged);\n\n/**\n * Summarizer is responsible for coordinating when to generate and send summaries.\n * It is the main entry point for summary work.\n * It is created only by summarizing container (i.e. one with clientType === \"summarizer\")\n */\nexport class Summarizer extends EventEmitter implements ISummarizer {\n    public get IFluidLoadable() { return this; }\n    public get ISummarizer() { return this; }\n\n    private readonly logger: ITelemetryLogger;\n    private runningSummarizer?: RunningSummarizer;\n    private _disposed: boolean = false;\n    private starting: boolean = false;\n\n    private readonly innerHandle: IFluidHandle<this>;\n\n    public get handle(): IFluidHandle<this> { return this.innerHandle; }\n    private readonly stopDeferred = new Deferred<SummarizerStopReason>();\n\n    constructor(\n        url: string,\n        /** Reference to runtime that created this object.\n         * i.e. runtime with clientType === \"summarizer\"\n         */\n        private readonly runtime: ISummarizerRuntime,\n        private readonly configurationGetter: () => ISummaryConfiguration,\n        /** Represents an object that can generate summary.\n         * In practical terms, it's same runtime (this.runtime) with clientType === \"summarizer\".\n        */\n        private readonly internalsProvider: ISummarizerInternalsProvider,\n        handleContext: IFluidHandleContext,\n        public readonly summaryCollection: SummaryCollection,\n        private readonly runCoordinatorCreateFn:\n            (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>,\n    ) {\n        super();\n        this.logger = ChildLogger.create(this.runtime.logger, \"Summarizer\");\n        this.innerHandle = new SummarizerHandle(this, url, handleContext);\n    }\n\n    /**\n     * Creates a Summarizer and its underlying client.\n     * Note that different implementations of ILoader will handle the URL differently.\n     * ILoader provided by a ContainerRuntime is a RelativeLoader, which will treat URL's\n     * starting with \"/\" as relative to the Container. The general ILoader\n     * interface will expect an absolute URL and will not handle \"/\".\n     * @param loader - the loader that resolves the request\n     * @param url - the URL used to resolve the container\n     */\n    public static async create(\n        loader: ILoader,\n        url: string): Promise<ISummarizer> {\n        const request: IRequest = {\n            headers: {\n                [LoaderHeader.cache]: false,\n                [LoaderHeader.clientDetails]: {\n                    capabilities: { interactive: false },\n                    type: summarizerClientType,\n                },\n                [DriverHeader.summarizingClient]: true,\n                [LoaderHeader.reconnect]: false,\n            },\n            url,\n        };\n\n        const resolvedContainer = await loader.resolve(request);\n        const fluidObject =\n            await requestFluidObject<FluidObject<ISummarizer>>(resolvedContainer, { url: \"_summarizer\" });\n        if (fluidObject.ISummarizer === undefined) {\n            throw new UsageError(\"Fluid object does not implement ISummarizer\");\n        }\n        return fluidObject.ISummarizer;\n    }\n\n    public async run(onBehalfOf: string): Promise<SummarizerStopReason> {\n        try {\n            return await this.runCore(onBehalfOf);\n        } catch (error) {\n            this.stop(\"summarizerException\");\n            throw SummarizingWarning.wrap(error, false /* logged */, this.logger);\n        } finally {\n            this.close();\n        }\n    }\n\n    /**\n     * Stops the summarizer from running.  This will complete\n     * the run promise, and also close the container.\n     * @param reason - reason code for stopping\n     */\n    public stop(reason: SummarizerStopReason) {\n        this.stopDeferred.resolve(reason);\n    }\n\n    public close() {\n        // This will result in \"summarizerClientDisconnected\" stop reason recorded in telemetry,\n        // unless stop() was called earlier\n        this.dispose();\n        this.runtime.closeFn();\n    }\n\n    private async runCore(onBehalfOf: string): Promise<SummarizerStopReason> {\n        const runCoordinator: ICancellableSummarizerController = await this.runCoordinatorCreateFn(this.runtime);\n\n        // Wait for either external signal to cancel, or loss of connectivity.\n        const stopP = Promise.race([runCoordinator.waitCancelled, this.stopDeferred.promise]);\n        void stopP.then((reason) => {\n            this.logger.sendTelemetryEvent({\n                eventName: \"StoppingSummarizer\",\n                onBehalfOf,\n                reason,\n            });\n        });\n\n        if (runCoordinator.cancelled) {\n            return runCoordinator.waitCancelled;\n        }\n\n        const runningSummarizer = await this.start(onBehalfOf, runCoordinator);\n\n        // Wait for either external signal to cancel, or loss of connectivity.\n        const stopReason = await stopP;\n\n        // There are two possible approaches here:\n        // 1. Propagate cancellation from this.stopDeferred to runCoordinator. This will ensure that we move to the exit\n        //    faster, including breaking out of the RunningSummarizer.trySummarize() faster.\n        //    We could create new coordinator and pass it to waitStop() -> trySummarizeOnce(\"lastSummary\") flow.\n        //    The con of this approach is that we might cancel active summary, and lastSummary will fail because it\n        //    did not wait for ack/nack from previous summary. Plus we disregard any 429 kind of info from service\n        //    that way (i.e. trySummarize() loop might have been waiting for 5 min because storage told us so).\n        //    In general, it's more wasted resources.\n        // 2. We can not do it and make waitStop() do last summary only if there was no active summary. This ensures\n        //    that client behaves properly (from server POV) and we do not waste resources. But, it may mean we wait\n        //    substantially longer for trySummarize() retries to play out and thus this summary loop may run into\n        //    conflict with new summarizer client starting on different client.\n        // As of now, #2 is implemented. It's more forward looking, as issue #7279 suggests changing design for new\n        // summarizer client to not be created until current summarizer fully moves to exit, and that would reduce\n        // cons of #2 substantially.\n\n        // Cleanup after running\n        await runningSummarizer.waitStop(\n            !runCoordinator.cancelled && Summarizer.stopReasonCanRunLastSummary(stopReason));\n\n        // Propagate reason and ensure that if someone is waiting for cancellation token, they are moving to exit\n        runCoordinator.stop(stopReason);\n\n        return stopReason;\n    }\n\n    /**\n     * Should we try to run a last summary for the given stop reason?\n     * Currently only allows \"parentNotConnected\"\n     * @param stopReason - SummarizerStopReason\n     * @returns - true if the stop reason can run a last summary\n     */\n    public static stopReasonCanRunLastSummary(stopReason: SummarizerStopReason): boolean {\n        return stopReason === \"parentNotConnected\";\n    }\n\n    /**\n     * Put the summarizer in a started state, including creating and initializing the RunningSummarizer.\n     * The start request can come either from the SummaryManager (in the auto-summarize case) or from the user\n     * (in the on-demand case).\n     * @param onBehalfOf - ID of the client that requested that the summarizer start\n     * @param runCoordinator - cancellation token\n     * @param newConfig - Summary configuration to override the existing config when invoking the RunningSummarizer.\n     * @returns - Promise that is fulfilled when the RunningSummarizer is ready\n     */\n    private async start(\n        onBehalfOf: string,\n        runCoordinator: ICancellableSummarizerController): Promise<RunningSummarizer> {\n        if (this.runningSummarizer) {\n            if (this.runningSummarizer.disposed) {\n                throw new UsageError(\"Starting a disposed summarizer\");\n            }\n            return this.runningSummarizer;\n        }\n        if (this.starting) {\n            throw new UsageError(\"Attempting to start a summarizer that is already starting\");\n        }\n        this.starting = true;\n        // Initialize values and first ack (time is not exact)\n        this.logger.sendTelemetryEvent({\n            eventName: \"RunningSummarizer\",\n            onBehalfOf,\n            initSummarySeqNumber: this.runtime.deltaManager.initialSequenceNumber,\n            config: JSON.stringify(this.configurationGetter()),\n        });\n\n        // Summarizing container ID (with clientType === \"summarizer\")\n        const clientId = this.runtime.clientId;\n        if (clientId === undefined) {\n            throw new UsageError(\"clientId should be defined if connected.\");\n        }\n\n        const runningSummarizer = await RunningSummarizer.start(\n            this.logger,\n            this.summaryCollection.createWatcher(clientId),\n            this.configurationGetter(),\n            async (...args) => this.internalsProvider.submitSummary(...args), // submitSummaryCallback\n            new SummarizeHeuristicData(\n                this.runtime.deltaManager.lastSequenceNumber,\n                { /** summary attempt baseline for heuristics */\n                    refSequenceNumber: this.runtime.deltaManager.initialSequenceNumber,\n                    summaryTime: Date.now(),\n                } as const,\n            ),\n            (errorMessage: string) => {\n                if (!this._disposed) {\n                    this.logger.sendErrorEvent({ eventName: \"summarizingError\" },\n                        createSummarizingWarning(errorMessage, true));\n                }\n            },\n            this.summaryCollection,\n            runCoordinator /* cancellationToken */,\n            (reason) => runCoordinator.stop(reason), /* stopSummarizerCallback */\n            this.runtime,\n        );\n        this.runningSummarizer = runningSummarizer;\n        this.starting = false;\n\n        // Handle summary acks\n        // Note: no exceptions are thrown from handleSummaryAcks handler as it handles all exceptions\n        this.handleSummaryAcks().catch((error) => {\n            this.logger.sendErrorEvent({ eventName: \"HandleSummaryAckFatalError\" }, error);\n        });\n\n        return runningSummarizer;\n    }\n\n    /**\n     * Disposes of resources after running.  This cleanup will\n     * clear any outstanding timers and reset some of the state\n     * properties.\n     * Called by ContainerRuntime when it is disposed, as well as at the end the run().\n     */\n    public dispose() {\n        // Given that the call can come from own ContainerRuntime, ensure that we stop all the processes.\n        this.stop(\"summarizerClientDisconnected\");\n\n        this._disposed = true;\n        if (this.runningSummarizer) {\n            this.runningSummarizer.dispose();\n            this.runningSummarizer = undefined;\n        }\n    }\n\n    public readonly summarizeOnDemand: ISummarizer[\"summarizeOnDemand\"] = (...args) => {\n        try {\n            if (this._disposed || this.runningSummarizer?.disposed) {\n                throw new UsageError(\"Summarizer is already disposed.\");\n            }\n            if (this.runtime.summarizerClientId !== undefined &&\n                this.runtime.summarizerClientId !== this.runtime.clientId) {\n                // If there is an elected summarizer, and it's not this one, don't allow on-demand summary.\n                // This is to prevent the on-demand summary and heuristic-based summary from stepping on\n                // each other.\n                throw new UsageError(\"On-demand summary attempted while an elected summarizer is present\");\n            }\n            const builder = new SummarizeResultBuilder();\n            if (this.runningSummarizer) {\n                // Summarizer is already running. Go ahead and start.\n                return this.runningSummarizer.summarizeOnDemand(builder, ...args);\n            }\n\n            // Summarizer isn't running, so we need to start it, which is an async operation.\n            // Manage the promise related to creating the cancellation token here.\n            // The promises related to starting, summarizing,\n            // and submitting are communicated to the caller through the results builder.\n            const coordinatorCreateP = this.runCoordinatorCreateFn(this.runtime);\n\n            coordinatorCreateP.then((runCoordinator) => {\n                // Successully created the cancellation token. Start the summarizer.\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const startP = this.start(this.runtime.clientId!, runCoordinator);\n                startP.then(async (runningSummarizer) => {\n                    // Successfully started the summarizer. Run it.\n                    runningSummarizer.summarizeOnDemand(builder, ...args);\n                    // Wait for a command to stop or loss of connectivity before tearing down the summarizer and client.\n                    const stopReason = await Promise.race([this.stopDeferred.promise, runCoordinator.waitCancelled]);\n                    await runningSummarizer.waitStop(false);\n                    runCoordinator.stop(stopReason);\n                    this.close();\n                }).catch((reason) => {\n                    builder.fail(\"Failed to start summarizer\", reason);\n                });\n            }).catch((reason) => {\n                builder.fail(\"Failed to create cancellation token\", reason);\n            });\n\n            return builder.build();\n        } catch (error) {\n            throw SummarizingWarning.wrap(error, false /* logged */, this.logger);\n        }\n    };\n\n    public readonly enqueueSummarize: ISummarizer[\"enqueueSummarize\"] = (...args) => {\n        if (this._disposed || this.runningSummarizer === undefined || this.runningSummarizer.disposed) {\n            throw new UsageError(\"Summarizer is not running or already disposed.\");\n        }\n        return this.runningSummarizer.enqueueSummarize(...args);\n    };\n\n    private async handleSummaryAcks() {\n        let refSequenceNumber = this.runtime.deltaManager.initialSequenceNumber;\n        let ack: IAckedSummary | undefined;\n        while (this.runningSummarizer) {\n            const summaryLogger = this.runningSummarizer.tryGetCorrelatedLogger(refSequenceNumber) ?? this.logger;\n            try {\n                // Initialize ack with undefined if exception happens inside of waitSummaryAck on second iteration,\n                // we record undefined, not previous handles.\n                ack = undefined;\n                ack = await this.summaryCollection.waitSummaryAck(refSequenceNumber);\n                refSequenceNumber = ack.summaryOp.referenceSequenceNumber;\n                const summaryOpHandle = ack.summaryOp.contents.handle;\n                const summaryAckHandle = ack.summaryAck.contents.handle;\n                // Make sure we block any summarizer from being executed/enqueued while\n                // executing the refreshLatestSummaryAck.\n                // https://dev.azure.com/fluidframework/internal/_workitems/edit/779\n                await this.runningSummarizer.lockedRefreshSummaryAckAction(async () =>\n                    this.internalsProvider.refreshLatestSummaryAck(\n                        summaryOpHandle,\n                        summaryAckHandle,\n                        refSequenceNumber,\n                        summaryLogger,\n                    ));\n            } catch (error) {\n                summaryLogger.sendErrorEvent({\n                    eventName: \"HandleSummaryAckError\",\n                    referenceSequenceNumber: refSequenceNumber,\n                    handle: ack?.summaryOp?.contents?.handle,\n                    ackHandle: ack?.summaryAck?.contents?.handle,\n                }, error);\n            }\n            refSequenceNumber++;\n        }\n    }\n}\n"]}
+{"version":3,"file":"summarizer.js","sourceRoot":"","sources":["../src/summarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mCAAsC;AACtC,+DAAwD;AAExD,iFAA8E;AAC9E,qEAA6D;AAC7D,2EAAmF;AACnF,iEAAmE;AACnE,qEAMyC;AASzC,yEAAkE;AAElE,yDAAsD;AACtD,2DAAwD;AAQxD,iEAAgE;AAChE,yDAA4D;AAG5D,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;AAE5C,MAAa,kBAAmB,SAAQ,8BAAY;IAIhD,YACI,YAAoB,EACX,SAAkB,KAAK;QAEhC,KAAK,CAAC,YAAY,CAAC,CAAC;QAFX,WAAM,GAAN,MAAM,CAAiB;QAL3B,cAAS,GAAG,gBAAgB,CAAC;QAC7B,aAAQ,GAAG,IAAI,CAAC;IAOzB,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAU,EAAE,SAAkB,KAAK,EAAE,MAAwB;QACrE,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC9E,OAAO,IAAA,iCAAe,EAAqB,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;CACJ;AAfD,gDAeC;AAEM,MAAM,wBAAwB,GACjC,CAAC,YAAoB,EAAE,MAAe,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAD/E,QAAA,wBAAwB,4BACuD;AAE5F;;;;GAIG;AACH,MAAa,UAAW,SAAQ,qBAAY;IAcxC,YACI,GAAW;IACX;;OAEG;IACc,OAA2B,EAC3B,mBAAgD;IACjE;;MAEE;IACe,iBAA+C,EAChE,aAAkC,EAClB,iBAAoC,EACnC,sBAC8D;QAE/E,KAAK,EAAE,CAAC;QAXS,YAAO,GAAP,OAAO,CAAoB;QAC3B,wBAAmB,GAAnB,mBAAmB,CAA6B;QAIhD,sBAAiB,GAAjB,iBAAiB,CAA8B;QAEhD,sBAAiB,GAAjB,iBAAiB,CAAmB;QACnC,2BAAsB,GAAtB,sBAAsB,CACwC;QAtB3E,cAAS,GAAY,KAAK,CAAC;QAC3B,aAAQ,GAAY,KAAK,CAAC;QAKjB,iBAAY,GAAG,IAAI,uBAAQ,EAAwB,CAAC;QAsOrD,sBAAiB,GAAqC,CAAC,GAAG,IAAI,EAAE,EAAE;;YAC9E,IAAI;gBACA,IAAI,IAAI,CAAC,SAAS,KAAI,MAAA,IAAI,CAAC,iBAAiB,0CAAE,QAAQ,CAAA,EAAE;oBACpD,MAAM,IAAI,4BAAU,CAAC,iCAAiC,CAAC,CAAC;iBAC3D;gBACD,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,KAAK,SAAS;oBAC7C,IAAI,CAAC,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBAC3D,2FAA2F;oBAC3F,wFAAwF;oBACxF,cAAc;oBACd,MAAM,IAAI,4BAAU,CAAC,oEAAoE,CAAC,CAAC;iBAC9F;gBACD,MAAM,OAAO,GAAG,IAAI,yCAAsB,EAAE,CAAC;gBAC7C,IAAI,IAAI,CAAC,iBAAiB,EAAE;oBACxB,qDAAqD;oBACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;iBACrE;gBAED,iFAAiF;gBACjF,sEAAsE;gBACtE,iDAAiD;gBACjD,6EAA6E;gBAC7E,MAAM,kBAAkB,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAErE,kBAAkB,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;oBACvC,oEAAoE;oBACpE,oEAAoE;oBACpE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAS,EAAE,cAAc,CAAC,CAAC;oBAClE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,EAAE;wBACpC,+CAA+C;wBAC/C,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;wBACtD,oGAAoG;wBACpG,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;wBACjG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;wBACxC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;wBAChC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACjB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;wBAChB,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;oBACvD,CAAC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;oBAChB,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;gBAChE,CAAC,CAAC,CAAC;gBAEH,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;aAC1B;YAAC,OAAO,KAAK,EAAE;gBACZ,MAAM,kBAAkB,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACzE;QACL,CAAC,CAAC;QAEc,qBAAgB,GAAoC,CAAC,GAAG,IAAI,EAAE,EAAE;YAC5E,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBAC3F,MAAM,IAAI,4BAAU,CAAC,gDAAgD,CAAC,CAAC;aAC1E;YACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5D,CAAC,CAAC;QAzQE,IAAI,CAAC,MAAM,GAAG,6BAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACpE,IAAI,CAAC,WAAW,GAAG,IAAI,mCAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IACtE,CAAC;IAhCD,IAAW,cAAc,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAC5C,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IASzC,IAAW,MAAM,KAAyB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAwBpE;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,MAAe,EACf,GAAW;QACX,MAAM,OAAO,GAAa;YACtB,OAAO,EAAE;gBACL,CAAC,oCAAY,CAAC,KAAK,CAAC,EAAE,KAAK;gBAC3B,CAAC,oCAAY,CAAC,aAAa,CAAC,EAAE;oBAC1B,YAAY,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;oBACpC,IAAI,EAAE,+CAAoB;iBAC7B;gBACD,CAAC,iCAAY,CAAC,iBAAiB,CAAC,EAAE,IAAI;gBACtC,CAAC,oCAAY,CAAC,SAAS,CAAC,EAAE,KAAK;aAClC;YACD,GAAG;SACN,CAAC;QAEF,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,WAAW,GACb,MAAM,IAAA,kCAAkB,EAA2B,iBAAiB,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QAClG,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,EAAE;YACvC,MAAM,IAAI,4BAAU,CAAC,6CAA6C,CAAC,CAAC;SACvE;QACD,OAAO,WAAW,CAAC,WAAW,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,UAAkB;QAC/B,IAAI;YACA,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;SACzC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACjC,MAAM,kBAAkB,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACzE;gBAAS;YACN,IAAI,CAAC,KAAK,EAAE,CAAC;SAChB;IACL,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,MAA4B;QACpC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK;QACR,wFAAwF;QACxF,mCAAmC;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,UAAkB;QACpC,MAAM,cAAc,GAAqC,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEzG,sEAAsE;QACtE,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;QACtF,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;gBAC3B,SAAS,EAAE,oBAAoB;gBAC/B,UAAU;gBACV,MAAM;aACT,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,cAAc,CAAC,SAAS,EAAE;YAC1B,OAAO,cAAc,CAAC,aAAa,CAAC;SACvC;QAED,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAEvE,sEAAsE;QACtE,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC;QAE/B,0CAA0C;QAC1C,gHAAgH;QAChH,oFAAoF;QACpF,wGAAwG;QACxG,2GAA2G;QAC3G,0GAA0G;QAC1G,uGAAuG;QACvG,6CAA6C;QAC7C,4GAA4G;QAC5G,4GAA4G;QAC5G,yGAAyG;QACzG,uEAAuE;QACvE,2GAA2G;QAC3G,0GAA0G;QAC1G,4BAA4B;QAE5B,wBAAwB;QACxB,MAAM,iBAAiB,CAAC,QAAQ,CAC5B,CAAC,cAAc,CAAC,SAAS,IAAI,UAAU,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC,CAAC;QAErF,yGAAyG;QACzG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,2BAA2B,CAAC,UAAgC;QACtE,OAAO,UAAU,KAAK,oBAAoB,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,KAAK,CACf,UAAkB,EAClB,cAAgD;QAChD,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;gBACjC,MAAM,IAAI,4BAAU,CAAC,gCAAgC,CAAC,CAAC;aAC1D;YACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;SACjC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACf,MAAM,IAAI,4BAAU,CAAC,2DAA2D,CAAC,CAAC;SACrF;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,sDAAsD;QACtD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC3B,SAAS,EAAE,mBAAmB;YAC9B,UAAU;YACV,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB;YACrE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;SACrD,CAAC,CAAC;QAEH,8DAA8D;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACvC,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,MAAM,IAAI,4BAAU,CAAC,0CAA0C,CAAC,CAAC;SACpE;QAED,MAAM,iBAAiB,GAAG,MAAM,qCAAiB,CAAC,KAAK,CACnD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAC9C,IAAI,CAAC,mBAAmB,EAAE,EAC1B,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,EAAE,wBAAwB;QAC1F,IAAI,6CAAsB,CACtB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAC5C;YACI,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB;YAClE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;SACjB,CACb,EACD,CAAC,YAAoB,EAAE,EAAE;YACrB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAE,EACxD,IAAA,gCAAwB,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;aACrD;QACL,CAAC,EACD,IAAI,CAAC,iBAAiB,EACtB,cAAc,CAAC,uBAAuB,EACtC,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,4BAA4B,CACrE,IAAI,CAAC,OAAO,CACf,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,sBAAsB;QACtB,6FAA6F;QAC7F,IAAI,CAAC,iBAAiB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,4BAA4B,EAAE,EAAE,KAAK,CAAC,CAAC;QACnF,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,OAAO;QACV,iGAAiG;QACjG,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAE1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACxB,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC;SACtC;IACL,CAAC;IA0DO,KAAK,CAAC,iBAAiB;;QAC3B,IAAI,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB,CAAC;QACxE,IAAI,GAA8B,CAAC;QACnC,OAAO,IAAI,CAAC,iBAAiB,EAAE;YAC3B,MAAM,aAAa,GAAG,MAAA,IAAI,CAAC,iBAAiB,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,mCAAI,IAAI,CAAC,MAAM,CAAC;YACtG,IAAI;gBACA,mGAAmG;gBACnG,6CAA6C;gBAC7C,GAAG,GAAG,SAAS,CAAC;gBAChB,GAAG,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;gBACrE,iBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC,uBAAuB,CAAC;gBAC1D,MAAM,eAAe,GAAG,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACtD,MAAM,gBAAgB,GAAG,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACxD,uEAAuE;gBACvE,yCAAyC;gBACzC,oEAAoE;gBACpE,MAAM,IAAI,CAAC,iBAAiB,CAAC,6BAA6B,CAAC,KAAK,IAAI,EAAE,CAClE,IAAI,CAAC,iBAAiB,CAAC,uBAAuB,CAC1C,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,CAChB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACpB,wFAAwF;oBACxF,wFAAwF;oBACxF,wFAAwF;oBACxF,uFAAuF;oBACvF,uFAAuF;oBACvF,sEAAsE;oBACtE,IAAI,IAAA,8BAAY,EAAC,KAAK,CAAC;2BAChB,KAAK,CAAC,SAAS,KAAK,oCAAe,CAAC,+BAA+B,EAAE;wBACxE,aAAa,CAAC,kBAAkB,CAAC;4BAC7B,SAAS,EAAE,8BAA8B;4BACzC,uBAAuB,EAAE,iBAAiB;4BAC1C,cAAc,EAAE,eAAe;4BAC/B,SAAS,EAAE,gBAAgB;yBAC9B,EAAE,KAAK,CAAC,CAAC;qBACb;yBAAM;wBACH,MAAM,KAAK,CAAC;qBACf;gBACL,CAAC,CAAC,CACL,CAAC;aACL;YAAC,OAAO,KAAK,EAAE;gBACZ,aAAa,CAAC,cAAc,CAAC;oBACzB,SAAS,EAAE,uBAAuB;oBAClC,uBAAuB,EAAE,iBAAiB;oBAC1C,MAAM,EAAE,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,0CAAE,QAAQ,0CAAE,MAAM;oBACxC,SAAS,EAAE,MAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,0CAAE,QAAQ,0CAAE,MAAM;iBAC/C,EAAE,KAAK,CAAC,CAAC;aACb;YACD,iBAAiB,EAAE,CAAC;SACvB;IACL,CAAC;CACJ;AA/VD,gCA+VC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { EventEmitter } from \"events\";\nimport { Deferred } from \"@fluidframework/common-utils\";\nimport { ITelemetryLogger } from \"@fluidframework/common-definitions\";\nimport { ILoader, LoaderHeader } from \"@fluidframework/container-definitions\";\nimport { UsageError } from \"@fluidframework/container-utils\";\nimport { DriverErrorType, DriverHeader } from \"@fluidframework/driver-definitions\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport {\n    ChildLogger,\n    IFluidErrorBase,\n    isFluidError,\n    LoggingError,\n    wrapErrorAndLog,\n} from \"@fluidframework/telemetry-utils\";\nimport {\n    FluidObject,\n    IFluidHandleContext,\n    IFluidHandle,\n    IRequest,\n} from \"@fluidframework/core-interfaces\";\nimport { ISummaryConfiguration } from \"./containerRuntime\";\nimport { ICancellableSummarizerController } from \"./runWhileConnectedCoordinator\";\nimport { summarizerClientType } from \"./summarizerClientElection\";\nimport { IAckedSummary, SummaryCollection } from \"./summaryCollection\";\nimport { SummarizerHandle } from \"./summarizerHandle\";\nimport { RunningSummarizer } from \"./runningSummarizer\";\nimport {\n    ISummarizer,\n    ISummarizerInternalsProvider,\n    ISummarizerRuntime,\n    ISummarizingWarning,\n    SummarizerStopReason,\n} from \"./summarizerTypes\";\nimport { SummarizeHeuristicData } from \"./summarizerHeuristics\";\nimport { SummarizeResultBuilder } from \"./summaryGenerator\";\nimport { IConnectableRuntime } from \".\";\n\nconst summarizingError = \"summarizingError\";\n\nexport class SummarizingWarning extends LoggingError implements ISummarizingWarning, IFluidErrorBase {\n    readonly errorType = summarizingError;\n    readonly canRetry = true;\n\n    constructor(\n        errorMessage: string,\n        readonly logged: boolean = false,\n    ) {\n        super(errorMessage);\n    }\n\n    static wrap(error: any, logged: boolean = false, logger: ITelemetryLogger) {\n        const newErrorFn = (errMsg: string) => new SummarizingWarning(errMsg, logged);\n        return wrapErrorAndLog<SummarizingWarning>(error, newErrorFn, logger);\n    }\n}\n\nexport const createSummarizingWarning =\n    (errorMessage: string, logged: boolean) => new SummarizingWarning(errorMessage, logged);\n\n/**\n * Summarizer is responsible for coordinating when to generate and send summaries.\n * It is the main entry point for summary work.\n * It is created only by summarizing container (i.e. one with clientType === \"summarizer\")\n */\nexport class Summarizer extends EventEmitter implements ISummarizer {\n    public get IFluidLoadable() { return this; }\n    public get ISummarizer() { return this; }\n\n    private readonly logger: ITelemetryLogger;\n    private runningSummarizer?: RunningSummarizer;\n    private _disposed: boolean = false;\n    private starting: boolean = false;\n\n    private readonly innerHandle: IFluidHandle<this>;\n\n    public get handle(): IFluidHandle<this> { return this.innerHandle; }\n    private readonly stopDeferred = new Deferred<SummarizerStopReason>();\n\n    constructor(\n        url: string,\n        /** Reference to runtime that created this object.\n         * i.e. runtime with clientType === \"summarizer\"\n         */\n        private readonly runtime: ISummarizerRuntime,\n        private readonly configurationGetter: () => ISummaryConfiguration,\n        /** Represents an object that can generate summary.\n         * In practical terms, it's same runtime (this.runtime) with clientType === \"summarizer\".\n        */\n        private readonly internalsProvider: ISummarizerInternalsProvider,\n        handleContext: IFluidHandleContext,\n        public readonly summaryCollection: SummaryCollection,\n        private readonly runCoordinatorCreateFn:\n            (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>,\n    ) {\n        super();\n        this.logger = ChildLogger.create(this.runtime.logger, \"Summarizer\");\n        this.innerHandle = new SummarizerHandle(this, url, handleContext);\n    }\n\n    /**\n     * Creates a Summarizer and its underlying client.\n     * Note that different implementations of ILoader will handle the URL differently.\n     * ILoader provided by a ContainerRuntime is a RelativeLoader, which will treat URL's\n     * starting with \"/\" as relative to the Container. The general ILoader\n     * interface will expect an absolute URL and will not handle \"/\".\n     * @param loader - the loader that resolves the request\n     * @param url - the URL used to resolve the container\n     */\n    public static async create(\n        loader: ILoader,\n        url: string): Promise<ISummarizer> {\n        const request: IRequest = {\n            headers: {\n                [LoaderHeader.cache]: false,\n                [LoaderHeader.clientDetails]: {\n                    capabilities: { interactive: false },\n                    type: summarizerClientType,\n                },\n                [DriverHeader.summarizingClient]: true,\n                [LoaderHeader.reconnect]: false,\n            },\n            url,\n        };\n\n        const resolvedContainer = await loader.resolve(request);\n        const fluidObject =\n            await requestFluidObject<FluidObject<ISummarizer>>(resolvedContainer, { url: \"_summarizer\" });\n        if (fluidObject.ISummarizer === undefined) {\n            throw new UsageError(\"Fluid object does not implement ISummarizer\");\n        }\n        return fluidObject.ISummarizer;\n    }\n\n    public async run(onBehalfOf: string): Promise<SummarizerStopReason> {\n        try {\n            return await this.runCore(onBehalfOf);\n        } catch (error) {\n            this.stop(\"summarizerException\");\n            throw SummarizingWarning.wrap(error, false /* logged */, this.logger);\n        } finally {\n            this.close();\n        }\n    }\n\n    /**\n     * Stops the summarizer from running.  This will complete\n     * the run promise, and also close the container.\n     * @param reason - reason code for stopping\n     */\n    public stop(reason: SummarizerStopReason) {\n        this.stopDeferred.resolve(reason);\n    }\n\n    public close() {\n        // This will result in \"summarizerClientDisconnected\" stop reason recorded in telemetry,\n        // unless stop() was called earlier\n        this.dispose();\n        this.runtime.closeFn();\n    }\n\n    private async runCore(onBehalfOf: string): Promise<SummarizerStopReason> {\n        const runCoordinator: ICancellableSummarizerController = await this.runCoordinatorCreateFn(this.runtime);\n\n        // Wait for either external signal to cancel, or loss of connectivity.\n        const stopP = Promise.race([runCoordinator.waitCancelled, this.stopDeferred.promise]);\n        void stopP.then((reason) => {\n            this.logger.sendTelemetryEvent({\n                eventName: \"StoppingSummarizer\",\n                onBehalfOf,\n                reason,\n            });\n        });\n\n        if (runCoordinator.cancelled) {\n            return runCoordinator.waitCancelled;\n        }\n\n        const runningSummarizer = await this.start(onBehalfOf, runCoordinator);\n\n        // Wait for either external signal to cancel, or loss of connectivity.\n        const stopReason = await stopP;\n\n        // There are two possible approaches here:\n        // 1. Propagate cancellation from this.stopDeferred to runCoordinator. This will ensure that we move to the exit\n        //    faster, including breaking out of the RunningSummarizer.trySummarize() faster.\n        //    We could create new coordinator and pass it to waitStop() -> trySummarizeOnce(\"lastSummary\") flow.\n        //    The con of this approach is that we might cancel active summary, and lastSummary will fail because it\n        //    did not wait for ack/nack from previous summary. Plus we disregard any 429 kind of info from service\n        //    that way (i.e. trySummarize() loop might have been waiting for 5 min because storage told us so).\n        //    In general, it's more wasted resources.\n        // 2. We can not do it and make waitStop() do last summary only if there was no active summary. This ensures\n        //    that client behaves properly (from server POV) and we do not waste resources. But, it may mean we wait\n        //    substantially longer for trySummarize() retries to play out and thus this summary loop may run into\n        //    conflict with new summarizer client starting on different client.\n        // As of now, #2 is implemented. It's more forward looking, as issue #7279 suggests changing design for new\n        // summarizer client to not be created until current summarizer fully moves to exit, and that would reduce\n        // cons of #2 substantially.\n\n        // Cleanup after running\n        await runningSummarizer.waitStop(\n            !runCoordinator.cancelled && Summarizer.stopReasonCanRunLastSummary(stopReason));\n\n        // Propagate reason and ensure that if someone is waiting for cancellation token, they are moving to exit\n        runCoordinator.stop(stopReason);\n\n        return stopReason;\n    }\n\n    /**\n     * Should we try to run a last summary for the given stop reason?\n     * Currently only allows \"parentNotConnected\"\n     * @param stopReason - SummarizerStopReason\n     * @returns - true if the stop reason can run a last summary\n     */\n    public static stopReasonCanRunLastSummary(stopReason: SummarizerStopReason): boolean {\n        return stopReason === \"parentNotConnected\";\n    }\n\n    /**\n     * Put the summarizer in a started state, including creating and initializing the RunningSummarizer.\n     * The start request can come either from the SummaryManager (in the auto-summarize case) or from the user\n     * (in the on-demand case).\n     * @param onBehalfOf - ID of the client that requested that the summarizer start\n     * @param runCoordinator - cancellation token\n     * @param newConfig - Summary configuration to override the existing config when invoking the RunningSummarizer.\n     * @returns - Promise that is fulfilled when the RunningSummarizer is ready\n     */\n    private async start(\n        onBehalfOf: string,\n        runCoordinator: ICancellableSummarizerController): Promise<RunningSummarizer> {\n        if (this.runningSummarizer) {\n            if (this.runningSummarizer.disposed) {\n                throw new UsageError(\"Starting a disposed summarizer\");\n            }\n            return this.runningSummarizer;\n        }\n        if (this.starting) {\n            throw new UsageError(\"Attempting to start a summarizer that is already starting\");\n        }\n        this.starting = true;\n        // Initialize values and first ack (time is not exact)\n        this.logger.sendTelemetryEvent({\n            eventName: \"RunningSummarizer\",\n            onBehalfOf,\n            initSummarySeqNumber: this.runtime.deltaManager.initialSequenceNumber,\n            config: JSON.stringify(this.configurationGetter()),\n        });\n\n        // Summarizing container ID (with clientType === \"summarizer\")\n        const clientId = this.runtime.clientId;\n        if (clientId === undefined) {\n            throw new UsageError(\"clientId should be defined if connected.\");\n        }\n\n        const runningSummarizer = await RunningSummarizer.start(\n            this.logger,\n            this.summaryCollection.createWatcher(clientId),\n            this.configurationGetter(),\n            async (...args) => this.internalsProvider.submitSummary(...args), // submitSummaryCallback\n            new SummarizeHeuristicData(\n                this.runtime.deltaManager.lastSequenceNumber,\n                { /** summary attempt baseline for heuristics */\n                    refSequenceNumber: this.runtime.deltaManager.initialSequenceNumber,\n                    summaryTime: Date.now(),\n                } as const,\n            ),\n            (errorMessage: string) => {\n                if (!this._disposed) {\n                    this.logger.sendErrorEvent({ eventName: \"summarizingError\" },\n                        createSummarizingWarning(errorMessage, true));\n                }\n            },\n            this.summaryCollection,\n            runCoordinator /* cancellationToken */,\n            (reason) => runCoordinator.stop(reason), /* stopSummarizerCallback */\n            this.runtime,\n        );\n        this.runningSummarizer = runningSummarizer;\n        this.starting = false;\n\n        // Handle summary acks\n        // Note: no exceptions are thrown from handleSummaryAcks handler as it handles all exceptions\n        this.handleSummaryAcks().catch((error) => {\n            this.logger.sendErrorEvent({ eventName: \"HandleSummaryAckFatalError\" }, error);\n        });\n\n        return runningSummarizer;\n    }\n\n    /**\n     * Disposes of resources after running.  This cleanup will\n     * clear any outstanding timers and reset some of the state\n     * properties.\n     * Called by ContainerRuntime when it is disposed, as well as at the end the run().\n     */\n    public dispose() {\n        // Given that the call can come from own ContainerRuntime, ensure that we stop all the processes.\n        this.stop(\"summarizerClientDisconnected\");\n\n        this._disposed = true;\n        if (this.runningSummarizer) {\n            this.runningSummarizer.dispose();\n            this.runningSummarizer = undefined;\n        }\n    }\n\n    public readonly summarizeOnDemand: ISummarizer[\"summarizeOnDemand\"] = (...args) => {\n        try {\n            if (this._disposed || this.runningSummarizer?.disposed) {\n                throw new UsageError(\"Summarizer is already disposed.\");\n            }\n            if (this.runtime.summarizerClientId !== undefined &&\n                this.runtime.summarizerClientId !== this.runtime.clientId) {\n                // If there is an elected summarizer, and it's not this one, don't allow on-demand summary.\n                // This is to prevent the on-demand summary and heuristic-based summary from stepping on\n                // each other.\n                throw new UsageError(\"On-demand summary attempted while an elected summarizer is present\");\n            }\n            const builder = new SummarizeResultBuilder();\n            if (this.runningSummarizer) {\n                // Summarizer is already running. Go ahead and start.\n                return this.runningSummarizer.summarizeOnDemand(builder, ...args);\n            }\n\n            // Summarizer isn't running, so we need to start it, which is an async operation.\n            // Manage the promise related to creating the cancellation token here.\n            // The promises related to starting, summarizing,\n            // and submitting are communicated to the caller through the results builder.\n            const coordinatorCreateP = this.runCoordinatorCreateFn(this.runtime);\n\n            coordinatorCreateP.then((runCoordinator) => {\n                // Successully created the cancellation token. Start the summarizer.\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const startP = this.start(this.runtime.clientId!, runCoordinator);\n                startP.then(async (runningSummarizer) => {\n                    // Successfully started the summarizer. Run it.\n                    runningSummarizer.summarizeOnDemand(builder, ...args);\n                    // Wait for a command to stop or loss of connectivity before tearing down the summarizer and client.\n                    const stopReason = await Promise.race([this.stopDeferred.promise, runCoordinator.waitCancelled]);\n                    await runningSummarizer.waitStop(false);\n                    runCoordinator.stop(stopReason);\n                    this.close();\n                }).catch((reason) => {\n                    builder.fail(\"Failed to start summarizer\", reason);\n                });\n            }).catch((reason) => {\n                builder.fail(\"Failed to create cancellation token\", reason);\n            });\n\n            return builder.build();\n        } catch (error) {\n            throw SummarizingWarning.wrap(error, false /* logged */, this.logger);\n        }\n    };\n\n    public readonly enqueueSummarize: ISummarizer[\"enqueueSummarize\"] = (...args) => {\n        if (this._disposed || this.runningSummarizer === undefined || this.runningSummarizer.disposed) {\n            throw new UsageError(\"Summarizer is not running or already disposed.\");\n        }\n        return this.runningSummarizer.enqueueSummarize(...args);\n    };\n\n    private async handleSummaryAcks() {\n        let refSequenceNumber = this.runtime.deltaManager.initialSequenceNumber;\n        let ack: IAckedSummary | undefined;\n        while (this.runningSummarizer) {\n            const summaryLogger = this.runningSummarizer.tryGetCorrelatedLogger(refSequenceNumber) ?? this.logger;\n            try {\n                // Initialize ack with undefined if exception happens inside of waitSummaryAck on second iteration,\n                // we record undefined, not previous handles.\n                ack = undefined;\n                ack = await this.summaryCollection.waitSummaryAck(refSequenceNumber);\n                refSequenceNumber = ack.summaryOp.referenceSequenceNumber;\n                const summaryOpHandle = ack.summaryOp.contents.handle;\n                const summaryAckHandle = ack.summaryAck.contents.handle;\n                // Make sure we block any summarizer from being executed/enqueued while\n                // executing the refreshLatestSummaryAck.\n                // https://dev.azure.com/fluidframework/internal/_workitems/edit/779\n                await this.runningSummarizer.lockedRefreshSummaryAckAction(async () =>\n                    this.internalsProvider.refreshLatestSummaryAck(\n                        summaryOpHandle,\n                        summaryAckHandle,\n                        refSequenceNumber,\n                        summaryLogger,\n                    ).catch(async (error) => {\n                        // If the error is 404, so maybe the fetched version no longer exists on server. We just\n                        // ignore this error in that case, as that means we will have another summaryAck for the\n                        // latest version with which we will refresh the state. However in case of single commit\n                        // summary, we might me missing a summary ack, so in that case we are still fine as the\n                        // code in `submitSummary` function in container runtime, will refresh the latest state\n                        // by calling `refreshLatestSummaryAckFromServer` and we will be fine.\n                        if (isFluidError(error)\n                            && error.errorType === DriverErrorType.fileNotFoundOrAccessDeniedError) {\n                            summaryLogger.sendTelemetryEvent({\n                                eventName: \"HandleSummaryAckErrorIgnored\",\n                                referenceSequenceNumber: refSequenceNumber,\n                                proposalHandle: summaryOpHandle,\n                                ackHandle: summaryAckHandle,\n                            }, error);\n                        } else {\n                            throw error;\n                        }\n                    }),\n                );\n            } catch (error) {\n                summaryLogger.sendErrorEvent({\n                    eventName: \"HandleSummaryAckError\",\n                    referenceSequenceNumber: refSequenceNumber,\n                    handle: ack?.summaryOp?.contents?.handle,\n                    ackHandle: ack?.summaryAck?.contents?.handle,\n                }, error);\n            }\n            refSequenceNumber++;\n        }\n    }\n}\n"]}

package/dist/summaryCollection.js

@@ -255,7 +255,7 @@ class SummaryCollection extends common_utils_1.TypedEventEmitter {
             // from. i.e. initialSequenceNumber > summarySequenceNumber.
             // We really don't care about it for now, since it is older than
             // the one we loaded from.
-            if (seq >= this.deltaManager.initialSequenceNumber) {
+            if (seq > this.deltaManager.initialSequenceNumber) {
                 // Potential causes for it to be later than our initialSequenceNumber
                 // are that the summaryOp was nacked then acked, double-acked, or
                 // the summarySequenceNumber is incorrect.

package/dist/summaryCollection.js.map

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

package/dist/summaryGenerator.js

@@ -253,7 +253,7 @@ class SummaryGenerator {
             case "generate": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration });
             case "upload": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration, handle: summaryData.handle, uploadDuration: summaryData.uploadDuration });
             case "submit": return Object.assign(Object.assign(Object.assign({}, initialProps), summaryData.summaryStats), { generateDuration: summaryData.generateDuration, handle: summaryData.handle, uploadDuration: summaryData.uploadDuration, clientSequenceNumber: summaryData.clientSequenceNumber, hasMissingOpData: this.heuristicData.hasMissingOpData, opsSizesSinceLastSummary: this.heuristicData.totalOpsSize, nonRuntimeOpsSinceLastSummary: this.heuristicData.numNonRuntimeOps });
-            default: (0, common_utils_1.assert)(true, "Unexpected summary stage");
+            default: (0, common_utils_1.assert)(true, 0x397 /* Unexpected summary stage */);
         }
         return initialProps;
     }