@fluidframework/merge-tree 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/lib/test/mergeTree.markRangeRemoved.deltaCallback.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.markRangeRemoved.deltaCallback.spec.js","sourceRoot":"","sources":["../../src/test/mergeTree.markRangeRemoved.deltaCallback.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AACnG,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEnF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IAC1B,IAAI,SAAoB,CAAC;IACzB,MAAM,aAAa,GAAG,EAAE,CAAC;IACzB,IAAI,qBAA6B,CAAC;IAClC,UAAU,CAAC,GAAG,EAAE;QACf,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,cAAc,CAAC;YACd,SAAS;YACT,GAAG,EAAE,CAAC;YACN,QAAQ,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC5C,MAAM,EAAE,uBAAuB;YAC/B,QAAQ,EAAE,aAAa;YACvB,GAAG,EAAE,uBAAuB;YAC5B,MAAM,EAAE,SAAS;SACjB,CAAC,CAAC;QACH,qBAAqB,GAAG,CAAC,CAAC;QAC1B,SAAS,CAAC,kBAAkB,CAC3B,aAAa;QACb,aAAa,CAAC,qBAAqB;QACnC,iBAAiB,CAAC,qBAAqB,CACvC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QACjC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC3B,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEzC,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,wBAAwB;gBAC7B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC7B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;aACnC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,8FAA8F;QAC9F,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;YAC1B,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEzC,MAAM,KAAK,GAAG,CAAC,CAAC;YAChB,MAAM,GAAG,GAAG,CAAC,CAAC;YAEd,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK;gBACL,GAAG;gBACH,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,wBAAwB;gBAC7B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,sFAAsF;YACtF,qEAAqE;YACrE,SAAS,CAAC,iBAAiB,CAAC;gBAC3B,EAAE,EAAE;oBACH,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;oBACT,IAAI,EAAE,kBAAkB,CAAC,MAAM;iBAC/B;gBACD,gBAAgB,EAAE;oBACjB,cAAc,EAAE,EAAE,qBAAqB;iBACH;aACrC,CAAC,CAAC;YAEH,uEAAuE;YACvE,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,qBAAqB,CAAC;YAC1D,SAAS,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;YAE3C,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC7B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnC,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,CAAC,wBAAwB,CAAC,YAAY,CAAC,EAAE,CAAC;aAC1C,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC9B,MAAM,cAAc,GAAW,EAAE,CAAC;YAClC,IAAI,oBAAoB,GAAG,qBAAqB,CAAC;YAEjD,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,oBAAoB;gBAC5B,QAAQ,EAAE,cAAc;gBACxB,GAAG,EAAE,EAAE,oBAAoB;gBAC3B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEzC,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,wBAAwB;gBAC7B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC7B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;aACnC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC9B,MAAM,cAAc,GAAW,EAAE,CAAC;YAClC,IAAI,oBAAoB,GAAG,qBAAqB,CAAC;YAEjD,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,wBAAwB;gBAC7B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEzC,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,oBAAoB;gBAC5B,QAAQ,EAAE,cAAc;gBACxB,GAAG,EAAE,EAAE,oBAAoB;gBAC3B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC7B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;aACnC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACtC,MAAM,cAAc,GAAW,EAAE,CAAC;YAClC,IAAI,oBAAoB,GAAG,qBAAqB,CAAC;YAEjD,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,wBAAwB;gBAC7B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEzC,gBAAgB,CAAC;gBAChB,SAAS;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,CAAC;gBACN,MAAM,EAAE,oBAAoB;gBAC5B,QAAQ,EAAE,cAAc;gBACxB,GAAG,EAAE,EAAE,oBAAoB;gBAC3B,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,SAAgB;aACxB,CAAC,CAAC;YAEH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE;gBAC7B,oEAAoE;gBACpE,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;aACnC,CAAC,CAAC;QACJ,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 { strict as assert } from \"assert\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { LocalClientId, UnassignedSequenceNumber, UniversalSequenceNumber } from \"../constants.js\";\nimport { MergeTreeMaintenanceType } from \"../mergeTreeDeltaCallback.js\";\nimport { MergeTreeDeltaType } from \"../ops.js\";\nimport { TextSegment } from \"../textSegment.js\";\nimport { MergeTree } from \"../mergeTree.js\";\nimport { countOperations, insertSegments, markRangeRemoved } from \"./testUtils.js\";\n\ndescribe(\"MergeTree\", () => {\n\tlet mergeTree: MergeTree;\n\tconst localClientId = 17;\n\tlet currentSequenceNumber: number;\n\tbeforeEach(() => {\n\t\tmergeTree = new MergeTree();\n\t\tinsertSegments({\n\t\t\tmergeTree,\n\t\t\tpos: 0,\n\t\t\tsegments: [TextSegment.make(\"hello world!\")],\n\t\t\trefSeq: UniversalSequenceNumber,\n\t\t\tclientId: LocalClientId,\n\t\t\tseq: UniversalSequenceNumber,\n\t\t\topArgs: undefined,\n\t\t});\n\t\tcurrentSequenceNumber = 0;\n\t\tmergeTree.startCollaboration(\n\t\t\tlocalClientId,\n\t\t\t/* minSeq: */ currentSequenceNumber,\n\t\t\t/* currentSeq: */ currentSequenceNumber,\n\t\t);\n\t});\n\n\tdescribe(\"markRangeRemoved\", () => {\n\t\tit(\"Event on Removal\", () => {\n\t\t\tconst count = countOperations(mergeTree);\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 4,\n\t\t\t\tend: 6,\n\t\t\t\trefSeq: currentSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UnassignedSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tassert.deepStrictEqual(count, {\n\t\t\t\t[MergeTreeDeltaType.REMOVE]: 1,\n\t\t\t\t[MergeTreeMaintenanceType.SPLIT]: 2,\n\t\t\t});\n\t\t});\n\n\t\t// Verify that zamboni unlinks a removed segment and raises the appropriate maintenance event.\n\t\tit(\"Event on Unlink\", () => {\n\t\t\tconst count = countOperations(mergeTree);\n\n\t\t\tconst start = 4;\n\t\t\tconst end = 6;\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart,\n\t\t\t\tend,\n\t\t\t\trefSeq: currentSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UnassignedSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\t// In order for the removed segment to unlinked by zamboni, we need to ACK the segment\n\t\t\t// and advance the collaboration window's minSeq past the removedSeq.\n\t\t\tmergeTree.ackPendingSegment({\n\t\t\t\top: {\n\t\t\t\t\tpos1: start,\n\t\t\t\t\tpos2: end,\n\t\t\t\t\ttype: MergeTreeDeltaType.REMOVE,\n\t\t\t\t},\n\t\t\t\tsequencedMessage: {\n\t\t\t\t\tsequenceNumber: ++currentSequenceNumber,\n\t\t\t\t} as any as ISequencedDocumentMessage,\n\t\t\t});\n\n\t\t\t// Move currentSeq/minSeq past the seq# at which the removal was ACKed.\n\t\t\tmergeTree.collabWindow.currentSeq = currentSequenceNumber;\n\t\t\tmergeTree.setMinSeq(currentSequenceNumber);\n\n\t\t\tassert.deepStrictEqual(count, {\n\t\t\t\t[MergeTreeDeltaType.REMOVE]: 1,\n\t\t\t\t[MergeTreeMaintenanceType.SPLIT]: 2,\n\t\t\t\t[MergeTreeMaintenanceType.UNLINK]: 1,\n\t\t\t\t[MergeTreeMaintenanceType.ACKNOWLEDGED]: 1,\n\t\t\t});\n\t\t});\n\n\t\tit(\"Remote Before Local\", () => {\n\t\t\tconst remoteClientId: number = 35;\n\t\t\tlet remoteSequenceNumber = currentSequenceNumber;\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 4,\n\t\t\t\tend: 6,\n\t\t\t\trefSeq: remoteSequenceNumber,\n\t\t\t\tclientId: remoteClientId,\n\t\t\t\tseq: ++remoteSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tconst count = countOperations(mergeTree);\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 3,\n\t\t\t\tend: 5,\n\t\t\t\trefSeq: currentSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UnassignedSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tassert.deepStrictEqual(count, {\n\t\t\t\t[MergeTreeDeltaType.REMOVE]: 1,\n\t\t\t\t[MergeTreeMaintenanceType.SPLIT]: 2,\n\t\t\t});\n\t\t});\n\n\t\tit(\"Local Before Remote\", () => {\n\t\t\tconst remoteClientId: number = 35;\n\t\t\tlet remoteSequenceNumber = currentSequenceNumber;\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 4,\n\t\t\t\tend: 6,\n\t\t\t\trefSeq: currentSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UnassignedSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tconst count = countOperations(mergeTree);\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 3,\n\t\t\t\tend: 5,\n\t\t\t\trefSeq: remoteSequenceNumber,\n\t\t\t\tclientId: remoteClientId,\n\t\t\t\tseq: ++remoteSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tassert.deepStrictEqual(count, {\n\t\t\t\t[MergeTreeDeltaType.REMOVE]: 1,\n\t\t\t\t[MergeTreeMaintenanceType.SPLIT]: 2,\n\t\t\t});\n\t\t});\n\n\t\tit(\"Local delete shadows remote\", () => {\n\t\t\tconst remoteClientId: number = 35;\n\t\t\tlet remoteSequenceNumber = currentSequenceNumber;\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 3,\n\t\t\t\tend: 6,\n\t\t\t\trefSeq: currentSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UnassignedSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tconst count = countOperations(mergeTree);\n\n\t\t\tmarkRangeRemoved({\n\t\t\t\tmergeTree,\n\t\t\t\tstart: 4,\n\t\t\t\tend: 5,\n\t\t\t\trefSeq: remoteSequenceNumber,\n\t\t\t\tclientId: remoteClientId,\n\t\t\t\tseq: ++remoteSequenceNumber,\n\t\t\t\toverwrite: false,\n\t\t\t\topArgs: undefined as any,\n\t\t\t});\n\n\t\t\tassert.deepStrictEqual(count, {\n\t\t\t\t/* MergeTreeDeltaType.REMOVE is absent as it should not be fired. */\n\t\t\t\t[MergeTreeMaintenanceType.SPLIT]: 2,\n\t\t\t});\n\t\t});\n\t});\n});\n"]}

