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

package/lib/test/testServer.js

@@ -0,0 +1,133 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Heap } from "@fluidframework/core-utils";
+import { RedBlackTree } from "../collections/index.js";
+import { compareNumbers } from "../mergeTreeNodes.js";
+import { MergeTreeTextHelper } from "../MergeTreeTextHelper.js";
+import { TestClient } from "./testClient.js";
+const clientSeqComparer = {
+    min: { refSeq: -1, clientId: "" },
+    compare: (a, b) => a.refSeq - b.refSeq,
+};
+/**
+ * Server for tests.  Simulates client communication by directing placing
+ * messages in client queues.
+ */
+export class TestServer extends TestClient {
+    constructor(options) {
+        super(options);
+        this.seq = 1;
+        this.clients = [];
+        this.clientSeqNumbers = new Heap(clientSeqComparer);
+        this.upstreamMap = new RedBlackTree(compareNumbers);
+        this.minSeq = 0;
+    }
+    addClients(clients) {
+        this.clientSeqNumbers = new Heap(clientSeqComparer);
+        this.clients = clients;
+        for (const client of clients) {
+            this.clientSeqNumbers.add({
+                refSeq: client.getCurrentSeq(),
+                clientId: client.longClientId ?? "",
+            });
+        }
+    }
+    applyMsg(msg) {
+        super.applyMsg(msg);
+        if (TestClient.useCheckQ) {
+            const clid = this.getShortClientId(msg.clientId);
+            return checkTextMatchRelative(msg.referenceSequenceNumber, clid, this, msg);
+        }
+        else {
+            return false;
+        }
+    }
+    // TODO: remove mappings when no longer needed using min seq
+    // in upstream message
+    transformUpstreamMessage(msg) {
+        if (msg.referenceSequenceNumber > 0) {
+            msg.referenceSequenceNumber =
+                this.upstreamMap.get(msg.referenceSequenceNumber)?.data ?? 0;
+        }
+        msg.origin = {
+            id: "A",
+            sequenceNumber: msg.sequenceNumber,
+            minimumSequenceNumber: msg.minimumSequenceNumber,
+        };
+        this.upstreamMap.put(msg.sequenceNumber, this.seq);
+        msg.sequenceNumber = -1;
+    }
+    copyMsg(msg) {
+        return {
+            clientId: msg.clientId,
+            clientSequenceNumber: msg.clientSequenceNumber,
+            contents: msg.contents,
+            minimumSequenceNumber: msg.minimumSequenceNumber,
+            referenceSequenceNumber: msg.referenceSequenceNumber,
+            sequenceNumber: msg.sequenceNumber,
+            type: msg.type,
+        };
+    }
+    applyMessages(msgCount) {
+        let _msgCount = msgCount;
+        while (_msgCount > 0) {
+            const msg = this.dequeueMsg();
+            if (msg) {
+                if (msg.sequenceNumber >= 0) {
+                    this.transformUpstreamMessage(msg);
+                }
+                msg.sequenceNumber = this.seq++;
+                msg.minimumSequenceNumber = this.minSeq;
+                if (this.applyMsg(msg)) {
+                    return true;
+                }
+                if (this.clients) {
+                    let minCli = this.clientSeqNumbers.peek()?.value;
+                    if (minCli &&
+                        minCli.clientId === msg.clientId &&
+                        minCli.refSeq < msg.referenceSequenceNumber) {
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                        const cliSeq = this.clientSeqNumbers.get();
+                        const oldSeq = cliSeq.refSeq;
+                        cliSeq.refSeq = msg.referenceSequenceNumber;
+                        this.clientSeqNumbers.add(cliSeq);
+                        minCli = this.clientSeqNumbers.peek()?.value;
+                        if (minCli && minCli.refSeq > oldSeq) {
+                            msg.minimumSequenceNumber = minCli.refSeq;
+                            this.minSeq = minCli.refSeq;
+                        }
+                    }
+                    for (const client of this.clients) {
+                        client.enqueueMsg(msg);
+                    }
+                }
+            }
+            else {
+                break;
+            }
+            _msgCount--;
+        }
+        return false;
+    }
+}
+/**
+ * Used for in-memory testing.  This will queue a reference string for each client message.
+ */
+export function checkTextMatchRelative(refSeq, clientId, server, msg) {
+    const client = server.clients[clientId];
+    const serverText = new MergeTreeTextHelper(server.mergeTree).getText(refSeq, clientId);
+    const cliText = client.checkQ.shift()?.data;
+    if (cliText === undefined || cliText !== serverText) {
+        console.log(`mismatch `);
+        console.log(msg);
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        console.log(server.mergeTree.toString());
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        console.log(client.mergeTree.toString());
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=testServer.js.map

package/lib/test/testServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testServer.js","sourceRoot":"","sources":["../../src/test/testServer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,IAAI,EAAa,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAO7C,MAAM,iBAAiB,GAAyB;IAC/C,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM;CACtC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IAKzC,YAAY,OAAqB;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QALhB,QAAG,GAAG,CAAC,CAAC;QACR,YAAO,GAAiB,EAAE,CAAC;QAC3B,qBAAgB,GAAoB,IAAI,IAAI,CAAY,iBAAiB,CAAC,CAAC;QAC3E,gBAAW,GAAiC,IAAI,YAAY,CAAiB,cAAc,CAAC,CAAC;QAsDrF,WAAM,GAAG,CAAC,CAAC;IAnDnB,CAAC;IAED,UAAU,CAAC,OAAqB;QAC/B,IAAI,CAAC,gBAAgB,GAAG,IAAI,IAAI,CAAY,iBAAiB,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC7B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;gBACzB,MAAM,EAAE,MAAM,CAAC,aAAa,EAAE;gBAC9B,QAAQ,EAAE,MAAM,CAAC,YAAY,IAAI,EAAE;aACnC,CAAC,CAAC;SACH;IACF,CAAC;IAED,QAAQ,CAAC,GAA8B;QACtC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpB,IAAI,UAAU,CAAC,SAAS,EAAE;YACzB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAkB,CAAC,CAAC;YAC3D,OAAO,sBAAsB,CAAC,GAAG,CAAC,uBAAuB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;SAC5E;aAAM;YACN,OAAO,KAAK,CAAC;SACb;IACF,CAAC;IAED,4DAA4D;IAC5D,sBAAsB;IACtB,wBAAwB,CAAC,GAA8B;QACtD,IAAI,GAAG,CAAC,uBAAuB,GAAG,CAAC,EAAE;YACpC,GAAG,CAAC,uBAAuB;gBAC1B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;SAC9D;QACD,GAAG,CAAC,MAAM,GAAG;YACZ,EAAE,EAAE,GAAG;YACP,cAAc,EAAE,GAAG,CAAC,cAAc;YAClC,qBAAqB,EAAE,GAAG,CAAC,qBAAqB;SAChD,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,GAAG,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,CAAC,GAA8B;QACrC,OAAO;YACN,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,oBAAoB,EAAE,GAAG,CAAC,oBAAoB;YAC9C,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,qBAAqB,EAAE,GAAG,CAAC,qBAAqB;YAChD,uBAAuB,EAAE,GAAG,CAAC,uBAAuB;YACpD,cAAc,EAAE,GAAG,CAAC,cAAc;YAClC,IAAI,EAAE,GAAG,CAAC,IAAI;SACsB,CAAC;IACvC,CAAC;IAID,aAAa,CAAC,QAAgB;QAC7B,IAAI,SAAS,GAAG,QAAQ,CAAC;QACzB,OAAO,SAAS,GAAG,CAAC,EAAE;YACrB,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC9B,IAAI,GAAG,EAAE;gBACR,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,EAAE;oBAC5B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;iBACnC;gBACD,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAChC,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC;gBACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACvB,OAAO,IAAI,CAAC;iBACZ;gBACD,IAAI,IAAI,CAAC,OAAO,EAAE;oBACjB,IAAI,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC;oBACjD,IACC,MAAM;wBACN,MAAM,CAAC,QAAQ,KAAK,GAAG,CAAC,QAAQ;wBAChC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,uBAAuB,EAC1C;wBACD,oEAAoE;wBACpE,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAG,CAAC;wBAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;wBAC7B,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,uBAAuB,CAAC;wBAC5C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;wBAClC,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,KAAK,CAAC;wBAC7C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE;4BACrC,GAAG,CAAC,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;4BAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;yBAC5B;qBACD;oBACD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;wBAClC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;qBACvB;iBACD;aACD;iBAAM;gBACN,MAAM;aACN;YACD,SAAS,EAAE,CAAC;SACZ;QACD,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAAc,EACd,QAAgB,EAChB,MAAkB,EAClB,GAA8B;IAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,UAAU,GAAG,IAAI,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACvF,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC;IAC5C,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,UAAU,EAAE;QACpD,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACzB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,gEAAgE;QAChE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,gEAAgE;QAChE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;KACZ;IACD,OAAO,KAAK,CAAC;AACd,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { Heap, IComparer } from \"@fluidframework/core-utils\";\nimport { RedBlackTree } from \"../collections/index.js\";\nimport { compareNumbers } from \"../mergeTreeNodes.js\";\nimport { PropertySet } from \"../properties.js\";\nimport { MergeTreeTextHelper } from \"../MergeTreeTextHelper.js\";\nimport { TestClient } from \"./testClient.js\";\n\ninterface ClientSeq {\n\trefSeq: number;\n\tclientId: string;\n}\n\nconst clientSeqComparer: IComparer<ClientSeq> = {\n\tmin: { refSeq: -1, clientId: \"\" },\n\tcompare: (a, b) => a.refSeq - b.refSeq,\n};\n\n/**\n * Server for tests.  Simulates client communication by directing placing\n * messages in client queues.\n */\nexport class TestServer extends TestClient {\n\tseq = 1;\n\tclients: TestClient[] = [];\n\tclientSeqNumbers: Heap<ClientSeq> = new Heap<ClientSeq>(clientSeqComparer);\n\tupstreamMap: RedBlackTree<number, number> = new RedBlackTree<number, number>(compareNumbers);\n\tconstructor(options?: PropertySet) {\n\t\tsuper(options);\n\t}\n\n\taddClients(clients: TestClient[]) {\n\t\tthis.clientSeqNumbers = new Heap<ClientSeq>(clientSeqComparer);\n\t\tthis.clients = clients;\n\t\tfor (const client of clients) {\n\t\t\tthis.clientSeqNumbers.add({\n\t\t\t\trefSeq: client.getCurrentSeq(),\n\t\t\t\tclientId: client.longClientId ?? \"\",\n\t\t\t});\n\t\t}\n\t}\n\n\tapplyMsg(msg: ISequencedDocumentMessage) {\n\t\tsuper.applyMsg(msg);\n\t\tif (TestClient.useCheckQ) {\n\t\t\tconst clid = this.getShortClientId(msg.clientId as string);\n\t\t\treturn checkTextMatchRelative(msg.referenceSequenceNumber, clid, this, msg);\n\t\t} else {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\t// TODO: remove mappings when no longer needed using min seq\n\t// in upstream message\n\ttransformUpstreamMessage(msg: ISequencedDocumentMessage) {\n\t\tif (msg.referenceSequenceNumber > 0) {\n\t\t\tmsg.referenceSequenceNumber =\n\t\t\t\tthis.upstreamMap.get(msg.referenceSequenceNumber)?.data ?? 0;\n\t\t}\n\t\tmsg.origin = {\n\t\t\tid: \"A\",\n\t\t\tsequenceNumber: msg.sequenceNumber,\n\t\t\tminimumSequenceNumber: msg.minimumSequenceNumber,\n\t\t};\n\t\tthis.upstreamMap.put(msg.sequenceNumber, this.seq);\n\t\tmsg.sequenceNumber = -1;\n\t}\n\n\tcopyMsg(msg: ISequencedDocumentMessage) {\n\t\treturn {\n\t\t\tclientId: msg.clientId,\n\t\t\tclientSequenceNumber: msg.clientSequenceNumber,\n\t\t\tcontents: msg.contents,\n\t\t\tminimumSequenceNumber: msg.minimumSequenceNumber,\n\t\t\treferenceSequenceNumber: msg.referenceSequenceNumber,\n\t\t\tsequenceNumber: msg.sequenceNumber,\n\t\t\ttype: msg.type,\n\t\t} as any as ISequencedDocumentMessage;\n\t}\n\n\tprivate minSeq = 0;\n\n\tapplyMessages(msgCount: number) {\n\t\tlet _msgCount = msgCount;\n\t\twhile (_msgCount > 0) {\n\t\t\tconst msg = this.dequeueMsg();\n\t\t\tif (msg) {\n\t\t\t\tif (msg.sequenceNumber >= 0) {\n\t\t\t\t\tthis.transformUpstreamMessage(msg);\n\t\t\t\t}\n\t\t\t\tmsg.sequenceNumber = this.seq++;\n\t\t\t\tmsg.minimumSequenceNumber = this.minSeq;\n\t\t\t\tif (this.applyMsg(msg)) {\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tif (this.clients) {\n\t\t\t\t\tlet minCli = this.clientSeqNumbers.peek()?.value;\n\t\t\t\t\tif (\n\t\t\t\t\t\tminCli &&\n\t\t\t\t\t\tminCli.clientId === msg.clientId &&\n\t\t\t\t\t\tminCli.refSeq < msg.referenceSequenceNumber\n\t\t\t\t\t) {\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\t\t\t\tconst cliSeq = this.clientSeqNumbers.get()!;\n\t\t\t\t\t\tconst oldSeq = cliSeq.refSeq;\n\t\t\t\t\t\tcliSeq.refSeq = msg.referenceSequenceNumber;\n\t\t\t\t\t\tthis.clientSeqNumbers.add(cliSeq);\n\t\t\t\t\t\tminCli = this.clientSeqNumbers.peek()?.value;\n\t\t\t\t\t\tif (minCli && minCli.refSeq > oldSeq) {\n\t\t\t\t\t\t\tmsg.minimumSequenceNumber = minCli.refSeq;\n\t\t\t\t\t\t\tthis.minSeq = minCli.refSeq;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tfor (const client of this.clients) {\n\t\t\t\t\t\tclient.enqueueMsg(msg);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t_msgCount--;\n\t\t}\n\t\treturn false;\n\t}\n}\n\n/**\n * Used for in-memory testing.  This will queue a reference string for each client message.\n */\nexport function checkTextMatchRelative(\n\trefSeq: number,\n\tclientId: number,\n\tserver: TestServer,\n\tmsg: ISequencedDocumentMessage,\n) {\n\tconst client = server.clients[clientId];\n\tconst serverText = new MergeTreeTextHelper(server.mergeTree).getText(refSeq, clientId);\n\tconst cliText = client.checkQ.shift()?.data;\n\tif (cliText === undefined || cliText !== serverText) {\n\t\tconsole.log(`mismatch `);\n\t\tconsole.log(msg);\n\t\t// eslint-disable-next-line @typescript-eslint/no-base-to-string\n\t\tconsole.log(server.mergeTree.toString());\n\t\t// eslint-disable-next-line @typescript-eslint/no-base-to-string\n\t\tconsole.log(client.mergeTree.toString());\n\t\treturn true;\n\t}\n\treturn false;\n}\n"]}

