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

package/lib/test/attributionCollection.perf.spec.js

@@ -0,0 +1,229 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "assert";
+import { benchmark, BenchmarkType } from "@fluid-tools/benchmark";
+import { areEqualAttributionKeys, AttributionCollection as NewAttributionCollection, } from "../attributionCollection.js";
+import { TextSegmentGranularity } from "../textSegment.js";
+import { compareNumbers } from "../mergeTreeNodes.js";
+import { RedBlackTree } from "../collections/index.js";
+function getCollectionSizes(ctor, baseSuiteType) {
+    const singleKeyCollection = new ctor(5, { type: "op", seq: 42 });
+    const tenKeyCollection = new ctor(2, { type: "op", seq: 0 });
+    for (let i = 1; i < 10; i++) {
+        tenKeyCollection.append(new ctor(3 * i, { type: "op", seq: i }));
+    }
+    const maxSizeCollection = new ctor(1, { type: "op", seq: 0 });
+    for (let i = 1; i < TextSegmentGranularity; i++) {
+        maxSizeCollection.append(new ctor(1, { type: "op", seq: i }));
+    }
+    return [
+        { name: "one key", collection: singleKeyCollection, type: BenchmarkType.Diagnostic },
+        { name: "ten keys", collection: tenKeyCollection, type: baseSuiteType },
+        { name: "maximum keys", collection: maxSizeCollection, type: BenchmarkType.Diagnostic },
+    ];
+}
+function runAttributionCollectionSuite(ctor, suiteBaseType) {
+    const collectionTestCases = getCollectionSizes(ctor, suiteBaseType);
+    for (const { name, collection, type } of collectionTestCases) {
+        describe(`using a collection with ${name}`, () => {
+            const { length } = collection;
+            benchmark({
+                title: "getAtOffset at the start",
+                benchmarkFn: () => collection.getAtOffset(0),
+                type,
+            });
+            benchmark({
+                title: "getAtOffset at the end",
+                benchmarkFn: () => collection.getAtOffset(length - 1),
+                type,
+            });
+            benchmark({
+                title: "getAtOffset in the middle",
+                benchmarkFn: () => collection.getAtOffset(length / 2),
+                type: BenchmarkType.Diagnostic,
+            });
+            benchmark({
+                title: "getAll",
+                benchmarkFn: () => collection.getAll(),
+                type,
+            });
+            benchmark({
+                title: "clone",
+                benchmarkFn: () => collection.clone(),
+                type,
+            });
+            benchmark({
+                title: "split + append in the middle",
+                benchmarkFn: () => {
+                    const split = collection.splitAt(length / 2);
+                    collection.append(split);
+                },
+                type,
+            });
+        });
+    }
+    benchmark({
+        title: "construction",
+        benchmarkFn: () => new ctor(42, { type: "op", seq: 5 }),
+        type: suiteBaseType,
+    });
+    const segmentsToSerialize = collectionTestCases.map(({ collection }) => ({
+        attribution: collection,
+        cachedLength: collection.length,
+    }));
+    benchmark({
+        title: "serializing",
+        benchmarkFn: () => ctor.serializeAttributionCollections(segmentsToSerialize),
+        type: suiteBaseType,
+    });
+    const summary = ctor.serializeAttributionCollections(segmentsToSerialize);
+    const segments = Array.from({ length: 9 }, () => ({
+        cachedLength: Math.floor(summary.length / 10),
+    }));
+    segments.push({ cachedLength: summary.length - 9 * Math.floor(summary.length / 10) });
+    benchmark({
+        title: "deserialize into 10 segments",
+        benchmarkFn: () => {
+            ctor.populateAttributionCollections(segments, summary);
+        },
+        type: suiteBaseType,
+    });
+}
+// Note: channel functionality is left unimplemented.
+class TreeAttributionCollection {
+    constructor(_length, 
+    // eslint-disable-next-line @rushstack/no-new-null
+    baseEntry) {
+        this._length = _length;
+        this.entries = new RedBlackTree(compareNumbers);
+        if (baseEntry !== undefined) {
+            this.entries.put(0, baseEntry);
+        }
+    }
+    get channelNames() {
+        return [];
+    }
+    getAtOffset(offset) {
+        assert(offset >= 0 && offset < this._length, "Requested offset should be valid");
+        const node = this.entries.floor(offset);
+        assert(node !== undefined, "Collection should have at least one entry");
+        return node.data ?? undefined;
+    }
+    get length() {
+        return this._length;
+    }
+    /**
+     * Splits this attribution collection into two with entries for [0, pos) and [pos, length).
+     */
+    splitAt(pos) {
+        const splitBaseEntry = this.getAtOffset(pos);
+        const splitCollection = new TreeAttributionCollection(this.length - pos, splitBaseEntry);
+        for (let current = this.entries.ceil(pos); current !== undefined; current = this.entries.ceil(pos)) {
+            // If there happened to be an attribution change at exactly pos, it's already set in the base entry
+            if (current.key !== pos) {
+                splitCollection.entries.put(current.key - pos, current.data);
+            }
+            this.entries.remove(current.key);
+        }
+        this._length = pos;
+        return splitCollection;
+    }
+    append(other) {
+        const lastEntry = this.getAtOffset(this.length - 1);
+        other.entries.map(({ key, data }) => {
+            if (key !== 0 || !areEqualAttributionKeys(lastEntry, data)) {
+                this.entries.put(key + this.length, data);
+            }
+            return true;
+        });
+        this._length += other.length;
+    }
+    getAll() {
+        const results = [];
+        this.entries.map(({ key, data }) => {
+            results.push({ offset: key, key: data });
+            return true;
+        });
+        return { root: results, length: this.length };
+    }
+    clone() {
+        const copy = new TreeAttributionCollection(this.length, this.getAtOffset(0));
+        this.entries.map(({ key, data }) => {
+            copy.entries.put(key, data);
+            return true;
+        });
+        return copy;
+    }
+    /**
+     * Rehydrates attribution information from its serialized form into the provided iterable of consecutive segments.
+     */
+    static populateAttributionCollections(segments, summary) {
+        const { seqs, posBreakpoints } = summary;
+        assert(seqs.length === posBreakpoints.length && seqs.length > 0, "Invalid attribution summary blob provided");
+        let curIndex = 0;
+        let cumulativeSegPos = 0;
+        let currentInfo = seqs[curIndex];
+        const getCurrentKey = () => typeof currentInfo === "object"
+            ? currentInfo
+            : { type: "op", seq: currentInfo };
+        for (const segment of segments) {
+            const attribution = new TreeAttributionCollection(segment.cachedLength, getCurrentKey());
+            while (posBreakpoints[curIndex] < cumulativeSegPos + segment.cachedLength) {
+                currentInfo = seqs[curIndex];
+                attribution.entries.put(posBreakpoints[curIndex] - cumulativeSegPos, getCurrentKey());
+                curIndex++;
+            }
+            segment.attribution = attribution;
+            cumulativeSegPos += segment.cachedLength;
+        }
+    }
+    update() {
+        throw new Error("unimplemented");
+    }
+    /**
+     * Condenses attribution information on consecutive segments into a `SerializedAttributionCollection`
+     */
+    static serializeAttributionCollections(segments) {
+        const posBreakpoints = [];
+        const seqs = [];
+        let mostRecentAttributionKey;
+        let cumulativePos = 0;
+        let segmentsWithAttribution = 0;
+        let segmentsWithoutAttribution = 0;
+        for (const segment of segments) {
+            if (segment.attribution) {
+                segmentsWithAttribution++;
+                for (const { offset, key: info } of segment.attribution?.getAll()?.root ?? []) {
+                    if (mostRecentAttributionKey === undefined ||
+                        !areEqualAttributionKeys(info, mostRecentAttributionKey)) {
+                        posBreakpoints.push(offset + cumulativePos);
+                        seqs.push(!info ? null : info.type === "op" ? info.seq : info);
+                    }
+                    mostRecentAttributionKey = info;
+                }
+            }
+            else {
+                segmentsWithoutAttribution++;
+            }
+            cumulativePos += segment.cachedLength;
+        }
+        assert(segmentsWithAttribution === 0 || segmentsWithoutAttribution === 0, "Expected either all segments or no segments to have attribution information.");
+        const blobContents = {
+            seqs,
+            posBreakpoints,
+            length: cumulativePos,
+        };
+        return blobContents;
+    }
+}
+describe("IAttributionCollection perf", () => {
+    describe("tree implementation", () => {
+        runAttributionCollectionSuite(TreeAttributionCollection, BenchmarkType.Diagnostic);
+    });
+    describe("list-based implementation", () => {
+        runAttributionCollectionSuite(NewAttributionCollection, BenchmarkType.Measurement);
+    });
+});
+//# sourceMappingURL=attributionCollection.perf.spec.js.map

