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

package/lib/test/snapshot.spec.js

@@ -0,0 +1,176 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { SnapshotV1 } from "../snapshotV1.js";
+import { createInsertOnlyAttributionPolicy, createPropertyTrackingAttributionPolicyFactory, } from "../attributionPolicy.js";
+import { loadSnapshot, TestString } from "./snapshot.utils.js";
+function makeSnapshotSuite(options) {
+    describe("from an empty initial state", () => {
+        let str;
+        beforeEach(() => {
+            str = new TestString("fakeId", options);
+        });
+        afterEach(async () => {
+            // Paranoid check that ensures `str` roundtrips through snapshot/load.  This helps to catch
+            // bugs that might be missed if the test case forgets to call/await `str.expect()`.
+            await str.checkSnapshot({
+                attribution: { policyFactory: createInsertOnlyAttributionPolicy },
+            });
+        });
+        it("excludes un-acked segments", async () => {
+            str.append("0", /* increaseMsn: */ false);
+            // Invoke `load/getSnapshot()` directly instead of `str.expect()` to avoid ACKing the
+            // pending insert op.
+            const client2 = await loadSnapshot(str.getSummary(), options);
+            // Original client has inserted text, but the one loaded from the snapshot should be empty.
+            // This is because un-ACKed ops are not included in snapshots.  Instead, these ops are
+            // retransmitted and applied after the snapshot has loaded.
+            assert.equal(str.getText(), "0");
+            assert.equal(client2.getText(), "");
+        });
+        it("includes segments below MSN", async () => {
+            str.append("0", /* increaseMsn: */ true);
+            await str.expect("0");
+        });
+        it("includes ACKed segments above the MSN", async () => {
+            str.append("0", /* increaseMsn: */ false);
+            await str.expect("0");
+        });
+        it("includes removals of segments above the MSN", async () => {
+            str.append("0x", /* increaseMsn: */ false);
+            str.removeRange(1, 2, /* increaseMsn: */ false);
+            await str.expect("0");
+        });
+        it("includes removals above the MSN of segments below the MSN", async () => {
+            str.append("0x", /* increaseMsn: */ true);
+            str.removeRange(1, 2, /* increaseMsn: */ false);
+            await str.expect("0");
+        });
+        it("can insert segments after loading removed segment", async () => {
+            str.append("0x", /* increaseMsn: */ true);
+            str.removeRange(1, 2, /* increaseMsn: */ false);
+            await str.expect("0");
+            str.append("1", /* increaseMsn: */ false);
+            await str.expect("01");
+        });
+        it("can insert segments relative to removed segment", async () => {
+            str.append("0x", /* increaseMsn: */ false);
+            str.append("2", /* increaseMsn: */ false);
+            str.removeRange(1, 2, /* increaseMsn: */ false);
+            str.insert(1, "1", /* increaseMsn: */ false);
+            str.append("3", /* increaseMsn: */ false);
+            await str.expect("0123");
+        });
+        it("can insert segments relative to removed segment loaded from snapshot", async () => {
+            str.append("0x", /* increaseMsn: */ false);
+            str.append("2", /* increaseMsn: */ false);
+            str.removeRange(1, 2, /* increaseMsn: */ false);
+            // Note that calling str.expect() switches the underlying client to the one loaded from the snapshot.
+            await str.expect("02");
+            str.insert(1, "1", /* increaseMsn: */ false);
+            str.append("3", /* increaseMsn: */ false);
+            await str.expect("0123");
+        });
+        it("includes obliterates above the MSN of segments below the MSN", async () => {
+            str.append("0x", /* increaseMsn: */ true);
+            str.obliterateRange(1, 2, /* increaseMsn: */ false);
+            await str.expect("0");
+        });
+        it("can insert segments after loading obliterated segment", async () => {
+            str.append("0x", /* increaseMsn: */ true);
+            str.obliterateRange(1, 2, /* increaseMsn: */ false);
+            await str.expect("0");
+            str.append("1", /* increaseMsn: */ false);
+            await str.expect("01");
+        });
+        it("can insert segments relative to obliterated segment", async () => {
+            str.append("0x", /* increaseMsn: */ false);
+            str.append("2", /* increaseMsn: */ false);
+            str.obliterateRange(1, 2, /* increaseMsn: */ false);
+            str.insert(1, "1", /* increaseMsn: */ false);
+            str.append("3", /* increaseMsn: */ false);
+            await str.expect("0123");
+        });
+        it("can insert segments relative to obliterated segment loaded from snapshot", async () => {
+            str.append("0x", /* increaseMsn: */ false);
+            str.append("2", /* increaseMsn: */ false);
+            str.obliterateRange(1, 2, /* increaseMsn: */ false);
+            // Note that calling str.expect() switches the underlying client to the one loaded from the snapshot.
+            await str.expect("02");
+            str.insert(1, "1", /* increaseMsn: */ false);
+            str.append("3", /* increaseMsn: */ false);
+            await str.expect("0123");
+        });
+        it("includes ACKed segments below MSN in body", async () => {
+            for (let i = 0; i < SnapshotV1.chunkSize + 10; i++) {
+                str.append(`${i % 10}`, /* increaseMsn: */ true);
+            }
+            await str.checkSnapshot();
+        });
+        it("includes ACKed segments above MSN in body", async () => {
+            for (let i = 0; i < SnapshotV1.chunkSize + 10; i++) {
+                str.append(`${i % 10}`, /* increaseMsn: */ false);
+            }
+            await str.checkSnapshot();
+        });
+        it("recovers annotated segments", async () => {
+            str.append("123", false);
+            str.annotate(1, 2, { foo: 1 }, false);
+            await str.checkSnapshot();
+        });
+    });
+    describe("from a non-empty initial state", () => {
+        it("includes segments submitted while detached", async () => {
+            const str = new TestString("A", options, "starting text");
+            await str.expect("starting text");
+        });
+    });
+}
+describe("snapshot", () => {
+    describe("with attribution", () => {
+        makeSnapshotSuite({
+            attribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },
+            mergeTreeEnableObliterate: true,
+        });
+    });
+    describe("with attribution and custom channels", () => {
+        makeSnapshotSuite({
+            attribution: {
+                track: true,
+                policyFactory: createPropertyTrackingAttributionPolicyFactory("foo"),
+            },
+            mergeTreeEnableObliterate: true,
+        });
+    });
+    describe("without attribution", () => {
+        makeSnapshotSuite({
+            attribution: { track: false },
+            mergeTreeEnableObliterate: true,
+        });
+    });
+    it("presence of attribution overrides merge-tree initialization value", async () => {
+        const str = new TestString("id", {
+            attribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },
+        });
+        str.append("hello world", /* increaseMsn: */ true);
+        await str.checkSnapshot({
+            attribution: { track: false, policyFactory: createInsertOnlyAttributionPolicy },
+        });
+        str.insert(0, "should have attribution", false);
+        str.applyPendingOps();
+        assert(str.getSegment(0).attribution !== undefined, "Attribution should be created on new segments");
+    });
+    it("lack of attribution overrides merge-tree initialization", async () => {
+        const str = new TestString("id", { attribution: { track: false } });
+        str.append("hello world", /* increaseMsn: */ true);
+        await str.checkSnapshot({
+            attribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },
+        });
+        str.insert(0, "should not have attribution", false);
+        str.applyPendingOps();
+        assert(str.getSegment(0).attribution === undefined, "No attribution should be created on new segments");
+    });
+});
+//# sourceMappingURL=snapshot.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.spec.js","sourceRoot":"","sources":["../../src/test/snapshot.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EACN,iCAAiC,EACjC,8CAA8C,GAC9C,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE/D,SAAS,iBAAiB,CAAC,OAA2B;IACrD,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;QAC5C,IAAI,GAAe,CAAC;QACpB,UAAU,CAAC,GAAG,EAAE;YACf,GAAG,GAAG,IAAI,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK,IAAI,EAAE;YACpB,2FAA2F;YAC3F,mFAAmF;YACnF,MAAM,GAAG,CAAC,aAAa,CAAC;gBACvB,WAAW,EAAE,EAAE,aAAa,EAAE,iCAAiC,EAAE;aACjE,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;YAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAE1C,qFAAqF;YACrF,qBAAqB;YACrB,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;YAE9D,2FAA2F;YAC3F,sFAAsF;YACtF,2DAA2D;YAC3D,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;YACjC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC5C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACtD,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC5D,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YAC1E,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC1C,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YAClE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC1C,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAChE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAChD,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC7C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;YACrF,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEhD,qGAAqG;YACrG,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAEvB,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC7C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;YAC7E,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC1C,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACtE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;YAC1C,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACpE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACpD,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC7C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;YACzF,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAEpD,qGAAqG;YACrG,MAAM,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAEvB,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC7C,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;gBACnD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;aACjD;YAED,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;gBACnD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,kBAAkB,CAAC,KAAK,CAAC,CAAC;aAClD;YAED,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC5C,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACzB,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YAEtC,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;QAC/C,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC;YAC1D,MAAM,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QACjC,iBAAiB,CAAC;YACjB,WAAW,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,iCAAiC,EAAE;YAC9E,yBAAyB,EAAE,IAAI;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;QACrD,iBAAiB,CAAC;YACjB,WAAW,EAAE;gBACZ,KAAK,EAAE,IAAI;gBACX,aAAa,EAAE,8CAA8C,CAAC,KAAK,CAAC;aACpE;YACD,yBAAyB,EAAE,IAAI;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACpC,iBAAiB,CAAC;YACjB,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;YAC7B,yBAAyB,EAAE,IAAI;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QAClF,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE;YAChC,WAAW,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,iCAAiC,EAAE;SAC9E,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,GAAG,CAAC,aAAa,CAAC;YACvB,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,iCAAiC,EAAE;SAC/E,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,yBAAyB,EAAE,KAAK,CAAC,CAAC;QAChD,GAAG,CAAC,eAAe,EAAE,CAAC;QACtB,MAAM,CACL,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,SAAS,EAC3C,+CAA+C,CAC/C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACpE,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACnD,MAAM,GAAG,CAAC,aAAa,CAAC;YACvB,WAAW,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,iCAAiC,EAAE;SAC9E,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,6BAA6B,EAAE,KAAK,CAAC,CAAC;QACpD,GAAG,CAAC,eAAe,EAAE,CAAC;QACtB,MAAM,CACL,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,SAAS,EAC3C,kDAAkD,CAClD,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"assert\";\nimport { SnapshotV1 } from \"../snapshotV1.js\";\nimport { IMergeTreeOptions } from \"../mergeTree.js\";\nimport {\n\tcreateInsertOnlyAttributionPolicy,\n\tcreatePropertyTrackingAttributionPolicyFactory,\n} from \"../attributionPolicy.js\";\nimport { loadSnapshot, TestString } from \"./snapshot.utils.js\";\n\nfunction makeSnapshotSuite(options?: IMergeTreeOptions): void {\n\tdescribe(\"from an empty initial state\", () => {\n\t\tlet str: TestString;\n\t\tbeforeEach(() => {\n\t\t\tstr = new TestString(\"fakeId\", options);\n\t\t});\n\n\t\tafterEach(async () => {\n\t\t\t// Paranoid check that ensures `str` roundtrips through snapshot/load.  This helps to catch\n\t\t\t// bugs that might be missed if the test case forgets to call/await `str.expect()`.\n\t\t\tawait str.checkSnapshot({\n\t\t\t\tattribution: { policyFactory: createInsertOnlyAttributionPolicy },\n\t\t\t});\n\t\t});\n\n\t\tit(\"excludes un-acked segments\", async () => {\n\t\t\tstr.append(\"0\", /* increaseMsn: */ false);\n\n\t\t\t// Invoke `load/getSnapshot()` directly instead of `str.expect()` to avoid ACKing the\n\t\t\t// pending insert op.\n\t\t\tconst client2 = await loadSnapshot(str.getSummary(), options);\n\n\t\t\t// Original client has inserted text, but the one loaded from the snapshot should be empty.\n\t\t\t// This is because un-ACKed ops are not included in snapshots.  Instead, these ops are\n\t\t\t// retransmitted and applied after the snapshot has loaded.\n\t\t\tassert.equal(str.getText(), \"0\");\n\t\t\tassert.equal(client2.getText(), \"\");\n\t\t});\n\n\t\tit(\"includes segments below MSN\", async () => {\n\t\t\tstr.append(\"0\", /* increaseMsn: */ true);\n\t\t\tawait str.expect(\"0\");\n\t\t});\n\n\t\tit(\"includes ACKed segments above the MSN\", async () => {\n\t\t\tstr.append(\"0\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t});\n\n\t\tit(\"includes removals of segments above the MSN\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ false);\n\t\t\tstr.removeRange(1, 2, /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t});\n\n\t\tit(\"includes removals above the MSN of segments below the MSN\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ true);\n\t\t\tstr.removeRange(1, 2, /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t});\n\n\t\tit(\"can insert segments after loading removed segment\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ true);\n\t\t\tstr.removeRange(1, 2, /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t\tstr.append(\"1\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"01\");\n\t\t});\n\n\t\tit(\"can insert segments relative to removed segment\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"2\", /* increaseMsn: */ false);\n\t\t\tstr.removeRange(1, 2, /* increaseMsn: */ false);\n\t\t\tstr.insert(1, \"1\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"3\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0123\");\n\t\t});\n\n\t\tit(\"can insert segments relative to removed segment loaded from snapshot\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"2\", /* increaseMsn: */ false);\n\t\t\tstr.removeRange(1, 2, /* increaseMsn: */ false);\n\n\t\t\t// Note that calling str.expect() switches the underlying client to the one loaded from the snapshot.\n\t\t\tawait str.expect(\"02\");\n\n\t\t\tstr.insert(1, \"1\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"3\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0123\");\n\t\t});\n\n\t\tit(\"includes obliterates above the MSN of segments below the MSN\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ true);\n\t\t\tstr.obliterateRange(1, 2, /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t});\n\n\t\tit(\"can insert segments after loading obliterated segment\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ true);\n\t\t\tstr.obliterateRange(1, 2, /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0\");\n\t\t\tstr.append(\"1\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"01\");\n\t\t});\n\n\t\tit(\"can insert segments relative to obliterated segment\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"2\", /* increaseMsn: */ false);\n\t\t\tstr.obliterateRange(1, 2, /* increaseMsn: */ false);\n\t\t\tstr.insert(1, \"1\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"3\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0123\");\n\t\t});\n\n\t\tit(\"can insert segments relative to obliterated segment loaded from snapshot\", async () => {\n\t\t\tstr.append(\"0x\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"2\", /* increaseMsn: */ false);\n\t\t\tstr.obliterateRange(1, 2, /* increaseMsn: */ false);\n\n\t\t\t// Note that calling str.expect() switches the underlying client to the one loaded from the snapshot.\n\t\t\tawait str.expect(\"02\");\n\n\t\t\tstr.insert(1, \"1\", /* increaseMsn: */ false);\n\t\t\tstr.append(\"3\", /* increaseMsn: */ false);\n\t\t\tawait str.expect(\"0123\");\n\t\t});\n\n\t\tit(\"includes ACKed segments below MSN in body\", async () => {\n\t\t\tfor (let i = 0; i < SnapshotV1.chunkSize + 10; i++) {\n\t\t\t\tstr.append(`${i % 10}`, /* increaseMsn: */ true);\n\t\t\t}\n\n\t\t\tawait str.checkSnapshot();\n\t\t});\n\n\t\tit(\"includes ACKed segments above MSN in body\", async () => {\n\t\t\tfor (let i = 0; i < SnapshotV1.chunkSize + 10; i++) {\n\t\t\t\tstr.append(`${i % 10}`, /* increaseMsn: */ false);\n\t\t\t}\n\n\t\t\tawait str.checkSnapshot();\n\t\t});\n\n\t\tit(\"recovers annotated segments\", async () => {\n\t\t\tstr.append(\"123\", false);\n\t\t\tstr.annotate(1, 2, { foo: 1 }, false);\n\n\t\t\tawait str.checkSnapshot();\n\t\t});\n\t});\n\n\tdescribe(\"from a non-empty initial state\", () => {\n\t\tit(\"includes segments submitted while detached\", async () => {\n\t\t\tconst str = new TestString(\"A\", options, \"starting text\");\n\t\t\tawait str.expect(\"starting text\");\n\t\t});\n\t});\n}\n\ndescribe(\"snapshot\", () => {\n\tdescribe(\"with attribution\", () => {\n\t\tmakeSnapshotSuite({\n\t\t\tattribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },\n\t\t\tmergeTreeEnableObliterate: true,\n\t\t});\n\t});\n\n\tdescribe(\"with attribution and custom channels\", () => {\n\t\tmakeSnapshotSuite({\n\t\t\tattribution: {\n\t\t\t\ttrack: true,\n\t\t\t\tpolicyFactory: createPropertyTrackingAttributionPolicyFactory(\"foo\"),\n\t\t\t},\n\t\t\tmergeTreeEnableObliterate: true,\n\t\t});\n\t});\n\n\tdescribe(\"without attribution\", () => {\n\t\tmakeSnapshotSuite({\n\t\t\tattribution: { track: false },\n\t\t\tmergeTreeEnableObliterate: true,\n\t\t});\n\t});\n\n\tit(\"presence of attribution overrides merge-tree initialization value\", async () => {\n\t\tconst str = new TestString(\"id\", {\n\t\t\tattribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },\n\t\t});\n\t\tstr.append(\"hello world\", /* increaseMsn: */ true);\n\t\tawait str.checkSnapshot({\n\t\t\tattribution: { track: false, policyFactory: createInsertOnlyAttributionPolicy },\n\t\t});\n\t\tstr.insert(0, \"should have attribution\", false);\n\t\tstr.applyPendingOps();\n\t\tassert(\n\t\t\tstr.getSegment(0).attribution !== undefined,\n\t\t\t\"Attribution should be created on new segments\",\n\t\t);\n\t});\n\n\tit(\"lack of attribution overrides merge-tree initialization\", async () => {\n\t\tconst str = new TestString(\"id\", { attribution: { track: false } });\n\t\tstr.append(\"hello world\", /* increaseMsn: */ true);\n\t\tawait str.checkSnapshot({\n\t\t\tattribution: { track: true, policyFactory: createInsertOnlyAttributionPolicy },\n\t\t});\n\t\tstr.insert(0, \"should not have attribution\", false);\n\t\tstr.applyPendingOps();\n\t\tassert(\n\t\t\tstr.getSegment(0).attribution === undefined,\n\t\t\t\"No attribution should be created on new segments\",\n\t\t);\n\t});\n});\n"]}

