@fluidframework/container-runtime 2.0.0-dev.5.2.0.169897 → 2.0.0-dev.6.4.0.191258

package/dist/opLifecycle/remoteMessageProcessor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remoteMessageProcessor.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/remoteMessageProcessor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,sBAAsB;IAEjC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;gBAFjB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,EAC9B,iBAAiB,EAAE,iBAAiB;IAGtD,IAAW,eAAe,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAE1D;IAEM,uBAAuB,CAAC,QAAQ,EAAE,MAAM;IAIxC,OAAO,CAAC,aAAa,EAAE,yBAAyB,GAAG,yBAAyB,EAAE;CAgDrF;AA6BD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAkBhF"}
+{"version":3,"file":"remoteMessageProcessor.d.ts","sourceRoot":"","sources":["../../src/opLifecycle/remoteMessageProcessor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAM9F,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,sBAAsB;IAEjC,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;gBAFjB,UAAU,EAAE,UAAU,EACtB,cAAc,EAAE,cAAc,EAC9B,iBAAiB,EAAE,iBAAiB;IAGtD,IAAW,eAAe,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAE1D;IAEM,uBAAuB,CAAC,QAAQ,EAAE,MAAM;IAI/C;;;;OAIG;IACI,OAAO,CAAC,aAAa,EAAE,yBAAyB,GAAG,yBAAyB,EAAE;CAiDrF;AAsCD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAsBhF"}

package/dist/opLifecycle/remoteMessageProcessor.js

@@ -19,12 +19,18 @@ class RemoteMessageProcessor {
     clearPartialMessagesFor(clientId) {
         this.opSplitter.clearPartialChunks(clientId);
     }
+    /**
+     * Ungroups and Unchunks the runtime ops encapsulated by the single remoteMessage received over the wire
+     * @param remoteMessage - A message from another client, likely a chunked/grouped op
+     * @returns the ungrouped, unchunked, unpacked SequencedContainerRuntimeMessage encapsulated in the remote message
+     */
     process(remoteMessage) {
         const result = [];
         // Ungroup before and after decompression for back-compat (cleanup tracked by AB#4371)
         for (const ungroupedMessage of this.opGroupingManager.ungroupOp(copy(remoteMessage))) {
             const message = this.opDecompressor.processMessage(ungroupedMessage).message;
             for (let ungroupedMessage2 of this.opGroupingManager.ungroupOp(message)) {
+                // unpack and unchunk the ungrouped message in place
                 unpackRuntimeMessage(ungroupedMessage2);
                 const chunkProcessingResult = this.opSplitter.processRemoteMessage(ungroupedMessage2);
                 ungroupedMessage2 = chunkProcessingResult.message;
@@ -60,7 +66,7 @@ const copy = (remoteMessage) => {
     // There might be multiple container instances receiving same message
     // We do not need to make deep copy, as each layer will just replace message.content itself,
     // but would not modify contents details
-    const message = Object.assign({}, remoteMessage);
+    const message = { ...remoteMessage };
     // back-compat: ADO #1385: eventually should become unconditional, but only for runtime messages!
     // System message may have no contents, or in some cases (mostly for back-compat) they may have actual objects.
     // Old ops may contain empty string (I assume noops).
@@ -70,20 +76,26 @@ const copy = (remoteMessage) => {
     return message;
 };
 /**
- * For a given message, it moves the nested contents and type on level up.
+ * For a given message, it moves the nested ContainerRuntimeMessage props one level up.
  *
+ * The return type illustrates the assumption that the message param
+ * becomes a ContainerRuntimeMessage by the time the function returns
+ * (but there is no runtime validation of the 'type' or 'compatDetails' values)
  */
-const unpack = (message) => {
+function unpack(message) {
     const innerContents = message.contents;
-    message.type = innerContents.type;
-    message.contents = innerContents.contents;
-};
+    // We're going to turn message into a SequencedContainerRuntimeMessage in-place
+    const sequencedContainerRuntimeMessage = message;
+    sequencedContainerRuntimeMessage.type = innerContents.type;
+    sequencedContainerRuntimeMessage.contents = innerContents.contents;
+    sequencedContainerRuntimeMessage.compatDetails = innerContents.compatDetails;
+}
 /**
  * Unpacks runtime messages.
  *
  * @remarks This API makes no promises regarding backward-compatibility. This is internal API.
  * @param message - message (as it observed in storage / service)
- * @returns unpacked runtime message
+ * @returns whether the given message was unpacked
  *
  * @internal
  */
@@ -96,7 +108,9 @@ function unpackRuntimeMessage(message) {
         return false;
     }
     // legacy op format?
-    if (message.contents.address !== undefined && message.contents.type === undefined) {
+    // 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.
+    if (message.contents.address !== undefined &&
+        message.contents.type === undefined) {
         message.type = containerRuntime_1.ContainerMessageType.FluidDataStoreOp;
     }
     else {

package/dist/opLifecycle/remoteMessageProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"remoteMessageProcessor.js","sourceRoot":"","sources":["../../src/opLifecycle/remoteMessageProcessor.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+EAA8F;AAC9F,0DAAoF;AAKpF,MAAa,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;IAEM,OAAO,CAAC,aAAwC;QACtD,MAAM,MAAM,GAAgC,EAAE,CAAC;QAE/C,sFAAsF;QACtF,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;YACrF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;YAE7E,KAAK,IAAI,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACxE,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;gBAExC,MAAM,qBAAqB,GAC1B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;gBACzD,iBAAiB,GAAG,qBAAqB,CAAC,OAAO,CAAC;gBAClD,IAAI,qBAAqB,CAAC,KAAK,KAAK,WAAW,EAAE;oBAChD,6FAA6F;oBAC7F,0CAA0C;oBAC1C,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBAC/B,SAAS;iBACT;gBAED,sFAAsF;gBACtF,KAAK,MAAM,6BAA6B,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAC3E,iBAAiB,CACjB,EAAE;oBACF,MAAM,0BAA0B,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CACpE,6BAA6B,CAC7B,CAAC;oBAEF,KAAK,MAAM,8BAA8B,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAC5E,0BAA0B,CAAC,OAAO,CAClC,EAAE;wBACF,IAAI,0BAA0B,CAAC,KAAK,KAAK,SAAS,EAAE;4BACnD,8DAA8D;4BAC9D,0CAA0C;4BAC1C,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;4BAC5C,SAAS;yBACT;wBAED,kEAAkE;wBAClE,MAAM,CAAC,8BAA8B,CAAC,CAAC;wBACvC,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;qBAC5C;iBACD;aACD;SACD;QAED,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AA/DD,wDA+DC;AAED,MAAM,IAAI,GAAG,CAAC,aAAwC,EAA6B,EAAE;IACpF,qEAAqE;IACrE,qEAAqE;IACrE,4FAA4F;IAC5F,wCAAwC;IACxC,MAAM,OAAO,qBAAQ,aAAa,CAAE,CAAC;IAErC,iGAAiG;IACjG,+GAA+G;IAC/G,qDAAqD;IACrD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,EAAE,EAAE;QACpE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;KAChD;IAED,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,GAAG,CAAC,OAAkC,EAAE,EAAE;IACrD,MAAM,aAAa,GAAG,OAAO,CAAC,QAAmC,CAAC;IAClE,OAAO,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;IAClC,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,OAAkC;IACtE,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;QAC3C,8CAA8C;QAC9C,sDAAsD;QACtD,+BAA+B;QAC/B,8BAA8B;QAC9B,OAAO,KAAK,CAAC;KACb;IAED,oBAAoB;IACpB,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE;QAClF,OAAO,CAAC,IAAI,GAAG,uCAAoB,CAAC,gBAAgB,CAAC;KACrD;SAAM;QACN,aAAa;QACb,MAAM,CAAC,OAAO,CAAC,CAAC;KAChB;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAlBD,oDAkBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType, ContainerRuntimeMessage } from \"../containerRuntime\";\nimport { OpDecompressor } from \"./opDecompressor\";\nimport { OpGroupingManager } from \"./opGroupingManager\";\nimport { OpSplitter } from \"./opSplitter\";\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\tpublic process(remoteMessage: ISequencedDocumentMessage): ISequencedDocumentMessage[] {\n\t\tconst result: ISequencedDocumentMessage[] = [];\n\n\t\t// Ungroup before and after decompression for back-compat (cleanup tracked by AB#4371)\n\t\tfor (const ungroupedMessage of this.opGroupingManager.ungroupOp(copy(remoteMessage))) {\n\t\t\tconst message = this.opDecompressor.processMessage(ungroupedMessage).message;\n\n\t\t\tfor (let ungroupedMessage2 of this.opGroupingManager.ungroupOp(message)) {\n\t\t\t\tunpackRuntimeMessage(ungroupedMessage2);\n\n\t\t\t\tconst chunkProcessingResult =\n\t\t\t\t\tthis.opSplitter.processRemoteMessage(ungroupedMessage2);\n\t\t\t\tungroupedMessage2 = chunkProcessingResult.message;\n\t\t\t\tif (chunkProcessingResult.state !== \"Processed\") {\n\t\t\t\t\t// If the message is not chunked or if the splitter is still rebuilding the original message,\n\t\t\t\t\t// there is no need to continue processing\n\t\t\t\t\tresult.push(ungroupedMessage2);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Ungroup before and after decompression for back-compat (cleanup tracked by AB#4371)\n\t\t\t\tfor (const ungroupedMessageAfterChunking of this.opGroupingManager.ungroupOp(\n\t\t\t\t\tungroupedMessage2,\n\t\t\t\t)) {\n\t\t\t\t\tconst decompressionAfterChunking = this.opDecompressor.processMessage(\n\t\t\t\t\t\tungroupedMessageAfterChunking,\n\t\t\t\t\t);\n\n\t\t\t\t\tfor (const ungroupedMessageAfterChunking2 of this.opGroupingManager.ungroupOp(\n\t\t\t\t\t\tdecompressionAfterChunking.message,\n\t\t\t\t\t)) {\n\t\t\t\t\t\tif (decompressionAfterChunking.state === \"Skipped\") {\n\t\t\t\t\t\t\t// After chunking, if the original message was not compressed,\n\t\t\t\t\t\t\t// there is no need to continue processing\n\t\t\t\t\t\t\tresult.push(ungroupedMessageAfterChunking2);\n\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// The message needs to be unpacked after chunking + decompression\n\t\t\t\t\t\tunpack(ungroupedMessageAfterChunking2);\n\t\t\t\t\t\tresult.push(ungroupedMessageAfterChunking2);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn result;\n\t}\n}\n\nconst copy = (remoteMessage: ISequencedDocumentMessage): ISequencedDocumentMessage => {\n\t// Do shallow copy of message, as the processing flow will modify it.\n\t// There might be multiple container instances receiving same message\n\t// We do not need to make deep copy, as each layer will just replace message.content itself,\n\t// but would not modify contents details\n\tconst message = { ...remoteMessage };\n\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 message.contents === \"string\" && message.contents !== \"\") {\n\t\tmessage.contents = JSON.parse(message.contents);\n\t}\n\n\treturn message;\n};\n\n/**\n * For a given message, it moves the nested contents and type on level up.\n *\n */\nconst unpack = (message: ISequencedDocumentMessage) => {\n\tconst innerContents = message.contents as ContainerRuntimeMessage;\n\tmessage.type = innerContents.type;\n\tmessage.contents = innerContents.contents;\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 unpacked runtime message\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\tif (message.contents.address !== undefined && message.contents.type === undefined) {\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,+EAA8F;AAC9F,0DAI6B;AAK7B,MAAa,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;;;;OAIG;IACI,OAAO,CAAC,aAAwC;QACtD,MAAM,MAAM,GAAgC,EAAE,CAAC;QAE/C,sFAAsF;QACtF,KAAK,MAAM,gBAAgB,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE;YACrF,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC;YAE7E,KAAK,IAAI,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;gBACxE,oDAAoD;gBACpD,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;gBACxC,MAAM,qBAAqB,GAC1B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;gBACzD,iBAAiB,GAAG,qBAAqB,CAAC,OAAO,CAAC;gBAElD,IAAI,qBAAqB,CAAC,KAAK,KAAK,WAAW,EAAE;oBAChD,6FAA6F;oBAC7F,0CAA0C;oBAC1C,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;oBAC/B,SAAS;iBACT;gBAED,sFAAsF;gBACtF,KAAK,MAAM,6BAA6B,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAC3E,iBAAiB,CACjB,EAAE;oBACF,MAAM,0BAA0B,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CACpE,6BAA6B,CAC7B,CAAC;oBAEF,KAAK,MAAM,8BAA8B,IAAI,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAC5E,0BAA0B,CAAC,OAAO,CAClC,EAAE;wBACF,IAAI,0BAA0B,CAAC,KAAK,KAAK,SAAS,EAAE;4BACnD,8DAA8D;4BAC9D,0CAA0C;4BAC1C,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;4BAC5C,SAAS;yBACT;wBAED,kEAAkE;wBAClE,MAAM,CAAC,8BAA8B,CAAC,CAAC;wBACvC,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;qBAC5C;iBACD;aACD;SACD;QAED,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AArED,wDAqEC;AAED,MAAM,IAAI,GAAG,CAAC,aAAwC,EAA6B,EAAE;IACpF,qEAAqE;IACrE,qEAAqE;IACrE,4FAA4F;IAC5F,wCAAwC;IACxC,MAAM,OAAO,GAAG,EAAE,GAAG,aAAa,EAAE,CAAC;IAErC,iGAAiG;IACjG,+GAA+G;IAC/G,qDAAqD;IACrD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,EAAE,EAAE;QACpE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;KAChD;IAED,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,MAAM,CACd,OAAkC;IAElC,MAAM,aAAa,GAAG,OAAO,CAAC,QAAmC,CAAC;IAElE,+EAA+E;IAC/E,MAAM,gCAAgC,GAAG,OAA2C,CAAC;IACrF,gCAAgC,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;IAC3D,gCAAgC,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;IACnE,gCAAgC,CAAC,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC;AAC9E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,OAAkC;IACtE,IAAI,OAAO,CAAC,IAAI,KAAK,kCAAW,CAAC,SAAS,EAAE;QAC3C,8CAA8C;QAC9C,sDAAsD;QACtD,+BAA+B;QAC/B,8BAA8B;QAC9B,OAAO,KAAK,CAAC;KACb;IAED,oBAAoB;IACpB,gJAAgJ;IAChJ,IACE,OAAO,CAAC,QAAkC,CAAC,OAAO,KAAK,SAAS;QAChE,OAAO,CAAC,QAA+B,CAAC,IAAI,KAAK,SAAS,EAC1D;QACD,OAAO,CAAC,IAAI,GAAG,uCAAoB,CAAC,gBAAgB,CAAC;KACrD;SAAM;QACN,aAAa;QACb,MAAM,CAAC,OAAO,CAAC,CAAC;KAChB;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAtBD,oDAsBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n\tContainerMessageType,\n\tContainerRuntimeMessage,\n\tSequencedContainerRuntimeMessage,\n} from \"../containerRuntime\";\nimport { OpDecompressor } from \"./opDecompressor\";\nimport { OpGroupingManager } from \"./opGroupingManager\";\nimport { OpSplitter } from \"./opSplitter\";\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 remoteMessage - A message from another client, likely a chunked/grouped op\n\t * @returns the ungrouped, unchunked, unpacked SequencedContainerRuntimeMessage encapsulated in the remote message\n\t */\n\tpublic process(remoteMessage: ISequencedDocumentMessage): ISequencedDocumentMessage[] {\n\t\tconst result: ISequencedDocumentMessage[] = [];\n\n\t\t// Ungroup before and after decompression for back-compat (cleanup tracked by AB#4371)\n\t\tfor (const ungroupedMessage of this.opGroupingManager.ungroupOp(copy(remoteMessage))) {\n\t\t\tconst message = this.opDecompressor.processMessage(ungroupedMessage).message;\n\n\t\t\tfor (let ungroupedMessage2 of this.opGroupingManager.ungroupOp(message)) {\n\t\t\t\t// unpack and unchunk the ungrouped message in place\n\t\t\t\tunpackRuntimeMessage(ungroupedMessage2);\n\t\t\t\tconst chunkProcessingResult =\n\t\t\t\t\tthis.opSplitter.processRemoteMessage(ungroupedMessage2);\n\t\t\t\tungroupedMessage2 = chunkProcessingResult.message;\n\n\t\t\t\tif (chunkProcessingResult.state !== \"Processed\") {\n\t\t\t\t\t// If the message is not chunked or if the splitter is still rebuilding the original message,\n\t\t\t\t\t// there is no need to continue processing\n\t\t\t\t\tresult.push(ungroupedMessage2);\n\t\t\t\t\tcontinue;\n\t\t\t\t}\n\n\t\t\t\t// Ungroup before and after decompression for back-compat (cleanup tracked by AB#4371)\n\t\t\t\tfor (const ungroupedMessageAfterChunking of this.opGroupingManager.ungroupOp(\n\t\t\t\t\tungroupedMessage2,\n\t\t\t\t)) {\n\t\t\t\t\tconst decompressionAfterChunking = this.opDecompressor.processMessage(\n\t\t\t\t\t\tungroupedMessageAfterChunking,\n\t\t\t\t\t);\n\n\t\t\t\t\tfor (const ungroupedMessageAfterChunking2 of this.opGroupingManager.ungroupOp(\n\t\t\t\t\t\tdecompressionAfterChunking.message,\n\t\t\t\t\t)) {\n\t\t\t\t\t\tif (decompressionAfterChunking.state === \"Skipped\") {\n\t\t\t\t\t\t\t// After chunking, if the original message was not compressed,\n\t\t\t\t\t\t\t// there is no need to continue processing\n\t\t\t\t\t\t\tresult.push(ungroupedMessageAfterChunking2);\n\t\t\t\t\t\t\tcontinue;\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\t// The message needs to be unpacked after chunking + decompression\n\t\t\t\t\t\tunpack(ungroupedMessageAfterChunking2);\n\t\t\t\t\t\tresult.push(ungroupedMessageAfterChunking2);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn result;\n\t}\n}\n\nconst copy = (remoteMessage: ISequencedDocumentMessage): ISequencedDocumentMessage => {\n\t// Do shallow copy of message, as the processing flow will modify it.\n\t// There might be multiple container instances receiving same message\n\t// We do not need to make deep copy, as each layer will just replace message.content itself,\n\t// but would not modify contents details\n\tconst message = { ...remoteMessage };\n\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 message.contents === \"string\" && message.contents !== \"\") {\n\t\tmessage.contents = JSON.parse(message.contents);\n\t}\n\n\treturn message;\n};\n\n/**\n * For a given message, it moves the nested ContainerRuntimeMessage props one level up.\n *\n * The return type illustrates the assumption that the message param\n * becomes a ContainerRuntimeMessage by the time the function returns\n * (but there is no runtime validation of the 'type' or 'compatDetails' values)\n */\nfunction unpack(\n\tmessage: ISequencedDocumentMessage,\n): asserts message is SequencedContainerRuntimeMessage {\n\tconst innerContents = message.contents as ContainerRuntimeMessage;\n\n\t// We're going to turn message into a SequencedContainerRuntimeMessage in-place\n\tconst sequencedContainerRuntimeMessage = message as SequencedContainerRuntimeMessage;\n\tsequencedContainerRuntimeMessage.type = innerContents.type;\n\tsequencedContainerRuntimeMessage.contents = innerContents.contents;\n\tsequencedContainerRuntimeMessage.compatDetails = innerContents.compatDetails;\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/dist/opProperties.js

@@ -6,10 +6,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.opSize = void 0;
 const opSize = (op) => {
-    var _a;
     // Some messages may already have string contents,
     // so stringifying them again will add inaccurate overhead.
-    const content = typeof op.contents === "string" ? op.contents : (_a = JSON.stringify(op.contents)) !== null && _a !== void 0 ? _a : "";
+    const content = typeof op.contents === "string" ? op.contents : JSON.stringify(op.contents) ?? "";
     const data = opHasData(op) ? op.data : "";
     return content.length + data.length;
 };

package/dist/opProperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"opProperties.js","sourceRoot":"","sources":["../src/opProperties.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOI,MAAM,MAAM,GAAG,CAAC,EAA6B,EAAU,EAAE;;IAC/D,kDAAkD;IAClD,2DAA2D;IAC3D,MAAM,OAAO,GACZ,OAAO,EAAE,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAA,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,mCAAI,EAAE,CAAC;IACnF,MAAM,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,OAAO,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AACrC,CAAC,CAAC;AAPW,QAAA,MAAM,UAOjB;AAEF,MAAM,SAAS,GAAG,CAAC,EAA6B,EAAyC,EAAE,CACzF,EAAsC,CAAC,IAAI,KAAK,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tISequencedDocumentMessage,\n\tISequencedDocumentSystemMessage,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const opSize = (op: ISequencedDocumentMessage): number => {\n\t// Some messages may already have string contents,\n\t// so stringifying them again will add inaccurate overhead.\n\tconst content =\n\t\ttypeof op.contents === \"string\" ? op.contents : JSON.stringify(op.contents) ?? \"\";\n\tconst data = opHasData(op) ? op.data : \"\";\n\treturn content.length + data.length;\n};\n\nconst opHasData = (op: ISequencedDocumentMessage): op is ISequencedDocumentSystemMessage =>\n\t(op as ISequencedDocumentSystemMessage).data !== undefined;\n"]}
+{"version":3,"file":"opProperties.js","sourceRoot":"","sources":["../src/opProperties.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOI,MAAM,MAAM,GAAG,CAAC,EAA6B,EAAU,EAAE;IAC/D,kDAAkD;IAClD,2DAA2D;IAC3D,MAAM,OAAO,GACZ,OAAO,EAAE,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnF,MAAM,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,OAAO,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;AACrC,CAAC,CAAC;AAPW,QAAA,MAAM,UAOjB;AAEF,MAAM,SAAS,GAAG,CAAC,EAA6B,EAAyC,EAAE,CACzF,EAAsC,CAAC,IAAI,KAAK,SAAS,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tISequencedDocumentMessage,\n\tISequencedDocumentSystemMessage,\n} from \"@fluidframework/protocol-definitions\";\n\nexport const opSize = (op: ISequencedDocumentMessage): number => {\n\t// Some messages may already have string contents,\n\t// so stringifying them again will add inaccurate overhead.\n\tconst content =\n\t\ttypeof op.contents === \"string\" ? op.contents : JSON.stringify(op.contents) ?? \"\";\n\tconst data = opHasData(op) ? op.data : \"\";\n\treturn content.length + data.length;\n};\n\nconst opHasData = (op: ISequencedDocumentMessage): op is ISequencedDocumentSystemMessage =>\n\t(op as ISequencedDocumentSystemMessage).data !== undefined;\n"]}

package/dist/packageVersion.d.ts

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

package/dist/packageVersion.js

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

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,mCAAmC,CAAC;AAC9C,QAAA,UAAU,GAAG,wBAAwB,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.0.0-dev.5.2.0.169897\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,mCAAmC,CAAC;AAC9C,QAAA,UAAU,GAAG,wBAAwB,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.0.0-dev.6.4.0.191258\";\n"]}

package/dist/pendingStateManager.d.ts

@@ -2,12 +2,12 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IDisposable } from "@fluidframework/common-definitions";
+import { IDisposable } from "@fluidframework/core-interfaces";
 import { ICriticalContainerError } from "@fluidframework/container-definitions";
-import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
-import { ContainerMessageType } from "./containerRuntime";
+import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
+import { ContainerMessageType, SequencedContainerRuntimeMessage } from "./containerRuntime";
 /**
- * ! TODO: Remove this interface in "2.0.0-internal.7.0.0" once we only read IPendingMessageNew
+ * ! TODO: Remove this interface in "2.0.0-internal.7.0.0" once we only read IPendingMessageNew (AB#4763)
  */
 export interface IPendingMessageOld {
     type: "message";
@@ -31,7 +31,7 @@ export interface IPendingMessageNew {
     opMetadata: Record<string, unknown> | undefined;
 }
 /**
- * ! TODO: Remove this type in "2.0.0-internal.7.0.0"
+ * ! TODO: Remove this type in "2.0.0-internal.7.0.0" (AB#4763)
  */
 export declare type IPendingState = IPendingMessageOld | IPendingMessageNew;
 export interface IPendingLocalState {
@@ -40,13 +40,19 @@ export interface IPendingLocalState {
      */
     pendingStates: IPendingState[];
 }
+export interface IPendingBatchMessage {
+    content: string;
+    localOpMetadata: unknown;
+    opMetadata: Record<string, unknown> | undefined;
+}
 export interface IRuntimeStateHandler {
     connected(): boolean;
     clientId(): string | undefined;
     close(error?: ICriticalContainerError): void;
     applyStashedOp(content: string): Promise<unknown>;
-    reSubmit(content: string | undefined, localOpMetadata: unknown, opMetadata: Record<string, unknown> | undefined): void;
-    orderSequentially(callback: () => void): void;
+    reSubmit(message: IPendingBatchMessage): void;
+    reSubmitBatch(batch: IPendingBatchMessage[]): void;
+    isActiveConnection: () => boolean;
 }
 /**
  * PendingStateManager is responsible for maintaining the messages that have not been sent or have not yet been
@@ -59,20 +65,29 @@ export interface IRuntimeStateHandler {
  */
 export declare class PendingStateManager implements IDisposable {
     private readonly stateHandler;
+    private readonly logger;
     private readonly pendingMessages;
     private readonly initialMessages;
+    /**
+     * Sequenced local ops that are saved when stashing since pending ops may depend on them
+     */
+    private savedOps;
     private readonly disposeOnce;
-    get pendingMessagesCount(): number;
     private isProcessingBatch;
     private pendingBatchBeginMessage;
     private clientId;
+    /**
+     * The pending messages count. Includes `pendingMessages` and `initialMessages` to keep in sync with
+     * 'hasPendingMessages'.
+     */
+    get pendingMessagesCount(): number;
     /**
      * 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(): boolean;
     getLocalState(): IPendingLocalState | undefined;
-    constructor(stateHandler: IRuntimeStateHandler, initialLocalState: IPendingLocalState | undefined);
+    constructor(stateHandler: IRuntimeStateHandler, initialLocalState: IPendingLocalState | undefined, logger: ITelemetryLoggerExt | undefined);
     get disposed(): boolean;
     readonly dispose: () => void;
     /**
@@ -93,7 +108,7 @@ export declare class PendingStateManager implements IDisposable {
      * the batch information was preserved for batch messages.
      * @param message - The message that got ack'd and needs to be processed.
      */
-    processPendingLocalMessage(message: ISequencedDocumentMessage): unknown;
+    processPendingLocalMessage(message: SequencedContainerRuntimeMessage): unknown;
     /**
      * 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.

package/dist/pendingStateManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pendingStateManager.d.ts","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAEhF,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AAEjF,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAG1D;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,EAAE,oBAAoB,CAAC;IAClC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,GAAG,CAAC;IACb,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,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;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEpE,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,aAAa,EAAE,aAAa,EAAE,CAAC;CAC/B;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,CACP,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,eAAe,EAAE,OAAO,EACxB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAC7C,IAAI,CAAC;IACR,iBAAiB,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAC9C;AAED;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IA0DrD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAzD9B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmC;IACnE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmC;IACnE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAGzB;IAEH,IAAW,oBAAoB,IAAI,MAAM,CAExC;IAGD,OAAO,CAAC,iBAAiB,CAAkB;IAI3C,OAAO,CAAC,wBAAwB,CAAwC;IAExE,OAAO,CAAC,QAAQ,CAAqB;IAErC;;;OAGG;IACI,kBAAkB,IAAI,OAAO;IAI7B,aAAa,IAAI,kBAAkB,GAAG,SAAS;gBA6BpC,YAAY,EAAE,oBAAoB,EACnD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS;IA4BlD,IAAW,QAAQ,YAElB;IACD,SAAgB,OAAO,aAAgC;IAEvD;;;;;;OAMG;IACI,eAAe,CACrB,OAAO,EAAE,MAAM,EACf,uBAAuB,EAAE,MAAM,EAC/B,eAAe,EAAE,OAAO,EACxB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAchD;;;OAGG;IACU,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM;IAwB9C;;;;OAIG;IACI,0BAA0B,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO;IAkC9E;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAkD5B;;;OAGG;IACI,mBAAmB;CA8E1B"}
+{"version":3,"file":"pendingStateManager.d.ts","sourceRoot":"","sources":["../src/pendingStateManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAEhF,OAAO,EAAuB,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAE3F,OAAO,EAAE,oBAAoB,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAI5F;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,EAAE,oBAAoB,CAAC;IAClC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,uBAAuB,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,GAAG,CAAC;IACb,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,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;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,CAAC;AAEpE,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,aAAa,EAAE,aAAa,EAAE,CAAC;CAC/B;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;CAClC;AAED;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IAmErD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IApExB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmC;IACnE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmC;IAEnE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA4B;IAE5C,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;;;OAGG;IACI,kBAAkB,IAAI,OAAO;IAI7B,aAAa,IAAI,kBAAkB,GAAG,SAAS;gBA4BpC,YAAY,EAAE,oBAAoB,EACnD,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,EAChC,MAAM,EAAE,mBAAmB,GAAG,SAAS;IA4BzD,IAAW,QAAQ,YAElB;IACD,SAAgB,OAAO,aAAgC;IAEvD;;;;;;OAMG;IACI,eAAe,CACrB,OAAO,EAAE,MAAM,EACf,uBAAuB,EAAE,MAAM,EAC/B,eAAe,EAAE,OAAO,EACxB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAchD;;;OAGG;IACU,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM;IA4B9C;;;;OAIG;IACI,0BAA0B,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO;IAwCrF;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAuD5B;;;OAGG;IACI,mBAAmB;CA4F1B"}

package/dist/pendingStateManager.js

@@ -8,9 +8,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PendingStateManager = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-const container_utils_1 = require("@fluidframework/container-utils");
 const double_ended_queue_1 = __importDefault(require("double-ended-queue"));
+const core_utils_1 = require("@fluidframework/core-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
 const containerRuntime_1 = require("./containerRuntime");
 const packageVersion_1 = require("./packageVersion");
 /**
@@ -23,11 +23,16 @@ const packageVersion_1 = require("./packageVersion");
  * It verifies that all the ops are acked, are received in the right order and batch information is correct.
  */
 class PendingStateManager {
-    constructor(stateHandler, initialLocalState) {
+    constructor(stateHandler, initialLocalState, logger) {
         this.stateHandler = stateHandler;
+        this.logger = logger;
         this.pendingMessages = new double_ended_queue_1.default();
         this.initialMessages = new double_ended_queue_1.default();
-        this.disposeOnce = new common_utils_1.Lazy(() => {
+        /**
+         * Sequenced local ops that are saved when stashing since pending ops may depend on them
+         */
+        this.savedOps = [];
+        this.disposeOnce = new core_utils_1.Lazy(() => {
             this.initialMessages.clear();
             this.pendingMessages.clear();
         });
@@ -36,9 +41,9 @@ class PendingStateManager {
         this.dispose = () => this.disposeOnce.value;
         /**
          * Convert old local state format to the new format (IPendingMessageOld to IPendingMessageNew)
-         * ! TODO: Remove this conversion in "2.0.0-internal.7.0.0"
+         * ! TODO: Remove this conversion in "2.0.0-internal.7.0.0" (AB#4763)
          */
-        if (initialLocalState === null || initialLocalState === void 0 ? void 0 : initialLocalState.pendingStates) {
+        if (initialLocalState?.pendingStates) {
             for (const initialState of initialLocalState.pendingStates) {
                 let messageContent = initialState.content;
                 if (initialState.messageType !== undefined &&
@@ -50,36 +55,43 @@ class PendingStateManager {
                     });
                 }
                 // Note: this object may contain "messageType" prop, but it should not be easily accesible due to interface being used
-                this.initialMessages.push(Object.assign(Object.assign({}, initialState), { content: messageContent }));
+                this.initialMessages.push({
+                    ...initialState,
+                    content: messageContent,
+                });
             }
         }
     }
+    /**
+     * The pending messages count. Includes `pendingMessages` and `initialMessages` to keep in sync with
+     * 'hasPendingMessages'.
+     */
     get pendingMessagesCount() {
-        return this.pendingMessages.length;
+        return this.pendingMessages.length + this.initialMessages.length;
     }
     /**
      * 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.pendingMessages.isEmpty() || !this.initialMessages.isEmpty();
+        return this.pendingMessagesCount !== 0;
     }
     getLocalState() {
-        (0, common_utils_1.assert)(this.initialMessages.isEmpty(), 0x2e9 /* "Must call getLocalState() after applying initial states" */);
+        (0, core_utils_1.assert)(this.initialMessages.isEmpty(), 0x2e9 /* "Must call getLocalState() after applying initial states" */);
         if (!this.pendingMessages.isEmpty()) {
             return {
-                pendingStates: this.pendingMessages.toArray().map((message) => {
-                    // ! TODO: Remove conversion to IPendingMessageOld in "2.0.0-internal.6.0.0" AB#3826
-                    const content = JSON.parse(message.content);
+                pendingStates: [...this.savedOps, ...this.pendingMessages.toArray()].map((message) => {
+                    let content = message.content;
+                    const parsedContent = JSON.parse(content);
                     // IdAllocations need their localOpMetadata stashed in the contents
                     // of the op to correctly resume the session when processing stashed ops
-                    if (content.type === containerRuntime_1.ContainerMessageType.IdAllocation) {
-                        content.contents.stashedState = message.localOpMetadata;
+                    if (parsedContent.type === containerRuntime_1.ContainerMessageType.IdAllocation) {
+                        parsedContent.contents.stashedState = message.localOpMetadata;
+                        content = JSON.stringify(parsedContent);
                     }
-                    return Object.assign(Object.assign({}, message), { messageType: content.type, content: content.contents, 
-                        // delete localOpMetadata since it may not be serializable
-                        // and will be regenerated by applyStashedOp()
-                        localOpMetadata: undefined });
+                    // delete localOpMetadata since it may not be serializable
+                    // and will be regenerated by applyStashedOp()
+                    return { ...message, content, localOpMetadata: undefined };
                 }),
             };
         }
@@ -122,9 +134,14 @@ class PendingStateManager {
                     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(nextMessage.content);
-            nextMessage.localOpMetadata = localOpMetadata;
+            try {
+                // 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.content);
+                nextMessage.localOpMetadata = localOpMetadata;
+            }
+            catch (error) {
+                throw telemetry_utils_1.DataProcessingError.wrapIfUnrecognized(error, "applyStashedOp", nextMessage);
+            }
             // then we push onto pendingMessages which will cause PendingStateManager to resubmit when we connect
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             this.pendingMessages.push(this.initialMessages.shift());
@@ -140,12 +157,16 @@ class PendingStateManager {
         this.maybeProcessBatchBegin(message);
         // Get the next message from the pending queue. Verify a message exists.
         const pendingMessage = this.pendingMessages.peekFront();
-        (0, common_utils_1.assert)(pendingMessage !== undefined, 0x169 /* "No pending message found for this remote message" */);
+        (0, core_utils_1.assert)(pendingMessage !== undefined, 0x169 /* "No pending message found for this remote message" */);
+        this.savedOps.push(pendingMessage);
         this.pendingMessages.shift();
-        const messageContent = JSON.stringify({ type: message.type, contents: message.contents });
-        // Stringified content does not match
+        // IMPORTANT: Order matters here, this must match the order of the properties used
+        // when submitting the message.
+        const { type, contents, compatDetails } = message;
+        const messageContent = JSON.stringify({ type, contents, compatDetails });
+        // Stringified content should match
         if (pendingMessage.content !== messageContent) {
-            this.stateHandler.close(container_utils_1.DataProcessingError.create("pending local message content mismatch", "unexpectedAckReceived", message, {
+            this.stateHandler.close(telemetry_utils_1.DataProcessingError.create("pending local message content mismatch", "unexpectedAckReceived", message, {
                 expectedMessageType: JSON.parse(pendingMessage.content).type,
             }));
             return;
@@ -159,11 +180,10 @@ class PendingStateManager {
      * @param message - The message that is being processed.
      */
     maybeProcessBatchBegin(message) {
-        var _a;
         // 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) {
+        if (message.metadata?.batch) {
             // We should not already be processing a batch and there should be no pending batch begin message.
-            (0, common_utils_1.assert)(!this.isProcessingBatch && this.pendingBatchBeginMessage === undefined, 0x16b /* "The pending batch state indicates we are already processing a batch" */);
+            (0, core_utils_1.assert)(!this.isProcessingBatch && this.pendingBatchBeginMessage === undefined, 0x16b /* "The pending batch state indicates we are already processing a batch" */);
             // Set the pending batch state indicating we have started processing a batch.
             this.pendingBatchBeginMessage = message;
             this.isProcessingBatch = true;
@@ -174,27 +194,28 @@ class PendingStateManager {
      * @param message - The message that is being processed.
      */
     maybeProcessBatchEnd(message) {
-        var _a, _b;
         if (!this.isProcessingBatch) {
             return;
         }
         // There should be a pending batch begin message.
-        (0, common_utils_1.assert)(this.pendingBatchBeginMessage !== undefined, 0x16d /* "There is no pending batch begin message" */);
-        const batchEndMetadata = (_a = message.metadata) === null || _a === void 0 ? void 0 : _a.batch;
+        (0, core_utils_1.assert)(this.pendingBatchBeginMessage !== undefined, 0x16d /* "There is no pending batch begin message" */);
+        const batchEndMetadata = message.metadata?.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;
+            const batchBeginMetadata = this.pendingBatchBeginMessage.metadata?.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) {
-                (0, common_utils_1.assert)(batchBeginMetadata === undefined, 0x16e /* "Batch with single message should not have batch metadata" */);
+                (0, core_utils_1.assert)(batchBeginMetadata === undefined, 0x16e /* "Batch with single message should not have batch metadata" */);
             }
             else {
                 if (batchBeginMetadata !== true || batchEndMetadata !== false) {
-                    this.stateHandler.close(container_utils_1.DataProcessingError.create("Pending batch inconsistency", // Formerly known as asserts 0x16f and 0x170
+                    this.stateHandler.close(telemetry_utils_1.DataProcessingError.create("Pending batch inconsistency", // Formerly known as asserts 0x16f and 0x170
                     "processPendingLocalMessage", message, {
                         runtimeVersion: packageVersion_1.pkgVersion,
-                        batchClientId: this.pendingBatchBeginMessage.clientId,
+                        batchClientId: this.pendingBatchBeginMessage.clientId === null
+                            ? "null"
+                            : this.pendingBatchBeginMessage.clientId,
                         clientId: this.stateHandler.clientId(),
                         hasBatchStart: batchBeginMetadata === true,
                         hasBatchEnd: batchEndMetadata === false,
@@ -213,51 +234,67 @@ class PendingStateManager {
      * states in its queue. This includes triggering resubmission of unacked ops.
      */
     replayPendingStates() {
-        var _a, _b;
-        (0, common_utils_1.assert)(this.stateHandler.connected(), 0x172 /* "The connection state is not consistent with the runtime" */);
+        (0, core_utils_1.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.
-        (0, common_utils_1.assert)(this.clientId !== this.stateHandler.clientId(), 0x173 /* "replayPendingStates called twice for same clientId!" */);
+        (0, core_utils_1.assert)(this.clientId !== this.stateHandler.clientId(), 0x173 /* "replayPendingStates called twice for same clientId!" */);
         this.clientId = this.stateHandler.clientId();
-        (0, common_utils_1.assert)(this.initialMessages.isEmpty(), 0x174 /* "initial states should be empty before replaying pending" */);
-        let pendingMessagesCount = this.pendingMessages.length;
-        if (pendingMessagesCount === 0) {
-            return;
-        }
+        (0, core_utils_1.assert)(this.initialMessages.isEmpty(), 0x174 /* "initial states should be empty before replaying pending" */);
+        const initialPendingMessagesCount = this.pendingMessages.length;
+        let remainingPendingMessagesCount = this.pendingMessages.length;
         // 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 (pendingMessagesCount > 0) {
+        while (remainingPendingMessagesCount > 0) {
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             let pendingMessage = this.pendingMessages.shift();
-            pendingMessagesCount--;
-            (0, common_utils_1.assert)(((_a = pendingMessage.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) !== false, 0x41b /* We cannot process batches in chunks */);
+            remainingPendingMessagesCount--;
+            (0, core_utils_1.assert)(pendingMessage.opMetadata?.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) {
-                (0, common_utils_1.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.content, pendingMessage.localOpMetadata, pendingMessage.opMetadata);
-                        if (((_a = pendingMessage.opMetadata) === null || _a === void 0 ? void 0 : _a.batch) === false) {
-                            break;
-                        }
-                        (0, common_utils_1.assert)(pendingMessagesCount > 0, 0x555 /* No batch end found */);
-                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                        pendingMessage = this.pendingMessages.shift();
-                        pendingMessagesCount--;
-                        (0, common_utils_1.assert)(((_b = pendingMessage.opMetadata) === null || _b === void 0 ? void 0 : _b.batch) !== true, 0x556 /* Batch start needs a corresponding batch end */);
+            if (pendingMessage.opMetadata?.batch) {
+                (0, core_utils_1.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;
                     }
-                });
+                    (0, core_utils_1.assert)(remainingPendingMessagesCount > 0, 0x555 /* No batch end found */);
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    pendingMessage = this.pendingMessages.shift();
+                    remainingPendingMessagesCount--;
+                    (0, core_utils_1.assert)(pendingMessage.opMetadata?.batch !== true, 0x556 /* Batch start needs a corresponding batch end */);
+                }
+                this.stateHandler.reSubmitBatch(batch);
             }
             else {
-                this.stateHandler.reSubmit(pendingMessage.content, pendingMessage.localOpMetadata, pendingMessage.opMetadata);
+                this.stateHandler.reSubmit({
+                    content: pendingMessage.content,
+                    localOpMetadata: pendingMessage.localOpMetadata,
+                    opMetadata: pendingMessage.opMetadata,
+                });
             }
         }
+        // pending ops should no longer depend on previous sequenced local ops after resubmit
+        this.savedOps = [];
+        // We replayPendingStates on read connections too - we expect these to get nack'd though, and to then reconnect
+        // on a write connection and replay again. This filters out the replay that happens on the read connection so
+        // we only see the replays on write connections (that have a chance to go through).
+        if (this.stateHandler.isActiveConnection()) {
+            this.logger?.sendTelemetryEvent({
+                eventName: "PendingStatesReplayed",
+                count: initialPendingMessagesCount,
+                clientId: this.stateHandler.clientId(),
+            });
+        }
     }
 }
 exports.PendingStateManager = PendingStateManager;