package/lib/test/mergeTree.markRangeRemoved.spec.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=mergeTree.markRangeRemoved.spec.d.ts.map

package/lib/test/mergeTree.markRangeRemoved.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.markRangeRemoved.spec.d.ts","sourceRoot":"","sources":["../../src/test/mergeTree.markRangeRemoved.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/lib/test/mergeTree.markRangeRemoved.spec.js

@@ -0,0 +1,128 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { strict as assert } from "assert";
+import { UnassignedSequenceNumber } from "../constants.js";
+import { createInsertSegmentOp, createRemoveRangeOp } from "../opBuilder.js";
+import { TextSegment } from "../textSegment.js";
+import { TestClient } from "./testClient.js";
+describe("MergeTree.markRangeRemoved", () => {
+    let client;
+    beforeEach(() => {
+        client = new TestClient();
+        client.startOrUpdateCollaboration("local");
+        for (const char of "hello world") {
+            client.applyMsg(client.makeOpMessage(client.insertTextLocal(client.getLength(), char), client.getCurrentSeq() + 1));
+        }
+        assert.equal(client.getText(), "hello world");
+    });
+    it("local remove followed by local insert", () => {
+        client.removeRangeLocal(0, client.getLength());
+        assert.equal(client.getText(), "");
+        client.insertTextLocal(0, "text");
+        assert.equal(client.getText(), "text");
+    });
+    it("local insert followed by local remove", () => {
+        client.insertTextLocal(0, "text");
+        assert.equal(client.getText(), "texthello world");
+        client.removeRangeLocal(0, client.getLength());
+        assert.equal(client.getText(), "");
+    });
+    it("remote remove followed by local insert", () => {
+        client.applyMsg(client.makeOpMessage(createRemoveRangeOp(0, client.getLength()), client.mergeTree.collabWindow.currentSeq + 1, client.mergeTree.collabWindow.currentSeq, "remote"));
+        assert.equal(client.getText(), "");
+        client.insertTextLocal(0, "text");
+        assert.equal(client.getText(), "text");
+    });
+    it("local remove followed by remote insert", () => {
+        client.removeRangeLocal(0, client.getLength());
+        assert.equal(client.getText(), "");
+        client.applyMsg(client.makeOpMessage(createInsertSegmentOp(0, TextSegment.make("text")), client.mergeTree.collabWindow.currentSeq + 1, client.mergeTree.collabWindow.currentSeq, "remote"));
+        assert.equal(client.getText(), "text");
+    });
+    it("local remove followed by remote overlapping remove", () => {
+        const originalSeq = client.getCurrentSeq();
+        let seq = originalSeq;
+        const remoteDeleteMessage = client.makeOpMessage(createRemoveRangeOp(0, client.getLength()), ++seq, undefined, "remote");
+        const segmentExpectedRemovedSeq = seq;
+        const { segment } = client.getContainingSegment(0);
+        assert(segment !== undefined, "expected to find segment");
+        const localDeleteMessage = client.makeOpMessage(client.removeRangeLocal(0, client.getLength()), ++seq, originalSeq /* refSeq */);
+        assert.equal(client.getText(), "");
+        assert.equal(segment.removedSeq, UnassignedSequenceNumber);
+        assert(segment.localRemovedSeq !== undefined);
+        const expectedLocalRemovedSeq = segment.localRemovedSeq;
+        client.applyMsg(remoteDeleteMessage);
+        assert.equal(segment.removedSeq, segmentExpectedRemovedSeq);
+        assert.equal(segment.localRemovedSeq, expectedLocalRemovedSeq);
+        assert.equal(client.getText(), "");
+        // localRemovedSeq should remain on the segment until the local removal has been acked.
+        // This ensures there's enough information to determine segment length in the case of
+        // reconnect.
+        client.applyMsg(localDeleteMessage);
+        assert.equal(segment.removedSeq, segmentExpectedRemovedSeq);
+        assert.equal(segment.localRemovedSeq, undefined);
+        assert.equal(client.getText(), "");
+    });
+    it("remote remove followed by remote insert", () => {
+        const removeMsg = client.makeOpMessage(createRemoveRangeOp(0, client.getLength()), client.mergeTree.collabWindow.currentSeq + 1, client.mergeTree.collabWindow.currentSeq, "remote2");
+        const insertMsg = client.makeOpMessage(createInsertSegmentOp(0, TextSegment.make("text")), client.mergeTree.collabWindow.currentSeq + 2, client.mergeTree.collabWindow.currentSeq, "remote");
+        client.applyMsg(removeMsg);
+        client.applyMsg(insertMsg);
+        assert.equal(client.getText(), "text");
+    });
+    it("remote insert followed by remote remove", () => {
+        const insertMsg = client.makeOpMessage(createInsertSegmentOp(0, TextSegment.make("text")), client.mergeTree.collabWindow.currentSeq + 1, client.mergeTree.collabWindow.currentSeq, "remote");
+        const removeMsg = client.makeOpMessage(createRemoveRangeOp(0, client.getLength()), client.mergeTree.collabWindow.currentSeq + 2, client.mergeTree.collabWindow.currentSeq, "remote2");
+        client.applyMsg(insertMsg);
+        client.applyMsg(removeMsg);
+        assert.equal(client.getText(), "text");
+    });
+    it("local and remote clients race to insert at position of removed segment", () => {
+        // Note: This test constructs its own TestClients to avoid being initialized with "hello world".
+        // First we run through the ops from the perspective of a passive observer (i.e., all operations are remote).
+        const expected = new TestClient();
+        expected.startOrUpdateCollaboration("3");
+        {
+            let seq = 0;
+            // Client 1 locally inserts and removes the letter "a".
+            expected.insertTextRemote(0, "a", undefined, ++seq, 
+            /* refSeq: */ 0, 
+            /* longClientId: */ "1");
+            expected.removeRangeRemote(0, 1, ++seq, /* refSeq: */ 0, /* longClientId: */ "1");
+            const refSeqAt2 = expected.getCurrentSeq();
+            // In parallel, Client 2 inserted "x" without knowledge of Client 1's insertion/removal.
+            expected.insertTextRemote(0, "X", undefined, ++seq, 
+            /* refSeq: */ 0, 
+            /* longClientId: */ "2");
+            // Client 1 inserts "c" having received acks for its own edits, but has not yet having
+            // observed the insertion of "X" from client 2.
+            expected.insertTextRemote(0, "c", undefined, ++seq, refSeqAt2, /* longClientId: */ "1");
+        }
+        // Next, we run through the same sequence from the perspective of client 1:
+        const actual = new TestClient();
+        actual.startOrUpdateCollaboration("1");
+        {
+            let seq = 0;
+            // Client 1 locally inserts and removes the letter "a".
+            const op1 = actual.insertTextLocal(0, "a");
+            const op2 = actual.removeRangeLocal(0, 1);
+            // Client 1 receives ACKs for op1 and op2.
+            actual.applyMsg(actual.makeOpMessage(op1, ++seq, /* refSeq: */ 0));
+            actual.applyMsg(actual.makeOpMessage(op2, ++seq, /* refSeq: */ 0));
+            const refSeqAt2 = actual.getCurrentSeq();
+            // Client 1 locally inserts "c".
+            const op4 = actual.insertTextLocal(0, "c");
+            // Client 1 then processes the parallel insertion of "X" from Client 2 at refSeq=0
+            actual.insertTextRemote(0, "X", undefined, ++seq, 
+            /* refSeq: */ 0, 
+            /* longClientId: */ "2");
+            // Finally, client 1 receives the ack for its insertion of "c".
+            actual.applyMsg(actual.makeOpMessage(op4, ++seq, refSeqAt2));
+        }
+        assert.equal(actual.getText(), expected.getText());
+    });
+});
+//# sourceMappingURL=mergeTree.markRangeRemoved.spec.js.map