package/lib/test/snapshot.utils.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ISummaryTree } from "@fluidframework/protocol-definitions";
+import { IMergeTreeOptions } from "../mergeTree.js";
+import { PropertySet } from "../properties.js";
+import { ISegment } from "../mergeTreeNodes.js";
+import { TestClient } from "./testClient.js";
+export declare function loadSnapshot(summary: ISummaryTree, options?: IMergeTreeOptions): Promise<TestClient>;
+export declare class TestString {
+    private readonly options?;
+    private client;
+    private readonly pending;
+    private seq;
+    private minSeq;
+    constructor(id: string, options?: IMergeTreeOptions | undefined, initialState?: string);
+    insert(pos: number, text: string, increaseMsn: boolean): void;
+    annotate(start: number, end: number, props: PropertySet, increaseMsn: boolean): void;
+    append(text: string, increaseMsn: boolean): void;
+    insertMarker(pos: number, increaseMsn: boolean): void;
+    appendMarker(increaseMsn: boolean): void;
+    removeRange(start: number, end: number, increaseMsn: boolean): void;
+    obliterateRange(start: number, end: number, increaseMsn: boolean): void;
+    expect(expected: string): Promise<void>;
+    checkSnapshot(options?: IMergeTreeOptions): Promise<void>;
+    getSummary(): ISummaryTree;
+    getText(): string;
+    applyPendingOps(): void;
+    private queue;
+    getSegment(pos: number): ISegment;
+}
+//# sourceMappingURL=snapshot.utils.d.ts.map

