@fluidframework/container-runtime 2.1.0-276326 → 2.1.0-281041

package/lib/opLifecycle/remoteMessageProcessor.js

@@ -2,8 +2,10 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import { assert } from "@fluidframework/core-utils/internal";
 import { MessageType, } from "@fluidframework/driver-definitions/internal";
 import { ContainerMessageType, } from "../messageTypes.js";
+import { asBatchMetadata } from "../metadata.js";
 import { isGroupedBatch } from "./opGroupingManager.js";
 import { isChunkedMessage } from "./opSplitter.js";
 /**
@@ -17,6 +19,7 @@ export class RemoteMessageProcessor {
         this.opSplitter = opSplitter;
         this.opDecompressor = opDecompressor;
         this.opGroupingManager = opGroupingManager;
+        this.processorBatch = [];
     }
     get partialMessages() {
         return this.opSplitter.chunks;
@@ -25,7 +28,7 @@ export class RemoteMessageProcessor {
         this.opSplitter.clearPartialChunks(clientId);
     }
     /**
-     * Ungroups and Unchunks the runtime ops encapsulated by the single remoteMessage received over the wire
+     * Ungroups and Unchunks the runtime ops of a batch received over the wire
      * @param remoteMessageCopy - A shallow copy of a message from another client, possibly virtualized
      * (grouped, compressed, and/or chunked).
      * Being a shallow copy, it's considered mutable, meaning no other Container or other parallel procedure
@@ -40,9 +43,8 @@ export class RemoteMessageProcessor {
      * 3. If grouped, ungroup the message
      * For more details, see https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/src/opLifecycle/README.md#inbound
      *
-     * @returns the unchunked, decompressed, ungrouped, unpacked SequencedContainerRuntimeMessages encapsulated in the remote message.
-     * For ops that weren't virtualized (e.g. System ops that the ContainerRuntime will ultimately ignore),
-     * a singleton array [remoteMessageCopy] is returned
+     * @returns all the unchunked, decompressed, ungrouped, unpacked InboundSequencedContainerRuntimeMessage from a single batch
+     * or undefined if the batch is not yet complete.
      */
     process(remoteMessageCopy) {
         let message = remoteMessageCopy;
@@ -51,7 +53,7 @@ export class RemoteMessageProcessor {
             const chunkProcessingResult = this.opSplitter.processChunk(message);
             // Only continue further if current chunk is the final chunk
             if (!chunkProcessingResult.isFinalChunk) {
-                return [];
+                return;
             }
             // This message will always be compressed
             message = chunkProcessingResult.message;
@@ -67,11 +69,59 @@ export class RemoteMessageProcessor {
             }
         }
         if (isGroupedBatch(message)) {
-            return this.opGroupingManager.ungroupOp(message).map(unpack);
+            // We should be awaiting a new batch (batchStartCsn undefined)
+            assert(this.batchStartCsn === undefined, "Grouped batch interrupting another batch");
+            assert(this.processorBatch.length === 0, "Processor batch should be empty on grouped batch");
+            return {
+                messages: this.opGroupingManager.ungroupOp(message).map(unpack),
+                batchStartCsn: message.clientSequenceNumber,
+            };
         }
+        const batchStartCsn = this.getAndUpdateBatchStartCsn(message);
         // Do a final unpack of runtime messages in case the message was not grouped, compressed, or chunked
         unpackRuntimeMessage(message);
-        return [message];
+        this.processorBatch.push(message);
+        // this.batchStartCsn is undefined only if we have processed all messages in the batch.
+        // If it's still defined, we're still in the middle of a batch, so we return nothing, letting
+        // containerRuntime know that we're waiting for more messages to complete the batch.
+        if (this.batchStartCsn !== undefined) {
+            // batch not yet complete
+            return undefined;
+        }
+        const messages = [...this.processorBatch];
+        this.processorBatch.length = 0;
+        return {
+            messages,
+            batchStartCsn,
+        };
+    }
+    /**
+     * Based on pre-existing batch tracking info and the current message's batch metadata,
+     * this will return the starting CSN for this message's batch, and will also update
+     * the batch tracking info (this.batchStartCsn) based on whether we're still mid-batch.
+     */
+    getAndUpdateBatchStartCsn(message) {
+        const batchMetadataFlag = asBatchMetadata(message.metadata)?.batch;
+        if (this.batchStartCsn === undefined) {
+            // We are waiting for a new batch
+            assert(batchMetadataFlag !== false, "Unexpected batch end marker");
+            // Start of a new multi-message batch
+            if (batchMetadataFlag === true) {
+                this.batchStartCsn = message.clientSequenceNumber;
+                return this.batchStartCsn;
+            }
+            // Single-message batch (Since metadata flag is undefined)
+            // IMPORTANT: Leave this.batchStartCsn undefined, we're ready for the next batch now.
+            return message.clientSequenceNumber;
+        }
+        // We are in the middle or end of an existing multi-message batch. Return the current batchStartCsn
+        const batchStartCsn = this.batchStartCsn;
+        assert(batchMetadataFlag !== true, "Unexpected batch start marker");
+        if (batchMetadataFlag === false) {
+            // Batch end? Then get ready for the next batch to start
+            this.batchStartCsn = undefined;
+        }
+        return batchStartCsn;
     }
 }
 /** Takes an incoming message and if the contents is a string, JSON.parse's it in place */

