@fluidframework/merge-tree 2.4.0-294316 → 2.4.0-297027

package/dist/mergeTree.js

@@ -24,6 +24,7 @@ const properties_js_1 = require("./properties.js");
 const referencePositions_js_1 = require("./referencePositions.js");
 // eslint-disable-next-line import/no-deprecated
 const segmentPropertiesManager_js_1 = require("./segmentPropertiesManager.js");
+const sequencePlace_js_1 = require("./sequencePlace.js");
 const sortedSegmentSet_js_1 = require("./sortedSegmentSet.js");
 const zamboni_js_1 = require("./zamboni.js");
 function markSegmentMoved(seg, moveInfo) {
@@ -764,13 +765,15 @@ class MergeTree {
                     segment: pendingSegment,
                 });
             });
-            if (opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE) {
+            if (opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE ||
+                opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE_SIDED) {
                 this.obliterates.addOrUpdate(pendingSegmentGroup.obliterateInfo);
             }
             // Perform slides after all segments have been acked, so that
             // positions after slide are final
             if (opArgs.op.type === ops_js_1.MergeTreeDeltaType.REMOVE ||
-                opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE) {
+                opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE ||
+                opArgs.op.type === ops_js_1.MergeTreeDeltaType.OBLITERATE_SIDED) {
                 this.slideAckedRemovedSegmentReferences(pendingSegmentGroup.segments);
             }
             this.mergeTreeMaintenanceCallback?.({
@@ -970,9 +973,9 @@ class MergeTree {
                     });
                 }
                 this.updateRoot(splitNode);
-                saveIfLocal(newSegment);
                 insertPos += newSegment.cachedLength;
                 if (!this.options?.mergeTreeEnableObliterate || this.obliterates.empty()) {
+                    saveIfLocal(newSegment);
                     continue;
                 }
                 // eslint-disable-next-line import/no-deprecated
@@ -999,13 +1002,13 @@ class MergeTree {
                             movedSeqs.unshift(ob.seq);
                         }
                         else {
-                            if (newest === undefined || normalizedNewestSeq < normalizedObSeq) {
-                                normalizedNewestSeq = normalizedObSeq;
-                                newest = ob;
-                            }
                             movedClientIds.push(ob.clientId);
                             movedSeqs.push(ob.seq);
                         }
+                        if (newest === undefined || normalizedNewestSeq < normalizedObSeq) {
+                            normalizedNewestSeq = normalizedObSeq;
+                            newest = ob;
+                        }
                     }
                 }
                 if (oldest && newest?.clientId !== clientId) {
@@ -1025,6 +1028,10 @@ class MergeTree {
                         this.blockUpdatePathLengths(newSegment.parent, seq, clientId);
                     }
                 }
+                else if (oldest && newest?.clientId === clientId) {
+                    newSegment.prevObliterateByInserter = newest;
+                }
+                saveIfLocal(newSegment);
             }
         }
     }
@@ -1231,10 +1238,11 @@ class MergeTree {
             (0, zamboni_js_1.zamboniSegments)(this);
         }
     }