package/lib/test/snapshot.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.utils.d.ts","sourceRoot":"","sources":["../../src/test/snapshot.utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAA6B,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAK/F,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,wBAAsB,YAAY,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,iBAAiB,uBAepF;AAGD,qBAAa,UAAU;IAQrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAP1B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAC3D,OAAO,CAAC,GAAG,CAAK;IAChB,OAAO,CAAC,MAAM,CAAK;gBAGlB,EAAE,EAAE,MAAM,EACO,OAAO,CAAC,+BAAmB,EAC5C,YAAY,GAAE,MAAW;IAMnB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;IAOtD,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO;IAI7E,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;IAIzC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;IAS9C,YAAY,CAAC,WAAW,EAAE,OAAO;IAIjC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;IAI5D,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO;IAO1D,MAAM,CAAC,QAAQ,EAAE,MAAM;IAWvB,aAAa,CAAC,OAAO,CAAC,EAAE,iBAAiB;IA8B/C,UAAU,IAAI,YAAY;IAS1B,OAAO;IAIP,eAAe;IAOtB,OAAO,CAAC,KAAK;IAeN,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAKxC"}

package/lib/test/snapshot.utils.js

@@ -0,0 +1,104 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { strict as assert } from "assert";
+import { MockStorage } from "@fluidframework/test-runtime-utils";
+import { ReferenceType } from "../ops.js";
+import { SnapshotV1 } from "../snapshotV1.js";
+import { createClientsAtInitialState } from "./testClientLogger.js";
+import { TestSerializer } from "./testSerializer.js";
+import { TestClient } from "./testClient.js";
+// Reconstitutes a MergeTree client from a summary
+export async function loadSnapshot(summary, options) {
+    const services = MockStorage.createFromSummary(summary);
+    const client2 = new TestClient(options);
+    const runtime = {
+        logger: client2.logger,
+        clientId: "1",
+    };
+    const { catchupOpsP } = await client2.load(runtime, services, new TestSerializer());
+    await catchupOpsP;
+    return client2;
+}
+// Wrapper around MergeTree client that provides a convenient SharedString-like API for tests.
+export class TestString {
+    constructor(id, options, initialState = "") {
+        this.options = options;
+        this.pending = [];
+        this.seq = 0;
+        this.minSeq = 0;
+        this.client = createClientsAtInitialState({ initialState, options }, id)[id];
+        this.client.startOrUpdateCollaboration(id);
+    }
+    insert(pos, text, increaseMsn) {
+        this.queue(this.client.insertTextLocal(pos, text, { segment: this.pending.length }), increaseMsn);
+    }
+    annotate(start, end, props, increaseMsn) {
+        this.queue(this.client.annotateRangeLocal(start, end, props), increaseMsn);
+    }
+    append(text, increaseMsn) {
+        this.insert(this.client.getLength(), text, increaseMsn);
+    }
+    insertMarker(pos, increaseMsn) {
+        this.queue(this.client.insertMarkerLocal(pos, ReferenceType.Simple, {
+            segment: this.pending.length,
+        }), increaseMsn);
+    }
+    appendMarker(increaseMsn) {
+        this.insertMarker(this.client.getLength(), increaseMsn);
+    }
+    removeRange(start, end, increaseMsn) {
+        this.queue(this.client.removeRangeLocal(start, end), increaseMsn);
+    }
+    obliterateRange(start, end, increaseMsn) {
+        this.queue(this.client.obliterateRangeLocal(start, end), increaseMsn);
+    }
+    // Ensures the client's text matches the `expected` string and round-trips through a snapshot
+    // into a new client.  The current client is then replaced with the loaded client in the hope
+    // that it will help detect corruption bugs as further ops are applied.
+    async expect(expected) {
+        assert.equal(this.client.getText(), expected, "MergeTree must contain the expected text prior to applying ops.");
+        await this.checkSnapshot(this.options);
+    }
+    // Ensures the MergeTree client's contents successfully roundtrip through a snapshot.
+    async checkSnapshot(options) {
+        this.applyPendingOps();
+        const expectedAttributionKeys = this.client.getAllAttributionSeqs();
+        const summary = this.getSummary();
+        const client2 = await loadSnapshot(summary, options ?? this.options);
+        assert.equal(this.client.getText(), client2.getText(), "Snapshot must produce a MergeTree with the same text as the original");
+        // Also check the length as weak test for non-TextSegments.
+        assert.equal(this.client.getLength(), client2.getLength(), "Snapshot must produce a MergeTree with the same length as the original");
+        const actualAttributionKeys = client2.getAllAttributionSeqs();
+        assert.deepEqual(actualAttributionKeys, expectedAttributionKeys, "Snapshot must produce a MergeTree with identical attribution as the original");
+        // Replace our client with the one loaded by the snapshot.
+        this.client = client2;
+    }
+    getSummary() {
+        const snapshot = new SnapshotV1(this.client.mergeTree, this.client.logger, (id) => this.client.getLongClientId(id));
+        snapshot.extractSync();
+        return snapshot.emit(TestClient.serializer, undefined).summary;
+    }
+    getText() {
+        return this.client.getText();
+    }
+    applyPendingOps() {
+        for (const msg of this.pending) {
+            this.client.applyMsg(msg);
+        }
+        this.pending.splice(0, this.pending.length);
+    }
+    queue(op, increaseMsn) {
+        const refSeq = this.seq;
+        const seq = ++this.seq;
+        this.pending.push(this.client.makeOpMessage(op, seq, refSeq, this.client.longClientId, (this.minSeq = increaseMsn ? seq : this.minSeq)));
+    }
+    getSegment(pos) {
+        const { segment } = this.client.getContainingSegment(pos);
+        assert(segment !== undefined);
+        return segment;
+    }
+}
+//# sourceMappingURL=snapshot.utils.js.map

