@fluidframework/merge-tree 0.58.2001 → 0.59.2000-61729

package/dist/mergeTree.js

@@ -7,7 +7,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 /* eslint-disable @typescript-eslint/consistent-type-assertions */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MergeTree = exports.clientSeqComparer = exports.internedSpaces = exports.compareStrings = exports.compareNumbers = exports.CollaborationWindow = exports.IncrementalMapState = exports.IncrementalExecOp = exports.Marker = exports.refHasRangeLabel = exports.refHasTileLabel = exports.refGetRangeLabels = exports.refGetTileLabels = exports.reservedMarkerSimpleTypeKey = exports.reservedMarkerIdKey = exports.reservedRangeLabelsKey = exports.reservedTileLabelsKey = exports.BaseSegment = exports.MergeBlock = exports.MaxNodesInBlock = exports.ordinalToArray = exports.MergeNode = void 0;
+exports.MergeTree = exports.clientSeqComparer = exports.internedSpaces = exports.compareStrings = exports.compareNumbers = exports.CollaborationWindow = exports.IncrementalMapState = exports.IncrementalExecOp = exports.Marker = exports.refHasRangeLabel = exports.refHasTileLabel = exports.refGetRangeLabels = exports.refGetTileLabels = exports.reservedMarkerSimpleTypeKey = exports.reservedMarkerIdKey = exports.reservedRangeLabelsKey = exports.reservedTileLabelsKey = exports.BaseSegment = exports.MergeBlock = exports.MaxNodesInBlock = exports.ordinalToArray = exports.MergeNode = exports.toRemovalInfo = void 0;
 /* eslint-disable no-bitwise */
 const common_utils_1 = require("@fluidframework/common-utils");
 const collections_1 = require("./collections");
@@ -19,6 +19,13 @@ const partialLengths_1 = require("./partialLengths");
 const properties_1 = require("./properties");
 const segmentGroupCollection_1 = require("./segmentGroupCollection");
 const segmentPropertiesManager_1 = require("./segmentPropertiesManager");
