@fluidframework/container-runtime 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/lib/test/opLifecycle/OpGroupingManager.spec.js

@@ -0,0 +1,225 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { ContainerMessageType } from "../../index.js";
+import { OpGroupingManager } from "../../opLifecycle/index.js";
+describe("OpGroupingManager", () => {
+    const mockLogger = new MockLogger();
+    const createBatch = (length, hasReentrantOps) => ({
+        ...messagesToBatch(new Array(length).fill(createMessage(generateStringOfSize(1)))),
+        hasReentrantOps,
+    });
+    const messagesToBatch = (messages) => ({
+        content: messages,
+        contentSizeInBytes: messages
+            .map((message) => JSON.stringify(message).length)
+            .reduce((a, b) => a + b),
+        referenceSequenceNumber: messages[0].referenceSequenceNumber,
+    });
+    const createMessage = (contents) => ({
+        metadata: { flag: true },
+        localOpMetadata: undefined,
+        type: ContainerMessageType.FluidDataStoreOp,
+        contents,
+        referenceSequenceNumber: 0,
+    });
+    const generateStringOfSize = (sizeInBytes) => new Array(sizeInBytes + 1).join("0");
+    describe("Configs", () => {
+        it("Grouped batching is disabled", () => {
+            assert.strictEqual(new OpGroupingManager({
+                groupedBatchingEnabled: false,
+                opCountThreshold: 0,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger).shouldGroup(createBatch(100)), false);
+        });
+        it("Grouped batching is enabled but the batch is too small", () => {
+            assert.strictEqual(new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 10,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger).shouldGroup(createBatch(5)), false);
+        });
+        it("Grouped batching is enabled, the batch is large enough, but it is reentrant", () => {
+            assert.strictEqual(new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: false,
+            }, mockLogger).shouldGroup(createBatch(5, true)), false);
+        });
+        it("Grouped batching is enabled, the batch is large enough, and it is reentrant", () => {
+            assert.strictEqual(new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger).shouldGroup(createBatch(5, true)), true);
+        });
+        it("Grouped batching is enabled and the batch is large enough", () => {
+            assert.strictEqual(new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: false,
+            }, mockLogger).shouldGroup(createBatch(5)), true);
+        });
+    });
+    describe("Fakes clientSequenceNumber when ungrouping", () => {
+        it("grouped op", () => {
+            const opGroupingManager = new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger);
+            const op = {
+                clientSequenceNumber: 10,
+                contents: {
+                    type: OpGroupingManager.groupedBatchOp,
+                    contents: [
+                        {
+                            contents: "1",
+                        },
+                        {
+                            contents: "2",
+                        },
+                        {
+                            contents: "3",
+                        },
+                    ],
+                },
+            };
+            const result = opGroupingManager.ungroupOp(op);
+            assert.deepStrictEqual(result, [
+                {
+                    clientSequenceNumber: 1,
+                    contents: "1",
+                    compression: undefined,
+                    metadata: undefined,
+                },
+                {
+                    clientSequenceNumber: 2,
+                    contents: "2",
+                    compression: undefined,
+                    metadata: undefined,
+                },
+                {
+                    clientSequenceNumber: 3,
+                    contents: "3",
+                    compression: undefined,
+                    metadata: undefined,
+                },
+            ]);
+        });
+        it("non-grouped op with grouped batching enabled", () => {
+            const opGroupingManager = new OpGroupingManager({
+                groupedBatchingEnabled: true,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger);
+            const op = {
+                clientSequenceNumber: 10,
+                contents: "1",
+            };
+            const result = opGroupingManager.ungroupOp(op);
+            assert.deepStrictEqual(result, [
+                {
+                    clientSequenceNumber: 10,
+                    contents: "1",
+                },
+            ]);
+        });
+        it("non-grouped op with grouped batching disabled", () => {
+            const opGroupingManager = new OpGroupingManager({
+                groupedBatchingEnabled: false,
+                opCountThreshold: 2,
+                reentrantBatchGroupingEnabled: true,
+            }, mockLogger);
+            const op = {
+                clientSequenceNumber: 10,
+                contents: "1",
+            };
+            const result = opGroupingManager.ungroupOp(op);
+            assert.deepStrictEqual(result, [
+                {
+                    clientSequenceNumber: 10,
+                    contents: "1",
+                },
+            ]);
+        });
+    });
+    it("Ungrouping multiple times does not mess up groupedBatch messages", () => {
+        const groupedBatch = {
+            type: "op",
+            sequenceNumber: 10,
+            clientSequenceNumber: 12,
+            contents: {
+                type: OpGroupingManager.groupedBatchOp,
+                contents: [
+                    {
+                        contents: {
+                            type: ContainerMessageType.FluidDataStoreOp,
+                            contents: {
+                                contents: "a",
+                            },
+                        },
+                    },
+                    {
+                        contents: {
+                            type: ContainerMessageType.FluidDataStoreOp,
+                            contents: {
+                                contents: "b",
+                            },
+                        },
+                    },
+                ],
+            },
+        };
+        const opGroupingManager = new OpGroupingManager({
+            groupedBatchingEnabled: false,
+            opCountThreshold: 2,
+            reentrantBatchGroupingEnabled: true,
+        }, mockLogger);
+        // Run the groupedBatch through a couple times to ensure it cannot get messed up
+        let messagesToUngroup = [groupedBatch];
+        let result = [];
+        for (let i = 0; i < 4; i++) {
+            result = [];
+            for (const message of messagesToUngroup) {
+                for (const ungroupedOp of opGroupingManager.ungroupOp(message)) {
+                    result.push(ungroupedOp);
+                }
+            }
+            messagesToUngroup = [...result];
+        }
+        const expected = [
+            {
+                type: "op",
+                sequenceNumber: 10,
+                clientSequenceNumber: 1,
+                metadata: undefined,
+                compression: undefined,
+                contents: {
+                    type: ContainerMessageType.FluidDataStoreOp,
+                    contents: {
+                        contents: "a",
+                    },
+                },
+            },
+            {
+                type: "op",
+                sequenceNumber: 10,
+                clientSequenceNumber: 2,
+                metadata: undefined,
+                compression: undefined,
+                contents: {
+                    type: ContainerMessageType.FluidDataStoreOp,
+                    contents: {
+                        contents: "b",
+                    },
+                },
+            },
+        ];
+        assert.deepStrictEqual(result, expected, "ungrouping should work as expected");
+    });
+});
+//# sourceMappingURL=OpGroupingManager.spec.js.map

