@fluidframework/container-runtime 0.59.4001 → 1.0.0

package/lib/pendingStateManager.js

@@ -5,8 +5,8 @@
 import { assert, Lazy } from "@fluidframework/common-utils";
 import { DataProcessingError } from "@fluidframework/container-utils";
 import { FlushMode } from "@fluidframework/runtime-definitions";
+import { wrapError } from "@fluidframework/telemetry-utils";
 import Deque from "double-ended-queue";
-import { ContainerMessageType, isRuntimeMessage } from "./containerRuntime";
 /**
  * PendingStateManager is responsible for maintaining the messages that have not been sent or have not yet been
  * acknowledged by the server. It also maintains the batch information for both automatically and manually flushed
@@ -17,49 +17,37 @@ import { ContainerMessageType, isRuntimeMessage } from "./containerRuntime";
  * It verifies that all the ops are acked, are received in the right order and batch information is correct.
  */
 export class PendingStateManager {
-    constructor(containerRuntime, applyStashedOp, initialFlushMode, initialLocalState) {
+    constructor(stateHandler, initialFlushMode, initialLocalState) {
         var _a;
-        this.containerRuntime = containerRuntime;
-        this.applyStashedOp = applyStashedOp;
+        this.stateHandler = stateHandler;
         this.pendingStates = new Deque();
-        this.previousClientIds = new Set();
-        this.firstStashedCSN = -1;
         this.disposeOnce = new Lazy(() => {
             this.initialStates.clear();
             this.pendingStates.clear();
         });
         // Maintains the count of messages that are currently unacked.
-        this.pendingMessagesCount = 0;
+        this._pendingMessagesCount = 0;
         // Indicates whether we are processing a batch.
         this.isProcessingBatch = false;
         this.dispose = () => this.disposeOnce.value;
         this.initialStates = new Deque((_a = initialLocalState === null || initialLocalState === void 0 ? void 0 : initialLocalState.pendingStates) !== null && _a !== void 0 ? _a : []);
-        if (initialLocalState) {
-            if (initialLocalState === null || initialLocalState === void 0 ? void 0 : initialLocalState.clientId) {
-                this.previousClientIds.add(initialLocalState.clientId);
-            }
-            // get stashed op count and client sequence number of first op
-            const messages = initialLocalState.pendingStates
-                .filter((state) => state.type === "message");
-            this.firstStashedCSN = messages[0].clientSequenceNumber;
-        }
         this.flushModeForNextMessage = initialFlushMode;
         this.onFlushModeUpdated(initialFlushMode);
     }
-    get connected() {
-        return this.containerRuntime.connected;
+    get pendingMessagesCount() {
+        return this._pendingMessagesCount;
     }
     /**
      * Called to check if there are any pending messages in the pending state queue.
      * @returns A boolean indicating whether there are messages or not.
      */
     hasPendingMessages() {
-        return this.pendingMessagesCount !== 0;
+        return this._pendingMessagesCount !== 0 || !this.initialStates.isEmpty();
     }
     getLocalState() {
+        assert(this.initialStates.isEmpty(), 0x2e9 /* "Must call getLocalState() after applying initial states" */);
         if (this.hasPendingMessages()) {
             return {
-                clientId: this.clientId,
                 pendingStates: this.pendingStates.toArray().map(
                 // delete localOpMetadata since it may not be serializable
                 // and will be regenerated by applyStashedOp()
@@ -87,7 +75,7 @@ export class PendingStateManager {
             opMetadata,
         };
         this.pendingStates.push(pendingMessage);
-        this.pendingMessagesCount++;
+        this._pendingMessagesCount++;
     }
     /**
      * Called when the FlushMode is updated. Adds the FlushMode to the pending state queue.
@@ -102,7 +90,7 @@ export class PendingStateManager {
     onFlush() {
         // If the FlushMode is Immediate, we don't need to track an explicit flush call because every message is
         // automatically flushed. So, flush is a no-op.
-        if (this.containerRuntime.flushMode === FlushMode.Immediate) {
+        if (this.stateHandler.flushMode() === FlushMode.Immediate) {
             return;
         }
         // If the previous state is not a message, flush is a no-op.
@@ -115,6 +103,7 @@ export class PendingStateManager {
     }
     /**
      * Applies stashed ops at their reference sequence number so they are ready to be ACKed or resubmitted
+     * @param seqNum - Sequence number at which to apply ops. Will apply all ops if seqNum is undefined.
      */
     async applyStashedOpsAt(seqNum) {
         // apply stashed ops at sequence number
@@ -122,14 +111,16 @@ export class PendingStateManager {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             const nextState = this.initialStates.peekFront();
             if (nextState.type === "message") {
-                if (nextState.referenceSequenceNumber > seqNum) {
-                    break; // nothing left to do at this sequence number
-                }
-                else if (nextState.referenceSequenceNumber > 0 && nextState.referenceSequenceNumber < seqNum) {
-                    throw new Error("loaded from snapshot too recent to apply stashed ops");
+                if (seqNum !== undefined) {
+                    if (nextState.referenceSequenceNumber > seqNum) {
+                        break; // nothing left to do at this sequence number
+                    }
+                    else if (nextState.referenceSequenceNumber < seqNum) {
+                        throw new Error("loaded from snapshot too recent to apply stashed ops");
+                    }
                 }
                 // applyStashedOp will cause the DDS to behave as if it has sent the op but not actually send it
-                const localOpMetadata = await this.applyStashedOp(nextState.messageType, nextState.content);
+                const localOpMetadata = await this.stateHandler.applyStashedOp(nextState.messageType, nextState.content);
                 nextState.localOpMetadata = localOpMetadata;
             }
             // then we push onto pendingStates which will cause PendingStateManager to resubmit when we connect
@@ -137,75 +128,6 @@ export class PendingStateManager {
             this.pendingStates.push(this.initialStates.shift());
         }
     }
-    /**
-     * Processes a local message once it's ack'd by the server to verify that there was no data corruption and that
-     * the batch information was preserved for batch messages. Also process remote messages that might have been
-     * sent from a previous container.
-     * @param message - The message that got ack'd and needs to be processed.
-     */
-    processMessage(message, local) {
-        // Do not process chunked ops until all pieces are available.
-        if (message.type === ContainerMessageType.ChunkedOp) {
-            return { localAck: false, localOpMetadata: undefined };
-        }
-        if (local) {
-            return { localAck: false, localOpMetadata: this.processPendingLocalMessage(message) };
-        }
-        else {
-            return this.processRemoteMessage(message);
-        }
-    }
-    /**
-     * Listens for ACKs of stashed ops
-     */
-    processRemoteMessage(message) {
-        var _a;
-        if (!isRuntimeMessage(message)) {
-            return { localAck: false, localOpMetadata: undefined };
-        }
-        // this message was a pending op that was actually sent successfully
-        const isOriginalClientId = message.clientId === Array.from(this.previousClientIds)[0] &&
-            message.clientSequenceNumber >= this.firstStashedCSN;
-        // this message is a pending or stashed op that was resubmitted
-        const isNewClientId = Array.from(this.previousClientIds).indexOf(message.clientId) > 0;
-        // if this is an ack for a stashed op, dequeue one message.
-        // we should have seen its ref seq num by now and the DDS should be ready for it to be ACKed
-        if (isOriginalClientId || isNewClientId) {
-            assert(this.clientId === undefined, 0x28b /* "multiple clients connected with stashed ops" */);
-            while (!this.pendingStates.isEmpty()) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                const nextState = this.pendingStates.shift();
-                // if it's not a message just drop it and keep looking
-                if (nextState.type === "message") {
-                    this.assertOpMatch(nextState, message, isOriginalClientId);
-                    return { localAck: true, localOpMetadata: nextState.localOpMetadata };
-                }
-            }
-        }
-        if (message.type === ContainerMessageType.Rejoin && this.previousClientIds.has((_a = message.contents) === null || _a === void 0 ? void 0 : _a.clientId)) {
-            this.previousClientIds.add(message.clientId);
-        }
-        return { localAck: false, localOpMetadata: undefined };
-    }
-    assertOpMatch(state, message, isOriginalClientId) {
-        assert(message.type === state.messageType, 0x28c /* "different message type" */);
-        assert(message.clientSequenceNumber === state.clientSequenceNumber || !isOriginalClientId, 0x28d /* "client sequence number doesn't match" */);
-        switch (message.type) {
-            case ContainerMessageType.Attach:
-                assert(message.contents.id === state.content.id, 0x28e /* "datastore ID doesn't match" */);
-                break;
-            case ContainerMessageType.FluidDataStoreOp:
-                assert(message.contents.address === state.content.address, 0x28f /* "address doesn't match" */);
-                break;
-            case ContainerMessageType.BlobAttach:
-                // todo: assert we have blob storage, assert blob IDs match, remove blob from blob storage since it made
-                // it through successfully
-                break;
-            case ContainerMessageType.Rejoin:
-            default:
-                throw new Error(`${message.type} not expected`);
-        }
-    }
     /**
      * Processes a local message once its ack'd by the server. It verifies that there was no data corruption and that
      * the batch information was preserved for batch messages.
@@ -223,10 +145,10 @@ export class PendingStateManager {
         if (pendingState.clientSequenceNumber !== message.clientSequenceNumber) {
             // Close the container because this could indicate data corruption.
             const error = DataProcessingError.create("pending local message clientSequenceNumber mismatch", "unexpectedAckReceived", message, { expectedClientSequenceNumber: pendingState.clientSequenceNumber });
-            this.containerRuntime.closeFn(error);
+            this.stateHandler.close(error);
             return;
         }
-        this.pendingMessagesCount--;
+        this._pendingMessagesCount--;
         // Post-processing part - If we are processing a batch then this could be the last message in the batch.
         this.maybeProcessBatchEnd(message);
         return pendingState.localOpMetadata;
@@ -319,6 +241,28 @@ export class PendingStateManager {
         this.pendingBatchBeginMessage = undefined;
         this.isProcessingBatch = false;
     }
+    /**
+     * Capture the pending state at this point
+     */
+    checkpoint() {
+        const checkpointHead = this.pendingStates.peekBack();
+        return {
+            rollback: () => {
+                try {
+                    while (this.pendingStates.peekBack() !== checkpointHead) {
+                        this.rollbackNextPendingState();
+                    }
+                }
+                catch (err) {
+                    const error = wrapError(err, (message) => {
+                        return DataProcessingError.create(`RollbackError: ${message}`, "checkpointRollback", undefined);
+                    });
+                    this.stateHandler.close(error);
+                    throw error;
+                }
+            },
+        };
+    }
     /**
      * Returns the next pending state from the pending state queue.
      */
@@ -327,27 +271,46 @@ export class PendingStateManager {
         assert(!!nextPendingState, 0x171 /* "No pending state found for the remote message" */);
         return nextPendingState;
     }
+    /**
+     * Undo the last pending state
+     */
+    rollbackNextPendingState() {
+        const pendingStatesCount = this.pendingStates.length;
+        if (pendingStatesCount === 0) {
+            return;
+        }
+        this._pendingMessagesCount--;
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const pendingState = this.pendingStates.pop();
+        switch (pendingState.type) {
+            case "message":
+                this.stateHandler.rollback(pendingState.messageType, pendingState.content, pendingState.localOpMetadata);
+                break;
+            default:
+                throw new Error(`Can't rollback state ${pendingState.type}`);
+        }
+    }
     /**
      * Called when the Container's connection state changes. If the Container gets connected, it replays all the pending
      * states in its queue. This includes setting the FlushMode and triggering resubmission of unacked ops.
      */
     replayPendingStates() {
-        assert(this.connected, 0x172 /* "The connection state is not consistent with the runtime" */);
+        assert(this.stateHandler.connected(), 0x172 /* "The connection state is not consistent with the runtime" */);
         // This assert suggests we are about to send same ops twice, which will result in data loss.
-        assert(this.clientId !== this.containerRuntime.clientId, 0x173 /* "replayPendingStates called twice for same clientId!" */);
-        this.clientId = this.containerRuntime.clientId;
+        assert(this.clientId !== this.stateHandler.clientId(), 0x173 /* "replayPendingStates called twice for same clientId!" */);
+        this.clientId = this.stateHandler.clientId();
         assert(this.initialStates.isEmpty(), 0x174 /* "initial states should be empty before replaying pending" */);
         let pendingStatesCount = this.pendingStates.length;
         if (pendingStatesCount === 0) {
             return;
         }
         // Reset the pending message count because all these messages will be removed from the queue.
-        this.pendingMessagesCount = 0;
+        this._pendingMessagesCount = 0;
         // Save the current FlushMode so that we can revert it back after replaying the states.
-        const savedFlushMode = this.containerRuntime.flushMode;
+        const savedFlushMode = this.stateHandler.flushMode();
         // Set the flush mode for the next message. This step is important because the flush mode may have been changed
         // after the next pending message was sent.
-        this.containerRuntime.setFlushMode(this.flushModeForNextMessage);
+        this.stateHandler.setFlushMode(this.flushModeForNextMessage);
         // Process exactly `pendingStatesCount` items in the queue as it represents the number of states that were
         // pending when we connected. This is important because the `reSubmitFn` might add more items in the queue
         // which must not be replayed.
@@ -356,13 +319,13 @@ export class PendingStateManager {
             const pendingState = this.pendingStates.shift();
             switch (pendingState.type) {
                 case "message":
-                    this.containerRuntime.reSubmitFn(pendingState.messageType, pendingState.content, pendingState.localOpMetadata, pendingState.opMetadata);
+                    this.stateHandler.reSubmit(pendingState.messageType, pendingState.content, pendingState.localOpMetadata, pendingState.opMetadata);
                     break;
                 case "flushMode":
-                    this.containerRuntime.setFlushMode(pendingState.flushMode);
+                    this.stateHandler.setFlushMode(pendingState.flushMode);
                     break;
                 case "flush":
-                    this.containerRuntime.flush();
+                    this.stateHandler.flush();
                     break;
                 default:
                     break;
@@ -370,7 +333,7 @@ export class PendingStateManager {
             pendingStatesCount--;
         }
         // Revert the FlushMode.
-        this.containerRuntime.setFlushMode(savedFlushMode);
+        this.stateHandler.setFlushMode(savedFlushMode);
     }
 }
 //# sourceMappingURL=pendingStateManager.js.map

package/lib/pendingStateManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"pendingStateManager.js","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAItE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,EAAoB,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA8C9F;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAmB;IAqD5B,YACqB,gBAAkC,EAClC,cAAmD,EACpE,gBAA2B,EAC3B,iBAAiD;;QAHhC,qBAAgB,GAAhB,gBAAgB,CAAkB;QAClC,mBAAc,GAAd,cAAc,CAAqC;QAtDvD,kBAAa,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE3C,sBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;QACtC,oBAAe,GAAW,CAAC,CAAC,CAAC;QAC7B,gBAAW,GAAG,IAAI,IAAI,CAAO,GAAG,EAAE;YAC/C,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,8DAA8D;QACtD,yBAAoB,GAAW,CAAC,CAAC;QAEzC,+CAA+C;QACvC,sBAAiB,GAAY,KAAK,CAAC;QA8D3B,YAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAjBnD,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,CAAgB,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,aAAa,mCAAI,EAAE,CAAC,CAAC;QAEtF,IAAI,iBAAiB,EAAE;YACnB,IAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,QAAQ,EAAE;gBAC7B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;aAC1D;YACD,8DAA8D;YAC9D,MAAM,QAAQ,GAAG,iBAAiB,CAAC,aAAa;iBAC3C,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAsB,CAAC;YACtE,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC;SAC3D;QAED,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;QAChD,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IA5CD,IAAY,SAAS;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACrB,OAAO,IAAI,CAAC,oBAAoB,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEM,aAAa;QAChB,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YAC3B,OAAO;gBACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,GAAG;gBAC3C,0DAA0D;gBAC1D,8CAA8C;gBAC9C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,iCAAM,KAAK,KAAE,eAAe,EAAE,SAAS,IAAG,CAAC,CAAC,KAAK,CAAC;aAC9F,CAAC;SACL;IACL,CAAC;IAwBD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;IAG5D;;;;;;;OAOG;IACI,eAAe,CAClB,IAA0B,EAC1B,oBAA4B,EAC5B,uBAA+B,EAC/B,OAAY,EACZ,eAAwB,EACxB,UAA+C;QAE/C,MAAM,cAAc,GAAoB;YACpC,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,IAAI;YACjB,oBAAoB;YACpB,uBAAuB;YACvB,OAAO;YACP,eAAe;YACf,UAAU;SACb,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAExC,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,SAAoB;QAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,OAAO;QACV,wGAAwG;QACxG,+CAA+C;QAC/C,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE;YACzD,OAAO;SACV;QAED,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;QACpD,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,IAAI,MAAK,SAAS,EAAE;YACnC,OAAO;SACV;QAED,qGAAqG;QACrG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,MAAc;QACzC,uCAAuC;QACvC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE;YAClC,oEAAoE;YACpE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAG,CAAC;YAClD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC9B,IAAI,SAAS,CAAC,uBAAuB,GAAG,MAAM,EAAE;oBAC5C,MAAM,CAAC,6CAA6C;iBACvD;qBAAM,IAAI,SAAS,CAAC,uBAAuB,GAAG,CAAC,IAAI,SAAS,CAAC,uBAAuB,GAAG,MAAM,EAAE;oBAC5F,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;iBAC3E;gBAED,gGAAgG;gBAChG,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC5F,SAAS,CAAC,eAAe,GAAG,eAAe,CAAC;aAC/C;YAED,mGAAmG;YACnG,oEAAoE;YACpE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC,CAAC;SACxD;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,OAAkC,EAAE,KAAc;QACpE,6DAA6D;QAC7D,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,SAAS,EAAE;YACjD,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;SAC1D;QAED,IAAI,KAAK,EAAE;YACP,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,CAAC;SACzF;aAAM;YACH,OAAO,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;SAC7C;IACL,CAAC;IAED;;OAEG;IACK,oBAAoB,CAAC,OAAkC;;QAC3D,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;YAC5B,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;SAC1D;QAED,oEAAoE;QACpE,MAAM,kBAAkB,GAAG,OAAO,CAAC,QAAQ,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACjF,OAAO,CAAC,oBAAoB,IAAI,IAAI,CAAC,eAAe,CAAC;QACzD,+DAA+D;QAC/D,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAEvF,2DAA2D;QAC3D,4FAA4F;QAC5F,IAAI,kBAAkB,IAAI,aAAa,EAAE;YACrC,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,KAAK,CAAC,mDAAmD,CAAC,CAAC;YAC/F,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE;gBAClC,oEAAoE;gBACpE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC;gBAC9C,sDAAsD;gBACtD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE;oBAC9B,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;oBAC3D,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,CAAC,eAAe,EAAE,CAAC;iBACzE;aACJ;SACJ;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC,MAAM,IAAI,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,QAAQ,0CAAE,QAAQ,CAAC,EAAE;YACxG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SAChD;QAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC;IAC3D,CAAC;IAEO,aAAa,CAAC,KAAsB,EAAE,OAAkC,EAAE,kBAA2B;QACzG,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACjF,MAAM,CAAC,OAAO,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB,IAAI,CAAC,kBAAkB,EACrF,KAAK,CAAC,4CAA4C,CAAC,CAAC;QACxD,QAAQ,OAAO,CAAC,IAAI,EAAE;YAClB,KAAK,oBAAoB,CAAC,MAAM;gBAC5B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;gBAC3F,MAAM;YACV,KAAK,oBAAoB,CAAC,gBAAgB;gBACtC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBAChG,MAAM;YACV,KAAK,oBAAoB,CAAC,UAAU;gBAChC,wGAAwG;gBACxG,0BAA0B;gBAC1B,MAAM;YACV,KAAK,oBAAoB,CAAC,MAAM,CAAC;YACjC;gBACI,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,eAAe,CAAC,CAAC;SACvD;IACL,CAAC;IAED;;;;OAIG;IACK,0BAA0B,CAAC,OAAkC;QACjE,0DAA0D;QAC1D,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAErC,qFAAqF;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACjD,MAAM,CAAC,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACxG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAE3B,mEAAmE;QACnE,2FAA2F;QAC3F,IAAI,YAAY,CAAC,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,EAAE;YACpE,mEAAmE;YACnE,MAAM,KAAK,GAAG,mBAAmB,CAAC,MAAM,CACpC,qDAAqD,EACrD,uBAAuB,EACvB,OAAO,EACP,EAAE,4BAA4B,EAAE,YAAY,CAAC,oBAAoB,EAAE,CACtE,CAAC;YAEF,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACrC,OAAO;SACV;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,wGAAwG;QACxG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,YAAY,CAAC,eAAe,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,OAAkC;QAC7D,uEAAuE;QACvE,IAAI,gBAAuC,CAAC;QAC5C,kEAAkE;QAClE,IAAI,YAAY,GAAY,KAAK,CAAC;QAElC;;;;;;;;WAQG;QACH,IAAI,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,gBAAgB,CAAC,IAAI,KAAK,SAAS,EAAE;YACxC,IAAI,gBAAgB,CAAC,IAAI,KAAK,WAAW,EAAE;gBACvC,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,CAAC;aACjD;YACD,IAAI,gBAAgB,CAAC,IAAI,KAAK,OAAO,EAAE;gBACnC,YAAY,GAAG,IAAI,CAAC;aACvB;YACD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAClD;QAED,IAAI,gBAAgB,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;SACnD;QAED,4GAA4G;QAC5G,oEAAoE;QACpE,IAAI,gBAAgB,KAAK,SAAS,CAAC,SAAS,EAAE;YAC1C,OAAO;SACV;QAED;;;;WAIG;QACH,IAAI,gBAAgB,KAAK,SAAS,CAAC,SAAS,IAAI,YAAY,EAAE;YAC1D,kGAAkG;YAClG,MAAM,CAAC,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,wBAAwB,KAAK,SAAS,EACzE,KAAK,CAAC,2EAA2E,CAAC,CAAC;YAEvF,6EAA6E;YAC7E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC;YACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;SACjC;IACL,CAAC;IAED;;;OAGG;IACK,oBAAoB,CAAC,OAAkC;;QAC3D,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,OAAO;SACV;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACrD,IAAI,gBAAgB,CAAC,IAAI,KAAK,SAAS,EAAE;YACrC,OAAO;SACV;QAED;;;;WAIG;QACH,MAAM,CACF,gBAAgB,CAAC,IAAI,KAAK,WAAW,EACrC,KAAK,CAAC,0FAA0F,CACnG,CAAC;QAEF,iDAAiD;QACjD,MAAM,CAAC,IAAI,CAAC,wBAAwB,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAE3G,oEAAoE;QACpE,MAAM,kBAAkB,GAAG,MAAA,IAAI,CAAC,wBAAwB,CAAC,QAAQ,0CAAE,KAAK,CAAC;QAEzE,4GAA4G;QAC5G,mGAAmG;QACnG,IAAI,IAAI,CAAC,wBAAwB,KAAK,OAAO,EAAE;YAC3C,MAAM,CAAC,kBAAkB,KAAK,SAAS,EACnC,KAAK,CAAC,gEAAgE,CAAC,CAAC;SAC/E;aAAM;YACH,6DAA6D;YAC7D,MAAM,gBAAgB,GAAG,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,CAAC;YACjD,MAAM,CAAC,kBAAkB,KAAK,IAAI,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;YACxF,MAAM,CAAC,gBAAgB,KAAK,KAAK,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;SACxF;QAED,6EAA6E;QAC7E,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACnC,CAAC;IAED;;OAEG;IACK,oBAAoB;QACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;QACxD,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACxF,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACtB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAE9F,4FAA4F;QAC5F,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EACnD,KAAK,CAAC,2DAA2D,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;QAE/C,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAE5G,IAAI,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QACnD,IAAI,kBAAkB,KAAK,CAAC,EAAE;YAC1B,OAAO;SACV;QAED,6FAA6F;QAC7F,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC;QAE9B,uFAAuF;QACvF,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;QAEvD,+GAA+G;QAC/G,2CAA2C;QAC3C,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAEjE,0GAA0G;QAC1G,0GAA0G;QAC1G,8BAA8B;QAC9B,OAAO,kBAAkB,GAAG,CAAC,EAAE;YAC3B,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC;YACjD,QAAQ,YAAY,CAAC,IAAI,EAAE;gBACvB,KAAK,SAAS;oBACV,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAC5B,YAAY,CAAC,WAAW,EACxB,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC7B,MAAM;gBACV,KAAK,WAAW;oBACZ,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;oBAC3D,MAAM;gBACV,KAAK,OAAO;oBACR,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;oBAC9B,MAAM;gBACV;oBACI,MAAM;aACb;YACD,kBAAkB,EAAE,CAAC;SACxB;QAED,wBAAwB;QACxB,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable } from \"@fluidframework/common-definitions\";\nimport { assert, Lazy } from \"@fluidframework/common-utils\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport {\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { FlushMode } from \"@fluidframework/runtime-definitions\";\nimport Deque from \"double-ended-queue\";\nimport { ContainerRuntime, ContainerMessageType, isRuntimeMessage } from \"./containerRuntime\";\n\n/**\n * This represents a message that has been submitted and is added to the pending queue when `submit` is called on the\n * ContainerRuntime. This message has either not been ack'd by the server or has not been submitted to the server yet.\n */\nexport interface IPendingMessage {\n    type: \"message\";\n    messageType: ContainerMessageType;\n    clientSequenceNumber: number;\n    referenceSequenceNumber: number;\n    content: any;\n    localOpMetadata: unknown;\n    opMetadata: Record<string, unknown> | undefined;\n}\n\n/**\n * This represents a FlushMode update and is added to the pending queue when `setFlushMode` is called on the\n * ContainerRuntime and the FlushMode changes.\n */\nexport interface IPendingFlushMode {\n    type: \"flushMode\";\n    flushMode: FlushMode;\n}\n\n/**\n * This represents an explicit flush call and is added to the pending queue when flush is called on the ContainerRuntime\n * to flush pending messages.\n */\nexport interface IPendingFlush {\n    type: \"flush\";\n}\n\nexport type IPendingState = IPendingMessage | IPendingFlushMode | IPendingFlush;\n\nexport interface IPendingLocalState {\n    /**\n     * client ID we most recently connected with, or undefined if we never connected\n     */\n    clientId?: string;\n    /**\n     * list of pending states, including ops and batch information\n     */\n    pendingStates: IPendingState[];\n}\n\n/**\n * PendingStateManager is responsible for maintaining the messages that have not been sent or have not yet been\n * acknowledged by the server. It also maintains the batch information for both automatically and manually flushed\n * batches along with the messages.\n * When the Container reconnects, it replays the pending states, which includes setting the FlushMode, manual flushing\n * of messages and triggering resubmission of unacked ops.\n *\n * It verifies that all the ops are acked, are received in the right order and batch information is correct.\n */\nexport class PendingStateManager implements IDisposable {\n    private readonly pendingStates = new Deque<IPendingState>();\n    private readonly initialStates: Deque<IPendingState>;\n    private readonly previousClientIds = new Set<string>();\n    private readonly firstStashedCSN: number = -1;\n    private readonly disposeOnce = new Lazy<void>(() => {\n        this.initialStates.clear();\n        this.pendingStates.clear();\n    });\n\n    // Maintains the count of messages that are currently unacked.\n    private pendingMessagesCount: number = 0;\n\n    // Indicates whether we are processing a batch.\n    private isProcessingBatch: boolean = false;\n\n    // This stores the first message in the batch that we are processing. This is used to verify that we get\n    // the correct batch metadata.\n    private pendingBatchBeginMessage: ISequencedDocumentMessage | undefined;\n\n    /**\n     * This tracks the flush mode for the next message in the pending state queue. When replaying messages, we need to\n     * first set the flush mode to this value and then send ops. It is important to do this info because the flush\n     * mode could have been updated.\n     */\n    private flushModeForNextMessage: FlushMode;\n\n    private clientId: string | undefined;\n\n    private get connected(): boolean {\n        return this.containerRuntime.connected;\n    }\n\n    /**\n     * Called to check if there are any pending messages in the pending state queue.\n     * @returns A boolean indicating whether there are messages or not.\n     */\n    public hasPendingMessages(): boolean {\n        return this.pendingMessagesCount !== 0;\n    }\n\n    public getLocalState(): IPendingLocalState | undefined {\n        if (this.hasPendingMessages()) {\n            return {\n                clientId: this.clientId,\n                pendingStates: this.pendingStates.toArray().map(\n                    // delete localOpMetadata since it may not be serializable\n                    // and will be regenerated by applyStashedOp()\n                    (state) => state.type === \"message\" ? { ...state, localOpMetadata: undefined } : state),\n            };\n        }\n    }\n\n    constructor(\n        private readonly containerRuntime: ContainerRuntime,\n        private readonly applyStashedOp: (type, content) => Promise<unknown>,\n        initialFlushMode: FlushMode,\n        initialLocalState: IPendingLocalState | undefined,\n    ) {\n        this.initialStates = new Deque<IPendingState>(initialLocalState?.pendingStates ?? []);\n\n        if (initialLocalState) {\n            if (initialLocalState?.clientId) {\n                this.previousClientIds.add(initialLocalState.clientId);\n            }\n            // get stashed op count and client sequence number of first op\n            const messages = initialLocalState.pendingStates\n                .filter((state) => state.type === \"message\") as IPendingMessage[];\n            this.firstStashedCSN = messages[0].clientSequenceNumber;\n        }\n\n        this.flushModeForNextMessage = initialFlushMode;\n        this.onFlushModeUpdated(initialFlushMode);\n    }\n\n    public get disposed() { return this.disposeOnce.evaluated; }\n    public readonly dispose = () => this.disposeOnce.value;\n\n    /**\n     * Called when a message is submitted locally. Adds the message and the associated details to the pending state\n     * queue.\n     * @param type - The container message type.\n     * @param clientSequenceNumber - The clientSequenceNumber associated with the message.\n     * @param content - The message content.\n     * @param localOpMetadata - The local metadata associated with the message.\n     */\n    public onSubmitMessage(\n        type: ContainerMessageType,\n        clientSequenceNumber: number,\n        referenceSequenceNumber: number,\n        content: any,\n        localOpMetadata: unknown,\n        opMetadata: Record<string, unknown> | undefined,\n    ) {\n        const pendingMessage: IPendingMessage = {\n            type: \"message\",\n            messageType: type,\n            clientSequenceNumber,\n            referenceSequenceNumber,\n            content,\n            localOpMetadata,\n            opMetadata,\n        };\n\n        this.pendingStates.push(pendingMessage);\n\n        this.pendingMessagesCount++;\n    }\n\n    /**\n     * Called when the FlushMode is updated. Adds the FlushMode to the pending state queue.\n     * @param flushMode - The flushMode that was updated.\n     */\n    public onFlushModeUpdated(flushMode: FlushMode) {\n        this.pendingStates.push({ type: \"flushMode\", flushMode });\n    }\n\n    /**\n     * Called when flush() is called on the ContainerRuntime to manually flush messages.\n     */\n    public onFlush() {\n        // If the FlushMode is Immediate, we don't need to track an explicit flush call because every message is\n        // automatically flushed. So, flush is a no-op.\n        if (this.containerRuntime.flushMode === FlushMode.Immediate) {\n            return;\n        }\n\n        // If the previous state is not a message, flush is a no-op.\n        const previousState = this.pendingStates.peekBack();\n        if (previousState?.type !== \"message\") {\n            return;\n        }\n\n        // An explicit flush is interesting and is tracked only if there are messages sent in TurnBased mode.\n        this.pendingStates.push({ type: \"flush\" });\n    }\n\n    /**\n     * Applies stashed ops at their reference sequence number so they are ready to be ACKed or resubmitted\n     */\n    public async applyStashedOpsAt(seqNum: number) {\n        // apply stashed ops at sequence number\n        while (!this.initialStates.isEmpty()) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const nextState = this.initialStates.peekFront()!;\n            if (nextState.type === \"message\") {\n                if (nextState.referenceSequenceNumber > seqNum) {\n                    break; // nothing left to do at this sequence number\n                } else if (nextState.referenceSequenceNumber > 0 && nextState.referenceSequenceNumber < seqNum) {\n                    throw new Error(\"loaded from snapshot too recent to apply stashed ops\");\n                }\n\n                // applyStashedOp will cause the DDS to behave as if it has sent the op but not actually send it\n                const localOpMetadata = await this.applyStashedOp(nextState.messageType, nextState.content);\n                nextState.localOpMetadata = localOpMetadata;\n            }\n\n            // then we push onto pendingStates which will cause PendingStateManager to resubmit when we connect\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            this.pendingStates.push(this.initialStates.shift()!);\n        }\n    }\n\n    /**\n     * Processes a local message once it's ack'd by the server to verify that there was no data corruption and that\n     * the batch information was preserved for batch messages. Also process remote messages that might have been\n     * sent from a previous container.\n     * @param message - The message that got ack'd and needs to be processed.\n     */\n    public processMessage(message: ISequencedDocumentMessage, local: boolean) {\n        // Do not process chunked ops until all pieces are available.\n        if (message.type === ContainerMessageType.ChunkedOp) {\n            return { localAck: false, localOpMetadata: undefined };\n        }\n\n        if (local) {\n            return { localAck: false, localOpMetadata: this.processPendingLocalMessage(message) };\n        } else {\n            return this.processRemoteMessage(message);\n        }\n    }\n\n    /**\n     * Listens for ACKs of stashed ops\n     */\n    private processRemoteMessage(message: ISequencedDocumentMessage) {\n        if (!isRuntimeMessage(message)) {\n            return { localAck: false, localOpMetadata: undefined };\n        }\n\n        // this message was a pending op that was actually sent successfully\n        const isOriginalClientId = message.clientId === Array.from(this.previousClientIds)[0] &&\n            message.clientSequenceNumber >= this.firstStashedCSN;\n        // this message is a pending or stashed op that was resubmitted\n        const isNewClientId = Array.from(this.previousClientIds).indexOf(message.clientId) > 0;\n\n        // if this is an ack for a stashed op, dequeue one message.\n        // we should have seen its ref seq num by now and the DDS should be ready for it to be ACKed\n        if (isOriginalClientId || isNewClientId) {\n            assert(this.clientId === undefined, 0x28b /* \"multiple clients connected with stashed ops\" */);\n            while (!this.pendingStates.isEmpty()) {\n                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                const nextState = this.pendingStates.shift()!;\n                // if it's not a message just drop it and keep looking\n                if (nextState.type === \"message\") {\n                    this.assertOpMatch(nextState, message, isOriginalClientId);\n                    return { localAck: true, localOpMetadata: nextState.localOpMetadata };\n                }\n            }\n        }\n\n        if (message.type === ContainerMessageType.Rejoin && this.previousClientIds.has(message.contents?.clientId)) {\n            this.previousClientIds.add(message.clientId);\n        }\n\n        return { localAck: false, localOpMetadata: undefined };\n    }\n\n    private assertOpMatch(state: IPendingMessage, message: ISequencedDocumentMessage, isOriginalClientId: boolean) {\n        assert(message.type === state.messageType, 0x28c /* \"different message type\" */);\n        assert(message.clientSequenceNumber === state.clientSequenceNumber || !isOriginalClientId,\n            0x28d /* \"client sequence number doesn't match\" */);\n        switch (message.type) {\n            case ContainerMessageType.Attach:\n                assert(message.contents.id === state.content.id, 0x28e /* \"datastore ID doesn't match\" */);\n                break;\n            case ContainerMessageType.FluidDataStoreOp:\n                assert(message.contents.address === state.content.address, 0x28f /* \"address doesn't match\" */);\n                break;\n            case ContainerMessageType.BlobAttach:\n                // todo: assert we have blob storage, assert blob IDs match, remove blob from blob storage since it made\n                // it through successfully\n                break;\n            case ContainerMessageType.Rejoin:\n            default:\n                throw new Error(`${message.type} not expected`);\n        }\n    }\n\n    /**\n     * Processes a local message once its ack'd by the server. It verifies that there was no data corruption and that\n     * the batch information was preserved for batch messages.\n     * @param message - The message that got ack'd and needs to be processed.\n     */\n    private processPendingLocalMessage(message: ISequencedDocumentMessage): unknown {\n        // Pre-processing part - This may be the start of a batch.\n        this.maybeProcessBatchBegin(message);\n\n        // Get the next state from the pending queue and verify that it is of type \"message\".\n        const pendingState = this.peekNextPendingState();\n        assert(pendingState.type === \"message\", 0x169 /* \"No pending message found for this remote message\" */);\n        this.pendingStates.shift();\n\n        // Processing part - Verify that there has been no data corruption.\n        // The clientSequenceNumber of the incoming message must match that of the pending message.\n        if (pendingState.clientSequenceNumber !== message.clientSequenceNumber) {\n            // Close the container because this could indicate data corruption.\n            const error = DataProcessingError.create(\n                \"pending local message clientSequenceNumber mismatch\",\n                \"unexpectedAckReceived\",\n                message,\n                { expectedClientSequenceNumber: pendingState.clientSequenceNumber },\n            );\n\n            this.containerRuntime.closeFn(error);\n            return;\n        }\n\n        this.pendingMessagesCount--;\n\n        // Post-processing part - If we are processing a batch then this could be the last message in the batch.\n        this.maybeProcessBatchEnd(message);\n\n        return pendingState.localOpMetadata;\n    }\n\n    /**\n     * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.\n     * @param message - The message that is being processed.\n     */\n    private maybeProcessBatchBegin(message: ISequencedDocumentMessage) {\n        // Tracks the last FlushMode that was set before this message was sent.\n        let pendingFlushMode: FlushMode | undefined;\n        // Tracks whether a flush was called before this message was sent.\n        let pendingFlush: boolean = false;\n\n        /**\n         * We are checking if the next message is the start of a batch. It can happen in the following scenarios:\n         * 1. The FlushMode was set to TurnBased before this message was sent.\n         * 2. The FlushMode was already TurnBased and a flush was called before this message was sent. This essentially\n         *    means that the flush marked the end of a previous batch and beginning of a new batch.\n         *\n         * Keep reading pending states from the queue until we encounter a message. It's possible that the FlushMode was\n         * updated a bunch of times without sending any messages.\n         */\n        let nextPendingState = this.peekNextPendingState();\n        while (nextPendingState.type !== \"message\") {\n            if (nextPendingState.type === \"flushMode\") {\n                pendingFlushMode = nextPendingState.flushMode;\n            }\n            if (nextPendingState.type === \"flush\") {\n                pendingFlush = true;\n            }\n            this.pendingStates.shift();\n            nextPendingState = this.peekNextPendingState();\n        }\n\n        if (pendingFlushMode !== undefined) {\n            this.flushModeForNextMessage = pendingFlushMode;\n        }\n\n        // If the FlushMode was set to Immediate before this message was sent, this message won't be a batch message\n        // because in Immediate mode, every message is flushed individually.\n        if (pendingFlushMode === FlushMode.Immediate) {\n            return;\n        }\n\n        /**\n         * This message is the first in a batch if before it was sent either the FlushMode was set to TurnBased or there\n         * was an explicit flush call. Note that a flush call is tracked only in TurnBased mode and it indicates the end\n         * of one batch and beginning of another.\n         */\n        if (pendingFlushMode === FlushMode.TurnBased || pendingFlush) {\n            // We should not already be processing a batch and there should be no pending batch begin message.\n            assert(!this.isProcessingBatch && this.pendingBatchBeginMessage === undefined,\n                0x16b /* \"The pending batch state indicates we are already processing a batch\" */);\n\n            // Set the pending batch state indicating we have started processing a batch.\n            this.pendingBatchBeginMessage = message;\n            this.isProcessingBatch = true;\n        }\n    }\n\n    /**\n     * This message could be the last message in batch. If so, clear batch state since the batch is complete.\n     * @param message - The message that is being processed.\n     */\n    private maybeProcessBatchEnd(message: ISequencedDocumentMessage) {\n        if (!this.isProcessingBatch) {\n            return;\n        }\n\n        const nextPendingState = this.peekNextPendingState();\n        if (nextPendingState.type === \"message\") {\n            return;\n        }\n\n        /**\n         * We are in the middle of processing a batch. The batch ends when we see an explicit flush. We should never see\n         * a FlushMode before flush. This is true because we track batches only when FlushMode is TurnBased and in this\n         * mode, a batch ends either by calling flush or by changing the mode to Immediate which also triggers a flush.\n         */\n        assert(\n            nextPendingState.type !== \"flushMode\",\n            0x2bd /* \"We should not see a pending FlushMode until we see a flush when processing a batch\" */,\n        );\n\n        // There should be a pending batch begin message.\n        assert(this.pendingBatchBeginMessage !== undefined, 0x16d /* \"There is no pending batch begin message\" */);\n\n        // Get the batch begin metadata from the first message in the batch.\n        const batchBeginMetadata = this.pendingBatchBeginMessage.metadata?.batch;\n\n        // There could be just a single message in the batch. If so, it should not have any batch metadata. If there\n        // are multiple messages in the batch, verify that we got the correct batch begin and end metadata.\n        if (this.pendingBatchBeginMessage === message) {\n            assert(batchBeginMetadata === undefined,\n                0x16e /* \"Batch with single message should not have batch metadata\" */);\n        } else {\n            // Get the batch metadata from the last message in the batch.\n            const batchEndMetadata = message.metadata?.batch;\n            assert(batchBeginMetadata === true, 0x16f /* \"Did not receive batch begin metadata\" */);\n            assert(batchEndMetadata === false, 0x170 /* \"Did not receive batch end metadata\" */);\n        }\n\n        // Clear the pending batch state now that we have processed the entire batch.\n        this.pendingBatchBeginMessage = undefined;\n        this.isProcessingBatch = false;\n    }\n\n    /**\n     * Returns the next pending state from the pending state queue.\n     */\n    private peekNextPendingState(): IPendingState {\n        const nextPendingState = this.pendingStates.peekFront();\n        assert(!!nextPendingState, 0x171 /* \"No pending state found for the remote message\" */);\n        return nextPendingState;\n    }\n\n    /**\n     * Called when the Container's connection state changes. If the Container gets connected, it replays all the pending\n     * states in its queue. This includes setting the FlushMode and triggering resubmission of unacked ops.\n     */\n    public replayPendingStates() {\n        assert(this.connected, 0x172 /* \"The connection state is not consistent with the runtime\" */);\n\n        // This assert suggests we are about to send same ops twice, which will result in data loss.\n        assert(this.clientId !== this.containerRuntime.clientId,\n            0x173 /* \"replayPendingStates called twice for same clientId!\" */);\n        this.clientId = this.containerRuntime.clientId;\n\n        assert(this.initialStates.isEmpty(), 0x174 /* \"initial states should be empty before replaying pending\" */);\n\n        let pendingStatesCount = this.pendingStates.length;\n        if (pendingStatesCount === 0) {\n            return;\n        }\n\n        // Reset the pending message count because all these messages will be removed from the queue.\n        this.pendingMessagesCount = 0;\n\n        // Save the current FlushMode so that we can revert it back after replaying the states.\n        const savedFlushMode = this.containerRuntime.flushMode;\n\n        // Set the flush mode for the next message. This step is important because the flush mode may have been changed\n        // after the next pending message was sent.\n        this.containerRuntime.setFlushMode(this.flushModeForNextMessage);\n\n        // Process exactly `pendingStatesCount` items in the queue as it represents the number of states that were\n        // pending when we connected. This is important because the `reSubmitFn` might add more items in the queue\n        // which must not be replayed.\n        while (pendingStatesCount > 0) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const pendingState = this.pendingStates.shift()!;\n            switch (pendingState.type) {\n                case \"message\":\n                    this.containerRuntime.reSubmitFn(\n                        pendingState.messageType,\n                        pendingState.content,\n                        pendingState.localOpMetadata,\n                        pendingState.opMetadata);\n                    break;\n                case \"flushMode\":\n                    this.containerRuntime.setFlushMode(pendingState.flushMode);\n                    break;\n                case \"flush\":\n                    this.containerRuntime.flush();\n                    break;\n                default:\n                    break;\n            }\n            pendingStatesCount--;\n        }\n\n        // Revert the FlushMode.\n        this.containerRuntime.setFlushMode(savedFlushMode);\n    }\n}\n"]}
+{"version":3,"file":"pendingStateManager.js","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAItE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAC5D,OAAO,KAAK,MAAM,oBAAoB,CAAC;AA8DvC;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAmB;IAkD5B,YACqB,YAAkC,EACnD,gBAA2B,EAC3B,iBAAiD;;QAFhC,iBAAY,GAAZ,YAAY,CAAsB;QAlDtC,kBAAa,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE3C,gBAAW,GAAG,IAAI,IAAI,CAAO,GAAG,EAAE;YAC/C,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,8DAA8D;QACtD,0BAAqB,GAAW,CAAC,CAAC;QAK1C,+CAA+C;QACvC,sBAAiB,GAAY,KAAK,CAAC;QA+C3B,YAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAPnD,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,CAAgB,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,aAAa,mCAAI,EAAE,CAAC,CAAC;QAEtF,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;QAChD,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAC9C,CAAC;IAjDD,IAAW,oBAAoB;QAC3B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAkBD;;;OAGG;IACI,kBAAkB;QACrB,OAAO,IAAI,CAAC,qBAAqB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;IAC7E,CAAC;IAEM,aAAa;QAChB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAC5G,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE;YAC3B,OAAO;gBACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,GAAG;gBAC3C,0DAA0D;gBAC1D,8CAA8C;gBAC9C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,iCAAM,KAAK,KAAE,eAAe,EAAE,SAAS,IAAG,CAAC,CAAC,KAAK,CAAC;aAC9F,CAAC;SACL;IACL,CAAC;IAaD,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;IAG5D;;;;;;;OAOG;IACI,eAAe,CAClB,IAA0B,EAC1B,oBAA4B,EAC5B,uBAA+B,EAC/B,OAAY,EACZ,eAAwB,EACxB,UAA+C;QAE/C,MAAM,cAAc,GAAoB;YACpC,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,IAAI;YACjB,oBAAoB;YACpB,uBAAuB;YACvB,OAAO;YACP,eAAe;YACf,UAAU;SACb,CAAC;QAEF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAExC,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,SAAoB;QAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,OAAO;QACV,wGAAwG;QACxG,+CAA+C;QAC/C,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,SAAS,CAAC,SAAS,EAAE;YACvD,OAAO;SACV;QAED,4DAA4D;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;QACpD,IAAI,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,IAAI,MAAK,SAAS,EAAE;YACnC,OAAO;SACV;QAED,qGAAqG;QACrG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,MAAe;QAC1C,uCAAuC;QACvC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE;YAClC,oEAAoE;YACpE,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAG,CAAC;YAClD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC9B,IAAI,MAAM,KAAK,SAAS,EAAE;oBACtB,IAAI,SAAS,CAAC,uBAAuB,GAAG,MAAM,EAAE;wBAC5C,MAAM,CAAC,6CAA6C;qBACvD;yBAAM,IAAI,SAAS,CAAC,uBAAuB,GAAG,MAAM,EAAE;wBACnD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;qBAC3E;iBACJ;gBAED,gGAAgG;gBAChG,MAAM,eAAe,GACjB,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;gBACrF,SAAS,CAAC,eAAe,GAAG,eAAe,CAAC;aAC/C;YAED,mGAAmG;YACnG,oEAAoE;YACpE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC,CAAC;SACxD;IACL,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,OAAkC;QAChE,0DAA0D;QAC1D,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAErC,qFAAqF;QACrF,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACjD,MAAM,CAAC,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;QACxG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAE3B,mEAAmE;QACnE,2FAA2F;QAC3F,IAAI,YAAY,CAAC,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,EAAE;YACpE,mEAAmE;YACnE,MAAM,KAAK,GAAG,mBAAmB,CAAC,MAAM,CACpC,qDAAqD,EACrD,uBAAuB,EACvB,OAAO,EACP,EAAE,4BAA4B,EAAE,YAAY,CAAC,oBAAoB,EAAE,CACtE,CAAC;YAEF,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC/B,OAAO;SACV;QAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE7B,wGAAwG;QACxG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,YAAY,CAAC,eAAe,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,OAAkC;QAC7D,uEAAuE;QACvE,IAAI,gBAAuC,CAAC;QAC5C,kEAAkE;QAClE,IAAI,YAAY,GAAY,KAAK,CAAC;QAElC;;;;;;;;WAQG;QACH,IAAI,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,gBAAgB,CAAC,IAAI,KAAK,SAAS,EAAE;YACxC,IAAI,gBAAgB,CAAC,IAAI,KAAK,WAAW,EAAE;gBACvC,gBAAgB,GAAG,gBAAgB,CAAC,SAAS,CAAC;aACjD;YACD,IAAI,gBAAgB,CAAC,IAAI,KAAK,OAAO,EAAE;gBACnC,YAAY,GAAG,IAAI,CAAC;aACvB;YACD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;YAC3B,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAClD;QAED,IAAI,gBAAgB,KAAK,SAAS,EAAE;YAChC,IAAI,CAAC,uBAAuB,GAAG,gBAAgB,CAAC;SACnD;QAED,4GAA4G;QAC5G,oEAAoE;QACpE,IAAI,gBAAgB,KAAK,SAAS,CAAC,SAAS,EAAE;YAC1C,OAAO;SACV;QAED;;;;WAIG;QACH,IAAI,gBAAgB,KAAK,SAAS,CAAC,SAAS,IAAI,YAAY,EAAE;YAC1D,kGAAkG;YAClG,MAAM,CAAC,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,wBAAwB,KAAK,SAAS,EACzE,KAAK,CAAC,2EAA2E,CAAC,CAAC;YAEvF,6EAA6E;YAC7E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC;YACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;SACjC;IACL,CAAC;IAED;;;OAGG;IACK,oBAAoB,CAAC,OAAkC;;QAC3D,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,OAAO;SACV;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACrD,IAAI,gBAAgB,CAAC,IAAI,KAAK,SAAS,EAAE;YACrC,OAAO;SACV;QAED;;;;WAIG;QACH,MAAM,CACF,gBAAgB,CAAC,IAAI,KAAK,WAAW,EACrC,KAAK,CAAC,0FAA0F,CACnG,CAAC;QAEF,iDAAiD;QACjD,MAAM,CAAC,IAAI,CAAC,wBAAwB,KAAK,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAE3G,oEAAoE;QACpE,MAAM,kBAAkB,GAAG,MAAA,IAAI,CAAC,wBAAwB,CAAC,QAAQ,0CAAE,KAAK,CAAC;QAEzE,4GAA4G;QAC5G,mGAAmG;QACnG,IAAI,IAAI,CAAC,wBAAwB,KAAK,OAAO,EAAE;YAC3C,MAAM,CAAC,kBAAkB,KAAK,SAAS,EACnC,KAAK,CAAC,gEAAgE,CAAC,CAAC;SAC/E;aAAM;YACH,6DAA6D;YAC7D,MAAM,gBAAgB,GAAG,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,CAAC;YACjD,MAAM,CAAC,kBAAkB,KAAK,IAAI,EAAE,KAAK,CAAC,4CAA4C,CAAC,CAAC;YACxF,MAAM,CAAC,gBAAgB,KAAK,KAAK,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;SACxF;QAED,6EAA6E;QAC7E,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACb,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;QACrD,OAAO;YACH,QAAQ,EAAE,GAAG,EAAE;gBACX,IAAI;oBACA,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,cAAc,EAAE;wBACrD,IAAI,CAAC,wBAAwB,EAAE,CAAC;qBACnC;iBACJ;gBAAC,OAAO,GAAG,EAAE;oBACV,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE;wBACrC,OAAO,mBAAmB,CAAC,MAAM,CAC7B,kBAAkB,OAAO,EAAE,EAC3B,oBAAoB,EACpB,SAAS,CAAwB,CAAC;oBAC1C,CAAC,CAAC,CAAC;oBACH,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;oBAC/B,MAAM,KAAK,CAAC;iBACf;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IAED;;OAEG;IACK,oBAAoB;QACxB,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC;QACxD,MAAM,CAAC,CAAC,CAAC,gBAAgB,EAAE,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACxF,OAAO,gBAAgB,CAAC;IAC5B,CAAC;IAED;;OAEG;IACK,wBAAwB;QAC5B,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QACrD,IAAI,kBAAkB,KAAK,CAAC,EAAE;YAC1B,OAAO;SACV;QAED,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAE7B,oEAAoE;QACpE,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,EAAG,CAAC;QAC/C,QAAQ,YAAY,CAAC,IAAI,EAAE;YACvB,KAAK,SAAS;gBACV,IAAI,CAAC,YAAY,CAAC,QAAQ,CACtB,YAAY,CAAC,WAAW,EACxB,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,eAAe,CAAC,CAAC;gBAClC,MAAM;YACV;gBACI,MAAM,IAAI,KAAK,CAAC,wBAAwB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;SACpE;IACL,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACtB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAE7G,4FAA4F;QAC5F,MAAM,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EACjD,KAAK,CAAC,2DAA2D,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAE7C,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAE5G,IAAI,kBAAkB,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;QACnD,IAAI,kBAAkB,KAAK,CAAC,EAAE;YAC1B,OAAO;SACV;QAED,6FAA6F;QAC7F,IAAI,CAAC,qBAAqB,GAAG,CAAC,CAAC;QAE/B,uFAAuF;QACvF,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QAErD,+GAA+G;QAC/G,2CAA2C;QAC3C,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAE7D,0GAA0G;QAC1G,0GAA0G;QAC1G,8BAA8B;QAC9B,OAAO,kBAAkB,GAAG,CAAC,EAAE;YAC3B,oEAAoE;YACpE,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC;YACjD,QAAQ,YAAY,CAAC,IAAI,EAAE;gBACvB,KAAK,SAAS;oBACV,IAAI,CAAC,YAAY,CAAC,QAAQ,CACtB,YAAY,CAAC,WAAW,EACxB,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC7B,MAAM;gBACV,KAAK,WAAW;oBACZ,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;oBACvD,MAAM;gBACV,KAAK,OAAO;oBACR,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;oBAC1B,MAAM;gBACV;oBACI,MAAM;aACb;YACD,kBAAkB,EAAE,CAAC;SACxB;QAED,wBAAwB;QACxB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IDisposable } from \"@fluidframework/common-definitions\";\nimport { assert, Lazy } from \"@fluidframework/common-utils\";\nimport { ICriticalContainerError } from \"@fluidframework/container-definitions\";\nimport { DataProcessingError } from \"@fluidframework/container-utils\";\nimport {\n    ISequencedDocumentMessage,\n} from \"@fluidframework/protocol-definitions\";\nimport { FlushMode } from \"@fluidframework/runtime-definitions\";\nimport { wrapError } from \"@fluidframework/telemetry-utils\";\nimport Deque from \"double-ended-queue\";\nimport { ContainerMessageType } from \"./containerRuntime\";\n\n/**\n * This represents a message that has been submitted and is added to the pending queue when `submit` is called on the\n * ContainerRuntime. This message has either not been ack'd by the server or has not been submitted to the server yet.\n */\nexport interface IPendingMessage {\n    type: \"message\";\n    messageType: ContainerMessageType;\n    clientSequenceNumber: number;\n    referenceSequenceNumber: number;\n    content: any;\n    localOpMetadata: unknown;\n    opMetadata: Record<string, unknown> | undefined;\n}\n\n/**\n * This represents a FlushMode update and is added to the pending queue when `setFlushMode` is called on the\n * ContainerRuntime and the FlushMode changes.\n */\nexport interface IPendingFlushMode {\n    type: \"flushMode\";\n    flushMode: FlushMode;\n}\n\n/**\n * This represents an explicit flush call and is added to the pending queue when flush is called on the ContainerRuntime\n * to flush pending messages.\n */\nexport interface IPendingFlush {\n    type: \"flush\";\n}\n\nexport type IPendingState = IPendingMessage | IPendingFlushMode | IPendingFlush;\n\nexport interface IPendingLocalState {\n    /**\n     * list of pending states, including ops and batch information\n     */\n    pendingStates: IPendingState[];\n}\n\nexport interface IRuntimeStateHandler{\n    connected(): boolean;\n    clientId(): string | undefined;\n    flushMode(): FlushMode;\n    setFlushMode(mode: FlushMode): void;\n    close(error?: ICriticalContainerError): void;\n    applyStashedOp: (type: ContainerMessageType, content: ISequencedDocumentMessage) => Promise<unknown>;\n    flush(): void;\n    reSubmit(\n        type: ContainerMessageType,\n        content: any,\n        localOpMetadata: unknown,\n        opMetadata: Record<string, unknown> | undefined): void;\n    rollback(\n        type: ContainerMessageType,\n        content: any,\n        localOpMetadata: unknown): void;\n}\n\n/**\n * PendingStateManager is responsible for maintaining the messages that have not been sent or have not yet been\n * acknowledged by the server. It also maintains the batch information for both automatically and manually flushed\n * batches along with the messages.\n * When the Container reconnects, it replays the pending states, which includes setting the FlushMode, manual flushing\n * of messages and triggering resubmission of unacked ops.\n *\n * It verifies that all the ops are acked, are received in the right order and batch information is correct.\n */\nexport class PendingStateManager implements IDisposable {\n    private readonly pendingStates = new Deque<IPendingState>();\n    private readonly initialStates: Deque<IPendingState>;\n    private readonly disposeOnce = new Lazy<void>(() => {\n        this.initialStates.clear();\n        this.pendingStates.clear();\n    });\n\n    // Maintains the count of messages that are currently unacked.\n    private _pendingMessagesCount: number = 0;\n    public get pendingMessagesCount(): number {\n        return this._pendingMessagesCount;\n    }\n\n    // Indicates whether we are processing a batch.\n    private isProcessingBatch: boolean = false;\n\n    // This stores the first message in the batch that we are processing. This is used to verify that we get\n    // the correct batch metadata.\n    private pendingBatchBeginMessage: ISequencedDocumentMessage | undefined;\n\n    /**\n     * This tracks the flush mode for the next message in the pending state queue. When replaying messages, we need to\n     * first set the flush mode to this value and then send ops. It is important to do this info because the flush\n     * mode could have been updated.\n     */\n    private flushModeForNextMessage: FlushMode;\n\n    private clientId: string | undefined;\n\n    /**\n     * Called to check if there are any pending messages in the pending state queue.\n     * @returns A boolean indicating whether there are messages or not.\n     */\n    public hasPendingMessages(): boolean {\n        return this._pendingMessagesCount !== 0 || !this.initialStates.isEmpty();\n    }\n\n    public getLocalState(): IPendingLocalState | undefined {\n        assert(this.initialStates.isEmpty(), 0x2e9 /* \"Must call getLocalState() after applying initial states\" */);\n        if (this.hasPendingMessages()) {\n            return {\n                pendingStates: this.pendingStates.toArray().map(\n                    // delete localOpMetadata since it may not be serializable\n                    // and will be regenerated by applyStashedOp()\n                    (state) => state.type === \"message\" ? { ...state, localOpMetadata: undefined } : state),\n            };\n        }\n    }\n\n    constructor(\n        private readonly stateHandler: IRuntimeStateHandler,\n        initialFlushMode: FlushMode,\n        initialLocalState: IPendingLocalState | undefined,\n    ) {\n        this.initialStates = new Deque<IPendingState>(initialLocalState?.pendingStates ?? []);\n\n        this.flushModeForNextMessage = initialFlushMode;\n        this.onFlushModeUpdated(initialFlushMode);\n    }\n\n    public get disposed() { return this.disposeOnce.evaluated; }\n    public readonly dispose = () => this.disposeOnce.value;\n\n    /**\n     * Called when a message is submitted locally. Adds the message and the associated details to the pending state\n     * queue.\n     * @param type - The container message type.\n     * @param clientSequenceNumber - The clientSequenceNumber associated with the message.\n     * @param content - The message content.\n     * @param localOpMetadata - The local metadata associated with the message.\n     */\n    public onSubmitMessage(\n        type: ContainerMessageType,\n        clientSequenceNumber: number,\n        referenceSequenceNumber: number,\n        content: any,\n        localOpMetadata: unknown,\n        opMetadata: Record<string, unknown> | undefined,\n    ) {\n        const pendingMessage: IPendingMessage = {\n            type: \"message\",\n            messageType: type,\n            clientSequenceNumber,\n            referenceSequenceNumber,\n            content,\n            localOpMetadata,\n            opMetadata,\n        };\n\n        this.pendingStates.push(pendingMessage);\n\n        this._pendingMessagesCount++;\n    }\n\n    /**\n     * Called when the FlushMode is updated. Adds the FlushMode to the pending state queue.\n     * @param flushMode - The flushMode that was updated.\n     */\n    public onFlushModeUpdated(flushMode: FlushMode) {\n        this.pendingStates.push({ type: \"flushMode\", flushMode });\n    }\n\n    /**\n     * Called when flush() is called on the ContainerRuntime to manually flush messages.\n     */\n    public onFlush() {\n        // If the FlushMode is Immediate, we don't need to track an explicit flush call because every message is\n        // automatically flushed. So, flush is a no-op.\n        if (this.stateHandler.flushMode() === FlushMode.Immediate) {\n            return;\n        }\n\n        // If the previous state is not a message, flush is a no-op.\n        const previousState = this.pendingStates.peekBack();\n        if (previousState?.type !== \"message\") {\n            return;\n        }\n\n        // An explicit flush is interesting and is tracked only if there are messages sent in TurnBased mode.\n        this.pendingStates.push({ type: \"flush\" });\n    }\n\n    /**\n     * Applies stashed ops at their reference sequence number so they are ready to be ACKed or resubmitted\n     * @param seqNum - Sequence number at which to apply ops. Will apply all ops if seqNum is undefined.\n     */\n    public async applyStashedOpsAt(seqNum?: number) {\n        // apply stashed ops at sequence number\n        while (!this.initialStates.isEmpty()) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const nextState = this.initialStates.peekFront()!;\n            if (nextState.type === \"message\") {\n                if (seqNum !== undefined) {\n                    if (nextState.referenceSequenceNumber > seqNum) {\n                        break; // nothing left to do at this sequence number\n                    } else if (nextState.referenceSequenceNumber < seqNum) {\n                        throw new Error(\"loaded from snapshot too recent to apply stashed ops\");\n                    }\n                }\n\n                // applyStashedOp will cause the DDS to behave as if it has sent the op but not actually send it\n                const localOpMetadata =\n                    await this.stateHandler.applyStashedOp(nextState.messageType, nextState.content);\n                nextState.localOpMetadata = localOpMetadata;\n            }\n\n            // then we push onto pendingStates which will cause PendingStateManager to resubmit when we connect\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            this.pendingStates.push(this.initialStates.shift()!);\n        }\n    }\n\n    /**\n     * Processes a local message once its ack'd by the server. It verifies that there was no data corruption and that\n     * the batch information was preserved for batch messages.\n     * @param message - The message that got ack'd and needs to be processed.\n     */\n    public processPendingLocalMessage(message: ISequencedDocumentMessage): unknown {\n        // Pre-processing part - This may be the start of a batch.\n        this.maybeProcessBatchBegin(message);\n\n        // Get the next state from the pending queue and verify that it is of type \"message\".\n        const pendingState = this.peekNextPendingState();\n        assert(pendingState.type === \"message\", 0x169 /* \"No pending message found for this remote message\" */);\n        this.pendingStates.shift();\n\n        // Processing part - Verify that there has been no data corruption.\n        // The clientSequenceNumber of the incoming message must match that of the pending message.\n        if (pendingState.clientSequenceNumber !== message.clientSequenceNumber) {\n            // Close the container because this could indicate data corruption.\n            const error = DataProcessingError.create(\n                \"pending local message clientSequenceNumber mismatch\",\n                \"unexpectedAckReceived\",\n                message,\n                { expectedClientSequenceNumber: pendingState.clientSequenceNumber },\n            );\n\n            this.stateHandler.close(error);\n            return;\n        }\n\n        this._pendingMessagesCount--;\n\n        // Post-processing part - If we are processing a batch then this could be the last message in the batch.\n        this.maybeProcessBatchEnd(message);\n\n        return pendingState.localOpMetadata;\n    }\n\n    /**\n     * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.\n     * @param message - The message that is being processed.\n     */\n    private maybeProcessBatchBegin(message: ISequencedDocumentMessage) {\n        // Tracks the last FlushMode that was set before this message was sent.\n        let pendingFlushMode: FlushMode | undefined;\n        // Tracks whether a flush was called before this message was sent.\n        let pendingFlush: boolean = false;\n\n        /**\n         * We are checking if the next message is the start of a batch. It can happen in the following scenarios:\n         * 1. The FlushMode was set to TurnBased before this message was sent.\n         * 2. The FlushMode was already TurnBased and a flush was called before this message was sent. This essentially\n         *    means that the flush marked the end of a previous batch and beginning of a new batch.\n         *\n         * Keep reading pending states from the queue until we encounter a message. It's possible that the FlushMode was\n         * updated a bunch of times without sending any messages.\n         */\n        let nextPendingState = this.peekNextPendingState();\n        while (nextPendingState.type !== \"message\") {\n            if (nextPendingState.type === \"flushMode\") {\n                pendingFlushMode = nextPendingState.flushMode;\n            }\n            if (nextPendingState.type === \"flush\") {\n                pendingFlush = true;\n            }\n            this.pendingStates.shift();\n            nextPendingState = this.peekNextPendingState();\n        }\n\n        if (pendingFlushMode !== undefined) {\n            this.flushModeForNextMessage = pendingFlushMode;\n        }\n\n        // If the FlushMode was set to Immediate before this message was sent, this message won't be a batch message\n        // because in Immediate mode, every message is flushed individually.\n        if (pendingFlushMode === FlushMode.Immediate) {\n            return;\n        }\n\n        /**\n         * This message is the first in a batch if before it was sent either the FlushMode was set to TurnBased or there\n         * was an explicit flush call. Note that a flush call is tracked only in TurnBased mode and it indicates the end\n         * of one batch and beginning of another.\n         */\n        if (pendingFlushMode === FlushMode.TurnBased || pendingFlush) {\n            // We should not already be processing a batch and there should be no pending batch begin message.\n            assert(!this.isProcessingBatch && this.pendingBatchBeginMessage === undefined,\n                0x16b /* \"The pending batch state indicates we are already processing a batch\" */);\n\n            // Set the pending batch state indicating we have started processing a batch.\n            this.pendingBatchBeginMessage = message;\n            this.isProcessingBatch = true;\n        }\n    }\n\n    /**\n     * This message could be the last message in batch. If so, clear batch state since the batch is complete.\n     * @param message - The message that is being processed.\n     */\n    private maybeProcessBatchEnd(message: ISequencedDocumentMessage) {\n        if (!this.isProcessingBatch) {\n            return;\n        }\n\n        const nextPendingState = this.peekNextPendingState();\n        if (nextPendingState.type === \"message\") {\n            return;\n        }\n\n        /**\n         * We are in the middle of processing a batch. The batch ends when we see an explicit flush. We should never see\n         * a FlushMode before flush. This is true because we track batches only when FlushMode is TurnBased and in this\n         * mode, a batch ends either by calling flush or by changing the mode to Immediate which also triggers a flush.\n         */\n        assert(\n            nextPendingState.type !== \"flushMode\",\n            0x2bd /* \"We should not see a pending FlushMode until we see a flush when processing a batch\" */,\n        );\n\n        // There should be a pending batch begin message.\n        assert(this.pendingBatchBeginMessage !== undefined, 0x16d /* \"There is no pending batch begin message\" */);\n\n        // Get the batch begin metadata from the first message in the batch.\n        const batchBeginMetadata = this.pendingBatchBeginMessage.metadata?.batch;\n\n        // There could be just a single message in the batch. If so, it should not have any batch metadata. If there\n        // are multiple messages in the batch, verify that we got the correct batch begin and end metadata.\n        if (this.pendingBatchBeginMessage === message) {\n            assert(batchBeginMetadata === undefined,\n                0x16e /* \"Batch with single message should not have batch metadata\" */);\n        } else {\n            // Get the batch metadata from the last message in the batch.\n            const batchEndMetadata = message.metadata?.batch;\n            assert(batchBeginMetadata === true, 0x16f /* \"Did not receive batch begin metadata\" */);\n            assert(batchEndMetadata === false, 0x170 /* \"Did not receive batch end metadata\" */);\n        }\n\n        // Clear the pending batch state now that we have processed the entire batch.\n        this.pendingBatchBeginMessage = undefined;\n        this.isProcessingBatch = false;\n    }\n\n    /**\n     * Capture the pending state at this point\n     */\n    public checkpoint() {\n        const checkpointHead = this.pendingStates.peekBack();\n        return {\n            rollback: () => {\n                try {\n                    while (this.pendingStates.peekBack() !== checkpointHead) {\n                        this.rollbackNextPendingState();\n                    }\n                } catch (err) {\n                    const error = wrapError(err, (message) => {\n                        return DataProcessingError.create(\n                            `RollbackError: ${message}`,\n                            \"checkpointRollback\",\n                            undefined) as DataProcessingError;\n                    });\n                    this.stateHandler.close(error);\n                    throw error;\n                }\n            },\n        };\n    }\n\n    /**\n     * Returns the next pending state from the pending state queue.\n     */\n    private peekNextPendingState(): IPendingState {\n        const nextPendingState = this.pendingStates.peekFront();\n        assert(!!nextPendingState, 0x171 /* \"No pending state found for the remote message\" */);\n        return nextPendingState;\n    }\n\n    /**\n     * Undo the last pending state\n     */\n    private rollbackNextPendingState() {\n        const pendingStatesCount = this.pendingStates.length;\n        if (pendingStatesCount === 0) {\n            return;\n        }\n\n        this._pendingMessagesCount--;\n\n        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n        const pendingState = this.pendingStates.pop()!;\n        switch (pendingState.type) {\n            case \"message\":\n                this.stateHandler.rollback(\n                    pendingState.messageType,\n                    pendingState.content,\n                    pendingState.localOpMetadata);\n                break;\n            default:\n                throw new Error(`Can't rollback state ${pendingState.type}`);\n        }\n    }\n\n    /**\n     * Called when the Container's connection state changes. If the Container gets connected, it replays all the pending\n     * states in its queue. This includes setting the FlushMode and triggering resubmission of unacked ops.\n     */\n    public replayPendingStates() {\n        assert(this.stateHandler.connected(), 0x172 /* \"The connection state is not consistent with the runtime\" */);\n\n        // This assert suggests we are about to send same ops twice, which will result in data loss.\n        assert(this.clientId !== this.stateHandler.clientId(),\n            0x173 /* \"replayPendingStates called twice for same clientId!\" */);\n        this.clientId = this.stateHandler.clientId();\n\n        assert(this.initialStates.isEmpty(), 0x174 /* \"initial states should be empty before replaying pending\" */);\n\n        let pendingStatesCount = this.pendingStates.length;\n        if (pendingStatesCount === 0) {\n            return;\n        }\n\n        // Reset the pending message count because all these messages will be removed from the queue.\n        this._pendingMessagesCount = 0;\n\n        // Save the current FlushMode so that we can revert it back after replaying the states.\n        const savedFlushMode = this.stateHandler.flushMode();\n\n        // Set the flush mode for the next message. This step is important because the flush mode may have been changed\n        // after the next pending message was sent.\n        this.stateHandler.setFlushMode(this.flushModeForNextMessage);\n\n        // Process exactly `pendingStatesCount` items in the queue as it represents the number of states that were\n        // pending when we connected. This is important because the `reSubmitFn` might add more items in the queue\n        // which must not be replayed.\n        while (pendingStatesCount > 0) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const pendingState = this.pendingStates.shift()!;\n            switch (pendingState.type) {\n                case \"message\":\n                    this.stateHandler.reSubmit(\n                        pendingState.messageType,\n                        pendingState.content,\n                        pendingState.localOpMetadata,\n                        pendingState.opMetadata);\n                    break;\n                case \"flushMode\":\n                    this.stateHandler.setFlushMode(pendingState.flushMode);\n                    break;\n                case \"flush\":\n                    this.stateHandler.flush();\n                    break;\n                default:\n                    break;\n            }\n            pendingStatesCount--;\n        }\n\n        // Revert the FlushMode.\n        this.stateHandler.setFlushMode(savedFlushMode);\n    }\n}\n"]}

package/lib/runningSummarizer.d.ts

@@ -3,8 +3,9 @@
  * Licensed under the MIT License.
  */
 import { IDisposable, ITelemetryLogger } from "@fluidframework/common-definitions";
-import { ISequencedDocumentMessage, ISummaryConfiguration } from "@fluidframework/protocol-definitions";
-import { IEnqueueSummarizeOptions, ISummarizeHeuristicData, ISummarizerOptions, IOnDemandSummarizeOptions, EnqueueSummarizeResult, SummarizerStopReason, ISubmitSummaryOptions, SubmitSummaryResult, ISummaryCancellationToken, ISummarizeResults } from "./summarizerTypes";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ISummaryConfiguration } from "./containerRuntime";
+import { IEnqueueSummarizeOptions, ISummarizeHeuristicData, IOnDemandSummarizeOptions, EnqueueSummarizeResult, SummarizerStopReason, ISubmitSummaryOptions, SubmitSummaryResult, ISummaryCancellationToken, ISummarizeResults } from "./summarizerTypes";
 import { IClientSummaryWatcher, SummaryCollection } from "./summaryCollection";
 import { SummarizeResultBuilder } from "./summaryGenerator";
 /**
@@ -23,7 +24,7 @@ export declare class RunningSummarizer implements IDisposable {
     private readonly summaryCollection;
     private readonly cancellationToken;
     private readonly stopSummarizerCallback;
-    static start(logger: ITelemetryLogger, summaryWatcher: IClientSummaryWatcher, configuration: ISummaryConfiguration, submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>, heuristicData: ISummarizeHeuristicData, raiseSummarizingError: (errorMessage: string) => void, summaryCollection: SummaryCollection, cancellationToken: ISummaryCancellationToken, stopSummarizerCallback: (reason: SummarizerStopReason) => void, options?: Readonly<Partial<ISummarizerOptions>>): Promise<RunningSummarizer>;
+    static start(logger: ITelemetryLogger, summaryWatcher: IClientSummaryWatcher, configuration: ISummaryConfiguration, submitSummaryCallback: (options: ISubmitSummaryOptions) => Promise<SubmitSummaryResult>, heuristicData: ISummarizeHeuristicData, raiseSummarizingError: (errorMessage: string) => void, summaryCollection: SummaryCollection, cancellationToken: ISummaryCancellationToken, stopSummarizerCallback: (reason: SummarizerStopReason) => void): Promise<RunningSummarizer>;
     get disposed(): boolean;
     private stopping;
     private _disposed;

package/lib/runningSummarizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runningSummarizer.d.ts","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGnF,OAAO,EACH,yBAAyB,EACzB,qBAAqB,EAExB,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EACH,wBAAwB,EAExB,uBAAuB,EAEvB,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAGpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAGH,sBAAsB,EAEzB,MAAM,oBAAoB,CAAC;AAI5B;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IAqD7C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;WA3DvB,KAAK,CACrB,MAAM,EAAE,gBAAgB,EACxB,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,EACrD,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,EAC9D,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAChD,OAAO,CAAC,iBAAiB,CAAC;IAoB7B,IAAW,QAAQ,YAA6B;IAEhD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,eAAe,CAAC,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAKT;IACd,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,uBAAuB,CAAK;IAEpC,OAAO;IA0EA,OAAO,IAAI,IAAI;IAWtB;;;;;OAKG;IACI,sBAAsB,yDAGT;IAEb,cAAc,CAAC,EAAE,EAAE,yBAAyB;IAe5C,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,yBAAyB;IAYtF,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA4BjD,SAAS;IAsBvB;;;;;;OAMG;YACW,mBAAmB;IAuBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAuBxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAkFpB,8DAA8D;IACvD,iBAAiB,CACpB,cAAc,oCAAuD,EACrE,EACI,MAAM,EACN,GAAG,OAAO,EACb,EAAE,yBAAyB,GAAG,iBAAiB;IAmBpD,6DAA6D;IACtD,gBAAgB,CAAC,EACpB,MAAM,EACN,mBAAuB,EACvB,QAAgB,EAChB,GAAG,OAAO,EACb,EAAE,wBAAwB,GAAG,sBAAsB;IA8BpD,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAMjC"}
+{"version":3,"file":"runningSummarizer.d.ts","sourceRoot":"","sources":["../src/runningSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAGnF,OAAO,EACH,yBAAyB,EAE5B,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EACH,qBAAqB,EACxB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACH,wBAAwB,EAExB,uBAAuB,EAEvB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EAGpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAGH,sBAAsB,EAEzB,MAAM,oBAAoB,CAAC;AAI5B;;;;;;GAMG;AACH,qBAAa,iBAAkB,YAAW,WAAW;IAmD7C,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IACtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;WAzDvB,KAAK,CACrB,MAAM,EAAE,gBAAgB,EACxB,cAAc,EAAE,qBAAqB,EACrC,aAAa,EAAE,qBAAqB,EACpC,qBAAqB,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,mBAAmB,CAAC,EACvF,aAAa,EAAE,uBAAuB,EACtC,qBAAqB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,EACrD,iBAAiB,EAAE,iBAAiB,EACpC,iBAAiB,EAAE,yBAAyB,EAC5C,sBAAsB,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,GAC/D,OAAO,CAAC,iBAAiB,CAAC;IAmB7B,IAAW,QAAQ,YAA6B;IAEhD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAe;IAC/C,OAAO,CAAC,eAAe,CAAC,CAA4B;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmB;IAC1C,OAAO,CAAC,eAAe,CAKT;IACd,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,uBAAuB,CAAK;IAEpC,OAAO;IAiFA,OAAO,IAAI,IAAI;IAWtB;;;;;OAKG;IACI,sBAAsB,yDAGT;IAEb,cAAc,CAAC,EAAE,EAAE,yBAAyB;IAe5C,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,yBAAyB;IAYtF,QAAQ,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;YA4BjD,SAAS;IAsBvB;;;;;;OAMG;YACW,mBAAmB;IAuBjC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAuBxB,oCAAoC;IACpC,OAAO,CAAC,YAAY;IAsFpB,8DAA8D;IACvD,iBAAiB,CACpB,cAAc,oCAAuD,EACrE,EACI,MAAM,EACN,GAAG,OAAO,EACb,EAAE,yBAAyB,GAAG,iBAAiB;IAmBpD,6DAA6D;IACtD,gBAAgB,CAAC,EACpB,MAAM,EACN,mBAAuB,EACvB,QAAgB,EAChB,GAAG,OAAO,EACb,EAAE,wBAAwB,GAAG,sBAAsB;IA8BpD,OAAO,CAAC,qBAAqB;IAwB7B,OAAO,CAAC,sBAAsB;CAMjC"}

package/lib/runningSummarizer.js

@@ -28,7 +28,7 @@ const maxSummarizeAckWaitTime = 10 * 60 * 1000; // 10 minutes
  * This object is created and controlled by Summarizer object.
  */
 export class RunningSummarizer {
-    constructor(baseLogger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback, { disableHeuristics = false } = {}) {
+    constructor(baseLogger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback) {
         this.summaryWatcher = summaryWatcher;
         this.configuration = configuration;
         this.submitSummaryCallback = submitSummaryCallback;
@@ -58,9 +58,11 @@ export class RunningSummarizer {
         this.logger = ChildLogger.create(baseLogger, "Running", {
             all: telemetryProps,
         });
-        if (!disableHeuristics) {
-            this.heuristicRunner = new SummarizeHeuristicRunner(heuristicData, configuration, (reason) => this.trySummarize(reason));
+        if (configuration.state !== "disableHeuristics") {
+            assert(this.configuration.state === "enabled", 0x2ea /* "Configuration state should be enabled" */);
+            this.heuristicRunner = new SummarizeHeuristicRunner(heuristicData, this.configuration, (reason) => this.trySummarize(reason), this.logger);
         }
+        assert(this.configuration.state !== "disabled", 0x2eb /* "Summary not supported with configuration disabled" */);
         // Cap the maximum amount of time client will wait for a summarize op ack to maxSummarizeAckWaitTime
         // configuration.maxAckWaitTime is composed from defaults, server values, and runtime overrides
         const maxAckWaitTime = Math.min(this.configuration.maxAckWaitTime, maxSummarizeAckWaitTime);
@@ -91,9 +93,9 @@ export class RunningSummarizer {
         });
         this.generator = new SummaryGenerator(this.pendingAckTimer, this.heuristicData, this.submitSummaryCallback, this.raiseSummarizingError, () => { this.totalSuccessfulAttempts++; }, this.summaryWatcher, this.logger);
     }
-    static async start(logger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback, options) {
+    static async start(logger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback) {
         var _a;
-        const summarizer = new RunningSummarizer(logger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback, options);
+        const summarizer = new RunningSummarizer(logger, summaryWatcher, configuration, submitSummaryCallback, heuristicData, raiseSummarizingError, summaryCollection, cancellationToken, stopSummarizerCallback);
         await summarizer.waitStart();
         // Run the heuristics after starting
         (_a = summarizer.heuristicRunner) === null || _a === void 0 ? void 0 : _a.run();
@@ -245,7 +247,10 @@ export class RunningSummarizer {
                 if (this.cancellationToken.cancelled) {
                     return;
                 }
-                summaryAttempts++;
+                // We only want to attempt 1 summary when reason is "lastSummary"
+                if (++summaryAttempts > 1 && reason === "lastSummary") {
+                    return;
+                }
                 summaryAttemptsPerPhase++;
                 const _a = attempts[summaryAttemptPhase], { delaySeconds: regularDelaySeconds = 0 } = _a, options = __rest(_a, ["delaySeconds"]);
                 const delaySeconds = overrideDelaySeconds !== null && overrideDelaySeconds !== void 0 ? overrideDelaySeconds : regularDelaySeconds;