@fluidframework/container-runtime 2.0.0-rc.1.0.6 → 2.0.0-rc.2.0.1

package/lib/test/pendingStateManager.spec.js

@@ -0,0 +1,329 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import assert from "assert";
+import { ContainerErrorTypes, } from "@fluidframework/container-definitions";
+import { MessageType } from "@fluidframework/protocol-definitions";
+import { isILoggingError } from "@fluidframework/telemetry-utils";
+import { PendingStateManager } from "../pendingStateManager.js";
+import { BatchManager } from "../opLifecycle/index.js";
+describe("Pending State Manager", () => {
+    describe("Rollback", () => {
+        let rollbackCalled;
+        let rollbackContent;
+        let rollbackShouldThrow;
+        let batchManager;
+        function getMessage(payload) {
+            return { contents: payload };
+        }
+        const rollBackCallback = (m) => {
+            rollbackCalled = true;
+            rollbackContent.push(m);
+            if (rollbackShouldThrow) {
+                throw new Error();
+            }
+        };
+        beforeEach(async () => {
+            rollbackCalled = false;
+            rollbackContent = [];
+            rollbackShouldThrow = false;
+            batchManager = new BatchManager({ hardLimit: 950 * 1024 });
+        });
+        it("should do nothing when rolling back empty pending stack", () => {
+            const checkpoint = batchManager.checkpoint();
+            checkpoint.rollback(rollBackCallback);
+            assert.strictEqual(rollbackCalled, false);
+            assert.strictEqual(batchManager.empty, true);
+        });
+        it("should do nothing when rolling back nothing", () => {
+            batchManager.push(getMessage("1"), /* reentrant */ false);
+            const checkpoint = batchManager.checkpoint();
+            checkpoint.rollback(rollBackCallback);
+            assert.strictEqual(rollbackCalled, false);
+            assert.strictEqual(batchManager.empty, false);
+        });
+        it("should succeed when rolling back entire pending stack", () => {
+            const checkpoint = batchManager.checkpoint();
+            batchManager.push(getMessage("11"), /* reentrant */ false);
+            batchManager.push(getMessage("22"), /* reentrant */ false);
+            batchManager.push(getMessage("33"), /* reentrant */ false);
+            checkpoint.rollback(rollBackCallback);
+            assert.strictEqual(rollbackCalled, true);
+            assert.strictEqual(rollbackContent.length, 3);
+            assert.strictEqual(rollbackContent[0].contents, "33");
+            assert.strictEqual(rollbackContent[1].contents, "22");
+            assert.strictEqual(rollbackContent[2].contents, "11");
+            assert.strictEqual(batchManager.empty, true);
+        });
+        it("should succeed when rolling back part of pending stack", () => {
+            batchManager.push(getMessage("11"), /* reentrant */ false);
+            const checkpoint = batchManager.checkpoint();
+            batchManager.push(getMessage("22"), /* reentrant */ false);
+            batchManager.push(getMessage("33"), /* reentrant */ false);
+            checkpoint.rollback(rollBackCallback);
+            assert.strictEqual(rollbackCalled, true);
+            assert.strictEqual(rollbackContent.length, 2);
+            assert.strictEqual(rollbackContent[0].contents, "33");
+            assert.strictEqual(rollbackContent[1].contents, "22");
+            assert.strictEqual(batchManager.empty, false);
+        });
+        it("should throw and close when rollback fails", () => {
+            rollbackShouldThrow = true;
+            const checkpoint = batchManager.checkpoint();
+            batchManager.push(getMessage("11"), /* reentrant */ false);
+            assert.throws(() => {
+                checkpoint.rollback(rollBackCallback);
+            });
+            assert.strictEqual(rollbackCalled, true);
+        });
+    });
+    describe("Op processing", () => {
+        let pendingStateManager;
+        let closeError;
+        const clientId = "clientId";
+        beforeEach(async () => {
+            closeError = undefined;
+            pendingStateManager = new PendingStateManager({
+                applyStashedOp: () => {
+                    throw new Error();
+                },
+                clientId: () => "oldClientId",
+                close: (error) => (closeError = error),
+                connected: () => true,
+                reSubmit: () => { },
+                reSubmitBatch: () => { },
+                isActiveConnection: () => false,
+                isAttached: () => true,
+            }, undefined /* initialLocalState */, undefined /* logger */);
+        });
+        const submitBatch = (messages) => {
+            messages.forEach((message) => {
+                pendingStateManager.onSubmitMessage(JSON.stringify({ type: message.type, contents: message.contents }), message.referenceSequenceNumber, undefined, message.metadata);
+            });
+        };
+        const process = (messages) => messages.forEach((message) => {
+            pendingStateManager.processPendingLocalMessage(message);
+        });
+        it("proper batch is processed correctly", () => {
+            const messages = [
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    clientSequenceNumber: 0,
+                    referenceSequenceNumber: 0,
+                    metadata: { batch: true },
+                },
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    clientSequenceNumber: 1,
+                    referenceSequenceNumber: 0,
+                },
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    metadata: { batch: false },
+                    clientSequenceNumber: 2,
+                    referenceSequenceNumber: 0,
+                },
+            ];
+            submitBatch(messages);
+            process(messages);
+            assert(closeError === undefined);
+        });
+        it("batch missing end message will call close", () => {
+            const messages = [
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    clientSequenceNumber: 0,
+                    referenceSequenceNumber: 0,
+                    metadata: { batch: true },
+                },
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    clientSequenceNumber: 1,
+                    referenceSequenceNumber: 0,
+                },
+            ];
+            submitBatch(messages);
+            process(messages);
+            assert(isILoggingError(closeError));
+            assert.strictEqual(closeError.errorType, ContainerErrorTypes.dataProcessingError);
+            assert.strictEqual(closeError.getTelemetryProperties().hasBatchStart, true);
+            assert.strictEqual(closeError.getTelemetryProperties().hasBatchEnd, false);
+        });
+        describe("processing out of sync messages will call close", () => {
+            it("messageTypes do not match", () => {
+                const messages = [
+                    {
+                        clientId,
+                        type: MessageType.Operation,
+                        clientSequenceNumber: 0,
+                        referenceSequenceNumber: 0,
+                    },
+                ];
+                submitBatch(messages);
+                process(messages.map((message) => ({
+                    ...message,
+                    type: "otherType",
+                })));
+                assert(isILoggingError(closeError));
+                assert.strictEqual(closeError.errorType, ContainerErrorTypes.dataProcessingError);
+                assert.strictEqual(closeError.getTelemetryProperties().expectedMessageType, MessageType.Operation);
+            });
+            it("only one message has undefined content", () => {
+                const messages = [
+                    {
+                        clientId,
+                        type: MessageType.Operation,
+                        clientSequenceNumber: 0,
+                        referenceSequenceNumber: 0,
+                        contents: {},
+                    },
+                ];
+                submitBatch(messages);
+                process(messages.map((message) => ({
+                    ...message,
+                    contents: undefined,
+                })));
+                assert.strictEqual(closeError?.errorType, ContainerErrorTypes.dataProcessingError);
+            });
+            it("stringified message content does not match", () => {
+                const messages = [
+                    {
+                        clientId,
+                        type: MessageType.Operation,
+                        clientSequenceNumber: 0,
+                        referenceSequenceNumber: 0,
+                        contents: {},
+                    },
+                ];
+                submitBatch(messages);
+                process(messages.map((message) => ({
+                    ...message,
+                    contents: { prop1: true },
+                })));
+                assert.strictEqual(closeError?.errorType, ContainerErrorTypes.dataProcessingError);
+            });
+        });
+        it("processing in sync messages will not call close", () => {
+            const messages = [
+                {
+                    clientId,
+                    type: MessageType.Operation,
+                    clientSequenceNumber: 0,
+                    referenceSequenceNumber: 0,
+                    contents: { prop1: true },
+                },
+            ];
+            submitBatch(messages);
+            process(messages.map((message) => ({
+                ...message,
+                contents: { prop1: true },
+            })));
+            assert.strictEqual(closeError, undefined, "unexpected close");
+        });
+    });
+    describe("Local state processing", () => {
+        function createPendingStateManager(pendingStates) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return new PendingStateManager({
+                applyStashedOp: async () => undefined,
+                clientId: () => undefined,
+                close: () => { },
+                connected: () => true,
+                reSubmit: () => { },
+                reSubmitBatch: () => { },
+                isActiveConnection: () => false,
+                isAttached: () => true,
+            }, { pendingStates }, undefined /* logger */);
+        }
+        describe("Constructor pendingStates", () => {
+            it("Empty local state", () => {
+                {
+                    const pendingStateManager = createPendingStateManager(undefined);
+                    assert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), []);
+                }
+                {
+                    const pendingStateManager = createPendingStateManager([]);
+                    assert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), []);
+                }
+            });
+            it("New format", () => {
+                const messages = [
+                    { type: "message", content: '{"type":"component"}' },
+                    {
+                        type: "message",
+                        content: '{"type": "component", "contents": {"prop1": "value"}}',
+                    },
+                ];
+                const pendingStateManager = createPendingStateManager(messages);
+                assert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), messages);
+            });
+        });
+        describe("Future op compat behavior", () => {
+            it("pending op roundtrip", async () => {
+                const pendingStateManager = createPendingStateManager([]);
+                const futureRuntimeMessage = {
+                    type: "FROM_THE_FUTURE",
+                    contents: "Hello",
+                    compatDetails: { behavior: "FailToProcess" },
+                };
+                pendingStateManager.onSubmitMessage(JSON.stringify(futureRuntimeMessage), 0, undefined, undefined);
+                pendingStateManager.processPendingLocalMessage(futureRuntimeMessage);
+            });
+        });
+    });
+    describe("Pending messages state", () => {
+        const messages = [
+            { type: "message", content: '{"type":"component"}' },
+            {
+                type: "message",
+                content: '{"type": "component", "contents": {"prop1": "value"}}',
+            },
+        ];
+        function createPendingStateManager(pendingStates) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return new PendingStateManager({
+                applyStashedOp: async () => undefined,
+                clientId: () => undefined,
+                close: () => { },
+                connected: () => true,
+                reSubmit: () => { },
+                reSubmitBatch: () => { },
+                isActiveConnection: () => false,
+                isAttached: () => true,
+            }, { pendingStates }, undefined /* logger */);
+        }
+        it("no pending or initial messages", () => {
+            const pendingStateManager = createPendingStateManager(undefined);
+            assert.strictEqual(pendingStateManager.hasPendingMessages(), false, "There shouldn't be pending messages");
+            assert.strictEqual(pendingStateManager.pendingMessagesCount, 0, "Pending messages count should be 0");
+        });
+        it("has pending messages but no initial messages", () => {
+            const pendingStateManager = createPendingStateManager(undefined);
+            for (const message of messages) {
+                pendingStateManager.onSubmitMessage(JSON.stringify(message.content), 0, undefined /* localOpMetadata */, undefined /* opMetadata */);
+            }
+            assert.strictEqual(pendingStateManager.hasPendingMessages(), true, "There should be pending messages");
+            assert.strictEqual(pendingStateManager.pendingMessagesCount, messages.length, "Pending messages count should be same as pending messages");
+        });
+        it("has initial messages but no pending messages", () => {
+            const pendingStateManager = createPendingStateManager(messages);
+            assert.strictEqual(pendingStateManager.hasPendingMessages(), true, "There should be initial messages");
+            assert.strictEqual(pendingStateManager.pendingMessagesCount, messages.length, "Pending messages count should be same as initial messages");
+        });
+        it("has both pending messages and initial messages", () => {
+            const pendingStateManager = createPendingStateManager(messages);
+            for (const message of messages) {
+                pendingStateManager.onSubmitMessage(JSON.stringify(message.content), 0, undefined /* localOpMetadata */, undefined /* opMetadata */);
+            }
+            assert.strictEqual(pendingStateManager.hasPendingMessages(), true, "There should be pending messages");
+            assert.strictEqual(pendingStateManager.pendingMessagesCount, messages.length * 2, "Pending messages count should be same as pending + initial messages");
+        });
+    });
+});
+//# sourceMappingURL=pendingStateManager.spec.js.map