package/lib/test/mergeTree.markRangeRemoved.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.markRangeRemoved.spec.js","sourceRoot":"","sources":["../../src/test/mergeTree.markRangeRemoved.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,6DAA6D;AAE7D,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC3C,IAAI,MAAkB,CAAC;IACvB,UAAU,CAAC,GAAG,EAAE;QACf,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC1B,MAAM,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC;QAC3C,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;YACjC,MAAM,CAAC,QAAQ,CACd,MAAM,CAAC,aAAa,CACnB,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,EAChD,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAC1B,CACD,CAAC;SACF;QACD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,iBAAiB,CAAC,CAAC;QAElD,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,QAAQ,CACd,MAAM,CAAC,aAAa,CACnB,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC1C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,QAAQ,CACR,CACD,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnC,MAAM,CAAC,QAAQ,CACd,MAAM,CAAC,aAAa,CACnB,qBAAqB,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAClD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,QAAQ,CACR,CACD,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC7D,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;QAC3C,IAAI,GAAG,GAAG,WAAW,CAAC;QACtB,MAAM,mBAAmB,GAAG,MAAM,CAAC,aAAa,CAC/C,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC1C,EAAE,GAAG,EACL,SAAS,EACT,QAAQ,CACR,CAAC;QACF,MAAM,yBAAyB,GAAG,GAAG,CAAC;QACtC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,0BAA0B,CAAC,CAAC;QAC1D,MAAM,kBAAkB,GAAG,MAAM,CAAC,aAAa,CAC9C,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC9C,EAAE,GAAG,EACL,WAAW,CAAC,YAAY,CACxB,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;QAC9C,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC;QAExD,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QACrC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;QAC5D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,uBAAuB,CAAC,CAAC;QAC/D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnC,uFAAuF;QACvF,qFAAqF;QACrF,aAAa;QACb,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QACpC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;QAC5D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CACrC,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC1C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,SAAS,CACT,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CACrC,qBAAqB,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAClD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,QAAQ,CACR,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC3B,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE3B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CACrC,qBAAqB,CAAC,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAClD,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,QAAQ,CACR,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CACrC,mBAAmB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC1C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,GAAG,CAAC,EAC5C,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,EACxC,SAAS,CACT,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAC3B,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE3B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QACjF,gGAAgG;QAEhG,6GAA6G;QAC7G,MAAM,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAC;QAClC,QAAQ,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC;QAEzC;YACC,IAAI,GAAG,GAAG,CAAC,CAAC;YAEZ,uDAAuD;YACvD,QAAQ,CAAC,gBAAgB,CACxB,CAAC,EACD,GAAG,EACH,SAAS,EACT,EAAE,GAAG;YACL,aAAa,CAAC,CAAC;YACf,mBAAmB,CAAC,GAAG,CACvB,CAAC;YACF,QAAQ,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAClF,MAAM,SAAS,GAAG,QAAQ,CAAC,aAAa,EAAE,CAAC;YAE3C,wFAAwF;YACxF,QAAQ,CAAC,gBAAgB,CACxB,CAAC,EACD,GAAG,EACH,SAAS,EACT,EAAE,GAAG;YACL,aAAa,CAAC,CAAC;YACf,mBAAmB,CAAC,GAAG,CACvB,CAAC;YAEF,sFAAsF;YACtF,+CAA+C;YAC/C,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC;SACxF;QAED,2EAA2E;QAC3E,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC;QAEvC;YACC,IAAI,GAAG,GAAG,CAAC,CAAC;YAEZ,uDAAuD;YACvD,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,GAAG,CAAE,CAAC;YAC5C,MAAM,GAAG,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAE1C,0CAA0C;YAC1C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YACnE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YACnE,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;YAEzC,gCAAgC;YAChC,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE3C,kFAAkF;YAClF,MAAM,CAAC,gBAAgB,CACtB,CAAC,EACD,GAAG,EACH,SAAS,EACT,EAAE,GAAG;YACL,aAAa,CAAC,CAAC;YACf,mBAAmB,CAAC,GAAG,CACvB,CAAC;YAEF,+DAA+D;YAC/D,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;SAC7D;QAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,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/* eslint-disable @typescript-eslint/no-non-null-assertion */\n\nimport { strict as assert } from \"assert\";\nimport { UnassignedSequenceNumber } from \"../constants.js\";\nimport { createInsertSegmentOp, createRemoveRangeOp } from \"../opBuilder.js\";\nimport { TextSegment } from \"../textSegment.js\";\nimport { TestClient } from \"./testClient.js\";\n\ndescribe(\"MergeTree.markRangeRemoved\", () => {\n\tlet client: TestClient;\n\tbeforeEach(() => {\n\t\tclient = new TestClient();\n\t\tclient.startOrUpdateCollaboration(\"local\");\n\t\tfor (const char of \"hello world\") {\n\t\t\tclient.applyMsg(\n\t\t\t\tclient.makeOpMessage(\n\t\t\t\t\tclient.insertTextLocal(client.getLength(), char),\n\t\t\t\t\tclient.getCurrentSeq() + 1,\n\t\t\t\t),\n\t\t\t);\n\t\t}\n\t\tassert.equal(client.getText(), \"hello world\");\n\t});\n\n\tit(\"local remove followed by local insert\", () => {\n\t\tclient.removeRangeLocal(0, client.getLength());\n\t\tassert.equal(client.getText(), \"\");\n\n\t\tclient.insertTextLocal(0, \"text\");\n\t\tassert.equal(client.getText(), \"text\");\n\t});\n\n\tit(\"local insert followed by local remove\", () => {\n\t\tclient.insertTextLocal(0, \"text\");\n\t\tassert.equal(client.getText(), \"texthello world\");\n\n\t\tclient.removeRangeLocal(0, client.getLength());\n\t\tassert.equal(client.getText(), \"\");\n\t});\n\n\tit(\"remote remove followed by local insert\", () => {\n\t\tclient.applyMsg(\n\t\t\tclient.makeOpMessage(\n\t\t\t\tcreateRemoveRangeOp(0, client.getLength()),\n\t\t\t\tclient.mergeTree.collabWindow.currentSeq + 1,\n\t\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\t\"remote\",\n\t\t\t),\n\t\t);\n\n\t\tassert.equal(client.getText(), \"\");\n\n\t\tclient.insertTextLocal(0, \"text\");\n\t\tassert.equal(client.getText(), \"text\");\n\t});\n\n\tit(\"local remove followed by remote insert\", () => {\n\t\tclient.removeRangeLocal(0, client.getLength());\n\t\tassert.equal(client.getText(), \"\");\n\n\t\tclient.applyMsg(\n\t\t\tclient.makeOpMessage(\n\t\t\t\tcreateInsertSegmentOp(0, TextSegment.make(\"text\")),\n\t\t\t\tclient.mergeTree.collabWindow.currentSeq + 1,\n\t\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\t\"remote\",\n\t\t\t),\n\t\t);\n\n\t\tassert.equal(client.getText(), \"text\");\n\t});\n\n\tit(\"local remove followed by remote overlapping remove\", () => {\n\t\tconst originalSeq = client.getCurrentSeq();\n\t\tlet seq = originalSeq;\n\t\tconst remoteDeleteMessage = client.makeOpMessage(\n\t\t\tcreateRemoveRangeOp(0, client.getLength()),\n\t\t\t++seq,\n\t\t\tundefined,\n\t\t\t\"remote\",\n\t\t);\n\t\tconst segmentExpectedRemovedSeq = seq;\n\t\tconst { segment } = client.getContainingSegment(0);\n\t\tassert(segment !== undefined, \"expected to find segment\");\n\t\tconst localDeleteMessage = client.makeOpMessage(\n\t\t\tclient.removeRangeLocal(0, client.getLength()),\n\t\t\t++seq,\n\t\t\toriginalSeq /* refSeq */,\n\t\t);\n\n\t\tassert.equal(client.getText(), \"\");\n\t\tassert.equal(segment.removedSeq, UnassignedSequenceNumber);\n\t\tassert(segment.localRemovedSeq !== undefined);\n\t\tconst expectedLocalRemovedSeq = segment.localRemovedSeq;\n\n\t\tclient.applyMsg(remoteDeleteMessage);\n\t\tassert.equal(segment.removedSeq, segmentExpectedRemovedSeq);\n\t\tassert.equal(segment.localRemovedSeq, expectedLocalRemovedSeq);\n\t\tassert.equal(client.getText(), \"\");\n\n\t\t// localRemovedSeq should remain on the segment until the local removal has been acked.\n\t\t// This ensures there's enough information to determine segment length in the case of\n\t\t// reconnect.\n\t\tclient.applyMsg(localDeleteMessage);\n\t\tassert.equal(segment.removedSeq, segmentExpectedRemovedSeq);\n\t\tassert.equal(segment.localRemovedSeq, undefined);\n\t\tassert.equal(client.getText(), \"\");\n\t});\n\n\tit(\"remote remove followed by remote insert\", () => {\n\t\tconst removeMsg = client.makeOpMessage(\n\t\t\tcreateRemoveRangeOp(0, client.getLength()),\n\t\t\tclient.mergeTree.collabWindow.currentSeq + 1,\n\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\"remote2\",\n\t\t);\n\n\t\tconst insertMsg = client.makeOpMessage(\n\t\t\tcreateInsertSegmentOp(0, TextSegment.make(\"text\")),\n\t\t\tclient.mergeTree.collabWindow.currentSeq + 2,\n\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\"remote\",\n\t\t);\n\n\t\tclient.applyMsg(removeMsg);\n\t\tclient.applyMsg(insertMsg);\n\n\t\tassert.equal(client.getText(), \"text\");\n\t});\n\n\tit(\"remote insert followed by remote remove\", () => {\n\t\tconst insertMsg = client.makeOpMessage(\n\t\t\tcreateInsertSegmentOp(0, TextSegment.make(\"text\")),\n\t\t\tclient.mergeTree.collabWindow.currentSeq + 1,\n\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\"remote\",\n\t\t);\n\n\t\tconst removeMsg = client.makeOpMessage(\n\t\t\tcreateRemoveRangeOp(0, client.getLength()),\n\t\t\tclient.mergeTree.collabWindow.currentSeq + 2,\n\t\t\tclient.mergeTree.collabWindow.currentSeq,\n\t\t\t\"remote2\",\n\t\t);\n\n\t\tclient.applyMsg(insertMsg);\n\t\tclient.applyMsg(removeMsg);\n\n\t\tassert.equal(client.getText(), \"text\");\n\t});\n\n\tit(\"local and remote clients race to insert at position of removed segment\", () => {\n\t\t// Note: This test constructs its own TestClients to avoid being initialized with \"hello world\".\n\n\t\t// First we run through the ops from the perspective of a passive observer (i.e., all operations are remote).\n\t\tconst expected = new TestClient();\n\t\texpected.startOrUpdateCollaboration(\"3\");\n\n\t\t{\n\t\t\tlet seq = 0;\n\n\t\t\t// Client 1 locally inserts and removes the letter \"a\".\n\t\t\texpected.insertTextRemote(\n\t\t\t\t0,\n\t\t\t\t\"a\",\n\t\t\t\tundefined,\n\t\t\t\t++seq,\n\t\t\t\t/* refSeq: */ 0,\n\t\t\t\t/* longClientId: */ \"1\",\n\t\t\t);\n\t\t\texpected.removeRangeRemote(0, 1, ++seq, /* refSeq: */ 0, /* longClientId: */ \"1\");\n\t\t\tconst refSeqAt2 = expected.getCurrentSeq();\n\n\t\t\t// In parallel, Client 2 inserted \"x\" without knowledge of Client 1's insertion/removal.\n\t\t\texpected.insertTextRemote(\n\t\t\t\t0,\n\t\t\t\t\"X\",\n\t\t\t\tundefined,\n\t\t\t\t++seq,\n\t\t\t\t/* refSeq: */ 0,\n\t\t\t\t/* longClientId: */ \"2\",\n\t\t\t);\n\n\t\t\t// Client 1 inserts \"c\" having received acks for its own edits, but has not yet having\n\t\t\t// observed the insertion of \"X\" from client 2.\n\t\t\texpected.insertTextRemote(0, \"c\", undefined, ++seq, refSeqAt2, /* longClientId: */ \"1\");\n\t\t}\n\n\t\t// Next, we run through the same sequence from the perspective of client 1:\n\t\tconst actual = new TestClient();\n\t\tactual.startOrUpdateCollaboration(\"1\");\n\n\t\t{\n\t\t\tlet seq = 0;\n\n\t\t\t// Client 1 locally inserts and removes the letter \"a\".\n\t\t\tconst op1 = actual.insertTextLocal(0, \"a\")!;\n\t\t\tconst op2 = actual.removeRangeLocal(0, 1);\n\n\t\t\t// Client 1 receives ACKs for op1 and op2.\n\t\t\tactual.applyMsg(actual.makeOpMessage(op1, ++seq, /* refSeq: */ 0));\n\t\t\tactual.applyMsg(actual.makeOpMessage(op2, ++seq, /* refSeq: */ 0));\n\t\t\tconst refSeqAt2 = actual.getCurrentSeq();\n\n\t\t\t// Client 1 locally inserts \"c\".\n\t\t\tconst op4 = actual.insertTextLocal(0, \"c\");\n\n\t\t\t// Client 1 then processes the parallel insertion of \"X\" from Client 2 at refSeq=0\n\t\t\tactual.insertTextRemote(\n\t\t\t\t0,\n\t\t\t\t\"X\",\n\t\t\t\tundefined,\n\t\t\t\t++seq,\n\t\t\t\t/* refSeq: */ 0,\n\t\t\t\t/* longClientId: */ \"2\",\n\t\t\t);\n\n\t\t\t// Finally, client 1 receives the ack for its insertion of \"c\".\n\t\t\tactual.applyMsg(actual.makeOpMessage(op4, ++seq, refSeqAt2));\n\t\t}\n\n\t\tassert.equal(actual.getText(), expected.getText());\n\t});\n});\n"]}