package/lib/test/testUtils.d.ts

@@ -0,0 +1,77 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IMergeBlock, ISegment } from "../mergeTreeNodes.js";
+import { IMergeTreeDeltaOpArgs } from "../mergeTreeDeltaCallback.js";
+import { ReferenceType } from "../ops.js";
+import { PropertySet } from "../properties.js";
+import { MergeTree } from "../mergeTree.js";
+import { LocalReferenceCollection } from "../localReference.js";
+export declare function loadTextFromFile(filename: string, mergeTree: MergeTree, segLimit?: number): MergeTree;
+export declare function loadTextFromFileWithMarkers(filename: string, mergeTree: MergeTree, segLimit?: number): MergeTree;
+interface InsertMarkerArgs {
+    mergeTree: MergeTree;
+    pos: number;
+    refSeq: number;
+    clientId: number;
+    seq: number;
+    behaviors: ReferenceType;
+    props: PropertySet | undefined;
+    opArgs: IMergeTreeDeltaOpArgs;
+}
+export declare function insertMarker({ mergeTree, pos, refSeq, clientId, seq, behaviors, props, opArgs, }: InsertMarkerArgs): void;
+interface InsertTextArgs {
+    mergeTree: MergeTree;
+    pos: number;
+    refSeq: number;
+    clientId: number;
+    seq: number;
+    text: string;
+    props?: PropertySet;
+    opArgs?: IMergeTreeDeltaOpArgs;
+}
+export declare function insertText({ mergeTree, pos, refSeq, clientId, seq, text, props, opArgs, }: InsertTextArgs): void;
+interface InsertSegmentsArgs {
+    mergeTree: MergeTree;
+    pos: number;
+    segments: ISegment[];
+    refSeq: number;
+    clientId: number;
+    seq: number;
+    opArgs: IMergeTreeDeltaOpArgs | undefined;
+}
+export declare function insertSegments({ mergeTree, pos, segments, refSeq, clientId, seq, opArgs, }: InsertSegmentsArgs): void;
+interface MarkRangeRemovedArgs {
+    mergeTree: MergeTree;
+    start: number;
+    end: number;
+    refSeq: number;
+    clientId: number;
+    seq: number;
+    overwrite: boolean;
+    opArgs: IMergeTreeDeltaOpArgs;
+}
+export declare function markRangeRemoved({ mergeTree, start, end, refSeq, clientId, seq, overwrite, opArgs, }: MarkRangeRemovedArgs): void;
+export declare function nodeOrdinalsHaveIntegrity(block: IMergeBlock): boolean;
+/**
+ * Returns an object that tallies each delta and maintenance operation observed
+ * for the given 'mergeTree'.
+ */
+export declare function countOperations(mergeTree: MergeTree): {};
+export declare function validatePartialLengths(clientId: number, mergeTree: MergeTree, expectedValues?: {
+    seq: number;
+    len: number;
+    localSeq?: number;
+}[], localSeq?: number, mergeBlock?: IMergeBlock): void;
+export declare function validateRefCount(collection?: LocalReferenceCollection): void;
+/**
+ * Enable stricter partial length assertions inside tests
+ *
+ * Note that these assertions can be expensive, and so should not be enabled in
+ * production code or tests that run through thousands of ops (e.g. the SharedString
+ * fuzz tests).
+ */
+export declare function useStrictPartialLengthChecks(): void;
+export {};
+//# sourceMappingURL=testUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../../src/test/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAU,MAAM,sBAAsB,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAQhE,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,SAAI,aAGpF;AAED,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,SAAI,aAG/F;AAED,UAAU,gBAAgB;IACzB,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,qBAAqB,CAAC;CAC9B;AAED,wBAAgB,YAAY,CAAC,EAC5B,SAAS,EACT,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,SAAS,EACT,KAAK,EACL,MAAM,GACN,EAAE,gBAAgB,QAElB;AAED,UAAU,cAAc;IACvB,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AAED,wBAAgB,UAAU,CAAC,EAC1B,SAAS,EACT,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,IAAI,EACJ,KAAK,EACL,MAAM,GACN,EAAE,cAAc,QAEhB;AAED,UAAU,kBAAkB;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC;CAC1C;AAED,wBAAgB,cAAc,CAAC,EAC9B,SAAS,EACT,GAAG,EACH,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,GAAG,EACH,MAAM,GACN,EAAE,kBAAkB,GAAG,IAAI,CAE3B;AAED,UAAU,oBAAoB;IAC7B,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,qBAAqB,CAAC;CAC9B;AAED,wBAAgB,gBAAgB,CAAC,EAChC,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,SAAiB,EACjB,MAAM,GACN,EAAE,oBAAoB,GAAG,IAAI,CAE7B;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAuBrE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,MAiBnD;AAkDD,wBAAgB,sBAAsB,CACrC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,EACpB,cAAc,CAAC,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,EAClE,QAAQ,CAAC,EAAE,MAAM,EACjB,UAAU,GAAE,WAA4B,GACtC,IAAI,CAiCN;AAED,wBAAgB,gBAAgB,CAAC,UAAU,CAAC,EAAE,wBAAwB,QASrE;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,SAU3C"}

