document-model 2.20.0 → 2.21.0

package/dist/test/document-helpers/attachBranch.test.js

@@ -0,0 +1,363 @@
+import { describe, expect, it } from "vitest";
+import { attachBranch, checkCleanedOperationsIntegrity, } from "../../src/document/utils/document-helpers.js";
+import { buildOperations } from "./utils.js";
+describe("attachBranch", () => {
+    const scenarios = [
+        {
+            // [T0:0 T1:0 T2:0 T3:0] + [] = [T0:0 T1:0 T2:0 T3:0] + []
+            title: "empty branch",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            tail: [],
+        },
+        {
+            // [] + [B0:0 B1:0 B2:0] = [B0:0 B1:0 B2:0] + []
+            title: "empty trunk",
+            trunk: [],
+            branch: [
+                { index: 0, skip: 0, type: "B_0" },
+                { index: 1, skip: 0, type: "B_1" },
+                { index: 2, skip: 0, type: "B_2" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "B_0" },
+                { index: 1, skip: 0, type: "B_1" },
+                { index: 2, skip: 0, type: "B_2" },
+            ],
+            tail: [],
+        },
+        {
+            // [T0:0 T1:0 T2:0 T3:0] + [B4:0 B5:0 B6:0] = [T0:0 T1:0 T2:0 T3:0 B4:0 B5:0 B6:0] + []
+            title: "simple append",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [
+                { index: 4, skip: 0, type: "B_4" },
+                { index: 5, skip: 0, type: "B_5" },
+                { index: 6, skip: 0, type: "B_6" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+                { index: 4, skip: 0, type: "B_4" },
+                { index: 5, skip: 0, type: "B_5" },
+                { index: 6, skip: 0, type: "B_6" },
+            ],
+            tail: [],
+        },
+        {
+            // [T0:0 T1:0 T2:0 T3:0] + [B3:0 B4:0] = [T0:0 T1:0 T2:0 B3:0 B4:0] + [T3:0]
+            title: "1 overlap",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [
+                { index: 3, skip: 0, type: "B_3" },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "B_3" },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            tail: [{ index: 3, skip: 0, type: "T_3" }],
+        },
+        {
+            // [T0:0 T1:0 T2:0 T3:0] + [B1:0] = [T0:0 B1:0] + [T1:0 T2:0 T3:0]
+            title: "early conflict",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [{ index: 1, skip: 0, type: "B_1" }],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "B_1" },
+            ],
+            tail: [
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+        },
+        {
+            title: "discard duplicates (longer trunk)",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 4, skip: 0, type: "T_4" },
+                { index: 5, skip: 0, type: "T_5" },
+            ],
+            branch: [
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            tail: [
+                { index: 4, skip: 0, type: "T_4" },
+                { index: 5, skip: 0, type: "T_5" },
+            ],
+        },
+        {
+            title: "discard duplicates (longer branch)",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+            ],
+            branch: [
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 3,
+                    skip: 0,
+                    type: "T_3",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            tail: [],
+        },
+        {
+            // [T0:0 T1:0 T2:2 T3:0] + [T2:0 T2:1 T2:2] = [T0:0 T1:0 B4:2]
+            title: "ignore irrelevant skip differences (1)",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 2,
+                    type: "T_2",
+                    timestamp: "2021-01-03T00:00:00.000Z",
+                },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-01T00:00:00.000Z",
+                },
+                {
+                    index: 2,
+                    skip: 1,
+                    type: "T_2",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                {
+                    index: 2,
+                    skip: 2,
+                    type: "T_2",
+                    timestamp: "2021-01-03T00:00:00.000Z",
+                },
+            ],
+            newTrunk: [
+                { index: 2, skip: 2, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            tail: [],
+        },
+        {
+            // [T0:0 T1:0 T2:1 T3:0 T4:0] + [T2:0 T2:2 B3:0 B4:0] = [T2:2 B3:0 B4:0] + [T3:0 T4:0]
+            title: "ignore irrelevant skip differences (2)",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                {
+                    index: 2,
+                    skip: 1,
+                    type: "T_2",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 3, skip: 0, type: "T_3" },
+                { index: 4, skip: 0, type: "T_4" },
+            ],
+            branch: [
+                {
+                    index: 2,
+                    skip: 0,
+                    type: "T_2",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                {
+                    index: 2,
+                    skip: 2,
+                    type: "T_2",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 3, skip: 0, type: "B_3" },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            newTrunk: [
+                {
+                    index: 2,
+                    skip: 2,
+                    type: "T_2",
+                    timestamp: "2021-01-02T00:00:00.000Z",
+                },
+                { index: 3, skip: 0, type: "B_3" },
+                { index: 4, skip: 0, type: "B_4" },
+            ],
+            tail: [
+                { index: 3, skip: 0, type: "T_3" },
+                { index: 4, skip: 0, type: "T_4" },
+            ],
+        },
+        {
+            // [T0:0 T1:0 T2:0 T3:0] + [B4:0 B4:2] = [T0:0 T1:0 B4:2]
+            title: "handle overlapping skips",
+            trunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 2, skip: 0, type: "T_2" },
+                { index: 3, skip: 0, type: "T_3" },
+            ],
+            branch: [
+                { index: 4, skip: 0, type: "B_4_0" },
+                { index: 4, skip: 2, type: "B_4_2" },
+            ],
+            newTrunk: [
+                { index: 0, skip: 0, type: "T_0" },
+                { index: 1, skip: 0, type: "T_1" },
+                { index: 4, skip: 2, type: "B_4_2" },
+            ],
+            tail: [],
+        },
+    ];
+    it.each(scenarios)("should return the new trunk and tail ($title)", (testInput) => {
+        const trunkOperations = buildOperations(testInput.trunk);
+        const branchOperations = buildOperations(testInput.branch);
+        const [newTrunk, tail] = attachBranch(trunkOperations, branchOperations);
+        expect(newTrunk).toMatchObject(testInput.newTrunk);
+        expect(tail).toMatchObject(testInput.tail);
+        expect(checkCleanedOperationsIntegrity(newTrunk)).toHaveLength(0);
+    });
+    it("should handle duplicated id operations", () => {
+        // target
+        const trunkOperations = buildOperations([
+            { index: 0, skip: 0, type: "T_0", id: "1" }, // add folder
+            { index: 1, skip: 0, type: "T_1", id: "2" }, // add folder
+            { index: 2, skip: 0, type: "T_2", id: "5" }, // 5
+            { index: 3, skip: 0, type: "T_3", id: "6" }, // 6
+            { index: 4, skip: 0, type: "T_4", id: "7" }, // 7
+            { index: 5, skip: 0, type: "T_5", id: "8" }, // 8
+        ]);
+        // new operations
+        const branchOperations = buildOperations([
+            { index: 4, skip: 2, type: "B_4_2", id: "3" }, // 3
+            { index: 5, skip: 0, type: "B_5", id: "4" }, // 4
+            { index: 6, skip: 0, type: "T_2", id: "5" }, // 5
+            { index: 7, skip: 0, type: "T_3", id: "6" }, // 6
+        ]);
+        const [newTrunk, tail] = attachBranch(trunkOperations, branchOperations);
+        expect(newTrunk).toMatchObject([
+            { index: 0, skip: 0, type: "T_0" }, // add folder
+            { index: 1, skip: 0, type: "T_1" }, // add folder
+            { index: 4, skip: 2, type: "B_4_2" }, // 3
+            { index: 5, skip: 0, type: "B_5" }, // 4
+            { index: 6, skip: 0, type: "T_2" }, // 5
+            { index: 7, skip: 0, type: "T_3" }, // 6
+        ]);
+        expect(tail).toMatchObject([
+            { index: 4, skip: 0, type: "T_4" }, // 7
+            { index: 5, skip: 0, type: "T_5" }, // 8
+        ]);
+        expect(checkCleanedOperationsIntegrity(newTrunk)).toHaveLength(0);
+    });
+});