package/lib/test/opLifecycle/OpGroupingManager.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpGroupingManager.spec.js","sourceRoot":"","sources":["../../../src/test/opLifecycle/OpGroupingManager.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAwB,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAErF,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAClC,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,eAAyB,EAAU,EAAE,CAAC,CAAC;QAC3E,GAAG,eAAe,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClF,eAAe;KACf,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,CAAC,QAAwB,EAAU,EAAE,CAAC,CAAC;QAC9D,OAAO,EAAE,QAAQ;QACjB,kBAAkB,EAAE,QAAQ;aAC1B,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;QACzB,uBAAuB,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,uBAAuB;KAC5D,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC;QAC5C,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACxB,eAAe,EAAE,SAAS;QAC1B,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,QAAQ;QACR,uBAAuB,EAAE,CAAC;KAC1B,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAC5D,IAAI,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEtC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACvC,MAAM,CAAC,WAAW,CACjB,IAAI,iBAAiB,CACpB;gBACC,sBAAsB,EAAE,KAAK;gBAC7B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAC/B,KAAK,CACL,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YACjE,MAAM,CAAC,WAAW,CACjB,IAAI,iBAAiB,CACpB;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,EAAE;gBACpB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAC7B,KAAK,CACL,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;YACtF,MAAM,CAAC,WAAW,CACjB,IAAI,iBAAiB,CACpB;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,KAAK;aACpC,EACD,UAAU,CACV,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EACnC,KAAK,CACL,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;YACtF,MAAM,CAAC,WAAW,CACjB,IAAI,iBAAiB,CACpB;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EACnC,IAAI,CACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACpE,MAAM,CAAC,WAAW,CACjB,IAAI,iBAAiB,CACpB;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,KAAK;aACpC,EACD,UAAU,CACV,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAC7B,IAAI,CACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAC3D,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;YACrB,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAC9C;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC;YAEF,MAAM,EAAE,GAAG;gBACV,oBAAoB,EAAE,EAAE;gBACxB,QAAQ,EAAE;oBACT,IAAI,EAAE,iBAAiB,CAAC,cAAc;oBACtC,QAAQ,EAAE;wBACT;4BACC,QAAQ,EAAE,GAAG;yBACb;wBACD;4BACC,QAAQ,EAAE,GAAG;yBACb;wBACD;4BACC,QAAQ,EAAE,GAAG;yBACb;qBACD;iBACD;aACM,CAAC;YAET,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE;gBAC9B;oBACC,oBAAoB,EAAE,CAAC;oBACvB,QAAQ,EAAE,GAAG;oBACb,WAAW,EAAE,SAAS;oBACtB,QAAQ,EAAE,SAAS;iBACnB;gBACD;oBACC,oBAAoB,EAAE,CAAC;oBACvB,QAAQ,EAAE,GAAG;oBACb,WAAW,EAAE,SAAS;oBACtB,QAAQ,EAAE,SAAS;iBACnB;gBACD;oBACC,oBAAoB,EAAE,CAAC;oBACvB,QAAQ,EAAE,GAAG;oBACb,WAAW,EAAE,SAAS;oBACtB,QAAQ,EAAE,SAAS;iBACnB;aACD,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAC9C;gBACC,sBAAsB,EAAE,IAAI;gBAC5B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC;YAEF,MAAM,EAAE,GAAG;gBACV,oBAAoB,EAAE,EAAE;gBACxB,QAAQ,EAAE,GAAG;aACN,CAAC;YAET,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE;gBAC9B;oBACC,oBAAoB,EAAE,EAAE;oBACxB,QAAQ,EAAE,GAAG;iBACb;aACD,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACxD,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAC9C;gBACC,sBAAsB,EAAE,KAAK;gBAC7B,gBAAgB,EAAE,CAAC;gBACnB,6BAA6B,EAAE,IAAI;aACnC,EACD,UAAU,CACV,CAAC;YAEF,MAAM,EAAE,GAAG;gBACV,oBAAoB,EAAE,EAAE;gBACxB,QAAQ,EAAE,GAAG;aACN,CAAC;YAET,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAE/C,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE;gBAC9B;oBACC,oBAAoB,EAAE,EAAE;oBACxB,QAAQ,EAAE,GAAG;iBACb;aACD,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC3E,MAAM,YAAY,GAAG;YACpB,IAAI,EAAE,IAAI;YACV,cAAc,EAAE,EAAE;YAClB,oBAAoB,EAAE,EAAE;YACxB,QAAQ,EAAE;gBACT,IAAI,EAAE,iBAAiB,CAAC,cAAc;gBACtC,QAAQ,EAAE;oBACT;wBACC,QAAQ,EAAE;4BACT,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;4BAC3C,QAAQ,EAAE;gCACT,QAAQ,EAAE,GAAG;6BACb;yBACD;qBACD;oBACD;wBACC,QAAQ,EAAE;4BACT,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;4BAC3C,QAAQ,EAAE;gCACT,QAAQ,EAAE,GAAG;6BACb;yBACD;qBACD;iBACD;aACD;SACM,CAAC;QACT,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,CAC9C;YACC,sBAAsB,EAAE,KAAK;YAC7B,gBAAgB,EAAE,CAAC;YACnB,6BAA6B,EAAE,IAAI;SACnC,EACD,UAAU,CACV,CAAC;QAEF,gFAAgF;QAChF,IAAI,iBAAiB,GAAgC,CAAC,YAAY,CAAC,CAAC;QACpE,IAAI,MAAM,GAAgC,EAAE,CAAC;QAC7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3B,MAAM,GAAG,EAAE,CAAC;YACZ,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;gBACxC,KAAK,MAAM,WAAW,IAAI,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;oBAC/D,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;iBACzB;aACD;YACD,iBAAiB,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;SAChC;QAED,MAAM,QAAQ,GAAG;YAChB;gBACC,IAAI,EAAE,IAAI;gBACV,cAAc,EAAE,EAAE;gBAClB,oBAAoB,EAAE,CAAC;gBACvB,QAAQ,EAAE,SAAS;gBACnB,WAAW,EAAE,SAAS;gBACtB,QAAQ,EAAE;oBACT,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;oBAC3C,QAAQ,EAAE;wBACT,QAAQ,EAAE,GAAG;qBACb;iBACD;aACD;YACD;gBACC,IAAI,EAAE,IAAI;gBACV,cAAc,EAAE,EAAE;gBAClB,oBAAoB,EAAE,CAAC;gBACvB,QAAQ,EAAE,SAAS;gBACnB,WAAW,EAAE,SAAS;gBACtB,QAAQ,EAAE;oBACT,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;oBAC3C,QAAQ,EAAE;wBACT,QAAQ,EAAE,GAAG;qBACb;iBACD;aACD;SACD,CAAC;QACF,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,EAAE,oCAAoC,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { ContainerMessageType } from \"../../index.js\";\nimport { BatchMessage, IBatch, OpGroupingManager } from \"../../opLifecycle/index.js\";\n\ndescribe(\"OpGroupingManager\", () => {\n\tconst mockLogger = new MockLogger();\n\tconst createBatch = (length: number, hasReentrantOps?: boolean): IBatch => ({\n\t\t...messagesToBatch(new Array(length).fill(createMessage(generateStringOfSize(1)))),\n\t\thasReentrantOps,\n\t});\n\tconst messagesToBatch = (messages: BatchMessage[]): IBatch => ({\n\t\tcontent: messages,\n\t\tcontentSizeInBytes: messages\n\t\t\t.map((message) => JSON.stringify(message).length)\n\t\t\t.reduce((a, b) => a + b),\n\t\treferenceSequenceNumber: messages[0].referenceSequenceNumber,\n\t});\n\tconst createMessage = (contents: string) => ({\n\t\tmetadata: { flag: true },\n\t\tlocalOpMetadata: undefined,\n\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\tcontents,\n\t\treferenceSequenceNumber: 0,\n\t});\n\tconst generateStringOfSize = (sizeInBytes: number): string =>\n\t\tnew Array(sizeInBytes + 1).join(\"0\");\n\n\tdescribe(\"Configs\", () => {\n\t\tit(\"Grouped batching is disabled\", () => {\n\t\t\tassert.strictEqual(\n\t\t\t\tnew OpGroupingManager(\n\t\t\t\t\t{\n\t\t\t\t\t\tgroupedBatchingEnabled: false,\n\t\t\t\t\t\topCountThreshold: 0,\n\t\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t\t},\n\t\t\t\t\tmockLogger,\n\t\t\t\t).shouldGroup(createBatch(100)),\n\t\t\t\tfalse,\n\t\t\t);\n\t\t});\n\n\t\tit(\"Grouped batching is enabled but the batch is too small\", () => {\n\t\t\tassert.strictEqual(\n\t\t\t\tnew OpGroupingManager(\n\t\t\t\t\t{\n\t\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\t\topCountThreshold: 10,\n\t\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t\t},\n\t\t\t\t\tmockLogger,\n\t\t\t\t).shouldGroup(createBatch(5)),\n\t\t\t\tfalse,\n\t\t\t);\n\t\t});\n\n\t\tit(\"Grouped batching is enabled, the batch is large enough, but it is reentrant\", () => {\n\t\t\tassert.strictEqual(\n\t\t\t\tnew OpGroupingManager(\n\t\t\t\t\t{\n\t\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\t\treentrantBatchGroupingEnabled: false,\n\t\t\t\t\t},\n\t\t\t\t\tmockLogger,\n\t\t\t\t).shouldGroup(createBatch(5, true)),\n\t\t\t\tfalse,\n\t\t\t);\n\t\t});\n\n\t\tit(\"Grouped batching is enabled, the batch is large enough, and it is reentrant\", () => {\n\t\t\tassert.strictEqual(\n\t\t\t\tnew OpGroupingManager(\n\t\t\t\t\t{\n\t\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t\t},\n\t\t\t\t\tmockLogger,\n\t\t\t\t).shouldGroup(createBatch(5, true)),\n\t\t\t\ttrue,\n\t\t\t);\n\t\t});\n\n\t\tit(\"Grouped batching is enabled and the batch is large enough\", () => {\n\t\t\tassert.strictEqual(\n\t\t\t\tnew OpGroupingManager(\n\t\t\t\t\t{\n\t\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\t\treentrantBatchGroupingEnabled: false,\n\t\t\t\t\t},\n\t\t\t\t\tmockLogger,\n\t\t\t\t).shouldGroup(createBatch(5)),\n\t\t\t\ttrue,\n\t\t\t);\n\t\t});\n\t});\n\n\tdescribe(\"Fakes clientSequenceNumber when ungrouping\", () => {\n\t\tit(\"grouped op\", () => {\n\t\t\tconst opGroupingManager = new OpGroupingManager(\n\t\t\t\t{\n\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t},\n\t\t\t\tmockLogger,\n\t\t\t);\n\n\t\t\tconst op = {\n\t\t\t\tclientSequenceNumber: 10,\n\t\t\t\tcontents: {\n\t\t\t\t\ttype: OpGroupingManager.groupedBatchOp,\n\t\t\t\t\tcontents: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcontents: \"1\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcontents: \"2\",\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tcontents: \"3\",\n\t\t\t\t\t\t},\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t} as any;\n\n\t\t\tconst result = opGroupingManager.ungroupOp(op);\n\n\t\t\tassert.deepStrictEqual(result, [\n\t\t\t\t{\n\t\t\t\t\tclientSequenceNumber: 1,\n\t\t\t\t\tcontents: \"1\",\n\t\t\t\t\tcompression: undefined,\n\t\t\t\t\tmetadata: undefined,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tclientSequenceNumber: 2,\n\t\t\t\t\tcontents: \"2\",\n\t\t\t\t\tcompression: undefined,\n\t\t\t\t\tmetadata: undefined,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tclientSequenceNumber: 3,\n\t\t\t\t\tcontents: \"3\",\n\t\t\t\t\tcompression: undefined,\n\t\t\t\t\tmetadata: undefined,\n\t\t\t\t},\n\t\t\t]);\n\t\t});\n\n\t\tit(\"non-grouped op with grouped batching enabled\", () => {\n\t\t\tconst opGroupingManager = new OpGroupingManager(\n\t\t\t\t{\n\t\t\t\t\tgroupedBatchingEnabled: true,\n\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t},\n\t\t\t\tmockLogger,\n\t\t\t);\n\n\t\t\tconst op = {\n\t\t\t\tclientSequenceNumber: 10,\n\t\t\t\tcontents: \"1\",\n\t\t\t} as any;\n\n\t\t\tconst result = opGroupingManager.ungroupOp(op);\n\n\t\t\tassert.deepStrictEqual(result, [\n\t\t\t\t{\n\t\t\t\t\tclientSequenceNumber: 10,\n\t\t\t\t\tcontents: \"1\",\n\t\t\t\t},\n\t\t\t]);\n\t\t});\n\n\t\tit(\"non-grouped op with grouped batching disabled\", () => {\n\t\t\tconst opGroupingManager = new OpGroupingManager(\n\t\t\t\t{\n\t\t\t\t\tgroupedBatchingEnabled: false,\n\t\t\t\t\topCountThreshold: 2,\n\t\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t\t},\n\t\t\t\tmockLogger,\n\t\t\t);\n\n\t\t\tconst op = {\n\t\t\t\tclientSequenceNumber: 10,\n\t\t\t\tcontents: \"1\",\n\t\t\t} as any;\n\n\t\t\tconst result = opGroupingManager.ungroupOp(op);\n\n\t\t\tassert.deepStrictEqual(result, [\n\t\t\t\t{\n\t\t\t\t\tclientSequenceNumber: 10,\n\t\t\t\t\tcontents: \"1\",\n\t\t\t\t},\n\t\t\t]);\n\t\t});\n\t});\n\n\tit(\"Ungrouping multiple times does not mess up groupedBatch messages\", () => {\n\t\tconst groupedBatch = {\n\t\t\ttype: \"op\",\n\t\t\tsequenceNumber: 10,\n\t\t\tclientSequenceNumber: 12,\n\t\t\tcontents: {\n\t\t\t\ttype: OpGroupingManager.groupedBatchOp,\n\t\t\t\tcontents: [\n\t\t\t\t\t{\n\t\t\t\t\t\tcontents: {\n\t\t\t\t\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t\t\t\t\t\tcontents: {\n\t\t\t\t\t\t\t\tcontents: \"a\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tcontents: {\n\t\t\t\t\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t\t\t\t\t\tcontents: {\n\t\t\t\t\t\t\t\tcontents: \"b\",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t} as any;\n\t\tconst opGroupingManager = new OpGroupingManager(\n\t\t\t{\n\t\t\t\tgroupedBatchingEnabled: false,\n\t\t\t\topCountThreshold: 2,\n\t\t\t\treentrantBatchGroupingEnabled: true,\n\t\t\t},\n\t\t\tmockLogger,\n\t\t);\n\n\t\t// Run the groupedBatch through a couple times to ensure it cannot get messed up\n\t\tlet messagesToUngroup: ISequencedDocumentMessage[] = [groupedBatch];\n\t\tlet result: ISequencedDocumentMessage[] = [];\n\t\tfor (let i = 0; i < 4; i++) {\n\t\t\tresult = [];\n\t\t\tfor (const message of messagesToUngroup) {\n\t\t\t\tfor (const ungroupedOp of opGroupingManager.ungroupOp(message)) {\n\t\t\t\t\tresult.push(ungroupedOp);\n\t\t\t\t}\n\t\t\t}\n\t\t\tmessagesToUngroup = [...result];\n\t\t}\n\n\t\tconst expected = [\n\t\t\t{\n\t\t\t\ttype: \"op\",\n\t\t\t\tsequenceNumber: 10,\n\t\t\t\tclientSequenceNumber: 1,\n\t\t\t\tmetadata: undefined,\n\t\t\t\tcompression: undefined,\n\t\t\t\tcontents: {\n\t\t\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t\t\t\tcontents: {\n\t\t\t\t\t\tcontents: \"a\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: \"op\",\n\t\t\t\tsequenceNumber: 10,\n\t\t\t\tclientSequenceNumber: 2,\n\t\t\t\tmetadata: undefined,\n\t\t\t\tcompression: undefined,\n\t\t\t\tcontents: {\n\t\t\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t\t\t\tcontents: {\n\t\t\t\t\t\tcontents: \"b\",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t];\n\t\tassert.deepStrictEqual(result, expected, \"ungrouping should work as expected\");\n\t});\n});\n"]}

