@fluidframework/merge-tree 1.0.1 → 1.1.0-75972

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/merge-tree",
-  "version": "1.0.1",
+  "version": "1.1.0-75972",
   "description": "Merge tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -61,23 +61,23 @@
   "dependencies": {
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^1.0.1",
-    "@fluidframework/container-utils": "^1.0.1",
-    "@fluidframework/core-interfaces": "^1.0.1",
-    "@fluidframework/datastore-definitions": "^1.0.1",
+    "@fluidframework/container-definitions": "1.1.0-75972",
+    "@fluidframework/container-utils": "1.1.0-75972",
+    "@fluidframework/core-interfaces": "1.1.0-75972",
+    "@fluidframework/datastore-definitions": "1.1.0-75972",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/runtime-definitions": "^1.0.1",
-    "@fluidframework/runtime-utils": "^1.0.1",
-    "@fluidframework/shared-object-base": "^1.0.1",
-    "@fluidframework/telemetry-utils": "^1.0.1"
+    "@fluidframework/runtime-definitions": "1.1.0-75972",
+    "@fluidframework/runtime-utils": "1.1.0-75972",
+    "@fluidframework/shared-object-base": "1.1.0-75972",
+    "@fluidframework/telemetry-utils": "1.1.0-75972"
   },
   "devDependencies": {
-    "@fluidframework/build-common": "^0.23.0",
+    "@fluidframework/build-common": "^0.24.0-0",
     "@fluidframework/build-tools": "^0.2.71273",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@^0.58.0",
-    "@fluidframework/mocha-test-setup": "^1.0.1",
-    "@fluidframework/test-runtime-utils": "^1.0.1",
+    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@^1.0.0",
+    "@fluidframework/mocha-test-setup": "1.1.0-75972",
+    "@fluidframework/test-runtime-utils": "1.1.0-75972",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/diff": "^3.5.1",
@@ -98,82 +98,10 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.0.0",
+    "version": "1.1.0",
     "broken": {
-      "ClassDeclaration_BaseSegment": {
-        "forwardCompat": false
-      },
       "ClassDeclaration_Client": {
         "forwardCompat": false
-      },
-      "InterfaceDeclaration_IConsensusInfo": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_IHierBlock": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_IMergeBlock": {
-        "forwardCompat": false
-      },
-      "TypeAliasDeclaration_IMergeNode": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_IMergeNodeCommon": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_IncrementalMapState": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_InsertContext": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_IRemovalInfo": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_ISegmentChanges": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_LocalReference": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "ClassDeclaration_LocalReferenceCollection": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_LRUSegment": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_Marker": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "ClassDeclaration_MergeBlock": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_MergeNode": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_MergeTree": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_SnapshotLegacy": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_TextSegment": {
-        "forwardCompat": false
-      },
-      "ClassDeclaration_List": {
-        "forwardCompat": false
-      },
-      "InterfaceDeclaration_IJSONMarkerSegment": {
-        "backCompat": false
-      },
-      "InterfaceDeclaration_IMarkerDef": {
-        "backCompat": false
-      },
-      "EnumDeclaration_ReferenceType": {
-        "backCompat": false
       }
     }
   }

package/src/client.ts

@@ -16,7 +16,7 @@ import { LoggingError } from "@fluidframework/telemetry-utils";
 import { IIntegerRange } from "./base";
 import { RedBlackTree } from "./collections";
 import { UnassignedSequenceNumber, UniversalSequenceNumber } from "./constants";