package/lib/test/snapshot.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.utils.js","sourceRoot":"","sources":["../../src/test/snapshot.utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,6DAA6D;AAE7D,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AACjE,OAAO,EAAgB,aAAa,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAI9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,kDAAkD;AAClD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAqB,EAAE,OAA2B;IACpF,MAAM,QAAQ,GAAG,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,OAAO,GAAoC;QAChD,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,GAAG;KACb,CAAC;IAEF,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,OAAO,CAAC,IAAI,CACzC,OAAiC,EACjC,QAAQ,EACR,IAAI,cAAc,EAAE,CACpB,CAAC;IACF,MAAM,WAAW,CAAC;IAClB,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,8FAA8F;AAC9F,MAAM,OAAO,UAAU;IAMtB,YACC,EAAU,EACO,OAA2B,EAC5C,eAAuB,EAAE;QADR,YAAO,GAAP,OAAO,CAAoB;QAN5B,YAAO,GAAgC,EAAE,CAAC;QACnD,QAAG,GAAG,CAAC,CAAC;QACR,WAAM,GAAG,CAAC,CAAC;QAOlB,IAAI,CAAC,MAAM,GAAG,2BAA2B,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7E,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,GAAW,EAAE,IAAY,EAAE,WAAoB;QAC5D,IAAI,CAAC,KAAK,CACT,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAE,EACzE,WAAW,CACX,CAAC;IACH,CAAC;IAEM,QAAQ,CAAC,KAAa,EAAE,GAAW,EAAE,KAAkB,EAAE,WAAoB;QACnF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAE,EAAE,WAAW,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,IAAY,EAAE,WAAoB;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAEM,YAAY,CAAC,GAAW,EAAE,WAAoB;QACpD,IAAI,CAAC,KAAK,CACT,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE,aAAa,CAAC,MAAM,EAAE;YACxD,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;SAC5B,CAAE,EACH,WAAW,CACX,CAAC;IACH,CAAC;IAEM,YAAY,CAAC,WAAoB;QACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAEM,WAAW,CAAC,KAAa,EAAE,GAAW,EAAE,WAAoB;QAClE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAE,EAAE,WAAW,CAAC,CAAC;IACpE,CAAC;IAEM,eAAe,CAAC,KAAa,EAAE,GAAW,EAAE,WAAoB;QACtE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAE,EAAE,WAAW,CAAC,CAAC;IACxE,CAAC;IAED,6FAA6F;IAC7F,6FAA6F;IAC7F,uEAAuE;IAChE,KAAK,CAAC,MAAM,CAAC,QAAgB;QACnC,MAAM,CAAC,KAAK,CACX,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EACrB,QAAQ,EACR,iEAAiE,CACjE,CAAC;QAEF,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,qFAAqF;IAC9E,KAAK,CAAC,aAAa,CAAC,OAA2B;QACrD,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QAErE,MAAM,CAAC,KAAK,CACX,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EACrB,OAAO,CAAC,OAAO,EAAE,EACjB,sEAAsE,CACtE,CAAC;QAEF,2DAA2D;QAC3D,MAAM,CAAC,KAAK,CACX,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EACvB,OAAO,CAAC,SAAS,EAAE,EACnB,wEAAwE,CACxE,CAAC;QAEF,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAC9D,MAAM,CAAC,SAAS,CACf,qBAAqB,EACrB,uBAAuB,EACvB,8EAA8E,CAC9E,CAAC;QAEF,0DAA0D;QAC1D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;IACvB,CAAC;IAEM,UAAU;QAChB,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CACjF,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAC/B,CAAC;QAEF,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvB,OAAO,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,SAAU,CAAC,CAAC,OAAO,CAAC;IACjE,CAAC;IAEM,OAAO;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC9B,CAAC;IAEM,eAAe;QACrB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SAC1B;QACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,EAAgB,EAAE,WAAoB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC;QACxB,MAAM,GAAG,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC;QAEvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAChB,IAAI,CAAC,MAAM,CAAC,aAAa,CACxB,EAAE,EACF,GAAG,EACH,MAAM,EACN,IAAI,CAAC,MAAM,CAAC,YAAY,EACxB,CAAC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAC/C,CACD,CAAC;IACH,CAAC;IAEM,UAAU,CAAC,GAAW;QAC5B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC1D,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;QAC9B,OAAO,OAAO,CAAC;IAChB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @typescript-eslint/no-non-null-assertion */\n\nimport { strict as assert } from \"assert\";\nimport { ISequencedDocumentMessage, ISummaryTree } from \"@fluidframework/protocol-definitions\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { MockStorage } from \"@fluidframework/test-runtime-utils\";\nimport { IMergeTreeOp, ReferenceType } from \"../ops.js\";\nimport { SnapshotV1 } from \"../snapshotV1.js\";\nimport { IMergeTreeOptions } from \"../mergeTree.js\";\nimport { PropertySet } from \"../properties.js\";\nimport { ISegment } from \"../mergeTreeNodes.js\";\nimport { createClientsAtInitialState } from \"./testClientLogger.js\";\nimport { TestSerializer } from \"./testSerializer.js\";\nimport { TestClient } from \"./testClient.js\";\n\n// Reconstitutes a MergeTree client from a summary\nexport async function loadSnapshot(summary: ISummaryTree, options?: IMergeTreeOptions) {\n\tconst services = MockStorage.createFromSummary(summary);\n\tconst client2 = new TestClient(options);\n\tconst runtime: Partial<IFluidDataStoreRuntime> = {\n\t\tlogger: client2.logger,\n\t\tclientId: \"1\",\n\t};\n\n\tconst { catchupOpsP } = await client2.load(\n\t\truntime as IFluidDataStoreRuntime,\n\t\tservices,\n\t\tnew TestSerializer(),\n\t);\n\tawait catchupOpsP;\n\treturn client2;\n}\n\n// Wrapper around MergeTree client that provides a convenient SharedString-like API for tests.\nexport class TestString {\n\tprivate client: TestClient;\n\tprivate readonly pending: ISequencedDocumentMessage[] = [];\n\tprivate seq = 0;\n\tprivate minSeq = 0;\n\n\tconstructor(\n\t\tid: string,\n\t\tprivate readonly options?: IMergeTreeOptions,\n\t\tinitialState: string = \"\",\n\t) {\n\t\tthis.client = createClientsAtInitialState({ initialState, options }, id)[id];\n\t\tthis.client.startOrUpdateCollaboration(id);\n\t}\n\n\tpublic insert(pos: number, text: string, increaseMsn: boolean) {\n\t\tthis.queue(\n\t\t\tthis.client.insertTextLocal(pos, text, { segment: this.pending.length })!,\n\t\t\tincreaseMsn,\n\t\t);\n\t}\n\n\tpublic annotate(start: number, end: number, props: PropertySet, increaseMsn: boolean) {\n\t\tthis.queue(this.client.annotateRangeLocal(start, end, props)!, increaseMsn);\n\t}\n\n\tpublic append(text: string, increaseMsn: boolean) {\n\t\tthis.insert(this.client.getLength(), text, increaseMsn);\n\t}\n\n\tpublic insertMarker(pos: number, increaseMsn: boolean) {\n\t\tthis.queue(\n\t\t\tthis.client.insertMarkerLocal(pos, ReferenceType.Simple, {\n\t\t\t\tsegment: this.pending.length,\n\t\t\t})!,\n\t\t\tincreaseMsn,\n\t\t);\n\t}\n\n\tpublic appendMarker(increaseMsn: boolean) {\n\t\tthis.insertMarker(this.client.getLength(), increaseMsn);\n\t}\n\n\tpublic removeRange(start: number, end: number, increaseMsn: boolean) {\n\t\tthis.queue(this.client.removeRangeLocal(start, end)!, increaseMsn);\n\t}\n\n\tpublic obliterateRange(start: number, end: number, increaseMsn: boolean) {\n\t\tthis.queue(this.client.obliterateRangeLocal(start, end)!, increaseMsn);\n\t}\n\n\t// Ensures the client's text matches the `expected` string and round-trips through a snapshot\n\t// into a new client.  The current client is then replaced with the loaded client in the hope\n\t// that it will help detect corruption bugs as further ops are applied.\n\tpublic async expect(expected: string) {\n\t\tassert.equal(\n\t\t\tthis.client.getText(),\n\t\t\texpected,\n\t\t\t\"MergeTree must contain the expected text prior to applying ops.\",\n\t\t);\n\n\t\tawait this.checkSnapshot(this.options);\n\t}\n\n\t// Ensures the MergeTree client's contents successfully roundtrip through a snapshot.\n\tpublic async checkSnapshot(options?: IMergeTreeOptions) {\n\t\tthis.applyPendingOps();\n\t\tconst expectedAttributionKeys = this.client.getAllAttributionSeqs();\n\t\tconst summary = this.getSummary();\n\t\tconst client2 = await loadSnapshot(summary, options ?? this.options);\n\n\t\tassert.equal(\n\t\t\tthis.client.getText(),\n\t\t\tclient2.getText(),\n\t\t\t\"Snapshot must produce a MergeTree with the same text as the original\",\n\t\t);\n\n\t\t// Also check the length as weak test for non-TextSegments.\n\t\tassert.equal(\n\t\t\tthis.client.getLength(),\n\t\t\tclient2.getLength(),\n\t\t\t\"Snapshot must produce a MergeTree with the same length as the original\",\n\t\t);\n\n\t\tconst actualAttributionKeys = client2.getAllAttributionSeqs();\n\t\tassert.deepEqual(\n\t\t\tactualAttributionKeys,\n\t\t\texpectedAttributionKeys,\n\t\t\t\"Snapshot must produce a MergeTree with identical attribution as the original\",\n\t\t);\n\n\t\t// Replace our client with the one loaded by the snapshot.\n\t\tthis.client = client2;\n\t}\n\n\tpublic getSummary(): ISummaryTree {\n\t\tconst snapshot = new SnapshotV1(this.client.mergeTree, this.client.logger, (id) =>\n\t\t\tthis.client.getLongClientId(id),\n\t\t);\n\n\t\tsnapshot.extractSync();\n\t\treturn snapshot.emit(TestClient.serializer, undefined!).summary;\n\t}\n\n\tpublic getText() {\n\t\treturn this.client.getText();\n\t}\n\n\tpublic applyPendingOps() {\n\t\tfor (const msg of this.pending) {\n\t\t\tthis.client.applyMsg(msg);\n\t\t}\n\t\tthis.pending.splice(0, this.pending.length);\n\t}\n\n\tprivate queue(op: IMergeTreeOp, increaseMsn: boolean) {\n\t\tconst refSeq = this.seq;\n\t\tconst seq = ++this.seq;\n\n\t\tthis.pending.push(\n\t\t\tthis.client.makeOpMessage(\n\t\t\t\top,\n\t\t\t\tseq,\n\t\t\t\trefSeq,\n\t\t\t\tthis.client.longClientId,\n\t\t\t\t(this.minSeq = increaseMsn ? seq : this.minSeq),\n\t\t\t),\n\t\t);\n\t}\n\n\tpublic getSegment(pos: number): ISegment {\n\t\tconst { segment } = this.client.getContainingSegment(pos);\n\t\tassert(segment !== undefined);\n\t\treturn segment;\n\t}\n}\n"]}

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

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

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

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

