@fluidframework/merge-tree 0.53.0 → 0.54.2

package/lib/mergeTree.js

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
-/* eslint-disable @typescript-eslint/consistent-type-assertions, @typescript-eslint/no-shadow, max-len, no-bitwise */
+/* eslint-disable @typescript-eslint/consistent-type-assertions */
+/* eslint-disable @typescript-eslint/no-shadow */
+/* eslint-disable no-bitwise */
 import { assert, Trace } from "@fluidframework/common-utils";
 import { Heap, ListMakeHead, Stack, } from "./collections";
 import { LocalClientId, NonCollabClient, TreeMaintenanceSequenceNumber, UnassignedSequenceNumber, UniversalSequenceNumber, } from "./constants";
@@ -151,6 +153,7 @@ export function ordinalToArray(ord) {
 // `MaxNodesInBlock`.  (i.e., `MaxNodesInBlock` contains 1 extra slot for temporary storage to
 // facilitate splits.)
 export const MaxNodesInBlock = 8;
+const traceOrdinals = false;
 export class MergeBlock extends MergeNode {
     constructor(childCount) {
         super();
@@ -177,12 +180,14 @@ export class MergeBlock extends MergeNode {
             localOrdinal = prevOrdCode + ordinalWidth;
         }
         child.ordinal = this.ordinal + String.fromCharCode(localOrdinal);
-        if (MergeBlock.traceOrdinals) {
+        if (traceOrdinals) {
+            // eslint-disable-next-line max-len
             console.log(`so: prnt chld prev ${ordinalToArray(this.ordinal)} ${ordinalToArray(child.ordinal)} ${(index > 0) ? ordinalToArray(this.children[index - 1].ordinal) : "NA"}`);
         }
         assert(child.ordinal.length === (this.ordinal.length + 1), 0x041 /* "Unexpected child ordinal length!" */);
         if (index > 0) {
-            assert(child.ordinal > this.children[index - 1].ordinal, 0x042 /* "Child ordinal <= previous sibling ordinal!" */);
+            assert(child.ordinal > this.children[index - 1].ordinal, 0x042);
+            // eslint-disable-next-line max-len
             // console.log(`${ordinalToArray(this.ordinal)} ${ordinalToArray(child.ordinal)} ${ordinalToArray(this.children[index - 1].ordinal)}`);
             // console.log(`ord width ${ordinalWidth}`);
         }
@@ -196,7 +201,6 @@ export class MergeBlock extends MergeNode {
         this.children[index] = child;
     }
 }
-MergeBlock.traceOrdinals = false;
 class HierMergeBlock extends MergeBlock {
     constructor(childCount) {
         super(childCount);
@@ -233,7 +237,7 @@ function nodeTotalLength(mergeTree, node) {
 }
 export class BaseSegment extends MergeNode {
     constructor() {
-        super();
+        super(...arguments);
         this.clientId = LocalClientId;
         this.seq = UniversalSequenceNumber;
         this.segmentGroups = new SegmentGroupCollection(this);
@@ -285,7 +289,8 @@ export class BaseSegment extends MergeNode {
                 this.localSeq = undefined;
                 return true;
             case 1 /* REMOVE */:
-                const removalInfo = mergeTree.getRemovalInfo(this);
+                // eslint-disable-next-line @typescript-eslint/no-this-alias
+                const removalInfo = this;
                 assert(!!removalInfo, 0x046 /* "On remove ack, missing removal info!" */);
                 assert(!!removalInfo.removedSeq, 0x047 /* "On remove ack, missing removed sequence number!" */);
                 this.localRemovedSeq = undefined;
@@ -344,10 +349,10 @@ export const reservedTileLabelsKey = "referenceTileLabels";
 export const reservedRangeLabelsKey = "referenceRangeLabels";
 export const reservedMarkerIdKey = "markerId";
 export const reservedMarkerSimpleTypeKey = "markerSimpleType";
-export const refGetTileLabels = (refPos) => (refPos.refType & ReferenceType.Tile) &&
-    refPos.properties ? refPos.properties[reservedTileLabelsKey] : undefined;
-export const refGetRangeLabels = (refPos) => (refPos.refType & (ReferenceType.NestBegin | ReferenceType.NestEnd)) &&
-    refPos.properties ? refPos.properties[reservedRangeLabelsKey] : undefined;
+export const refGetTileLabels = (refPos) => (refPos.refType & ReferenceType.Tile)
+    && refPos.properties ? refPos.properties[reservedTileLabelsKey] : undefined;
+export const refGetRangeLabels = (refPos) => (refPos.refType & (ReferenceType.NestBegin | ReferenceType.NestEnd))
+    && refPos.properties ? refPos.properties[reservedRangeLabelsKey] : undefined;
 export function refHasTileLabel(refPos, label) {
     const tileLabels = refPos.getTileLabels();
     if (tileLabels) {
@@ -669,11 +674,12 @@ export class MergeTree {
         this.packTime = 0;
         this.ordTime = 0;
         this.maxOrdTime = 0;
+        this.blockUpdateActions = MergeTree.initBlockUpdateActions;
         this.collabWindow = new CollaborationWindow();
-        // TODO: change this to ES6 map; add remove on segment remove
+        // TODO: add remove on segment remove
         // for now assume only markers have ids and so point directly at the Segment
         // if we need to have pointers to non-markers, we can change to point at local refs
-        this.idToSegment = createMap();
+        this.idToSegment = new Map();
         this.splitLeafSegment = (segment, pos) => {
             if (!(pos > 0 && segment)) {
                 return {};
@@ -687,7 +693,6 @@ export class MergeTree {
             }
             return { next };
         };
-        this.blockUpdateActions = MergeTree.initBlockUpdateActions;
         this.root = this.makeBlock(0);
     }
     makeBlock(childCount) {
@@ -730,7 +735,7 @@ export class MergeTree {
         return b;
     }
     localNetLength(segment) {
-        const removalInfo = this.getRemovalInfo(segment);
+        const removalInfo = segment;
         if (removalInfo.removedSeq !== undefined) {
             return 0;
         }
@@ -740,13 +745,14 @@ export class MergeTree {
     }
     // TODO: remove id when segment removed
     mapIdToSegment(id, segment) {
-        this.idToSegment[id] = segment;
+        this.idToSegment.set(id, segment);
     }
     addNode(block, node) {
         const index = block.childCount++;
         block.assignChild(node, index, false);
         return index;
     }
+    /* eslint-disable max-len */
     reloadFromSegments(segments) {
         // This code assumes that a later call to `startCollaboration()` will initialize partial lengths.
         assert(!this.collabWindow.collaborating, 0x049 /* "Trying to reload from segments while collaborating!" */);
@@ -795,6 +801,7 @@ export class MergeTree {
             console.log(`reload time ${elapsedMicroseconds(clockStart)}`);
         }
     }
+    /* eslint-enable max-len */
     // For now assume min starts at zero
     startCollaboration(localClientId, minSeq, currentSeq) {
         this.collabWindow.clientId = localClientId;
@@ -842,10 +849,10 @@ export class MergeTree {
                         }
                         else {
                             if (MergeTree.traceZRemove) {
-                                // eslint-disable-next-line @typescript-eslint/dot-notation
+                                // eslint-disable-next-line @typescript-eslint/dot-notation, max-len
                                 console.log(`${this.getLongClientId(this.collabWindow.clientId)}: Zremove ${segment["text"]}; cli ${this.getLongClientId(segment.clientId)}`);
                             }
-                            // Notify maintenance event observers that the segment is being unlinked from the MergeTree.
+                            // Notify maintenance event observers that the segment is being unlinked from the MergeTree
                             if (this.mergeTreeMaintenanceCallback) {
                                 this.mergeTreeMaintenanceCallback({
                                     operation: -3 /* UNLINK */,
@@ -865,7 +872,7 @@ export class MergeTree {
                                 && this.localNetLength(segment) > 0;
                             if (canAppend) {
                                 if (MergeTree.traceAppend) {
-                                    // eslint-disable-next-line @typescript-eslint/dot-notation
+                                    // eslint-disable-next-line @typescript-eslint/dot-notation, max-len
                                     console.log(`${this.getLongClientId(this.collabWindow.clientId)}: append ${prevSegment["text"]} + ${segment["text"]}; cli ${this.getLongClientId(prevSegment.clientId)} + cli ${this.getLongClientId(segment.clientId)}`);
                                 }
                                 prevSegment.append(segment);
@@ -1016,7 +1023,14 @@ export class MergeTree {
     }
     getStats() {
         const nodeGetStats = (block) => {
-            const stats = { maxHeight: 0, nodeCount: 0, leafCount: 0, removedLeafCount: 0, liveCount: 0, histo: [] };
+            const stats = {
+                maxHeight: 0,
+                nodeCount: 0,
+                leafCount: 0,
+                removedLeafCount: 0,
+                liveCount: 0,
+                histo: [],
+            };
             for (let k = 0; k < MaxNodesInBlock; k++) {
                 stats.histo[k] = 0;
             }
@@ -1127,21 +1141,6 @@ export class MergeTree {
         }
         return totalOffset;
     }
-    cloneSegments(refSeq, clientId, start = 0, end) {
-        let _end = end;
-        const gatherSegment = (segment, pos, refSeq, clientId, start, end, accumSegments) => {
-            accumSegments.segments.push(segment.clone());
-            return true;
-        };
-        if (_end === undefined) {
-            _end = this.blockLength(this.root, refSeq, clientId);
-        }
-        const accum = {
-            segments: [],
-        };
-        this.mapRange({ leaf: gatherSegment }, refSeq, clientId, accum, start, _end);
-        return accum.segments;
-    }
     getContainingSegment(pos, refSeq, clientId) {
         let segment;
         let offset;
@@ -1161,9 +1160,6 @@ export class MergeTree {
             return node.cachedLength;
         }
     }
-    getRemovalInfo(segment) {
-        return segment;
-    }
     nodeLength(node, refSeq, clientId) {
         if ((!this.collabWindow.collaborating) || (this.collabWindow.clientId === clientId)) {
             // Local client sees all segments, even when collaborating
@@ -1181,7 +1177,7 @@ export class MergeTree {
             }
             else {
                 const segment = node;
-                const removalInfo = this.getRemovalInfo(segment);
+                const removalInfo = segment;
                 if (removalInfo.removedSeq !== undefined
                     && removalInfo.removedSeq !== UnassignedSequenceNumber
                     && removalInfo.removedSeq <= refSeq) {
@@ -1194,8 +1190,9 @@ export class MergeTree {
                     ((segment.seq !== 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.removedClientId === clientId
+                            || (removalInfo.removedClientOverlap
+                                && removalInfo.removedClientOverlap.includes(clientId))) {
                             return 0;
                         }
                         else {
@@ -1236,7 +1233,7 @@ export class MergeTree {
         }
     }
     setMinSeq(minSeq) {
-        assert(minSeq <= this.collabWindow.currentSeq, 0x04e /* "Trying to set minSeq above currentSeq of collab window!" */);
+        assert(minSeq <= this.collabWindow.currentSeq, 0x04e);
         // Only move forward
         assert(this.collabWindow.minSeq <= minSeq, 0x04f /* "minSeq of collab window > target minSeq!" */);
         if (minSeq > this.collabWindow.minSeq) {
@@ -1305,7 +1302,8 @@ export class MergeTree {
         for (let childIndex = 0; childIndex < block.childCount; childIndex++) {
             const child = children[childIndex];
             const len = (_a = this.nodeLength(child, refSeq, clientId)) !== null && _a !== void 0 ? _a : 0;
-            if (((!contains) && (_pos < len)) || (contains && contains(child, _pos, refSeq, clientId, undefined, undefined, clientData))) {
+            if ((!contains && _pos < len)
+                || (contains && contains(child, _pos, refSeq, clientId, undefined, undefined, clientData))) {
                 // Found entry containing pos
                 if (!child.isLeaf()) {
                     return this.searchBlock(child, _pos, _segpos, refSeq, clientId, actions, clientData);
@@ -1436,7 +1434,7 @@ export class MergeTree {
     }
     // TODO: error checking
     getMarkerFromId(id) {
-        return this.idToSegment[id];
+        return this.idToSegment.get(id);
     }
     /**
      * Given a position specified relative to a marker id, lookup the marker
@@ -1628,6 +1626,7 @@ export class MergeTree {
         const checkSegmentIsLocal = (segment, pos, refSeq, clientId) => {
             if (segment.seq === UnassignedSequenceNumber) {
                 if (MergeTree.diagInsertTie) {
+                    // eslint-disable-next-line max-len
                     console.log(`@cli ${glc(this, this.collabWindow.clientId)}: promoting continue due to seq ${segment.seq} text ${segment.toString()} ref ${refSeq}`);
                 }
                 segIsLocal = true;
@@ -1639,6 +1638,7 @@ export class MergeTree {
             segIsLocal = false;
             this.rightExcursion(node, checkSegmentIsLocal);
             if (MergeTree.diagInsertTie && segIsLocal) {
+                // eslint-disable-next-line max-len
                 console.log(`@cli ${glc(this, this.collabWindow.clientId)}: attempting continue with seq ${seq}  ref ${refSeq} `);
             }
             return segIsLocal;
@@ -1837,6 +1837,7 @@ export class MergeTree {
                     }
                     else if (splitNode === MergeTree.theUnfinishedNode) {
                         if (MergeTree.traceTraversal) {
+                            // eslint-disable-next-line max-len
                             console.log(`@cli ${glc(this, this.collabWindow.clientId)} unfinished bus pos ${_pos} len ${len}`);
                         }
                         _pos -= len; // Act as if shifted segment
@@ -1881,6 +1882,7 @@ export class MergeTree {
         }
         if (MergeTree.traceTraversal) {
             if ((!found) && (_pos > 0)) {
+                // eslint-disable-next-line max-len
                 console.log(`inserting walk fell through pos ${_pos} len: ${this.blockLength(this.root, refSeq, clientId)}`);
             }
         }
@@ -1961,6 +1963,7 @@ export class MergeTree {
                 if (i > 0) {
                     if (child.ordinal <= block.children[i - 1].ordinal) {
                         console.log("node sib integrity issue");
+                        // eslint-disable-next-line max-len
                         console.log(`??: prnt chld prev ${ordinalToArray(block.ordinal)} ${ordinalToArray(child.ordinal)} ${(i > 0) ? ordinalToArray(block.children[i - 1].ordinal) : "NA"}`);
                     }
                 }
@@ -2061,9 +2064,10 @@ export class MergeTree {
         const savedLocalRefs = [];
         const localSeq = seq === UnassignedSequenceNumber ? ++this.collabWindow.localSeq : undefined;
         const markRemoved = (segment, pos, start, end) => {
-            const removalInfo = this.getRemovalInfo(segment);
+            const removalInfo = segment;
             if (removalInfo.removedSeq !== undefined) {
                 if (MergeTree.diagOverlappingRemove) {
+                    // eslint-disable-next-line max-len
                     console.log(`yump @seq ${seq} cli ${glc(this, this.collabWindow.clientId)}: overlaps deleted segment ${removalInfo.removedSeq} text '${segment.toString()}'`);
                 }
                 _overwrite = true;
@@ -2091,8 +2095,8 @@ export class MergeTree {
             // Save segment so can assign removed sequence number when acked by server
             if (this.collabWindow.collaborating) {
                 // Use removal information
-                const removalInfo = this.getRemovalInfo(segment);
-                if ((removalInfo.removedSeq === UnassignedSequenceNumber) && (clientId === this.collabWindow.clientId)) {
+                const removalInfo = segment;
+                if (removalInfo.removedSeq === UnassignedSequenceNumber && clientId === this.collabWindow.clientId) {
                     segmentGroup = this.addToPendingList(segment, segmentGroup, localSeq);
                 }
                 else {
@@ -2220,8 +2224,12 @@ export class MergeTree {
     }
     blockUpdateLength(node, seq, clientId) {
         this.blockUpdate(node);
-        if (this.collabWindow.collaborating && (seq !== UnassignedSequenceNumber) && (seq !== TreeMaintenanceSequenceNumber)) {
-            if (node.partialLengths !== undefined && MergeTree.options.incrementalUpdate && clientId !== NonCollabClient) {
+        if (this.collabWindow.collaborating
+            && seq !== UnassignedSequenceNumber
+            && seq !== TreeMaintenanceSequenceNumber) {
+            if (node.partialLengths !== undefined
+                && MergeTree.options.incrementalUpdate
+                && clientId !== NonCollabClient) {
                 node.partialLengths.update(this, node, seq, clientId, this.collabWindow);
             }
             else {
@@ -2247,6 +2255,7 @@ export class MergeTree {
     nodeToString(block, strbuf, indentCount = 0) {
         let _strbuf = strbuf;
         _strbuf += internedSpaces(indentCount);
+        // eslint-disable-next-line max-len
         _strbuf += `Node (len ${block.cachedLength}) p len (${block.parent ? block.parent.cachedLength : 0}) ord ${ordinalToArray(block.ordinal)} with ${block.childCount} segs:\n`;
         if (MergeTree.blockUpdateMarkers) {
             _strbuf += internedSpaces(indentCount);
@@ -2265,8 +2274,9 @@ export class MergeTree {
             else {
                 const segment = child;
                 _strbuf += internedSpaces(indentCount + 4);
+                // eslint-disable-next-line max-len
                 _strbuf += `cli: ${glc(this, segment.clientId)} seq: ${segment.seq} ord: ${ordinalToArray(segment.ordinal)}`;
-                const removalInfo = this.getRemovalInfo(segment);
+                const removalInfo = segment;
                 if (removalInfo.removedSeq !== undefined) {
                     _strbuf += ` rcli: ${glc(this, removalInfo.removedClientId)} rseq: ${removalInfo.removedSeq}`;
                 }
@@ -2305,7 +2315,7 @@ export class MergeTree {
                 const len = (_a = this.nodeLength(child, state.refSeq, state.clientId)) !== null && _a !== void 0 ? _a : 0;
                 if (MergeTree.traceIncrTraversal) {
                     if (child.isLeaf()) {
-                        // eslint-disable-next-line @typescript-eslint/dot-notation
+                        // eslint-disable-next-line @typescript-eslint/dot-notation, max-len
                         console.log(`considering (r ${state.refSeq} c ${glc(this, state.clientId)}) seg with text ${child["text"]} len ${len} seq ${child.seq} rseq ${child.removedSeq} cli ${glc(this, child.clientId)}`);
                     }
                 }
@@ -2372,6 +2382,7 @@ export class MergeTree {
                         segInfo += ` rcli: ${glc(this, segment.removedClientId)} rseq: ${segment.removedSeq}`;
                     }
                 }
+                // eslint-disable-next-line max-len
                 console.log(`@tcli ${glc(this, this.collabWindow.clientId)}: map len: ${len} start: ${_start} end: ${_end} ${segInfo}`);
             }
             if (go && (_end > 0) && (len > 0) && (_start < len)) {
@@ -2442,15 +2453,6 @@ export class MergeTree {
         return go;
     }
 }
-// Maximum length of text segment to be considered to be merged with other segment.
-// Maximum segment length is at least 2x of it (not taking into account initial segment creation).
-// The bigger it is, the more expensive it is to break segment into sub-segments (on edits)
-// The smaller it is, the more segments we have in snapshots (and in memory) - it's more expensive to load snapshots.
-// Small number also makes ReplayTool produce false positives ("same" snapshots have slightly different binary representations).
-// More measurements needs to be done, but it's very likely the right spot is somewhere between 1K-2K mark.
-// That said, we also break segments on newline and there are very few segments that are longer than 256 because of it.
-// must be an even number
-MergeTree.TextSegmentGranularity = 256;
 MergeTree.zamboniSegmentsMaxCount = 2;
 MergeTree.options = {
     incrementalUpdate: true,
@@ -2464,7 +2466,6 @@ MergeTree.traceZRemove = false;
 MergeTree.traceOrdinals = false;
 MergeTree.traceGatherText = false;
 MergeTree.diagInsertTie = false;
-MergeTree.skipLeftShift = true;
 MergeTree.diagOverlappingRemove = false;
 MergeTree.traceTraversal = false;
 MergeTree.traceIncrTraversal = false;