package/lib/test/mergeTree.walk.spec.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=mergeTree.walk.spec.d.ts.map

package/lib/test/mergeTree.walk.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.walk.spec.d.ts","sourceRoot":"","sources":["../../src/test/mergeTree.walk.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/lib/test/mergeTree.walk.spec.js

@@ -0,0 +1,61 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { MaxNodesInBlock } from "../mergeTreeNodes.js";
+import { TextSegment } from "../textSegment.js";
+import { LocalClientId, UniversalSequenceNumber } from "../constants.js";
+import { MergeTree } from "../mergeTree.js";
+import { walkAllChildSegments } from "../mergeTreeNodeWalk.js";
+import { insertText } from "./testUtils.js";
+const localClientId = 17;
+describe("MergeTree walks", () => {
+    let mergeTree;
+    beforeEach(() => {
+        let initialText = "0";
+        mergeTree = new MergeTree();
+        mergeTree.insertSegments(0, [TextSegment.make(initialText)], UniversalSequenceNumber, LocalClientId, UniversalSequenceNumber, undefined);
+        for (let i = 1; i < MaxNodesInBlock * MaxNodesInBlock; i++) {
+            const text = i.toString();
+            insertText({
+                mergeTree,
+                pos: mergeTree.getLength(UniversalSequenceNumber, localClientId),
+                refSeq: UniversalSequenceNumber,
+                clientId: localClientId,
+                seq: UniversalSequenceNumber,
+                text,
+                props: undefined,
+                opArgs: undefined,
+            });
+            initialText += text;
+        }
+    });
+    describe("walkAllChildSegments", () => {
+        function* getAllDescendantBlocks(block) {
+            yield block;
+            for (let i = 0; i < block.childCount; i++) {
+                const child = block.children[i];
+                if (!child.isLeaf()) {
+                    yield* getAllDescendantBlocks(child);
+                }
+            }
+        }
+        it("visits only descendants", () => {
+            for (const block of getAllDescendantBlocks(mergeTree.root)) {
+                let walkedAnySegments = false;
+                walkAllChildSegments(block, (seg) => {
+                    walkedAnySegments = true;
+                    let current = seg.parent;
+                    while (current !== block && current !== undefined) {
+                        current = current.parent;
+                    }
+                    assert(current === block, "Expected all visited segments to be descendants");
+                    return true;
+                });
+                assert(walkedAnySegments, "Walk should have hit segments");
+            }
+        });
+    });
+});
+//# sourceMappingURL=mergeTree.walk.spec.js.map

