@fluidframework/merge-tree 2.12.0 → 2.13.0

package/src/snapshotlegacy.ts

@@ -18,8 +18,9 @@ import {
 
 import { NonCollabClient, UnassignedSequenceNumber } from "./constants.js";
 import { MergeTree } from "./mergeTree.js";
-import { type ISegmentLeaf } from "./mergeTreeNodes.js";
+import { type ISegmentPrivate } from "./mergeTreeNodes.js";
 import { matchProperties } from "./properties.js";
+import { isInserted, isRemoved } from "./segmentInfos.js";
 import {
 	JsonSegmentSpecs,
 	MergeTreeChunkLegacy,
@@ -55,7 +56,7 @@ export class SnapshotLegacy {
 
 	private header: SnapshotHeader | undefined;
 	private seq: number | undefined;
-	private segments: ISegmentLeaf[] | undefined;
+	private segments: ISegmentPrivate[] | undefined;
 	private readonly logger: ITelemetryLoggerExt;
 	private readonly chunkSize: number;
 
@@ -71,11 +72,11 @@ export class SnapshotLegacy {
 	}
 
 	private getSeqLengthSegs(
-		allSegments: ISegmentLeaf[],
+		allSegments: ISegmentPrivate[],
 		approxSequenceLength: number,
 		startIndex = 0,
 	): MergeTreeChunkLegacy {
-		const segs: ISegmentLeaf[] = [];
+		const segs: ISegmentPrivate[] = [];
 		let sequenceLength = 0;
 		let segCount = 0;
 		let segsWithAttribution = 0;
@@ -191,7 +192,7 @@ export class SnapshotLegacy {
 		return builder.getSummaryTree();
 	}
 
-	extractSync(): ISegmentLeaf[] {
+	extractSync(): ISegmentPrivate[] {
 		const collabWindow = this.mergeTree.collabWindow;
 		const seq = (this.seq = collabWindow.minSeq);
 		this.header = {
@@ -204,20 +205,14 @@ export class SnapshotLegacy {
 
 		let originalSegments = 0;
 
-		const segs: ISegmentLeaf[] = [];
-		let prev: ISegmentLeaf | undefined;
-		const extractSegment = (
-			segment: ISegmentLeaf,
-			pos: number,
-			refSeq: number,
-			clientId: number,
-			start: number | undefined,
-			end: number | undefined,
-		): boolean => {
+		const segs: ISegmentPrivate[] = [];
+		let prev: ISegmentPrivate | undefined;
+		const extractSegment = (segment: ISegmentPrivate): boolean => {
 			if (
+				isInserted(segment) &&
 				segment.seq !== UnassignedSequenceNumber &&
-				segment.seq! <= seq &&
-				(segment.removedSeq === undefined ||
+				segment.seq <= seq &&
+				(!isRemoved(segment) ||
 					segment.removedSeq === UnassignedSequenceNumber ||
 					segment.removedSeq > seq)
 			) {

package/src/sortedSegmentSet.ts

@@ -5,7 +5,7 @@
 
 import { LocalReferencePosition } from "./localReference.js";
 import { ISegmentInternal } from "./mergeTreeNodes.js";
-// eslint-disable-next-line import/no-deprecated
+import { hasProp, toMergeNodeInfo } from "./segmentInfos.js";
 import { SortedSet } from "./sortedSet.js";
 
 /**
@@ -28,7 +28,7 @@ export type SortedSegmentSetItem =
  *
  * @internal
  */
-// eslint-disable-next-line import/no-deprecated
+
 export class SortedSegmentSet<
 	T extends SortedSegmentSetItem = ISegmentInternal,
 > extends SortedSet<T, string> {
@@ -40,15 +40,13 @@ export class SortedSegmentSet<
 			// The particular value for comparison doesn't matter because `findItemPosition` tolerates
 			// elements with duplicate keys (as it must, since local references use the same key as their segment).
 			// All that matters is that it's consistent.
-			return lref.getSegment()?.ordinal ?? "";
+			return toMergeNodeInfo(lref.getSegment())?.ordinal ?? "";
 		}
-		const maybeObject = item as { readonly segment: ISegmentInternal };
-		if (maybeObject?.segment) {
-			return maybeObject.segment.ordinal;
+		if (hasProp(item, "segment", "object")) {
+			return toMergeNodeInfo(item.segment)?.ordinal ?? "";
 		}
 
-		const maybeSegment = item as ISegmentInternal;
-		return maybeSegment.ordinal;
+		return toMergeNodeInfo(item)?.ordinal ?? "";
 	}
 
 	protected findItemPosition(item: T): { exists: boolean; index: number } {

package/src/zamboni.ts

@@ -10,15 +10,15 @@ import { MergeTree } from "./mergeTree.js";
 import { MergeTreeMaintenanceType } from "./mergeTreeDeltaCallback.js";
 import {
 	type MergeBlock,
+	assignChild,
 	IMergeNode,
-	ISegmentLeaf,
+	ISegmentPrivate,
 	Marker,
 	MaxNodesInBlock,
 	seqLTE,
-	toMoveInfo,
-	toRemovalInfo,
 } from "./mergeTreeNodes.js";
 import { matchProperties } from "./properties.js";
+import { toRemovalInfo, toMoveInfo, removeMergeNodeInfo } from "./segmentInfos.js";
 
 export const zamboniSegmentsMax = 2;
 function underflow(node: MergeBlock): boolean {
@@ -60,7 +60,7 @@ export function zamboniSegments(
 				block.childCount = newChildCount;
 				block.children = childrenCopy;
 				for (let j = 0; j < newChildCount; j++) {
-					block.assignChild(childrenCopy[j], j, false);
+					assignChild(block, childrenCopy[j], j, false);
 				}
 
 				if (underflow(block) && block.parent) {
@@ -110,7 +110,7 @@ export function packParent(parent: MergeBlock, mergeTree: MergeTree): void {
 			const packedBlock = mergeTree.makeBlock(nodeCount);
 			for (let packedNodeIndex = 0; packedNodeIndex < nodeCount; packedNodeIndex++) {
 				const nodeToPack = holdNodes[childrenPackedCount++];
-				packedBlock.assignChild(nodeToPack, packedNodeIndex, false);
+				assignChild(packedBlock, nodeToPack, packedNodeIndex, false);
 			}
 			packedBlock.parent = parent;
 			packedBlocks[nodeIndex] = packedBlock;
@@ -118,7 +118,7 @@ export function packParent(parent: MergeBlock, mergeTree: MergeTree): void {
 		}
 		parent.children = packedBlocks;
 		for (let j = 0; j < childCount; j++) {
-			parent.assignChild(packedBlocks[j], j, false);
+			assignChild(parent, packedBlocks[j], j, false);
 		}
 		parent.childCount = childCount;
 	} else {
@@ -136,7 +136,7 @@ export function packParent(parent: MergeBlock, mergeTree: MergeTree): void {
 function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTree): void {
 	// The previous segment is tracked while scouring for the purposes of merging adjacent segments
 	// when possible.
-	let prevSegment: ISegmentLeaf | undefined;
+	let prevSegment: ISegmentPrivate | undefined;
 	for (let k = 0; k < node.childCount; k++) {
 		// TODO Non null asserting, why is this not null?
 		const childNode = node.children[k]!;
@@ -164,19 +164,17 @@ function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTr
 					},
 					undefined,
 				);
-
-				segment.parent = undefined;
-
 				if (Marker.is(segment)) {
 					mergeTree.unlinkMarker(segment);
 				}
+				removeMergeNodeInfo(segment);
 			} else {
 				holdNodes.push(segment);
 			}
 
 			prevSegment = undefined;
 		} else {
-			if (segment.seq! <= mergeTree.collabWindow.minSeq) {
+			if (segment.seq <= mergeTree.collabWindow.minSeq) {
 				const segmentHasPositiveLength = (mergeTree.localNetLength(segment) ?? 0) > 0;
 				const canAppend =
 					prevSegment?.canAppend(segment) &&
@@ -194,8 +192,8 @@ function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTr
 						undefined,
 					);
 
-					segment.parent = undefined;
 					for (const tg of segment.trackingCollection.trackingGroups) tg.unlink(segment);
+					removeMergeNodeInfo(segment);
 				} else {
 					holdNodes.push(segment);
 					prevSegment = segmentHasPositiveLength ? segment : undefined;