package/lib/test/testUtils.js

@@ -0,0 +1,151 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import fs from "fs";
+import { Marker } from "../mergeTreeNodes.js";
+import { TextSegment } from "../textSegment.js";
+import { walkAllChildSegments } from "../mergeTreeNodeWalk.js";
+import { UnassignedSequenceNumber } from "../constants.js";
+import { PartialSequenceLengths, verifyExpectedPartialLengths, verifyPartialLengths, } from "../partialLengths.js";
+import { loadText } from "./text.js";
+export function loadTextFromFile(filename, mergeTree, segLimit = 0) {
+    const content = fs.readFileSync(filename, "utf8");
+    return loadText(content, mergeTree, segLimit);
+}
+export function loadTextFromFileWithMarkers(filename, mergeTree, segLimit = 0) {
+    const content = fs.readFileSync(filename, "utf8");
+    return loadText(content, mergeTree, segLimit, true);
+}
+export function insertMarker({ mergeTree, pos, refSeq, clientId, seq, behaviors, props, opArgs, }) {
+    mergeTree.insertSegments(pos, [Marker.make(behaviors, props)], refSeq, clientId, seq, opArgs);
+}
+export function insertText({ mergeTree, pos, refSeq, clientId, seq, text, props, opArgs, }) {
+    mergeTree.insertSegments(pos, [TextSegment.make(text, props)], refSeq, clientId, seq, opArgs);
+}
+export function insertSegments({ mergeTree, pos, segments, refSeq, clientId, seq, opArgs, }) {
+    mergeTree.insertSegments(pos, segments, refSeq, clientId, seq, opArgs);
+}
+export function markRangeRemoved({ mergeTree, start, end, refSeq, clientId, seq, overwrite = false, opArgs, }) {
+    mergeTree.markRangeRemoved(start, end, refSeq, clientId, seq, overwrite, opArgs);
+}
+export function nodeOrdinalsHaveIntegrity(block) {
+    const olen = block.ordinal.length;
+    for (let i = 0; i < block.childCount; i++) {
+        if (block.children[i].ordinal) {
+            if (olen !== block.children[i].ordinal.length - 1) {
+                console.log("node integrity issue");
+                return false;
+            }
+            if (i > 0) {
+                if (block.children[i].ordinal <= block.children[i - 1].ordinal) {
+                    console.log("node sib integrity issue");
+                    return false;
+                }
+            }
+            if (!block.children[i].isLeaf()) {
+                return nodeOrdinalsHaveIntegrity(block.children[i]);
+            }
+        }
+        else {
+            console.log(`node child ordinal not set ${i}`);
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Returns an object that tallies each delta and maintenance operation observed
+ * for the given 'mergeTree'.
+ */
+export function countOperations(mergeTree) {
+    const counts = {};
+    assert.strictEqual(mergeTree.mergeTreeDeltaCallback, undefined);
+    assert.strictEqual(mergeTree.mergeTreeMaintenanceCallback, undefined);
+    const fn = (deltaArgs) => {
+        const previous = counts[deltaArgs.operation];
+        counts[deltaArgs.operation] = previous === undefined ? 1 : previous + 1;
+    };
+    mergeTree.mergeTreeDeltaCallback = (opArgs, deltaArgs) => {
+        fn(deltaArgs);
+    };
+    mergeTree.mergeTreeMaintenanceCallback = fn;
+    return counts;
+}
+function getPartialLengths(clientId, seq, mergeTree, localSeq, mergeBlock = mergeTree.root) {
+    const partialLen = mergeBlock.partialLengths?.getPartialLength(seq, clientId, localSeq);
+    let actualLen = 0;
+    const isInserted = (segment) => segment.seq === undefined ||
+        (segment.seq !== UnassignedSequenceNumber && segment.seq <= seq) ||
+        (localSeq !== undefined &&
+            segment.seq === UnassignedSequenceNumber &&
+            segment.localSeq !== undefined &&
+            segment.localSeq <= localSeq);
+    const isRemoved = (segment) => segment.removedSeq !== undefined &&
+        ((localSeq !== undefined &&
+            segment.removedSeq === UnassignedSequenceNumber &&
+            segment.localRemovedSeq !== undefined &&
+            segment.localRemovedSeq <= localSeq) ||
+            (segment.removedSeq !== UnassignedSequenceNumber && segment.removedSeq <= seq));
+    const isMoved = (segment) => segment.movedSeq !== undefined &&
+        ((localSeq !== undefined &&
+            segment.movedSeq === UnassignedSequenceNumber &&
+            segment.localMovedSeq !== undefined &&
+            segment.localMovedSeq <= localSeq) ||
+            (segment.movedSeq !== UnassignedSequenceNumber && segment.movedSeq <= seq));
+    walkAllChildSegments(mergeBlock, (segment) => {
+        if (isInserted(segment) && !isRemoved(segment) && !isMoved(segment)) {
+            actualLen += segment.cachedLength;
+        }
+        return true;
+    });
+    return {
+        partialLen,
+        actualLen,
+    };
+}
+export function validatePartialLengths(clientId, mergeTree, expectedValues, localSeq, mergeBlock = mergeTree.root) {
+    mergeTree.computeLocalPartials(0);
+    for (let i = mergeTree.collabWindow.minSeq + 1; i <= mergeTree.collabWindow.currentSeq; i++) {
+        const { partialLen, actualLen } = getPartialLengths(clientId, i, mergeTree, localSeq, mergeBlock);
+        if (partialLen && partialLen < 0) {
+            assert.fail("Negative partial length returned");
+        }
+        assert.equal(partialLen, actualLen);
+    }
+    if (!expectedValues) {
+        return;
+    }
+    for (const { seq, len, localSeq: expectedLocalSeq } of expectedValues) {
+        const { partialLen, actualLen } = getPartialLengths(clientId, seq, mergeTree, expectedLocalSeq ?? localSeq, mergeBlock);
+        assert.equal(partialLen, len);
+        assert.equal(actualLen, len);
+    }
+}
+export function validateRefCount(collection) {
+    if (!collection) {
+        return;
+    }
+    const expectedLength = Array.from(collection).length;
+    // eslint-disable-next-line @typescript-eslint/dot-notation
+    assert.equal(collection["refCount"], expectedLength);
+}
+/**
+ * Enable stricter partial length assertions inside tests
+ *
+ * Note that these assertions can be expensive, and so should not be enabled in
+ * production code or tests that run through thousands of ops (e.g. the SharedString
+ * fuzz tests).
+ */
+export function useStrictPartialLengthChecks() {
+    beforeEach(() => {
+        PartialSequenceLengths.options.verifier = verifyPartialLengths;
+        PartialSequenceLengths.options.verifyExpected = verifyExpectedPartialLengths;
+    });
+    afterEach(() => {
+        PartialSequenceLengths.options.verifier = undefined;
+        PartialSequenceLengths.options.verifyExpected = undefined;
+    });
+}
+//# sourceMappingURL=testUtils.js.map

package/lib/test/testUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUtils.js","sourceRoot":"","sources":["../../src/test/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAyB,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAErE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAIhD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,OAAO,EACN,sBAAsB,EACtB,4BAA4B,EAC5B,oBAAoB,GACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,MAAM,UAAU,gBAAgB,CAAC,QAAgB,EAAE,SAAoB,EAAE,QAAQ,GAAG,CAAC;IACpF,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,QAAgB,EAAE,SAAoB,EAAE,QAAQ,GAAG,CAAC;IAC/F,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAClD,OAAO,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAaD,MAAM,UAAU,YAAY,CAAC,EAC5B,SAAS,EACT,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,SAAS,EACT,KAAK,EACL,MAAM,GACY;IAClB,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AAC/F,CAAC;AAaD,MAAM,UAAU,UAAU,CAAC,EAC1B,SAAS,EACT,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,IAAI,EACJ,KAAK,EACL,MAAM,GACU;IAChB,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AAC/F,CAAC;AAYD,MAAM,UAAU,cAAc,CAAC,EAC9B,SAAS,EACT,GAAG,EACH,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,GAAG,EACH,MAAM,GACc;IACpB,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AACxE,CAAC;AAaD,MAAM,UAAU,gBAAgB,CAAC,EAChC,SAAS,EACT,KAAK,EACL,GAAG,EACH,MAAM,EACN,QAAQ,EACR,GAAG,EACH,SAAS,GAAG,KAAK,EACjB,MAAM,GACgB;IACtB,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAkB;IAC3D,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;YAC9B,IAAI,IAAI,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;gBAClD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;gBACpC,OAAO,KAAK,CAAC;aACb;YACD,IAAI,CAAC,GAAG,CAAC,EAAE;gBACV,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE;oBAC/D,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;oBACxC,OAAO,KAAK,CAAC;iBACb;aACD;YACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE;gBAChC,OAAO,yBAAyB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAgB,CAAC,CAAC;aACnE;SACD;aAAM;YACN,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,EAAE,CAAC,CAAC;YAC/C,OAAO,KAAK,CAAC;SACb;KACD;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,SAAoB;IACnD,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAChE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,4BAA4B,EAAE,SAAS,CAAC,CAAC;IAEtE,MAAM,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE;QACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,CAAuB,CAAC;QACnE,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;IACzE,CAAC,CAAC;IAEF,SAAS,CAAC,sBAAsB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE;QACxD,EAAE,CAAC,SAAS,CAAC,CAAC;IACf,CAAC,CAAC;IACF,SAAS,CAAC,4BAA4B,GAAG,EAAE,CAAC;IAE5C,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACzB,QAAgB,EAChB,GAAW,EACX,SAAoB,EACpB,QAAiB,EACjB,aAA0B,SAAS,CAAC,IAAI;IAExC,MAAM,UAAU,GAAG,UAAU,CAAC,cAAc,EAAE,gBAAgB,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAExF,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,MAAM,UAAU,GAAG,CAAC,OAAiB,EAAE,EAAE,CACxC,OAAO,CAAC,GAAG,KAAK,SAAS;QACzB,CAAC,OAAO,CAAC,GAAG,KAAK,wBAAwB,IAAI,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC;QAChE,CAAC,QAAQ,KAAK,SAAS;YACtB,OAAO,CAAC,GAAG,KAAK,wBAAwB;YACxC,OAAO,CAAC,QAAQ,KAAK,SAAS;YAC9B,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC;IAEhC,MAAM,SAAS,GAAG,CAAC,OAAiB,EAAE,EAAE,CACvC,OAAO,CAAC,UAAU,KAAK,SAAS;QAChC,CAAC,CAAC,QAAQ,KAAK,SAAS;YACvB,OAAO,CAAC,UAAU,KAAK,wBAAwB;YAC/C,OAAO,CAAC,eAAe,KAAK,SAAS;YACrC,OAAO,CAAC,eAAe,IAAI,QAAQ,CAAC;YACpC,CAAC,OAAO,CAAC,UAAU,KAAK,wBAAwB,IAAI,OAAO,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC;IAElF,MAAM,OAAO,GAAG,CAAC,OAAiB,EAAE,EAAE,CACrC,OAAO,CAAC,QAAQ,KAAK,SAAS;QAC9B,CAAC,CAAC,QAAQ,KAAK,SAAS;YACvB,OAAO,CAAC,QAAQ,KAAK,wBAAwB;YAC7C,OAAO,CAAC,aAAa,KAAK,SAAS;YACnC,OAAO,CAAC,aAAa,IAAI,QAAQ,CAAC;YAClC,CAAC,OAAO,CAAC,QAAQ,KAAK,wBAAwB,IAAI,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC;IAE9E,oBAAoB,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE;QAC5C,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACpE,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC;SAClC;QACD,OAAO,IAAI,CAAC;IACb,CAAC,CAAC,CAAC;IAEH,OAAO;QACN,UAAU;QACV,SAAS;KACT,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CACrC,QAAgB,EAChB,SAAoB,EACpB,cAAkE,EAClE,QAAiB,EACjB,aAA0B,SAAS,CAAC,IAAI;IAExC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,SAAS,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE;QAC5F,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,iBAAiB,CAClD,QAAQ,EACR,CAAC,EACD,SAAS,EACT,QAAQ,EACR,UAAU,CACV,CAAC;QAEF,IAAI,UAAU,IAAI,UAAU,GAAG,CAAC,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;SAChD;QACD,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACpC;IAED,IAAI,CAAC,cAAc,EAAE;QACpB,OAAO;KACP;IAED,KAAK,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,EAAE,IAAI,cAAc,EAAE;QACtE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,iBAAiB,CAClD,QAAQ,EACR,GAAG,EACH,SAAS,EACT,gBAAgB,IAAI,QAAQ,EAC5B,UAAU,CACV,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;KAC7B;AACF,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAqC;IACrE,IAAI,CAAC,UAAU,EAAE;QAChB,OAAO;KACP;IAED,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;IAErD,2DAA2D;IAC3D,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,4BAA4B;IAC3C,UAAU,CAAC,GAAG,EAAE;QACf,sBAAsB,CAAC,OAAO,CAAC,QAAQ,GAAG,oBAAoB,CAAC;QAC/D,sBAAsB,CAAC,OAAO,CAAC,cAAc,GAAG,4BAA4B,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACd,sBAAsB,CAAC,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;QACpD,sBAAsB,CAAC,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAC3D,CAAC,CAAC,CAAC;AACJ,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 fs from \"fs\";\nimport { IMergeBlock, ISegment, Marker } from \"../mergeTreeNodes.js\";\nimport { IMergeTreeDeltaOpArgs } from \"../mergeTreeDeltaCallback.js\";\nimport { TextSegment } from \"../textSegment.js\";\nimport { ReferenceType } from \"../ops.js\";\nimport { PropertySet } from \"../properties.js\";\nimport { MergeTree } from \"../mergeTree.js\";\nimport { walkAllChildSegments } from \"../mergeTreeNodeWalk.js\";\nimport { UnassignedSequenceNumber } from \"../constants.js\";\nimport { LocalReferenceCollection } from \"../localReference.js\";\nimport {\n\tPartialSequenceLengths,\n\tverifyExpectedPartialLengths,\n\tverifyPartialLengths,\n} from \"../partialLengths.js\";\nimport { loadText } from \"./text.js\";\n\nexport function loadTextFromFile(filename: string, mergeTree: MergeTree, segLimit = 0) {\n\tconst content = fs.readFileSync(filename, \"utf8\");\n\treturn loadText(content, mergeTree, segLimit);\n}\n\nexport function loadTextFromFileWithMarkers(filename: string, mergeTree: MergeTree, segLimit = 0) {\n\tconst content = fs.readFileSync(filename, \"utf8\");\n\treturn loadText(content, mergeTree, segLimit, true);\n}\n\ninterface InsertMarkerArgs {\n\tmergeTree: MergeTree;\n\tpos: number;\n\trefSeq: number;\n\tclientId: number;\n\tseq: number;\n\tbehaviors: ReferenceType;\n\tprops: PropertySet | undefined;\n\topArgs: IMergeTreeDeltaOpArgs;\n}\n\nexport function insertMarker({\n\tmergeTree,\n\tpos,\n\trefSeq,\n\tclientId,\n\tseq,\n\tbehaviors,\n\tprops,\n\topArgs,\n}: InsertMarkerArgs) {\n\tmergeTree.insertSegments(pos, [Marker.make(behaviors, props)], refSeq, clientId, seq, opArgs);\n}\n\ninterface InsertTextArgs {\n\tmergeTree: MergeTree;\n\tpos: number;\n\trefSeq: number;\n\tclientId: number;\n\tseq: number;\n\ttext: string;\n\tprops?: PropertySet;\n\topArgs?: IMergeTreeDeltaOpArgs;\n}\n\nexport function insertText({\n\tmergeTree,\n\tpos,\n\trefSeq,\n\tclientId,\n\tseq,\n\ttext,\n\tprops,\n\topArgs,\n}: InsertTextArgs) {\n\tmergeTree.insertSegments(pos, [TextSegment.make(text, props)], refSeq, clientId, seq, opArgs);\n}\n\ninterface InsertSegmentsArgs {\n\tmergeTree: MergeTree;\n\tpos: number;\n\tsegments: ISegment[];\n\trefSeq: number;\n\tclientId: number;\n\tseq: number;\n\topArgs: IMergeTreeDeltaOpArgs | undefined;\n}\n\nexport function insertSegments({\n\tmergeTree,\n\tpos,\n\tsegments,\n\trefSeq,\n\tclientId,\n\tseq,\n\topArgs,\n}: InsertSegmentsArgs): void {\n\tmergeTree.insertSegments(pos, segments, refSeq, clientId, seq, opArgs);\n}\n\ninterface MarkRangeRemovedArgs {\n\tmergeTree: MergeTree;\n\tstart: number;\n\tend: number;\n\trefSeq: number;\n\tclientId: number;\n\tseq: number;\n\toverwrite: boolean;\n\topArgs: IMergeTreeDeltaOpArgs;\n}\n\nexport function markRangeRemoved({\n\tmergeTree,\n\tstart,\n\tend,\n\trefSeq,\n\tclientId,\n\tseq,\n\toverwrite = false,\n\topArgs,\n}: MarkRangeRemovedArgs): void {\n\tmergeTree.markRangeRemoved(start, end, refSeq, clientId, seq, overwrite, opArgs);\n}\n\nexport function nodeOrdinalsHaveIntegrity(block: IMergeBlock): boolean {\n\tconst olen = block.ordinal.length;\n\tfor (let i = 0; i < block.childCount; i++) {\n\t\tif (block.children[i].ordinal) {\n\t\t\tif (olen !== block.children[i].ordinal.length - 1) {\n\t\t\t\tconsole.log(\"node integrity issue\");\n\t\t\t\treturn false;\n\t\t\t}\n\t\t\tif (i > 0) {\n\t\t\t\tif (block.children[i].ordinal <= block.children[i - 1].ordinal) {\n\t\t\t\t\tconsole.log(\"node sib integrity issue\");\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (!block.children[i].isLeaf()) {\n\t\t\t\treturn nodeOrdinalsHaveIntegrity(block.children[i] as IMergeBlock);\n\t\t\t}\n\t\t} else {\n\t\t\tconsole.log(`node child ordinal not set ${i}`);\n\t\t\treturn false;\n\t\t}\n\t}\n\treturn true;\n}\n\n/**\n * Returns an object that tallies each delta and maintenance operation observed\n * for the given 'mergeTree'.\n */\nexport function countOperations(mergeTree: MergeTree) {\n\tconst counts = {};\n\n\tassert.strictEqual(mergeTree.mergeTreeDeltaCallback, undefined);\n\tassert.strictEqual(mergeTree.mergeTreeMaintenanceCallback, undefined);\n\n\tconst fn = (deltaArgs) => {\n\t\tconst previous = counts[deltaArgs.operation] as undefined | number;\n\t\tcounts[deltaArgs.operation] = previous === undefined ? 1 : previous + 1;\n\t};\n\n\tmergeTree.mergeTreeDeltaCallback = (opArgs, deltaArgs) => {\n\t\tfn(deltaArgs);\n\t};\n\tmergeTree.mergeTreeMaintenanceCallback = fn;\n\n\treturn counts;\n}\n\nfunction getPartialLengths(\n\tclientId: number,\n\tseq: number,\n\tmergeTree: MergeTree,\n\tlocalSeq?: number,\n\tmergeBlock: IMergeBlock = mergeTree.root,\n) {\n\tconst partialLen = mergeBlock.partialLengths?.getPartialLength(seq, clientId, localSeq);\n\n\tlet actualLen = 0;\n\n\tconst isInserted = (segment: ISegment) =>\n\t\tsegment.seq === undefined ||\n\t\t(segment.seq !== UnassignedSequenceNumber && segment.seq <= seq) ||\n\t\t(localSeq !== undefined &&\n\t\t\tsegment.seq === UnassignedSequenceNumber &&\n\t\t\tsegment.localSeq !== undefined &&\n\t\t\tsegment.localSeq <= localSeq);\n\n\tconst isRemoved = (segment: ISegment) =>\n\t\tsegment.removedSeq !== undefined &&\n\t\t((localSeq !== undefined &&\n\t\t\tsegment.removedSeq === UnassignedSequenceNumber &&\n\t\t\tsegment.localRemovedSeq !== undefined &&\n\t\t\tsegment.localRemovedSeq <= localSeq) ||\n\t\t\t(segment.removedSeq !== UnassignedSequenceNumber && segment.removedSeq <= seq));\n\n\tconst isMoved = (segment: ISegment) =>\n\t\tsegment.movedSeq !== undefined &&\n\t\t((localSeq !== undefined &&\n\t\t\tsegment.movedSeq === UnassignedSequenceNumber &&\n\t\t\tsegment.localMovedSeq !== undefined &&\n\t\t\tsegment.localMovedSeq <= localSeq) ||\n\t\t\t(segment.movedSeq !== UnassignedSequenceNumber && segment.movedSeq <= seq));\n\n\twalkAllChildSegments(mergeBlock, (segment) => {\n\t\tif (isInserted(segment) && !isRemoved(segment) && !isMoved(segment)) {\n\t\t\tactualLen += segment.cachedLength;\n\t\t}\n\t\treturn true;\n\t});\n\n\treturn {\n\t\tpartialLen,\n\t\tactualLen,\n\t};\n}\n\nexport function validatePartialLengths(\n\tclientId: number,\n\tmergeTree: MergeTree,\n\texpectedValues?: { seq: number; len: number; localSeq?: number }[],\n\tlocalSeq?: number,\n\tmergeBlock: IMergeBlock = mergeTree.root,\n): void {\n\tmergeTree.computeLocalPartials(0);\n\tfor (let i = mergeTree.collabWindow.minSeq + 1; i <= mergeTree.collabWindow.currentSeq; i++) {\n\t\tconst { partialLen, actualLen } = getPartialLengths(\n\t\t\tclientId,\n\t\t\ti,\n\t\t\tmergeTree,\n\t\t\tlocalSeq,\n\t\t\tmergeBlock,\n\t\t);\n\n\t\tif (partialLen && partialLen < 0) {\n\t\t\tassert.fail(\"Negative partial length returned\");\n\t\t}\n\t\tassert.equal(partialLen, actualLen);\n\t}\n\n\tif (!expectedValues) {\n\t\treturn;\n\t}\n\n\tfor (const { seq, len, localSeq: expectedLocalSeq } of expectedValues) {\n\t\tconst { partialLen, actualLen } = getPartialLengths(\n\t\t\tclientId,\n\t\t\tseq,\n\t\t\tmergeTree,\n\t\t\texpectedLocalSeq ?? localSeq,\n\t\t\tmergeBlock,\n\t\t);\n\n\t\tassert.equal(partialLen, len);\n\t\tassert.equal(actualLen, len);\n\t}\n}\n\nexport function validateRefCount(collection?: LocalReferenceCollection) {\n\tif (!collection) {\n\t\treturn;\n\t}\n\n\tconst expectedLength = Array.from(collection).length;\n\n\t// eslint-disable-next-line @typescript-eslint/dot-notation\n\tassert.equal(collection[\"refCount\"], expectedLength);\n}\n\n/**\n * Enable stricter partial length assertions inside tests\n *\n * Note that these assertions can be expensive, and so should not be enabled in\n * production code or tests that run through thousands of ops (e.g. the SharedString\n * fuzz tests).\n */\nexport function useStrictPartialLengthChecks() {\n\tbeforeEach(() => {\n\t\tPartialSequenceLengths.options.verifier = verifyPartialLengths;\n\t\tPartialSequenceLengths.options.verifyExpected = verifyExpectedPartialLengths;\n\t});\n\n\tafterEach(() => {\n\t\tPartialSequenceLengths.options.verifier = undefined;\n\t\tPartialSequenceLengths.options.verifyExpected = undefined;\n\t});\n}\n"]}

package/lib/test/text.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISegment } from "../mergeTreeNodes.js";
+import { MergeTree } from "../mergeTree.js";
+export declare function loadSegments(content: string, segLimit: number, markers?: boolean, withProps?: boolean): ISegment[];
+export declare function loadText(content: string, mergeTree: MergeTree, segLimit: number, markers?: boolean): MergeTree;
+//# sourceMappingURL=text.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/test/text.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAU,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAK5C,wBAAgB,YAAY,CAC3B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,OAAe,EACxB,SAAS,GAAE,OAAc,cA6DzB;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,UAAQ,aAIhG"}