package/lib/test/mergeTree.walk.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.walk.spec.js","sourceRoot":"","sources":["../../src/test/mergeTree.walk.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAA6B,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAClF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,aAAa,GAAG,EAAE,CAAC;AAEzB,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAChC,IAAI,SAAoB,CAAC;IACzB,UAAU,CAAC,GAAG,EAAE;QACf,IAAI,WAAW,GAAG,GAAG,CAAC;QACtB,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,SAAS,CAAC,cAAc,CACvB,CAAC,EACD,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,EAC/B,uBAAuB,EACvB,aAAa,EACb,uBAAuB,EACvB,SAAS,CACT,CAAC;QACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,GAAG,eAAe,EAAE,CAAC,EAAE,EAAE;YAC3D,MAAM,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC1B,UAAU,CAAC;gBACV,SAAS;gBACT,GAAG,EAAE,SAAS,CAAC,SAAS,CAAC,uBAAuB,EAAE,aAAa,CAAC;gBAChE,MAAM,EAAE,uBAAuB;gBAC/B,QAAQ,EAAE,aAAa;gBACvB,GAAG,EAAE,uBAAuB;gBAC5B,IAAI;gBACJ,KAAK,EAAE,SAAS;gBAChB,MAAM,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,WAAW,IAAI,IAAI,CAAC;SACpB;IACF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACrC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,KAAkB;YAClD,MAAM,KAAK,CAAC;YACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE;gBAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE;oBACpB,KAAK,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;iBACrC;aACD;QACF,CAAC;QAED,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YAClC,KAAK,MAAM,KAAK,IAAI,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;gBAC3D,IAAI,iBAAiB,GAAG,KAAK,CAAC;gBAC9B,oBAAoB,CAAC,KAAK,EAAE,CAAC,GAAiB,EAAE,EAAE;oBACjD,iBAAiB,GAAG,IAAI,CAAC;oBACzB,IAAI,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC;oBACzB,OAAO,OAAO,KAAK,KAAK,IAAI,OAAO,KAAK,SAAS,EAAE;wBAClD,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;qBACzB;oBACD,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,iDAAiD,CAAC,CAAC;oBAC7E,OAAO,IAAI,CAAC;gBACb,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,iBAAiB,EAAE,+BAA+B,CAAC,CAAC;aAC3D;QACF,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 { strict as assert } from \"assert\";\nimport { IMergeBlock, ISegmentLeaf, MaxNodesInBlock } from \"../mergeTreeNodes.js\";\nimport { TextSegment } from \"../textSegment.js\";\nimport { LocalClientId, UniversalSequenceNumber } from \"../constants.js\";\nimport { MergeTree } from \"../mergeTree.js\";\nimport { walkAllChildSegments } from \"../mergeTreeNodeWalk.js\";\nimport { insertText } from \"./testUtils.js\";\n\nconst localClientId = 17;\n\ndescribe(\"MergeTree walks\", () => {\n\tlet mergeTree: MergeTree;\n\tbeforeEach(() => {\n\t\tlet initialText = \"0\";\n\t\tmergeTree = new MergeTree();\n\t\tmergeTree.insertSegments(\n\t\t\t0,\n\t\t\t[TextSegment.make(initialText)],\n\t\t\tUniversalSequenceNumber,\n\t\t\tLocalClientId,\n\t\t\tUniversalSequenceNumber,\n\t\t\tundefined,\n\t\t);\n\t\tfor (let i = 1; i < MaxNodesInBlock * MaxNodesInBlock; i++) {\n\t\t\tconst text = i.toString();\n\t\t\tinsertText({\n\t\t\t\tmergeTree,\n\t\t\t\tpos: mergeTree.getLength(UniversalSequenceNumber, localClientId),\n\t\t\t\trefSeq: UniversalSequenceNumber,\n\t\t\t\tclientId: localClientId,\n\t\t\t\tseq: UniversalSequenceNumber,\n\t\t\t\ttext,\n\t\t\t\tprops: undefined,\n\t\t\t\topArgs: undefined,\n\t\t\t});\n\t\t\tinitialText += text;\n\t\t}\n\t});\n\n\tdescribe(\"walkAllChildSegments\", () => {\n\t\tfunction* getAllDescendantBlocks(block: IMergeBlock): Iterable<IMergeBlock> {\n\t\t\tyield block;\n\t\t\tfor (let i = 0; i < block.childCount; i++) {\n\t\t\t\tconst child = block.children[i];\n\t\t\t\tif (!child.isLeaf()) {\n\t\t\t\t\tyield* getAllDescendantBlocks(child);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tit(\"visits only descendants\", () => {\n\t\t\tfor (const block of getAllDescendantBlocks(mergeTree.root)) {\n\t\t\t\tlet walkedAnySegments = false;\n\t\t\t\twalkAllChildSegments(block, (seg: ISegmentLeaf) => {\n\t\t\t\t\twalkedAnySegments = true;\n\t\t\t\t\tlet current = seg.parent;\n\t\t\t\t\twhile (current !== block && current !== undefined) {\n\t\t\t\t\t\tcurrent = current.parent;\n\t\t\t\t\t}\n\t\t\t\t\tassert(current === block, \"Expected all visited segments to be descendants\");\n\t\t\t\t\treturn true;\n\t\t\t\t});\n\t\t\t\tassert(walkedAnySegments, \"Walk should have hit segments\");\n\t\t\t}\n\t\t});\n\t});\n});\n"]}