package/lib/test/opLifecycle/batchManager.spec.js

@@ -0,0 +1,189 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { BatchManager, estimateSocketSize } from "../../opLifecycle/index.js";
+import { ContainerMessageType } from "../../messageTypes.js";
+describe("BatchManager", () => {
+    const softLimit = 1024;
+    const hardLimit = 950 * 1024;
+    const smallMessageSize = 10;
+    const generateStringOfSize = (sizeInBytes) => new Array(sizeInBytes + 1).join("0");
+    const smallMessage = () => ({
+        contents: generateStringOfSize(smallMessageSize),
+        type: ContainerMessageType.FluidDataStoreOp,
+    });
+    it("BatchManager's soft limit: a bunch of small messages", () => {
+        const message = { contents: generateStringOfSize(softLimit / 2) };
+        const batchManager = new BatchManager({ hardLimit, softLimit });
+        // Can push one large message
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        // Can't push another large message
+        assert.equal(batchManager.push(message, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 1);
+        // But can push one small message
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.length, 2);
+        // Pop and check batch
+        const batch = batchManager.popBatch();
+        assert.equal(batch.content.length, 2);
+        assert.equal(batch.contentSizeInBytes, softLimit / 2 + smallMessageSize);
+        // Validate that can push large message again
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        assert.equal(batchManager.push(message, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 1);
+    });
+    it("BatchManager's soft limit: single large message", () => {
+        const message = { contents: generateStringOfSize(softLimit * 2) };
+        const batchManager = new BatchManager({ hardLimit, softLimit });
+        // Can push one large message, even above soft limit
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        // Can't push another small message
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), false);
+        assert.equal(batchManager.length, 1);
+        // Pop and check batch
+        const batch = batchManager.popBatch();
+        assert.equal(batch.content.length, 1);
+        assert.equal(batch.contentSizeInBytes, softLimit * 2);
+        // Validate that we can't push large message above soft limit if we have already at least one message.
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        assert.equal(batchManager.push(message, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 1);
+    });
+    it("BatchManager: no soft limit", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        const third = Math.floor(hardLimit / 3) + 1;
+        const message = { contents: generateStringOfSize(third) };
+        // Can push one large message, even above soft limit
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        // Can push second large message, even above soft limit
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 2);
+        // Can't push another message
+        assert.equal(batchManager.push(message, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 2);
+        // Pop and check batch
+        const batch = batchManager.popBatch();
+        assert.equal(batch.content.length, 2);
+        // Can push messages again
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 2);
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.length, 3);
+    });
+    it("BatchManager: soft limit is higher than hard limit", () => {
+        const batchManager = new BatchManager({ hardLimit, softLimit: hardLimit * 2 });
+        const twoThird = Math.floor((hardLimit * 2) / 3);
+        const message = { contents: generateStringOfSize(twoThird) };
+        const largeMessage = {
+            contents: generateStringOfSize(hardLimit + 1),
+        };
+        // Can't push very large message, above hard limit
+        assert.equal(batchManager.push(largeMessage, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 0);
+        // Can push one message
+        assert.equal(batchManager.push(message, /* reentrant */ false), true);
+        assert.equal(batchManager.length, 1);
+        // Can't push second message
+        assert.equal(batchManager.push(message, /* reentrant */ false), false);
+        assert.equal(batchManager.length, 1);
+        // Pop and check batch
+        const batch = batchManager.popBatch();
+        assert.equal(batch.content.length, 1);
+    });
+    it("BatchManager: 'infinity' hard limit allows everything", () => {
+        const message = { contents: generateStringOfSize(softLimit) };
+        const batchManager = new BatchManager({ hardLimit: Infinity });
+        for (let i = 1; i <= 10; i++) {
+            assert.equal(batchManager.push(message, /* reentrant */ false), true);
+            assert.equal(batchManager.length, i);
+        }
+    });
+    it("Batch metadata is set correctly", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 1 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 2 }, 
+        /* reentrant */ false), true);
+        const batch = batchManager.popBatch();
+        assert.equal(batch.content[0].metadata?.batch, true);
+        assert.equal(batch.content[1].metadata?.batch, undefined);
+        assert.equal(batch.content[2].metadata?.batch, false);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        const singleOpBatch = batchManager.popBatch();
+        assert.equal(singleOpBatch.content[0].metadata?.batch, undefined);
+    });
+    it("Batch content size is tracked correctly", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);
+        assert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);
+        assert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);
+    });
+    it("Batch reference sequence number maps to the last message", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 1 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 2 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.sequenceNumbers.referenceSequenceNumber, 2);
+    });
+    it("Batch size estimates", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        batchManager.push(smallMessage(), /* reentrant */ false);
+        // 10 bytes of content + 200 bytes overhead
+        assert.equal(estimateSocketSize(batchManager.popBatch()), 210);
+        for (let i = 0; i < 10; i++) {
+            batchManager.push(smallMessage(), /* reentrant */ false);
+        }
+        // (10 bytes of content + 200 bytes overhead) x 10
+        assert.equal(estimateSocketSize(batchManager.popBatch()), 2100);
+        batchManager.push(smallMessage(), /* reentrant */ false);
+        for (let i = 0; i < 9; i++) {
+            batchManager.push({
+                contents: undefined,
+                type: ContainerMessageType.FluidDataStoreOp,
+            }, 
+            /* reentrant */ false); // empty op
+        }
+        // 10 bytes of content + 200 bytes overhead x 10
+        assert.equal(estimateSocketSize(batchManager.popBatch()), 2010);
+    });
+    it("Batch op reentry state preserved during its lifetime", () => {
+        const batchManager = new BatchManager({ hardLimit });
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 1 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 2 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.popBatch().hasReentrantOps, false);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 1 }, 
+        /* reentrant */ true, 
+        /* currentClientSequenceNumber */ undefined), true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 2 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.popBatch().hasReentrantOps, true);
+        assert.equal(batchManager.push({ ...smallMessage(), referenceSequenceNumber: 0 }, 
+        /* reentrant */ false), true);
+        assert.equal(batchManager.popBatch().hasReentrantOps, false);
+    });
+});
+//# sourceMappingURL=batchManager.spec.js.map