package/lib/test/text.js

@@ -0,0 +1,71 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Marker } from "../mergeTreeNodes.js";
+import { ReferenceType } from "../ops.js";
+import { reservedTileLabelsKey } from "../referencePositions.js";
+import { TextSegment } from "../textSegment.js";
+export function loadSegments(content, segLimit, markers = false, withProps = true) {
+    const BOMFreeContent = content.replace(/^\uFEFF/, "");
+    const paragraphs = BOMFreeContent.split(/\r?\n/);
+    for (let i = 0, len = paragraphs.length; i < len; i++) {
+        paragraphs[i] = paragraphs[i]
+            .replace(/\r?\n/g, " ")
+            .replace(/\u201c|\u201d/g, '"')
+            .replace(/\u2019/g, "'");
+        if (!markers && i !== paragraphs.length - 1) {
+            paragraphs[i] += "\n";
+        }
+    }
+    const segments = [];
+    for (const paragraph of paragraphs) {
+        let pgMarker;
+        if (markers) {
+            pgMarker = Marker.make(ReferenceType.Tile, { [reservedTileLabelsKey]: ["pg"] });
+        }
+        if (withProps) {
+            if (paragraph.includes("Chapter") || paragraph.includes("PRIDE AND PREJ")) {
+                if (pgMarker) {
+                    pgMarker.addProperties({ header: 2 });
+                    segments.push(new TextSegment(paragraph));
+                }
+                else {
+                    segments.push(TextSegment.make(paragraph, { fontSize: "140%", lineHeight: "150%" }));
+                }
+            }
+            else {
+                const emphStrings = paragraph.split("_");
+                for (let i = 0, len = emphStrings.length; i < len; i++) {
+                    // eslint-disable-next-line no-bitwise
+                    if (i & 1) {
+                        if (emphStrings[i].length > 0) {
+                            segments.push(TextSegment.make(emphStrings[i], { fontStyle: "italic" }));
+                        }
+                    }
+                    else {
+                        if (emphStrings[i].length > 0) {
+                            segments.push(new TextSegment(emphStrings[i]));
+                        }
+                    }
+                }
+            }
+        }
+        else {
+            segments.push(new TextSegment(paragraph));
+        }
+        if (pgMarker) {
+            segments.push(pgMarker);
+        }
+    }
+    if (segLimit > 0) {
+        segments.length = segLimit;
+    }
+    return segments;
+}
+export function loadText(content, mergeTree, segLimit, markers = false) {
+    const segments = loadSegments(content, segLimit, markers);
+    mergeTree.reloadFromSegments(segments);
+    return mergeTree;
+}
+//# sourceMappingURL=text.js.map

