@fluidframework/container-runtime 2.0.0-dev.2.3.0.115467 → 2.0.0-dev.4.1.0.148229

package/lib/pendingStateManager.js

@@ -17,74 +17,92 @@ import { pkgVersion } from "./packageVersion";
  */
 export class PendingStateManager {
     constructor(stateHandler, initialLocalState) {
-        var _a;
+        var _a, _b;
         this.stateHandler = stateHandler;
-        this.pendingStates = new Deque();
+        this.pendingMessages = new Deque();
+        this.initialMessages = new Deque();
         this.disposeOnce = new Lazy(() => {
-            this.initialStates.clear();
-            this.pendingStates.clear();
+            this.initialMessages.clear();
+            this.pendingMessages.clear();
         });
-        // Maintains the count of messages that are currently unacked.
-        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 : []);
+        /**
+         * Convert old local state format to the new format
+         * The old format contained "flush" messages as the indicator of batch ends
+         * The new format instead uses batch metadata on the last message to indicate batch ends
+         * ! TODO: Remove this conversion in "2.0.0-internal.5.0.0" as version from "2.0.0-internal.4.0.0" will be new format
+         * AB#2496 tracks removal
+         */
+        if (initialLocalState === null || initialLocalState === void 0 ? void 0 : initialLocalState.pendingStates) {
+            const pendingStates = initialLocalState === null || initialLocalState === void 0 ? void 0 : initialLocalState.pendingStates;
+            let currentlyBatching = false;
+            for (let i = 0; i < pendingStates.length; i++) {
+                const initialState = pendingStates[i];
+                // Skip over "flush" messages
+                if (initialState.type === "message") {
+                    if ((_a = initialState.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) {
+                        currentlyBatching = true;
+                    }
+                    else if (((_b = initialState.opMetadata) === null || _b === void 0 ? void 0 : _b.batch) === false) {
+                        currentlyBatching = false;
+                    }
+                    else if (
+                    // End of batch if we are currently batching and this is last message or next message is flush
+                    currentlyBatching &&
+                        (i === pendingStates.length - 1 || pendingStates[i + 1].type === "flush")) {
+                        currentlyBatching = false;
+                        initialState.opMetadata = Object.assign(Object.assign({}, initialState.opMetadata), { batch: false });
+                    }
+                    this.initialMessages.push(initialState);
+                }
+            }
+        }
     }
     get pendingMessagesCount() {
-        return this._pendingMessagesCount;
+        return this.pendingMessages.length;
     }
     /**
-     * Called to check if there are any pending messages in the pending state queue.
+     * Called to check if there are any pending messages in the pending message queue.
      * @returns A boolean indicating whether there are messages or not.
      */
     hasPendingMessages() {
-        return this._pendingMessagesCount !== 0 || !this.initialStates.isEmpty();
+        return !this.pendingMessages.isEmpty() || !this.initialMessages.isEmpty();
     }
     getLocalState() {
-        assert(this.initialStates.isEmpty(), 0x2e9 /* "Must call getLocalState() after applying initial states" */);
-        if (this.hasPendingMessages()) {
+        assert(this.initialMessages.isEmpty(), 0x2e9 /* "Must call getLocalState() after applying initial states" */);
+        if (!this.pendingMessages.isEmpty()) {
             return {
-                pendingStates: this.pendingStates.toArray().map(
                 // delete localOpMetadata since it may not be serializable
                 // and will be regenerated by applyStashedOp()
-                (state) => state.type === "message" ? Object.assign(Object.assign({}, state), { localOpMetadata: undefined }) : state),
+                pendingStates: this.pendingMessages
+                    .toArray()
+                    .map((message) => (Object.assign(Object.assign({}, message), { localOpMetadata: undefined }))),
             };
         }
     }
-    get disposed() { return this.disposeOnce.evaluated; }
+    get disposed() {
+        return this.disposeOnce.evaluated;
+    }
     /**
      * Called when a message is submitted locally. Adds the message and the associated details to the pending state
      * queue.
      * @param type - The container message type.
-     * @param clientSequenceNumber - The clientSequenceNumber associated with the message.
      * @param content - The message content.
      * @param localOpMetadata - The local metadata associated with the message.
      */
-    onSubmitMessage(type, clientSequenceNumber, referenceSequenceNumber, content, localOpMetadata, opMetadata) {
+    onSubmitMessage(type, referenceSequenceNumber, content, localOpMetadata, opMetadata) {
         const pendingMessage = {
             type: "message",
             messageType: type,
-            clientSequenceNumber,
+            clientSequenceNumber: -1,
             referenceSequenceNumber,
             content,
             localOpMetadata,
             opMetadata,
         };
-        this.pendingStates.push(pendingMessage);
-        this._pendingMessagesCount++;
-    }
-    /**
-     * Called when flush() is called on the ContainerRuntime to manually flush messages.
-     */
-    onFlush() {
-        // If the previous state is not a message, flush is a no-op.
-        const previousState = this.pendingStates.peekBack();
-        if ((previousState === null || previousState === void 0 ? void 0 : previousState.type) !== "message") {
-            return;
-        }
-        // An explicit flush is interesting and is tracked only if there are messages sent in TurnBased mode.
-        this.pendingStates.push({ type: "flush" });
+        this.pendingMessages.push(pendingMessage);
     }
     /**
      * Applies stashed ops at their reference sequence number so they are ready to be ACKed or resubmitted
@@ -92,29 +110,23 @@ export class PendingStateManager {
      */
     async applyStashedOpsAt(seqNum) {
         // apply stashed ops at sequence number
-        while (!this.initialStates.isEmpty()) {
+        while (!this.initialMessages.isEmpty()) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const nextState = this.initialStates.peekFront();
-            if (nextState.type === "message") {
-                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");
-                    }
+            const nextMessage = this.initialMessages.peekFront();
+            if (seqNum !== undefined) {
+                if (nextMessage.referenceSequenceNumber > seqNum) {
+                    break; // nothing left to do at this sequence number
+                }
+                if (nextMessage.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.stateHandler.applyStashedOp(nextState.messageType, nextState.content);
-                nextState.localOpMetadata = localOpMetadata;
             }
-            // then we push onto pendingStates which will cause PendingStateManager to resubmit when we connect
+            // applyStashedOp will cause the DDS to behave as if it has sent the op but not actually send it
+            const localOpMetadata = await this.stateHandler.applyStashedOp(nextMessage.messageType, nextMessage.content);
+            nextMessage.localOpMetadata = localOpMetadata;
+            // then we push onto pendingMessages which will cause PendingStateManager to resubmit when we connect
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const firstPendingState = this.initialStates.shift();
-            this.pendingStates.push(firstPendingState);
-            if (firstPendingState.type === "message") {
-                this._pendingMessagesCount++;
-            }
+            this.pendingMessages.push(this.initialMessages.shift());
         }
     }
     /**
@@ -125,23 +137,28 @@ export class PendingStateManager {
     processPendingLocalMessage(message) {
         // Pre-processing part - This may be the start of a batch.
         this.maybeProcessBatchBegin(message);
-        // Get the next state from the pending queue and verify that it is of type "message".
-        const pendingState = this.peekNextPendingState();
-        assert(pendingState.type === "message", 0x169 /* "No pending message found for this remote message" */);
-        this.pendingStates.shift();
-        // Processing part - Verify that there has been no data corruption.
-        // The clientSequenceNumber of the incoming message must match that of the pending message.
-        if (pendingState.clientSequenceNumber !== message.clientSequenceNumber) {
+        // Get the next message from the pending queue. Verify a message exists.
+        const pendingMessage = this.pendingMessages.peekFront();
+        assert(pendingMessage !== undefined, 0x169 /* "No pending message found for this remote message" */);
+        this.pendingMessages.shift();
+        if (pendingMessage.messageType !== message.type) {
             // Close the container because this could indicate data corruption.
-            const error = DataProcessingError.create("pending local message clientSequenceNumber mismatch", "unexpectedAckReceived", message, { expectedClientSequenceNumber: pendingState.clientSequenceNumber });
-            this.stateHandler.close(error);
+            this.stateHandler.close(DataProcessingError.create("pending local message type mismatch", "unexpectedAckReceived", message, {
+                expectedMessageType: pendingMessage.messageType,
+            }));
+            return;
+        }
+        const pendingMessageContent = JSON.stringify(pendingMessage.content);
+        const messageContent = JSON.stringify(message.contents);
+        // Stringified content does not match
+        if (pendingMessageContent !== messageContent) {
+            // Close the container because this could indicate data corruption.
+            this.stateHandler.close(DataProcessingError.create("pending local message content mismatch", "unexpectedAckReceived", message));
             return;
         }
-        this._pendingMessagesCount--;
-        assert(this._pendingMessagesCount >= 0, 0x3d6 /* positive */);
         // 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;
+        return pendingMessage.localOpMetadata;
     }
     /**
      * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.
@@ -149,20 +166,6 @@ export class PendingStateManager {
      */
     maybeProcessBatchBegin(message) {
         var _a;
-        /**
-         * We are checking if the next message is the start of a batch. It can happen in the following scenarios:
-         *
-         * 1. The FlushMode was set to TurnBased before this message was sent.
-         *
-         * 2. The FlushMode was already TurnBased and a flush was called before this message was sent. This essentially
-         * means that the flush marked the end of a previous batch and beginning of a new batch.
-         *
-         * Keep reading pending states from the queue until we encounter a message. It's possible that the FlushMode was
-         * updated a bunch of times without sending any messages.
-         */
-        while (this.peekNextPendingState().type !== "message") {
-            this.pendingStates.shift();
-        }
         // This message is the first in a batch if the "batch" property on the metadata is set to true
         if ((_a = message.metadata) === null || _a === void 0 ? void 0 : _a.batch) {
             // We should not already be processing a batch and there should be no pending batch begin message.
@@ -181,48 +184,35 @@ export class PendingStateManager {
         if (!this.isProcessingBatch) {
             return;
         }
-        const nextPendingState = this.peekNextPendingState();
-        if (nextPendingState.type === "message") {
-            return;
-        }
         // There should be a pending batch begin message.
         assert(this.pendingBatchBeginMessage !== undefined, 0x16d /* "There is no pending batch begin message" */);
-        // Get the batch begin metadata from the first message in the batch.
-        const batchBeginMetadata = (_a = this.pendingBatchBeginMessage.metadata) === null || _a === void 0 ? void 0 : _a.batch;
-        // There could be just a single message in the batch. If so, it should not have any batch metadata. If there
-        // are multiple messages in the batch, verify that we got the correct batch begin and end metadata.
-        if (this.pendingBatchBeginMessage === message) {
-            assert(batchBeginMetadata === undefined, 0x16e /* "Batch with single message should not have batch metadata" */);
-        }
-        else {
-            // Get the batch metadata from the last message in the batch.
-            const batchEndMetadata = (_b = message.metadata) === null || _b === void 0 ? void 0 : _b.batch;
-            if (batchBeginMetadata !== true || batchEndMetadata !== false) {
-                this.stateHandler.close(DataProcessingError.create("Pending batch inconsistency", // Formerly known as asserts 0x16f and 0x170
-                "processPendingLocalMessage", message, {
-                    runtimeVersion: pkgVersion,
-                    batchClientId: this.pendingBatchBeginMessage.clientId,
-                    clientId: this.stateHandler.clientId(),
-                    hasBatchStart: batchBeginMetadata === true,
-                    hasBatchEnd: batchEndMetadata === false,
-                    messageType: message.type,
-                    batchStartSequenceNumber: this.pendingBatchBeginMessage.clientSequenceNumber,
-                    pendingMessagesCount: this.pendingMessagesCount,
-                    nextPendingState: nextPendingState.type,
-                }));
+        const batchEndMetadata = (_a = message.metadata) === null || _a === void 0 ? void 0 : _a.batch;
+        if (this.pendingMessages.isEmpty() || batchEndMetadata === false) {
+            // Get the batch begin metadata from the first message in the batch.
+            const batchBeginMetadata = (_b = this.pendingBatchBeginMessage.metadata) === null || _b === void 0 ? void 0 : _b.batch;
+            // There could be just a single message in the batch. If so, it should not have any batch metadata. If there
+            // are multiple messages in the batch, verify that we got the correct batch begin and end metadata.
+            if (this.pendingBatchBeginMessage === message) {
+                assert(batchBeginMetadata === undefined, 0x16e /* "Batch with single message should not have batch metadata" */);
+            }
+            else {
+                if (batchBeginMetadata !== true || batchEndMetadata !== false) {
+                    this.stateHandler.close(DataProcessingError.create("Pending batch inconsistency", // Formerly known as asserts 0x16f and 0x170
+                    "processPendingLocalMessage", message, {
+                        runtimeVersion: pkgVersion,
+                        batchClientId: this.pendingBatchBeginMessage.clientId,
+                        clientId: this.stateHandler.clientId(),
+                        hasBatchStart: batchBeginMetadata === true,
+                        hasBatchEnd: batchEndMetadata === false,
+                        messageType: message.type,
+                        pendingMessagesCount: this.pendingMessagesCount,
+                    }));
+                }
             }
+            // Clear the pending batch state now that we have processed the entire batch.
+            this.pendingBatchBeginMessage = undefined;
+            this.isProcessingBatch = false;
         }
-        // Clear the pending batch state now that we have processed the entire batch.
-        this.pendingBatchBeginMessage = undefined;
-        this.isProcessingBatch = false;
-    }
-    /**
-     * Returns the next pending state from the pending state queue.
-     */
-    peekNextPendingState() {
-        const nextPendingState = this.pendingStates.peekFront();
-        assert(!!nextPendingState, 0x171 /* "No pending state found for the remote message" */);
-        return nextPendingState;
     }
     /**
      * Called when the Container's connection state changes. If the Container gets connected, it replays all the pending
@@ -234,63 +224,45 @@ export class PendingStateManager {
         // This assert suggests we are about to send same ops twice, which will result in data loss.
         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) {
+        assert(this.initialMessages.isEmpty(), 0x174 /* "initial states should be empty before replaying pending" */);
+        let pendingMessagesCount = this.pendingMessages.length;
+        if (pendingMessagesCount === 0) {
             return;
         }
-        // Reset the pending message count because all these messages will be removed from the queue.
-        this._pendingMessagesCount = 0;
-        const messageBatchQueue = new Deque();
-        // Process exactly `pendingStatesCount` items in the queue as it represents the number of states that were
+        // Process exactly `pendingMessagesCount` items in the queue as it represents the number of messages that were
         // pending when we connected. This is important because the `reSubmitFn` might add more items in the queue
         // which must not be replayed.
-        while (pendingStatesCount > 0) {
+        while (pendingMessagesCount > 0) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const pendingState = this.pendingStates.shift();
-            switch (pendingState.type) {
-                case "message":
-                    assert(((_a = pendingState.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) !== false || messageBatchQueue.length > 0, 0x41b /* We cannot process batches in chunks */);
-                    /**
-                     * We want to ensure grouped messages get processed in a batch.
-                     * Note: It is not possible for the PendingStateManager to receive a partially acked batch. It will
-                     * either receive the whole batch ack or nothing at all.
-                     */
-                    if (messageBatchQueue.length > 0 || ((_b = pendingState.opMetadata) === null || _b === void 0 ? void 0 : _b.batch)) {
-                        messageBatchQueue.enqueue(pendingState);
+            let pendingMessage = this.pendingMessages.shift();
+            pendingMessagesCount--;
+            assert(((_a = pendingMessage.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) !== false, 0x41b /* We cannot process batches in chunks */);
+            /**
+             * We want to ensure grouped messages get processed in a batch.
+             * Note: It is not possible for the PendingStateManager to receive a partially acked batch. It will
+             * either receive the whole batch ack or nothing at all.
+             */
+            if ((_b = pendingMessage.opMetadata) === null || _b === void 0 ? void 0 : _b.batch) {
+                assert(pendingMessagesCount > 0, 0x554 /* Last pending message cannot be a batch begin */);
+                this.stateHandler.orderSequentially(() => {
+                    var _a, _b;
+                    while (pendingMessagesCount >= 0) {
+                        // check is >= because batch end may be last pending message
+                        this.stateHandler.reSubmit(pendingMessage.messageType, pendingMessage.content, pendingMessage.localOpMetadata, pendingMessage.opMetadata);
+                        if (((_a = pendingMessage.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) === false) {
+                            break;
+                        }
+                        assert(pendingMessagesCount > 0, 0x555 /* No batch end found */);
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                        pendingMessage = this.pendingMessages.shift();
+                        pendingMessagesCount--;
+                        assert(((_b = pendingMessage.opMetadata) === null || _b === void 0 ? void 0 : _b.batch) !== true, 0x556 /* Batch start needs a corresponding batch end */);
                     }
-                    else {
-                        this.stateHandler.reSubmit(pendingState.messageType, pendingState.content, pendingState.localOpMetadata, pendingState.opMetadata);
-                    }
-                    break;
-                case "flush":
-                    /**
-                     * A "flush" call can indicate the end of a batch.
-                     * We can't rely on the "batch" property in the message metadata as it gets
-                     * updated elsewhere and it is not the same object instance that gets updated.
-                     */
-                    if (messageBatchQueue.length > 0) {
-                        this.stateHandler.orderSequentially(() => {
-                            while (messageBatchQueue.length > 0) {
-                                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                                const message = messageBatchQueue.dequeue();
-                                this.stateHandler.reSubmit(message.messageType, message.content, message.localOpMetadata, message.opMetadata);
-                            }
-                        });
-                    }
-                    assert(messageBatchQueue.length === 0, 0x41c /* cannot flush in the middle of a batch */);
-                    this.stateHandler.flush();
-                    break;
-                default:
-                    break;
+                });
+            }
+            else {
+                this.stateHandler.reSubmit(pendingMessage.messageType, pendingMessage.content, pendingMessage.localOpMetadata, pendingMessage.opMetadata);
             }
-            pendingStatesCount--;
-        }
-        // There are some cases where ops are stashed but not flushed. We need to ensure they are resubmitted
-        while (messageBatchQueue.length > 0) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const message = messageBatchQueue.dequeue();
-            this.stateHandler.reSubmit(message.messageType, message.content, message.localOpMetadata, message.opMetadata);
         }
     }
 }

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;AAE5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAItE,OAAO,KAAK,MAAM,oBAAoB,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAmD9C;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAmB;IA2C5B,YACqB,YAAkC,EACnD,iBAAiD;;QADhC,iBAAY,GAAZ,YAAY,CAAsB;QA3CtC,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;QAoC3B,YAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QAJnD,IAAI,CAAC,aAAa,GAAG,IAAI,KAAK,CAAgB,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,aAAa,mCAAI,EAAE,CAAC,CAAC;IAC1F,CAAC;IAtCD,IAAW,oBAAoB;QAC3B,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAWD;;;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;IASD,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;;OAEG;IACI,OAAO;QACV,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,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAG,CAAC;YACtD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC3C,IAAI,iBAAiB,CAAC,IAAI,KAAK,SAAS,EAAE;gBACtC,IAAI,CAAC,qBAAqB,EAAE,CAAC;aAChC;SACJ;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;QAC7B,MAAM,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;QAE9D,wGAAwG;QACxG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,YAAY,CAAC,eAAe,CAAC;IACxC,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,OAAkC;;QAC7D;;;;;;;;;;WAUG;QACH,OAAO,IAAI,CAAC,oBAAoB,EAAE,CAAC,IAAI,KAAK,SAAS,EAAE;YACnD,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;SAC9B;QAED,8FAA8F;QAC9F,IAAI,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,EAAE;YACzB,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,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,IAAI,kBAAkB,KAAK,IAAI,IAAI,gBAAgB,KAAK,KAAK,EAAE;gBAC3D,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAC9C,6BAA6B,EAAE,4CAA4C;gBAC3E,4BAA4B,EAC5B,OAAO,EACP;oBACI,cAAc,EAAE,UAAU;oBAC1B,aAAa,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ;oBACrD,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;oBACtC,aAAa,EAAE,kBAAkB,KAAK,IAAI;oBAC1C,WAAW,EAAE,gBAAgB,KAAK,KAAK;oBACvC,WAAW,EAAE,OAAO,CAAC,IAAI;oBACzB,wBAAwB,EAAE,IAAI,CAAC,wBAAwB,CAAC,oBAAoB;oBAC5E,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;oBAC/C,gBAAgB,EAAE,gBAAgB,CAAC,IAAI;iBAC1C,CAAC,CAAC,CAAC;aACX;SACJ;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,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,MAAM,iBAAiB,GAAG,IAAI,KAAK,EAAmB,CAAC;QAEvD,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,MAAM,CAAC,CAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,KAAK,MAAK,KAAK,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAC3E,KAAK,CAAC,yCAAyC,CAAC,CAAC;oBACrD;;;;uBAIG;oBACH,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,KAAI,MAAA,YAAY,CAAC,UAAU,0CAAE,KAAK,CAAA,EAAE;wBAChE,iBAAiB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;qBAC3C;yBAAM;wBACH,IAAI,CAAC,YAAY,CAAC,QAAQ,CACtB,YAAY,CAAC,WAAW,EACxB,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,eAAe,EAC5B,YAAY,CAAC,UAAU,CAAC,CAAC;qBAChC;oBACD,MAAM;gBACV,KAAK,OAAO;oBACR;;;;uBAIG;oBACH,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;wBAC9B,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE;4BACrC,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;gCACjC,oEAAoE;gCACpE,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAG,CAAC;gCAC7C,IAAI,CAAC,YAAY,CAAC,QAAQ,CACtB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,eAAe,EACvB,OAAO,CAAC,UAAU,CAAC,CAAC;6BAC3B;wBACL,CAAC,CAAC,CAAC;qBACN;oBACD,MAAM,CAAC,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;oBAC1F,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;oBAC1B,MAAM;gBACV;oBACI,MAAM;aACb;YACD,kBAAkB,EAAE,CAAC;SACxB;QAED,qGAAqG;QACrG,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,oEAAoE;YACpE,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAG,CAAC;YAC7C,IAAI,CAAC,YAAY,CAAC,QAAQ,CACtB,OAAO,CAAC,WAAW,EACnB,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,eAAe,EACvB,OAAO,CAAC,UAAU,CAAC,CAAC;SAC3B;IACL,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 Deque from \"double-ended-queue\";\nimport { ContainerMessageType } from \"./containerRuntime\";\nimport { pkgVersion } from \"./packageVersion\";\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 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 | 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    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    orderSequentially(callback: () => void): 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 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    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        initialLocalState: IPendingLocalState | undefined,\n    ) {\n        this.initialStates = new Deque<IPendingState>(initialLocalState?.pendingStates ?? []);\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 flush() is called on the ContainerRuntime to manually flush messages.\n     */\n    public onFlush() {\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            const firstPendingState = this.initialStates.shift()!;\n            this.pendingStates.push(firstPendingState);\n            if (firstPendingState.type === \"message\") {\n                this._pendingMessagesCount++;\n            }\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        assert(this._pendingMessagesCount >= 0, 0x3d6 /* positive */);\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        /**\n         * We are checking if the next message is the start of a batch. It can happen in the following scenarios:\n         *\n         * 1. The FlushMode was set to TurnBased before this message was sent.\n         *\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        while (this.peekNextPendingState().type !== \"message\") {\n            this.pendingStates.shift();\n        }\n\n        // This message is the first in a batch if the \"batch\" property on the metadata is set to true\n        if (message.metadata?.batch) {\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        // 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            if (batchBeginMetadata !== true || batchEndMetadata !== false) {\n                this.stateHandler.close(DataProcessingError.create(\n                    \"Pending batch inconsistency\", // Formerly known as asserts 0x16f and 0x170\n                    \"processPendingLocalMessage\",\n                    message,\n                    {\n                        runtimeVersion: pkgVersion,\n                        batchClientId: this.pendingBatchBeginMessage.clientId,\n                        clientId: this.stateHandler.clientId(),\n                        hasBatchStart: batchBeginMetadata === true,\n                        hasBatchEnd: batchEndMetadata === false,\n                        messageType: message.type,\n                        batchStartSequenceNumber: this.pendingBatchBeginMessage.clientSequenceNumber,\n                        pendingMessagesCount: this.pendingMessagesCount,\n                        nextPendingState: nextPendingState.type,\n                    }));\n            }\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 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        const messageBatchQueue = new Deque<IPendingMessage>();\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                    assert(pendingState.opMetadata?.batch !== false || messageBatchQueue.length > 0,\n                        0x41b /* We cannot process batches in chunks */);\n                    /**\n                     * We want to ensure grouped messages get processed in a batch.\n                     * Note: It is not possible for the PendingStateManager to receive a partially acked batch. It will\n                     * either receive the whole batch ack or nothing at all.\n                     */\n                    if (messageBatchQueue.length > 0 || pendingState.opMetadata?.batch) {\n                        messageBatchQueue.enqueue(pendingState);\n                    } else {\n                        this.stateHandler.reSubmit(\n                            pendingState.messageType,\n                            pendingState.content,\n                            pendingState.localOpMetadata,\n                            pendingState.opMetadata);\n                    }\n                    break;\n                case \"flush\":\n                    /**\n                     * A \"flush\" call can indicate the end of a batch.\n                     * We can't rely on the \"batch\" property in the message metadata as it gets\n                     * updated elsewhere and it is not the same object instance that gets updated.\n                     */\n                    if (messageBatchQueue.length > 0) {\n                        this.stateHandler.orderSequentially(() => {\n                            while (messageBatchQueue.length > 0) {\n                                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n                                const message = messageBatchQueue.dequeue()!;\n                                this.stateHandler.reSubmit(\n                                    message.messageType,\n                                    message.content,\n                                    message.localOpMetadata,\n                                    message.opMetadata);\n                            }\n                        });\n                    }\n                    assert(messageBatchQueue.length === 0, 0x41c /* cannot flush in the middle of a batch */);\n                    this.stateHandler.flush();\n                    break;\n                default:\n                    break;\n            }\n            pendingStatesCount--;\n        }\n\n        // There are some cases where ops are stashed but not flushed. We need to ensure they are resubmitted\n        while (messageBatchQueue.length > 0) {\n            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n            const message = messageBatchQueue.dequeue()!;\n            this.stateHandler.reSubmit(\n                message.messageType,\n                message.content,\n                message.localOpMetadata,\n                message.opMetadata);\n        }\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;AAEtE,OAAO,KAAK,MAAM,oBAAoB,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAqD9C;;;;;;;;GAQG;AACH,MAAM,OAAO,mBAAmB;IA6C/B,YACkB,YAAkC,EACnD,iBAAiD;;QADhC,iBAAY,GAAZ,YAAY,CAAsB;QA7CnC,oBAAe,GAAG,IAAI,KAAK,EAAmB,CAAC;QAC/C,oBAAe,GAAG,IAAI,KAAK,EAAmB,CAAC;QAC/C,gBAAW,GAAG,IAAI,IAAI,CAAO,GAAG,EAAE;YAClD,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;YAC7B,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAMH,+CAA+C;QACvC,sBAAiB,GAAY,KAAK,CAAC;QAwE3B,YAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QApCtD;;;;;;WAMG;QACH,IAAI,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,aAAa,EAAE;YACrC,MAAM,aAAa,GAAG,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,aAAa,CAAC;YACvD,IAAI,iBAAiB,GAAG,KAAK,CAAC;YAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;gBAEtC,6BAA6B;gBAC7B,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE;oBACpC,IAAI,MAAA,YAAY,CAAC,UAAU,0CAAE,KAAK,EAAE;wBACnC,iBAAiB,GAAG,IAAI,CAAC;qBACzB;yBAAM,IAAI,CAAA,MAAA,YAAY,CAAC,UAAU,0CAAE,KAAK,MAAK,KAAK,EAAE;wBACpD,iBAAiB,GAAG,KAAK,CAAC;qBAC1B;yBAAM;oBACN,8FAA8F;oBAC9F,iBAAiB;wBACjB,CAAC,CAAC,KAAK,aAAa,CAAC,MAAM,GAAG,CAAC,IAAI,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,EACxE;wBACD,iBAAiB,GAAG,KAAK,CAAC;wBAC1B,YAAY,CAAC,UAAU,mCAAQ,YAAY,CAAC,UAAU,KAAE,KAAK,EAAE,KAAK,GAAE,CAAC;qBACvE;oBACD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBACxC;aACD;SACD;IACF,CAAC;IAxED,IAAW,oBAAoB;QAC9B,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;IACpC,CAAC;IAWD;;;OAGG;IACI,kBAAkB;QACxB,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IAC3E,CAAC;IAEM,aAAa;QACnB,MAAM,CACL,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAC9B,KAAK,CAAC,+DAA+D,CACrE,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE;YACpC,OAAO;gBACN,0DAA0D;gBAC1D,8CAA8C;gBAC9C,aAAa,EAAE,IAAI,CAAC,eAAe;qBACjC,OAAO,EAAE;qBACT,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCAAM,OAAO,KAAE,eAAe,EAAE,SAAS,IAAG,CAAC;aAChE,CAAC;SACF;IACF,CAAC;IAuCD,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACnC,CAAC;IAGD;;;;;;OAMG;IACI,eAAe,CACrB,IAA0B,EAC1B,uBAA+B,EAC/B,OAAY,EACZ,eAAwB,EACxB,UAA+C;QAE/C,MAAM,cAAc,GAAoB;YACvC,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,CAAC,CAAC;YACxB,uBAAuB;YACvB,OAAO;YACP,eAAe;YACf,UAAU;SACV,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,MAAe;QAC7C,uCAAuC;QACvC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE;YACvC,oEAAoE;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAG,CAAC;YACtD,IAAI,MAAM,KAAK,SAAS,EAAE;gBACzB,IAAI,WAAW,CAAC,uBAAuB,GAAG,MAAM,EAAE;oBACjD,MAAM,CAAC,6CAA6C;iBACpD;gBACD,IAAI,WAAW,CAAC,uBAAuB,GAAG,MAAM,EAAE;oBACjD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;iBACxE;aACD;YAED,gGAAgG;YAChG,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAC7D,WAAW,CAAC,WAAW,EACvB,WAAW,CAAC,OAAO,CACnB,CAAC;YACF,WAAW,CAAC,eAAe,GAAG,eAAe,CAAC;YAE9C,qGAAqG;YACrG,oEAAoE;YACpE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAG,CAAC,CAAC;SACzD;IACF,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,OAAkC;QACnE,0DAA0D;QAC1D,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAErC,wEAAwE;QACxE,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;QACxD,MAAM,CACL,cAAc,KAAK,SAAS,EAC5B,KAAK,CAAC,wDAAwD,CAC9D,CAAC;QACF,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAE7B,IAAI,cAAc,CAAC,WAAW,KAAK,OAAO,CAAC,IAAI,EAAE;YAChD,mEAAmE;YACnE,IAAI,CAAC,YAAY,CAAC,KAAK,CACtB,mBAAmB,CAAC,MAAM,CACzB,qCAAqC,EACrC,uBAAuB,EACvB,OAAO,EACP;gBACC,mBAAmB,EAAE,cAAc,CAAC,WAAW;aAC/C,CACD,CACD,CAAC;YACF,OAAO;SACP;QAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAExD,qCAAqC;QACrC,IAAI,qBAAqB,KAAK,cAAc,EAAE;YAC7C,mEAAmE;YACnE,IAAI,CAAC,YAAY,CAAC,KAAK,CACtB,mBAAmB,CAAC,MAAM,CACzB,wCAAwC,EACxC,uBAAuB,EACvB,OAAO,CACP,CACD,CAAC;YACF,OAAO;SACP;QAED,wGAAwG;QACxG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,cAAc,CAAC,eAAe,CAAC;IACvC,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,OAAkC;;QAChE,8FAA8F;QAC9F,IAAI,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,EAAE;YAC5B,kGAAkG;YAClG,MAAM,CACL,CAAC,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,wBAAwB,KAAK,SAAS,EACtE,KAAK,CAAC,2EAA2E,CACjF,CAAC;YAEF,6EAA6E;YAC7E,IAAI,CAAC,wBAAwB,GAAG,OAAO,CAAC;YACxC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;SAC9B;IACF,CAAC;IAED;;;OAGG;IACK,oBAAoB,CAAC,OAAkC;;QAC9D,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC5B,OAAO;SACP;QAED,iDAAiD;QACjD,MAAM,CACL,IAAI,CAAC,wBAAwB,KAAK,SAAS,EAC3C,KAAK,CAAC,+CAA+C,CACrD,CAAC;QAEF,MAAM,gBAAgB,GAAG,MAAA,OAAO,CAAC,QAAQ,0CAAE,KAAK,CAAC;QACjD,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,IAAI,gBAAgB,KAAK,KAAK,EAAE;YACjE,oEAAoE;YACpE,MAAM,kBAAkB,GAAG,MAAA,IAAI,CAAC,wBAAwB,CAAC,QAAQ,0CAAE,KAAK,CAAC;YAEzE,4GAA4G;YAC5G,mGAAmG;YACnG,IAAI,IAAI,CAAC,wBAAwB,KAAK,OAAO,EAAE;gBAC9C,MAAM,CACL,kBAAkB,KAAK,SAAS,EAChC,KAAK,CAAC,gEAAgE,CACtE,CAAC;aACF;iBAAM;gBACN,IAAI,kBAAkB,KAAK,IAAI,IAAI,gBAAgB,KAAK,KAAK,EAAE;oBAC9D,IAAI,CAAC,YAAY,CAAC,KAAK,CACtB,mBAAmB,CAAC,MAAM,CACzB,6BAA6B,EAAE,4CAA4C;oBAC3E,4BAA4B,EAC5B,OAAO,EACP;wBACC,cAAc,EAAE,UAAU;wBAC1B,aAAa,EAAE,IAAI,CAAC,wBAAwB,CAAC,QAAQ;wBACrD,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;wBACtC,aAAa,EAAE,kBAAkB,KAAK,IAAI;wBAC1C,WAAW,EAAE,gBAAgB,KAAK,KAAK;wBACvC,WAAW,EAAE,OAAO,CAAC,IAAI;wBACzB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;qBAC/C,CACD,CACD,CAAC;iBACF;aACD;YAED,6EAA6E;YAC7E,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;SAC/B;IACF,CAAC;IAED;;;OAGG;IACI,mBAAmB;;QACzB,MAAM,CACL,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAC7B,KAAK,CAAC,+DAA+D,CACrE,CAAC;QAEF,4FAA4F;QAC5F,MAAM,CACL,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,EAC9C,KAAK,CAAC,2DAA2D,CACjE,CAAC;QACF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAE7C,MAAM,CACL,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,EAC9B,KAAK,CAAC,+DAA+D,CACrE,CAAC;QAEF,IAAI,oBAAoB,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;QACvD,IAAI,oBAAoB,KAAK,CAAC,EAAE;YAC/B,OAAO;SACP;QAED,8GAA8G;QAC9G,0GAA0G;QAC1G,8BAA8B;QAC9B,OAAO,oBAAoB,GAAG,CAAC,EAAE;YAChC,oEAAoE;YACpE,IAAI,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAG,CAAC;YACnD,oBAAoB,EAAE,CAAC;YACvB,MAAM,CACL,CAAA,MAAA,cAAc,CAAC,UAAU,0CAAE,KAAK,MAAK,KAAK,EAC1C,KAAK,CAAC,yCAAyC,CAC/C,CAAC;YAEF;;;;eAIG;YACH,IAAI,MAAA,cAAc,CAAC,UAAU,0CAAE,KAAK,EAAE;gBACrC,MAAM,CACL,oBAAoB,GAAG,CAAC,EACxB,KAAK,CAAC,kDAAkD,CACxD,CAAC;gBAEF,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE;;oBACxC,OAAO,oBAAoB,IAAI,CAAC,EAAE;wBACjC,4DAA4D;wBAC5D,IAAI,CAAC,YAAY,CAAC,QAAQ,CACzB,cAAc,CAAC,WAAW,EAC1B,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,eAAe,EAC9B,cAAc,CAAC,UAAU,CACzB,CAAC;wBAEF,IAAI,CAAA,MAAA,cAAc,CAAC,UAAU,0CAAE,KAAK,MAAK,KAAK,EAAE;4BAC/C,MAAM;yBACN;wBACD,MAAM,CAAC,oBAAoB,GAAG,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;wBAEjE,oEAAoE;wBACpE,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAG,CAAC;wBAC/C,oBAAoB,EAAE,CAAC;wBACvB,MAAM,CACL,CAAA,MAAA,cAAc,CAAC,UAAU,0CAAE,KAAK,MAAK,IAAI,EACzC,KAAK,CAAC,iDAAiD,CACvD,CAAC;qBACF;gBACF,CAAC,CAAC,CAAC;aACH;iBAAM;gBACN,IAAI,CAAC,YAAY,CAAC,QAAQ,CACzB,cAAc,CAAC,WAAW,EAC1B,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,eAAe,EAC9B,cAAc,CAAC,UAAU,CACzB,CAAC;aACF;SACD;IACF,CAAC;CACD","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 { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport Deque from \"double-ended-queue\";\nimport { ContainerMessageType } from \"./containerRuntime\";\nimport { pkgVersion } from \"./packageVersion\";\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\ttype: \"message\";\n\tmessageType: ContainerMessageType;\n\tclientSequenceNumber: number;\n\treferenceSequenceNumber: number;\n\tcontent: any;\n\tlocalOpMetadata: unknown;\n\topMetadata: Record<string, unknown> | undefined;\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 * ! TODO: Remove in \"2.0.0-internal.5.0.0\" AB#2496\n */\nexport interface IPendingFlush {\n\ttype: \"flush\";\n}\n\n/** ! TODO: Remove in \"2.0.0-internal.5.0.0\" AB#2496 */\nexport type IPendingState = IPendingMessage | IPendingFlush;\n\nexport interface IPendingLocalState {\n\t/**\n\t * list of pending states, including ops and batch information\n\t */\n\tpendingStates: IPendingState[];\n}\n\nexport interface IRuntimeStateHandler {\n\tconnected(): boolean;\n\tclientId(): string | undefined;\n\tclose(error?: ICriticalContainerError): void;\n\tapplyStashedOp: (\n\t\ttype: ContainerMessageType,\n\t\tcontent: ISequencedDocumentMessage,\n\t) => Promise<unknown>;\n\treSubmit(\n\t\ttype: ContainerMessageType,\n\t\tcontent: any,\n\t\tlocalOpMetadata: unknown,\n\t\topMetadata: Record<string, unknown> | undefined,\n\t): void;\n\trollback(type: ContainerMessageType, content: any, localOpMetadata: unknown): void;\n\torderSequentially(callback: () => void): 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 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\tprivate readonly pendingMessages = new Deque<IPendingMessage>();\n\tprivate readonly initialMessages = new Deque<IPendingMessage>();\n\tprivate readonly disposeOnce = new Lazy<void>(() => {\n\t\tthis.initialMessages.clear();\n\t\tthis.pendingMessages.clear();\n\t});\n\n\tpublic get pendingMessagesCount(): number {\n\t\treturn this.pendingMessages.length;\n\t}\n\n\t// Indicates whether we are processing a batch.\n\tprivate isProcessingBatch: boolean = false;\n\n\t// This stores the first message in the batch that we are processing. This is used to verify that we get\n\t// the correct batch metadata.\n\tprivate pendingBatchBeginMessage: ISequencedDocumentMessage | undefined;\n\n\tprivate clientId: string | undefined;\n\n\t/**\n\t * Called to check if there are any pending messages in the pending message queue.\n\t * @returns A boolean indicating whether there are messages or not.\n\t */\n\tpublic hasPendingMessages(): boolean {\n\t\treturn !this.pendingMessages.isEmpty() || !this.initialMessages.isEmpty();\n\t}\n\n\tpublic getLocalState(): IPendingLocalState | undefined {\n\t\tassert(\n\t\t\tthis.initialMessages.isEmpty(),\n\t\t\t0x2e9 /* \"Must call getLocalState() after applying initial states\" */,\n\t\t);\n\t\tif (!this.pendingMessages.isEmpty()) {\n\t\t\treturn {\n\t\t\t\t// delete localOpMetadata since it may not be serializable\n\t\t\t\t// and will be regenerated by applyStashedOp()\n\t\t\t\tpendingStates: this.pendingMessages\n\t\t\t\t\t.toArray()\n\t\t\t\t\t.map((message) => ({ ...message, localOpMetadata: undefined })),\n\t\t\t};\n\t\t}\n\t}\n\n\tconstructor(\n\t\tprivate readonly stateHandler: IRuntimeStateHandler,\n\t\tinitialLocalState: IPendingLocalState | undefined,\n\t) {\n\t\t/**\n\t\t * Convert old local state format to the new format\n\t\t * The old format contained \"flush\" messages as the indicator of batch ends\n\t\t * The new format instead uses batch metadata on the last message to indicate batch ends\n\t\t * ! TODO: Remove this conversion in \"2.0.0-internal.5.0.0\" as version from \"2.0.0-internal.4.0.0\" will be new format\n\t\t * AB#2496 tracks removal\n\t\t */\n\t\tif (initialLocalState?.pendingStates) {\n\t\t\tconst pendingStates = initialLocalState?.pendingStates;\n\t\t\tlet currentlyBatching = false;\n\t\t\tfor (let i = 0; i < pendingStates.length; i++) {\n\t\t\t\tconst initialState = pendingStates[i];\n\n\t\t\t\t// Skip over \"flush\" messages\n\t\t\t\tif (initialState.type === \"message\") {\n\t\t\t\t\tif (initialState.opMetadata?.batch) {\n\t\t\t\t\t\tcurrentlyBatching = true;\n\t\t\t\t\t} else if (initialState.opMetadata?.batch === false) {\n\t\t\t\t\t\tcurrentlyBatching = false;\n\t\t\t\t\t} else if (\n\t\t\t\t\t\t// End of batch if we are currently batching and this is last message or next message is flush\n\t\t\t\t\t\tcurrentlyBatching &&\n\t\t\t\t\t\t(i === pendingStates.length - 1 || pendingStates[i + 1].type === \"flush\")\n\t\t\t\t\t) {\n\t\t\t\t\t\tcurrentlyBatching = false;\n\t\t\t\t\t\tinitialState.opMetadata = { ...initialState.opMetadata, batch: false };\n\t\t\t\t\t}\n\t\t\t\t\tthis.initialMessages.push(initialState);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic get disposed() {\n\t\treturn this.disposeOnce.evaluated;\n\t}\n\tpublic readonly dispose = () => this.disposeOnce.value;\n\n\t/**\n\t * Called when a message is submitted locally. Adds the message and the associated details to the pending state\n\t * queue.\n\t * @param type - The container message type.\n\t * @param content - The message content.\n\t * @param localOpMetadata - The local metadata associated with the message.\n\t */\n\tpublic onSubmitMessage(\n\t\ttype: ContainerMessageType,\n\t\treferenceSequenceNumber: number,\n\t\tcontent: any,\n\t\tlocalOpMetadata: unknown,\n\t\topMetadata: Record<string, unknown> | undefined,\n\t) {\n\t\tconst pendingMessage: IPendingMessage = {\n\t\t\ttype: \"message\",\n\t\t\tmessageType: type,\n\t\t\tclientSequenceNumber: -1, // dummy value (not to be used anywhere)\n\t\t\treferenceSequenceNumber,\n\t\t\tcontent,\n\t\t\tlocalOpMetadata,\n\t\t\topMetadata,\n\t\t};\n\n\t\tthis.pendingMessages.push(pendingMessage);\n\t}\n\n\t/**\n\t * Applies stashed ops at their reference sequence number so they are ready to be ACKed or resubmitted\n\t * @param seqNum - Sequence number at which to apply ops. Will apply all ops if seqNum is undefined.\n\t */\n\tpublic async applyStashedOpsAt(seqNum?: number) {\n\t\t// apply stashed ops at sequence number\n\t\twhile (!this.initialMessages.isEmpty()) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tconst nextMessage = this.initialMessages.peekFront()!;\n\t\t\tif (seqNum !== undefined) {\n\t\t\t\tif (nextMessage.referenceSequenceNumber > seqNum) {\n\t\t\t\t\tbreak; // nothing left to do at this sequence number\n\t\t\t\t}\n\t\t\t\tif (nextMessage.referenceSequenceNumber < seqNum) {\n\t\t\t\t\tthrow new Error(\"loaded from snapshot too recent to apply stashed ops\");\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// applyStashedOp will cause the DDS to behave as if it has sent the op but not actually send it\n\t\t\tconst localOpMetadata = await this.stateHandler.applyStashedOp(\n\t\t\t\tnextMessage.messageType,\n\t\t\t\tnextMessage.content,\n\t\t\t);\n\t\t\tnextMessage.localOpMetadata = localOpMetadata;\n\n\t\t\t// then we push onto pendingMessages which will cause PendingStateManager to resubmit when we connect\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tthis.pendingMessages.push(this.initialMessages.shift()!);\n\t\t}\n\t}\n\n\t/**\n\t * Processes a local message once its ack'd by the server. It verifies that there was no data corruption and that\n\t * the batch information was preserved for batch messages.\n\t * @param message - The message that got ack'd and needs to be processed.\n\t */\n\tpublic processPendingLocalMessage(message: ISequencedDocumentMessage): unknown {\n\t\t// Pre-processing part - This may be the start of a batch.\n\t\tthis.maybeProcessBatchBegin(message);\n\n\t\t// Get the next message from the pending queue. Verify a message exists.\n\t\tconst pendingMessage = this.pendingMessages.peekFront();\n\t\tassert(\n\t\t\tpendingMessage !== undefined,\n\t\t\t0x169 /* \"No pending message found for this remote message\" */,\n\t\t);\n\t\tthis.pendingMessages.shift();\n\n\t\tif (pendingMessage.messageType !== message.type) {\n\t\t\t// Close the container because this could indicate data corruption.\n\t\t\tthis.stateHandler.close(\n\t\t\t\tDataProcessingError.create(\n\t\t\t\t\t\"pending local message type mismatch\",\n\t\t\t\t\t\"unexpectedAckReceived\",\n\t\t\t\t\tmessage,\n\t\t\t\t\t{\n\t\t\t\t\t\texpectedMessageType: pendingMessage.messageType,\n\t\t\t\t\t},\n\t\t\t\t),\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\tconst pendingMessageContent = JSON.stringify(pendingMessage.content);\n\t\tconst messageContent = JSON.stringify(message.contents);\n\n\t\t// Stringified content does not match\n\t\tif (pendingMessageContent !== messageContent) {\n\t\t\t// Close the container because this could indicate data corruption.\n\t\t\tthis.stateHandler.close(\n\t\t\t\tDataProcessingError.create(\n\t\t\t\t\t\"pending local message content mismatch\",\n\t\t\t\t\t\"unexpectedAckReceived\",\n\t\t\t\t\tmessage,\n\t\t\t\t),\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\n\t\t// Post-processing part - If we are processing a batch then this could be the last message in the batch.\n\t\tthis.maybeProcessBatchEnd(message);\n\n\t\treturn pendingMessage.localOpMetadata;\n\t}\n\n\t/**\n\t * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.\n\t * @param message - The message that is being processed.\n\t */\n\tprivate maybeProcessBatchBegin(message: ISequencedDocumentMessage) {\n\t\t// This message is the first in a batch if the \"batch\" property on the metadata is set to true\n\t\tif (message.metadata?.batch) {\n\t\t\t// We should not already be processing a batch and there should be no pending batch begin message.\n\t\t\tassert(\n\t\t\t\t!this.isProcessingBatch && this.pendingBatchBeginMessage === undefined,\n\t\t\t\t0x16b /* \"The pending batch state indicates we are already processing a batch\" */,\n\t\t\t);\n\n\t\t\t// Set the pending batch state indicating we have started processing a batch.\n\t\t\tthis.pendingBatchBeginMessage = message;\n\t\t\tthis.isProcessingBatch = true;\n\t\t}\n\t}\n\n\t/**\n\t * This message could be the last message in batch. If so, clear batch state since the batch is complete.\n\t * @param message - The message that is being processed.\n\t */\n\tprivate maybeProcessBatchEnd(message: ISequencedDocumentMessage) {\n\t\tif (!this.isProcessingBatch) {\n\t\t\treturn;\n\t\t}\n\n\t\t// There should be a pending batch begin message.\n\t\tassert(\n\t\t\tthis.pendingBatchBeginMessage !== undefined,\n\t\t\t0x16d /* \"There is no pending batch begin message\" */,\n\t\t);\n\n\t\tconst batchEndMetadata = message.metadata?.batch;\n\t\tif (this.pendingMessages.isEmpty() || batchEndMetadata === false) {\n\t\t\t// Get the batch begin metadata from the first message in the batch.\n\t\t\tconst batchBeginMetadata = this.pendingBatchBeginMessage.metadata?.batch;\n\n\t\t\t// There could be just a single message in the batch. If so, it should not have any batch metadata. If there\n\t\t\t// are multiple messages in the batch, verify that we got the correct batch begin and end metadata.\n\t\t\tif (this.pendingBatchBeginMessage === message) {\n\t\t\t\tassert(\n\t\t\t\t\tbatchBeginMetadata === undefined,\n\t\t\t\t\t0x16e /* \"Batch with single message should not have batch metadata\" */,\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tif (batchBeginMetadata !== true || batchEndMetadata !== false) {\n\t\t\t\t\tthis.stateHandler.close(\n\t\t\t\t\t\tDataProcessingError.create(\n\t\t\t\t\t\t\t\"Pending batch inconsistency\", // Formerly known as asserts 0x16f and 0x170\n\t\t\t\t\t\t\t\"processPendingLocalMessage\",\n\t\t\t\t\t\t\tmessage,\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\truntimeVersion: pkgVersion,\n\t\t\t\t\t\t\t\tbatchClientId: this.pendingBatchBeginMessage.clientId,\n\t\t\t\t\t\t\t\tclientId: this.stateHandler.clientId(),\n\t\t\t\t\t\t\t\thasBatchStart: batchBeginMetadata === true,\n\t\t\t\t\t\t\t\thasBatchEnd: batchEndMetadata === false,\n\t\t\t\t\t\t\t\tmessageType: message.type,\n\t\t\t\t\t\t\t\tpendingMessagesCount: this.pendingMessagesCount,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t),\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Clear the pending batch state now that we have processed the entire batch.\n\t\t\tthis.pendingBatchBeginMessage = undefined;\n\t\t\tthis.isProcessingBatch = false;\n\t\t}\n\t}\n\n\t/**\n\t * Called when the Container's connection state changes. If the Container gets connected, it replays all the pending\n\t * states in its queue. This includes triggering resubmission of unacked ops.\n\t */\n\tpublic replayPendingStates() {\n\t\tassert(\n\t\t\tthis.stateHandler.connected(),\n\t\t\t0x172 /* \"The connection state is not consistent with the runtime\" */,\n\t\t);\n\n\t\t// This assert suggests we are about to send same ops twice, which will result in data loss.\n\t\tassert(\n\t\t\tthis.clientId !== this.stateHandler.clientId(),\n\t\t\t0x173 /* \"replayPendingStates called twice for same clientId!\" */,\n\t\t);\n\t\tthis.clientId = this.stateHandler.clientId();\n\n\t\tassert(\n\t\t\tthis.initialMessages.isEmpty(),\n\t\t\t0x174 /* \"initial states should be empty before replaying pending\" */,\n\t\t);\n\n\t\tlet pendingMessagesCount = this.pendingMessages.length;\n\t\tif (pendingMessagesCount === 0) {\n\t\t\treturn;\n\t\t}\n\n\t\t// Process exactly `pendingMessagesCount` items in the queue as it represents the number of messages that were\n\t\t// pending when we connected. This is important because the `reSubmitFn` might add more items in the queue\n\t\t// which must not be replayed.\n\t\twhile (pendingMessagesCount > 0) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tlet pendingMessage = this.pendingMessages.shift()!;\n\t\t\tpendingMessagesCount--;\n\t\t\tassert(\n\t\t\t\tpendingMessage.opMetadata?.batch !== false,\n\t\t\t\t0x41b /* We cannot process batches in chunks */,\n\t\t\t);\n\n\t\t\t/**\n\t\t\t * We want to ensure grouped messages get processed in a batch.\n\t\t\t * Note: It is not possible for the PendingStateManager to receive a partially acked batch. It will\n\t\t\t * either receive the whole batch ack or nothing at all.\n\t\t\t */\n\t\t\tif (pendingMessage.opMetadata?.batch) {\n\t\t\t\tassert(\n\t\t\t\t\tpendingMessagesCount > 0,\n\t\t\t\t\t0x554 /* Last pending message cannot be a batch begin */,\n\t\t\t\t);\n\n\t\t\t\tthis.stateHandler.orderSequentially(() => {\n\t\t\t\t\twhile (pendingMessagesCount >= 0) {\n\t\t\t\t\t\t// check is >= because batch end may be last pending message\n\t\t\t\t\t\tthis.stateHandler.reSubmit(\n\t\t\t\t\t\t\tpendingMessage.messageType,\n\t\t\t\t\t\t\tpendingMessage.content,\n\t\t\t\t\t\t\tpendingMessage.localOpMetadata,\n\t\t\t\t\t\t\tpendingMessage.opMetadata,\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\tif (pendingMessage.opMetadata?.batch === false) {\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tassert(pendingMessagesCount > 0, 0x555 /* No batch end found */);\n\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\t\tpendingMessage = this.pendingMessages.shift()!;\n\t\t\t\t\t\tpendingMessagesCount--;\n\t\t\t\t\t\tassert(\n\t\t\t\t\t\t\tpendingMessage.opMetadata?.batch !== true,\n\t\t\t\t\t\t\t0x556 /* Batch start needs a corresponding batch end */,\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tthis.stateHandler.reSubmit(\n\t\t\t\t\tpendingMessage.messageType,\n\t\t\t\t\tpendingMessage.content,\n\t\t\t\t\tpendingMessage.localOpMetadata,\n\t\t\t\t\tpendingMessage.opMetadata,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/lib/scheduleManager.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /*!
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.

package/lib/scheduleManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scheduleManager.d.ts","sourceRoot":"","sources":["../src/scheduleManager.ts"],"names":[],"mappings":";AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAiBtE;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAMpB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,MAAM,GAAG,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IAR3B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,QAAQ,CAAS;gBAGJ,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,OAAO,EAAE,YAAY,EAC7B,WAAW,EAAE,MAAM,MAAM,GAAG,SAAS,EAC7B,MAAM,EAAE,gBAAgB;IAStC,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;IAcrD,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,SAAS,EAAE,OAAO,EAAE,yBAAyB;CAwBtF"}
+{"version":3,"file":"scheduleManager.d.ts","sourceRoot":"","sources":["../src/scheduleManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAkBtE;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAM1B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,MAAM,GAAG,SAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM;IARxB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,QAAQ,CAAS;gBAGP,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,EACxE,OAAO,EAAE,YAAY,EAC7B,WAAW,EAAE,MAAM,MAAM,GAAG,SAAS,EAC7B,MAAM,EAAE,gBAAgB;IASnC,kBAAkB,CAAC,OAAO,EAAE,yBAAyB;IAgBrD,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,SAAS,EAAE,OAAO,EAAE,yBAAyB;CAwBnF"}

package/lib/scheduleManager.js

@@ -4,7 +4,6 @@ import { isRuntimeMessage } from "@fluidframework/driver-utils";
 import { DataCorruptionError, DataProcessingError, extractSafePropertiesFromMessage, } from "@fluidframework/container-utils";
 import { DeltaScheduler } from "./deltaScheduler";
 import { pkgVersion } from "./packageVersion";
-import { latencyThreshold } from "./connectionTelemetry";
 /**
  * This class has the following responsibilities:
  *
@@ -139,7 +138,7 @@ class ScheduleManagerCore {
     }
     resumeQueue(startBatch, messageEndBatch) {
         const endBatch = messageEndBatch.sequenceNumber;
-        const duration = this.localPaused ? (performance.now() - this.timePaused) : undefined;
+        const duration = this.localPaused ? performance.now() - this.timePaused : undefined;
         this.batchCount++;
         if (this.batchCount % 1000 === 1) {
             this.logger.sendTelemetryEvent({
@@ -157,15 +156,6 @@ class ScheduleManagerCore {
             return;
         }
         this.localPaused = false;
-        // Random round number - we want to know when batch waiting paused op processing.
-        if (duration !== undefined && duration > latencyThreshold) {
-            this.logger.sendErrorEvent({
-                eventName: "MaxBatchWaitTimeExceeded",
-                duration,
-                sequenceNumber: endBatch,
-                length: endBatch - startBatch,
-            });
-        }
         this.deltaManager.inbound.resume();
     }
     /**
@@ -175,6 +165,8 @@ class ScheduleManagerCore {
         assert(this.deltaManager.inbound.length !== 0, 0x298 /* "we have something in the queue that generates this event" */);
         assert((this.currentBatchClientId === undefined) === (this.pauseSequenceNumber === undefined), 0x299 /* "non-synchronized state" */);
         const metadata = message.metadata;
+        // batchMetadata will be true for the message that starts a batch, false for the one that ends it, and
+        // undefined for all other messages.
         const batchMetadata = metadata === null || metadata === void 0 ? void 0 : metadata.batch;
         // Protocol messages are never part of a runtime batch of messages
         if (!isRuntimeMessage(message)) {
@@ -197,20 +189,18 @@ class ScheduleManagerCore {
             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 DataCorruptionError("OpBatchIncomplete", Object.assign({ runtimeVersion: pkgVersion, batchClientId: this.currentBatchClientId, pauseSequenceNumber: this.pauseSequenceNumber, localBatch: this.currentBatchClientId === this.getClientId(), localMessage: message.clientId === this.getClientId() }, extractSafePropertiesFromMessage(message)));
-            }
+        // If we got here, the message is part of a batch. Either starting, in progress, or ending.
+        // If this is not the start of the batch, error out if the message was sent by a client other than the one that
+        // started the current batch (it should not be possible for ops from other clients to get interleaved with a batch).
+        if (this.currentBatchClientId !== undefined &&
+            this.currentBatchClientId !== message.clientId) {
+            throw new DataCorruptionError("OpBatchIncomplete", Object.assign({ runtimeVersion: pkgVersion, batchClientId: this.currentBatchClientId, pauseSequenceNumber: this.pauseSequenceNumber, localBatch: this.currentBatchClientId === this.getClientId(), localMessage: message.clientId === this.getClientId() }, 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)
+        //    - here, when queue was empty and start of batch showed up (batchMetadata === true below).
+        // 2. resumed when batch end comes in (batchMetadata === false below)
         if (batchMetadata) {
             assert(this.currentBatchClientId === undefined, 0x29e /* "there can't be active batch" */);
             assert(!this.localPaused, 0x29f /* "we should be processing ops when there is no active batch" */);