package/lib/test/mergeTree.zamboni.spec.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=mergeTree.zamboni.spec.d.ts.map

package/lib/test/mergeTree.zamboni.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.zamboni.spec.d.ts","sourceRoot":"","sources":["../../src/test/mergeTree.zamboni.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/lib/test/mergeTree.zamboni.spec.js

@@ -0,0 +1,50 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { zamboniSegments, packParent } from "../zamboni.js";
+import { TestClient } from "./testClient.js";
+describe("Zamboni Logic", () => {
+    let client;
+    const localUserLongId = "localUser";
+    beforeEach(() => {
+        client = new TestClient();
+        for (const c of "hello world") {
+            client.insertTextLocal(client.getLength(), c);
+        }
+        client.startOrUpdateCollaboration(localUserLongId);
+    });
+    it("packParent with no children segments", () => {
+        client.applyMsg(client.makeOpMessage(client.removeRangeLocal(0, client.getLength() - 1), 1));
+        packParent(client.mergeTree.root, client.mergeTree);
+        assert.equal(client.mergeTree.root.cachedLength, 1);
+        client.applyMsg(client.makeOpMessage(client.removeRangeLocal(0, client.getLength()), client.getCurrentSeq(), client.getCurrentSeq(), undefined, client.getCurrentSeq()));
+        assert.equal(client.mergeTree.root.cachedLength ?? 0, 0);
+        packParent(client.mergeTree.root, client.mergeTree);
+        assert.equal(client.mergeTree.root.childCount, 0);
+    });
+    it("zamboni with no segments to scour", () => {
+        const cachedLength = client.mergeTree.root.cachedLength;
+        const childCount = client.mergeTree.root.childCount;
+        zamboniSegments(client.mergeTree);
+        assert.equal(cachedLength, client.mergeTree.root.cachedLength);
+        assert.equal(childCount, client.mergeTree.root.childCount);
+    });
+    it("zamboni with one segment to scour", () => {
+        const initialChildCount = client.mergeTree.root.children[0].childCount;
+        const initialCachedLength = client.mergeTree.root.cachedLength ?? 0;
+        client.removeRangeLocal(0, 1);
+        zamboniSegments(client.mergeTree);
+        assert.equal(client.mergeTree.root.cachedLength, initialCachedLength - 1);
+        assert.equal(client.mergeTree.root.children[0].childCount, initialChildCount);
+    });
+    it("zamboni with many segments to scour", () => {
+        client.removeRangeLocal(0, 6);
+        assert.equal(client.mergeTree.root.children[0].cachedLength, 0);
+        zamboniSegments(client.mergeTree);
+        packParent(client.mergeTree.root, client.mergeTree);
+        assert.equal(client.mergeTree.root.childCount, 1);
+    });
+});
+//# sourceMappingURL=mergeTree.zamboni.spec.js.map

package/lib/test/mergeTree.zamboni.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTree.zamboni.spec.js","sourceRoot":"","sources":["../../src/test/mergeTree.zamboni.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC9B,IAAI,MAAkB,CAAC;IACvB,MAAM,eAAe,GAAG,WAAW,CAAC;IACpC,UAAU,CAAC,GAAG,EAAE;QACf,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE;YAC9B,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;SAC9C;QACD,MAAM,CAAC,0BAA0B,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,QAAQ,CACd,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAC3E,CAAC;QACF,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAEpD,MAAM,CAAC,QAAQ,CACd,MAAM,CAAC,aAAa,CACnB,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,EAC9C,MAAM,CAAC,aAAa,EAAE,EACtB,MAAM,CAAC,aAAa,EAAE,EACtB,SAAS,EACT,MAAM,CAAC,aAAa,EAAE,CACtB,CACD,CAAC;QACF,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAEzD,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC5C,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC;QACxD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC;QAEpD,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC5C,MAAM,iBAAiB,GAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAiB,CAAC,UAAU,CAAC;QACxF,MAAM,mBAAmB,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;QACpE,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,mBAAmB,GAAG,CAAC,CAAC,CAAC;QAC1E,MAAM,CAAC,KAAK,CACV,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAiB,CAAC,UAAU,EAC7D,iBAAiB,CACjB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE9B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAEhE,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IACnD,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 { IMergeBlock } from \"../mergeTreeNodes.js\";\nimport { zamboniSegments, packParent } from \"../zamboni.js\";\nimport { TestClient } from \"./testClient.js\";\n\ndescribe(\"Zamboni Logic\", () => {\n\tlet client: TestClient;\n\tconst localUserLongId = \"localUser\";\n\tbeforeEach(() => {\n\t\tclient = new TestClient();\n\t\tfor (const c of \"hello world\") {\n\t\t\tclient.insertTextLocal(client.getLength(), c);\n\t\t}\n\t\tclient.startOrUpdateCollaboration(localUserLongId);\n\t});\n\tit(\"packParent with no children segments\", () => {\n\t\tclient.applyMsg(\n\t\t\tclient.makeOpMessage(client.removeRangeLocal(0, client.getLength() - 1), 1),\n\t\t);\n\t\tpackParent(client.mergeTree.root, client.mergeTree);\n\t\tassert.equal(client.mergeTree.root.cachedLength, 1);\n\n\t\tclient.applyMsg(\n\t\t\tclient.makeOpMessage(\n\t\t\t\tclient.removeRangeLocal(0, client.getLength()),\n\t\t\t\tclient.getCurrentSeq(),\n\t\t\t\tclient.getCurrentSeq(),\n\t\t\t\tundefined,\n\t\t\t\tclient.getCurrentSeq(),\n\t\t\t),\n\t\t);\n\t\tassert.equal(client.mergeTree.root.cachedLength ?? 0, 0);\n\n\t\tpackParent(client.mergeTree.root, client.mergeTree);\n\n\t\tassert.equal(client.mergeTree.root.childCount, 0);\n\t});\n\tit(\"zamboni with no segments to scour\", () => {\n\t\tconst cachedLength = client.mergeTree.root.cachedLength;\n\t\tconst childCount = client.mergeTree.root.childCount;\n\n\t\tzamboniSegments(client.mergeTree);\n\n\t\tassert.equal(cachedLength, client.mergeTree.root.cachedLength);\n\t\tassert.equal(childCount, client.mergeTree.root.childCount);\n\t});\n\tit(\"zamboni with one segment to scour\", () => {\n\t\tconst initialChildCount = (client.mergeTree.root.children[0] as IMergeBlock).childCount;\n\t\tconst initialCachedLength = client.mergeTree.root.cachedLength ?? 0;\n\t\tclient.removeRangeLocal(0, 1);\n\t\tzamboniSegments(client.mergeTree);\n\n\t\tassert.equal(client.mergeTree.root.cachedLength, initialCachedLength - 1);\n\t\tassert.equal(\n\t\t\t(client.mergeTree.root.children[0] as IMergeBlock).childCount,\n\t\t\tinitialChildCount,\n\t\t);\n\t});\n\tit(\"zamboni with many segments to scour\", () => {\n\t\tclient.removeRangeLocal(0, 6);\n\n\t\tassert.equal(client.mergeTree.root.children[0].cachedLength, 0);\n\n\t\tzamboniSegments(client.mergeTree);\n\t\tpackParent(client.mergeTree.root, client.mergeTree);\n\n\t\tassert.equal(client.mergeTree.root.childCount, 1);\n\t});\n});\n"]}