package/lib/test/opLifecycle/batchManager.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batchManager.spec.js","sourceRoot":"","sources":["../../../src/test/opLifecycle/batchManager.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAgB,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,MAAM,SAAS,GAAG,IAAI,CAAC;IACvB,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7B,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAC5D,IAAI,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEtC,MAAM,YAAY,GAAG,GAAiB,EAAE,CACvC,CAAC;QACA,QAAQ,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;QAChD,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;KAC3C,CAAwB,CAAC;IAE3B,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC/D,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,SAAS,GAAG,CAAC,CAAC,EAAyB,CAAC;QACzF,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QAEhE,6BAA6B;QAC7B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,mCAAmC;QACnC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,iCAAiC;QACjC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,sBAAsB;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,EAAE,SAAS,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC;QAEzE,6CAA6C;QAC7C,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC1D,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,SAAS,GAAG,CAAC,CAAC,EAAyB,CAAC;QACzF,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QAEhE,oDAAoD;QACpD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,mCAAmC;QACnC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,sBAAsB;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,kBAAkB,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;QAEtD,sGAAsG;QACtG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACtC,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,KAAK,CAAC,EAAyB,CAAC;QAEjF,oDAAoD;QACpD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,uDAAuD;QACvD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,6BAA6B;QAC7B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,sBAAsB;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEtC,0BAA0B;QAC1B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC7D,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,QAAQ,CAAC,EAAyB,CAAC;QACpF,MAAM,YAAY,GAAG;YACpB,QAAQ,EAAE,oBAAoB,CAAC,SAAS,GAAG,CAAC,CAAC;SACtB,CAAC;QAEzB,kDAAkD;QAClD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,uBAAuB;QACvB,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,4BAA4B;QAC5B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAErC,sBAAsB;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAChE,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,oBAAoB,CAAC,SAAS,CAAC,EAAyB,CAAC;QACrF,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE;YAC7B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;YACtE,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;SACrC;IACF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAC1C,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QAEF,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAEtD,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,aAAa,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAClD,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACtF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QACnE,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC/B,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACzD,2CAA2C;QAC3C,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAE/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAC5B,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;SACzD;QAED,kDAAkD;QAClD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAEhE,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3B,YAAY,CAAC,IAAI,CAChB;gBACC,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;aACpB;YACxB,eAAe,CAAC,KAAK,CACrB,CAAC,CAAC,WAAW;SACd;QAED,gDAAgD;QAChD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC/D,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAE7D,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,IAAI;QACpB,iCAAiC,CAAC,SAAS,CAC3C,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAE5D,MAAM,CAAC,KAAK,CACX,YAAY,CAAC,IAAI,CAChB,EAAE,GAAG,YAAY,EAAE,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjD,eAAe,CAAC,KAAK,CACrB,EACD,IAAI,CACJ,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { BatchManager, BatchMessage, estimateSocketSize } from \"../../opLifecycle/index.js\";\nimport { ContainerMessageType } from \"../../messageTypes.js\";\n\ndescribe(\"BatchManager\", () => {\n\tconst softLimit = 1024;\n\tconst hardLimit = 950 * 1024;\n\tconst smallMessageSize = 10;\n\n\tconst generateStringOfSize = (sizeInBytes: number): string =>\n\t\tnew Array(sizeInBytes + 1).join(\"0\");\n\n\tconst smallMessage = (): BatchMessage =>\n\t\t({\n\t\t\tcontents: generateStringOfSize(smallMessageSize),\n\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t}) as any as BatchMessage;\n\n\tit(\"BatchManager's soft limit: a bunch of small messages\", () => {\n\t\tconst message = { contents: generateStringOfSize(softLimit / 2) } as any as BatchMessage;\n\t\tconst batchManager = new BatchManager({ hardLimit, softLimit });\n\n\t\t// Can push one large message\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Can't push another large message\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// But can push one small message\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 2);\n\n\t\t// Pop and check batch\n\t\tconst batch = batchManager.popBatch();\n\t\tassert.equal(batch.content.length, 2);\n\t\tassert.equal(batch.contentSizeInBytes, softLimit / 2 + smallMessageSize);\n\n\t\t// Validate that can push large message again\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 1);\n\t});\n\n\tit(\"BatchManager's soft limit: single large message\", () => {\n\t\tconst message = { contents: generateStringOfSize(softLimit * 2) } as any as BatchMessage;\n\t\tconst batchManager = new BatchManager({ hardLimit, softLimit });\n\n\t\t// Can push one large message, even above soft limit\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Can't push another small message\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Pop and check batch\n\t\tconst batch = batchManager.popBatch();\n\t\tassert.equal(batch.content.length, 1);\n\t\tassert.equal(batch.contentSizeInBytes, softLimit * 2);\n\n\t\t// Validate that we can't push large message above soft limit if we have already at least one message.\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 1);\n\t});\n\n\tit(\"BatchManager: no soft limit\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tconst third = Math.floor(hardLimit / 3) + 1;\n\t\tconst message = { contents: generateStringOfSize(third) } as any as BatchMessage;\n\n\t\t// Can push one large message, even above soft limit\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Can push second large message, even above soft limit\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 2);\n\n\t\t// Can't push another message\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 2);\n\n\t\t// Pop and check batch\n\t\tconst batch = batchManager.popBatch();\n\t\tassert.equal(batch.content.length, 2);\n\n\t\t// Can push messages again\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 2);\n\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 3);\n\t});\n\n\tit(\"BatchManager: soft limit is higher than hard limit\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit, softLimit: hardLimit * 2 });\n\t\tconst twoThird = Math.floor((hardLimit * 2) / 3);\n\t\tconst message = { contents: generateStringOfSize(twoThird) } as any as BatchMessage;\n\t\tconst largeMessage = {\n\t\t\tcontents: generateStringOfSize(hardLimit + 1),\n\t\t} as any as BatchMessage;\n\n\t\t// Can't push very large message, above hard limit\n\t\tassert.equal(batchManager.push(largeMessage, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 0);\n\n\t\t// Can push one message\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Can't push second message\n\t\tassert.equal(batchManager.push(message, /* reentrant */ false), false);\n\t\tassert.equal(batchManager.length, 1);\n\n\t\t// Pop and check batch\n\t\tconst batch = batchManager.popBatch();\n\t\tassert.equal(batch.content.length, 1);\n\t});\n\n\tit(\"BatchManager: 'infinity' hard limit allows everything\", () => {\n\t\tconst message = { contents: generateStringOfSize(softLimit) } as any as BatchMessage;\n\t\tconst batchManager = new BatchManager({ hardLimit: Infinity });\n\n\t\tfor (let i = 1; i <= 10; i++) {\n\t\t\tassert.equal(batchManager.push(message, /* reentrant */ false), true);\n\t\t\tassert.equal(batchManager.length, i);\n\t\t}\n\t});\n\n\tit(\"Batch metadata is set correctly\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 1 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 2 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\n\t\tconst batch = batchManager.popBatch();\n\t\tassert.equal(batch.content[0].metadata?.batch, true);\n\t\tassert.equal(batch.content[1].metadata?.batch, undefined);\n\t\tassert.equal(batch.content[2].metadata?.batch, false);\n\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tconst singleOpBatch = batchManager.popBatch();\n\t\tassert.equal(singleOpBatch.content[0].metadata?.batch, undefined);\n\t});\n\n\tit(\"Batch content size is tracked correctly\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);\n\t\tassert.equal(batchManager.push(smallMessage(), /* reentrant */ false), true);\n\t\tassert.equal(batchManager.contentSizeInBytes, smallMessageSize * batchManager.length);\n\t});\n\n\tit(\"Batch reference sequence number maps to the last message\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 1 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 2 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\n\t\tassert.equal(batchManager.sequenceNumbers.referenceSequenceNumber, 2);\n\t});\n\n\tit(\"Batch size estimates\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tbatchManager.push(smallMessage(), /* reentrant */ false);\n\t\t// 10 bytes of content + 200 bytes overhead\n\t\tassert.equal(estimateSocketSize(batchManager.popBatch()), 210);\n\n\t\tfor (let i = 0; i < 10; i++) {\n\t\t\tbatchManager.push(smallMessage(), /* reentrant */ false);\n\t\t}\n\n\t\t// (10 bytes of content + 200 bytes overhead) x 10\n\t\tassert.equal(estimateSocketSize(batchManager.popBatch()), 2100);\n\n\t\tbatchManager.push(smallMessage(), /* reentrant */ false);\n\t\tfor (let i = 0; i < 9; i++) {\n\t\t\tbatchManager.push(\n\t\t\t\t{\n\t\t\t\t\tcontents: undefined,\n\t\t\t\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\t\t\t} as any as BatchMessage,\n\t\t\t\t/* reentrant */ false,\n\t\t\t); // empty op\n\t\t}\n\n\t\t// 10 bytes of content + 200 bytes overhead x 10\n\t\tassert.equal(estimateSocketSize(batchManager.popBatch()), 2010);\n\t});\n\n\tit(\"Batch op reentry state preserved during its lifetime\", () => {\n\t\tconst batchManager = new BatchManager({ hardLimit });\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 1 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 2 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\n\t\tassert.equal(batchManager.popBatch().hasReentrantOps, false);\n\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 1 },\n\t\t\t\t/* reentrant */ true,\n\t\t\t\t/* currentClientSequenceNumber */ undefined,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 2 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(batchManager.popBatch().hasReentrantOps, true);\n\n\t\tassert.equal(\n\t\t\tbatchManager.push(\n\t\t\t\t{ ...smallMessage(), referenceSequenceNumber: 0 },\n\t\t\t\t/* reentrant */ false,\n\t\t\t),\n\t\t\ttrue,\n\t\t);\n\t\tassert.equal(batchManager.popBatch().hasReentrantOps, false);\n\t});\n});\n"]}

