@fluidframework/merge-tree 0.58.3000-61081 → 0.59.2000-61729

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/merge-tree",
-  "version": "0.58.3000-61081",
+  "version": "0.59.2000-61729",
   "description": "Merge tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -60,21 +60,21 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^0.47.1000",
-    "@fluidframework/core-interfaces": "^0.42.0",
-    "@fluidframework/datastore-definitions": "0.58.3000-61081",
-    "@fluidframework/protocol-definitions": "^0.1027.1000",
-    "@fluidframework/runtime-definitions": "0.58.3000-61081",
-    "@fluidframework/runtime-utils": "0.58.3000-61081",
-    "@fluidframework/shared-object-base": "0.58.3000-61081",
-    "@fluidframework/telemetry-utils": "0.58.3000-61081"
+    "@fluidframework/container-definitions": "^0.48.1000-0",
+    "@fluidframework/core-interfaces": "^0.43.1000-0",
+    "@fluidframework/datastore-definitions": "0.59.2000-61729",
+    "@fluidframework/protocol-definitions": "^0.1028.1000-0",
+    "@fluidframework/runtime-definitions": "0.59.2000-61729",
+    "@fluidframework/runtime-utils": "0.59.2000-61729",
+    "@fluidframework/shared-object-base": "0.59.2000-61729",
+    "@fluidframework/telemetry-utils": "0.59.2000-61729"
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.27.2000-59622",
-    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@0.58.2000",
-    "@fluidframework/mocha-test-setup": "0.58.3000-61081",
-    "@fluidframework/test-runtime-utils": "0.58.3000-61081",
+    "@fluidframework/eslint-config-fluid": "^0.28.1000-61189",
+    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@^0.58.0",
+    "@fluidframework/mocha-test-setup": "0.59.2000-61729",
+    "@fluidframework/test-runtime-utils": "0.59.2000-61729",
     "@microsoft/api-extractor": "^7.16.1",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/diff": "^3.5.1",
@@ -103,7 +103,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "0.58.3000",
+    "version": "0.59.1000",
     "broken": {},
     "disabled": true
   }

package/src/localReference.ts

