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

package/lib/test/reconnectHelper.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { IMergeTreeDeltaOp } from "../ops.js";
+import { SegmentGroup } from "../index.js";
+import { TestClientLogger } from "./testClientLogger.js";
+declare const ClientIds: readonly ["A", "B", "C", "D"];
+type ClientName = (typeof ClientIds)[number];
+export declare class ReconnectTestHelper {
+    clients: Record<"A" | "C" | "B" | "D", import("./testClient.js").TestClient> & {
+        all: import("./testClient.js").TestClient[];
+    };
+    idxFromName(name: ClientName): number;
+    logger: TestClientLogger;
+    ops: ISequencedDocumentMessage[];
+    perClientOps: ISequencedDocumentMessage[][];
+    seq: number;
+    insertText(clientName: ClientName, pos: number, text: string): void;
+    removeRange(clientName: ClientName, start: number, end: number): void;
+    obliterateRange(clientName: ClientName, start: number, end: number): void;
+    insertTextLocal(clientName: ClientName, pos: number, text: string): {
+        op: import("../ops.js").IMergeTreeInsertMsg;
+        seg: SegmentGroup;
+        refSeq: number;
+    };
+    removeRangeLocal(clientName: ClientName, start: number, end: number): {
+        op: import("../ops.js").IMergeTreeRemoveMsg;
+        seg: SegmentGroup;
+        refSeq: number;
+    };
+    obliterateRangeLocal(clientName: ClientName, start: number, end: number): {
+        op: import("../ops.js").IMergeTreeObliterateMsg;
+        seg: SegmentGroup;
+        refSeq: number;
+    };
+    disconnect(clientNames: ClientName[]): void;
+    processAllOps(): void;
+    reconnect(clientNames: ClientName[]): void;
+    submitDisconnectedOp(clientName: ClientName, op: {
+        op: IMergeTreeDeltaOp;
+        seg: SegmentGroup | SegmentGroup[];
+        refSeq: number;
+    }): void;
+}
+export {};
+//# sourceMappingURL=reconnectHelper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reconnectHelper.d.ts","sourceRoot":"","sources":["../../src/test/reconnectHelper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAA+B,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtF,QAAA,MAAM,SAAS,+BAAgC,CAAC;AAChD,KAAK,UAAU,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7C,qBAAa,mBAAmB;IAC/B,OAAO;;MAML;IAEF,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIrC,MAAM,mBAA0C;IAEhD,GAAG,EAAE,yBAAyB,EAAE,CAAM;IACtC,YAAY,EAAE,yBAAyB,EAAE,EAAE,CAAkC;IAE7E,GAAG,EAAE,MAAM,CAAK;IAET,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAKnE,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKrE,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKzE,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;;;;;IASjE,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;;;;;IASnE,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;;;;;IASvE,UAAU,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI;IAW3C,aAAa,IAAI,IAAI;IAQrB,SAAS,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI;IAS1C,oBAAoB,CAC1B,UAAU,EAAE,UAAU,EACtB,EAAE,EAAE;QAAE,EAAE,EAAE,iBAAiB,CAAC;QAAC,GAAG,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAC/E,IAAI;CAMP"}

package/lib/test/reconnectHelper.js

@@ -0,0 +1,82 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { createClientsAtInitialState, TestClientLogger } from "./testClientLogger.js";
+const ClientIds = ["A", "B", "C", "D"];
+export class ReconnectTestHelper {
+    constructor() {
+        this.clients = createClientsAtInitialState({
+            initialState: "",
+            options: { mergeTreeEnableObliterate: true },
+        }, ...ClientIds);
+        this.logger = new TestClientLogger(this.clients.all);
+        this.ops = [];
+        this.perClientOps = this.clients.all.map(() => []);
+        this.seq = 0;
+    }
+    idxFromName(name) {
+        return name.charCodeAt(0) - "A".charCodeAt(0);
+    }
+    insertText(clientName, pos, text) {
+        const client = this.clients[clientName];
+        this.ops.push(client.makeOpMessage(client.insertTextLocal(pos, text), ++this.seq));
+    }
+    removeRange(clientName, start, end) {
+        const client = this.clients[clientName];
+        this.ops.push(client.makeOpMessage(client.removeRangeLocal(start, end), ++this.seq));
+    }
+    obliterateRange(clientName, start, end) {
+        const client = this.clients[clientName];
+        this.ops.push(client.makeOpMessage(client.obliterateRangeLocal(start, end), ++this.seq));
+    }
+    insertTextLocal(clientName, pos, text) {
+        const client = this.clients[clientName];
+        const op = client.insertTextLocal(pos, text);
+        assert(op);
+        const seg = client.peekPendingSegmentGroups();
+        assert(seg);
+        return { op, seg, refSeq: client.getCollabWindow().currentSeq };
+    }
+    removeRangeLocal(clientName, start, end) {
+        const client = this.clients[clientName];
+        const op = client.removeRangeLocal(start, end);
+        assert(op);
+        const seg = client.peekPendingSegmentGroups();
+        assert(seg);
+        return { op, seg, refSeq: client.getCollabWindow().currentSeq };
+    }
+    obliterateRangeLocal(clientName, start, end) {
+        const client = this.clients[clientName];
+        const op = client.obliterateRangeLocal(start, end);
+        assert(op);
+        const seg = client.peekPendingSegmentGroups();
+        assert(seg);
+        return { op, seg, refSeq: client.getCollabWindow().currentSeq };
+    }
+    disconnect(clientNames) {
+        const clientIdxs = clientNames.map(this.idxFromName);
+        this.ops
+            .splice(0)
+            .forEach((op) => this.clients.all.forEach((c, i) => clientIdxs.includes(i) ? this.perClientOps[i].push(op) : c.applyMsg(op)));
+    }
+    processAllOps() {
+        this.ops.splice(0).forEach((op) => this.clients.all.forEach((c) => {
+            c.applyMsg(op);
+        }));
+    }
+    reconnect(clientNames) {
+        const clientIdxs = clientNames.map(this.idxFromName);
+        this.perClientOps.forEach((clientOps, i) => {
+            if (clientIdxs.includes(i)) {
+                clientOps.splice(0).forEach((op) => this.clients.all[i].applyMsg(op));
+            }
+        });
+    }
+    submitDisconnectedOp(clientName, op) {
+        const client = this.clients[clientName];
+        this.ops.push(client.makeOpMessage(client.regeneratePendingOp(op.op, op.seg), ++this.seq, op.refSeq));
+    }
+}
+//# sourceMappingURL=reconnectHelper.js.map