package/lib/test/opLifecycle/opCompressor.spec.js

@@ -0,0 +1,74 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MockLogger } from "@fluidframework/telemetry-utils";
+import { ContainerMessageType } from "../../index.js";
+import { OpCompressor } from "../../opLifecycle/index.js";
+describe("OpCompressor", () => {
+    let compressor;
+    const mockLogger = new MockLogger();
+    beforeEach(() => {
+        compressor = new OpCompressor(mockLogger);
+        mockLogger.clear();
+    });
+    const createBatch = (length, messageSize) => messagesToBatch(new Array(length).fill(createMessage(generateStringOfSize(messageSize))));
+    const messagesToBatch = (messages) => ({
+        content: messages,
+        contentSizeInBytes: messages
+            .map((message) => JSON.stringify(message).length)
+            .reduce((a, b) => a + b),
+        referenceSequenceNumber: messages[0].referenceSequenceNumber,
+    });
+    const createMessage = (contents) => ({
+        metadata: { flag: true },
+        localOpMetadata: undefined,
+        type: ContainerMessageType.FluidDataStoreOp,
+        contents,
+        referenceSequenceNumber: 0,
+    });
+    const generateStringOfSize = (sizeInBytes) => new Array(sizeInBytes + 1).join("0");
+    const toMB = (bytes) => (bytes / (1024 * 1024)).toFixed(2);
+    describe("Compressing batches", () => [
+        // small batch with one small message
+        createBatch(1, 100 * 1024),
+        // small batch with small messages
+        createBatch(10, 100 * 1024),
+        // small batch with large messages
+        createBatch(2, 100 * 1024 * 1024),
+        // large batch with small messages
+        createBatch(1000, 100 * 1024),
+    ].forEach((batch) => {
+        it(`Batch of ${batch.content.length} ops of total size ${toMB(batch.contentSizeInBytes)} MB`, () => {
+            const compressedBatch = compressor.compressBatch(batch);
+            assert.strictEqual(compressedBatch.content.length, batch.content.length);
+            assert.strictEqual(compressedBatch.content[0].compression, "lz4");
+            assert.strictEqual(compressedBatch.content[0].metadata?.flag, true);
+            if (compressedBatch.content.length > 1) {
+                assert.strictEqual(compressedBatch.content[1].contents, undefined);
+                assert.strictEqual(compressedBatch.content[1].compression, undefined);
+                assert.strictEqual(compressedBatch.content[1].contents, undefined);
+            }
+        }).timeout(3000);
+    }));
+    describe("Unsupported batches", () => [
+        // large batch with small messages
+        createBatch(6000, 100 * 1024),
+        // small batch with large messages
+        createBatch(6, 100 * 1024 * 1024),
+    ].forEach((batch) => {
+        it(`Not compressing batch of ${batch.content.length} ops of total size ${toMB(batch.contentSizeInBytes)} MB`, () => {
+            assert.throws(() => compressor.compressBatch(batch));
+            mockLogger.assertMatch([
+                {
+                    eventName: "OpCompressor:BatchTooLarge",
+                    category: "error",
+                    length: batch.content.length,
+                    size: batch.contentSizeInBytes,
+                },
+            ]);
+        });
+    }));
+});
+//# sourceMappingURL=opCompressor.spec.js.map