package/lib/opLifecycle/remoteMessageProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"remoteMessageProcessor.js","sourceRoot":"","sources":["../../src/opLifecycle/remoteMessageProcessor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,WAAW,GAEX,MAAM,6CAA6C,CAAC;AAErD,OAAO,EACN,oBAAoB,GAKpB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAqB,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAc,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,OAAO,sBAAsB;IAClC,YACkB,UAAsB,EACtB,cAA8B,EAC9B,iBAAoC;QAFpC,eAAU,GAAV,UAAU,CAAY;QACtB,mBAAc,GAAd,cAAc,CAAgB;QAC9B,sBAAiB,GAAjB,iBAAiB,CAAmB;IACnD,CAAC;IAEJ,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAC/B,CAAC;IAEM,uBAAuB,CAAC,QAAgB;QAC9C,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,OAAO,CACb,iBAA4C;QAE5C,IAAI,OAAO,GAAG,iBAAiB,CAAC;QAChC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAEpC,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACpE,4DAA4D;YAC5D,IAAI,CAAC,qBAAqB,CAAC,YAAY,EAAE,CAAC;gBACzC,OAAO,EAAE,CAAC;YACX,CAAC;YACD,yCAAyC;YACzC,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC;QACzC,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;YAC5C,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9C,uDAAuD;YACvD,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,OAAO,CAAC,CAAC;YACjB,CAAC;QACF,CAAC;QAED,IAAI,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9D,CAAC;QAED,oGAAoG;QACpG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,OAAiE,CAAC,CAAC;IAC5E,CAAC;CACD;AAED,0FAA0F;AAC1F,SAAS,0BAA0B,CAAC,cAAyC;IAC5E,iGAAiG;IACjG,+GAA+G;IAC/G,qDAAqD;IACrD,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;QACnF,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,MAAM,CAAC,OAAkC;IACjD,wFAAwF;IACxF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAA0C,CAAC;IAEpE,uGAAuG;IACvG,MAAM,eAAe,GAAG,OAAkD,CAAC;IAE3E,eAAe,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IACrC,eAAe,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAC7C,IAAI,eAAe,IAAI,QAAQ,EAAE,CAAC;QAChC,eAAwE,CAAC,aAAa;YACtF,QAAQ,CAAC,aAAa,CAAC;IACzB,CAAC;IACD,OAAO,eAAe,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAkC;IACtE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;QAC5C,8CAA8C;QAC9C,sDAAsD;QACtD,+BAA+B;QAC/B,8BAA8B;QAC9B,OAAO,KAAK,CAAC;IACd,CAAC;IAED,oBAAoB;IACpB,gJAAgJ;IAChJ,IACE,OAAO,CAAC,QAAkC,CAAC,OAAO,KAAK,SAAS;QAChE,OAAO,CAAC,QAA+B,CAAC,IAAI,KAAK,SAAS,EAC1D,CAAC;QACF,OAAO,CAAC,IAAI,GAAG,oBAAoB,CAAC,gBAAgB,CAAC;IACtD,CAAC;SAAM,CAAC;QACP,aAAa;QACb,MAAM,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tMessageType,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\nimport {\n\tContainerMessageType,\n\ttype InboundContainerRuntimeMessage,\n\ttype InboundSequencedContainerRuntimeMessage,\n\ttype InboundSequencedContainerRuntimeMessageOrSystemMessage,\n\ttype InboundSequencedRecentlyAddedContainerRuntimeMessage,\n} from \"../messageTypes.js\";\n\nimport { OpDecompressor } from \"./opDecompressor.js\";\nimport { OpGroupingManager, isGroupedBatch } from \"./opGroupingManager.js\";\nimport { OpSplitter, isChunkedMessage } from \"./opSplitter.js\";\n\n/**\n * Stateful class for processing incoming remote messages as the virtualization measures are unwrapped,\n * potentially across numerous inbound ops.\n *\n * @internal\n */\nexport class RemoteMessageProcessor {\n\tconstructor(\n\t\tprivate readonly opSplitter: OpSplitter,\n\t\tprivate readonly opDecompressor: OpDecompressor,\n\t\tprivate readonly opGroupingManager: OpGroupingManager,\n\t) {}\n\n\tpublic get partialMessages(): ReadonlyMap<string, string[]> {\n\t\treturn this.opSplitter.chunks;\n\t}\n\n\tpublic clearPartialMessagesFor(clientId: string) {\n\t\tthis.opSplitter.clearPartialChunks(clientId);\n\t}\n\n\t/**\n\t * Ungroups and Unchunks the runtime ops encapsulated by the single remoteMessage received over the wire\n\t * @param remoteMessageCopy - A shallow copy of a message from another client, possibly virtualized\n\t * (grouped, compressed, and/or chunked).\n\t * Being a shallow copy, it's considered mutable, meaning no other Container or other parallel procedure\n\t * depends on this object instance.\n\t * Note remoteMessageCopy.contents (and other object props) MUST not be modified,\n\t * but may be overwritten (as is the case with contents).\n\t *\n\t * Incoming messages will always have compression, chunking, and grouped batching happen in a defined order and that order cannot be changed.\n\t * When processing these messages, the order is:\n\t * 1. If chunked, process the chunk and only continue if this is a final chunk\n\t * 2. If compressed, decompress the message and store for further unrolling of the decompressed content\n\t * 3. If grouped, ungroup the message\n\t * For more details, see https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/src/opLifecycle/README.md#inbound\n\t *\n\t * @returns the unchunked, decompressed, ungrouped, unpacked SequencedContainerRuntimeMessages encapsulated in the remote message.\n\t * For ops that weren't virtualized (e.g. System ops that the ContainerRuntime will ultimately ignore),\n\t * a singleton array [remoteMessageCopy] is returned\n\t */\n\tpublic process(\n\t\tremoteMessageCopy: ISequencedDocumentMessage,\n\t): InboundSequencedContainerRuntimeMessageOrSystemMessage[] {\n\t\tlet message = remoteMessageCopy;\n\t\tensureContentsDeserialized(message);\n\n\t\tif (isChunkedMessage(message)) {\n\t\t\tconst chunkProcessingResult = this.opSplitter.processChunk(message);\n\t\t\t// Only continue further if current chunk is the final chunk\n\t\t\tif (!chunkProcessingResult.isFinalChunk) {\n\t\t\t\treturn [];\n\t\t\t}\n\t\t\t// This message will always be compressed\n\t\t\tmessage = chunkProcessingResult.message;\n\t\t}\n\n\t\tif (this.opDecompressor.isCompressedMessage(message)) {\n\t\t\tthis.opDecompressor.decompressAndStore(message);\n\t\t}\n\n\t\tif (this.opDecompressor.currentlyUnrolling) {\n\t\t\tmessage = this.opDecompressor.unroll(message);\n\t\t\t// Need to unpack after unrolling if not a groupedBatch\n\t\t\tif (!isGroupedBatch(message)) {\n\t\t\t\tunpack(message);\n\t\t\t}\n\t\t}\n\n\t\tif (isGroupedBatch(message)) {\n\t\t\treturn this.opGroupingManager.ungroupOp(message).map(unpack);\n\t\t}\n\n\t\t// Do a final unpack of runtime messages in case the message was not grouped, compressed, or chunked\n\t\tunpackRuntimeMessage(message);\n\t\treturn [message as InboundSequencedContainerRuntimeMessageOrSystemMessage];\n\t}\n}\n\n/** Takes an incoming message and if the contents is a string, JSON.parse's it in place */\nfunction ensureContentsDeserialized(mutableMessage: ISequencedDocumentMessage): void {\n\t// back-compat: ADO #1385: eventually should become unconditional, but only for runtime messages!\n\t// System message may have no contents, or in some cases (mostly for back-compat) they may have actual objects.\n\t// Old ops may contain empty string (I assume noops).\n\tif (typeof mutableMessage.contents === \"string\" && mutableMessage.contents !== \"\") {\n\t\tmutableMessage.contents = JSON.parse(mutableMessage.contents);\n\t}\n}\n\n/**\n * For a given message, it moves the nested InboundContainerRuntimeMessage props one level up.\n *\n * The return type illustrates the assumption that the message param\n * becomes a InboundSequencedContainerRuntimeMessage by the time the function returns\n * (but there is no runtime validation of the 'type' or 'compatDetails' values).\n */\nfunction unpack(message: ISequencedDocumentMessage): InboundSequencedContainerRuntimeMessage {\n\t// We assume the contents is an InboundContainerRuntimeMessage (the message is \"packed\")\n\tconst contents = message.contents as InboundContainerRuntimeMessage;\n\n\t// We're going to unpack message in-place (promoting those properties of contents up to message itself)\n\tconst messageUnpacked = message as InboundSequencedContainerRuntimeMessage;\n\n\tmessageUnpacked.type = contents.type;\n\tmessageUnpacked.contents = contents.contents;\n\tif (\"compatDetails\" in contents) {\n\t\t(messageUnpacked as InboundSequencedRecentlyAddedContainerRuntimeMessage).compatDetails =\n\t\t\tcontents.compatDetails;\n\t}\n\treturn messageUnpacked;\n}\n\n/**\n * Unpacks runtime messages.\n *\n * @remarks This API makes no promises regarding backward-compatibility. This is internal API.\n * @param message - message (as it observed in storage / service)\n * @returns whether the given message was unpacked\n *\n * @internal\n */\nexport function unpackRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n\tif (message.type !== MessageType.Operation) {\n\t\t// Legacy format, but it's already \"unpacked\",\n\t\t// i.e. message.type is actually ContainerMessageType.\n\t\t// Or it's non-runtime message.\n\t\t// Nothing to do in such case.\n\t\treturn false;\n\t}\n\n\t// legacy op format?\n\t// TODO: Unsure if this is a real format we should be concerned with. There doesn't appear to be anything prepared to handle the address member.\n\tif (\n\t\t(message.contents as { address?: unknown }).address !== undefined &&\n\t\t(message.contents as { type?: unknown }).type === undefined\n\t) {\n\t\tmessage.type = ContainerMessageType.FluidDataStoreOp;\n\t} else {\n\t\t// new format\n\t\tunpack(message);\n\t}\n\n\treturn true;\n}\n"]}
+{"version":3,"file":"remoteMessageProcessor.js","sourceRoot":"","sources":["../../src/opLifecycle/remoteMessageProcessor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACN,WAAW,GAEX,MAAM,6CAA6C,CAAC;AAErD,OAAO,EACN,oBAAoB,GAIpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjD,OAAO,EAAqB,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAc,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,OAAO,sBAAsB;IAUlC,YACkB,UAAsB,EACtB,cAA8B,EAC9B,iBAAoC;QAFpC,eAAU,GAAV,UAAU,CAAY;QACtB,mBAAc,GAAd,cAAc,CAAgB;QAC9B,sBAAiB,GAAjB,iBAAiB,CAAmB;QALrC,mBAAc,GAA8C,EAAE,CAAC;IAM7E,CAAC;IAEJ,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAC/B,CAAC;IAEM,uBAAuB,CAAC,QAAgB;QAC9C,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,OAAO,CAAC,iBAA4C;QAM1D,IAAI,OAAO,GAAG,iBAAiB,CAAC;QAEhC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAEpC,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;YACpE,4DAA4D;YAC5D,IAAI,CAAC,qBAAqB,CAAC,YAAY,EAAE,CAAC;gBACzC,OAAO;YACR,CAAC;YACD,yCAAyC;YACzC,OAAO,GAAG,qBAAqB,CAAC,OAAO,CAAC;QACzC,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,CAAC;YAC5C,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC9C,uDAAuD;YACvD,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,OAAO,CAAC,CAAC;YACjB,CAAC;QACF,CAAC;QAED,IAAI,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,8DAA8D;YAC9D,MAAM,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,0CAA0C,CAAC,CAAC;YACrF,MAAM,CACL,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAChC,kDAAkD,CAClD,CAAC;YACF,OAAO;gBACN,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC/D,aAAa,EAAE,OAAO,CAAC,oBAAoB;aAC3C,CAAC;QACH,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAE9D,oGAAoG;QACpG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAkD,CAAC,CAAC;QAE7E,uFAAuF;QACvF,6FAA6F;QAC7F,oFAAoF;QACpF,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACtC,yBAAyB;YACzB,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/B,OAAO;YACN,QAAQ;YACR,aAAa;SACb,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,yBAAyB,CAAC,OAAkC;QACnE,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;QACnE,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YACtC,iCAAiC;YACjC,MAAM,CAAC,iBAAiB,KAAK,KAAK,EAAE,6BAA6B,CAAC,CAAC;YAEnE,qCAAqC;YACrC,IAAI,iBAAiB,KAAK,IAAI,EAAE,CAAC;gBAChC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,oBAAoB,CAAC;gBAClD,OAAO,IAAI,CAAC,aAAa,CAAC;YAC3B,CAAC;YAED,0DAA0D;YAC1D,qFAAqF;YACrF,OAAO,OAAO,CAAC,oBAAoB,CAAC;QACrC,CAAC;QAED,mGAAmG;QACnG,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzC,MAAM,CAAC,iBAAiB,KAAK,IAAI,EAAE,+BAA+B,CAAC,CAAC;QACpE,IAAI,iBAAiB,KAAK,KAAK,EAAE,CAAC;YACjC,wDAAwD;YACxD,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAChC,CAAC;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;CACD;AAED,0FAA0F;AAC1F,SAAS,0BAA0B,CAAC,cAAyC;IAC5E,iGAAiG;IACjG,+GAA+G;IAC/G,qDAAqD;IACrD,IAAI,OAAO,cAAc,CAAC,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;QACnF,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,MAAM,CAAC,OAAkC;IACjD,wFAAwF;IACxF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAA0C,CAAC;IAEpE,uGAAuG;IACvG,MAAM,eAAe,GAAG,OAAkD,CAAC;IAE3E,eAAe,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IACrC,eAAe,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAC7C,IAAI,eAAe,IAAI,QAAQ,EAAE,CAAC;QAChC,eAAwE,CAAC,aAAa;YACtF,QAAQ,CAAC,aAAa,CAAC;IACzB,CAAC;IACD,OAAO,eAAe,CAAC;AACxB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAkC;IACtE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;QAC5C,8CAA8C;QAC9C,sDAAsD;QACtD,+BAA+B;QAC/B,8BAA8B;QAC9B,OAAO,KAAK,CAAC;IACd,CAAC;IAED,oBAAoB;IACpB,gJAAgJ;IAChJ,IACE,OAAO,CAAC,QAAkC,CAAC,OAAO,KAAK,SAAS;QAChE,OAAO,CAAC,QAA+B,CAAC,IAAI,KAAK,SAAS,EAC1D,CAAC;QACF,OAAO,CAAC,IAAI,GAAG,oBAAoB,CAAC,gBAAgB,CAAC;IACtD,CAAC;SAAM,CAAC;QACP,aAAa;QACb,MAAM,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tMessageType,\n\tISequencedDocumentMessage,\n} from \"@fluidframework/driver-definitions/internal\";\n\nimport {\n\tContainerMessageType,\n\ttype InboundContainerRuntimeMessage,\n\ttype InboundSequencedContainerRuntimeMessage,\n\ttype InboundSequencedRecentlyAddedContainerRuntimeMessage,\n} from \"../messageTypes.js\";\nimport { asBatchMetadata } from \"../metadata.js\";\n\nimport { OpDecompressor } from \"./opDecompressor.js\";\nimport { OpGroupingManager, isGroupedBatch } from \"./opGroupingManager.js\";\nimport { OpSplitter, isChunkedMessage } from \"./opSplitter.js\";\n\n/**\n * Stateful class for processing incoming remote messages as the virtualization measures are unwrapped,\n * potentially across numerous inbound ops.\n *\n * @internal\n */\nexport class RemoteMessageProcessor {\n\t/**\n\t * Client Sequence Number of the first message in the current batch being processed.\n\t * If undefined, we are expecting the next message to start a new batch.\n\t *\n\t * @remarks For chunked batches, this is the CSN of the \"representative\" chunk (the final chunk)\n\t */\n\tprivate batchStartCsn: number | undefined;\n\tprivate readonly processorBatch: InboundSequencedContainerRuntimeMessage[] = [];\n\n\tconstructor(\n\t\tprivate readonly opSplitter: OpSplitter,\n\t\tprivate readonly opDecompressor: OpDecompressor,\n\t\tprivate readonly opGroupingManager: OpGroupingManager,\n\t) {}\n\n\tpublic get partialMessages(): ReadonlyMap<string, string[]> {\n\t\treturn this.opSplitter.chunks;\n\t}\n\n\tpublic clearPartialMessagesFor(clientId: string) {\n\t\tthis.opSplitter.clearPartialChunks(clientId);\n\t}\n\n\t/**\n\t * Ungroups and Unchunks the runtime ops of a batch received over the wire\n\t * @param remoteMessageCopy - A shallow copy of a message from another client, possibly virtualized\n\t * (grouped, compressed, and/or chunked).\n\t * Being a shallow copy, it's considered mutable, meaning no other Container or other parallel procedure\n\t * depends on this object instance.\n\t * Note remoteMessageCopy.contents (and other object props) MUST not be modified,\n\t * but may be overwritten (as is the case with contents).\n\t *\n\t * Incoming messages will always have compression, chunking, and grouped batching happen in a defined order and that order cannot be changed.\n\t * When processing these messages, the order is:\n\t * 1. If chunked, process the chunk and only continue if this is a final chunk\n\t * 2. If compressed, decompress the message and store for further unrolling of the decompressed content\n\t * 3. If grouped, ungroup the message\n\t * For more details, see https://github.com/microsoft/FluidFramework/blob/main/packages/runtime/container-runtime/src/opLifecycle/README.md#inbound\n\t *\n\t * @returns all the unchunked, decompressed, ungrouped, unpacked InboundSequencedContainerRuntimeMessage from a single batch\n\t * or undefined if the batch is not yet complete.\n\t */\n\tpublic process(remoteMessageCopy: ISequencedDocumentMessage):\n\t\t| {\n\t\t\t\tmessages: InboundSequencedContainerRuntimeMessage[];\n\t\t\t\tbatchStartCsn: number;\n\t\t  }\n\t\t| undefined {\n\t\tlet message = remoteMessageCopy;\n\n\t\tensureContentsDeserialized(message);\n\n\t\tif (isChunkedMessage(message)) {\n\t\t\tconst chunkProcessingResult = this.opSplitter.processChunk(message);\n\t\t\t// Only continue further if current chunk is the final chunk\n\t\t\tif (!chunkProcessingResult.isFinalChunk) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t\t// This message will always be compressed\n\t\t\tmessage = chunkProcessingResult.message;\n\t\t}\n\n\t\tif (this.opDecompressor.isCompressedMessage(message)) {\n\t\t\tthis.opDecompressor.decompressAndStore(message);\n\t\t}\n\n\t\tif (this.opDecompressor.currentlyUnrolling) {\n\t\t\tmessage = this.opDecompressor.unroll(message);\n\t\t\t// Need to unpack after unrolling if not a groupedBatch\n\t\t\tif (!isGroupedBatch(message)) {\n\t\t\t\tunpack(message);\n\t\t\t}\n\t\t}\n\n\t\tif (isGroupedBatch(message)) {\n\t\t\t// We should be awaiting a new batch (batchStartCsn undefined)\n\t\t\tassert(this.batchStartCsn === undefined, \"Grouped batch interrupting another batch\");\n\t\t\tassert(\n\t\t\t\tthis.processorBatch.length === 0,\n\t\t\t\t\"Processor batch should be empty on grouped batch\",\n\t\t\t);\n\t\t\treturn {\n\t\t\t\tmessages: this.opGroupingManager.ungroupOp(message).map(unpack),\n\t\t\t\tbatchStartCsn: message.clientSequenceNumber,\n\t\t\t};\n\t\t}\n\n\t\tconst batchStartCsn = this.getAndUpdateBatchStartCsn(message);\n\n\t\t// Do a final unpack of runtime messages in case the message was not grouped, compressed, or chunked\n\t\tunpackRuntimeMessage(message);\n\t\tthis.processorBatch.push(message as InboundSequencedContainerRuntimeMessage);\n\n\t\t// this.batchStartCsn is undefined only if we have processed all messages in the batch.\n\t\t// If it's still defined, we're still in the middle of a batch, so we return nothing, letting\n\t\t// containerRuntime know that we're waiting for more messages to complete the batch.\n\t\tif (this.batchStartCsn !== undefined) {\n\t\t\t// batch not yet complete\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst messages = [...this.processorBatch];\n\t\tthis.processorBatch.length = 0;\n\t\treturn {\n\t\t\tmessages,\n\t\t\tbatchStartCsn,\n\t\t};\n\t}\n\n\t/**\n\t * Based on pre-existing batch tracking info and the current message's batch metadata,\n\t * this will return the starting CSN for this message's batch, and will also update\n\t * the batch tracking info (this.batchStartCsn) based on whether we're still mid-batch.\n\t */\n\tprivate getAndUpdateBatchStartCsn(message: ISequencedDocumentMessage): number {\n\t\tconst batchMetadataFlag = asBatchMetadata(message.metadata)?.batch;\n\t\tif (this.batchStartCsn === undefined) {\n\t\t\t// We are waiting for a new batch\n\t\t\tassert(batchMetadataFlag !== false, \"Unexpected batch end marker\");\n\n\t\t\t// Start of a new multi-message batch\n\t\t\tif (batchMetadataFlag === true) {\n\t\t\t\tthis.batchStartCsn = message.clientSequenceNumber;\n\t\t\t\treturn this.batchStartCsn;\n\t\t\t}\n\n\t\t\t// Single-message batch (Since metadata flag is undefined)\n\t\t\t// IMPORTANT: Leave this.batchStartCsn undefined, we're ready for the next batch now.\n\t\t\treturn message.clientSequenceNumber;\n\t\t}\n\n\t\t// We are in the middle or end of an existing multi-message batch. Return the current batchStartCsn\n\t\tconst batchStartCsn = this.batchStartCsn;\n\n\t\tassert(batchMetadataFlag !== true, \"Unexpected batch start marker\");\n\t\tif (batchMetadataFlag === false) {\n\t\t\t// Batch end? Then get ready for the next batch to start\n\t\t\tthis.batchStartCsn = undefined;\n\t\t}\n\n\t\treturn batchStartCsn;\n\t}\n}\n\n/** Takes an incoming message and if the contents is a string, JSON.parse's it in place */\nfunction ensureContentsDeserialized(mutableMessage: ISequencedDocumentMessage): void {\n\t// back-compat: ADO #1385: eventually should become unconditional, but only for runtime messages!\n\t// System message may have no contents, or in some cases (mostly for back-compat) they may have actual objects.\n\t// Old ops may contain empty string (I assume noops).\n\tif (typeof mutableMessage.contents === \"string\" && mutableMessage.contents !== \"\") {\n\t\tmutableMessage.contents = JSON.parse(mutableMessage.contents);\n\t}\n}\n\n/**\n * For a given message, it moves the nested InboundContainerRuntimeMessage props one level up.\n *\n * The return type illustrates the assumption that the message param\n * becomes a InboundSequencedContainerRuntimeMessage by the time the function returns\n * (but there is no runtime validation of the 'type' or 'compatDetails' values).\n */\nfunction unpack(message: ISequencedDocumentMessage): InboundSequencedContainerRuntimeMessage {\n\t// We assume the contents is an InboundContainerRuntimeMessage (the message is \"packed\")\n\tconst contents = message.contents as InboundContainerRuntimeMessage;\n\n\t// We're going to unpack message in-place (promoting those properties of contents up to message itself)\n\tconst messageUnpacked = message as InboundSequencedContainerRuntimeMessage;\n\n\tmessageUnpacked.type = contents.type;\n\tmessageUnpacked.contents = contents.contents;\n\tif (\"compatDetails\" in contents) {\n\t\t(messageUnpacked as InboundSequencedRecentlyAddedContainerRuntimeMessage).compatDetails =\n\t\t\tcontents.compatDetails;\n\t}\n\treturn messageUnpacked;\n}\n\n/**\n * Unpacks runtime messages.\n *\n * @remarks This API makes no promises regarding backward-compatibility. This is internal API.\n * @param message - message (as it observed in storage / service)\n * @returns whether the given message was unpacked\n *\n * @internal\n */\nexport function unpackRuntimeMessage(message: ISequencedDocumentMessage): boolean {\n\tif (message.type !== MessageType.Operation) {\n\t\t// Legacy format, but it's already \"unpacked\",\n\t\t// i.e. message.type is actually ContainerMessageType.\n\t\t// Or it's non-runtime message.\n\t\t// Nothing to do in such case.\n\t\treturn false;\n\t}\n\n\t// legacy op format?\n\t// TODO: Unsure if this is a real format we should be concerned with. There doesn't appear to be anything prepared to handle the address member.\n\tif (\n\t\t(message.contents as { address?: unknown }).address !== undefined &&\n\t\t(message.contents as { type?: unknown }).type === undefined\n\t) {\n\t\tmessage.type = ContainerMessageType.FluidDataStoreOp;\n\t} else {\n\t\t// new format\n\t\tunpack(message);\n\t}\n\n\treturn true;\n}\n"]}

