@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/lib/test/utilities/SummarySizeTests.js

@@ -0,0 +1,158 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IsoBuffer } from '@fluidframework/common-utils';
+import { expect } from 'chai';
+import { Change, StablePlace, StableRange } from '../../ChangeTypes';
+import { revert } from '../../HistoryEditFactory';
+import { IdCompressor } from '../../id-compressor';
+import { setUpTestTree, } from './TestUtilities';
+/**
+ * Summary size tests where `edits` are applied and checked against the `expectedSize`.
+ */
+const summarySizeTests = [
+    {
+        edits: (testTree) => [
+            Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),
+        ],
+        expectedSize: 1075,
+        description: 'when inserting a node',
+    },
+    {
+        edits: (testTree) => {
+            const edits = [];
+            for (let i = 0; i < 50; i++) {
+                edits.push(Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)));
+            }
+            return edits;
+        },
+        expectedSize: 10680,
+        description: 'with 50 inserts',
+    },
+    {
+        edits: (testTree) => {
+            const node = testTree.buildLeaf(testTree.generateNodeId());
+            return [
+                Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),
+                [Change.setPayload(node.identifier, 10)],
+            ];
+        },
+        expectedSize: 1170,
+        description: 'when inserting and setting a node',
+    },
+    {
+        edits: (testTree) => {
+            const node = testTree.buildLeaf(testTree.generateNodeId());
+            return [
+                Change.insertTree(node, StablePlace.atEndOf(testTree.right.traitLocation)),
+                [Change.delete(StableRange.only(node))],
+            ];
+        },
+        expectedSize: 1223,
+        description: 'when inserting and deleting a node',
+    },
+    {
+        edits: (testTree) => [
+            Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),
+        ],
+        expectedSize: 1223,
+        description: 'when inserting and reverting a node',
+        revertEdits: true,
+    },
+    {
+        edits: (testTree) => [
+            Change.insertTree(makeLargeTestTree(testTree), StablePlace.atStartOf(testTree.right.traitLocation)),
+        ],
+        expectedSize: 76979,
+        description: 'when inserting a large tree',
+    },
+    {
+        edits: (testTree) => {
+            const largeTree = makeLargeTestTree(testTree);
+            return [
+                Change.insertTree(largeTree, StablePlace.atStartOf(testTree.right.traitLocation)),
+                Change.move(StableRange.only(largeTree), StablePlace.atEndOf(testTree.left.traitLocation)),
+            ];
+        },
+        expectedSize: 77243,
+        description: 'when inserting and moving a large tree',
+    },
+];
+/**
+ * Runs a test suite for summaries on `SharedTree` that verifies their sizes do not exceed the defined limits.
+ * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.
+ */
+export function runSummarySizeTests(title, setUpLocalServerTestSharedTree) {
+    describe(title, () => {
+        const setupEditId = '9406d301-7449-48a5-b2ea-9be637b0c6e4';
+        let tree;
+        let testTree;
+        let testObjectProvider;
+        // Resets the tree before each test
+        beforeEach(async () => {
+            const testingComponents = await setUpLocalServerTestSharedTree({
+                setupEditId,
+            });
+            tree = testingComponents.tree;
+            testTree = setUpTestTree(tree);
+            testObjectProvider = testingComponents.testObjectProvider;
+        });
+        async function checkSummarySize(changes, expectedSummarySize, revertEdits = false) {
+            const edits = changes.map((e) => tree.applyEdit(...e));
+            if (revertEdits) {
+                for (let i = changes.length - 1; i >= 0; i--) {
+                    const editIndex = tree.edits.getIndexOfId(edits[i].id);
+                    const edit = tree.edits.getEditInSessionAtIndex(editIndex);
+                    const reverted = revert(edit.changes, tree.logViewer.getRevisionViewInSession(editIndex));
+                    if (reverted !== undefined) {
+                        tree.applyEditInternal(reverted);
+                    }
+                }
+            }
+            // Wait for the ops to to be submitted and processed across the containers.
+            await testObjectProvider.ensureSynchronized();
+            const summary = tree.saveSerializedSummary();
+            const summarySize = IsoBuffer.from(summary).byteLength;
+            // TODO: make lte when 0.1.1 is settled
+            expect(summarySize).to.equal(expectedSummarySize);
+        }
+        for (const { edits, expectedSize, description, revertEdits } of summarySizeTests) {
+            it(`does not exceed ${expectedSize} ${description}`, async () => {
+                await checkSummarySize(edits(testTree), expectedSize, revertEdits);
+            });
+        }
+    });
+}
+function makeLargeTestTree(testTree, nodesPerTrait = 10, traitsPerLevel = 2, levels = 2) {
+    const specialSession = '9f858704-89f6-4923-abf3-14fc986e717f';
+    // ensure uuids for traits and definitions are stable
+    const compressor = new IdCompressor(specialSession, 0);
+    const uuidv4 = () => compressor.decompress(compressor.generateCompressedId());
+    const definition = uuidv4();
+    const traitLabels = [];
+    for (let i = 0; i < traitsPerLevel; i++) {
+        traitLabels.push(uuidv4());
+    }
+    return {
+        definition,
+        identifier: testTree.generateNodeId(),
+        traits: generateTraits(testTree, definition, traitLabels, nodesPerTrait, levels),
+    };
+}
+function generateTraits(testTree, definition, traitLabels, nodesPerTrait, totalLevels, level = 0) {
+    const traits = {};
+    traitLabels.forEach((label) => {
+        traits[label] = Array.from(Array(nodesPerTrait).keys()).map(() => {
+            return {
+                definition,
+                identifier: testTree.generateNodeId(),
+                traits: level < totalLevels
+                    ? generateTraits(testTree, definition, traitLabels, nodesPerTrait, totalLevels, level + 1)
+                    : {},
+            };
+        });
+    });
+    return traits;
+}
+//# sourceMappingURL=SummarySizeTests.js.map