package/lib/test/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/test/text.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAY,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,UAAU,YAAY,CAC3B,OAAe,EACf,QAAgB,EAChB,UAAmB,KAAK,EACxB,YAAqB,IAAI;IAEzB,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;QACtD,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;aAC3B,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;aACtB,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;aAC9B,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC5C,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;SACtB;KACD;IAED,MAAM,QAAQ,GAAG,EAAgB,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QACnC,IAAI,QAA4B,CAAC;QACjC,IAAI,OAAO,EAAE;YACZ,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAChF;QACD,IAAI,SAAS,EAAE;YACd,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE;gBAC1E,IAAI,QAAQ,EAAE;oBACb,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;oBACtC,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC1C;qBAAM;oBACN,QAAQ,CAAC,IAAI,CACZ,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CACrE,CAAC;iBACF;aACD;iBAAM;gBACN,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;oBACvD,sCAAsC;oBACtC,IAAI,CAAC,GAAG,CAAC,EAAE;wBACV,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BAC9B,QAAQ,CAAC,IAAI,CACZ,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CACzD,CAAC;yBACF;qBACD;yBAAM;wBACN,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;4BAC9B,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;yBAC/C;qBACD;iBACD;aACD;SACD;aAAM;YACN,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;SAC1C;QACD,IAAI,QAAQ,EAAE;YACb,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACxB;KACD;IAED,IAAI,QAAQ,GAAG,CAAC,EAAE;QACjB,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC;KAC3B;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,OAAe,EAAE,SAAoB,EAAE,QAAgB,EAAE,OAAO,GAAG,KAAK;IAChG,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC1D,SAAS,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO,SAAS,CAAC;AAClB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISegment, Marker } from \"../mergeTreeNodes.js\";\nimport { MergeTree } from \"../mergeTree.js\";\nimport { ReferenceType } from \"../ops.js\";\nimport { reservedTileLabelsKey } from \"../referencePositions.js\";\nimport { TextSegment } from \"../textSegment.js\";\n\nexport function loadSegments(\n\tcontent: string,\n\tsegLimit: number,\n\tmarkers: boolean = false,\n\twithProps: boolean = true,\n) {\n\tconst BOMFreeContent = content.replace(/^\\uFEFF/, \"\");\n\n\tconst paragraphs = BOMFreeContent.split(/\\r?\\n/);\n\tfor (let i = 0, len = paragraphs.length; i < len; i++) {\n\t\tparagraphs[i] = paragraphs[i]\n\t\t\t.replace(/\\r?\\n/g, \" \")\n\t\t\t.replace(/\\u201c|\\u201d/g, '\"')\n\t\t\t.replace(/\\u2019/g, \"'\");\n\t\tif (!markers && i !== paragraphs.length - 1) {\n\t\t\tparagraphs[i] += \"\\n\";\n\t\t}\n\t}\n\n\tconst segments = [] as ISegment[];\n\tfor (const paragraph of paragraphs) {\n\t\tlet pgMarker: Marker | undefined;\n\t\tif (markers) {\n\t\t\tpgMarker = Marker.make(ReferenceType.Tile, { [reservedTileLabelsKey]: [\"pg\"] });\n\t\t}\n\t\tif (withProps) {\n\t\t\tif (paragraph.includes(\"Chapter\") || paragraph.includes(\"PRIDE AND PREJ\")) {\n\t\t\t\tif (pgMarker) {\n\t\t\t\t\tpgMarker.addProperties({ header: 2 });\n\t\t\t\t\tsegments.push(new TextSegment(paragraph));\n\t\t\t\t} else {\n\t\t\t\t\tsegments.push(\n\t\t\t\t\t\tTextSegment.make(paragraph, { fontSize: \"140%\", lineHeight: \"150%\" }),\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tconst emphStrings = paragraph.split(\"_\");\n\t\t\t\tfor (let i = 0, len = emphStrings.length; i < len; i++) {\n\t\t\t\t\t// eslint-disable-next-line no-bitwise\n\t\t\t\t\tif (i & 1) {\n\t\t\t\t\t\tif (emphStrings[i].length > 0) {\n\t\t\t\t\t\t\tsegments.push(\n\t\t\t\t\t\t\t\tTextSegment.make(emphStrings[i], { fontStyle: \"italic\" }),\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t}\n\t\t\t\t\t} else {\n\t\t\t\t\t\tif (emphStrings[i].length > 0) {\n\t\t\t\t\t\t\tsegments.push(new TextSegment(emphStrings[i]));\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tsegments.push(new TextSegment(paragraph));\n\t\t}\n\t\tif (pgMarker) {\n\t\t\tsegments.push(pgMarker);\n\t\t}\n\t}\n\n\tif (segLimit > 0) {\n\t\tsegments.length = segLimit;\n\t}\n\n\treturn segments;\n}\n\nexport function loadText(content: string, mergeTree: MergeTree, segLimit: number, markers = false) {\n\tconst segments = loadSegments(content, segLimit, markers);\n\tmergeTree.reloadFromSegments(segments);\n\treturn mergeTree;\n}\n"]}

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

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

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

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