package/lib/test/mergeTreeOperationRunner.d.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { IRandom } from "@fluid-private/stochastic-test-utils";
+import { IMergeTreeOp } from "../ops.js";
+import { SegmentGroup } from "../mergeTreeNodes.js";
+import { TestClient } from "./testClient.js";
+import { TestClientLogger } from "./testClientLogger.js";
+export type TestOperation = (client: TestClient, opStart: number, opEnd: number, random: IRandom) => IMergeTreeOp | undefined;
+export declare const removeRange: TestOperation;
+export declare const obliterateRange: TestOperation;
+export declare const annotateRange: TestOperation;
+export declare const insertAtRefPos: TestOperation;
+export declare const insert: TestOperation;
+export interface IConfigRange {
+    min: number;
+    max: number;
+    growthFunc?: (input: number) => number;
+}
+export declare function doOverRange(range: IConfigRange, defaultGrowthFunc: (input: number) => number, doAction: (current: number) => void): void;
+export declare function resolveRange(range: IConfigRange, defaultGrowthFunc: (input: number) => number): number[];
+export declare function resolveRanges<T extends object>(ranges: T, defaultGrowthFunc: (input: number) => number): ResolvedRanges<T>;
+type ReplaceRangeWith<T, TReplace> = T extends {
+    min: number;
+    max: number;
+} ? TReplace : never;
+type RangePropertyNames<T> = {
+    [K in keyof T]-?: T[K] extends IConfigRange ? K : never;
+}[keyof T];
+type PickFromRanges<T> = {
+    [K in RangePropertyNames<T>]: ReplaceRangeWith<T[K], number>;
+};
+type ResolvedRanges<T> = {
+    [K in RangePropertyNames<T>]: ReplaceRangeWith<T[K], number[]>;
+};
+interface ProvidesGrowthFunc {
+    growthFunc: (input: number) => number;
+}
+export declare function doOverRanges<T extends ProvidesGrowthFunc>(ranges: T, doAction: (selection: PickFromRanges<T>, description: string) => void): void;
+export interface IMergeTreeOperationRunnerConfig {
+    readonly rounds: number;
+    readonly opsPerRoundRange: IConfigRange;
+    readonly incrementalLog?: boolean;
+    readonly operations: readonly TestOperation[];
+    growthFunc(input: number): number;
+    resultsFilePostfix?: string;
+}
+export interface ReplayGroup {
+    msgs: ISequencedDocumentMessage[];
+    initialText: string;
+    resultText: string;
+    seq: number;
+}
+export declare const replayResultsPath: string;
+export declare function runMergeTreeOperationRunner(random: IRandom, startingSeq: number, clients: readonly TestClient[], minLength: number, config: IMergeTreeOperationRunnerConfig, apply?: ApplyMessagesFn): number;
+export declare function generateOperationMessagesForClients(random: IRandom, startingSeq: number, clients: readonly TestClient[], logger: TestClientLogger, opsPerRound: number, minLength: number, operations: readonly TestOperation[]): [ISequencedDocumentMessage, SegmentGroup | SegmentGroup[]][];
+export declare function generateClientNames(): string[];
+type ApplyMessagesFn = (startingSeq: number, messageData: [ISequencedDocumentMessage, SegmentGroup | SegmentGroup[]][], clients: readonly TestClient[], logger: TestClientLogger, random: IRandom) => number;
+export declare function applyMessages(startingSeq: number, messageData: [ISequencedDocumentMessage, SegmentGroup | SegmentGroup[]][], clients: readonly TestClient[], logger: TestClientLogger): number;
+export {};
+//# sourceMappingURL=mergeTreeOperationRunner.d.ts.map

package/lib/test/mergeTreeOperationRunner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeTreeOperationRunner.d.ts","sourceRoot":"","sources":["../../src/test/mergeTreeOperationRunner.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAqC,MAAM,WAAW,CAAC;AAE5E,OAAO,EAAY,YAAY,EAAiB,MAAM,sBAAsB,CAAC;AAE7E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,MAAM,MAAM,aAAa,GAAG,CAC3B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,OAAO,KACX,YAAY,GAAG,SAAS,CAAC;AAE9B,eAAO,MAAM,WAAW,EAAE,aACc,CAAC;AAEzC,eAAO,MAAM,eAAe,EAAE,aAIkB,CAAC;AAEjD,eAAO,MAAM,aAAa,EAAE,aAC+C,CAAC;AAE5E,eAAO,MAAM,cAAc,EAAE,aAqC5B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,aAWpB,CAAC;AAEF,MAAM,WAAW,YAAY;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACvC;AAED,wBAAgB,WAAW,CAC1B,KAAK,EAAE,YAAY,EACnB,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAC5C,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,QAoBnC;AAED,wBAAgB,YAAY,CAC3B,KAAK,EAAE,YAAY,EACnB,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAC1C,MAAM,EAAE,CAMV;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC7C,MAAM,EAAE,CAAC,EACT,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAC1C,cAAc,CAAC,CAAC,CAAC,CAQnB;AAMD,KAAK,gBAAgB,CAAC,CAAC,EAAE,QAAQ,IAAI,CAAC,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,QAAQ,GAAG,KAAK,CAAC;AAE/F,KAAK,kBAAkB,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,KAAK;CAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AAElG,KAAK,cAAc,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;CAC5D,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9D,CAAC;AAEF,UAAU,kBAAkB;IAC3B,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACtC;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,kBAAkB,EACxD,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,KAAK,IAAI,QAyBrE;AAED,MAAM,WAAW,+BAA+B;IAC/C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC;IACxC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,UAAU,EAAE,SAAS,aAAa,EAAE,CAAC;IAC9C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,yBAAyB,EAAE,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,eAAO,MAAM,iBAAiB,QAAuC,CAAC;AAEtE,wBAAgB,2BAA2B,CAC1C,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,+BAA+B,EACvC,KAAK,GAAE,eAA+B,UA6CtC;AAED,wBAAgB,mCAAmC,CAClD,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,MAAM,EAAE,gBAAgB,EACxB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,SAAS,aAAa,EAAE,gEA+CpC;AAED,wBAAgB,mBAAmB,IAAI,MAAM,EAAE,CAc9C;AAED,KAAK,eAAe,GAAG,CACtB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,yBAAyB,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC,EAAE,EACzE,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,MAAM,EAAE,gBAAgB,EACxB,MAAM,EAAE,OAAO,KACX,MAAM,CAAC;AAEZ,wBAAgB,aAAa,CAC5B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,yBAAyB,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC,EAAE,EACzE,OAAO,EAAE,SAAS,UAAU,EAAE,EAC9B,MAAM,EAAE,gBAAgB,UAexB"}

package/lib/test/mergeTreeOperationRunner.js