package/lib/test/snapshotlegacy.spec.js

@@ -0,0 +1,137 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+import { strict as assert } from "assert";
+import { MockStorage } from "@fluidframework/test-runtime-utils";
+import { SnapshotLegacy } from "../snapshotlegacy.js";
+import { createInsertOnlyAttributionPolicy, createPropertyTrackingAndInsertionAttributionPolicyFactory, } from "../attributionPolicy.js";
+import { TestSerializer } from "./testSerializer.js";
+import { createClientsAtInitialState } from "./testClientLogger.js";
+import { TestClient } from "./testClient.js";
+describe("snapshot", () => {
+    it("header only", async () => {
+        const client1 = new TestClient();
+        client1.startOrUpdateCollaboration("0");
+        for (let i = 0; i < SnapshotLegacy.sizeOfFirstChunk; i++) {
+            const op = client1.insertTextLocal(client1.getLength(), `${i % 10}`, { segment: i });
+            const msg = client1.makeOpMessage(op, i + 1);
+            msg.minimumSequenceNumber = i + 1;
+            client1.applyMsg(msg);
+        }
+        const serializer = new TestSerializer();
+        const snapshot = new SnapshotLegacy(client1.mergeTree, client1.logger);
+        snapshot.extractSync();
+        const summaryTree = snapshot.emit([], serializer, undefined);
+        const services = MockStorage.createFromSummary(summaryTree.summary);
+        const client2 = new TestClient(undefined);
+        const runtime = {
+            logger: client2.logger,
+            clientId: "1",
+        };
+        await client2.load(runtime, services, serializer);
+        assert.equal(client2.getLength(), client1.getLength());
+        assert.equal(client2.getText(), client1.getText());
+    }).timeout(5000);
+    it("header and body", async () => {
+        const clients = [new TestClient(), new TestClient(), new TestClient()];
+        clients[0].startOrUpdateCollaboration("0");
+        for (let i = 0; i < SnapshotLegacy.sizeOfFirstChunk + 10; i++) {
+            const op = clients[0].insertTextLocal(clients[0].getLength(), `${i % 10}`, {
+                segment: i,
+            });
+            const msg = clients[0].makeOpMessage(op, i + 1);
+            msg.minimumSequenceNumber = i + 1;
+            clients[0].applyMsg(msg);
+        }
+        const serializer = new TestSerializer();
+        for (let i = 0; i < clients.length - 1; i++) {
+            const client1 = clients[i];
+            const client2 = clients[i + 1];
+            const snapshot = new SnapshotLegacy(client1.mergeTree, client1.logger);
+            snapshot.extractSync();
+            const summaryTree = snapshot.emit([], serializer, undefined);
+            const services = MockStorage.createFromSummary(summaryTree.summary);
+            const runtime = {
+                logger: client2.logger,
+                clientId: (i + 1).toString(),
+            };
+            await client2.load(runtime, services, serializer);
+            const client2Len = client2.getLength();
+            assert.equal(client2Len, client1.getLength(), `client${client2.longClientId} and client${client1.longClientId} lengths don't match`);
+            assert.equal(client2.getText(SnapshotLegacy.sizeOfFirstChunk - 1), client1.getText(SnapshotLegacy.sizeOfFirstChunk - 1));
+        }
+    }).timeout(5000);
+    async function assertAttributionKeysMatch(client, expected) {
+        assert.deepEqual(client.getAllAttributionSeqs(), expected.root, "Keys don't match before round-tripping");
+        for (const [channel, channelExpectation] of Object.entries(expected.channels ?? {})) {
+            assert.deepEqual(client.getAllAttributionSeqs(channel), channelExpectation, `Keys for channel ${channel} don't match before round-trip.`);
+        }
+        const serializer = new TestSerializer();
+        // This avoids necessitating handling catchup ops.
+        client.mergeTree.setMinSeq(client.mergeTree.collabWindow.currentSeq);
+        const snapshot = new SnapshotLegacy(client.mergeTree, client.logger);
+        snapshot.extractSync();
+        const summaryTree = snapshot.emit([], serializer, undefined);
+        const services = MockStorage.createFromSummary(summaryTree.summary);
+        const roundTripClient = new TestClient({
+            attribution: {
+                track: true,
+                policyFactory: createInsertOnlyAttributionPolicy,
+            },
+        });
+        const runtime = {
+            logger: roundTripClient.logger,
+            clientId: "round-trips summary",
+        };
+        await roundTripClient.load(runtime, services, serializer);
+        assert.deepEqual(roundTripClient.getAllAttributionSeqs(), expected.root, "Keys don't match after round-tripping");
+        for (const [channel, channelExpectation] of Object.entries(expected.channels ?? {})) {
+            assert.deepEqual(roundTripClient.getAllAttributionSeqs(channel), channelExpectation, `Keys for channel ${channel} don't match after round-trip.`);
+        }
+    }
+    it("preserves attribution information", async () => {
+        const clients = createClientsAtInitialState({
+            initialState: "",
+            options: {
+                attribution: {
+                    track: true,
+                    policyFactory: createPropertyTrackingAndInsertionAttributionPolicyFactory("foo"),
+                },
+            },
+        }, "A", "B");
+        const ops = [];
+        const applyAllOps = () => ops.splice(0).forEach((op) => clients.all.map((client) => client.applyMsg(op)));
+        ops.push(clients.A.makeOpMessage(clients.A.insertTextLocal(0, "hello world"), /* seq */ 1));
+        applyAllOps();
+        ops.push(clients.B.makeOpMessage(clients.B.insertTextLocal(6, "new "), 
+        /* seq */ 2, 
+        /* refSeq */ 1));
+        ops.push(clients.B.makeOpMessage(clients.B.annotateRangeLocal(0, 14, { foo: "bar" }), 
+        /* seq */ 3, 
+        /* refSeq */ 2));
+        applyAllOps();
+        await assertAttributionKeysMatch(clients.A, {
+            // "hello " has key 1 (i.e. seq 1), "new " has key 2 (i.e. seq 2), "world" has key 1.
+            root: [1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 1, 1, 1, 1, 1],
+            channels: {
+                foo: Array.from({ length: "hello new world".length }, (_, i) => i < 14 ? 3 : undefined),
+            },
+        });
+    });
+    it("doesn't include attribution information when attribution tracking is false on doc creation", async () => {
+        const clients = createClientsAtInitialState({
+            initialState: "",
+            options: { attribution: { track: false } },
+        }, "A");
+        const ops = [];
+        const applyAllOps = () => ops.splice(0).forEach((op) => clients.all.map((client) => client.applyMsg(op)));
+        ops.push(clients.A.makeOpMessage(clients.A.insertTextLocal(0, "hello world"), /* seq */ 1));
+        applyAllOps();
+        await assertAttributionKeysMatch(clients.A, {
+            root: Array.from({ length: "hello world".length }, () => undefined),
+        });
+    });
+});
+//# sourceMappingURL=snapshotlegacy.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotlegacy.spec.js","sourceRoot":"","sources":["../../src/test/snapshotlegacy.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,6DAA6D;AAE7D,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EACN,iCAAiC,EACjC,0DAA0D,GAC1D,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QAC5B,MAAM,OAAO,GAAG,IAAI,UAAU,EAAE,CAAC;QACjC,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,gBAAgB,EAAE,CAAC,EAAE,EAAE;YACzD,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YACrF,MAAM,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7C,GAAG,CAAC,qBAAqB,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,MAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAC;QAExC,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACvE,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,EAAE,SAAU,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEpE,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAoC;YAChD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,GAAG;SACb,CAAC;QACF,MAAM,OAAO,CAAC,IAAI,CAAC,OAAiC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QAE5E,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QACvD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,OAAO,GAAG,CAAC,IAAI,UAAU,EAAE,EAAE,IAAI,UAAU,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC,CAAC;QACvE,OAAO,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,gBAAgB,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAC9D,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE;gBAC1E,OAAO,EAAE,CAAC;aACV,CAAE,CAAC;YACJ,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAChD,GAAG,CAAC,qBAAqB,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACzB;QAED,MAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACvE,QAAQ,CAAC,WAAW,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,EAAE,SAAU,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACpE,MAAM,OAAO,GAAoC;gBAChD,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;aAC5B,CAAC;YACF,MAAM,OAAO,CAAC,IAAI,CAAC,OAAiC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;YAE5E,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;YACvC,MAAM,CAAC,KAAK,CACX,UAAU,EACV,OAAO,CAAC,SAAS,EAAE,EACnB,SAAS,OAAO,CAAC,YAAY,cAAc,OAAO,CAAC,YAAY,sBAAsB,CACrF,CAAC;YAEF,MAAM,CAAC,KAAK,CACX,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,GAAG,CAAC,CAAC,EACpD,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,gBAAgB,GAAG,CAAC,CAAC,CACpD,CAAC;SACF;IACF,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,KAAK,UAAU,0BAA0B,CACxC,MAAkB,EAClB,QAGC;QAED,MAAM,CAAC,SAAS,CACf,MAAM,CAAC,qBAAqB,EAAE,EAC9B,QAAQ,CAAC,IAAI,EACb,wCAAwC,CACxC,CAAC;QACF,KAAK,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE;YACpF,MAAM,CAAC,SAAS,CACf,MAAM,CAAC,qBAAqB,CAAC,OAAO,CAAC,EACrC,kBAAkB,EAClB,oBAAoB,OAAO,iCAAiC,CAC5D,CAAC;SACF;QACD,MAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAC;QACxC,kDAAkD;QAClD,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACrE,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,EAAE,SAAU,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEpE,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC;YACtC,WAAW,EAAE;gBACZ,KAAK,EAAE,IAAI;gBACX,aAAa,EAAE,iCAAiC;aAChD;SACD,CAAC,CAAC;QACH,MAAM,OAAO,GAAoC;YAChD,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,QAAQ,EAAE,qBAAqB;SAC/B,CAAC;QACF,MAAM,eAAe,CAAC,IAAI,CAAC,OAAiC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACpF,MAAM,CAAC,SAAS,CACf,eAAe,CAAC,qBAAqB,EAAE,EACvC,QAAQ,CAAC,IAAI,EACb,uCAAuC,CACvC,CAAC;QACF,KAAK,MAAM,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE;YACpF,MAAM,CAAC,SAAS,CACf,eAAe,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAC9C,kBAAkB,EAClB,oBAAoB,OAAO,gCAAgC,CAC3D,CAAC;SACF;IACF,CAAC;IAED,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,OAAO,GAAG,2BAA2B,CAC1C;YACC,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE;gBACR,WAAW,EAAE;oBACZ,KAAK,EAAE,IAAI;oBACX,aAAa,EACZ,0DAA0D,CAAC,KAAK,CAAC;iBAClE;aACD;SACD,EACD,GAAG,EACH,GAAG,CACH,CAAC;QAEF,MAAM,GAAG,GAAgC,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,GAAG,EAAE,CACxB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5F,WAAW,EAAE,CAAC;QAEd,GAAG,CAAC,IAAI,CACP,OAAO,CAAC,CAAC,CAAC,aAAa,CACtB,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,MAAM,CAAC;QACpC,SAAS,CAAC,CAAC;QACX,YAAY,CAAC,CAAC,CACd,CACD,CAAC;QAEF,GAAG,CAAC,IAAI,CACP,OAAO,CAAC,CAAC,CAAC,aAAa,CACtB,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACnD,SAAS,CAAC,CAAC;QACX,YAAY,CAAC,CAAC,CACd,CACD,CAAC;QAEF,WAAW,EAAE,CAAC;QAEd,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC,EAAE;YAC3C,qFAAqF;YACrF,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACnD,QAAQ,EAAE;gBACT,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAC9D,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CACtB;aACD;SACD,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;QAC3G,MAAM,OAAO,GAAG,2BAA2B,CAC1C;YACC,YAAY,EAAE,EAAE;YAChB,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;SAC1C,EACD,GAAG,CACH,CAAC;QAEF,MAAM,GAAG,GAAgC,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,GAAG,EAAE,CACxB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjF,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5F,WAAW,EAAE,CAAC;QAEd,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC,EAAE;YAC3C,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC;SACnE,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n/* eslint-disable @typescript-eslint/no-non-null-assertion */\n\nimport { strict as assert } from \"assert\";\nimport { IFluidDataStoreRuntime } from \"@fluidframework/datastore-definitions\";\nimport { MockStorage } from \"@fluidframework/test-runtime-utils\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/protocol-definitions\";\nimport { SnapshotLegacy } from \"../snapshotlegacy.js\";\nimport {\n\tcreateInsertOnlyAttributionPolicy,\n\tcreatePropertyTrackingAndInsertionAttributionPolicyFactory,\n} from \"../attributionPolicy.js\";\nimport { TestSerializer } from \"./testSerializer.js\";\nimport { createClientsAtInitialState } from \"./testClientLogger.js\";\nimport { TestClient } from \"./testClient.js\";\n\ndescribe(\"snapshot\", () => {\n\tit(\"header only\", async () => {\n\t\tconst client1 = new TestClient();\n\t\tclient1.startOrUpdateCollaboration(\"0\");\n\t\tfor (let i = 0; i < SnapshotLegacy.sizeOfFirstChunk; i++) {\n\t\t\tconst op = client1.insertTextLocal(client1.getLength(), `${i % 10}`, { segment: i });\n\t\t\tconst msg = client1.makeOpMessage(op, i + 1);\n\t\t\tmsg.minimumSequenceNumber = i + 1;\n\t\t\tclient1.applyMsg(msg);\n\t\t}\n\n\t\tconst serializer = new TestSerializer();\n\n\t\tconst snapshot = new SnapshotLegacy(client1.mergeTree, client1.logger);\n\t\tsnapshot.extractSync();\n\t\tconst summaryTree = snapshot.emit([], serializer, undefined!);\n\t\tconst services = MockStorage.createFromSummary(summaryTree.summary);\n\n\t\tconst client2 = new TestClient(undefined);\n\t\tconst runtime: Partial<IFluidDataStoreRuntime> = {\n\t\t\tlogger: client2.logger,\n\t\t\tclientId: \"1\",\n\t\t};\n\t\tawait client2.load(runtime as IFluidDataStoreRuntime, services, serializer);\n\n\t\tassert.equal(client2.getLength(), client1.getLength());\n\t\tassert.equal(client2.getText(), client1.getText());\n\t}).timeout(5000);\n\n\tit(\"header and body\", async () => {\n\t\tconst clients = [new TestClient(), new TestClient(), new TestClient()];\n\t\tclients[0].startOrUpdateCollaboration(\"0\");\n\t\tfor (let i = 0; i < SnapshotLegacy.sizeOfFirstChunk + 10; i++) {\n\t\t\tconst op = clients[0].insertTextLocal(clients[0].getLength(), `${i % 10}`, {\n\t\t\t\tsegment: i,\n\t\t\t})!;\n\t\t\tconst msg = clients[0].makeOpMessage(op, i + 1);\n\t\t\tmsg.minimumSequenceNumber = i + 1;\n\t\t\tclients[0].applyMsg(msg);\n\t\t}\n\n\t\tconst serializer = new TestSerializer();\n\t\tfor (let i = 0; i < clients.length - 1; i++) {\n\t\t\tconst client1 = clients[i];\n\t\t\tconst client2 = clients[i + 1];\n\t\t\tconst snapshot = new SnapshotLegacy(client1.mergeTree, client1.logger);\n\t\t\tsnapshot.extractSync();\n\t\t\tconst summaryTree = snapshot.emit([], serializer, undefined!);\n\t\t\tconst services = MockStorage.createFromSummary(summaryTree.summary);\n\t\t\tconst runtime: Partial<IFluidDataStoreRuntime> = {\n\t\t\t\tlogger: client2.logger,\n\t\t\t\tclientId: (i + 1).toString(),\n\t\t\t};\n\t\t\tawait client2.load(runtime as IFluidDataStoreRuntime, services, serializer);\n\n\t\t\tconst client2Len = client2.getLength();\n\t\t\tassert.equal(\n\t\t\t\tclient2Len,\n\t\t\t\tclient1.getLength(),\n\t\t\t\t`client${client2.longClientId} and client${client1.longClientId} lengths don't match`,\n\t\t\t);\n\n\t\t\tassert.equal(\n\t\t\t\tclient2.getText(SnapshotLegacy.sizeOfFirstChunk - 1),\n\t\t\t\tclient1.getText(SnapshotLegacy.sizeOfFirstChunk - 1),\n\t\t\t);\n\t\t}\n\t}).timeout(5000);\n\n\tasync function assertAttributionKeysMatch(\n\t\tclient: TestClient,\n\t\texpected: {\n\t\t\troot: (number | undefined)[];\n\t\t\tchannels?: { [name: string]: (number | undefined)[] };\n\t\t},\n\t): Promise<void> {\n\t\tassert.deepEqual(\n\t\t\tclient.getAllAttributionSeqs(),\n\t\t\texpected.root,\n\t\t\t\"Keys don't match before round-tripping\",\n\t\t);\n\t\tfor (const [channel, channelExpectation] of Object.entries(expected.channels ?? {})) {\n\t\t\tassert.deepEqual(\n\t\t\t\tclient.getAllAttributionSeqs(channel),\n\t\t\t\tchannelExpectation,\n\t\t\t\t`Keys for channel ${channel} don't match before round-trip.`,\n\t\t\t);\n\t\t}\n\t\tconst serializer = new TestSerializer();\n\t\t// This avoids necessitating handling catchup ops.\n\t\tclient.mergeTree.setMinSeq(client.mergeTree.collabWindow.currentSeq);\n\t\tconst snapshot = new SnapshotLegacy(client.mergeTree, client.logger);\n\t\tsnapshot.extractSync();\n\t\tconst summaryTree = snapshot.emit([], serializer, undefined!);\n\t\tconst services = MockStorage.createFromSummary(summaryTree.summary);\n\n\t\tconst roundTripClient = new TestClient({\n\t\t\tattribution: {\n\t\t\t\ttrack: true,\n\t\t\t\tpolicyFactory: createInsertOnlyAttributionPolicy,\n\t\t\t},\n\t\t});\n\t\tconst runtime: Partial<IFluidDataStoreRuntime> = {\n\t\t\tlogger: roundTripClient.logger,\n\t\t\tclientId: \"round-trips summary\",\n\t\t};\n\t\tawait roundTripClient.load(runtime as IFluidDataStoreRuntime, services, serializer);\n\t\tassert.deepEqual(\n\t\t\troundTripClient.getAllAttributionSeqs(),\n\t\t\texpected.root,\n\t\t\t\"Keys don't match after round-tripping\",\n\t\t);\n\t\tfor (const [channel, channelExpectation] of Object.entries(expected.channels ?? {})) {\n\t\t\tassert.deepEqual(\n\t\t\t\troundTripClient.getAllAttributionSeqs(channel),\n\t\t\t\tchannelExpectation,\n\t\t\t\t`Keys for channel ${channel} don't match after round-trip.`,\n\t\t\t);\n\t\t}\n\t}\n\n\tit(\"preserves attribution information\", async () => {\n\t\tconst clients = createClientsAtInitialState(\n\t\t\t{\n\t\t\t\tinitialState: \"\",\n\t\t\t\toptions: {\n\t\t\t\t\tattribution: {\n\t\t\t\t\t\ttrack: true,\n\t\t\t\t\t\tpolicyFactory:\n\t\t\t\t\t\t\tcreatePropertyTrackingAndInsertionAttributionPolicyFactory(\"foo\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\t\"A\",\n\t\t\t\"B\",\n\t\t);\n\n\t\tconst ops: ISequencedDocumentMessage[] = [];\n\t\tconst applyAllOps = () =>\n\t\t\tops.splice(0).forEach((op) => clients.all.map((client) => client.applyMsg(op)));\n\n\t\tops.push(clients.A.makeOpMessage(clients.A.insertTextLocal(0, \"hello world\"), /* seq */ 1));\n\n\t\tapplyAllOps();\n\n\t\tops.push(\n\t\t\tclients.B.makeOpMessage(\n\t\t\t\tclients.B.insertTextLocal(6, \"new \"),\n\t\t\t\t/* seq */ 2,\n\t\t\t\t/* refSeq */ 1,\n\t\t\t),\n\t\t);\n\n\t\tops.push(\n\t\t\tclients.B.makeOpMessage(\n\t\t\t\tclients.B.annotateRangeLocal(0, 14, { foo: \"bar\" }),\n\t\t\t\t/* seq */ 3,\n\t\t\t\t/* refSeq */ 2,\n\t\t\t),\n\t\t);\n\n\t\tapplyAllOps();\n\n\t\tawait assertAttributionKeysMatch(clients.A, {\n\t\t\t// \"hello \" has key 1 (i.e. seq 1), \"new \" has key 2 (i.e. seq 2), \"world\" has key 1.\n\t\t\troot: [1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 1, 1, 1, 1, 1],\n\t\t\tchannels: {\n\t\t\t\tfoo: Array.from({ length: \"hello new world\".length }, (_, i) =>\n\t\t\t\t\ti < 14 ? 3 : undefined,\n\t\t\t\t),\n\t\t\t},\n\t\t});\n\t});\n\n\tit(\"doesn't include attribution information when attribution tracking is false on doc creation\", async () => {\n\t\tconst clients = createClientsAtInitialState(\n\t\t\t{\n\t\t\t\tinitialState: \"\",\n\t\t\t\toptions: { attribution: { track: false } },\n\t\t\t},\n\t\t\t\"A\",\n\t\t);\n\n\t\tconst ops: ISequencedDocumentMessage[] = [];\n\t\tconst applyAllOps = () =>\n\t\t\tops.splice(0).forEach((op) => clients.all.map((client) => client.applyMsg(op)));\n\n\t\tops.push(clients.A.makeOpMessage(clients.A.insertTextLocal(0, \"hello world\"), /* seq */ 1));\n\n\t\tapplyAllOps();\n\n\t\tawait assertAttributionKeysMatch(clients.A, {\n\t\t\troot: Array.from({ length: \"hello world\".length }, () => undefined),\n\t\t});\n\t});\n});\n"]}

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

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

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

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