package/lib/test/tracking.spec.js

@@ -0,0 +1,118 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { TrackingGroup } from "../mergeTreeTracking.js";
+import { ReferenceType } from "../ops.js";
+import { TestClient } from "./testClient.js";
+describe("MergeTree.tracking", () => {
+    let testClient;
+    beforeEach(() => {
+        testClient = new TestClient();
+        testClient.startOrUpdateCollaboration("me");
+    });
+    it("Inserted segment should have empty tracking groups", () => {
+        testClient.insertTextLocal(0, "abc");
+        assert.equal(testClient.getLength(), 3);
+        const segmentInfo = testClient.getContainingSegment(0);
+        assert(segmentInfo?.segment?.trackingCollection.empty);
+    });
+    it("Insert single segment with single tracking group", () => {
+        const trackingGroup = new TrackingGroup();
+        testClient.on("delta", (opArgs, deltaArgs) => {
+            deltaArgs.deltaSegments.forEach((sg) => sg.segment.trackingCollection.link(trackingGroup));
+        });
+        testClient.insertTextLocal(0, "abc");
+        assert.equal(trackingGroup.size, 1);
+        const segmentInfo = testClient.getContainingSegment(0);
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 1);
+        assert(trackingGroup.unlink(segmentInfo.segment), "unlink segment should be true");
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 0);
+    });
+    it("Splitting segment should split tracking group", () => {
+        const trackingGroup = new TrackingGroup();
+        testClient.on("delta", (opArgs, deltaArgs) => {
+            deltaArgs.deltaSegments.forEach((sg) => sg.segment.trackingCollection.link(trackingGroup));
+        });
+        const ops = [testClient.insertTextLocal(0, "abc")];
+        testClient.removeAllListeners("delta");
+        assert.equal(trackingGroup.size, 1);
+        ops.push(testClient.insertTextLocal(1, "z"));
+        assert.equal(testClient.getLength(), 4);
+        assert.equal(trackingGroup.size, 2);
+        const segmentInfo = testClient.getContainingSegment(0);
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 1);
+    });
+    it("Zamboni should merge matching tracking groups", () => {
+        const trackingGroup = new TrackingGroup();
+        testClient.on("delta", (opArgs, deltaArgs) => {
+            deltaArgs.deltaSegments.forEach((sg) => sg.segment.trackingCollection.link(trackingGroup));
+        });
+        const ops = [testClient.insertTextLocal(0, "abc")];
+        assert.equal(trackingGroup.size, 1);
+        ops.push(testClient.insertTextLocal(1, "z"));
+        assert.equal(testClient.getLength(), 4);
+        assert.equal(trackingGroup.size, 3);
+        let segmentInfo = testClient.getContainingSegment(0);
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 1);
+        let seq = 1;
+        ops.forEach((op) => testClient.applyMsg(testClient.makeOpMessage(op, ++seq)));
+        assert.equal(trackingGroup.size, 3);
+        segmentInfo = testClient.getContainingSegment(0);
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 1);
+        testClient.updateMinSeq(seq);
+        assert.equal(trackingGroup.size, 1);
+        segmentInfo = testClient.getContainingSegment(0);
+        assert.equal(segmentInfo?.segment?.trackingCollection.trackingGroups.size, 1);
+    });
+    it("Newly created local reference should have empty tracking group", () => {
+        testClient.insertTextLocal(0, "abc");
+        assert.equal(testClient.getLength(), 3);
+        const segmentInfo = testClient.getContainingSegment(0);
+        assert(segmentInfo.segment);
+        const ref = testClient.createLocalReferencePosition(segmentInfo.segment, 0, ReferenceType.SlideOnRemove, undefined);
+        assert(ref.trackingCollection.empty);
+    });
+    it("Local reference can be added an removed from tracking group", () => {
+        testClient.insertTextLocal(0, "abc");
+        assert.equal(testClient.getLength(), 3);
+        const segmentInfo = testClient.getContainingSegment(0);
+        assert(segmentInfo.segment);
+        const ref = testClient.createLocalReferencePosition(segmentInfo.segment, 0, ReferenceType.SlideOnRemove, undefined);
+        const trackingGroup = new TrackingGroup();
+        ref.trackingCollection.link(trackingGroup);
+        assert.equal(trackingGroup.size, 1);
+        assert.equal(trackingGroup.has(ref), true);
+        assert.equal(trackingGroup.tracked.includes(ref), true);
+        assert.equal(ref.trackingCollection.trackingGroups.size, 1);
+        ref.trackingCollection.unlink(trackingGroup);
+        assert.equal(trackingGroup.size, 0);
+        assert.equal(trackingGroup.has(ref), false);
+        assert.equal(trackingGroup.tracked.includes(ref), false);
+        assert.equal(ref.trackingCollection.trackingGroups.size, 0);
+    });
+    it("unlink segment from tracking group", () => {
+        const trackingGroup = new TrackingGroup();
+        testClient.insertTextLocal(0, "abc");
+        const { segment } = testClient.getContainingSegment(0);
+        segment?.trackingCollection.link(trackingGroup);
+        assert.equal(segment?.trackingCollection.trackingGroups.size, 1);
+        assert(trackingGroup.unlink(segment), "unlink segment should be true");
+        assert.equal(segment?.trackingCollection.trackingGroups.size, 0);
+        assert.equal(trackingGroup.unlink(segment), false, "repeat unlink segment should be false");
+        assert.equal(segment.trackingCollection.unlink(trackingGroup), false, "repeat unlink trackingGroup should be false");
+    });
+    it("unlink tracking group from collection", () => {
+        const trackingGroup = new TrackingGroup();
+        testClient.insertTextLocal(0, "abc");
+        const { segment } = testClient.getContainingSegment(0);
+        segment?.trackingCollection.link(trackingGroup);
+        assert.equal(segment?.trackingCollection.trackingGroups.size, 1);
+        assert(segment.trackingCollection.unlink(trackingGroup), "unlink trackingGroup should be true");
+        assert.equal(segment?.trackingCollection.trackingGroups.size, 0);
+        assert.equal(trackingGroup.unlink(segment), false, "repeat unlink segment should be false");
+        assert.equal(segment.trackingCollection.unlink(trackingGroup), false, "repeat unlink trackingGroup should be false");
+    });
+});
+//# sourceMappingURL=tracking.spec.js.map