@@ -0,0 +1,207 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { strict as assert } from "assert";
+import * as fs from "fs";
+import { MergeTreeDeltaType, ReferenceType } from "../ops.js";
+import { TextSegment } from "../textSegment.js";
+import { toRemovalInfo } from "../mergeTreeNodes.js";
+import { walkAllChildSegments } from "../mergeTreeNodeWalk.js";
+import { TestClientLogger } from "./testClientLogger.js";
+import { _dirname } from "./dirname.cjs";
+export const removeRange = (client, opStart, opEnd) => client.removeRangeLocal(opStart, opEnd);
+export const obliterateRange = (client, opStart, opEnd) => client.obliterateRangeLocal(opStart, opEnd);
+export const annotateRange = (client, opStart, opEnd) => client.annotateRangeLocal(opStart, opEnd, { client: client.longClientId });
+export const insertAtRefPos = (client, opStart, opEnd, random) => {
+    const segs = [];
+    // gather all the segments at the pos, including removed segments
+    walkAllChildSegments(client.mergeTree.root, (seg) => {
+        const pos = client.getPosition(seg);
+        if (pos >= opStart) {
+            if (pos <= opStart) {
+                segs.push(seg);
+                return true;
+            }
+            return false;
+        }
+        return true;
+    });
+    if (segs.length > 0) {
+        const text = client.longClientId.repeat(random.integer(1, 3));
+        const seg = random.pick(segs);
+        const lref = client.createLocalReferencePosition(seg, toRemovalInfo(seg) ? 0 : random.integer(0, seg.cachedLength - 1), toRemovalInfo(seg)
+            ? ReferenceType.SlideOnRemove
+            : random.pick([
+                ReferenceType.Simple,
+                ReferenceType.SlideOnRemove,
+                ReferenceType.Transient,
+            ]), undefined);
+        return client.insertAtReferencePositionLocal(lref, TextSegment.make(text));
+    }
+};
+export const insert = (client, _start, _end, random) => {
+    // Note: the _start param is generated using exclusive range. This provides more coverage by allowing
+    // insertion at the end.
+    const start = random.integer(0, client.getLength());
+    const text = client.longClientId.repeat(random.integer(1, 3));
+    return client.insertTextLocal(start, text);
+};
+export function doOverRange(range, defaultGrowthFunc, doAction) {
+    let lastCurrent = Number.NaN;
+    for (let current = range.min; current <= range.max; current = (range.growthFunc ?? defaultGrowthFunc)(current)) {
+        // let growth funcs be simple
+        // especially around 0 and 1
+        // if the value didn't change,
+        // just increment it
+        if (current === lastCurrent) {
+            current++;
+        }
+        if (current <= range.max) {
+            lastCurrent = current;
+            doAction(current);
+        }
+    }
+}
+export function resolveRange(range, defaultGrowthFunc) {
+    const results = [];
+    doOverRange(range, range.growthFunc ?? defaultGrowthFunc, (num) => {
+        results.push(num);
+    });
+    return results;
+}
+export function resolveRanges(ranges, defaultGrowthFunc) {
+    return Object.entries(ranges)
+        .filter(([_, value]) => isConfigRange(value))
+        .map(([key, value]) => [key, resolveRange(value, defaultGrowthFunc)])
+        .reduce((prev, [key, resolvedRange]) => {
+        prev[key] = resolvedRange;
+        return prev;
+    }, {});
+}
+function isConfigRange(t) {
+    return typeof t === "object" && typeof t.min === "number" && typeof t.max === "number";
+}
+export function doOverRanges(ranges, doAction) {
+    const rangeEntries = Object.entries(ranges).filter(([_, value]) => isConfigRange(value));
+    const doOverRangesHelper = (selections) => {
+        if (selections.length === rangeEntries.length) {
+            const selectionsObj = {};
+            for (const [key, value] of selections) {
+                selectionsObj[key] = value;
+            }
+            const description = selections.map(([key, value]) => `${key}:${value}`).join("_");
+            doAction(selectionsObj, description);
+        }
+        else {
+            const [key, value] = rangeEntries[selections.length];
+            doOverRange(value, value.growthFunc ?? ranges.growthFunc, (selection) => {
+                selections.push([key, selection]);
+                doOverRangesHelper(selections);
+                selections.pop();
+            });
+        }
+    };
+    doOverRangesHelper([]);
+}
+export const replayResultsPath = `${_dirname}/../../src/test/results`;
+export function runMergeTreeOperationRunner(random, startingSeq, clients, minLength, config, apply = applyMessages) {
+    let seq = startingSeq;
+    const results = [];
+    doOverRange(config.opsPerRoundRange, config.growthFunc, (opsPerRound) => {
+        if (config.incrementalLog) {
+            console.log(`MinLength: ${minLength} Clients: ${clients.length} Ops: ${opsPerRound} Seq: ${seq}`);
+        }
+        for (let round = 0; round < config.rounds; round++) {
+            const initialText = clients[0].getText();
+            const logger = new TestClientLogger(clients, `Clients: ${clients.length} Ops: ${opsPerRound} Round: ${round}`);
+            const messageData = generateOperationMessagesForClients(random, seq, clients, logger, opsPerRound, minLength, config.operations);
+            const msgs = messageData.map((md) => md[0]);
+            seq = apply(seq, messageData, clients, logger, random);
+            const resultText = logger.validate();
+            results.push({
+                initialText,
+                resultText,
+                msgs,
+                seq,
+            });
+            logger.dispose();
+        }
+    });
+    if (config.resultsFilePostfix !== undefined) {
+        const resultsFilePath = `${replayResultsPath}/len_${minLength}-clients_${clients.length}-${config.resultsFilePostfix}`;
+        fs.writeFileSync(resultsFilePath, JSON.stringify(results, undefined, 4));
+    }
+    return seq;
+}
+export function generateOperationMessagesForClients(random, startingSeq, clients, logger, opsPerRound, minLength, operations) {
+    const minimumSequenceNumber = startingSeq;
+    let tempSeq = startingSeq * -1;
+    const messages = [];
+    for (let i = 0; i < opsPerRound; i++) {
+        // pick a client greater than 0, client 0 only applies remote ops
+        // and is our baseline
+        const client = clients[random.integer(1, clients.length - 1)];
+        const len = client.getLength();
+        const sg = client.peekPendingSegmentGroups();
+        let op;
+        if (len === 0 || len < minLength) {
+            const text = client.longClientId.repeat(random.integer(1, 3));
+            op = client.insertTextLocal(random.integer(0, len), text);
+        }
+        else {
+            let opIndex = random.integer(0, operations.length - 1);
+            const start = random.integer(0, len - 1);
+            const end = random.integer(start + 1, len);
+            for (let y = 0; y < operations.length && op === undefined; y++) {
+                op = operations[opIndex](client, start, end, random);
+                opIndex++;
+                opIndex %= operations.length;
+            }
+        }
+        if (op !== undefined) {
+            // Pre-check to avoid logger.toString() in the string template
+            if (sg === client.peekPendingSegmentGroups()) {
+                assert.notEqual(sg, client.peekPendingSegmentGroups(), `op created but segment group not enqueued.${logger}`);
+            }
+            const message = client.makeOpMessage(op, --tempSeq);
+            message.minimumSequenceNumber = minimumSequenceNumber;
+            messages.push([
+                message,
+                client.peekPendingSegmentGroups(op.type === MergeTreeDeltaType.GROUP ? op.ops.length : 1),
+            ]);
+        }
+    }
+    return messages;
+}
+export function generateClientNames() {
+    const clientNames = [];
+    function addClientNames(startChar, count) {
+        const startCode = startChar.charCodeAt(0);
+        for (let i = 0; i < count; i++) {
+            clientNames.push(String.fromCharCode(startCode + i));
+        }
+    }
+    addClientNames("A", 26);
+    addClientNames("a", 26);
+    addClientNames("0", 17);
+    return clientNames;
+}
+export function applyMessages(startingSeq, messageData, clients, logger) {
+    let seq = startingSeq;
+    try {
+        // log and apply all the ops created in the round
+        // eslint-disable-next-line @typescript-eslint/prefer-for-of
+        for (let i = 0; i < messageData.length; i++) {
+            const [message] = messageData[i];
+            message.sequenceNumber = ++seq;
+            clients.forEach((c) => c.applyMsg(message));
+        }
+    }
+    catch (e) {
+        throw logger.addLogsToError(e);
+    }
+    return seq;
+}
+//# sourceMappingURL=mergeTreeOperationRunner.js.map