package/lib/test/pendingStateManager.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pendingStateManager.spec.js","sourceRoot":"","sources":["../../src/test/pendingStateManager.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EACN,mBAAmB,GAEnB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAA6B,WAAW,EAAE,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAmB,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAE,YAAY,EAAgB,MAAM,yBAAyB,CAAC;AAUrE,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACtC,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACzB,IAAI,cAAc,CAAC;QACnB,IAAI,eAAe,CAAC;QACpB,IAAI,mBAAmB,CAAC;QACxB,IAAI,YAA0B,CAAC;QAE/B,SAAS,UAAU,CAAC,OAAe;YAClC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAyB,CAAC;QACrD,CAAC;QAED,MAAM,gBAAgB,GAAG,CAAC,CAAe,EAAE,EAAE;YAC5C,cAAc,GAAG,IAAI,CAAC;YACtB,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,mBAAmB,EAAE;gBACxB,MAAM,IAAI,KAAK,EAAE,CAAC;aAClB;QACF,CAAC,CAAC;QAEF,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,cAAc,GAAG,KAAK,CAAC;YACvB,eAAe,GAAG,EAAE,CAAC;YACrB,mBAAmB,GAAG,KAAK,CAAC;YAE5B,YAAY,GAAG,IAAI,YAAY,CAAC,EAAE,SAAS,EAAE,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YAClE,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7C,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAEtC,MAAM,CAAC,WAAW,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACtD,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7C,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAEtC,MAAM,CAAC,WAAW,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAChE,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7C,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAEtC,MAAM,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC9C,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YACjE,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7C,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YAEtC,MAAM,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC9C,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACrD,mBAAmB,GAAG,IAAI,CAAC;YAC3B,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;YAC7C,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC3D,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;gBAClB,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;YAEH,MAAM,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC9B,IAAI,mBAAmB,CAAC;QACxB,IAAI,UAA+C,CAAC;QACpD,MAAM,QAAQ,GAAG,UAAU,CAAC;QAE5B,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,UAAU,GAAG,SAAS,CAAC;YACvB,mBAAmB,GAAG,IAAI,mBAAmB,CAC5C;gBACC,cAAc,EAAE,GAAG,EAAE;oBACpB,MAAM,IAAI,KAAK,EAAE,CAAC;gBACnB,CAAC;gBACD,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAa;gBAC7B,KAAK,EAAE,CAAC,KAA+B,EAAE,EAAE,CAAC,CAAC,UAAU,GAAG,KAAK,CAAC;gBAChE,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;gBACrB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;gBAClB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;gBACvB,kBAAkB,EAAE,GAAG,EAAE,CAAC,KAAK;gBAC/B,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;aACtB,EACD,SAAS,CAAC,uBAAuB,EACjC,SAAS,CAAC,YAAY,CACtB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,CAAC,QAA8C,EAAE,EAAE;YACtE,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC5B,mBAAmB,CAAC,eAAe,CAClC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,EAClE,OAAO,CAAC,uBAAuB,EAC/B,SAAS,EACT,OAAO,CAAC,QAAQ,CAChB,CAAC;YACH,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,QAA8C,EAAE,EAAE,CAClE,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,mBAAmB,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEJ,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC9C,MAAM,QAAQ,GAAyC;gBACtD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;oBAC1B,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;iBACzB;gBACD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;iBAC1B;gBACD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;oBAC1B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;iBAC1B;aACD,CAAC;YAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;YACtB,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClB,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,QAAQ,GAAyC;gBACtD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;oBAC1B,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;iBACzB;gBACD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;iBAC1B;aACD,CAAC;YAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;YACtB,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClB,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;YACpC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;YAClF,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC5E,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAChE,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;gBACpC,MAAM,QAAQ,GAAyC;oBACtD;wBACC,QAAQ;wBACR,IAAI,EAAE,WAAW,CAAC,SAAS;wBAC3B,oBAAoB,EAAE,CAAC;wBACvB,uBAAuB,EAAE,CAAC;qBAC1B;iBACD,CAAC;gBAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACtB,OAAO,CACN,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAC1B,GAAG,OAAO;oBACV,IAAI,EAAE,WAAW;iBACjB,CAAC,CAAC,CACH,CAAC;gBACF,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;gBACpC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;gBAClF,MAAM,CAAC,WAAW,CACjB,UAAU,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,EACvD,WAAW,CAAC,SAAS,CACrB,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;gBACjD,MAAM,QAAQ,GAAyC;oBACtD;wBACC,QAAQ;wBACR,IAAI,EAAE,WAAW,CAAC,SAAS;wBAC3B,oBAAoB,EAAE,CAAC;wBACvB,uBAAuB,EAAE,CAAC;wBAC1B,QAAQ,EAAE,EAAE;qBACZ;iBACD,CAAC;gBAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACtB,OAAO,CACN,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAC1B,GAAG,OAAO;oBACV,QAAQ,EAAE,SAAS;iBACnB,CAAC,CAAC,CACH,CAAC;gBACF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;gBACrD,MAAM,QAAQ,GAAyC;oBACtD;wBACC,QAAQ;wBACR,IAAI,EAAE,WAAW,CAAC,SAAS;wBAC3B,oBAAoB,EAAE,CAAC;wBACvB,uBAAuB,EAAE,CAAC;wBAC1B,QAAQ,EAAE,EAAE;qBACZ;iBACD,CAAC;gBAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACtB,OAAO,CACN,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAC1B,GAAG,OAAO;oBACV,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;iBACzB,CAAC,CAAC,CACH,CAAC;gBACF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,QAAQ,GAAyC;gBACtD;oBACC,QAAQ;oBACR,IAAI,EAAE,WAAW,CAAC,SAAS;oBAC3B,oBAAoB,EAAE,CAAC;oBACvB,uBAAuB,EAAE,CAAC;oBAC1B,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;iBACzB;aACD,CAAC;YAEF,WAAW,CAAC,QAAQ,CAAC,CAAC;YACtB,OAAO,CACN,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC1B,GAAG,OAAO;gBACV,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;aACzB,CAAC,CAAC,CACH,CAAC;YACF,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,EAAE,kBAAkB,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACvC,SAAS,yBAAyB,CAAC,aAAa;YAC/C,+DAA+D;YAC/D,OAAO,IAAI,mBAAmB,CAC7B;gBACC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS;gBACrC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS;gBACzB,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;gBACf,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;gBACrB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;gBAClB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;gBACvB,kBAAkB,EAAE,GAAG,EAAE,CAAC,KAAK;gBAC/B,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;aACtB,EACD,EAAE,aAAa,EAAE,EACjB,SAAS,CAAC,YAAY,CACf,CAAC;QACV,CAAC;QAED,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;YAC1C,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;gBAC5B;oBACC,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;oBACjE,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;iBAC1E;gBACD;oBACC,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,EAAE,CAAC,CAAC;oBAC1D,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;iBAC1E;YACF,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;gBACrB,MAAM,QAAQ,GAAG;oBAChB,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,sBAAsB,EAAE;oBACpD;wBACC,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,uDAAuD;qBAChE;iBACD,CAAC;gBACF,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;gBAChE,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,eAAe,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;YAC1C,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;gBACrC,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,EAAE,CAAC,CAAC;gBAC1D,MAAM,oBAAoB,GACqB;oBAC9C,IAAI,EAAE,iBAAiB;oBACvB,QAAQ,EAAE,OAAO;oBACjB,aAAa,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE;iBAC5C,CAAC;gBAEF,mBAAmB,CAAC,eAAe,CAClC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,EACpC,CAAC,EACD,SAAS,EACT,SAAS,CACT,CAAC;gBACF,mBAAmB,CAAC,0BAA0B,CAC7C,oBAC+B,CAC/B,CAAC;YACH,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACvC,MAAM,QAAQ,GAAG;YAChB,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,sBAAsB,EAAE;YACpD;gBACC,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,uDAAuD;aAChE;SACD,CAAC;QAEF,SAAS,yBAAyB,CAAC,aAAa;YAC/C,+DAA+D;YAC/D,OAAO,IAAI,mBAAmB,CAC7B;gBACC,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS;gBACrC,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS;gBACzB,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;gBACf,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;gBACrB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;gBAClB,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;gBACvB,kBAAkB,EAAE,GAAG,EAAE,CAAC,KAAK;gBAC/B,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;aACtB,EACD,EAAE,aAAa,EAAE,EACjB,SAAS,CAAC,YAAY,CACf,CAAC;QACV,CAAC;QAED,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACzC,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;YACjE,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,kBAAkB,EAAE,EACxC,KAAK,EACL,qCAAqC,CACrC,CAAC;YACF,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,oBAAoB,EACxC,CAAC,EACD,oCAAoC,CACpC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;YACjE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,mBAAmB,CAAC,eAAe,CAClC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAC/B,CAAC,EACD,SAAS,CAAC,qBAAqB,EAC/B,SAAS,CAAC,gBAAgB,CAC1B,CAAC;aACF;YACD,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,kBAAkB,EAAE,EACxC,IAAI,EACJ,kCAAkC,CAClC,CAAC;YACF,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,oBAAoB,EACxC,QAAQ,CAAC,MAAM,EACf,2DAA2D,CAC3D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,kBAAkB,EAAE,EACxC,IAAI,EACJ,kCAAkC,CAClC,CAAC;YACF,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,oBAAoB,EACxC,QAAQ,CAAC,MAAM,EACf,2DAA2D,CAC3D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACzD,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;YAChE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC/B,mBAAmB,CAAC,eAAe,CAClC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAC/B,CAAC,EACD,SAAS,CAAC,qBAAqB,EAC/B,SAAS,CAAC,gBAAgB,CAC1B,CAAC;aACF;YACD,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,kBAAkB,EAAE,EACxC,IAAI,EACJ,kCAAkC,CAClC,CAAC;YACF,MAAM,CAAC,WAAW,CACjB,mBAAmB,CAAC,oBAAoB,EACxC,QAAQ,CAAC,MAAM,GAAG,CAAC,EACnB,qEAAqE,CACrE,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,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 assert from \"assert\";\nimport Deque from \"double-ended-queue\";\n\nimport {\n\tContainerErrorTypes,\n\tICriticalContainerError,\n} from \"@fluidframework/container-definitions\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport { isILoggingError } from \"@fluidframework/telemetry-utils\";\n\nimport { IPendingMessage, PendingStateManager } from \"../pendingStateManager.js\";\nimport { BatchManager, BatchMessage } from \"../opLifecycle/index.js\";\nimport type {\n\tRecentlyAddedContainerRuntimeMessageDetails,\n\tUnknownContainerRuntimeMessage,\n} from \"../messageTypes.js\";\n\ntype PendingStateManager_WithPrivates = Omit<PendingStateManager, \"initialMessages\"> & {\n\tinitialMessages: Deque<IPendingMessage>;\n};\n\ndescribe(\"Pending State Manager\", () => {\n\tdescribe(\"Rollback\", () => {\n\t\tlet rollbackCalled;\n\t\tlet rollbackContent;\n\t\tlet rollbackShouldThrow;\n\t\tlet batchManager: BatchManager;\n\n\t\tfunction getMessage(payload: string) {\n\t\t\treturn { contents: payload } as any as BatchMessage;\n\t\t}\n\n\t\tconst rollBackCallback = (m: BatchMessage) => {\n\t\t\trollbackCalled = true;\n\t\t\trollbackContent.push(m);\n\t\t\tif (rollbackShouldThrow) {\n\t\t\t\tthrow new Error();\n\t\t\t}\n\t\t};\n\n\t\tbeforeEach(async () => {\n\t\t\trollbackCalled = false;\n\t\t\trollbackContent = [];\n\t\t\trollbackShouldThrow = false;\n\n\t\t\tbatchManager = new BatchManager({ hardLimit: 950 * 1024 });\n\t\t});\n\n\t\tit(\"should do nothing when rolling back empty pending stack\", () => {\n\t\t\tconst checkpoint = batchManager.checkpoint();\n\t\t\tcheckpoint.rollback(rollBackCallback);\n\n\t\t\tassert.strictEqual(rollbackCalled, false);\n\t\t\tassert.strictEqual(batchManager.empty, true);\n\t\t});\n\n\t\tit(\"should do nothing when rolling back nothing\", () => {\n\t\t\tbatchManager.push(getMessage(\"1\"), /* reentrant */ false);\n\t\t\tconst checkpoint = batchManager.checkpoint();\n\t\t\tcheckpoint.rollback(rollBackCallback);\n\n\t\t\tassert.strictEqual(rollbackCalled, false);\n\t\t\tassert.strictEqual(batchManager.empty, false);\n\t\t});\n\n\t\tit(\"should succeed when rolling back entire pending stack\", () => {\n\t\t\tconst checkpoint = batchManager.checkpoint();\n\t\t\tbatchManager.push(getMessage(\"11\"), /* reentrant */ false);\n\t\t\tbatchManager.push(getMessage(\"22\"), /* reentrant */ false);\n\t\t\tbatchManager.push(getMessage(\"33\"), /* reentrant */ false);\n\t\t\tcheckpoint.rollback(rollBackCallback);\n\n\t\t\tassert.strictEqual(rollbackCalled, true);\n\t\t\tassert.strictEqual(rollbackContent.length, 3);\n\t\t\tassert.strictEqual(rollbackContent[0].contents, \"33\");\n\t\t\tassert.strictEqual(rollbackContent[1].contents, \"22\");\n\t\t\tassert.strictEqual(rollbackContent[2].contents, \"11\");\n\t\t\tassert.strictEqual(batchManager.empty, true);\n\t\t});\n\n\t\tit(\"should succeed when rolling back part of pending stack\", () => {\n\t\t\tbatchManager.push(getMessage(\"11\"), /* reentrant */ false);\n\t\t\tconst checkpoint = batchManager.checkpoint();\n\t\t\tbatchManager.push(getMessage(\"22\"), /* reentrant */ false);\n\t\t\tbatchManager.push(getMessage(\"33\"), /* reentrant */ false);\n\t\t\tcheckpoint.rollback(rollBackCallback);\n\n\t\t\tassert.strictEqual(rollbackCalled, true);\n\t\t\tassert.strictEqual(rollbackContent.length, 2);\n\t\t\tassert.strictEqual(rollbackContent[0].contents, \"33\");\n\t\t\tassert.strictEqual(rollbackContent[1].contents, \"22\");\n\t\t\tassert.strictEqual(batchManager.empty, false);\n\t\t});\n\n\t\tit(\"should throw and close when rollback fails\", () => {\n\t\t\trollbackShouldThrow = true;\n\t\t\tconst checkpoint = batchManager.checkpoint();\n\t\t\tbatchManager.push(getMessage(\"11\"), /* reentrant */ false);\n\t\t\tassert.throws(() => {\n\t\t\t\tcheckpoint.rollback(rollBackCallback);\n\t\t\t});\n\n\t\t\tassert.strictEqual(rollbackCalled, true);\n\t\t});\n\t});\n\n\tdescribe(\"Op processing\", () => {\n\t\tlet pendingStateManager;\n\t\tlet closeError: ICriticalContainerError | undefined;\n\t\tconst clientId = \"clientId\";\n\n\t\tbeforeEach(async () => {\n\t\t\tcloseError = undefined;\n\t\t\tpendingStateManager = new PendingStateManager(\n\t\t\t\t{\n\t\t\t\t\tapplyStashedOp: () => {\n\t\t\t\t\t\tthrow new Error();\n\t\t\t\t\t},\n\t\t\t\t\tclientId: () => \"oldClientId\",\n\t\t\t\t\tclose: (error?: ICriticalContainerError) => (closeError = error),\n\t\t\t\t\tconnected: () => true,\n\t\t\t\t\treSubmit: () => {},\n\t\t\t\t\treSubmitBatch: () => {},\n\t\t\t\t\tisActiveConnection: () => false,\n\t\t\t\t\tisAttached: () => true,\n\t\t\t\t},\n\t\t\t\tundefined /* initialLocalState */,\n\t\t\t\tundefined /* logger */,\n\t\t\t);\n\t\t});\n\n\t\tconst submitBatch = (messages: Partial<ISequencedDocumentMessage>[]) => {\n\t\t\tmessages.forEach((message) => {\n\t\t\t\tpendingStateManager.onSubmitMessage(\n\t\t\t\t\tJSON.stringify({ type: message.type, contents: message.contents }),\n\t\t\t\t\tmessage.referenceSequenceNumber,\n\t\t\t\t\tundefined,\n\t\t\t\t\tmessage.metadata,\n\t\t\t\t);\n\t\t\t});\n\t\t};\n\n\t\tconst process = (messages: Partial<ISequencedDocumentMessage>[]) =>\n\t\t\tmessages.forEach((message) => {\n\t\t\t\tpendingStateManager.processPendingLocalMessage(message);\n\t\t\t});\n\n\t\tit(\"proper batch is processed correctly\", () => {\n\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\tmetadata: { batch: true },\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tclientSequenceNumber: 1,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tmetadata: { batch: false },\n\t\t\t\t\tclientSequenceNumber: 2,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t},\n\t\t\t];\n\n\t\t\tsubmitBatch(messages);\n\t\t\tprocess(messages);\n\t\t\tassert(closeError === undefined);\n\t\t});\n\n\t\tit(\"batch missing end message will call close\", () => {\n\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\tmetadata: { batch: true },\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tclientSequenceNumber: 1,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t},\n\t\t\t];\n\n\t\t\tsubmitBatch(messages);\n\t\t\tprocess(messages);\n\t\t\tassert(isILoggingError(closeError));\n\t\t\tassert.strictEqual(closeError.errorType, ContainerErrorTypes.dataProcessingError);\n\t\t\tassert.strictEqual(closeError.getTelemetryProperties().hasBatchStart, true);\n\t\t\tassert.strictEqual(closeError.getTelemetryProperties().hasBatchEnd, false);\n\t\t});\n\n\t\tdescribe(\"processing out of sync messages will call close\", () => {\n\t\t\tit(\"messageTypes do not match\", () => {\n\t\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t\t{\n\t\t\t\t\t\tclientId,\n\t\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\t},\n\t\t\t\t];\n\n\t\t\t\tsubmitBatch(messages);\n\t\t\t\tprocess(\n\t\t\t\t\tmessages.map((message) => ({\n\t\t\t\t\t\t...message,\n\t\t\t\t\t\ttype: \"otherType\",\n\t\t\t\t\t})),\n\t\t\t\t);\n\t\t\t\tassert(isILoggingError(closeError));\n\t\t\t\tassert.strictEqual(closeError.errorType, ContainerErrorTypes.dataProcessingError);\n\t\t\t\tassert.strictEqual(\n\t\t\t\t\tcloseError.getTelemetryProperties().expectedMessageType,\n\t\t\t\t\tMessageType.Operation,\n\t\t\t\t);\n\t\t\t});\n\n\t\t\tit(\"only one message has undefined content\", () => {\n\t\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t\t{\n\t\t\t\t\t\tclientId,\n\t\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\t\tcontents: {},\n\t\t\t\t\t},\n\t\t\t\t];\n\n\t\t\t\tsubmitBatch(messages);\n\t\t\t\tprocess(\n\t\t\t\t\tmessages.map((message) => ({\n\t\t\t\t\t\t...message,\n\t\t\t\t\t\tcontents: undefined,\n\t\t\t\t\t})),\n\t\t\t\t);\n\t\t\t\tassert.strictEqual(closeError?.errorType, ContainerErrorTypes.dataProcessingError);\n\t\t\t});\n\n\t\t\tit(\"stringified message content does not match\", () => {\n\t\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t\t{\n\t\t\t\t\t\tclientId,\n\t\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\t\tcontents: {},\n\t\t\t\t\t},\n\t\t\t\t];\n\n\t\t\t\tsubmitBatch(messages);\n\t\t\t\tprocess(\n\t\t\t\t\tmessages.map((message) => ({\n\t\t\t\t\t\t...message,\n\t\t\t\t\t\tcontents: { prop1: true },\n\t\t\t\t\t})),\n\t\t\t\t);\n\t\t\t\tassert.strictEqual(closeError?.errorType, ContainerErrorTypes.dataProcessingError);\n\t\t\t});\n\t\t});\n\n\t\tit(\"processing in sync messages will not call close\", () => {\n\t\t\tconst messages: Partial<ISequencedDocumentMessage>[] = [\n\t\t\t\t{\n\t\t\t\t\tclientId,\n\t\t\t\t\ttype: MessageType.Operation,\n\t\t\t\t\tclientSequenceNumber: 0,\n\t\t\t\t\treferenceSequenceNumber: 0,\n\t\t\t\t\tcontents: { prop1: true },\n\t\t\t\t},\n\t\t\t];\n\n\t\t\tsubmitBatch(messages);\n\t\t\tprocess(\n\t\t\t\tmessages.map((message) => ({\n\t\t\t\t\t...message,\n\t\t\t\t\tcontents: { prop1: true },\n\t\t\t\t})),\n\t\t\t);\n\t\t\tassert.strictEqual(closeError, undefined, \"unexpected close\");\n\t\t});\n\t});\n\n\tdescribe(\"Local state processing\", () => {\n\t\tfunction createPendingStateManager(pendingStates): PendingStateManager_WithPrivates {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\t\treturn new PendingStateManager(\n\t\t\t\t{\n\t\t\t\t\tapplyStashedOp: async () => undefined,\n\t\t\t\t\tclientId: () => undefined,\n\t\t\t\t\tclose: () => {},\n\t\t\t\t\tconnected: () => true,\n\t\t\t\t\treSubmit: () => {},\n\t\t\t\t\treSubmitBatch: () => {},\n\t\t\t\t\tisActiveConnection: () => false,\n\t\t\t\t\tisAttached: () => true,\n\t\t\t\t},\n\t\t\t\t{ pendingStates },\n\t\t\t\tundefined /* logger */,\n\t\t\t) as any;\n\t\t}\n\n\t\tdescribe(\"Constructor pendingStates\", () => {\n\t\t\tit(\"Empty local state\", () => {\n\t\t\t\t{\n\t\t\t\t\tconst pendingStateManager = createPendingStateManager(undefined);\n\t\t\t\t\tassert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), []);\n\t\t\t\t}\n\t\t\t\t{\n\t\t\t\t\tconst pendingStateManager = createPendingStateManager([]);\n\t\t\t\t\tassert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), []);\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tit(\"New format\", () => {\n\t\t\t\tconst messages = [\n\t\t\t\t\t{ type: \"message\", content: '{\"type\":\"component\"}' },\n\t\t\t\t\t{\n\t\t\t\t\t\ttype: \"message\",\n\t\t\t\t\t\tcontent: '{\"type\": \"component\", \"contents\": {\"prop1\": \"value\"}}',\n\t\t\t\t\t},\n\t\t\t\t];\n\t\t\t\tconst pendingStateManager = createPendingStateManager(messages);\n\t\t\t\tassert.deepStrictEqual(pendingStateManager.initialMessages.toArray(), messages);\n\t\t\t});\n\t\t});\n\n\t\tdescribe(\"Future op compat behavior\", () => {\n\t\t\tit(\"pending op roundtrip\", async () => {\n\t\t\t\tconst pendingStateManager = createPendingStateManager([]);\n\t\t\t\tconst futureRuntimeMessage: Pick<ISequencedDocumentMessage, \"type\" | \"contents\"> &\n\t\t\t\t\tRecentlyAddedContainerRuntimeMessageDetails = {\n\t\t\t\t\ttype: \"FROM_THE_FUTURE\",\n\t\t\t\t\tcontents: \"Hello\",\n\t\t\t\t\tcompatDetails: { behavior: \"FailToProcess\" },\n\t\t\t\t};\n\n\t\t\t\tpendingStateManager.onSubmitMessage(\n\t\t\t\t\tJSON.stringify(futureRuntimeMessage),\n\t\t\t\t\t0,\n\t\t\t\t\tundefined,\n\t\t\t\t\tundefined,\n\t\t\t\t);\n\t\t\t\tpendingStateManager.processPendingLocalMessage(\n\t\t\t\t\tfutureRuntimeMessage as ISequencedDocumentMessage &\n\t\t\t\t\t\tUnknownContainerRuntimeMessage,\n\t\t\t\t);\n\t\t\t});\n\t\t});\n\t});\n\n\tdescribe(\"Pending messages state\", () => {\n\t\tconst messages = [\n\t\t\t{ type: \"message\", content: '{\"type\":\"component\"}' },\n\t\t\t{\n\t\t\t\ttype: \"message\",\n\t\t\t\tcontent: '{\"type\": \"component\", \"contents\": {\"prop1\": \"value\"}}',\n\t\t\t},\n\t\t];\n\n\t\tfunction createPendingStateManager(pendingStates): PendingStateManager_WithPrivates {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\t\treturn new PendingStateManager(\n\t\t\t\t{\n\t\t\t\t\tapplyStashedOp: async () => undefined,\n\t\t\t\t\tclientId: () => undefined,\n\t\t\t\t\tclose: () => {},\n\t\t\t\t\tconnected: () => true,\n\t\t\t\t\treSubmit: () => {},\n\t\t\t\t\treSubmitBatch: () => {},\n\t\t\t\t\tisActiveConnection: () => false,\n\t\t\t\t\tisAttached: () => true,\n\t\t\t\t},\n\t\t\t\t{ pendingStates },\n\t\t\t\tundefined /* logger */,\n\t\t\t) as any;\n\t\t}\n\n\t\tit(\"no pending or initial messages\", () => {\n\t\t\tconst pendingStateManager = createPendingStateManager(undefined);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.hasPendingMessages(),\n\t\t\t\tfalse,\n\t\t\t\t\"There shouldn't be pending messages\",\n\t\t\t);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.pendingMessagesCount,\n\t\t\t\t0,\n\t\t\t\t\"Pending messages count should be 0\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"has pending messages but no initial messages\", () => {\n\t\t\tconst pendingStateManager = createPendingStateManager(undefined);\n\t\t\tfor (const message of messages) {\n\t\t\t\tpendingStateManager.onSubmitMessage(\n\t\t\t\t\tJSON.stringify(message.content),\n\t\t\t\t\t0,\n\t\t\t\t\tundefined /* localOpMetadata */,\n\t\t\t\t\tundefined /* opMetadata */,\n\t\t\t\t);\n\t\t\t}\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.hasPendingMessages(),\n\t\t\t\ttrue,\n\t\t\t\t\"There should be pending messages\",\n\t\t\t);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.pendingMessagesCount,\n\t\t\t\tmessages.length,\n\t\t\t\t\"Pending messages count should be same as pending messages\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"has initial messages but no pending messages\", () => {\n\t\t\tconst pendingStateManager = createPendingStateManager(messages);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.hasPendingMessages(),\n\t\t\t\ttrue,\n\t\t\t\t\"There should be initial messages\",\n\t\t\t);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.pendingMessagesCount,\n\t\t\t\tmessages.length,\n\t\t\t\t\"Pending messages count should be same as initial messages\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"has both pending messages and initial messages\", () => {\n\t\t\tconst pendingStateManager = createPendingStateManager(messages);\n\t\t\tfor (const message of messages) {\n\t\t\t\tpendingStateManager.onSubmitMessage(\n\t\t\t\t\tJSON.stringify(message.content),\n\t\t\t\t\t0,\n\t\t\t\t\tundefined /* localOpMetadata */,\n\t\t\t\t\tundefined /* opMetadata */,\n\t\t\t\t);\n\t\t\t}\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.hasPendingMessages(),\n\t\t\t\ttrue,\n\t\t\t\t\"There should be pending messages\",\n\t\t\t);\n\t\t\tassert.strictEqual(\n\t\t\t\tpendingStateManager.pendingMessagesCount,\n\t\t\t\tmessages.length * 2,\n\t\t\t\t\"Pending messages count should be same as pending + initial messages\",\n\t\t\t);\n\t\t});\n\t});\n});\n"]}