package/lib/packageVersion.d.ts

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

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/container-runtime";
-export const pkgVersion = "2.1.0-276326";
+export const pkgVersion = "2.1.0-281041";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

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

package/lib/pendingStateManager.d.ts

@@ -5,11 +5,13 @@
 import { ICriticalContainerError } from "@fluidframework/container-definitions";
 import { IDisposable } from "@fluidframework/core-interfaces";
 import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
-import { InboundSequencedContainerRuntimeMessage } from "./messageTypes.js";
-import type { BatchMessage } from "./opLifecycle/index.js";
+import { type InboundSequencedContainerRuntimeMessage } from "./messageTypes.js";
+import { BatchId, BatchMessage } from "./opLifecycle/index.js";
 /**
  * This represents a message that has been submitted and is added to the pending queue when `submit` is called on the
  * ContainerRuntime. This message has either not been ack'd by the server or has not been submitted to the server yet.
+ *
+ * @remarks This is the current serialization format for pending local state when a Container is serialized.
  */
 export interface IPendingMessage {
     type: "message";
@@ -18,7 +20,16 @@ export interface IPendingMessage {
     localOpMetadata: unknown;
     opMetadata: Record<string, unknown> | undefined;
     sequenceNumber?: number;
-    batchStartCsn?: number;
+    /** Info needed to compute the batchId on reconnect */
+    batchIdContext: {
+        /** The Batch's original clientId, from when it was first flushed to be submitted */
+        clientId: string;
+        /**
+         * The Batch's original clientSequenceNumber, from when it was first flushed to be submitted
+         *	@remarks A negative value means it was not yet submitted when queued here (e.g. disconnected right before flush fired)
+         */
+        batchStartCsn: number;
+    };
 }
 export interface IPendingLocalState {
     /**
@@ -26,18 +37,14 @@ export interface IPendingLocalState {
      */
     pendingStates: IPendingMessage[];
 }
-export interface IPendingBatchMessage {
-    content: string;
-    localOpMetadata: unknown;
-    opMetadata: Record<string, unknown> | undefined;
-}
+/** Info needed to replay/resubmit a pending message */
+export type PendingMessageResubmitData = Pick<IPendingMessage, "content" | "localOpMetadata" | "opMetadata">;
 export interface IRuntimeStateHandler {
     connected(): boolean;
     clientId(): string | undefined;
     close(error?: ICriticalContainerError): void;
     applyStashedOp(content: string): Promise<unknown>;
-    reSubmit(message: IPendingBatchMessage): void;
-    reSubmitBatch(batch: IPendingBatchMessage[]): void;
+    reSubmitBatch(batch: PendingMessageResubmitData[], batchId: BatchId): void;
     isActiveConnection: () => boolean;
     isAttached: () => boolean;
 }
@@ -53,16 +60,21 @@ export interface IRuntimeStateHandler {
 export declare class PendingStateManager implements IDisposable {
     private readonly stateHandler;
     private readonly logger;
+    /** Messages that will need to be resubmitted if not ack'd before the next reconnection */
     private readonly pendingMessages;
+    /** Messages stashed from a previous container, now being rehydrated. Need to be resubmitted. */
     private readonly initialMessages;
     /**
      * Sequenced local ops that are saved when stashing since pending ops may depend on them
      */
     private savedOps;
+    /** Used to stand in for batchStartCsn for messages that weren't submitted (so no CSN) */
+    private negativeCounter;
     private readonly disposeOnce;
     private isProcessingBatch;
     private pendingBatchBeginMessage;
-    private clientId;
+    /** Used to ensure we don't replay ops on the same connection twice */
+    private clientIdFromLastReplay;
     /**
      * The pending messages count. Includes `pendingMessages` and `initialMessages` to keep in sync with
      * 'hasPendingMessages'.
@@ -80,7 +92,7 @@ export declare class PendingStateManager implements IDisposable {
      */
     hasPendingMessages(): boolean;
     getLocalState(snapshotSequenceNumber?: number): IPendingLocalState;
-    constructor(stateHandler: IRuntimeStateHandler, initialLocalState: IPendingLocalState | undefined, logger: ITelemetryLoggerExt | undefined);
+    constructor(stateHandler: IRuntimeStateHandler, stashedLocalState: IPendingLocalState | undefined, logger: ITelemetryLoggerExt);
     get disposed(): boolean;
     readonly dispose: () => void;
     /**
@@ -96,15 +108,29 @@ export declare class PendingStateManager implements IDisposable {
      * @param seqNum - Sequence number at which to apply ops. Will apply all ops if seqNum is undefined.
      */
     applyStashedOpsAt(seqNum?: number): Promise<void>;
+    /**
+     * Processes the incoming batch from the server. It verifies that messages are received in the right order and
+     * that the batch information is correct.
+     * @param batch - The batch that is being processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch
+     */
+    processPendingLocalBatch(batch: InboundSequencedContainerRuntimeMessage[], batchStartCsn: number): {
+        message: InboundSequencedContainerRuntimeMessage;
+        localOpMetadata: unknown;
+    }[];
     /**
      * 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.
      * @param message - The message that got ack'd and needs to be processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch (assigned during submit)
+     * (not to be confused with message.clientSequenceNumber - the overwritten value in case of grouped batching)
      */
-    processPendingLocalMessage(message: InboundSequencedContainerRuntimeMessage): unknown;
+    private processPendingLocalMessage;
     /**
      * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.
      * @param message - The message that is being processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch (assigned during submit)
+     * @param pendingMessage - The corresponding pendingMessage.
      */
     private maybeProcessBatchBegin;
     /**

package/lib/pendingStateManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pendingStateManager.d.ts","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAG9D,OAAO,EACN,mBAAmB,EAGnB,MAAM,0CAA0C,CAAC;AAGlD,OAAO,EAAE,uCAAuC,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAG3D;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,SAAS,CAAC;IAChB,uBAAuB,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,aAAa,EAAE,eAAe,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAChD;AAED,MAAM,WAAW,oBAAoB;IACpC,SAAS,IAAI,OAAO,CAAC;IACrB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;IAC/B,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAC7C,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC9C,aAAa,CAAC,KAAK,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC;IACnD,kBAAkB,EAAE,MAAM,OAAO,CAAC;IAClC,UAAU,EAAE,MAAM,OAAO,CAAC;CAC1B;AA6BD;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IAiFrD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAlFxB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgC;IAEhE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgC;IAEhE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAyB;IAEzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGzB;IAGH,OAAO,CAAC,iBAAiB,CAAkB;IAI3C,OAAO,CAAC,wBAAwB,CAAwC;IAExE,OAAO,CAAC,QAAQ,CAAqB;IAErC;;;OAGG;IACH,IAAW,oBAAoB,IAAI,MAAM,CAExC;IAED;;;;OAIG;IACH,IAAW,mCAAmC,IAAI,MAAM,GAAG,SAAS,CAEnE;IAED;;;OAGG;IACI,kBAAkB,IAAI,OAAO;IAI7B,aAAa,CAAC,sBAAsB,CAAC,EAAE,MAAM,GAAG,kBAAkB;gBAgCvD,YAAY,EAAE,oBAAoB,EACnD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,EAChC,MAAM,EAAE,mBAAmB,GAAG,SAAS;IAOzD,IAAW,QAAQ,YAElB;IACD,SAAgB,OAAO,aAAgC;IAEvD;;;;;;OAMG;IACI,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS;IAoBnF;;;OAGG;IACU,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM;IAiC9C;;;;OAIG;IACI,0BAA0B,CAChC,OAAO,EAAE,uCAAuC,GAC9C,OAAO;IAqCV;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAwD5B;;;;OAIG;IACI,mBAAmB;CA4F1B"}
+{"version":3,"file":"pendingStateManager.d.ts","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAG9D,OAAO,EACN,mBAAmB,EAInB,MAAM,0CAA0C,CAAC;AAIlD,OAAO,EAAE,KAAK,uCAAuC,EAAE,MAAM,mBAAmB,CAAC;AAEjF,OAAO,EAAE,OAAO,EAAE,YAAY,EAAmB,MAAM,wBAAwB,CAAC;AAGhF;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,SAAS,CAAC;IAChB,uBAAuB,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sDAAsD;IACtD,cAAc,EAAE;QACf,oFAAoF;QACpF,QAAQ,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAcD,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,aAAa,EAAE,eAAe,EAAE,CAAC;CACjC;AAED,uDAAuD;AACvD,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAC5C,eAAe,EACf,SAAS,GAAG,iBAAiB,GAAG,YAAY,CAC5C,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACpC,SAAS,IAAI,OAAO,CAAC;IACrB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;IAC/B,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;IAC7C,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAClD,aAAa,CAAC,KAAK,EAAE,0BAA0B,EAAE,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3E,kBAAkB,EAAE,MAAM,OAAO,CAAC;IAClC,UAAU,EAAE,MAAM,OAAO,CAAC;CAC1B;AA6BD;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IAsFrD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAvFxB,0FAA0F;IAC1F,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgC;IAChE,gGAAgG;IAChG,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyC;IAEzE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAyB;IAEzC,yFAAyF;IACzF,OAAO,CAAC,eAAe,CAAc;IAErC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGzB;IAGH,OAAO,CAAC,iBAAiB,CAAkB;IAI3C,OAAO,CAAC,wBAAwB,CAAwC;IAExE,sEAAsE;IACtE,OAAO,CAAC,sBAAsB,CAAqB;IAEnD;;;OAGG;IACH,IAAW,oBAAoB,IAAI,MAAM,CAExC;IAED;;;;OAIG;IACH,IAAW,mCAAmC,IAAI,MAAM,GAAG,SAAS,CAEnE;IAED;;;OAGG;IACI,kBAAkB,IAAI,OAAO;IAI7B,aAAa,CAAC,sBAAsB,CAAC,EAAE,MAAM,GAAG,kBAAkB;gBAgCvD,YAAY,EAAE,oBAAoB,EACnD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,EAChC,MAAM,EAAE,mBAAmB;IAO7C,IAAW,QAAQ,YAElB;IACD,SAAgB,OAAO,aAAgC;IAEvD;;;;;;OAMG;IACI,YAAY,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,oBAAoB,EAAE,MAAM,GAAG,SAAS;IA+BnF;;;OAGG;IACU,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM;IAkC9C;;;;;OAKG;IACI,wBAAwB,CAC9B,KAAK,EAAE,uCAAuC,EAAE,EAChD,aAAa,EAAE,MAAM,GACnB;QACF,OAAO,EAAE,uCAAuC,CAAC;QACjD,eAAe,EAAE,OAAO,CAAC;KACzB,EAAE;IAOH;;;;;;OAMG;IACH,OAAO,CAAC,0BAA0B;IA0ClC;;;;;OAKG;IACH,OAAO,CAAC,sBAAsB;IAoC9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAwD5B;;;;OAIG;IACI,mBAAmB;CA8G1B"}

package/lib/pendingStateManager.js

@@ -3,8 +3,11 @@
  * Licensed under the MIT License.
  */
 import { assert, Lazy } from "@fluidframework/core-utils/internal";
-import { DataProcessingError, LoggingError, } from "@fluidframework/telemetry-utils/internal";
+import { DataProcessingError, LoggingError, extractSafePropertiesFromMessage, } from "@fluidframework/telemetry-utils/internal";
 import Deque from "double-ended-queue";
+import { v4 as uuid } from "uuid";
+import { asBatchMetadata } from "./metadata.js";
+import { generateBatchId } from "./opLifecycle/index.js";
 import { pkgVersion } from "./packageVersion.js";
 function buildPendingMessageContent(
 // AnyComboFromUnion is needed need to gain access to compatDetails that
@@ -76,16 +79,19 @@ export class PendingStateManager {
             ],
         };
     }
-    constructor(stateHandler, initialLocalState, logger) {
+    constructor(stateHandler, stashedLocalState, logger) {
         this.stateHandler = stateHandler;
         this.logger = logger;
+        /** Messages that will need to be resubmitted if not ack'd before the next reconnection */
         this.pendingMessages = new Deque();
-        // This queue represents already acked messages.
+        /** Messages stashed from a previous container, now being rehydrated. Need to be resubmitted. */
         this.initialMessages = new Deque();
         /**
          * Sequenced local ops that are saved when stashing since pending ops may depend on them
          */
         this.savedOps = [];
+        /** Used to stand in for batchStartCsn for messages that weren't submitted (so no CSN) */
+        this.negativeCounter = -1;
         this.disposeOnce = new Lazy(() => {
             this.initialMessages.clear();
             this.pendingMessages.clear();
@@ -93,8 +99,8 @@ export class PendingStateManager {
         // Indicates whether we are processing a batch.
         this.isProcessingBatch = false;
         this.dispose = () => this.disposeOnce.value;
-        if (initialLocalState?.pendingStates) {
-            this.initialMessages.push(...initialLocalState.pendingStates);
+        if (stashedLocalState?.pendingStates) {
+            this.initialMessages.push(...stashedLocalState.pendingStates);
         }
     }
     get disposed() {
@@ -108,6 +114,14 @@ export class PendingStateManager {
      * or undefined if the batch was not yet sent (e.g. by the time we flushed we lost the connection)
      */
     onFlushBatch(batch, clientSequenceNumber) {
+        // If we're connected this is the client of the current connection,
+        // otherwise it's the clientId that just disconnected
+        // It's only undefined if we've NEVER connected. This is a tight corner case and we can
+        // simply make up a unique ID in this case.
+        const clientId = this.stateHandler.clientId() ?? uuid();
+        // If the batch was not yet sent, we need to assign a unique batchStartCsn
+        // Use a negative number to distinguish these from real CSNs
+        const batchStartCsn = clientSequenceNumber ?? this.negativeCounter--;
         for (const message of batch) {
             const { contents: content = "", referenceSequenceNumber, localOpMetadata, metadata: opMetadata, } = message;
             const pendingMessage = {
@@ -116,7 +130,8 @@ export class PendingStateManager {
                 content,
                 localOpMetadata,
                 opMetadata,
-                batchStartCsn: clientSequenceNumber,
+                // Note: We only need this on the first message.
+                batchIdContext: { clientId, batchStartCsn },
             };
             this.pendingMessages.push(pendingMessage);
         }
@@ -151,6 +166,7 @@ export class PendingStateManager {
                 else {
                     nextMessage.localOpMetadata = localOpMetadata;
                     // then we push onto pendingMessages which will cause PendingStateManager to resubmit when we connect
+                    patchBatchIdContext(nextMessage); // Back compat
                     this.pendingMessages.push(nextMessage);
                 }
             }
@@ -159,17 +175,31 @@ export class PendingStateManager {
             }
         }
     }
+    /**
+     * Processes the incoming batch from the server. It verifies that messages are received in the right order and
+     * that the batch information is correct.
+     * @param batch - The batch that is being processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch
+     */
+    processPendingLocalBatch(batch, batchStartCsn) {
+        return batch.map((message) => ({
+            message,
+            localOpMetadata: this.processPendingLocalMessage(message, batchStartCsn),
+        }));
+    }
     /**
      * 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.
      * @param message - The message that got ack'd and needs to be processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch (assigned during submit)
+     * (not to be confused with message.clientSequenceNumber - the overwritten value in case of grouped batching)
      */
-    processPendingLocalMessage(message) {
-        // Pre-processing part - This may be the start of a batch.
-        this.maybeProcessBatchBegin(message);
+    processPendingLocalMessage(message, batchStartCsn) {
         // 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 may be the start of a batch.
+        this.maybeProcessBatchBegin(message, batchStartCsn, pendingMessage);
         pendingMessage.sequenceNumber = message.sequenceNumber;
         this.savedOps.push(withoutLocalOpMetadata(pendingMessage));
         this.pendingMessages.shift();
@@ -188,8 +218,26 @@ export class PendingStateManager {
     /**
      * This message could be the first message in batch. If so, set batch state marking the beginning of a batch.
      * @param message - The message that is being processed.
+     * @param batchStartCsn - The clientSequenceNumber of the start of this message's batch (assigned during submit)
+     * @param pendingMessage - The corresponding pendingMessage.
      */
-    maybeProcessBatchBegin(message) {
+    maybeProcessBatchBegin(message, batchStartCsn, pendingMessage) {
+        if (!this.isProcessingBatch) {
+            // Expecting the start of a batch (maybe single-message).
+            if (pendingMessage.batchIdContext.batchStartCsn !== batchStartCsn) {
+                this.logger?.sendErrorEvent({
+                    eventName: "BatchClientSequenceNumberMismatch",
+                    details: {
+                        processingBatch: !!this.pendingBatchBeginMessage,
+                        pendingBatchCsn: pendingMessage.batchIdContext.batchStartCsn,
+                        batchStartCsn,
+                        messageBatchMetadata: message.metadata?.batch,
+                        pendingMessageBatchMetadata: pendingMessage.opMetadata?.batch,
+                    },
+                    messageDetails: extractSafePropertiesFromMessage(message),
+                });
+            }
+        }
         // This message is the first in a batch if the "batch" property on the metadata is set to true
         if (message.metadata?.batch) {
             // We should not already be processing a batch and there should be no pending batch begin message.
@@ -249,8 +297,8 @@ export class PendingStateManager {
     replayPendingStates() {
         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.stateHandler.clientId(), 0x173 /* "replayPendingStates called twice for same clientId!" */);
-        this.clientId = this.stateHandler.clientId();
+        assert(this.clientIdFromLastReplay !== this.stateHandler.clientId(), 0x173 /* "replayPendingStates called twice for same clientId!" */);
+        this.clientIdFromLastReplay = this.stateHandler.clientId();
         assert(this.initialMessages.isEmpty(), 0x174 /* "initial states should be empty before replaying pending" */);
         const initialPendingMessagesCount = this.pendingMessages.length;
         let remainingPendingMessagesCount = this.pendingMessages.length;
@@ -261,40 +309,49 @@ export class PendingStateManager {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             let pendingMessage = this.pendingMessages.shift();
             remainingPendingMessagesCount--;
-            assert(pendingMessage.opMetadata?.batch !== false, 0x41b /* We cannot process batches in chunks */);
+            const batchMetadataFlag = asBatchMetadata(pendingMessage.opMetadata)?.batch;
+            assert(batchMetadataFlag !== false, 0x41b /* We cannot process batches in chunks */);
+            // The next message starts a batch (possibly single-message), and we'll need its batchId.
+            // We'll find batchId on this message if it was previously generated.
+            // Otherwise, generate it now - this is the first time resubmitting this batch.
+            const batchId = asBatchMetadata(pendingMessage.opMetadata)?.batchId ??
+                generateBatchId(pendingMessage.batchIdContext.clientId, pendingMessage.batchIdContext.batchStartCsn);
             /**
-             * We want to ensure grouped messages get processed in a batch.
+             * We must preserve the distinct batches on resubmit.
              * 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.
+             * either receive the whole batch ack or nothing at all.  @see ScheduleManager for how this works.
              */
-            if (pendingMessage.opMetadata?.batch) {
-                assert(remainingPendingMessagesCount > 0, 0x554 /* Last pending message cannot be a batch begin */);
-                const batch = [];
-                // check is >= because batch end may be last pending message
-                while (remainingPendingMessagesCount >= 0) {
-                    batch.push({
+            if (batchMetadataFlag === undefined) {
+                // Single-message batch
+                this.stateHandler.reSubmitBatch([
+                    {
                         content: pendingMessage.content,
                         localOpMetadata: pendingMessage.localOpMetadata,
                         opMetadata: pendingMessage.opMetadata,
-                    });
-                    if (pendingMessage.opMetadata?.batch === false) {
-                        break;
-                    }
-                    assert(remainingPendingMessagesCount > 0, 0x555 /* No batch end found */);
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    pendingMessage = this.pendingMessages.shift();
-                    remainingPendingMessagesCount--;
-                    assert(pendingMessage.opMetadata?.batch !== true, 0x556 /* Batch start needs a corresponding batch end */);
-                }
-                this.stateHandler.reSubmitBatch(batch);
+                    },
+                ], batchId);
+                continue;
             }
-            else {
-                this.stateHandler.reSubmit({
+            // else: batchMetadataFlag === true  (It's a typical multi-message batch)
+            assert(remainingPendingMessagesCount > 0, 0x554 /* Last pending message cannot be a batch begin */);
+            const batch = [];
+            // check is >= because batch end may be last pending message
+            while (remainingPendingMessagesCount >= 0) {
+                batch.push({
                     content: pendingMessage.content,
                     localOpMetadata: pendingMessage.localOpMetadata,
                     opMetadata: pendingMessage.opMetadata,
                 });
+                if (pendingMessage.opMetadata?.batch === false) {
+                    break;
+                }
+                assert(remainingPendingMessagesCount > 0, 0x555 /* No batch end found */);
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                pendingMessage = this.pendingMessages.shift();
+                remainingPendingMessagesCount--;
+                assert(pendingMessage.opMetadata?.batch !== true, 0x556 /* Batch start needs a corresponding batch end */);
             }
+            this.stateHandler.reSubmitBatch(batch, batchId);
         }
         // pending ops should no longer depend on previous sequenced local ops after resubmit
         this.savedOps = [];
@@ -310,4 +367,12 @@ export class PendingStateManager {
         }
     }
 }
+/** For back-compat if trying to apply stashed ops that pre-date batchIdContext */
+function patchBatchIdContext(message) {
+    const batchIdContext = message.batchIdContext;
+    if (batchIdContext === undefined) {
+        // Using uuid guarantees uniqueness, retaining existing behavior
+        message.batchIdContext = { clientId: uuid(), batchStartCsn: -1 };
+    }
+}
 //# sourceMappingURL=pendingStateManager.js.map