package/lib/test/opLifecycle/opCompressor.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opCompressor.spec.js","sourceRoot":"","sources":["../../../src/test/opLifecycle/opCompressor.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAwB,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAEhF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC7B,IAAI,UAAwB,CAAC;IAC7B,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;IACpC,UAAU,CAAC,GAAG,EAAE;QACf,UAAU,GAAG,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;QAC1C,UAAU,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAE,EAAE,CAC3D,eAAe,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3F,MAAM,eAAe,GAAG,CAAC,QAAwB,EAAU,EAAE,CAAC,CAAC;QAC9D,OAAO,EAAE,QAAQ;QACjB,kBAAkB,EAAE,QAAQ;aAC1B,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;QACzB,uBAAuB,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,uBAAuB;KAC5D,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC;QAC5C,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACxB,eAAe,EAAE,SAAS;QAC1B,IAAI,EAAE,oBAAoB,CAAC,gBAAgB;QAC3C,QAAQ;QACR,uBAAuB,EAAE,CAAC;KAC1B,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAC5D,IAAI,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAEnE,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,CACpC;QACC,qCAAqC;QACrC,WAAW,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;QAC1B,kCAAkC;QAClC,WAAW,CAAC,EAAE,EAAE,GAAG,GAAG,IAAI,CAAC;QAC3B,kCAAkC;QAClC,WAAW,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;QACjC,kCAAkC;QAClC,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC;KAC7B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACnB,EAAE,CAAC,YAAY,KAAK,CAAC,OAAO,CAAC,MAAM,sBAAsB,IAAI,CAC5D,KAAK,CAAC,kBAAkB,CACxB,KAAK,EAAE,GAAG,EAAE;YACZ,MAAM,eAAe,GAAG,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACxD,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACzE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAClE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACpE,IAAI,eAAe,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBACvC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;gBACnE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBACtE,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;aACnE;QACF,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC,CAAC;IAEL,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,CACpC;QACC,kCAAkC;QAClC,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC;QAC7B,kCAAkC;QAClC,WAAW,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;KACjC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACnB,EAAE,CAAC,4BAA4B,KAAK,CAAC,OAAO,CAAC,MAAM,sBAAsB,IAAI,CAC5E,KAAK,CAAC,kBAAkB,CACxB,KAAK,EAAE,GAAG,EAAE;YACZ,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;YACrD,UAAU,CAAC,WAAW,CAAC;gBACtB;oBACC,SAAS,EAAE,4BAA4B;oBACvC,QAAQ,EAAE,OAAO;oBACjB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM;oBAC5B,IAAI,EAAE,KAAK,CAAC,kBAAkB;iBAC9B;aACD,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC,CAAC;AACN,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { MockLogger } from \"@fluidframework/telemetry-utils\";\nimport { ContainerMessageType } from \"../../index.js\";\nimport { BatchMessage, IBatch, OpCompressor } from \"../../opLifecycle/index.js\";\n\ndescribe(\"OpCompressor\", () => {\n\tlet compressor: OpCompressor;\n\tconst mockLogger = new MockLogger();\n\tbeforeEach(() => {\n\t\tcompressor = new OpCompressor(mockLogger);\n\t\tmockLogger.clear();\n\t});\n\n\tconst createBatch = (length: number, messageSize: number) =>\n\t\tmessagesToBatch(new Array(length).fill(createMessage(generateStringOfSize(messageSize))));\n\tconst messagesToBatch = (messages: BatchMessage[]): IBatch => ({\n\t\tcontent: messages,\n\t\tcontentSizeInBytes: messages\n\t\t\t.map((message) => JSON.stringify(message).length)\n\t\t\t.reduce((a, b) => a + b),\n\t\treferenceSequenceNumber: messages[0].referenceSequenceNumber,\n\t});\n\tconst createMessage = (contents: string) => ({\n\t\tmetadata: { flag: true },\n\t\tlocalOpMetadata: undefined,\n\t\ttype: ContainerMessageType.FluidDataStoreOp,\n\t\tcontents,\n\t\treferenceSequenceNumber: 0,\n\t});\n\tconst generateStringOfSize = (sizeInBytes: number): string =>\n\t\tnew Array(sizeInBytes + 1).join(\"0\");\n\tconst toMB = (bytes: number) => (bytes / (1024 * 1024)).toFixed(2);\n\n\tdescribe(\"Compressing batches\", () =>\n\t\t[\n\t\t\t// small batch with one small message\n\t\t\tcreateBatch(1, 100 * 1024),\n\t\t\t// small batch with small messages\n\t\t\tcreateBatch(10, 100 * 1024),\n\t\t\t// small batch with large messages\n\t\t\tcreateBatch(2, 100 * 1024 * 1024),\n\t\t\t// large batch with small messages\n\t\t\tcreateBatch(1000, 100 * 1024),\n\t\t].forEach((batch) => {\n\t\t\tit(`Batch of ${batch.content.length} ops of total size ${toMB(\n\t\t\t\tbatch.contentSizeInBytes,\n\t\t\t)} MB`, () => {\n\t\t\t\tconst compressedBatch = compressor.compressBatch(batch);\n\t\t\t\tassert.strictEqual(compressedBatch.content.length, batch.content.length);\n\t\t\t\tassert.strictEqual(compressedBatch.content[0].compression, \"lz4\");\n\t\t\t\tassert.strictEqual(compressedBatch.content[0].metadata?.flag, true);\n\t\t\t\tif (compressedBatch.content.length > 1) {\n\t\t\t\t\tassert.strictEqual(compressedBatch.content[1].contents, undefined);\n\t\t\t\t\tassert.strictEqual(compressedBatch.content[1].compression, undefined);\n\t\t\t\t\tassert.strictEqual(compressedBatch.content[1].contents, undefined);\n\t\t\t\t}\n\t\t\t}).timeout(3000);\n\t\t}));\n\n\tdescribe(\"Unsupported batches\", () =>\n\t\t[\n\t\t\t// large batch with small messages\n\t\t\tcreateBatch(6000, 100 * 1024),\n\t\t\t// small batch with large messages\n\t\t\tcreateBatch(6, 100 * 1024 * 1024),\n\t\t].forEach((batch) => {\n\t\t\tit(`Not compressing batch of ${batch.content.length} ops of total size ${toMB(\n\t\t\t\tbatch.contentSizeInBytes,\n\t\t\t)} MB`, () => {\n\t\t\t\tassert.throws(() => compressor.compressBatch(batch));\n\t\t\t\tmockLogger.assertMatch([\n\t\t\t\t\t{\n\t\t\t\t\t\teventName: \"OpCompressor:BatchTooLarge\",\n\t\t\t\t\t\tcategory: \"error\",\n\t\t\t\t\t\tlength: batch.content.length,\n\t\t\t\t\t\tsize: batch.contentSizeInBytes,\n\t\t\t\t\t},\n\t\t\t\t]);\n\t\t\t});\n\t\t}));\n});\n"]}