package/lib/test/scheduleManager.spec.js

@@ -0,0 +1,270 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { EventEmitter } from "@fluid-internal/client-utils";
+import { MessageType } from "@fluidframework/protocol-definitions";
+import { MockDeltaManager } from "@fluidframework/test-runtime-utils";
+import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { ScheduleManager } from "../scheduleManager.js";
+describe("ScheduleManager", () => {
+    describe("Batch processing events", () => {
+        let batchBegin = 0;
+        let batchEnd = 0;
+        let sequenceNumber = 0;
+        let emitter;
+        let deltaManager;
+        let scheduleManager;
+        const testClientId = "test-client";
+        beforeEach(() => {
+            emitter = new EventEmitter();
+            deltaManager = new MockDeltaManager();
+            deltaManager.inbound.processCallback = (message) => {
+                scheduleManager.beforeOpProcessing(message);
+                scheduleManager.afterOpProcessing(undefined, message);
+                deltaManager.emit("op", message);
+            };
+            scheduleManager = new ScheduleManager(deltaManager, emitter, () => testClientId, createChildLogger({ namespace: "fluid:testScheduleManager" }));
+            emitter.on("batchBegin", () => {
+                // When we receive a "batchBegin" event, we should not have any outstanding
+                // events, i.e., batchBegin and batchEnd should be equal.
+                assert.strictEqual(batchBegin, batchEnd, "Received batchBegin before previous batchEnd");
+                batchBegin++;
+            });
+            emitter.on("batchEnd", () => {
+                batchEnd++;
+                // Every "batchEnd" event should correspond to a "batchBegin" event, i.e.,
+                // batchBegin and batchEnd should be equal.
+                assert.strictEqual(batchBegin, batchEnd, "Received batchEnd without corresponding batchBegin");
+            });
+        });
+        afterEach(() => {
+            batchBegin = 0;
+            batchEnd = 0;
+            sequenceNumber = 0;
+        });
+        /**
+         * Pushes single op to the inbound queue. Adds proper sequence numbers to them
+         */
+        function pushOp(partialMessage) {
+            sequenceNumber++;
+            const message = { ...partialMessage, sequenceNumber };
+            deltaManager.inbound.push(message);
+        }
+        /**
+         * awaits until all ops that could be processed are processed.
+         */
+        async function processOps() {
+            const inbound = deltaManager.inbound;
+            while (!inbound.paused && inbound.length > 0) {
+                await Promise.resolve();
+            }
+        }
+        it("Single non-batch message", async () => {
+            const message = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+            };
+            // Send a non-batch message.
+            pushOp(message);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 0, "Did not process all ops");
+            assert.strictEqual(batchBegin, 1, "Did not receive correct batchBegin events");
+            assert.strictEqual(batchEnd, 1, "Did not receive correct batchEnd events");
+        });
+        it("Multiple non-batch messages", async () => {
+            const message = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+            };
+            // Sent 5 non-batch messages.
+            pushOp(message);
+            pushOp(message);
+            pushOp(message);
+            pushOp(message);
+            pushOp(message);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 0, "Did not process all ops");
+            assert.strictEqual(batchBegin, 5, "Did not receive correct batchBegin events");
+            assert.strictEqual(batchEnd, 5, "Did not receive correct batchEnd events");
+        });
+        it("Message with non batch-related metadata", async () => {
+            const message = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { foo: 1 },
+            };
+            pushOp(message);
+            await processOps();
+            // We should have a "batchBegin" and a "batchEnd" event for the batch.
+            assert.strictEqual(deltaManager.inbound.length, 0, "Did not process all ops");
+            assert.strictEqual(batchBegin, 1, "Did not receive correct batchBegin event for the batch");
+            assert.strictEqual(batchEnd, 1, "Did not receive correct batchEnd event for the batch");
+        });
+        it("Messages in a single batch", async () => {
+            const batchBeginMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: true },
+            };
+            const batchMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+            };
+            const batchEndMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: false },
+            };
+            // Send a batch with 4 messages.
+            pushOp(batchBeginMessage);
+            pushOp(batchMessage);
+            pushOp(batchMessage);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 3, "Some of partial batch ops were processed");
+            pushOp(batchEndMessage);
+            await processOps();
+            // We should have only received one "batchBegin" and one "batchEnd" event for the batch.
+            assert.strictEqual(deltaManager.inbound.length, 0, "Did not process all ops");
+            assert.strictEqual(batchBegin, 1, "Did not receive correct batchBegin event for the batch");
+            assert.strictEqual(batchEnd, 1, "Did not receive correct batchEnd event for the batch");
+        });
+        it("two batches", async () => {
+            const batchBeginMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: true },
+            };
+            const batchMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+            };
+            const batchEndMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: false },
+            };
+            // Pause to not allow ops to be processed while we accumulated them.
+            await deltaManager.inbound.pause();
+            // Send a batch with 4 messages.
+            pushOp(batchBeginMessage);
+            pushOp(batchMessage);
+            pushOp(batchMessage);
+            pushOp(batchEndMessage);
+            // Add incomplete batch
+            pushOp(batchBeginMessage);
+            pushOp(batchMessage);
+            pushOp(batchMessage);
+            assert.strictEqual(deltaManager.inbound.length, 7, "none of the batched ops are processed yet");
+            void deltaManager.inbound.resume();
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 3, "none of the second batch ops are processed yet");
+            assert.strictEqual(batchBegin, 1, "Did not receive correct batchBegin event for the batch");
+            assert.strictEqual(batchEnd, 1, "Did not receive correct batchEnd event for the batch");
+            // End the batch - all ops should be processed.
+            pushOp(batchEndMessage);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 0, "processed all ops");
+            assert.strictEqual(batchBegin, 2, "Did not receive correct batchBegin event for the batch");
+            assert.strictEqual(batchEnd, 2, "Did not receive correct batchEnd event for the batch");
+        });
+        it("non-batched ops followed by batch", async () => {
+            const batchBeginMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: true },
+            };
+            const batchMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+            };
+            const batchEndMessage = {
+                clientId: testClientId,
+                type: MessageType.Operation,
+                metadata: { batch: false },
+            };
+            // Pause to not allow ops to be processed while we accumulated them.
+            await deltaManager.inbound.pause();
+            // Send a batch with 2 messages.
+            pushOp(batchMessage);
+            pushOp(batchMessage);
+            // Add incomplete batch
+            pushOp(batchBeginMessage);
+            pushOp(batchMessage);
+            pushOp(batchMessage);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 5, "none of the batched ops are processed yet");
+            void deltaManager.inbound.resume();
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 3, "none of the second batch ops are processed yet");
+            // End the batch - all ops should be processed.
+            pushOp(batchEndMessage);
+            await processOps();
+            assert.strictEqual(deltaManager.inbound.length, 0, "processed all ops");
+            assert.strictEqual(batchBegin, 3, "Did not receive correct batchBegin event for the batch");
+            assert.strictEqual(batchEnd, 3, "Did not receive correct batchEnd event for the batch");
+        });
+        function testWrongBatches() {
+            const clientId1 = "test-client-1";
+            const clientId2 = "test-client-2";
+            const batchBeginMessage = {
+                clientId: clientId1,
+                type: MessageType.Operation,
+                metadata: { batch: true },
+            };
+            const batchMessage = {
+                clientId: clientId1,
+                type: MessageType.Operation,
+            };
+            const messagesToFail = [
+                // System op from same client
+                {
+                    clientId: clientId1,
+                    type: MessageType.NoOp,
+                },
+                // Batch messages interleaved with a batch begin message from same client
+                batchBeginMessage,
+                // Send a message from another client. This should result in a a violation!
+                {
+                    clientId: clientId2,
+                    type: MessageType.Operation,
+                },
+                // Send a message from another client with non batch-related metadata. This should result
+                // in a "batchEnd" event for the previous batch since the client id changes. Also, we
+                // should get a "batchBegin" and a "batchEnd" event for the new client.
+                {
+                    clientId: clientId2,
+                    type: MessageType.Operation,
+                    metadata: { foo: 1 },
+                },
+                // Send a batch from another client. This should result in a "batchEnd" event for the
+                // previous batch since the client id changes. Also, we should get one "batchBegin" and
+                // one "batchEnd" event for the batch from the new client.
+                {
+                    clientId: clientId2,
+                    type: MessageType.Operation,
+                    metadata: { batch: true },
+                },
+            ];
+            let counter = 0;
+            for (const messageToFail of messagesToFail) {
+                counter++;
+                it(`Partial batch messages, case ${counter}`, async () => {
+                    // Send a batch with 3 messages from first client but don't send batch end message.
+                    pushOp(batchBeginMessage);
+                    pushOp(batchMessage);
+                    pushOp(batchMessage);
+                    await processOps();
+                    assert.strictEqual(deltaManager.inbound.length, 3, "Some of partial batch ops were processed");
+                    assert.throws(() => pushOp(messageToFail));
+                    assert.strictEqual(deltaManager.inbound.length, 4, "Some of batch ops were processed");
+                    assert.strictEqual(batchBegin, 0, "Did not receive correct batchBegin event for the batch");
+                    assert.strictEqual(batchEnd, 0, "Did not receive correct batchBegin event for the batch");
+                });
+            }
+        }
+        testWrongBatches();
+    });
+});
+//# sourceMappingURL=scheduleManager.spec.js.map