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

package/src/mergeTreeNodes.ts

@@ -48,11 +48,43 @@ export interface IMergeNodeCommon {
 	ordinal: string;
 	isLeaf(): this is ISegment;
 }
+
 /**
+ * This interface exposes internal things to dds that leverage merge tree,
+ * like sequence and matrix.
+ *
+ * We use tiered interface to control visibility of segment properties.
+ * This sits between ISegment and ISegmentLeaf. It should only expose
+ * things tagged internal.
+ *
+ * @internal
+ */
+export type ISegmentInternal = ISegment & {
+	localRefs?: LocalReferenceCollection;
+};
+
+/**
+ * We use tiered interface to control visibility of segment properties.
+ * This is the lowest interface and is not exported, it site below ISegment and ISegmentInternal.
+ * It should only expose unexported things.
+ *
  * someday we may split tree leaves from segments, but for now they are the same
  * this is just a convenience type that makes it clear that we need something that is both a segment and a leaf node
  */
-export type ISegmentLeaf = ISegment & { parent?: MergeBlock };
+export type ISegmentLeaf = ISegmentInternal & {
+	parent?: MergeBlock;
+	// eslint-disable-next-line import/no-deprecated
+	segmentGroups?: SegmentGroupCollection;
+	// eslint-disable-next-line import/no-deprecated
+	propertyManager?: PropertiesManager;
+
+	/**
+	 * If a segment is inserted into an obliterated range,
+	 * but the newest obliteration of that range was by the inserting client,
+	 * then the segment is not obliterated because it is aware of the latest obliteration.
+	 */
+	prevObliterateByInserter?: ObliterateInfo;
+};
 export type IMergeNode = MergeBlock | ISegmentLeaf;
 
 /**
@@ -388,6 +420,7 @@ export interface SegmentActions<TClientData> {
  * @deprecated This functionality was not meant to be exported and will be removed in a future release
  * @legacy
  * @alpha
+ * @privateRemarks After deprecation period this interface should be made internal
  */
 export interface ObliterateInfo {
 	start: LocalReferencePosition;
@@ -661,7 +694,8 @@ export abstract class BaseSegment implements ISegment {
 				return false;
 			}
 
-			case MergeTreeDeltaType.OBLITERATE: {
+			case MergeTreeDeltaType.OBLITERATE:
+			case MergeTreeDeltaType.OBLITERATE_SIDED: {
 				const moveInfo: IMoveInfo | undefined = toMoveInfo(this);
 				assert(moveInfo !== undefined, 0x86e /* On obliterate ack, missing move info! */);
 				const obliterateInfo = segmentGroup.obliterateInfo;
@@ -697,7 +731,6 @@ export abstract class BaseSegment implements ISegment {
 			return undefined;
 		}
 
-		this.copyPropertiesTo(leafSegment);
 		// eslint-disable-next-line @typescript-eslint/no-this-alias, unicorn/no-this-assignment
 		const thisAsMergeSegment: ISegmentLeaf = this;
 		leafSegment.parent = thisAsMergeSegment.parent;
@@ -721,11 +754,8 @@ export abstract class BaseSegment implements ISegment {
 		leafSegment.movedSeqs = this.movedSeqs?.slice();
 		leafSegment.localMovedSeq = this.localMovedSeq;
 		leafSegment.wasMovedOnInsert = this.wasMovedOnInsert;
-		this.segmentGroups.copyTo(leafSegment);
+
 		this.trackingCollection.copyTo(leafSegment);
-		if (this.localRefs) {
-			this.localRefs.split(pos, leafSegment);
-		}
 		if (this.attribution) {
 			leafSegment.attribution = this.attribution.splitAt(pos);
 		}
@@ -733,22 +763,6 @@ export abstract class BaseSegment implements ISegment {
 		return leafSegment;
 	}
 
-	private copyPropertiesTo(other: ISegment): void {
-		if (this.properties !== undefined) {
-			if (this.propertyManager) {
-				// eslint-disable-next-line import/no-deprecated
-				other.propertyManager = new PropertiesManager();
-				other.properties = this.propertyManager.copyTo(
-					this.properties,
-					other.properties,
-					other.propertyManager,
-				);
-			} else {
-				other.properties = clone(this.properties);
-			}
-		}
-	}
-
 	public abstract clone(): ISegment;
 
 	public append(other: ISegment): void {

package/src/opBuilder.ts

@@ -14,8 +14,10 @@ import {
 	IMergeTreeObliterateMsg,
 	IMergeTreeRemoveMsg,
 	MergeTreeDeltaType,
+	type IMergeTreeObliterateSidedMsg,
 } from "./ops.js";
 import { PropertySet } from "./properties.js";
+import { normalizePlace, Side, type SequencePlace } from "./sequencePlace.js";
 
 /**
  * Creates the op for annotating the markers with the provided properties
@@ -97,6 +99,36 @@ export function createObliterateRangeOp(start: number, end: number): IMergeTreeO
 	};
 }
 
+/**
+ * Creates the op to obliterate a range
+ *
+ * @param start - The start of the range to obliterate.
+ * If a number is provided, the range will start before that index.
+ * @param end - The end of the range to obliterate.
+ * If a number is provided, the range will end after that index -1.
+ * This preserves the previous behavior of not expanding obliteration ranges at the endpoints
+ * for uses which predate the availability of endpoint expansion.
+ *
+ * @internal
+ */
+export function createObliterateRangeOpSided(
+	start: SequencePlace,
+	end: SequencePlace,
+): IMergeTreeObliterateSidedMsg {
+	const startPlace = normalizePlace(start);
+	// If a number is provided, default to after the previous index.
+	// This preserves the behavior of obliterate prior to the introduction of endpoint expansion.
+	const endPlace =
+		typeof end === "number"
+			? { pos: end - 1, side: Side.After } // default to inclusive bounds
+			: normalizePlace(end);
+	return {
+		type: MergeTreeDeltaType.OBLITERATE_SIDED,
+		pos1: { pos: startPlace.pos, before: startPlace.side === Side.Before },
+		pos2: { pos: endPlace.pos, before: endPlace.side === Side.Before },
+	};
+}
+
 /**
  * Creates an op for inserting a segment at the specified position.
  *

package/src/ops.ts

@@ -70,6 +70,7 @@ export const MergeTreeDeltaType = {
 	 */
 	GROUP: 3,
 	OBLITERATE: 4,
+	OBLITERATE_SIDED: 5,
 } as const;
 
 /**
@@ -162,6 +163,26 @@ export interface IMergeTreeObliterateMsg extends IMergeTreeDelta {
 	relativePos2?: never;
 }
 
+/**
+ * @legacy
+ * @alpha
+ */
+export interface IMergeTreeObliterateSidedMsg extends IMergeTreeDelta {
+	type: typeof MergeTreeDeltaType.OBLITERATE_SIDED;
+	pos1: { pos: number; before: boolean };
+	/**
+	 * This field is currently unused, but we keep it around to make the union
+	 * type of all merge-tree messages have the same fields
+	 */
+	relativePos1?: never;
+	pos2: { pos: number; before: boolean };
+	/**
+	 * This field is currently unused, but we keep it around to make the union
+	 * type of all merge-tree messages have the same fields
+	 */
+	relativePos2?: never;
+}
+
 /**
  * @legacy
  * @alpha
@@ -206,7 +227,8 @@ export type IMergeTreeDeltaOp =
 	| IMergeTreeInsertMsg
 	| IMergeTreeRemoveMsg
 	| IMergeTreeAnnotateMsg
-	| IMergeTreeObliterateMsg;
+	| IMergeTreeObliterateMsg
+	| IMergeTreeObliterateSidedMsg;
 
 /**
  * @legacy

package/src/revertibles.ts

@@ -12,7 +12,12 @@ import { LocalReferenceCollection, LocalReferencePosition } from "./localReferen
 import { MergeTree, findRootMergeBlock } from "./mergeTree.js";
 import { IMergeTreeDeltaCallbackArgs } from "./mergeTreeDeltaCallback.js";
 import { depthFirstNodeWalk } from "./mergeTreeNodeWalk.js";
-import { ISegment, ISegmentLeaf, toRemovalInfo } from "./mergeTreeNodes.js";
+import {
+	ISegment,
+	ISegmentInternal,
+	toRemovalInfo,
+	type ISegmentLeaf,
+} from "./mergeTreeNodes.js";
 import { ITrackingGroup, Trackable, UnorderedTrackingGroup } from "./mergeTreeTracking.js";
 import { IJSONSegment, MergeTreeDeltaType, ReferenceType } from "./ops.js";
 import { PropertySet, matchProperties } from "./properties.js";
@@ -241,7 +246,8 @@ export function discardMergeTreeDeltaRevertible(
 			t.trackingCollection.unlink(r.trackingGroup);
 			// remove untracked local references
 			if (t.trackingCollection.empty && !t.isLeaf()) {
-				t.getSegment()?.localRefs?.removeLocalRef(t);
+				const segment: ISegmentInternal | undefined = t.getSegment();
+				segment?.localRefs?.removeLocalRef(t);
 			}
 		}
 	}
@@ -281,7 +287,7 @@ function revertLocalRemove(
 
 		assert(!tracked.isLeaf(), 0x3f4 /* removes must track local refs */);
 
-		const refSeg = tracked.getSegment();
+		const refSeg: ISegmentInternal | undefined = tracked.getSegment();
 		let realPos = mergeTreeWithRevert.referencePositionToLocalPosition(tracked);
 
 		// References which are on EndOfStringSegment don't return detached for pos,
@@ -334,7 +340,7 @@ function revertLocalRemove(
 			insertSegment.parent!,
 			insertSegment,
 			undefined,
-			(seg) => {
+			(seg: ISegmentInternal) => {
 				if (seg.localRefs?.empty === false) {
 					return seg.localRefs.walkReferences(refHandler, undefined, forward);
 				}
@@ -366,7 +372,8 @@ function revertLocalRemove(
 			tg.link(insertSegment);
 			tg.unlink(tracked);
 		}
-		tracked.getSegment()?.localRefs?.removeLocalRef(tracked);
+		const segment: ISegmentInternal | undefined = tracked.getSegment();
+		segment?.localRefs?.removeLocalRef(tracked);
 	}
 }
 

package/src/sequencePlace.ts

@@ -87,3 +87,19 @@ export function endpointPosAndSide(
 		endPos,
 	};
 }
+
+/**
+ * Returns the given place in InteriorSequencePlace form.
+ */
+export function normalizePlace(place: SequencePlace): InteriorSequencePlace {
+	if (typeof place === "number") {
+		return { pos: place, side: Side.Before };
+	}
+	if (place === "start") {
+		return { pos: -1, side: Side.After };
+	}
+	if (place === "end") {
+		return { pos: -1, side: Side.Before };
+	}
+	return place;
+}

package/src/snapshotV1.ts

@@ -212,7 +212,6 @@ export class SnapshotV1 {
 			if (segment) {
 				if (segment.properties !== undefined && Object.keys(segment.properties).length === 0) {
 					segment.properties = undefined;
-					segment.propertyManager = undefined;
 				}
 				pushSegRaw(
 					segment.toJSONObject() as JsonSegmentSpecs,
@@ -282,7 +281,6 @@ export class SnapshotV1 {
 
 				if (segment.properties !== undefined && Object.keys(segment.properties).length === 0) {
 					segment.properties = undefined;
-					segment.propertyManager = undefined;
 				}
 				const raw: IJSONSegmentWithMergeInfo & { removedClient?: string } = {
 					json: segment.toJSONObject() as IJSONSegment,

package/src/snapshotlegacy.ts

@@ -246,7 +246,6 @@ export class SnapshotLegacy {
 			totalLength += segment.cachedLength;
 			if (segment.properties !== undefined && Object.keys(segment.properties).length === 0) {
 				segment.properties = undefined;
-				segment.propertyManager = undefined;
 			}
 			this.segments!.push(segment);
 		});

package/src/zamboni.ts

@@ -135,8 +135,9 @@ function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTr
 	// when possible.
 	let prevSegment: ISegment | undefined;
 	for (let k = 0; k < node.childCount; k++) {
-		const childNode = node.children[k];
-		if (!childNode.isLeaf() || !childNode.segmentGroups.empty) {
+		// TODO Non null asserting, why is this not null?
+		const childNode = node.children[k]!;
+		if (!childNode.isLeaf() || childNode.segmentGroups?.empty === false) {
 			holdNodes.push(childNode);
 			prevSegment = undefined;
 			continue;