package/lib/test/reconnectHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reconnectHelper.js","sourceRoot":"","sources":["../../src/test/reconnectHelper.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAI1C,OAAO,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtF,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAGhD,MAAM,OAAO,mBAAmB;IAAhC;QACC,YAAO,GAAG,2BAA2B,CACpC;YACC,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,EAAE,yBAAyB,EAAE,IAAI,EAAE;SAC5C,EACD,GAAG,SAAS,CACZ,CAAC;QAMF,WAAM,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEhD,QAAG,GAAgC,EAAE,CAAC;QACtC,iBAAY,GAAkC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAE7E,QAAG,GAAW,CAAC,CAAC;IAiFjB,CAAC;IA1FA,WAAW,CAAC,IAAgB;QAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IASM,UAAU,CAAC,UAAsB,EAAE,GAAW,EAAE,IAAY;QAClE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACpF,CAAC;IAEM,WAAW,CAAC,UAAsB,EAAE,KAAa,EAAE,GAAW;QACpE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACtF,CAAC;IAEM,eAAe,CAAC,UAAsB,EAAE,KAAa,EAAE,GAAW;QACxE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1F,CAAC;IAEM,eAAe,CAAC,UAAsB,EAAE,GAAW,EAAE,IAAY;QACvE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,EAAE,GAAG,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC7C,MAAM,CAAC,EAAE,CAAC,CAAC;QACX,MAAM,GAAG,GAAG,MAAM,CAAC,wBAAwB,EAAE,CAAC;QAC9C,MAAM,CAAC,GAAG,CAAC,CAAC;QACZ,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC,UAAU,EAAE,CAAC;IACjE,CAAC;IAEM,gBAAgB,CAAC,UAAsB,EAAE,KAAa,EAAE,GAAW;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,EAAE,GAAG,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC/C,MAAM,CAAC,EAAE,CAAC,CAAC;QACX,MAAM,GAAG,GAAG,MAAM,CAAC,wBAAwB,EAAE,CAAC;QAC9C,MAAM,CAAC,GAAG,CAAC,CAAC;QACZ,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC,UAAU,EAAE,CAAC;IACjE,CAAC;IAEM,oBAAoB,CAAC,UAAsB,EAAE,KAAa,EAAE,GAAW;QAC7E,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,EAAE,GAAG,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACnD,MAAM,CAAC,EAAE,CAAC,CAAC;QACX,MAAM,GAAG,GAAG,MAAM,CAAC,wBAAwB,EAAE,CAAC;QAC9C,MAAM,CAAC,GAAG,CAAC,CAAC;QACZ,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC,UAAU,EAAE,CAAC;IACjE,CAAC;IAEM,UAAU,CAAC,WAAyB;QAC1C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG;aACN,MAAM,CAAC,CAAC,CAAC;aACT,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACf,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACjC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CACvE,CACD,CAAC;IACJ,CAAC;IAEM,aAAa;QACnB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9B,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC,CAAC,CACF,CAAC;IACH,CAAC;IAEM,SAAS,CAAC,WAAyB;QACzC,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;YAC1C,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;gBAC3B,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;aACtE;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,oBAAoB,CAC1B,UAAsB,EACtB,EAAiF;QAEjF,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CACZ,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,CACtF,CAAC;IACH,CAAC;CACD","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 { IMergeTreeDeltaOp } from \"../ops.js\";\nimport { SegmentGroup } from \"../index.js\";\nimport { createClientsAtInitialState, TestClientLogger } from \"./testClientLogger.js\";\n\nconst ClientIds = [\"A\", \"B\", \"C\", \"D\"] as const;\ntype ClientName = (typeof ClientIds)[number];\n\nexport class ReconnectTestHelper {\n\tclients = createClientsAtInitialState(\n\t\t{\n\t\t\tinitialState: \"\",\n\t\t\toptions: { mergeTreeEnableObliterate: true },\n\t\t},\n\t\t...ClientIds,\n\t);\n\n\tidxFromName(name: ClientName): number {\n\t\treturn name.charCodeAt(0) - \"A\".charCodeAt(0);\n\t}\n\n\tlogger = new TestClientLogger(this.clients.all);\n\n\tops: ISequencedDocumentMessage[] = [];\n\tperClientOps: ISequencedDocumentMessage[][] = this.clients.all.map(() => []);\n\n\tseq: number = 0;\n\n\tpublic insertText(clientName: ClientName, pos: number, text: string): void {\n\t\tconst client = this.clients[clientName];\n\t\tthis.ops.push(client.makeOpMessage(client.insertTextLocal(pos, text), ++this.seq));\n\t}\n\n\tpublic removeRange(clientName: ClientName, start: number, end: number): void {\n\t\tconst client = this.clients[clientName];\n\t\tthis.ops.push(client.makeOpMessage(client.removeRangeLocal(start, end), ++this.seq));\n\t}\n\n\tpublic obliterateRange(clientName: ClientName, start: number, end: number): void {\n\t\tconst client = this.clients[clientName];\n\t\tthis.ops.push(client.makeOpMessage(client.obliterateRangeLocal(start, end), ++this.seq));\n\t}\n\n\tpublic insertTextLocal(clientName: ClientName, pos: number, text: string) {\n\t\tconst client = this.clients[clientName];\n\t\tconst op = client.insertTextLocal(pos, text);\n\t\tassert(op);\n\t\tconst seg = client.peekPendingSegmentGroups();\n\t\tassert(seg);\n\t\treturn { op, seg, refSeq: client.getCollabWindow().currentSeq };\n\t}\n\n\tpublic removeRangeLocal(clientName: ClientName, start: number, end: number) {\n\t\tconst client = this.clients[clientName];\n\t\tconst op = client.removeRangeLocal(start, end);\n\t\tassert(op);\n\t\tconst seg = client.peekPendingSegmentGroups();\n\t\tassert(seg);\n\t\treturn { op, seg, refSeq: client.getCollabWindow().currentSeq };\n\t}\n\n\tpublic obliterateRangeLocal(clientName: ClientName, start: number, end: number) {\n\t\tconst client = this.clients[clientName];\n\t\tconst op = client.obliterateRangeLocal(start, end);\n\t\tassert(op);\n\t\tconst seg = client.peekPendingSegmentGroups();\n\t\tassert(seg);\n\t\treturn { op, seg, refSeq: client.getCollabWindow().currentSeq };\n\t}\n\n\tpublic disconnect(clientNames: ClientName[]): void {\n\t\tconst clientIdxs = clientNames.map(this.idxFromName);\n\t\tthis.ops\n\t\t\t.splice(0)\n\t\t\t.forEach((op) =>\n\t\t\t\tthis.clients.all.forEach((c, i) =>\n\t\t\t\t\tclientIdxs.includes(i) ? this.perClientOps[i].push(op) : c.applyMsg(op),\n\t\t\t\t),\n\t\t\t);\n\t}\n\n\tpublic processAllOps(): void {\n\t\tthis.ops.splice(0).forEach((op) =>\n\t\t\tthis.clients.all.forEach((c) => {\n\t\t\t\tc.applyMsg(op);\n\t\t\t}),\n\t\t);\n\t}\n\n\tpublic reconnect(clientNames: ClientName[]): void {\n\t\tconst clientIdxs = clientNames.map(this.idxFromName);\n\t\tthis.perClientOps.forEach((clientOps, i) => {\n\t\t\tif (clientIdxs.includes(i)) {\n\t\t\t\tclientOps.splice(0).forEach((op) => this.clients.all[i].applyMsg(op));\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic submitDisconnectedOp(\n\t\tclientName: ClientName,\n\t\top: { op: IMergeTreeDeltaOp; seg: SegmentGroup | SegmentGroup[]; refSeq: number },\n\t): void {\n\t\tconst client = this.clients[clientName];\n\t\tthis.ops.push(\n\t\t\tclient.makeOpMessage(client.regeneratePendingOp(op.op, op.seg), ++this.seq, op.refSeq),\n\t\t);\n\t}\n}\n"]}

package/lib/test/resetPendingSegmentsToOp.spec.d.ts

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

package/lib/test/resetPendingSegmentsToOp.spec.d.ts.map

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

package/lib/test/resetPendingSegmentsToOp.spec.js