package/dist/test/document-helpers/checkCleanedOperationsIntegrity.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkCleanedOperationsIntegrity.test.d.ts","sourceRoot":"","sources":["../../../test/document-helpers/checkCleanedOperationsIntegrity.test.ts"],"names":[],"mappings":""}

package/dist/test/document-helpers/checkCleanedOperationsIntegrity.test.js

@@ -0,0 +1,251 @@
+import { describe, expect, it } from "vitest";
+import { checkCleanedOperationsIntegrity, IntegrityIssueSubType, IntegrityIssueType, } from "../../src/document/utils/document-helpers.js";
+import { buildOperations } from "./utils.js";
+describe("checkCleanedOperationsIntegrity", () => {
+    const validScenarios = [
+        { title: "case 1", operations: [], expected: 0 },
+        { title: "case 2", operations: [{ index: 1, skip: 1 }], expected: 0 },
+        {
+            title: "case 3",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 1, skip: 0 },
+                { index: 2, skip: 0 },
+                { index: 3, skip: 0 },
+                { index: 4, skip: 0 },
+                { index: 5, skip: 0 },
+            ],
+            expected: 0,
+        },
+        {
+            title: "case 4",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 2, skip: 1 },
+                { index: 3, skip: 0 },
+                { index: 4, skip: 0 },
+                { index: 5, skip: 0 },
+            ],
+            expected: 0,
+        },
+        {
+            title: "case 5",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 3, skip: 2 },
+                { index: 4, skip: 0 },
+                { index: 5, skip: 0 },
+            ],
+            expected: 0,
+        },
+        {
+            title: "case 6",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 3, skip: 2 },
+                { index: 5, skip: 1 },
+            ],
+            expected: 0,
+        },
+    ];
+    const invalidScenarios = [
+        { title: "case 1", operations: [{ index: 0, skip: 3 }], expected: 1 },
+        { title: "case 2", operations: [{ index: 1, skip: 2 }], expected: 1 },
+        {
+            title: "case 3",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 1, skip: 1 },
+            ],
+            expected: 1,
+        },
+        {
+            title: "case 4",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 2, skip: 2 },
+            ],
+            expected: 1,
+        },
+        {
+            title: "case 5",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 3, skip: 2 },
+                { index: 5, skip: 2 },
+            ],
+            expected: 1,
+        },
+    ];
+    it.each(validScenarios)("valid:  $title", (testInput) => {
+        const operations = buildOperations(testInput.operations);
+        const result = checkCleanedOperationsIntegrity(operations);
+        expect(result.length).toBe(testInput.expected);
+    });
+    it.each(invalidScenarios)("invalid: $title", (testInput) => {
+        const operations = buildOperations(testInput.operations);
+        const result = checkCleanedOperationsIntegrity(operations);
+        expect(result.length).toBe(testInput.expected);
+    });
+    const missingIndexScenarios = [
+        {
+            title: "case 1",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 1, skip: 0 },
+                { index: 3, skip: 0 },
+                { index: 4, skip: 0 },
+                { index: 5, skip: 0 },
+            ],
+            expected: [{ index: 3, skip: 0 }],
+        },
+        {
+            title: "case 2",
+            operations: [
+                { index: 1, skip: 1 },
+                { index: 3, skip: 0 },
+                { index: 4, skip: 0 },
+                { index: 5, skip: 0 },
+            ],
+            expected: [{ index: 3, skip: 0 }],
+        },
+        {
+            title: "case 3",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 2, skip: 0 },
+                { index: 5, skip: 0 },
+                { index: 6, skip: 0 },
+                { index: 8, skip: 0 },
+            ],
+            expected: [
+                { index: 2, skip: 0 },
+                { index: 5, skip: 0 },
+                { index: 8, skip: 0 },
+            ],
+        },
+        {
+            title: "case 4",
+            operations: [
+                { index: 1, skip: 1 },
+                { index: 5, skip: 3 },
+                { index: 8, skip: 2 },
+                { index: 10, skip: 0 },
+                { index: 11, skip: 0 },
+                { index: 13, skip: 1 },
+            ],
+            expected: [{ index: 10, skip: 0 }],
+        },
+        {
+            title: "case 5",
+            operations: [
+                { index: 1, skip: 1 },
+                { index: 5, skip: 3 },
+                { index: 8, skip: 2 },
+                { index: 11, skip: 1 },
+                { index: 14, skip: 1 },
+            ],
+            expected: [
+                { index: 11, skip: 1 },
+                { index: 14, skip: 1 },
+            ],
+        },
+    ];
+    it.each(missingIndexScenarios)("should report missing index sub error: $title", (testInput) => {
+        const operations = buildOperations(testInput.operations);
+        const result = checkCleanedOperationsIntegrity(operations);
+        const expectedErrors = testInput.expected.map((op) => ({
+            operation: op,
+            issue: IntegrityIssueType.UNEXPECTED_INDEX,
+            category: IntegrityIssueSubType.MISSING_INDEX,
+        }));
+        expect(result.length).toBe(expectedErrors.length);
+        expect(result).toMatchObject(expectedErrors);
+    });
+    const duplicatedIndexScenarios = [
+        {
+            title: "case 1",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 1, skip: 0 },
+                { index: 1, skip: 0 },
+                { index: 2, skip: 0 },
+                { index: 3, skip: 0 },
+            ],
+            expected: [{ index: 1, skip: 0 }],
+        },
+        {
+            title: "case 2",
+            operations: [
+                { index: 1, skip: 1 },
+                { index: 2, skip: 0 },
+                { index: 2, skip: 0 },
+                { index: 3, skip: 0 },
+            ],
+            expected: [{ index: 2, skip: 0 }],
+        },
+        {
+            title: "case 3",
+            operations: [
+                { index: 0, skip: 0 },
+                { index: 2, skip: 1 },
+                { index: 5, skip: 2 },
+                { index: 5, skip: 2 },
+            ],
+            expected: [{ index: 5, skip: 2 }],
+        },
+        {
+            title: "case 4",
+            operations: [
+                { index: 1, skip: 1 },
+                { index: 2, skip: 0 },
+                { index: 3, skip: 0 },
+                { index: 3, skip: 0 },
+                { index: 3, skip: 0 },
+                { index: 4, skip: 0 },
+            ],
+            expected: [
+                { index: 3, skip: 0 },
+                { index: 3, skip: 0 },
+            ],
+        },
+    ];
+    it.each(duplicatedIndexScenarios)("should report duplicated index sub error: $title", (testInput) => {
+        const operations = buildOperations(testInput.operations);
+        const result = checkCleanedOperationsIntegrity(operations);
+        const expectedErrors = testInput.expected.map((op) => ({
+            operation: op,
+            issue: IntegrityIssueType.UNEXPECTED_INDEX,
+            category: IntegrityIssueSubType.DUPLICATED_INDEX,
+        }));
+        expect(result.length).toBe(expectedErrors.length);
+        expect(result).toMatchObject(expectedErrors);
+    });
+    it("should detect when an operation is both: missing index and duplicate index error", () => {
+        const operations = buildOperations([
+            { index: 1, skip: 1 },
+            { index: 3, skip: 0 },
+            { index: 3, skip: 0 },
+            { index: 5, skip: 0 },
+        ]);
+        const result = checkCleanedOperationsIntegrity(operations);
+        expect(result.length).toBe(3);
+        expect(result).toMatchObject([
+            {
+                issue: IntegrityIssueType.UNEXPECTED_INDEX,
+                category: IntegrityIssueSubType.MISSING_INDEX,
+                operation: { index: 3, skip: 0 },
+            },
+            {
+                issue: IntegrityIssueType.UNEXPECTED_INDEX,
+                category: IntegrityIssueSubType.DUPLICATED_INDEX,
+                operation: { index: 3, skip: 0 },
+            },
+            {
+                issue: IntegrityIssueType.UNEXPECTED_INDEX,
+                category: IntegrityIssueSubType.MISSING_INDEX,
+                operation: { index: 5, skip: 0 },
+            },
+        ]);
+    });
+});

package/dist/test/document-helpers/conflictResolution.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conflictResolution.test.d.ts","sourceRoot":"","sources":["../../../test/document-helpers/conflictResolution.test.ts"],"names":[],"mappings":""}