package/lib/test/attributionCollection.perf.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributionCollection.perf.spec.js","sourceRoot":"","sources":["../../src/test/attributionCollection.perf.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,EACN,uBAAuB,EACvB,qBAAqB,IAAI,wBAAwB,GAIjD,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAY,MAAM,sBAAsB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAkBvD,SAAS,kBAAkB,CAC1B,IAAgC,EAChC,aAA4B;IAM5B,MAAM,mBAAmB,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAC7D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;QAC5B,gBAAgB,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;KACjE;IACD,MAAM,iBAAiB,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,sBAAsB,EAAE,CAAC,EAAE,EAAE;QAChD,iBAAiB,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;KAC9D;IACD,OAAO;QACN,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,mBAAmB,EAAE,IAAI,EAAE,aAAa,CAAC,UAAU,EAAE;QACpF,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,EAAE,aAAa,EAAE;QACvE,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,iBAAiB,EAAE,IAAI,EAAE,aAAa,CAAC,UAAU,EAAE;KACvF,CAAC;AACH,CAAC;AAED,SAAS,6BAA6B,CACrC,IAAgC,EAChC,aAA4B;IAE5B,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IACpE,KAAK,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,mBAAmB,EAAE;QAC7D,QAAQ,CAAC,2BAA2B,IAAI,EAAE,EAAE,GAAG,EAAE;YAChD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;YAC9B,SAAS,CAAC;gBACT,KAAK,EAAE,0BAA0B;gBACjC,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC5C,IAAI;aACJ,CAAC,CAAC;YAEH,SAAS,CAAC;gBACT,KAAK,EAAE,wBAAwB;gBAC/B,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;gBACrD,IAAI;aACJ,CAAC,CAAC;YAEH,SAAS,CAAC;gBACT,KAAK,EAAE,2BAA2B;gBAClC,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;gBACrD,IAAI,EAAE,aAAa,CAAC,UAAU;aAC9B,CAAC,CAAC;YAEH,SAAS,CAAC;gBACT,KAAK,EAAE,QAAQ;gBACf,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE;gBACtC,IAAI;aACJ,CAAC,CAAC;YAEH,SAAS,CAAC;gBACT,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE;gBACrC,IAAI;aACJ,CAAC,CAAC;YAEH,SAAS,CAAC;gBACT,KAAK,EAAE,8BAA8B;gBACrC,WAAW,EAAE,GAAG,EAAE;oBACjB,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAC7C,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC1B,CAAC;gBACD,IAAI;aACJ,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;KACH;IAED,SAAS,CAAC;QACT,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;QACvD,IAAI,EAAE,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;QACxE,WAAW,EAAE,UAAU;QACvB,YAAY,EAAE,UAAU,CAAC,MAAM;KAC/B,CAAC,CAAC,CAAC;IAEJ,SAAS,CAAC;QACT,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,+BAA+B,CAAC,mBAAmB,CAAC;QAC5E,IAAI,EAAE,aAAa;KACnB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,CAAC,+BAA+B,CAAC,mBAAmB,CAAC,CAAC;IAC1E,MAAM,QAAQ,GAAe,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAC7D,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC;KAC7C,CAAC,CAAe,CAAC;IAClB,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,EAAS,CAAC,CAAC;IAC7F,SAAS,CAAC;QACT,KAAK,EAAE,8BAA8B;QACrC,WAAW,EAAE,GAAG,EAAE;YACjB,IAAI,CAAC,8BAA8B,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,EAAE,aAAa;KACnB,CAAC,CAAC;AACJ,CAAC;AAED,qDAAqD;AACrD,MAAM,yBAAyB;IAK9B,YACS,OAAe;IACvB,kDAAkD;IAClD,SAAiC;QAFzB,YAAO,GAAP,OAAO,CAAQ;QALP,YAAO,GAAgD,IAAI,YAAY,CACvF,cAAc,CACd,CAAC;QAOD,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;SAC/B;IACF,CAAC;IAED,IAAW,YAAY;QACtB,OAAO,EAAE,CAAC;IACX,CAAC;IAEM,WAAW,CAAC,MAAc;QAChC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,kCAAkC,CAAC,CAAC;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,2CAA2C,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC;IAC/B,CAAC;IAED,IAAW,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,GAAW;QACzB,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,eAAe,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,cAAc,CAAC,CAAC;QACzF,KACC,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EACpC,OAAO,KAAK,SAAS,EACrB,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAC/B;YACD,mGAAmG;YACnG,IAAI,OAAO,CAAC,GAAG,KAAK,GAAG,EAAE;gBACxB,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;aAC7D;YACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;SACjC;QACD,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC;QACnB,OAAO,eAAe,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,KAAgC;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACpD,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;YACnC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;gBAC3D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;aAC1C;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC;IAC9B,CAAC;IAEM,MAAM;QACZ,MAAM,OAAO,GAAqD,EAAE,CAAC;QACrE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;YAClC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IAC/C,CAAC;IAEM,KAAK;QACX,MAAM,IAAI,GAAG,IAAI,yBAAyB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC5B,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,8BAA8B,CAC3C,QAA4B,EAC5B,OAAwC;QAExC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QACzC,MAAM,CACL,IAAI,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EACxD,2CAA2C,CAC3C,CAAC;QACF,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,IAAI,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,MAAM,aAAa,GAAG,GAAG,EAAE,CAC1B,OAAO,WAAW,KAAK,QAAQ;YAC9B,CAAC,CAAC,WAAW;YACb,CAAC,CAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAY,CAAC;QAEhD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC/B,MAAM,WAAW,GAAG,IAAI,yBAAyB,CAChD,OAAO,CAAC,YAAY,EACpB,aAAa,EAAE,CACf,CAAC;YACF,OAAO,cAAc,CAAC,QAAQ,CAAC,GAAG,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE;gBAC1E,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC7B,WAAW,CAAC,OAAO,CAAC,GAAG,CACtB,cAAc,CAAC,QAAQ,CAAC,GAAG,gBAAgB,EAC3C,aAAa,EAAE,CACf,CAAC;gBACF,QAAQ,EAAE,CAAC;aACX;YAED,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;YAClC,gBAAgB,IAAI,OAAO,CAAC,YAAY,CAAC;SACzC;IACF,CAAC;IAEM,MAAM;QACZ,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,+BAA+B,CAC5C,QAGE;QAEF,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,IAAI,GAAuC,EAAE,CAAC;QACpD,IAAI,wBAA2D,CAAC;QAChE,IAAI,aAAa,GAAG,CAAC,CAAC;QAEtB,IAAI,uBAAuB,GAAG,CAAC,CAAC;QAChC,IAAI,0BAA0B,GAAG,CAAC,CAAC;QACnC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC/B,IAAI,OAAO,CAAC,WAAW,EAAE;gBACxB,uBAAuB,EAAE,CAAC;gBAC1B,KAAK,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,IAAI,IAAI,EAAE,EAAE;oBAC9E,IACC,wBAAwB,KAAK,SAAS;wBACtC,CAAC,uBAAuB,CAAC,IAAI,EAAE,wBAAwB,CAAC,EACvD;wBACD,cAAc,CAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;wBAC5C,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;qBAC/D;oBACD,wBAAwB,GAAG,IAAI,CAAC;iBAChC;aACD;iBAAM;gBACN,0BAA0B,EAAE,CAAC;aAC7B;YAED,aAAa,IAAI,OAAO,CAAC,YAAY,CAAC;SACtC;QAED,MAAM,CACL,uBAAuB,KAAK,CAAC,IAAI,0BAA0B,KAAK,CAAC,EACjE,8EAA8E,CAC9E,CAAC;QAEF,MAAM,YAAY,GAAoC;YACrD,IAAI;YACJ,cAAc;YACd,MAAM,EAAE,aAAa;SACrB,CAAC;QACF,OAAO,YAAY,CAAC;IACrB,CAAC;CACD;AAED,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC5C,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACpC,6BAA6B,CAAC,yBAAyB,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QAC1C,6BAA6B,CAAC,wBAAwB,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IACpF,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 { benchmark, BenchmarkType } from \"@fluid-tools/benchmark\";\nimport { AttributionKey } from \"@fluidframework/runtime-definitions\";\nimport {\n\tareEqualAttributionKeys,\n\tAttributionCollection as NewAttributionCollection,\n\tIAttributionCollection,\n\tIAttributionCollectionSpec,\n\tSerializedAttributionCollection,\n} from \"../attributionCollection.js\";\nimport { TextSegmentGranularity } from \"../textSegment.js\";\nimport { compareNumbers, ISegment } from \"../mergeTreeNodes.js\";\nimport { RedBlackTree } from \"../collections/index.js\";\n\ninterface IAttributionCollectionCtor {\n\tnew (length: number, key?: AttributionKey): IAttributionCollection<AttributionKey>;\n\n\tserializeAttributionCollections(\n\t\tsegments: Iterable<{\n\t\t\tattribution?: IAttributionCollection<AttributionKey>;\n\t\t\tcachedLength: number;\n\t\t}>,\n\t): SerializedAttributionCollection;\n\n\tpopulateAttributionCollections(\n\t\tsegments: Iterable<ISegment>,\n\t\tsummary: SerializedAttributionCollection,\n\t): void;\n}\n\nfunction getCollectionSizes(\n\tctor: IAttributionCollectionCtor,\n\tbaseSuiteType: BenchmarkType,\n): {\n\tname: string;\n\tcollection: IAttributionCollection<AttributionKey>;\n\ttype: BenchmarkType;\n}[] {\n\tconst singleKeyCollection = new ctor(5, { type: \"op\", seq: 42 });\n\tconst tenKeyCollection = new ctor(2, { type: \"op\", seq: 0 });\n\tfor (let i = 1; i < 10; i++) {\n\t\ttenKeyCollection.append(new ctor(3 * i, { type: \"op\", seq: i }));\n\t}\n\tconst maxSizeCollection = new ctor(1, { type: \"op\", seq: 0 });\n\tfor (let i = 1; i < TextSegmentGranularity; i++) {\n\t\tmaxSizeCollection.append(new ctor(1, { type: \"op\", seq: i }));\n\t}\n\treturn [\n\t\t{ name: \"one key\", collection: singleKeyCollection, type: BenchmarkType.Diagnostic },\n\t\t{ name: \"ten keys\", collection: tenKeyCollection, type: baseSuiteType },\n\t\t{ name: \"maximum keys\", collection: maxSizeCollection, type: BenchmarkType.Diagnostic },\n\t];\n}\n\nfunction runAttributionCollectionSuite(\n\tctor: IAttributionCollectionCtor,\n\tsuiteBaseType: BenchmarkType,\n): void {\n\tconst collectionTestCases = getCollectionSizes(ctor, suiteBaseType);\n\tfor (const { name, collection, type } of collectionTestCases) {\n\t\tdescribe(`using a collection with ${name}`, () => {\n\t\t\tconst { length } = collection;\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"getAtOffset at the start\",\n\t\t\t\tbenchmarkFn: () => collection.getAtOffset(0),\n\t\t\t\ttype,\n\t\t\t});\n\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"getAtOffset at the end\",\n\t\t\t\tbenchmarkFn: () => collection.getAtOffset(length - 1),\n\t\t\t\ttype,\n\t\t\t});\n\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"getAtOffset in the middle\",\n\t\t\t\tbenchmarkFn: () => collection.getAtOffset(length / 2),\n\t\t\t\ttype: BenchmarkType.Diagnostic,\n\t\t\t});\n\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"getAll\",\n\t\t\t\tbenchmarkFn: () => collection.getAll(),\n\t\t\t\ttype,\n\t\t\t});\n\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"clone\",\n\t\t\t\tbenchmarkFn: () => collection.clone(),\n\t\t\t\ttype,\n\t\t\t});\n\n\t\t\tbenchmark({\n\t\t\t\ttitle: \"split + append in the middle\",\n\t\t\t\tbenchmarkFn: () => {\n\t\t\t\t\tconst split = collection.splitAt(length / 2);\n\t\t\t\t\tcollection.append(split);\n\t\t\t\t},\n\t\t\t\ttype,\n\t\t\t});\n\t\t});\n\t}\n\n\tbenchmark({\n\t\ttitle: \"construction\",\n\t\tbenchmarkFn: () => new ctor(42, { type: \"op\", seq: 5 }),\n\t\ttype: suiteBaseType,\n\t});\n\n\tconst segmentsToSerialize = collectionTestCases.map(({ collection }) => ({\n\t\tattribution: collection,\n\t\tcachedLength: collection.length,\n\t}));\n\n\tbenchmark({\n\t\ttitle: \"serializing\",\n\t\tbenchmarkFn: () => ctor.serializeAttributionCollections(segmentsToSerialize),\n\t\ttype: suiteBaseType,\n\t});\n\n\tconst summary = ctor.serializeAttributionCollections(segmentsToSerialize);\n\tconst segments: ISegment[] = Array.from({ length: 9 }, () => ({\n\t\tcachedLength: Math.floor(summary.length / 10),\n\t})) as ISegment[];\n\tsegments.push({ cachedLength: summary.length - 9 * Math.floor(summary.length / 10) } as any);\n\tbenchmark({\n\t\ttitle: \"deserialize into 10 segments\",\n\t\tbenchmarkFn: () => {\n\t\t\tctor.populateAttributionCollections(segments, summary);\n\t\t},\n\t\ttype: suiteBaseType,\n\t});\n}\n\n// Note: channel functionality is left unimplemented.\nclass TreeAttributionCollection implements IAttributionCollection<AttributionKey> {\n\tprivate readonly entries: RedBlackTree<number, AttributionKey | null> = new RedBlackTree(\n\t\tcompareNumbers,\n\t);\n\n\tpublic constructor(\n\t\tprivate _length: number,\n\t\t// eslint-disable-next-line @rushstack/no-new-null\n\t\tbaseEntry?: AttributionKey | null,\n\t) {\n\t\tif (baseEntry !== undefined) {\n\t\t\tthis.entries.put(0, baseEntry);\n\t\t}\n\t}\n\n\tpublic get channelNames() {\n\t\treturn [];\n\t}\n\n\tpublic getAtOffset(offset: number): AttributionKey | undefined {\n\t\tassert(offset >= 0 && offset < this._length, \"Requested offset should be valid\");\n\t\tconst node = this.entries.floor(offset);\n\t\tassert(node !== undefined, \"Collection should have at least one entry\");\n\t\treturn node.data ?? undefined;\n\t}\n\n\tpublic get length(): number {\n\t\treturn this._length;\n\t}\n\n\t/**\n\t * Splits this attribution collection into two with entries for [0, pos) and [pos, length).\n\t */\n\tpublic splitAt(pos: number): TreeAttributionCollection {\n\t\tconst splitBaseEntry = this.getAtOffset(pos);\n\t\tconst splitCollection = new TreeAttributionCollection(this.length - pos, splitBaseEntry);\n\t\tfor (\n\t\t\tlet current = this.entries.ceil(pos);\n\t\t\tcurrent !== undefined;\n\t\t\tcurrent = this.entries.ceil(pos)\n\t\t) {\n\t\t\t// If there happened to be an attribution change at exactly pos, it's already set in the base entry\n\t\t\tif (current.key !== pos) {\n\t\t\t\tsplitCollection.entries.put(current.key - pos, current.data);\n\t\t\t}\n\t\t\tthis.entries.remove(current.key);\n\t\t}\n\t\tthis._length = pos;\n\t\treturn splitCollection;\n\t}\n\n\tpublic append(other: TreeAttributionCollection): void {\n\t\tconst lastEntry = this.getAtOffset(this.length - 1);\n\t\tother.entries.map(({ key, data }) => {\n\t\t\tif (key !== 0 || !areEqualAttributionKeys(lastEntry, data)) {\n\t\t\t\tthis.entries.put(key + this.length, data);\n\t\t\t}\n\t\t\treturn true;\n\t\t});\n\t\tthis._length += other.length;\n\t}\n\n\tpublic getAll(): IAttributionCollectionSpec<AttributionKey> {\n\t\tconst results: { offset: number; key: AttributionKey | null }[] = [];\n\t\tthis.entries.map(({ key, data }) => {\n\t\t\tresults.push({ offset: key, key: data });\n\t\t\treturn true;\n\t\t});\n\t\treturn { root: results, length: this.length };\n\t}\n\n\tpublic clone(): TreeAttributionCollection {\n\t\tconst copy = new TreeAttributionCollection(this.length, this.getAtOffset(0));\n\t\tthis.entries.map(({ key, data }) => {\n\t\t\tcopy.entries.put(key, data);\n\t\t\treturn true;\n\t\t});\n\t\treturn copy;\n\t}\n\n\t/**\n\t * Rehydrates attribution information from its serialized form into the provided iterable of consecutive segments.\n\t */\n\tpublic static populateAttributionCollections(\n\t\tsegments: Iterable<ISegment>,\n\t\tsummary: SerializedAttributionCollection,\n\t): void {\n\t\tconst { seqs, posBreakpoints } = summary;\n\t\tassert(\n\t\t\tseqs.length === posBreakpoints.length && seqs.length > 0,\n\t\t\t\"Invalid attribution summary blob provided\",\n\t\t);\n\t\tlet curIndex = 0;\n\t\tlet cumulativeSegPos = 0;\n\t\tlet currentInfo = seqs[curIndex];\n\t\tconst getCurrentKey = () =>\n\t\t\ttypeof currentInfo === \"object\"\n\t\t\t\t? currentInfo\n\t\t\t\t: ({ type: \"op\", seq: currentInfo } as const);\n\n\t\tfor (const segment of segments) {\n\t\t\tconst attribution = new TreeAttributionCollection(\n\t\t\t\tsegment.cachedLength,\n\t\t\t\tgetCurrentKey(),\n\t\t\t);\n\t\t\twhile (posBreakpoints[curIndex] < cumulativeSegPos + segment.cachedLength) {\n\t\t\t\tcurrentInfo = seqs[curIndex];\n\t\t\t\tattribution.entries.put(\n\t\t\t\t\tposBreakpoints[curIndex] - cumulativeSegPos,\n\t\t\t\t\tgetCurrentKey(),\n\t\t\t\t);\n\t\t\t\tcurIndex++;\n\t\t\t}\n\n\t\t\tsegment.attribution = attribution;\n\t\t\tcumulativeSegPos += segment.cachedLength;\n\t\t}\n\t}\n\n\tpublic update(): void {\n\t\tthrow new Error(\"unimplemented\");\n\t}\n\n\t/**\n\t * Condenses attribution information on consecutive segments into a `SerializedAttributionCollection`\n\t */\n\tpublic static serializeAttributionCollections(\n\t\tsegments: Iterable<{\n\t\t\tattribution?: IAttributionCollection<AttributionKey>;\n\t\t\tcachedLength: number;\n\t\t}>,\n\t): SerializedAttributionCollection {\n\t\tconst posBreakpoints: number[] = [];\n\t\tconst seqs: (number | AttributionKey | null)[] = [];\n\t\tlet mostRecentAttributionKey: AttributionKey | null | undefined;\n\t\tlet cumulativePos = 0;\n\n\t\tlet segmentsWithAttribution = 0;\n\t\tlet segmentsWithoutAttribution = 0;\n\t\tfor (const segment of segments) {\n\t\t\tif (segment.attribution) {\n\t\t\t\tsegmentsWithAttribution++;\n\t\t\t\tfor (const { offset, key: info } of segment.attribution?.getAll()?.root ?? []) {\n\t\t\t\t\tif (\n\t\t\t\t\t\tmostRecentAttributionKey === undefined ||\n\t\t\t\t\t\t!areEqualAttributionKeys(info, mostRecentAttributionKey)\n\t\t\t\t\t) {\n\t\t\t\t\t\tposBreakpoints.push(offset + cumulativePos);\n\t\t\t\t\t\tseqs.push(!info ? null : info.type === \"op\" ? info.seq : info);\n\t\t\t\t\t}\n\t\t\t\t\tmostRecentAttributionKey = info;\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tsegmentsWithoutAttribution++;\n\t\t\t}\n\n\t\t\tcumulativePos += segment.cachedLength;\n\t\t}\n\n\t\tassert(\n\t\t\tsegmentsWithAttribution === 0 || segmentsWithoutAttribution === 0,\n\t\t\t\"Expected either all segments or no segments to have attribution information.\",\n\t\t);\n\n\t\tconst blobContents: SerializedAttributionCollection = {\n\t\t\tseqs,\n\t\t\tposBreakpoints,\n\t\t\tlength: cumulativePos,\n\t\t};\n\t\treturn blobContents;\n\t}\n}\n\ndescribe(\"IAttributionCollection perf\", () => {\n\tdescribe(\"tree implementation\", () => {\n\t\trunAttributionCollectionSuite(TreeAttributionCollection, BenchmarkType.Diagnostic);\n\t});\n\n\tdescribe(\"list-based implementation\", () => {\n\t\trunAttributionCollectionSuite(NewAttributionCollection, BenchmarkType.Measurement);\n\t});\n});\n"]}

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

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

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

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