+function toRemovalInfo(maybe) {
+    if ((maybe === null || maybe === void 0 ? void 0 : maybe.removedClientIds) !== undefined && (maybe === null || maybe === void 0 ? void 0 : maybe.removedSeq) !== undefined) {
+        return maybe;
+    }
+    common_utils_1.assert((maybe === null || maybe === void 0 ? void 0 : maybe.removedClientIds) === undefined && (maybe === null || maybe === void 0 ? void 0 : maybe.removedSeq) === undefined, 0x2bf /* "both removedClientIds and removedSeq should be set or not set" */);
+}
+exports.toRemovalInfo = toRemovalInfo;
 class MergeNode {
     constructor() {
         this.index = 0;
@@ -255,10 +262,11 @@ class BaseSegment extends MergeNode {
         return true;
     }
     cloneInto(b) {
+        var _a;
         b.clientId = this.clientId;
         // TODO: deep clone properties
         b.properties = properties_1.clone(this.properties);
-        b.removedClientId = this.removedClientId;
+        b.removedClientIds = (_a = this.removedClientIds) === null || _a === void 0 ? void 0 : _a.slice();
         // TODO: copy removed client overlap and branch removal info
         b.removedSeq = this.removedSeq;
         b.seq = this.seq;
@@ -285,10 +293,8 @@ class BaseSegment extends MergeNode {
                 this.localSeq = undefined;
                 return true;
             case 1 /* REMOVE */:
-                // eslint-disable-next-line @typescript-eslint/no-this-alias
-                const removalInfo = this;
-                common_utils_1.assert(!!removalInfo, 0x046 /* "On remove ack, missing removal info!" */);
-                common_utils_1.assert(!!removalInfo.removedSeq, 0x047 /* "On remove ack, missing removed sequence number!" */);
+                const removalInfo = toRemovalInfo(this);
+                common_utils_1.assert(removalInfo !== undefined, 0x046 /* "On remove ack, missing removal info!" */);
                 this.localRemovedSeq = undefined;
                 if (removalInfo.removedSeq === constants_1.UnassignedSequenceNumber) {
                     removalInfo.removedSeq = opArgs.sequencedMessage.sequenceNumber;
@@ -300,6 +306,7 @@ class BaseSegment extends MergeNode {
         }
     }
     splitAt(pos) {
+        var _a;
         if (pos > 0) {
             const leafSegment = this.createSplitSegmentAt(pos);
             if (leafSegment) {
@@ -309,15 +316,12 @@ class BaseSegment extends MergeNode {
                 // when this segment is put in the tree, it will get it's real ordinal,
                 // but this ordinal meets all the necessary invariants for now.
                 leafSegment.ordinal = this.ordinal + String.fromCharCode(0);
-                leafSegment.removedClientId = this.removedClientId;
+                leafSegment.removedClientIds = (_a = this.removedClientIds) === null || _a === void 0 ? void 0 : _a.slice();
                 leafSegment.removedSeq = this.removedSeq;
                 leafSegment.localRemovedSeq = this.localRemovedSeq;
                 leafSegment.seq = this.seq;
                 leafSegment.localSeq = this.localSeq;
                 leafSegment.clientId = this.clientId;
-                if (this.removedClientOverlap) {
-                    leafSegment.removedClientOverlap = [...this.removedClientOverlap];
-                }
                 this.segmentGroups.copyTo(leafSegment);
                 this.trackingCollection.copyTo(leafSegment);
                 if (this.localRefs) {
@@ -680,13 +684,7 @@ class MergeTree {
         this.root = this.makeBlock(0);
     }
     makeBlock(childCount) {
-        let block;
-        if (MergeTree.blockUpdateMarkers) {
-            block = new HierMergeBlock(childCount);
-        }
-        else {
-            block = new MergeBlock(childCount);
-        }
+        const block = new HierMergeBlock(childCount);
         block.ordinal = "";
         return block;
     }
@@ -719,8 +717,8 @@ class MergeTree {
         return b;
     }
     localNetLength(segment) {
-        const removalInfo = segment;
-        if (removalInfo.removedSeq !== undefined) {
+        const removalInfo = toRemovalInfo(segment);
+        if (removalInfo !== undefined) {
             return 0;
         }
         else {
@@ -1070,8 +1068,8 @@ class MergeTree {
             }
             else {
                 const segment = node;
-                const removalInfo = segment;
-                if (removalInfo.removedSeq !== undefined
+                const removalInfo = toRemovalInfo(segment);
+                if (removalInfo !== undefined
                     && removalInfo.removedSeq !== constants_1.UnassignedSequenceNumber
                     && removalInfo.removedSeq <= refSeq) {
                     // this segment is a tombstone eligible for zamboni
@@ -1082,10 +1080,8 @@ class MergeTree {
                 if (((segment.clientId === clientId) ||
                     ((segment.seq !== constants_1.UnassignedSequenceNumber) && (segment.seq <= refSeq)))) {
                     // Segment happened by reference sequence number or segment from requesting client
-                    if (removalInfo.removedSeq !== undefined) {
-                        if (removalInfo.removedClientId === clientId
-                            || (removalInfo.removedClientOverlap
-                                && removalInfo.removedClientOverlap.includes(clientId))) {
+                    if (removalInfo !== undefined) {
+                        if (removalInfo.removedClientIds.includes(clientId)) {
                             return 0;
                         }
                         else {
@@ -1100,7 +1096,7 @@ class MergeTree {
                     // the segment was inserted and removed before the
                     // this context, so it will never exist for this
                     // context
-                    if (removalInfo.removedSeq !== undefined
+                    if (removalInfo !== undefined
                         && removalInfo.removedSeq !== constants_1.UnassignedSequenceNumber) {
                         return undefined;
                     }
@@ -1801,12 +1797,6 @@ class MergeTree {
             }
         }
     }
-    addOverlappingClient(removalInfo, clientId) {
-        if (!removalInfo.removedClientOverlap) {
-            removalInfo.removedClientOverlap = [];
-        }
-        removalInfo.removedClientOverlap.push(clientId);
-    }
     /**
      * Annotate a range with properties
      * @param start - The inclusive start position of the range to annotate
@@ -1862,23 +1852,26 @@ class MergeTree {
         const savedLocalRefs = [];
         const localSeq = seq === constants_1.UnassignedSequenceNumber ? ++this.collabWindow.localSeq : undefined;
         const markRemoved = (segment, pos, _start, _end) => {
-            const removalInfo = segment;
-            if (removalInfo.removedSeq !== undefined) {
+            const existingRemovalInfo = toRemovalInfo(segment);
+            if (existingRemovalInfo !== undefined) {
                 _overwrite = true;
-                if (removalInfo.removedSeq === constants_1.UnassignedSequenceNumber) {
-                    // replace because comes later
-                    removalInfo.removedClientId = clientId;
-                    removalInfo.removedSeq = seq;
+                if (existingRemovalInfo.removedSeq === constants_1.UnassignedSequenceNumber) {
+                    // we removed this locally, but someone else removed it first
+                    // so put them at the head of the list
+                    // the list isn't ordered, but we
+                    // keep first removal at the head.
+                    existingRemovalInfo.removedClientIds.unshift(clientId);
+                    existingRemovalInfo.removedSeq = seq;
                     segment.localRemovedSeq = undefined;
                 }
                 else {
                     // Do not replace earlier sequence number for remove
-                    this.addOverlappingClient(removalInfo, clientId);
+                    existingRemovalInfo.removedClientIds.push(clientId);
                 }
             }
             else {
-                removalInfo.removedClientId = clientId;
-                removalInfo.removedSeq = seq;
+                segment.removedClientIds = [clientId];
+                segment.removedSeq = seq;
                 segment.localRemovedSeq = localSeq;
                 removedSegments.push({ segment });
                 if (segment.localRefs && !segment.localRefs.empty) {
@@ -1888,9 +1881,7 @@ class MergeTree {
             }
             // Save segment so can assign removed sequence number when acked by server
             if (this.collabWindow.collaborating) {
-                // Use removal information
-                const _removalInfo = segment;
-                if (_removalInfo.removedSeq === constants_1.UnassignedSequenceNumber && clientId === this.collabWindow.clientId) {
+                if (segment.removedSeq === constants_1.UnassignedSequenceNumber && clientId === this.collabWindow.clientId) {
                     segmentGroup = this.addToPendingList(segment, segmentGroup, localSeq);
                 }
                 else {
@@ -2185,8 +2176,4 @@ MergeTree.options = {
     zamboniSegments: true,
 };
 MergeTree.theUnfinishedNode = { childCount: -1 };
-// WARNING:
-// Setting blockUpdateMarkers to false will result in eventual consistency issues
-// for property updates on markers when loading from snapshots
-MergeTree.blockUpdateMarkers = true;
 //# sourceMappingURL=mergeTree.js.map