@@ -134,7 +134,8 @@ export class LocalReferenceCollection {
             if (!seg1.localRefs) {
                 seg1.localRefs = new LocalReferenceCollection(seg1);
             }
-            assert(seg1.localRefs.refsByOffset.length === seg1.cachedLength, "LocalReferences array contains a gap");
+            assert(seg1.localRefs.refsByOffset.length === seg1.cachedLength,
+                0x2be /* "LocalReferences array contains a gap" */);
             seg1.localRefs.append(seg2.localRefs);
         }
         else if (seg1.localRefs) {

package/src/mergeTree.ts

@@ -104,15 +104,21 @@ export interface IHierBlock extends IMergeBlock {
 }
 
 export interface IRemovalInfo {
-    removedSeq?: number;
-    removedClientId?: number;
-    removedClientOverlap?: number[];
+    removedSeq: number;
+    removedClientIds: number[];
+}
+export function toRemovalInfo(maybe: Partial<IRemovalInfo> | undefined): IRemovalInfo | undefined {
+    if (maybe?.removedClientIds !== undefined && maybe?.removedSeq !== undefined) {
+        return maybe as IRemovalInfo;
+    }
+    assert(maybe?.removedClientIds === undefined && maybe?.removedSeq === undefined,
+        0x2bf /* "both removedClientIds and removedSeq should be set or not set" */);
 }
 
 /**
  * A segment representing a portion of the merge tree.
  */
-export interface ISegment extends IMergeNodeCommon, IRemovalInfo {
+export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo> {
     readonly type: string;
     readonly segmentGroups: SegmentGroupCollection;
     readonly trackingCollection: TrackingGroupCollection;
@@ -482,8 +488,7 @@ export abstract class BaseSegment extends MergeNode implements ISegment {
     public clientId: number = LocalClientId;
     public seq: number = UniversalSequenceNumber;
     public removedSeq?: number;
-    public removedClientId?: number;
-    public removedClientOverlap?: number[];
+    public removedClientIds?: number[];
     public readonly segmentGroups: SegmentGroupCollection = new SegmentGroupCollection(this);
     public readonly trackingCollection: TrackingGroupCollection = new TrackingGroupCollection(this);
     public propertyManager?: PropertiesManager;
@@ -521,7 +526,7 @@ export abstract class BaseSegment extends MergeNode implements ISegment {
         b.clientId = this.clientId;
         // TODO: deep clone properties
         b.properties = clone(this.properties);
-        b.removedClientId = this.removedClientId;
+        b.removedClientIds = this.removedClientIds?.slice();
         // TODO: copy removed client overlap and branch removal info
         b.removedSeq = this.removedSeq;
         b.seq = this.seq;
@@ -555,10 +560,9 @@ export abstract class BaseSegment extends MergeNode implements ISegment {
                 return true;
 
             case MergeTreeDeltaType.REMOVE:
-                // eslint-disable-next-line @typescript-eslint/no-this-alias
-                const removalInfo: IRemovalInfo = this;
-                assert(!!removalInfo, 0x046 /* "On remove ack, missing removal info!" */);
-                assert(!!removalInfo.removedSeq, 0x047 /* "On remove ack, missing removed sequence number!" */);
+
+                const removalInfo: IRemovalInfo | undefined = toRemovalInfo(this);
+                assert(removalInfo !== undefined, 0x046 /* "On remove ack, missing removal info!" */);
                 this.localRemovedSeq = undefined;
                 if (removalInfo.removedSeq === UnassignedSequenceNumber) {
                     removalInfo.removedSeq = opArgs.sequencedMessage!.sequenceNumber;
@@ -584,15 +588,12 @@ export abstract class BaseSegment extends MergeNode implements ISegment {
                 // but this ordinal meets all the necessary invariants for now.
                 leafSegment.ordinal = this.ordinal + String.fromCharCode(0);
 
-                leafSegment.removedClientId = this.removedClientId;
+                leafSegment.removedClientIds = this.removedClientIds?.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) {
@@ -1091,8 +1092,8 @@ export class MergeTree {
     }
 
     public localNetLength(segment: ISegment) {
-        const removalInfo: IRemovalInfo = segment;
-        if (removalInfo.removedSeq !== undefined) {
+        const removalInfo = toRemovalInfo(segment);
+        if (removalInfo !== undefined) {
             return 0;
         } else {
             return segment.cachedLength;
@@ -1458,9 +1459,9 @@ export class MergeTree {
                 return node.partialLengths!.getPartialLength(refSeq, clientId);
             } else {
                 const segment = node;
-                const removalInfo: IRemovalInfo = segment;
+                const removalInfo = toRemovalInfo(segment);
 
-                if(removalInfo.removedSeq !== undefined
+                if(removalInfo !== undefined
                     && removalInfo.removedSeq !== UnassignedSequenceNumber
                     && removalInfo.removedSeq <= refSeq) {
                     // this segment is a tombstone eligible for zamboni
@@ -1471,12 +1472,8 @@ export class MergeTree {
                 if (((segment.clientId === clientId) ||
                     ((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 !== undefined) {
+                        if (removalInfo.removedClientIds.includes(clientId)) {
                             return 0;
                         } else {
                             return segment.cachedLength;
@@ -1488,7 +1485,7 @@ export 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 !== UnassignedSequenceNumber) {
                         return undefined;
                     }
@@ -2296,13 +2293,6 @@ export class MergeTree {
         }
     }
 
-    private addOverlappingClient(removalInfo: IRemovalInfo, clientId: number) {
-        if (!removalInfo.removedClientOverlap) {
-            removalInfo.removedClientOverlap = <number[]>[];
-        }
-        removalInfo.removedClientOverlap.push(clientId);
-    }
-
     /**
      * Annotate a range with properties
      * @param start - The inclusive start position of the range to annotate
@@ -2373,21 +2363,24 @@ export class MergeTree {
         const savedLocalRefs: LocalReferenceCollection[] = [];
         const localSeq = seq === UnassignedSequenceNumber ? ++this.collabWindow.localSeq : undefined;
         const markRemoved = (segment: ISegment, pos: number, _start: number, _end: number) => {
-            const removalInfo: IRemovalInfo = segment;
-            if (removalInfo.removedSeq !== undefined) {
+            const existingRemovalInfo = toRemovalInfo(segment);
+            if (existingRemovalInfo !== undefined) {
                 _overwrite = true;
-                if (removalInfo.removedSeq === UnassignedSequenceNumber) {
-                    // replace because comes later
-                    removalInfo.removedClientId = clientId;
-                    removalInfo.removedSeq = seq;
+                if (existingRemovalInfo.removedSeq === 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 });
@@ -2399,9 +2392,7 @@ export class MergeTree {
 
             // Save segment so can assign removed sequence number when acked by server
             if (this.collabWindow.collaborating) {
-                // Use removal information
-                const _removalInfo: IRemovalInfo = segment;
-                if (_removalInfo.removedSeq === UnassignedSequenceNumber && clientId === this.collabWindow.clientId) {
+                if (segment.removedSeq === UnassignedSequenceNumber && clientId === this.collabWindow.clientId) {
                     segmentGroup = this.addToPendingList(segment, segmentGroup, localSeq);
                 } else {
                     if (MergeTree.options.zamboniSegments) {

package/src/partialLengths.ts

@@ -14,6 +14,7 @@ import {
     IRemovalInfo,
     ISegment,
     MergeTree,
+    toRemovalInfo,
 } from "./mergeTree";
 
 interface IOverlapClient {
@@ -81,7 +82,7 @@ export class PartialSequenceLengths {
         collabWindow: CollaborationWindow,
         recur = false) {
         let combinedPartialLengths = new PartialSequenceLengths(collabWindow.minSeq);
-        PartialSequenceLengths.fromLeaves(mergeTree, combinedPartialLengths, block, collabWindow);
+        PartialSequenceLengths.fromLeaves(combinedPartialLengths, block, collabWindow);
         let prevPartial: PartialSequenceLength | undefined;
 
         function cloneOverlapRemoveClients(oldTree: RedBlackTree<number, IOverlapClient> | undefined) {
@@ -209,13 +210,13 @@ export class PartialSequenceLengths {
     }
 
     private static fromLeaves(
-        mergeTree: MergeTree, combinedPartialLengths: PartialSequenceLengths,
+        combinedPartialLengths: PartialSequenceLengths,
         block: IMergeBlock, collabWindow: CollaborationWindow) {
         combinedPartialLengths.minLength = 0;
         combinedPartialLengths.segmentCount = block.childCount;
 
-        function seqLTE(seq: number, minSeq: number) {
-            return (seq !== UnassignedSequenceNumber) && (seq <= minSeq);
+        function seqLTE(seq: number | undefined, minSeq: number) {
+            return seq !== undefined && seq !== UnassignedSequenceNumber && seq <= minSeq;
         }
 
         for (let i = 0; i < block.childCount; i++) {
@@ -223,21 +224,19 @@ export class PartialSequenceLengths {
             if (child.isLeaf()) {
                 // Leaf segment
                 const segment = child;
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                if (seqLTE(segment.seq!, collabWindow.minSeq)) {
+                if (seqLTE(segment.seq, collabWindow.minSeq)) {
                     combinedPartialLengths.minLength += segment.cachedLength;
                 } else {
                     if (segment.seq !== UnassignedSequenceNumber) {
                         PartialSequenceLengths.insertSegment(combinedPartialLengths, segment);
                     }
                 }
-                const removalInfo: IRemovalInfo = segment;
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                if (seqLTE(removalInfo.removedSeq!, collabWindow.minSeq)) {
+                const removalInfo = toRemovalInfo(segment);
+                if (seqLTE(removalInfo?.removedSeq, collabWindow.minSeq)) {
                     combinedPartialLengths.minLength -= segment.cachedLength;
                 } else {
-                    if ((removalInfo.removedSeq !== undefined) &&
-                        (removalInfo.removedSeq !== UnassignedSequenceNumber)) {
+                    if (removalInfo !== undefined
+                        && removalInfo.removedSeq !== UnassignedSequenceNumber) {
                         PartialSequenceLengths.insertSegment(
                             combinedPartialLengths,
                             segment,
@@ -300,14 +299,15 @@ export class PartialSequenceLengths {
         let removeClientOverlap: number[] | undefined;
 
         if (removalInfo) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            seq = removalInfo.removedSeq!;
+            seq = removalInfo.removedSeq;
             segmentLen = -segmentLen;
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            clientId = removalInfo.removedClientId!;
-            if (removalInfo.removedClientOverlap) {
-                removeClientOverlap = removalInfo.removedClientOverlap;
-            }
+            // this code still assume removed client id and
+            // overlap clients are separate. so we need to pull
+            // then apart first.
+            clientId = removalInfo.removedClientIds[0];
+            removeClientOverlap = removalInfo.removedClientIds.length > 1
+                ? removalInfo.removedClientIds.slice(1)
+                : undefined;
         }
 
         const seqPartials = combinedPartialLengths.partialLengths;
@@ -421,14 +421,14 @@ export class PartialSequenceLengths {
                 segCount += branchPartialLengths.segmentCount;
             } else {
                 const segment = child;
-                const removalInfo: IRemovalInfo = segment;
+                const removalInfo = toRemovalInfo(segment);
 
                 if (segment.seq === seq) {
-                    if (removalInfo.removedSeq !== seq) {
+                    if (removalInfo?.removedSeq !== seq) {
                         seqSeglen += segment.cachedLength;
                     }
                 } else {
-                    if (removalInfo.removedSeq === seq) {
+                    if (removalInfo?.removedSeq === seq) {
                         seqSeglen -= segment.cachedLength;
                     }
                 }

package/src/snapshotLoader.ts

@@ -107,14 +107,11 @@ export class SnapshotLoader {
             // this will only cause problems if there is an overlapping delete
             // spanning the snapshot, which should be rare
             if (spec.removedClient !== undefined) {
-                seg.removedClientId = this.client.getOrAddShortClientId(spec.removedClient);
+                seg.removedClientIds = [this.client.getOrAddShortClientId(spec.removedClient)];
             }
             if (spec.removedClientIds !== undefined) {
-                seg.removedClientId = this.client.getOrAddShortClientId(spec.removedClientIds[0]);
-                if(spec.removedClientIds.length > 1) {
-                    seg.removedClientOverlap = spec.removedClientIds.slice(1).map(
-                        (sid)=> this.client.getOrAddShortClientId(sid));
-                }
+                seg.removedClientIds = spec.removedClientIds?.map(
+                    (sid)=> this.client.getOrAddShortClientId(sid));
             }
         } else {
             seg = this.client.specToSegment(spec);

package/src/snapshotV1.ts

@@ -220,15 +220,12 @@ export class SnapshotV1 {
                     raw.removedSeq = segment.removedSeq;
 
                     // back compat for when we split overlap and removed client
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    raw.removedClient = this.getLongClientId(segment.removedClientId!);
+                    raw.removedClient =
+                        segment.removedClientIds !== undefined
+                            ? this.getLongClientId(segment.removedClientIds[0])
+                            : undefined;
 
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    const removedClientIds = [segment.removedClientId!];
-                    if(segment.removedClientOverlap !== undefined) {
-                        removedClientIds.push(... segment.removedClientOverlap);
-                    }
-                    raw.removedClientIds = removedClientIds.map((id)=>this.getLongClientId(id));
+                    raw.removedClientIds = segment.removedClientIds?.map((id)=>this.getLongClientId(id));
                 }
 
             // Sanity check that we are preserving either the seq < minSeq or a removed segment's info.