package/lib/test/utilities/SummarySizeTests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SummarySizeTests.js","sourceRoot":"","sources":["../../../src/test/utilities/SummarySizeTests.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAGN,aAAa,GACb,MAAM,iBAAiB,CAAC;AAgBzB;;GAEG;AACH,MAAM,gBAAgB,GAA2B;IAChD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;SAC1F;QACD,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,uBAAuB;KACpC;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,KAAK,GAAe,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;gBAC5B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aACvG;YACD,OAAO,KAAK,CAAC;QACd,CAAC;QACD,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,iBAAiB;KAC9B;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC;YAC3D,OAAO;gBACN,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAC1F,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;aACxC,CAAC;QACH,CAAC;QACD,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,mCAAmC;KAChD;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC;YAC3D,OAAO;gBACN,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBAC1E,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;aACvC,CAAC;QACH,CAAC;QACD,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,oCAAoC;KACjD;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;SAC1F;QACD,YAAY,EAAE,IAAI;QAClB,WAAW,EAAE,qCAAqC;QAClD,WAAW,EAAE,IAAI;KACjB;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;SACnG;QACD,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,6BAA6B;KAC1C;IACD;QACC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE;YACnB,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAC9C,OAAO;gBACN,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBACjF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;aAC1F,CAAC;QACH,CAAC;QACD,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,wCAAwC;KACrD;CACD,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAClC,KAAa,EACb,8BAEoD;IAEpD,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;QACpB,MAAM,WAAW,GAAG,sCAAgD,CAAC;QAErE,IAAI,IAAgB,CAAC;QACrB,IAAI,QAAkB,CAAC;QACvB,IAAI,kBAAsC,CAAC;QAE3C,mCAAmC;QACnC,UAAU,CAAC,KAAK,IAAI,EAAE;YACrB,MAAM,iBAAiB,GAAG,MAAM,8BAA8B,CAAC;gBAC9D,WAAW;aACX,CAAC,CAAC;YACH,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;YAC9B,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YAC/B,kBAAkB,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,KAAK,UAAU,gBAAgB,CAC9B,OAAmB,EACnB,mBAA2B,EAC3B,WAAW,GAAG,KAAK;YAEnB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAEvD,IAAI,WAAW,EAAE;gBAChB,KAAK,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,SAAS,CAAyB,CAAC;oBACnF,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC1F,IAAI,QAAQ,KAAK,SAAS,EAAE;wBAC3B,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;qBACjC;iBACD;aACD;YAED,2EAA2E;YAC3E,MAAM,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;YAE9C,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC7C,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC;YAEvD,uCAAuC;YACvC,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACnD,CAAC;QAED,KAAK,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,IAAI,gBAAgB,EAAE;YACjF,EAAE,CAAC,mBAAmB,YAAY,IAAI,WAAW,EAAE,EAAE,KAAK,IAAI,EAAE;gBAC/D,MAAM,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;SACH;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAkB,EAAE,aAAa,GAAG,EAAE,EAAE,cAAc,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC;IAChG,MAAM,cAAc,GAAG,sCAAmD,CAAC;IAC3E,qDAAqD;IACrD,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,GAAW,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACtF,MAAM,UAAU,GAAG,MAAM,EAAgB,CAAC;IAE1C,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;QACxC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAgB,CAAC,CAAC;KACzC;IAED,OAAO;QACN,UAAU;QACV,UAAU,EAAE,QAAQ,CAAC,cAAc,EAAE;QACrC,MAAM,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,CAAC;KAChF,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACtB,QAAkB,EAClB,UAAsB,EACtB,WAAyB,EACzB,aAAqB,EACrB,WAAmB,EACnB,KAAK,GAAG,CAAC;IAET,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YAChE,OAAO;gBACN,UAAU;gBACV,UAAU,EAAE,QAAQ,CAAC,cAAc,EAAE;gBACrC,MAAM,EACL,KAAK,GAAG,WAAW;oBAClB,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,GAAG,CAAC,CAAC;oBAC1F,CAAC,CAAC,EAAE;aACN,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AACf,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IsoBuffer } from '@fluidframework/common-utils';\nimport { TestObjectProvider } from '@fluidframework/test-utils';\nimport { expect } from 'chai';\nimport { Definition, EditId, SessionId, TraitLabel } from '../../Identifiers';\nimport { Change, StablePlace, StableRange } from '../../ChangeTypes';\nimport { SharedTree } from '../../SharedTree';\nimport { ChangeInternal, ChangeNode, Edit, TraitMap } from '../../persisted-types';\nimport { revert } from '../../HistoryEditFactory';\nimport { IdCompressor } from '../../id-compressor';\nimport { TestTree } from './TestNode';\nimport {\n\tLocalServerSharedTreeTestingComponents,\n\tLocalServerSharedTreeTestingOptions,\n\tsetUpTestTree,\n} from './TestUtilities';\n\n/**\n * An entry into the summarySizeTests list.\n */\ninterface SummarySizeTestEntry {\n\t/** Helper to obtain the list of edits to apply to the SharedTree. */\n\tedits: (testTree: TestTree) => Change[][];\n\t/** Expected size of the summary of the SharedTree after applying the `edits`. */\n\texpectedSize: number;\n\t/** Description for the test and the edits applied. */\n\tdescription: string;\n\t/** Flag to determine whether to revert the applied edits or not. */\n\trevertEdits?: boolean;\n}\n\n/**\n * Summary size tests where `edits` are applied and checked against the `expectedSize`.\n */\nconst summarySizeTests: SummarySizeTestEntry[] = [\n\t{\n\t\tedits: (testTree) => [\n\t\t\tChange.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),\n\t\t],\n\t\texpectedSize: 1075,\n\t\tdescription: 'when inserting a node',\n\t},\n\t{\n\t\tedits: (testTree) => {\n\t\t\tconst edits: Change[][] = [];\n\t\t\tfor (let i = 0; i < 50; i++) {\n\t\t\t\tedits.push(Change.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)));\n\t\t\t}\n\t\t\treturn edits;\n\t\t},\n\t\texpectedSize: 10680,\n\t\tdescription: 'with 50 inserts',\n\t},\n\t{\n\t\tedits: (testTree) => {\n\t\t\tconst node = testTree.buildLeaf(testTree.generateNodeId());\n\t\t\treturn [\n\t\t\t\tChange.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),\n\t\t\t\t[Change.setPayload(node.identifier, 10)],\n\t\t\t];\n\t\t},\n\t\texpectedSize: 1170,\n\t\tdescription: 'when inserting and setting a node',\n\t},\n\t{\n\t\tedits: (testTree) => {\n\t\t\tconst node = testTree.buildLeaf(testTree.generateNodeId());\n\t\t\treturn [\n\t\t\t\tChange.insertTree(node, StablePlace.atEndOf(testTree.right.traitLocation)),\n\t\t\t\t[Change.delete(StableRange.only(node))],\n\t\t\t];\n\t\t},\n\t\texpectedSize: 1223,\n\t\tdescription: 'when inserting and deleting a node',\n\t},\n\t{\n\t\tedits: (testTree) => [\n\t\t\tChange.insertTree(testTree.buildLeaf(), StablePlace.atEndOf(testTree.right.traitLocation)),\n\t\t],\n\t\texpectedSize: 1223,\n\t\tdescription: 'when inserting and reverting a node',\n\t\trevertEdits: true,\n\t},\n\t{\n\t\tedits: (testTree) => [\n\t\t\tChange.insertTree(makeLargeTestTree(testTree), StablePlace.atStartOf(testTree.right.traitLocation)),\n\t\t],\n\t\texpectedSize: 76979,\n\t\tdescription: 'when inserting a large tree',\n\t},\n\t{\n\t\tedits: (testTree) => {\n\t\t\tconst largeTree = makeLargeTestTree(testTree);\n\t\t\treturn [\n\t\t\t\tChange.insertTree(largeTree, StablePlace.atStartOf(testTree.right.traitLocation)),\n\t\t\t\tChange.move(StableRange.only(largeTree), StablePlace.atEndOf(testTree.left.traitLocation)),\n\t\t\t];\n\t\t},\n\t\texpectedSize: 77243,\n\t\tdescription: 'when inserting and moving a large tree',\n\t},\n];\n\n/**\n * Runs a test suite for summaries on `SharedTree` that verifies their sizes do not exceed the defined limits.\n * This suite can be used to test other implementations that aim to fulfill `SharedTree`'s contract.\n */\nexport function runSummarySizeTests(\n\ttitle: string,\n\tsetUpLocalServerTestSharedTree: (\n\t\toptions: LocalServerSharedTreeTestingOptions\n\t) => Promise<LocalServerSharedTreeTestingComponents>\n) {\n\tdescribe(title, () => {\n\t\tconst setupEditId = '9406d301-7449-48a5-b2ea-9be637b0c6e4' as EditId;\n\n\t\tlet tree: SharedTree;\n\t\tlet testTree: TestTree;\n\t\tlet testObjectProvider: TestObjectProvider;\n\n\t\t// Resets the tree before each test\n\t\tbeforeEach(async () => {\n\t\t\tconst testingComponents = await setUpLocalServerTestSharedTree({\n\t\t\t\tsetupEditId,\n\t\t\t});\n\t\t\ttree = testingComponents.tree;\n\t\t\ttestTree = setUpTestTree(tree);\n\t\t\ttestObjectProvider = testingComponents.testObjectProvider;\n\t\t});\n\n\t\tasync function checkSummarySize(\n\t\t\tchanges: Change[][],\n\t\t\texpectedSummarySize: number,\n\t\t\trevertEdits = false\n\t\t): Promise<void> {\n\t\t\tconst edits = changes.map((e) => tree.applyEdit(...e));\n\n\t\t\tif (revertEdits) {\n\t\t\t\tfor (let i = changes.length - 1; i >= 0; i--) {\n\t\t\t\t\tconst editIndex = tree.edits.getIndexOfId(edits[i].id);\n\t\t\t\t\tconst edit = tree.edits.getEditInSessionAtIndex(editIndex) as Edit<ChangeInternal>;\n\t\t\t\t\tconst reverted = revert(edit.changes, tree.logViewer.getRevisionViewInSession(editIndex));\n\t\t\t\t\tif (reverted !== undefined) {\n\t\t\t\t\t\ttree.applyEditInternal(reverted);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Wait for the ops to to be submitted and processed across the containers.\n\t\t\tawait testObjectProvider.ensureSynchronized();\n\n\t\t\tconst summary = tree.saveSerializedSummary();\n\t\t\tconst summarySize = IsoBuffer.from(summary).byteLength;\n\n\t\t\t// TODO: make lte when 0.1.1 is settled\n\t\t\texpect(summarySize).to.equal(expectedSummarySize);\n\t\t}\n\n\t\tfor (const { edits, expectedSize, description, revertEdits } of summarySizeTests) {\n\t\t\tit(`does not exceed ${expectedSize} ${description}`, async () => {\n\t\t\t\tawait checkSummarySize(edits(testTree), expectedSize, revertEdits);\n\t\t\t});\n\t\t}\n\t});\n}\n\nfunction makeLargeTestTree(testTree: TestTree, nodesPerTrait = 10, traitsPerLevel = 2, levels = 2): ChangeNode {\n\tconst specialSession = '9f858704-89f6-4923-abf3-14fc986e717f' as SessionId;\n\t// ensure uuids for traits and definitions are stable\n\tconst compressor = new IdCompressor(specialSession, 0);\n\tconst uuidv4 = (): string => compressor.decompress(compressor.generateCompressedId());\n\tconst definition = uuidv4() as Definition;\n\n\tconst traitLabels: TraitLabel[] = [];\n\tfor (let i = 0; i < traitsPerLevel; i++) {\n\t\ttraitLabels.push(uuidv4() as TraitLabel);\n\t}\n\n\treturn {\n\t\tdefinition,\n\t\tidentifier: testTree.generateNodeId(),\n\t\ttraits: generateTraits(testTree, definition, traitLabels, nodesPerTrait, levels),\n\t};\n}\n\nfunction generateTraits(\n\ttestTree: TestTree,\n\tdefinition: Definition,\n\ttraitLabels: TraitLabel[],\n\tnodesPerTrait: number,\n\ttotalLevels: number,\n\tlevel = 0\n): TraitMap<ChangeNode> {\n\tconst traits = {};\n\n\ttraitLabels.forEach((label) => {\n\t\ttraits[label] = Array.from(Array(nodesPerTrait).keys()).map(() => {\n\t\t\treturn {\n\t\t\t\tdefinition,\n\t\t\t\tidentifier: testTree.generateNodeId(),\n\t\t\t\ttraits:\n\t\t\t\t\tlevel < totalLevels\n\t\t\t\t\t\t? generateTraits(testTree, definition, traitLabels, nodesPerTrait, totalLevels, level + 1)\n\t\t\t\t\t\t: {},\n\t\t\t};\n\t\t});\n\t});\n\n\treturn traits;\n}\n"]}

package/lib/test/utilities/TestCommon.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Check if the given value is defined using mocha's `expect`. Return the defined value;
+ */
+export declare function expectDefined<T>(value: T | undefined): T;
+//# sourceMappingURL=TestCommon.d.ts.map

package/lib/test/utilities/TestCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestCommon.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/TestCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,CAAC,CAGxD"}

package/lib/test/utilities/TestCommon.js

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { expect } from 'chai';
+/**
+ * Check if the given value is defined using mocha's `expect`. Return the defined value;
+ */
+export function expectDefined(value) {
+    expect(value).to.be.not.undefined;
+    return value;
+}
+//# sourceMappingURL=TestCommon.js.map

package/lib/test/utilities/TestCommon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestCommon.js","sourceRoot":"","sources":["../../../src/test/utilities/TestCommon.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,UAAU,aAAa,CAAI,KAAoB;IACpD,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;IAClC,OAAO,KAAU,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { expect } from 'chai';\n\n/**\n * Check if the given value is defined using mocha's `expect`. Return the defined value;\n */\nexport function expectDefined<T>(value: T | undefined): T {\n\texpect(value).to.be.not.undefined;\n\treturn value as T;\n}\n"]}

package/lib/test/utilities/TestNode.d.ts

@@ -0,0 +1,140 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { BuildTreeNode } from '../../ChangeTypes';
+import { Definition, NodeId, OpSpaceNodeId, SessionId, StableNodeId, TraitLabel } from '../../Identifiers';
+import { NodeIdContext, NodeIdConverter, NodeIdNormalizer } from '../../NodeIdUtilities';
+import { BuildNodeInternal, ChangeNode, Payload, TraitLocationInternal_0_0_2, TraitMap, TreeNode } from '../../persisted-types';
+import { RevisionView } from '../../RevisionView';
+import { TraitLocation } from '../../TreeView';
+/** A legacy format of a `TestNode` */
+export declare type TestNode_0_0_2 = TreeNode<TestNode_0_0_2, StableNodeId>;
+/**
+ * A node with no children
+ */
+export declare type LeafNode<T> = Omit<T, 'traits'> & {
+    traits: Record<string, never>;
+};
+/**
+ * Test extension of {@link TraitLocation} which can be converted to stable or legacy formats
+ */
+export interface TestTraitLocation extends TraitLocation {
+    stable: TraitLocationInternal_0_0_2;
+    /** Translate this location into the equivalent location in another ID context */
+    translate(idConverter: NodeIdConverter): TestTraitLocation;
+}
+/**
+ * An object containing useful properties for analyzing a node within a test context.
+ */
+export interface TestNode extends TreeNode<TestNode, NodeId> {
+    /** The label of the trait under which this node resides */
+    traitLabel: TraitLabel;
+    /** The trait location at which this node resides */
+    traitLocation: TestTraitLocation;
+    /** A revision view of this node */
+    view: RevisionView;
+    /** A version of this tree with stable IDs */
+    stable: TestNode_0_0_2;
+    /** Translate this node's ID into the equivalent ID in another ID context */
+    translateId(idConverter: NodeIdConverter): NodeId;
+    /** Express this tree as a ChangeNode */
+    toChangeNode(): ChangeNode;
+}
+/**
+ * A small tree of `TestNode`s consisting of a root/parent node, a "left" child and a "right" child. This is a useful tree for initializing
+ * tests as it makes it ergonomic to retrieve various properties of the tree. Note that it only represents the initial state of the tree,
+ * it does not update even if the SharedTree that it was the initial state for is mutated.
+ */
+export interface TestTree extends TestNode, NodeIdContext, NodeIdNormalizer<OpSpaceNodeId> {
+    /** The left child node */
+    left: TestNode;
+    /** The right child node */
+    right: TestNode;
+    /** Create an arbitrary unparented node with the given payload, if specified */
+    buildLeaf(id?: undefined, payload?: Payload): LeafNode<BuildTreeNode>;
+    /** Create an arbitrary unparented node with the given identifier and payload, if specified */
+    buildLeaf(id: NodeId, payload?: Payload): LeafNode<ChangeNode>;
+    /**
+     * Generates a leaf node for use in internal build changes.
+     * If no `id` is explicitly provided, one will be generated.
+     * @param id - Explicit ID to use as the new node's identifier. If not provided, one will be generated.
+     */
+    buildLeafInternal(id?: NodeId, payload?: Payload): LeafNode<TreeNode<BuildNodeInternal, NodeId>>;
+}
+/**
+ * A TestTree for general use within the shared-tree package. The nodes in every `SimpleTestTree` will have unique identifiers - i.e. two
+ * different instances of `SimpleTestTree` are never equivalent.
+ */
+export declare class SimpleTestTree implements TestTree {
+    private readonly nodeIdContext;
+    private readonly nodeIdNormalizer;
+    static readonly definition: Definition;
+    static readonly traitLabel: TraitLabel;
+    static readonly leftTraitLabel: TraitLabel;
+    static readonly rightTraitLabel: TraitLabel;
+    private readonly root;
+    readonly left: TestNode;
+    readonly right: TestNode;
+    readonly expensiveValidation: any;
+    constructor(nodeIdContext: NodeIdContext, nodeIdNormalizer: NodeIdNormalizer<OpSpaceNodeId>, expensiveValidation?: boolean);
+    get definition(): Definition;
+    get identifier(): NodeId;
+    get traits(): TraitMap<TestNode>;
+    get traitLabel(): TraitLabel;
+    get traitLocation(): TestTraitLocation;
+    get view(): RevisionView;
+    get stable(): TestNode_0_0_2;
+    translateId(idConverter: NodeIdConverter): NodeId;
+    toChangeNode(): ChangeNode;
+    buildLeaf(id?: undefined, payload?: Payload): LeafNode<BuildTreeNode>;
+    buildLeaf(id: NodeId, payload?: Payload): LeafNode<ChangeNode>;
+    buildLeafInternal(id?: NodeId, payload?: Payload): LeafNode<TreeNode<BuildNodeInternal, NodeId>>;
+    generateNodeId(override?: string): NodeId;
+    convertToStableNodeId(id: NodeId): StableNodeId;
+    tryConvertToStableNodeId(id: NodeId): StableNodeId | undefined;
+    convertToNodeId(id: StableNodeId): NodeId;
+    tryConvertToNodeId(id: StableNodeId): NodeId | undefined;
+    get localSessionId(): SessionId;
+    normalizeToOpSpace(id: NodeId): OpSpaceNodeId;
+    normalizeToSessionSpace(id: OpSpaceNodeId, sessionId: SessionId): NodeId;
+}
+/** A TestTree which resets before each test */
+export declare class RefreshingTestTree<T extends TestTree> implements TestTree {
+    private _testTree?;
+    constructor(createTestTree: () => T, fn?: (testTree: T) => void);
+    private get testTree();
+    get left(): TestNode;
+    get right(): TestNode;
+    get definition(): Definition;
+    get identifier(): NodeId;
+    get traits(): TraitMap<TestNode>;
+    get traitLabel(): TraitLabel;
+    get traitLocation(): TestTraitLocation;
+    get view(): RevisionView;
+    get stable(): TestNode_0_0_2;
+    translateId(idConverter: NodeIdConverter): NodeId;
+    toChangeNode(): ChangeNode;
+    buildLeaf(id?: undefined, payload?: Payload): LeafNode<BuildTreeNode>;
+    buildLeaf(id: NodeId, payload?: Payload): LeafNode<ChangeNode>;
+    buildLeafInternal(id?: NodeId, payload?: Payload): LeafNode<TreeNode<BuildNodeInternal, NodeId>>;
+    generateNodeId(override?: string): NodeId;
+    convertToStableNodeId(id: NodeId): StableNodeId;
+    tryConvertToStableNodeId(id: NodeId): StableNodeId | undefined;
+    convertToNodeId(id: StableNodeId): NodeId;
+    tryConvertToNodeId(id: StableNodeId): NodeId | undefined;
+    get localSessionId(): SessionId;
+    normalizeToOpSpace(id: NodeId): OpSpaceNodeId;
+    normalizeToSessionSpace(id: OpSpaceNodeId, sessionId: SessionId): NodeId;
+}
+/** Create a new node with an automatically generated ID and the given payload */
+export declare function buildLeaf(id?: undefined, payload?: Payload): LeafNode<BuildTreeNode>;
+/** Create a new node with the given ID and payload */
+export declare function buildLeaf(id: NodeId, payload?: Payload): LeafNode<ChangeNode>;
+/**
+ * Generates a leaf {@link ChangeNode}.
+ * If no `id` is explicitly provided, one will be generated.
+ * @param id - Explicit ID to use as the new node's identifier. If not provided, one will be generated.
+ */
+export declare function buildLeafInternal(nodeIdContext: NodeIdContext, id?: NodeId, payload?: Payload): LeafNode<TreeNode<BuildNodeInternal, NodeId>>;
+//# sourceMappingURL=TestNode.d.ts.map

package/lib/test/utilities/TestNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestNode.d.ts","sourceRoot":"","sources":["../../../src/test/utilities/TestNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAIlD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE3G,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EACN,iBAAiB,EACjB,UAAU,EACV,OAAO,EAEP,2BAA2B,EAC3B,QAAQ,EACR,QAAQ,EACR,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,sCAAsC;AACtC,oBAAY,cAAc,GAAG,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;AAEpE;;GAEG;AACH,oBAAY,QAAQ,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;CAAE,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACvD,MAAM,EAAE,2BAA2B,CAAC;IACpC,iFAAiF;IACjF,SAAS,CAAC,WAAW,EAAE,eAAe,GAAG,iBAAiB,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC3D,2DAA2D;IAC3D,UAAU,EAAE,UAAU,CAAC;IACvB,oDAAoD;IACpD,aAAa,EAAE,iBAAiB,CAAC;IACjC,mCAAmC;IACnC,IAAI,EAAE,YAAY,CAAC;IACnB,6CAA6C;IAC7C,MAAM,EAAE,cAAc,CAAC;IACvB,4EAA4E;IAC5E,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,MAAM,CAAC;IAClD,wCAAwC;IACxC,YAAY,IAAI,UAAU,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAC;IACzF,0BAA0B;IAC1B,IAAI,EAAE,QAAQ,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,CAAC;IAChB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtE,8FAA8F;IAC9F,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IAC/D;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,CAAC;CACjG;AAED;;;GAGG;AACH,qBAAa,cAAe,YAAW,QAAQ;IAY7C,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAZlC,gBAAuB,UAAU,aAAwB;IACzD,gBAAuB,UAAU,aAAwD;IACzF,gBAAuB,cAAc,aAAwB;IAC7D,gBAAuB,eAAe,aAAyB;IAE/D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAW;IAChC,SAAgB,IAAI,EAAE,QAAQ,CAAC;IAC/B,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,mBAAmB,MAAC;gBAGlB,aAAa,EAAE,aAAa,EAC5B,gBAAgB,EAAE,gBAAgB,CAAC,aAAa,CAAC,EAClE,mBAAmB,UAAO;IAoF3B,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAEtC;IAED,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,IAAW,aAAa,IAAI,iBAAiB,CAE5C;IAED,IAAW,IAAI,IAAI,YAAY,CAE9B;IAED,IAAW,MAAM,mBAEhB;IAEM,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,MAAM;IAIjD,YAAY,IAAI,UAAU;IAI1B,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;IAErE,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC;IAU9D,iBAAiB,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAIhG,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIzC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAI/C,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI9D,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAIzC,kBAAkB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAI/D,IAAI,cAAc,IAAI,SAAS,CAE9B;IAED,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa;IAG7C,uBAAuB,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,GAAG,MAAM;CAGxE;AAED,+CAA+C;AAC/C,qBAAa,kBAAkB,CAAC,CAAC,SAAS,QAAQ,CAAE,YAAW,QAAQ;IACtE,OAAO,CAAC,SAAS,CAAC,CAAI;gBAEH,cAAc,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI;IAUtE,OAAO,KAAK,QAAQ,GAOnB;IAED,IAAW,IAAI,IAAI,QAAQ,CAE1B;IAED,IAAW,KAAK,IAAI,QAAQ,CAE3B;IAED,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAEtC;IAED,IAAW,UAAU,IAAI,UAAU,CAElC;IAED,IAAW,aAAa,IAAI,iBAAiB,CAE5C;IAED,IAAW,IAAI,IAAI,YAAY,CAE9B;IAED,IAAW,MAAM,IAAI,cAAc,CAElC;IAEM,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,MAAM;IAIjD,YAAY,IAAI,UAAU;IAI1B,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC;IACrE,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC;IAS9D,iBAAiB,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAIhG,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIhD,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAI/C,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAI9D,eAAe,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAIzC,kBAAkB,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAIxD,IAAI,cAAc,IAAI,SAAS,CAE9B;IAED,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa;IAI7C,uBAAuB,CAAC,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,SAAS,GAAG,MAAM;CAGxE;AAED,iFAAiF;AACjF,wBAAgB,SAAS,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;AACtF,sDAAsD;AACtD,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAY/E;;;;GAIG;AACH,wBAAgB,iBAAiB,CAChC,aAAa,EAAE,aAAa,EAC5B,EAAE,CAAC,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,OAAO,GACf,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,CAO/C"}

package/lib/test/utilities/TestNode.js

@@ -0,0 +1,292 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { memoizeGetter, fail, setPropertyIfDefined, identity } from '../../Common';
+import { convertTreeNodes } from '../../EditUtilities';
+import { convertNodeDataIds } from '../../IdConversion';
+import { initialTree } from '../../InitialTree';
+import { RevisionView } from '../../RevisionView';
+/**
+ * A TestTree for general use within the shared-tree package. The nodes in every `SimpleTestTree` will have unique identifiers - i.e. two
+ * different instances of `SimpleTestTree` are never equivalent.
+ */
+export class SimpleTestTree {
+    constructor(nodeIdContext, nodeIdNormalizer, expensiveValidation = true) {
+        this.nodeIdContext = nodeIdContext;
+        this.nodeIdNormalizer = nodeIdNormalizer;
+        const leftIdentifier = nodeIdContext.generateNodeId();
+        const rightIdentifier = nodeIdContext.generateNodeId();
+        const rootIdentifier = nodeIdContext.generateNodeId();
+        this.expensiveValidation = expensiveValidation;
+        this.left = {
+            definition: SimpleTestTree.definition,
+            identifier: leftIdentifier,
+            traits: {},
+            traitLabel: SimpleTestTree.leftTraitLabel,
+            traitLocation: {
+                parent: rootIdentifier,
+                label: SimpleTestTree.leftTraitLabel,
+                get stable() {
+                    return memoizeGetter(this, 'stable', convertToTraitLocation_0_0_2(this, nodeIdContext));
+                },
+                translate: (idConverter) => translateTraitLocation(SimpleTestTree.leftTraitLabel, rootIdentifier, nodeIdContext, idConverter),
+            },
+            get view() {
+                return memoizeGetter(this, 'view', RevisionView.fromTree(this, expensiveValidation));
+            },
+            get stable() {
+                return memoizeGetter(this, 'stable', convertToTestNode_0_0_2(this, nodeIdContext));
+            },
+            translateId: (idConverter) => translateId(leftIdentifier, nodeIdContext, idConverter),
+            toChangeNode: () => convertTreeNodes(this.left, (node) => convertNodeDataIds(node, identity)),
+        };
+        this.right = {
+            definition: SimpleTestTree.definition,
+            identifier: rightIdentifier,
+            traits: {},
+            traitLabel: SimpleTestTree.rightTraitLabel,
+            traitLocation: {
+                parent: rootIdentifier,
+                label: SimpleTestTree.rightTraitLabel,
+                get stable() {
+                    return memoizeGetter(this, 'stable', convertToTraitLocation_0_0_2(this, nodeIdContext));
+                },
+                translate: (idConverter) => translateTraitLocation(SimpleTestTree.rightTraitLabel, rootIdentifier, nodeIdContext, idConverter),
+            },
+            get view() {
+                return memoizeGetter(this, 'view', RevisionView.fromTree(this, expensiveValidation));
+            },
+            get stable() {
+                return memoizeGetter(this, 'stable', convertToTestNode_0_0_2(this, nodeIdContext));
+            },
+            translateId: (idConverter) => translateId(rightIdentifier, nodeIdContext, idConverter),
+            toChangeNode: () => convertTreeNodes(this.right, (node) => convertNodeDataIds(node, identity)),
+        };
+        const rootParent = nodeIdContext.convertToNodeId(initialTree.identifier);
+        this.root = {
+            definition: SimpleTestTree.definition,
+            identifier: rootIdentifier,
+            traits: {
+                [SimpleTestTree.leftTraitLabel]: [this.left],
+                [SimpleTestTree.rightTraitLabel]: [this.right],
+            },
+            traitLabel: SimpleTestTree.traitLabel,
+            traitLocation: {
+                label: SimpleTestTree.traitLabel,
+                parent: rootParent,
+                get stable() {
+                    return memoizeGetter(this, 'stable', convertToTraitLocation_0_0_2(this, nodeIdContext));
+                },
+                translate: (idConverter) => translateTraitLocation(SimpleTestTree.traitLabel, rootParent, nodeIdContext, idConverter),
+            },
+            get view() {
+                return memoizeGetter(this, 'view', RevisionView.fromTree(this, expensiveValidation));
+            },
+            get stable() {
+                return memoizeGetter(this, 'stable', convertToTestNode_0_0_2(this, nodeIdContext));
+            },
+            translateId: (idConverter) => translateId(rootIdentifier, nodeIdContext, idConverter),
+            toChangeNode: () => convertTreeNodes(this.root, (node) => convertNodeDataIds(node, identity)),
+        };
+    }
+    get definition() {
+        return this.root.definition;
+    }
+    get identifier() {
+        return this.root.identifier;
+    }
+    get traits() {
+        return this.root.traits;
+    }
+    get traitLabel() {
+        return this.root.traitLabel;
+    }
+    get traitLocation() {
+        return this.root.traitLocation;
+    }
+    get view() {
+        return this.root.view;
+    }
+    get stable() {
+        return this.root.stable;
+    }
+    translateId(idConverter) {
+        return this.root.translateId(idConverter);
+    }
+    toChangeNode() {
+        return convertTreeNodes(this, (node) => convertNodeDataIds(node, identity));
+    }
+    buildLeaf(id, payload) {
+        if (id === undefined) {
+            return buildLeaf(undefined, payload);
+        }
+        else {
+            return buildLeaf(id, payload);
+        }
+    }
+    buildLeafInternal(id, payload) {
+        return buildLeafInternal(this, id, payload);
+    }
+    generateNodeId(override) {
+        return this.nodeIdContext.generateNodeId(override);
+    }
+    convertToStableNodeId(id) {
+        return this.nodeIdContext.convertToStableNodeId(id);
+    }
+    tryConvertToStableNodeId(id) {
+        return this.nodeIdContext.tryConvertToStableNodeId(id);
+    }
+    convertToNodeId(id) {
+        return this.nodeIdContext.convertToNodeId(id);
+    }
+    tryConvertToNodeId(id) {
+        return this.nodeIdContext.tryConvertToNodeId(id);
+    }
+    get localSessionId() {
+        return this.nodeIdNormalizer.localSessionId;
+    }
+    normalizeToOpSpace(id) {
+        return this.nodeIdNormalizer.normalizeToOpSpace(id);
+    }
+    normalizeToSessionSpace(id, sessionId) {
+        return this.nodeIdNormalizer.normalizeToSessionSpace(id, sessionId);
+    }
+}
+SimpleTestTree.definition = 'node';
+SimpleTestTree.traitLabel = 'e276f382-fa99-49a1-ae81-42001791c733';
+SimpleTestTree.leftTraitLabel = 'left';
+SimpleTestTree.rightTraitLabel = 'right';
+/** A TestTree which resets before each test */
+export class RefreshingTestTree {
+    constructor(createTestTree, fn) {
+        beforeEach(() => {
+            this._testTree = createTestTree();
+            fn === null || fn === void 0 ? void 0 : fn(this._testTree);
+        });
+        afterEach(() => {
+            this._testTree = undefined;
+        });
+    }
+    get testTree() {
+        var _a;
+        return ((_a = this._testTree) !== null && _a !== void 0 ? _a : fail('RefreshingTestTree should be created within a describe() block and should only be read within it() blocks'));
+    }
+    get left() {
+        return this.testTree.left;
+    }
+    get right() {
+        return this.testTree.right;
+    }
+    get definition() {
+        return this.testTree.definition;
+    }
+    get identifier() {
+        return this.testTree.identifier;
+    }
+    get traits() {
+        return this.testTree.traits;
+    }
+    get traitLabel() {
+        return this.testTree.traitLabel;
+    }
+    get traitLocation() {
+        return this.testTree.traitLocation;
+    }
+    get view() {
+        return this.testTree.view;
+    }
+    get stable() {
+        return this.testTree.stable;
+    }
+    translateId(idConverter) {
+        return this.testTree.translateId(idConverter);
+    }
+    toChangeNode() {
+        return convertTreeNodes(this.testTree, (node) => convertNodeDataIds(node, identity));
+    }
+    buildLeaf(id, payload) {
+        if (id === undefined) {
+            return this.testTree.buildLeaf(undefined, payload);
+        }
+        else {
+            return this.testTree.buildLeaf(id, payload);
+        }
+    }
+    buildLeafInternal(id, payload) {
+        return this.testTree.buildLeafInternal(id, payload);
+    }
+    generateNodeId(override) {
+        return this.testTree.generateNodeId(override);
+    }
+    convertToStableNodeId(id) {
+        return this.testTree.convertToStableNodeId(id);
+    }
+    tryConvertToStableNodeId(id) {
+        return this.testTree.convertToStableNodeId(id);
+    }
+    convertToNodeId(id) {
+        return this.testTree.convertToNodeId(id);
+    }
+    tryConvertToNodeId(id) {
+        return this.testTree.tryConvertToNodeId(id);
+    }
+    get localSessionId() {
+        return this.testTree.localSessionId;
+    }
+    normalizeToOpSpace(id) {
+        return this.testTree.normalizeToOpSpace(id);
+    }
+    normalizeToSessionSpace(id, sessionId) {
+        return this.testTree.normalizeToSessionSpace(id, sessionId);
+    }
+}
+/** Create a new node with the given ID and payload */
+export function buildLeaf(id, payload) {
+    const node = {
+        definition: SimpleTestTree.definition,
+        traits: {},
+    };
+    setPropertyIfDefined(id, node, 'identifier');
+    setPropertyIfDefined(payload, node, 'payload');
+    return node;
+}
+/**
+ * Generates a leaf {@link ChangeNode}.
+ * If no `id` is explicitly provided, one will be generated.
+ * @param id - Explicit ID to use as the new node's identifier. If not provided, one will be generated.
+ */
+export function buildLeafInternal(nodeIdContext, id, payload) {
+    const leaf = buildLeaf(undefined, payload);
+    return {
+        definition: leaf.definition,
+        identifier: id !== null && id !== void 0 ? id : nodeIdContext.generateNodeId(),
+        traits: {},
+    };
+}
+/** Translate an ID in one context to an ID in another */
+function translateId(id, from, to) {
+    return to.convertToNodeId(from.convertToStableNodeId(id));
+}
+function translateTraitLocation(label, parentId, from, to) {
+    return {
+        label,
+        parent: translateId(parentId, from, to),
+        get stable() {
+            return memoizeGetter(this, 'stable', convertToTraitLocation_0_0_2(this, to));
+        },
+        translate: (idManager) => translateTraitLocation(label, parentId, to, idManager),
+    };
+}
+function convertToTestNode_0_0_2(node, idConverter) {
+    // This is equivalent to calling tryConvertToChangeNode_0_0_2 but that causes lint to stack overflow
+    return convertTreeNodes(node, (nodeData) => convertNodeDataIds(nodeData, (id) => idConverter.convertToStableNodeId(id)));
+}
+function convertToTraitLocation_0_0_2(traitLocation, idConverter) {
+    const parent = idConverter.convertToStableNodeId(traitLocation.parent);
+    return {
+        label: traitLocation.label,
+        parent,
+    };
+}
+//# sourceMappingURL=TestNode.js.map