@@ -0,0 +1,235 @@
+/*!
+ * 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 { Marker, reservedMarkerIdKey } from "../mergeTreeNodes.js";
+import { ReferenceType } from "../ops.js";
+import { clone } from "../properties.js";
+import { TextSegment } from "../textSegment.js";
+import { TestClient } from "./testClient.js";
+import { TestClientLogger, createClientsAtInitialState } from "./testClientLogger.js";
+describe("resetPendingSegmentsToOp", () => {
+    let client;
+    beforeEach(() => {
+        client = new TestClient();
+        client.startOrUpdateCollaboration("local user");
+        assert(client.mergeTree.pendingSegments?.empty);
+    });
+    describe("with a number of nested inserts", () => {
+        const insertCount = 5;
+        const expectedSegmentCount = insertCount * 2 - 1;
+        let opList;
+        let opCount = 0;
+        function applyOpList(cli) {
+            while (opList.length > 0) {
+                const op = opList.shift();
+                if (op) {
+                    const seqOp = cli.makeOpMessage(op.op, ++opCount, op.refSeq);
+                    cli.applyMsg(seqOp);
+                }
+            }
+        }
+        beforeEach(() => {
+            opList = [];
+            opCount = 0;
+            for (let i = 0; i < insertCount; i++) {
+                const op = client.insertTextLocal(i, "hello");
+                opList.push({ op, refSeq: client.getCurrentSeq() });
+                assert.equal(client.mergeTree.pendingSegments?.length, i + 1);
+            }
+        });
+        it("acked insertSegment", async () => {
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("only computes localPartialLengths once", () => {
+            // This test helps verify the asymptotic correctness of rebase.
+            // Since local partial length information is reasonably expensive to store and compute compared to how
+            // frequently it's used (i.e. only on reconnect), mergeTree has some logic to only do so when requested,
+            // and invalidates that info whenever a segment update occurs.
+            // This test verifies that local partial length information only gets computed once when regenerating
+            // a number of ops for reconnection.
+            let localPartialsComputeCount = 0;
+            const spiedMergeTree = client.mergeTree;
+            spiedMergeTree._localPartialsComputed = spiedMergeTree.localPartialsComputed;
+            Object.defineProperty(client.mergeTree, "localPartialsComputed", {
+                get() {
+                    return this._localPartialsComputed;
+                },
+                set(newValue) {
+                    if (newValue) {
+                        localPartialsComputeCount++;
+                    }
+                    this._localPartialsComputed = newValue;
+                },
+            });
+            const oldops = opList;
+            const pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];
+            opList = oldops.map((op) => ({
+                op: client.regeneratePendingOp(op.op, pending.shift()),
+                refSeq: client.getCurrentSeq(),
+            }));
+            applyOpList(client);
+            assert.equal(localPartialsComputeCount, 1);
+        });
+        it("nacked insertSegment", async () => {
+            const oldops = opList;
+            const pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];
+            opList = oldops.map((op) => ({
+                op: client.regeneratePendingOp(op.op, pending.shift()),
+                refSeq: client.getCurrentSeq(),
+            }));
+            // we expect a nack op per segment since our original ops split segments
+            // we should expect mores nack ops then original ops.
+            // only the first op didn't split a segment, all the others did
+            assert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("acked removeRange", async () => {
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+            opList.push({
+                op: client.removeRangeLocal(0, client.getLength()),
+                refSeq: client.getCurrentSeq(),
+            });
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("nacked removeRange", async () => {
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+            opList.push({
+                op: client.removeRangeLocal(0, client.getLength()),
+                refSeq: client.getCurrentSeq(),
+            });
+            opList.push({
+                op: client.regeneratePendingOp(opList.shift().op, client.mergeTree.pendingSegments.first.data),
+                refSeq: client.getCurrentSeq(),
+            });
+            // we expect a nack op per segment since our original ops split segments
+            // we should expect mores nack ops then original ops.
+            // only the first op didn't split a segment, all the others did
+            assert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("nacked insertSegment and removeRange", async () => {
+            opList.push({
+                op: client.removeRangeLocal(0, client.getLength()),
+                refSeq: client.getCurrentSeq(),
+            });
+            const oldops = opList;
+            const pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];
+            opList = oldops.map((op) => ({
+                op: client.regeneratePendingOp(op.op, pending.shift()),
+                refSeq: client.getCurrentSeq(),
+            }));
+            assert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount * 2);
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("acked annotateRange", async () => {
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+            opList.push({
+                op: client.annotateRangeLocal(0, client.getLength(), { foo: "bar" }),
+                refSeq: client.getCurrentSeq(),
+            });
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("nacked annotateRange", async () => {
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+            opList.push({
+                op: client.annotateRangeLocal(0, client.getLength(), { foo: "bar" }),
+                refSeq: client.getCurrentSeq(),
+            });
+            opList.push({
+                op: client.regeneratePendingOp(opList.shift().op, client.mergeTree.pendingSegments.first.data),
+                refSeq: client.getCurrentSeq(),
+            });
+            // we expect a nack op per segment since our original ops split segments
+            // we should expect mores nack ops then original ops.
+            // only the first op didn't split a segment, all the others did
+            assert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+        it("nacked insertSegment and annotateRange", async () => {
+            opList.push({
+                op: client.annotateRangeLocal(0, client.getLength(), { foo: "bar" }),
+                refSeq: client.getCurrentSeq(),
+            });
+            const oldops = opList;
+            const pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];
+            opList = oldops.map((op) => ({
+                op: client.regeneratePendingOp(op.op, pending.shift()),
+                refSeq: client.getCurrentSeq(),
+            }));
+            // we expect a nack op per segment since our original ops split segments
+            // we should expect mores nack ops then original ops.
+            // only the first op didn't split a segment, all the others did
+            assert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount * 2);
+            applyOpList(client);
+            assert(client.mergeTree.pendingSegments?.empty);
+        });
+    });
+    describe("uses original properties on insert", () => {
+        // Regression tests for an issue where regenerated insert ops would use the properties of a segment
+        // at the time of regeneration rather than its properties at insertion time.
+        it("for markers", () => {
+            const insertOp = client.insertMarkerLocal(0, ReferenceType.Simple, {
+                [reservedMarkerIdKey]: "id",
+                prop1: "foo",
+            });
+            assert(insertOp);
+            const { segment } = client.getContainingSegment(0);
+            assert(segment !== undefined && Marker.is(segment));
+            client.annotateMarker(segment, { prop2: "bar" });
+            const otherClient = new TestClient();
+            otherClient.startOrUpdateCollaboration("other user");
+            const regeneratedInsert = client.regeneratePendingOp(insertOp, client.mergeTree.pendingSegments.first.data);
+            otherClient.applyMsg(client.makeOpMessage(regeneratedInsert, 1), false);
+            const { segment: otherSegment } = otherClient.getContainingSegment(0);
+            assert(otherSegment !== undefined && Marker.is(otherSegment));
+            // `clone` here is because properties use a Object.create(null); to compare strict equal the prototype chain
+            // should therefore not include Object.
+            assert.deepStrictEqual(otherSegment.properties, clone({ [reservedMarkerIdKey]: "id", prop1: "foo" }));
+        });
+        it("for text segments", () => {
+            const insertOp = client.insertTextLocal(0, "abc", { prop1: "foo" });
+            assert(insertOp);
+            client.annotateRangeLocal(0, 3, { prop2: "bar" });
+            const otherClient = new TestClient();
+            otherClient.startOrUpdateCollaboration("other user");
+            const regeneratedInsert = client.regeneratePendingOp(insertOp, client.mergeTree.pendingSegments.first.data);
+            otherClient.applyMsg(client.makeOpMessage(regeneratedInsert, 1), false);
+            const { segment: otherSegment } = otherClient.getContainingSegment(0);
+            assert(otherSegment !== undefined && TextSegment.is(otherSegment));
+            assert.deepStrictEqual(otherSegment.properties, clone({ prop1: "foo" }));
+        });
+    });
+});
+describe("resetPendingSegmentsToOp.rebase", () => {
+    it("rebase with oustanding ops", () => {
+        const clients = createClientsAtInitialState({ initialState: "0123456789" }, "A", "B");
+        const logger = new TestClientLogger(clients.all);
+        const ops = Array.from({ length: 10 }).map((_, i) => [
+            clients.A.makeOpMessage(clients.A.annotateRangeLocal(0, clients.A.getLength(), { prop: i }), i + 1),
+            clients.A.peekPendingSegmentGroups(),
+        ]);
+        ops.push(...ops
+            .splice(Math.floor(ops.length / 2))
+            .map(([op, sg]) => [
+            clients.A.makeOpMessage(clients.A.regeneratePendingOp(op.contents, sg), op.sequenceNumber),
+            clients.A.peekPendingSegmentGroups(),
+        ]));
+        ops.forEach(([op]) => clients.all.forEach((c) => c.applyMsg(op)));
+        logger.validate();
+    });
+});
+//# sourceMappingURL=resetPendingSegmentsToOp.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resetPendingSegmentsToOp.spec.js","sourceRoot":"","sources":["../../src/test/resetPendingSegmentsToOp.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,6DAA6D;AAE7D,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAgB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAgB,aAAa,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AAEtF,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACzC,IAAI,MAAkB,CAAC;IAEvB,UAAU,CAAC,GAAG,EAAE;QACf,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC1B,MAAM,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAChD,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,oBAAoB,GAAG,WAAW,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,MAA8C,CAAC;QACnD,IAAI,OAAO,GAAW,CAAC,CAAC;QAExB,SAAS,WAAW,CAAC,GAAe;YACnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACzB,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC1B,IAAI,EAAE,EAAE;oBACP,MAAM,KAAK,GAAG,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;oBAC7D,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACpB;aACD;QACF,CAAC;QAED,UAAU,CAAC,GAAG,EAAE;YACf,MAAM,GAAG,EAAE,CAAC;YACZ,OAAO,GAAG,CAAC,CAAC;YAEZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;gBACrC,MAAM,EAAE,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,CAAE,CAAC;gBAC/C,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACpD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;aAC9D;QACF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YACpC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YACjD,+DAA+D;YAC/D,sGAAsG;YACtG,wGAAwG;YACxG,8DAA8D;YAC9D,qGAAqG;YACrG,oCAAoC;YACpC,IAAI,yBAAyB,GAAG,CAAC,CAAC;YAClC,MAAM,cAAc,GAAG,MAAM,CAAC,SAG7B,CAAC;YACF,cAAc,CAAC,sBAAsB,GAAG,cAAc,CAAC,qBAAqB,CAAC;YAC7E,MAAM,CAAC,cAAc,CACpB,MAAM,CAAC,SAA0D,EACjE,uBAAuB,EACvB;gBACC,GAAG;oBACF,OAAO,IAAI,CAAC,sBAAiC,CAAC;gBAC/C,CAAC;gBACD,GAAG,CAAC,QAAQ;oBACX,IAAI,QAAQ,EAAE;wBACb,yBAAyB,EAAE,CAAC;qBAC5B;oBACD,IAAI,CAAC,sBAAsB,GAAG,QAAQ,CAAC;gBACxC,CAAC;aACD,CACD,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,CAAC;YACtB,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5B,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,KAAK,EAAG,CAAC;gBACvD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC,CAAC;YACJ,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACrC,MAAM,MAAM,GAAG,MAAM,CAAC;YACtB,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5B,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,KAAK,EAAG,CAAC;gBACvD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC,CAAC;YACJ,wEAAwE;YACxE,qDAAqD;YACrD,+DAA+D;YAC/D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;YAC7E,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;YAClC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAE;gBACnD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;YACnC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAE;gBACnD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAC7B,MAAM,CAAC,KAAK,EAAG,CAAC,EAAE,EAClB,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAM,CAAC,IAAI,CAC5C;gBACD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,wEAAwE;YACxE,qDAAqD;YACrD,+DAA+D;YAC/D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;YAC7E,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,CAAE;gBACnD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,CAAC;YACtB,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5B,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,KAAK,EAAG,CAAC;gBACvD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC,CAAC;YAEJ,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;YAEjF,WAAW,CAAC,MAAM,CAAC,CAAC;YAEpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YACpC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAE;gBACrE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACrC,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;YAEhD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAE;gBACrE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAC7B,MAAM,CAAC,KAAK,EAAG,CAAC,EAAE,EAClB,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAM,CAAC,IAAI,CAC5C;gBACD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,wEAAwE;YACxE,qDAAqD;YACrD,+DAA+D;YAC/D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,CAAC,CAAC;YAC7E,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAE;gBACrE,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,CAAC;YACtB,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5B,EAAE,EAAE,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,KAAK,EAAG,CAAC;gBACvD,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;aAC9B,CAAC,CAAC,CAAC;YACJ,wEAAwE;YACxE,qDAAqD;YACrD,+DAA+D;YAC/D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;YACjF,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;QACnD,mGAAmG;QACnG,4EAA4E;QAC5E,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACtB,MAAM,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE;gBAClE,CAAC,mBAAmB,CAAC,EAAE,IAAI;gBAC3B,KAAK,EAAE,KAAK;aACZ,CAAC,CAAC;YACH,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;YACnD,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YAEjD,MAAM,WAAW,GAAG,IAAI,UAAU,EAAE,CAAC;YACrC,WAAW,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,MAAM,CAAC,mBAAmB,CACnD,QAAQ,EACR,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAM,CAAC,IAAI,CAC5C,CAAC;YACF,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAExE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;YACtE,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;YAC9D,4GAA4G;YAC5G,uCAAuC;YACvC,MAAM,CAAC,eAAe,CACrB,YAAY,CAAC,UAAU,EACvB,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CACpD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACpE,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjB,MAAM,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YAElD,MAAM,WAAW,GAAG,IAAI,UAAU,EAAE,CAAC;YACrC,WAAW,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,MAAM,CAAC,mBAAmB,CACnD,QAAQ,EACR,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,KAAM,CAAC,IAAI,CAC5C,CAAC;YACF,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAExE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;YACtE,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,WAAW,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;YACnE,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAChD,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACrC,MAAM,OAAO,GAAG,2BAA2B,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QAEtF,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,GAAG,GAAgD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CACtF,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACT,OAAO,CAAC,CAAC,CAAC,aAAa,CACtB,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EACnE,CAAC,GAAG,CAAC,CACL;YACD,OAAO,CAAC,CAAC,CAAC,wBAAwB,EAAG;SACrC,CACD,CAAC;QAEF,GAAG,CAAC,IAAI,CACP,GAAG,GAAG;aACJ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;aAClC,GAAG,CAA4C,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,OAAO,CAAC,CAAC,CAAC,aAAa,CACtB,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,EAAE,CAAC,QAAwB,EAAE,EAAE,CAAC,EAC9D,EAAE,CAAC,cAAc,CACjB;YACD,OAAO,CAAC,CAAC,CAAC,wBAAwB,EAAG;SACrC,CAAC,CACH,CAAC;QAEF,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,QAAQ,EAAE,CAAC;IACnB,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 { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { Marker, SegmentGroup, reservedMarkerIdKey } from \"../mergeTreeNodes.js\";\nimport { IMergeTreeOp, ReferenceType } from \"../ops.js\";\nimport { clone } from \"../properties.js\";\nimport { TextSegment } from \"../textSegment.js\";\nimport { TestClient } from \"./testClient.js\";\nimport { TestClientLogger, createClientsAtInitialState } from \"./testClientLogger.js\";\n\ndescribe(\"resetPendingSegmentsToOp\", () => {\n\tlet client: TestClient;\n\n\tbeforeEach(() => {\n\t\tclient = new TestClient();\n\t\tclient.startOrUpdateCollaboration(\"local user\");\n\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t});\n\n\tdescribe(\"with a number of nested inserts\", () => {\n\t\tconst insertCount = 5;\n\t\tconst expectedSegmentCount = insertCount * 2 - 1;\n\t\tlet opList: { op: IMergeTreeOp; refSeq: number }[];\n\t\tlet opCount: number = 0;\n\n\t\tfunction applyOpList(cli: TestClient) {\n\t\t\twhile (opList.length > 0) {\n\t\t\t\tconst op = opList.shift();\n\t\t\t\tif (op) {\n\t\t\t\t\tconst seqOp = cli.makeOpMessage(op.op, ++opCount, op.refSeq);\n\t\t\t\t\tcli.applyMsg(seqOp);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tbeforeEach(() => {\n\t\t\topList = [];\n\t\t\topCount = 0;\n\n\t\t\tfor (let i = 0; i < insertCount; i++) {\n\t\t\t\tconst op = client.insertTextLocal(i, \"hello\")!;\n\t\t\t\topList.push({ op, refSeq: client.getCurrentSeq() });\n\t\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, i + 1);\n\t\t\t}\n\t\t});\n\n\t\tit(\"acked insertSegment\", async () => {\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"only computes localPartialLengths once\", () => {\n\t\t\t// This test helps verify the asymptotic correctness of rebase.\n\t\t\t// Since local partial length information is reasonably expensive to store and compute compared to how\n\t\t\t// frequently it's used (i.e. only on reconnect), mergeTree has some logic to only do so when requested,\n\t\t\t// and invalidates that info whenever a segment update occurs.\n\t\t\t// This test verifies that local partial length information only gets computed once when regenerating\n\t\t\t// a number of ops for reconnection.\n\t\t\tlet localPartialsComputeCount = 0;\n\t\t\tconst spiedMergeTree = client.mergeTree as unknown as {\n\t\t\t\tlocalPartialsComputed: boolean;\n\t\t\t\t_localPartialsComputed: boolean;\n\t\t\t};\n\t\t\tspiedMergeTree._localPartialsComputed = spiedMergeTree.localPartialsComputed;\n\t\t\tObject.defineProperty(\n\t\t\t\tclient.mergeTree as unknown as { localPartialsComputed: boolean },\n\t\t\t\t\"localPartialsComputed\",\n\t\t\t\t{\n\t\t\t\t\tget() {\n\t\t\t\t\t\treturn this._localPartialsComputed as boolean;\n\t\t\t\t\t},\n\t\t\t\t\tset(newValue) {\n\t\t\t\t\t\tif (newValue) {\n\t\t\t\t\t\t\tlocalPartialsComputeCount++;\n\t\t\t\t\t\t}\n\t\t\t\t\t\tthis._localPartialsComputed = newValue;\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t);\n\t\t\tconst oldops = opList;\n\t\t\tconst pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];\n\t\t\topList = oldops.map((op) => ({\n\t\t\t\top: client.regeneratePendingOp(op.op, pending.shift()!),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t}));\n\t\t\tapplyOpList(client);\n\t\t\tassert.equal(localPartialsComputeCount, 1);\n\t\t});\n\n\t\tit(\"nacked insertSegment\", async () => {\n\t\t\tconst oldops = opList;\n\t\t\tconst pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];\n\t\t\topList = oldops.map((op) => ({\n\t\t\t\top: client.regeneratePendingOp(op.op, pending.shift()!),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t}));\n\t\t\t// we expect a nack op per segment since our original ops split segments\n\t\t\t// we should expect mores nack ops then original ops.\n\t\t\t// only the first op didn't split a segment, all the others did\n\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"acked removeRange\", async () => {\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\n\t\t\topList.push({\n\t\t\t\top: client.removeRangeLocal(0, client.getLength())!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"nacked removeRange\", async () => {\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\n\t\t\topList.push({\n\t\t\t\top: client.removeRangeLocal(0, client.getLength())!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\topList.push({\n\t\t\t\top: client.regeneratePendingOp(\n\t\t\t\t\topList.shift()!.op,\n\t\t\t\t\tclient.mergeTree.pendingSegments.first!.data,\n\t\t\t\t),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\t// we expect a nack op per segment since our original ops split segments\n\t\t\t// we should expect mores nack ops then original ops.\n\t\t\t// only the first op didn't split a segment, all the others did\n\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"nacked insertSegment and removeRange\", async () => {\n\t\t\topList.push({\n\t\t\t\top: client.removeRangeLocal(0, client.getLength())!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\tconst oldops = opList;\n\t\t\tconst pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];\n\t\t\topList = oldops.map((op) => ({\n\t\t\t\top: client.regeneratePendingOp(op.op, pending.shift()!),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t}));\n\n\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount * 2);\n\n\t\t\tapplyOpList(client);\n\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"acked annotateRange\", async () => {\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\n\t\t\topList.push({\n\t\t\t\top: client.annotateRangeLocal(0, client.getLength(), { foo: \"bar\" })!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"nacked annotateRange\", async () => {\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\n\t\t\topList.push({\n\t\t\t\top: client.annotateRangeLocal(0, client.getLength(), { foo: \"bar\" })!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\topList.push({\n\t\t\t\top: client.regeneratePendingOp(\n\t\t\t\t\topList.shift()!.op,\n\t\t\t\t\tclient.mergeTree.pendingSegments.first!.data,\n\t\t\t\t),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\t// we expect a nack op per segment since our original ops split segments\n\t\t\t// we should expect mores nack ops then original ops.\n\t\t\t// only the first op didn't split a segment, all the others did\n\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount);\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\n\t\tit(\"nacked insertSegment and annotateRange\", async () => {\n\t\t\topList.push({\n\t\t\t\top: client.annotateRangeLocal(0, client.getLength(), { foo: \"bar\" })!,\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t});\n\t\t\tconst oldops = opList;\n\t\t\tconst pending = [...client.mergeTree.pendingSegments.map((n) => n.data)];\n\t\t\topList = oldops.map((op) => ({\n\t\t\t\top: client.regeneratePendingOp(op.op, pending.shift()!),\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t}));\n\t\t\t// we expect a nack op per segment since our original ops split segments\n\t\t\t// we should expect mores nack ops then original ops.\n\t\t\t// only the first op didn't split a segment, all the others did\n\t\t\tassert.equal(client.mergeTree.pendingSegments?.length, expectedSegmentCount * 2);\n\t\t\tapplyOpList(client);\n\t\t\tassert(client.mergeTree.pendingSegments?.empty);\n\t\t});\n\t});\n\n\tdescribe(\"uses original properties on insert\", () => {\n\t\t// Regression tests for an issue where regenerated insert ops would use the properties of a segment\n\t\t// at the time of regeneration rather than its properties at insertion time.\n\t\tit(\"for markers\", () => {\n\t\t\tconst insertOp = client.insertMarkerLocal(0, ReferenceType.Simple, {\n\t\t\t\t[reservedMarkerIdKey]: \"id\",\n\t\t\t\tprop1: \"foo\",\n\t\t\t});\n\t\t\tassert(insertOp);\n\t\t\tconst { segment } = client.getContainingSegment(0);\n\t\t\tassert(segment !== undefined && Marker.is(segment));\n\t\t\tclient.annotateMarker(segment, { prop2: \"bar\" });\n\n\t\t\tconst otherClient = new TestClient();\n\t\t\totherClient.startOrUpdateCollaboration(\"other user\");\n\t\t\tconst regeneratedInsert = client.regeneratePendingOp(\n\t\t\t\tinsertOp,\n\t\t\t\tclient.mergeTree.pendingSegments.first!.data,\n\t\t\t);\n\t\t\totherClient.applyMsg(client.makeOpMessage(regeneratedInsert, 1), false);\n\n\t\t\tconst { segment: otherSegment } = otherClient.getContainingSegment(0);\n\t\t\tassert(otherSegment !== undefined && Marker.is(otherSegment));\n\t\t\t// `clone` here is because properties use a Object.create(null); to compare strict equal the prototype chain\n\t\t\t// should therefore not include Object.\n\t\t\tassert.deepStrictEqual(\n\t\t\t\totherSegment.properties,\n\t\t\t\tclone({ [reservedMarkerIdKey]: \"id\", prop1: \"foo\" }),\n\t\t\t);\n\t\t});\n\n\t\tit(\"for text segments\", () => {\n\t\t\tconst insertOp = client.insertTextLocal(0, \"abc\", { prop1: \"foo\" });\n\t\t\tassert(insertOp);\n\t\t\tclient.annotateRangeLocal(0, 3, { prop2: \"bar\" });\n\n\t\t\tconst otherClient = new TestClient();\n\t\t\totherClient.startOrUpdateCollaboration(\"other user\");\n\t\t\tconst regeneratedInsert = client.regeneratePendingOp(\n\t\t\t\tinsertOp,\n\t\t\t\tclient.mergeTree.pendingSegments.first!.data,\n\t\t\t);\n\t\t\totherClient.applyMsg(client.makeOpMessage(regeneratedInsert, 1), false);\n\n\t\t\tconst { segment: otherSegment } = otherClient.getContainingSegment(0);\n\t\t\tassert(otherSegment !== undefined && TextSegment.is(otherSegment));\n\t\t\tassert.deepStrictEqual(otherSegment.properties, clone({ prop1: \"foo\" }));\n\t\t});\n\t});\n});\n\ndescribe(\"resetPendingSegmentsToOp.rebase\", () => {\n\tit(\"rebase with oustanding ops\", () => {\n\t\tconst clients = createClientsAtInitialState({ initialState: \"0123456789\" }, \"A\", \"B\");\n\n\t\tconst logger = new TestClientLogger(clients.all);\n\t\tconst ops: [ISequencedDocumentMessage, SegmentGroup][] = Array.from({ length: 10 }).map(\n\t\t\t(_, i) => [\n\t\t\t\tclients.A.makeOpMessage(\n\t\t\t\t\tclients.A.annotateRangeLocal(0, clients.A.getLength(), { prop: i }),\n\t\t\t\t\ti + 1,\n\t\t\t\t),\n\t\t\t\tclients.A.peekPendingSegmentGroups()!,\n\t\t\t],\n\t\t);\n\n\t\tops.push(\n\t\t\t...ops\n\t\t\t\t.splice(Math.floor(ops.length / 2))\n\t\t\t\t.map<[ISequencedDocumentMessage, SegmentGroup]>(([op, sg]) => [\n\t\t\t\t\tclients.A.makeOpMessage(\n\t\t\t\t\t\tclients.A.regeneratePendingOp(op.contents as IMergeTreeOp, sg),\n\t\t\t\t\t\top.sequenceNumber,\n\t\t\t\t\t),\n\t\t\t\t\tclients.A.peekPendingSegmentGroups()!,\n\t\t\t\t]),\n\t\t);\n\n\t\tops.forEach(([op]) => clients.all.forEach((c) => c.applyMsg(op)));\n\t\tlogger.validate();\n\t});\n});\n"]}

package/lib/test/revertibleFarm.spec.d.ts

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

package/lib/test/revertibleFarm.spec.d.ts.map

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

package/lib/test/revertibleFarm.spec.js

@@ -0,0 +1,119 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import assert from "assert";
+import { makeRandom } from "@fluid-private/stochastic-test-utils";
+import { appendToMergeTreeDeltaRevertibles, revertMergeTreeDeltaRevertibles, } from "../revertibles.js";
+import { walkAllChildSegments } from "../mergeTreeNodeWalk.js";
+import { removeRange, generateOperationMessagesForClients, applyMessages, annotateRange, doOverRanges, } from "./mergeTreeOperationRunner.js";
+import { createRevertDriver } from "./testClient.js";
+import { createClientsAtInitialState, TestClientLogger } from "./testClientLogger.js";
+const defaultOptions = {
+    initialOps: 5,
+    minLength: { min: 1, max: 256, growthFunc: (i) => i * i },
+    concurrentOpsWithRevert: { min: 0, max: 8 },
+    revertOps: { min: 1, max: 16 },
+    ackBeforeRevert: ["None", "Some", "All"],
+    rounds: 10,
+    operations: [removeRange, annotateRange],
+    growthFunc: (i) => i * 2,
+};
+describe("MergeTree.Client", () => {
+    doOverRanges(defaultOptions, ({ minLength: minLen, concurrentOpsWithRevert, revertOps }) => {
+        for (const ackBeforeRevert of defaultOptions.ackBeforeRevert) {
+            it(`InitialOps: ${defaultOptions.initialOps} MinLen: ${minLen}  ConcurrentOpsWithRevert: ${concurrentOpsWithRevert} RevertOps: ${revertOps} AckBeforeRevert: ${ackBeforeRevert}`, async () => {
+                const random = makeRandom(minLen, revertOps, [...ackBeforeRevert].reduce((pv, cv) => pv + cv.charCodeAt(0), 0), concurrentOpsWithRevert);
+                const clients = createClientsAtInitialState({
+                    initialState: "",
+                    options: {},
+                }, "A", "B", "C");
+                let seq = 0;
+                for (let rnd = 0; rnd < defaultOptions.rounds; rnd++) {
+                    clients.all.forEach((c) => c.updateMinSeq(seq));
+                    const logger = new TestClientLogger(clients.all, `Round ${rnd}`);
+                    {
+                        // init with random values
+                        const initialMsgs = generateOperationMessagesForClients(random, seq, clients.all, logger, defaultOptions.initialOps, minLen, defaultOptions.operations);
+                        seq = applyMessages(seq, initialMsgs, clients.all, logger);
+                    }
+                    // cache the base text to ensure we get back to it after revert
+                    const undoBaseText = logger.validate({
+                        clear: true,
+                        errorPrefix: "After Initial Ops",
+                    });
+                    const clientB_Revertibles = [];
+                    const clientBDriver = createRevertDriver(clients.B);
+                    const deltaCallback = (op, delta) => {
+                        if (op.sequencedMessage === undefined) {
+                            appendToMergeTreeDeltaRevertibles(delta, clientB_Revertibles);
+                        }
+                    };
+                    const msgs = [];
+                    {
+                        clientBDriver.submitOpCallback = (op) => msgs.push([
+                            clients.B.makeOpMessage(op, undefined, undefined, undefined, seq),
+                            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                            clients.B.peekPendingSegmentGroups(),
+                        ]);
+                        clients.B.on("delta", deltaCallback);
+                        msgs.push(...generateOperationMessagesForClients(random, seq, [clients.A, clients.B], logger, revertOps, minLen, defaultOptions.operations));
+                    }
+                    if (concurrentOpsWithRevert > 0) {
+                        // add modifications from another client
+                        msgs.push(...generateOperationMessagesForClients(random, seq, [clients.A, clients.C], logger, concurrentOpsWithRevert, minLen, defaultOptions.operations));
+                    }
+                    let redoBaseText;
+                    if (ackBeforeRevert !== "None") {
+                        const ackAll = ackBeforeRevert === "All";
+                        seq = applyMessages(seq, msgs.splice(0, ackAll
+                            ? msgs.length
+                            : random.integer(0, Math.floor(msgs.length / 2))), clients.all, logger);
+                        if (ackAll) {
+                            redoBaseText = logger.validate({ errorPrefix: "Before Revert Ack" });
+                        }
+                    }
+                    try {
+                        revertMergeTreeDeltaRevertibles(clientBDriver, clientB_Revertibles.splice(0));
+                        seq = applyMessages(seq, msgs.splice(0), clients.all, logger);
+                    }
+                    catch (e) {
+                        throw logger.addLogsToError(e);
+                    }
+                    logger.validate({
+                        clear: true,
+                        baseText: concurrentOpsWithRevert === 0 ? undoBaseText : undefined,
+                        errorPrefix: "After Revert (undo)",
+                    });
+                    try {
+                        // reset the callback before the final revert
+                        // to avoid accruing any new detached references
+                        clients.B.off("delta", deltaCallback);
+                        revertMergeTreeDeltaRevertibles(clientBDriver, clientB_Revertibles.splice(0));
+                        seq = applyMessages(seq, msgs.splice(0), clients.all, logger);
+                        walkAllChildSegments(clients.B.mergeTree.root, (seg) => {
+                            if (seg?.trackingCollection.empty === false) {
+                                assert.notDeepStrictEqual(seg?.trackingCollection.empty, false, "there should be no left over tracking group");
+                            }
+                            if (seg?.localRefs?.empty === false) {
+                                assert.notDeepStrictEqual(seg?.localRefs?.empty, false, "there should be no left over local references");
+                            }
+                        });
+                        const mergeTreeWithRevert = clients.B.mergeTree;
+                        assert.notDeepStrictEqual(mergeTreeWithRevert.__mergeTreeRevertible?.detachedReferences?.localRefs
+                            ?.empty, false, "there should be no left over local references in detached references");
+                    }
+                    catch (e) {
+                        throw logger.addLogsToError(e);
+                    }
+                    logger.validate({
+                        errorPrefix: "After Re-Revert (redo)",
+                        baseText: redoBaseText,
+                    });
+                    logger.dispose();
+                }
+            });
+        }
+    });
+});
+//# sourceMappingURL=revertibleFarm.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"revertibleFarm.spec.js","sourceRoot":"","sources":["../../src/test/revertibleFarm.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,sCAAsC,CAAC;AAElE,OAAO,EACN,iCAAiC,EAGjC,+BAA+B,GAC/B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EACN,WAAW,EACX,mCAAmC,EACnC,aAAa,EACb,aAAa,EACb,YAAY,GACZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtF,MAAM,cAAc,GAAG;IACtB,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE;IACzD,uBAAuB,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;IAC3C,SAAS,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;IAC9B,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAgC;IACvE,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,CAAC,WAAW,EAAE,aAAa,CAAC;IACxC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC;CACxB,CAAC;AAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IACjC,YAAY,CAAC,cAAc,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,uBAAuB,EAAE,SAAS,EAAE,EAAE,EAAE;QAC1F,KAAK,MAAM,eAAe,IAAI,cAAc,CAAC,eAAe,EAAE;YAC7D,EAAE,CAAC,eAAe,cAAc,CAAC,UAAU,YAAY,MAAM,8BAA8B,uBAAuB,eAAe,SAAS,qBAAqB,eAAe,EAAE,EAAE,KAAK,IAAI,EAAE;gBAC5L,MAAM,MAAM,GAAG,UAAU,CACxB,MAAM,EACN,SAAS,EACT,CAAC,GAAG,eAAe,CAAC,CAAC,MAAM,CAAS,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EACzE,uBAAuB,CACvB,CAAC;gBAEF,MAAM,OAAO,GAAG,2BAA2B,CAC1C;oBACC,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,EAAE;iBACX,EACD,GAAG,EACH,GAAG,EACH,GAAG,CACH,CAAC;gBACF,IAAI,GAAG,GAAG,CAAC,CAAC;gBACZ,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;oBACrD,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;oBAEhD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,EAAE,CAAC,CAAC;oBACjE;wBACC,0BAA0B;wBAC1B,MAAM,WAAW,GAAG,mCAAmC,CACtD,MAAM,EACN,GAAG,EACH,OAAO,CAAC,GAAG,EACX,MAAM,EACN,cAAc,CAAC,UAAU,EACzB,MAAM,EACN,cAAc,CAAC,UAAU,CACzB,CAAC;wBAEF,GAAG,GAAG,aAAa,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;qBAC3D;oBAED,+DAA+D;oBAC/D,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC;wBACpC,KAAK,EAAE,IAAI;wBACX,WAAW,EAAE,mBAAmB;qBAChC,CAAC,CAAC;oBAEH,MAAM,mBAAmB,GAA+B,EAAE,CAAC;oBAC3D,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBACpD,MAAM,aAAa,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;wBACnC,IAAI,EAAE,CAAC,gBAAgB,KAAK,SAAS,EAAE;4BACtC,iCAAiC,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;yBAC9D;oBACF,CAAC,CAAC;oBAEF,MAAM,IAAI,GAAiE,EAAE,CAAC;oBAC9E;wBACC,aAAa,CAAC,gBAAgB,GAAG,CAAC,EAAE,EAAE,EAAE,CACvC,IAAI,CAAC,IAAI,CAAC;4BACT,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC;4BACjE,oEAAoE;4BACpE,OAAO,CAAC,CAAC,CAAC,wBAAwB,EAAG;yBACrC,CAAC,CAAC;wBACJ,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;wBACrC,IAAI,CAAC,IAAI,CACR,GAAG,mCAAmC,CACrC,MAAM,EACN,GAAG,EACH,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,MAAM,EACN,SAAS,EACT,MAAM,EACN,cAAc,CAAC,UAAU,CACzB,CACD,CAAC;qBACF;oBAED,IAAI,uBAAuB,GAAG,CAAC,EAAE;wBAChC,wCAAwC;wBACxC,IAAI,CAAC,IAAI,CACR,GAAG,mCAAmC,CACrC,MAAM,EACN,GAAG,EACH,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACtB,MAAM,EACN,uBAAuB,EACvB,MAAM,EACN,cAAc,CAAC,UAAU,CACzB,CACD,CAAC;qBACF;oBAED,IAAI,YAAgC,CAAC;oBACrC,IAAI,eAAe,KAAK,MAAM,EAAE;wBAC/B,MAAM,MAAM,GAAG,eAAe,KAAK,KAAK,CAAC;wBACzC,GAAG,GAAG,aAAa,CAClB,GAAG,EACH,IAAI,CAAC,MAAM,CACV,CAAC,EACD,MAAM;4BACL,CAAC,CAAC,IAAI,CAAC,MAAM;4BACb,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CACjD,EACD,OAAO,CAAC,GAAG,EACX,MAAM,CACN,CAAC;wBACF,IAAI,MAAM,EAAE;4BACX,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC;yBACrE;qBACD;oBAED,IAAI;wBACH,+BAA+B,CAC9B,aAAa,EACb,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAC7B,CAAC;wBACF,GAAG,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;qBAC9D;oBAAC,OAAO,CAAC,EAAE;wBACX,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;qBAC/B;oBACD,MAAM,CAAC,QAAQ,CAAC;wBACf,KAAK,EAAE,IAAI;wBACX,QAAQ,EAAE,uBAAuB,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;wBAClE,WAAW,EAAE,qBAAqB;qBAClC,CAAC,CAAC;oBAEH,IAAI;wBACH,6CAA6C;wBAC7C,gDAAgD;wBAChD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;wBACtC,+BAA+B,CAC9B,aAAa,EACb,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAC7B,CAAC;wBACF,GAAG,GAAG,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;wBAE9D,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAa,EAAE,EAAE;4BAChE,IAAI,GAAG,EAAE,kBAAkB,CAAC,KAAK,KAAK,KAAK,EAAE;gCAC5C,MAAM,CAAC,kBAAkB,CACxB,GAAG,EAAE,kBAAkB,CAAC,KAAK,EAC7B,KAAK,EACL,6CAA6C,CAC7C,CAAC;6BACF;4BACD,IAAI,GAAG,EAAE,SAAS,EAAE,KAAK,KAAK,KAAK,EAAE;gCACpC,MAAM,CAAC,kBAAkB,CACxB,GAAG,EAAE,SAAS,EAAE,KAAK,EACrB,KAAK,EACL,+CAA+C,CAC/C,CAAC;6BACF;wBACF,CAAC,CAAC,CAAC;wBACH,MAAM,mBAAmB,GACxB,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;wBACrB,MAAM,CAAC,kBAAkB,CACxB,mBAAmB,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,SAAS;4BACvE,EAAE,KAAK,EACR,KAAK,EACL,sEAAsE,CACtE,CAAC;qBACF;oBAAC,OAAO,CAAC,EAAE;wBACX,MAAM,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;qBAC/B;oBACD,MAAM,CAAC,QAAQ,CAAC;wBACf,WAAW,EAAE,wBAAwB;wBACrC,QAAQ,EAAE,YAAY;qBACtB,CAAC,CAAC;oBACH,MAAM,CAAC,OAAO,EAAE,CAAC;iBACjB;YACF,CAAC,CAAC,CAAC;SACH;IACF,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 { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { makeRandom } from \"@fluid-private/stochastic-test-utils\";\nimport { ISegment, SegmentGroup } from \"../mergeTreeNodes.js\";\nimport {\n\tappendToMergeTreeDeltaRevertibles,\n\tMergeTreeDeltaRevertible,\n\tMergeTreeWithRevert,\n\trevertMergeTreeDeltaRevertibles,\n} from \"../revertibles.js\";\nimport { walkAllChildSegments } from \"../mergeTreeNodeWalk.js\";\nimport {\n\tremoveRange,\n\tgenerateOperationMessagesForClients,\n\tapplyMessages,\n\tannotateRange,\n\tdoOverRanges,\n} from \"./mergeTreeOperationRunner.js\";\nimport { createRevertDriver } from \"./testClient.js\";\nimport { createClientsAtInitialState, TestClientLogger } from \"./testClientLogger.js\";\n\nconst defaultOptions = {\n\tinitialOps: 5,\n\tminLength: { min: 1, max: 256, growthFunc: (i) => i * i },\n\tconcurrentOpsWithRevert: { min: 0, max: 8 },\n\trevertOps: { min: 1, max: 16 },\n\tackBeforeRevert: [\"None\", \"Some\", \"All\"] as (\"None\" | \"Some\" | \"All\")[],\n\trounds: 10,\n\toperations: [removeRange, annotateRange],\n\tgrowthFunc: (i) => i * 2,\n};\n\ndescribe(\"MergeTree.Client\", () => {\n\tdoOverRanges(defaultOptions, ({ minLength: minLen, concurrentOpsWithRevert, revertOps }) => {\n\t\tfor (const ackBeforeRevert of defaultOptions.ackBeforeRevert) {\n\t\t\tit(`InitialOps: ${defaultOptions.initialOps} MinLen: ${minLen}  ConcurrentOpsWithRevert: ${concurrentOpsWithRevert} RevertOps: ${revertOps} AckBeforeRevert: ${ackBeforeRevert}`, async () => {\n\t\t\t\tconst random = makeRandom(\n\t\t\t\t\tminLen,\n\t\t\t\t\trevertOps,\n\t\t\t\t\t[...ackBeforeRevert].reduce<number>((pv, cv) => pv + cv.charCodeAt(0), 0),\n\t\t\t\t\tconcurrentOpsWithRevert,\n\t\t\t\t);\n\n\t\t\t\tconst clients = createClientsAtInitialState(\n\t\t\t\t\t{\n\t\t\t\t\t\tinitialState: \"\",\n\t\t\t\t\t\toptions: {},\n\t\t\t\t\t},\n\t\t\t\t\t\"A\",\n\t\t\t\t\t\"B\",\n\t\t\t\t\t\"C\",\n\t\t\t\t);\n\t\t\t\tlet seq = 0;\n\t\t\t\tfor (let rnd = 0; rnd < defaultOptions.rounds; rnd++) {\n\t\t\t\t\tclients.all.forEach((c) => c.updateMinSeq(seq));\n\n\t\t\t\t\tconst logger = new TestClientLogger(clients.all, `Round ${rnd}`);\n\t\t\t\t\t{\n\t\t\t\t\t\t// init with random values\n\t\t\t\t\t\tconst initialMsgs = generateOperationMessagesForClients(\n\t\t\t\t\t\t\trandom,\n\t\t\t\t\t\t\tseq,\n\t\t\t\t\t\t\tclients.all,\n\t\t\t\t\t\t\tlogger,\n\t\t\t\t\t\t\tdefaultOptions.initialOps,\n\t\t\t\t\t\t\tminLen,\n\t\t\t\t\t\t\tdefaultOptions.operations,\n\t\t\t\t\t\t);\n\n\t\t\t\t\t\tseq = applyMessages(seq, initialMsgs, clients.all, logger);\n\t\t\t\t\t}\n\n\t\t\t\t\t// cache the base text to ensure we get back to it after revert\n\t\t\t\t\tconst undoBaseText = logger.validate({\n\t\t\t\t\t\tclear: true,\n\t\t\t\t\t\terrorPrefix: \"After Initial Ops\",\n\t\t\t\t\t});\n\n\t\t\t\t\tconst clientB_Revertibles: MergeTreeDeltaRevertible[] = [];\n\t\t\t\t\tconst clientBDriver = createRevertDriver(clients.B);\n\t\t\t\t\tconst deltaCallback = (op, delta) => {\n\t\t\t\t\t\tif (op.sequencedMessage === undefined) {\n\t\t\t\t\t\t\tappendToMergeTreeDeltaRevertibles(delta, clientB_Revertibles);\n\t\t\t\t\t\t}\n\t\t\t\t\t};\n\n\t\t\t\t\tconst msgs: [ISequencedDocumentMessage, SegmentGroup | SegmentGroup[]][] = [];\n\t\t\t\t\t{\n\t\t\t\t\t\tclientBDriver.submitOpCallback = (op) =>\n\t\t\t\t\t\t\tmsgs.push([\n\t\t\t\t\t\t\t\tclients.B.makeOpMessage(op, undefined, undefined, undefined, seq),\n\t\t\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\t\t\t\tclients.B.peekPendingSegmentGroups()!,\n\t\t\t\t\t\t\t]);\n\t\t\t\t\t\tclients.B.on(\"delta\", deltaCallback);\n\t\t\t\t\t\tmsgs.push(\n\t\t\t\t\t\t\t...generateOperationMessagesForClients(\n\t\t\t\t\t\t\t\trandom,\n\t\t\t\t\t\t\t\tseq,\n\t\t\t\t\t\t\t\t[clients.A, clients.B],\n\t\t\t\t\t\t\t\tlogger,\n\t\t\t\t\t\t\t\trevertOps,\n\t\t\t\t\t\t\t\tminLen,\n\t\t\t\t\t\t\t\tdefaultOptions.operations,\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\n\t\t\t\t\tif (concurrentOpsWithRevert > 0) {\n\t\t\t\t\t\t// add modifications from another client\n\t\t\t\t\t\tmsgs.push(\n\t\t\t\t\t\t\t...generateOperationMessagesForClients(\n\t\t\t\t\t\t\t\trandom,\n\t\t\t\t\t\t\t\tseq,\n\t\t\t\t\t\t\t\t[clients.A, clients.C],\n\t\t\t\t\t\t\t\tlogger,\n\t\t\t\t\t\t\t\tconcurrentOpsWithRevert,\n\t\t\t\t\t\t\t\tminLen,\n\t\t\t\t\t\t\t\tdefaultOptions.operations,\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\n\t\t\t\t\tlet redoBaseText: string | undefined;\n\t\t\t\t\tif (ackBeforeRevert !== \"None\") {\n\t\t\t\t\t\tconst ackAll = ackBeforeRevert === \"All\";\n\t\t\t\t\t\tseq = applyMessages(\n\t\t\t\t\t\t\tseq,\n\t\t\t\t\t\t\tmsgs.splice(\n\t\t\t\t\t\t\t\t0,\n\t\t\t\t\t\t\t\tackAll\n\t\t\t\t\t\t\t\t\t? msgs.length\n\t\t\t\t\t\t\t\t\t: random.integer(0, Math.floor(msgs.length / 2)),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t\tclients.all,\n\t\t\t\t\t\t\tlogger,\n\t\t\t\t\t\t);\n\t\t\t\t\t\tif (ackAll) {\n\t\t\t\t\t\t\tredoBaseText = logger.validate({ errorPrefix: \"Before Revert Ack\" });\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t\ttry {\n\t\t\t\t\t\trevertMergeTreeDeltaRevertibles(\n\t\t\t\t\t\t\tclientBDriver,\n\t\t\t\t\t\t\tclientB_Revertibles.splice(0),\n\t\t\t\t\t\t);\n\t\t\t\t\t\tseq = applyMessages(seq, msgs.splice(0), clients.all, logger);\n\t\t\t\t\t} catch (e) {\n\t\t\t\t\t\tthrow logger.addLogsToError(e);\n\t\t\t\t\t}\n\t\t\t\t\tlogger.validate({\n\t\t\t\t\t\tclear: true,\n\t\t\t\t\t\tbaseText: concurrentOpsWithRevert === 0 ? undoBaseText : undefined,\n\t\t\t\t\t\terrorPrefix: \"After Revert (undo)\",\n\t\t\t\t\t});\n\n\t\t\t\t\ttry {\n\t\t\t\t\t\t// reset the callback before the final revert\n\t\t\t\t\t\t// to avoid accruing any new detached references\n\t\t\t\t\t\tclients.B.off(\"delta\", deltaCallback);\n\t\t\t\t\t\trevertMergeTreeDeltaRevertibles(\n\t\t\t\t\t\t\tclientBDriver,\n\t\t\t\t\t\t\tclientB_Revertibles.splice(0),\n\t\t\t\t\t\t);\n\t\t\t\t\t\tseq = applyMessages(seq, msgs.splice(0), clients.all, logger);\n\n\t\t\t\t\t\twalkAllChildSegments(clients.B.mergeTree.root, (seg: ISegment) => {\n\t\t\t\t\t\t\tif (seg?.trackingCollection.empty === false) {\n\t\t\t\t\t\t\t\tassert.notDeepStrictEqual(\n\t\t\t\t\t\t\t\t\tseg?.trackingCollection.empty,\n\t\t\t\t\t\t\t\t\tfalse,\n\t\t\t\t\t\t\t\t\t\"there should be no left over tracking group\",\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\tif (seg?.localRefs?.empty === false) {\n\t\t\t\t\t\t\t\tassert.notDeepStrictEqual(\n\t\t\t\t\t\t\t\t\tseg?.localRefs?.empty,\n\t\t\t\t\t\t\t\t\tfalse,\n\t\t\t\t\t\t\t\t\t\"there should be no left over local references\",\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t});\n\t\t\t\t\t\tconst mergeTreeWithRevert: Partial<MergeTreeWithRevert> =\n\t\t\t\t\t\t\tclients.B.mergeTree;\n\t\t\t\t\t\tassert.notDeepStrictEqual(\n\t\t\t\t\t\t\tmergeTreeWithRevert.__mergeTreeRevertible?.detachedReferences?.localRefs\n\t\t\t\t\t\t\t\t?.empty,\n\t\t\t\t\t\t\tfalse,\n\t\t\t\t\t\t\t\"there should be no left over local references in detached references\",\n\t\t\t\t\t\t);\n\t\t\t\t\t} catch (e) {\n\t\t\t\t\t\tthrow logger.addLogsToError(e);\n\t\t\t\t\t}\n\t\t\t\t\tlogger.validate({\n\t\t\t\t\t\terrorPrefix: \"After Re-Revert (redo)\",\n\t\t\t\t\t\tbaseText: redoBaseText,\n\t\t\t\t\t});\n\t\t\t\t\tlogger.dispose();\n\t\t\t\t}\n\t\t\t});\n\t\t}\n\t});\n});\n"]}

package/lib/test/revertibles.spec.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Run a custom "spy function" every time the given method is invoked.
+ * @param methodClass - the class that has the method
+ * @param methodName - the name of the method
+ * @param spy - the spy function to run alongside the method
+ * @returns a function which will remove the spy function when invoked. Should be called exactly once
+ * after the spy is no longer needed.
+ *
+ * This method is duplicated between shared-tree test code, and should eventually
+ * be merged with the implementation that lives there
+ */
+export declare function spyOnMethod(methodClass: Function, methodName: string, spy: () => void): () => void;
+//# sourceMappingURL=revertibles.spec.d.ts.map

package/lib/test/revertibles.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revertibles.spec.d.ts","sourceRoot":"","sources":["../../src/test/revertibles.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAeH;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAE1B,WAAW,EAAE,QAAQ,EACrB,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,IAAI,GACb,MAAM,IAAI,CAcZ"}