-import { LocalReference, _validateReferenceType } from "./localReference";
+import { LocalReference, LocalReferencePosition } from "./localReference";
 import {
     CollaborationWindow,
     compareStrings,
@@ -53,7 +53,7 @@ import { SnapshotLegacy } from "./snapshotlegacy";
 import { SnapshotLoader } from "./snapshotLoader";
 import { MergeTreeTextHelper } from "./textSegment";
 import { SnapshotV1 } from "./snapshotV1";
-import { ReferencePosition, RangeStackMap, DetachedReferencePosition } from "./referencePositions";
+import { ReferencePosition, RangeStackMap } from "./referencePositions";
 import {
     IMergeTreeClientSequenceArgs,
     IMergeTreeDeltaOpArgs,
@@ -333,21 +333,17 @@ export class Client {
     }
 
     public createLocalReferencePosition(
-        segment: ISegment, offset: number, refType: ReferenceType, properties: PropertySet | undefined,
-    ): ReferencePosition {
+        segment: ISegment, offset: number | undefined, refType: ReferenceType, properties: PropertySet | undefined,
+    ): LocalReferencePosition {
         return this.mergeTree.createLocalReferencePosition(segment, offset, refType, properties, this);
     }
 
-    public removeLocalReferencePosition(lref: ReferencePosition) {
+    public removeLocalReferencePosition(lref: LocalReferencePosition) {
         return this.mergeTree.removeLocalReferencePosition(lref);
     }
 
     public localReferencePositionToPosition(lref: ReferencePosition) {
-        const segment = lref.getSegment();
-        if (segment === undefined) {
-            return DetachedReferencePosition;
-        }
-        return this.getPosition(segment) + lref.getOffset();
+        return this.mergeTree.referencePositionToLocalPosition(lref);
     }
 
     /**
@@ -713,6 +709,61 @@ export class Client {
         return segmentPosition;
     }
 
+    /**
+     * Rebases a (local) position from the perspective `{ seq: seqNumberFrom, localSeq }` to the perspective
+     * of the current sequence number. This is desirable when rebasing operations for reconnection.
+     *
+     * If the position refers to a segment/offset that was removed by some operation between `seqNumberFrom` and
+     * the current sequence number, the returned position will align with the position of a reference given
+     * `SlideOnRemove` semantics.
+     */
+    public rebasePosition(
+        pos: number,
+        seqNumberFrom: number,
+        localSeq: number,
+    ): number {
+        assert(localSeq <= this.mergeTree.collabWindow.localSeq, 0x300 /* localSeq greater than collab window */);
+        let segment: ISegment | undefined;
+        let posAccumulated = 0;
+        let offset = pos;
+        const isInsertedInView = (seg: ISegment) =>
+            (seg.seq !== undefined && seg.seq !== UnassignedSequenceNumber && seg.seq <= seqNumberFrom)
+            || (seg.localSeq !== undefined && seg.localSeq <= localSeq);
+
+        const isRemovedFromView = ({ removedSeq, localRemovedSeq }: ISegment) =>
+            (removedSeq !== undefined && removedSeq !== UnassignedSequenceNumber && removedSeq <= seqNumberFrom)
+            || (localRemovedSeq !== undefined && localRemovedSeq <= localSeq);
+
+        this.mergeTree.walkAllSegments(this.mergeTree.root, (seg) => {
+            assert(seg.seq !== undefined || seg.localSeq !== undefined,
+                0x301 /* Either seq or localSeq should be defined */);
+            segment = seg;
+
+            if (isInsertedInView(seg) && !isRemovedFromView(seg)) {
+                posAccumulated += seg.cachedLength;
+                if (offset >= seg.cachedLength) {
+                    offset -= seg.cachedLength;
+                }
+            }
+
+            // Keep going while we've yet to reach the segment at the desired position
+            return posAccumulated <= pos;
+        });
+
+        assert(segment !== undefined, 0x302 /* No segment found */);
+        const seqNumberTo = this.getCollabWindow().currentSeq;
+        if ((segment.removedSeq !== undefined &&
+             segment.removedSeq !== UnassignedSequenceNumber &&
+             segment.removedSeq <= seqNumberTo)
+            || (segment.localRemovedSeq !== undefined && segment.localRemovedSeq <= localSeq)) {
+            // Segment that the position was in has been removed: null out offset.
+            offset = 0;
+        }
+
+        assert(0 <= offset && offset < segment.cachedLength, 0x303 /* Invalid offset */);
+        return this.findReconnectionPosition(segment, localSeq) + offset;
+    }
+
     private resetPendingDeltaToOps(
         resetOp: IMergeTreeDeltaOp,
         segmentGroup: SegmentGroup): IMergeTreeDeltaOp[] {

package/src/index.ts

@@ -7,7 +7,7 @@ export * from "./base";
 export * from "./client";
 export * from "./collections";
 export * from "./constants";
-export { LocalReference, LocalReferenceCollection } from "./localReference";
+export { LocalReference, LocalReferencePosition, LocalReferenceCollection } from "./localReference";
 export * from "./mergeTree";
 export * from "./mergeTreeDeltaCallback";
 export * from "./mergeTreeTracking";

package/src/localReference.ts

@@ -46,10 +46,14 @@ export function _validateReferenceType(refType: ReferenceType) {
     }
 }
 
+export interface LocalReferencePosition extends ReferencePosition {
+    callbacks?: Partial<Record<"beforeSlide" | "afterSlide", () => void>>;
+}
+
 /**
- * @deprecated - Use ReferencePosition
+ * @deprecated - Use LocalReferencePosition
  */
-export class LocalReference implements ReferencePosition {
+export class LocalReference implements LocalReferencePosition {
     /**
      * @deprecated - use DetachedReferencePosition
      */
@@ -65,6 +69,8 @@ export class LocalReference implements ReferencePosition {
      */
     public segment: ISegment | undefined;
 
+    public callbacks?: Partial<Record<"beforeSlide" | "afterSlide", () => void>> | undefined;
+
     /**
      * @deprecated - use createReferencePosition
      */
@@ -166,9 +172,6 @@ export class LocalReference implements ReferencePosition {
     }
 
     public getOffset() {
-        if (this.segment?.removedSeq) {
-            return 0;
-        }
         return this.offset;
     }
 
@@ -308,7 +311,7 @@ export class LocalReferenceCollection {
      * @internal - this method should only be called by mergeTree
      */
     public createLocalRef(
-        offset: number,
+        offset: number | undefined,
         refType: ReferenceType,
         properties: PropertySet | undefined,
         client: Client): ReferencePosition {

package/src/mergeTree.ts

@@ -24,7 +24,7 @@ import {
     UnassignedSequenceNumber,
     UniversalSequenceNumber,
 } from "./constants";
-import { LocalReference, LocalReferenceCollection } from "./localReference";
+import { LocalReference, LocalReferenceCollection, LocalReferencePosition } from "./localReference";
 import {
     IMergeTreeDeltaOpArgs,
     IMergeTreeSegmentDelta,
@@ -1431,32 +1431,31 @@ export class MergeTree {
         if (!segoff.segment || !isRemovedAndAcked(segoff.segment)) {
             return segoff;
         }
-        // Slide to the next farthest valid segment in the tree. If no such segment is found
-        // slide to the last valid segment.
-        // TODO this walks the whole tree to find the segment - could write a more efficient
-        // walk that starts at the segment
-        let foundStart = false;
-        let foundSegmentPastStart = false;
         let slideToSegment: ISegment | undefined;
-        this.walkAllSegments(this.root, (seg) => {
+        const goFurtherToFindSlideToSegment = (seg) => {
             if (seg.seq !== UnassignedSequenceNumber && !isRemovedAndAcked(seg)) {
                 slideToSegment = seg;
-                if (foundStart) {
-                    foundSegmentPastStart = true;
-                    return false;
-                }
-            }
-            if (!foundStart && seg === segoff.segment) {
-                foundStart = true;
+                return false;
             }
             return true;
-        });
-        let offset = 0;
-        if (slideToSegment && !foundSegmentPastStart) {
+        };
+        // Slide to the next farthest valid segment in the tree.
+        this.rightExcursion(segoff.segment, goFurtherToFindSlideToSegment);
+        if (slideToSegment) {
+            return { segment: slideToSegment, offset: 0 };
+        }
+        // If no such segment is found, slide to the last valid segment.
+        this.leftExcursion(segoff.segment, goFurtherToFindSlideToSegment);
+
+        // Workaround TypeScript issue (https://github.com/microsoft/TypeScript/issues/9998)
+        slideToSegment = slideToSegment as ISegment | undefined;
+
+        if (slideToSegment) {
             // If slid nearer then offset should be at the end of the segment
-            offset = slideToSegment.cachedLength - 1;
+            return { segment: slideToSegment, offset: slideToSegment.cachedLength - 1 };
         }
-        return { segment: slideToSegment, offset };
+
+        return { segment: undefined, offset: 0 };
     }
 
     /**
@@ -1476,6 +1475,7 @@ export class MergeTree {
             newSegment.localRefs = new LocalReferenceCollection(newSegment);
         }
         for (const ref of refsToSlide) {
+            ref.callbacks?.beforeSlide?.();
             const removedRef = segment.localRefs.removeLocalRef(ref);
             assert(ref === removedRef, 0x2f3 /* Ref not in the segment localRefs */);
             if (!newSegment) {
@@ -1488,6 +1488,7 @@ export class MergeTree {
                 assert(!!newSegment.localRefs, 0x2f4 /* localRefs must be allocated */);
                 newSegment.localRefs.addLocalRef(ref);
             }
+            ref.callbacks?.afterSlide?.();
         }
         // TODO is it required to update the path lengths?
         if (newSegment) {
@@ -1787,11 +1788,10 @@ export class MergeTree {
         if (pendingSegmentGroup !== undefined) {
             const deltaSegments: IMergeTreeSegmentDelta[] = [];
             pendingSegmentGroup.segments.map((pendingSegment) => {
-                const modified = pendingSegment.ack(pendingSegmentGroup, opArgs, this);
-                // This computation of overwrite appears incorrect. Leaving as is to avoid breaking something.
-                overwrite = !modified || overwrite;
+                const overlappingRemove = !pendingSegment.ack(pendingSegmentGroup, opArgs, this);
+                overwrite = overlappingRemove || overwrite;
 
-                if (modified && opArgs.op.type === MergeTreeDeltaType.REMOVE) {
+                if (!overlappingRemove && opArgs.op.type === MergeTreeDeltaType.REMOVE) {
                     this.updateSegmentRefsAfterMarkRemoved(pendingSegment, false);
                 }
                 if (MergeTree.options.zamboniSegments) {
@@ -2533,7 +2533,7 @@ export class MergeTree {
         }
     }
 
-    public removeLocalReferencePosition(lref: ReferencePosition): ReferencePosition | undefined {
+    public removeLocalReferencePosition(lref: LocalReferencePosition): LocalReferencePosition | undefined {
         const segment = lref.getSegment();
         if (segment) {
             const removedRefs = segment?.localRefs?.removeLocalRef(lref);
@@ -2545,9 +2545,9 @@ export class MergeTree {
         }
     }
     public createLocalReferencePosition(
-        segment: ISegment, offset: number, refType: ReferenceType, properties: PropertySet | undefined,
+        segment: ISegment, offset: number | undefined, refType: ReferenceType, properties: PropertySet | undefined,
         client: Client,
-    ): ReferencePosition {
+    ): LocalReferencePosition {
         if (isRemoved(segment)) {
             if (!refTypeIncludesFlag(refType, ReferenceType.SlideOnRemove)) {
                 throw new UsageError("Can only create SlideOnRemove local reference position on a removed segment");