-    obliterateRange(start, end, refSeq, clientId, seq, overwrite = false, opArgs) {
-        errorIfOptionNotTrue(this.options, "mergeTreeEnableObliterate");
-        this.ensureIntervalBoundary(start, refSeq, clientId);
-        this.ensureIntervalBoundary(end, refSeq, clientId);
+    obliterateRangeSided(start, end, refSeq, clientId, seq, overwrite = false, opArgs) {
+        const startPos = start.side === sequencePlace_js_1.Side.Before ? start.pos : start.pos + 1;
+        const endPos = end.side === sequencePlace_js_1.Side.Before ? end.pos : end.pos + 1;
+        this.ensureIntervalBoundary(startPos, refSeq, clientId);
+        this.ensureIntervalBoundary(endPos, refSeq, clientId);
         let _overwrite = overwrite;
         const localOverlapWithRefs = [];
         const movedSegments = [];
@@ -1249,18 +1257,46 @@ class MergeTree {
             localSeq,
             segmentGroup: undefined,
         };
-        const { segment: startSeg } = this.getContainingSegment(start, refSeq, clientId);
-        const { segment: endSeg } = this.getContainingSegment(end - 1, refSeq, clientId);
+        const { segment: startSeg } = this.getContainingSegment(start.pos, refSeq, clientId);
+        const { segment: endSeg } = this.getContainingSegment(end.pos, refSeq, clientId);
         (0, internal_1.assert)(startSeg !== undefined && endSeg !== undefined, 0xa3f /* segments cannot be undefined */);
-        obliterate.start = this.createLocalReferencePosition(startSeg, 0, ops_js_1.ReferenceType.StayOnRemove, {
+        obliterate.start = this.createLocalReferencePosition(startSeg, start.side === sequencePlace_js_1.Side.Before ? 0 : Math.max(startSeg.cachedLength - 1, 0), ops_js_1.ReferenceType.StayOnRemove, {
             obliterate,
         });
-        obliterate.end = this.createLocalReferencePosition(endSeg, endSeg.cachedLength - 1, ops_js_1.ReferenceType.StayOnRemove, {
+        obliterate.end = this.createLocalReferencePosition(endSeg, end.side === sequencePlace_js_1.Side.Before ? 0 : Math.max(endSeg.cachedLength - 1, 0), ops_js_1.ReferenceType.StayOnRemove, {
             obliterate,
         });
+        // Always create a segment group for obliterate,
+        // even if there are no segments currently in the obliteration range.
+        // Segments may be concurrently inserted into the obliteration range,
+        // at which point they are added to the segment group.
+        obliterate.segmentGroup = {
+            segments: [],
+            localSeq,
+            refSeq: this.collabWindow.currentSeq,
+            obliterateInfo: obliterate,
+        };
+        if (this.collabWindow.collaborating && clientId === this.collabWindow.clientId) {
+            this.pendingSegments.push(obliterate.segmentGroup);
+        }
+        this.obliterates.addOrUpdate(obliterate);
         const markMoved = (segment, pos, _start, _end) => {
-            var _a;
+            if ((start.side === sequencePlace_js_1.Side.After && startPos === pos + segment.cachedLength) || // exclusive start segment
+                (end.side === sequencePlace_js_1.Side.Before &&
+                    endPos === pos &&
+                    (0, perspective_js_1.isSegmentPresent)(segment, { refSeq, localSeq })) // exclusive end segment
+            ) {
+                // We walk these segments because we want to also walk any concurrently inserted segments between here and the obliterated segments.
+                // These segments are outside of the obliteration range though, so return true to keep walking.
+                return true;
+            }
             const existingMoveInfo = (0, mergeTreeNodes_js_1.toMoveInfo)(segment);
+            if (segment.prevObliterateByInserter?.seq === constants_js_1.UnassignedSequenceNumber) {
+                // We chose to not obliterate this segment because we are aware of an unacked local obliteration.
+                // The local obliterate has not been sequenced yet, so it is still the newest obliterate we are aware of.
+                // Other clients will also choose not to obliterate this segment because the most recent obliteration has the same clientId
+                return true;
+            }
             if (clientId !== segment.clientId &&
                 segment.seq !== undefined &&
                 seq !== constants_js_1.UnassignedSequenceNumber &&
@@ -1301,7 +1337,6 @@ class MergeTree {
                 if (segment.movedSeq === constants_js_1.UnassignedSequenceNumber &&
                     clientId === this.collabWindow.clientId) {
                     obliterate.segmentGroup = this.addToPendingList(segment, obliterate.segmentGroup, localSeq);
-                    (_a = obliterate.segmentGroup).obliterateInfo ?? (_a.obliterateInfo = obliterate);
                 }
                 else {
                     if (MergeTree.options.zamboniSegments) {
@@ -1320,8 +1355,8 @@ class MergeTree {
             }
             return true;
         };
-        this.nodeMap(refSeq, clientId, markMoved, undefined, afterMarkMoved, start, end, undefined, seq === constants_js_1.UnassignedSequenceNumber ? undefined : seq);
-        this.obliterates.addOrUpdate(obliterate);
+        this.nodeMap(refSeq, clientId, markMoved, undefined, afterMarkMoved, start.pos, end.pos + 1, // include the segment containing the end reference
+        undefined, seq === constants_js_1.UnassignedSequenceNumber ? undefined : seq);
         this.slideAckedRemovedSegmentReferences(localOverlapWithRefs);
         // opArgs == undefined => test code
         if (movedSegments.length > 0) {
@@ -1342,6 +1377,17 @@ class MergeTree {
             (0, zamboni_js_1.zamboniSegments)(this);
         }
     }
+    obliterateRange(start, end, refSeq, clientId, seq, overwrite = false, opArgs) {
+        errorIfOptionNotTrue(this.options, "mergeTreeEnableObliterate");
+        if (this.options?.mergeTreeEnableSidedObliterate) {
+            (0, internal_1.assert)(typeof start === "object" && typeof end === "object", "Start and end must be of type InteriorSequencePlace if mergeTreeEnableSidedObliterate is enabled.");
+            this.obliterateRangeSided(start, end, refSeq, clientId, seq, overwrite, opArgs);
+        }
+        else {
+            (0, internal_1.assert)(typeof start === "number" && typeof end === "number", "Start and end must be numbers if mergeTreeEnableSidedObliterate is not enabled.");
+            this.obliterateRangeSided({ pos: start, side: sequencePlace_js_1.Side.Before }, { pos: end - 1, side: sequencePlace_js_1.Side.After }, refSeq, clientId, seq, overwrite, opArgs);
+        }
+    }
     markRangeRemoved(start, end, refSeq, clientId, seq, overwrite = false, opArgs) {
         let _overwrite = overwrite;
         this.ensureIntervalBoundary(start, refSeq, clientId);