@fluidframework/merge-tree 2.11.0 → 2.12.0

package/src/revertibles.ts

@@ -8,16 +8,12 @@ import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import { DoublyLinkedList } from "./collections/index.js";
 import { EndOfTreeSegment } from "./endOfTreeSegment.js";
+// eslint-disable-next-line import/no-deprecated
 import { LocalReferenceCollection, LocalReferencePosition } from "./localReference.js";
 import { MergeTree, findRootMergeBlock } from "./mergeTree.js";
 import { IMergeTreeDeltaCallbackArgs } from "./mergeTreeDeltaCallback.js";
 import { depthFirstNodeWalk } from "./mergeTreeNodeWalk.js";
-import {
-	ISegment,
-	ISegmentInternal,
-	toRemovalInfo,
-	type ISegmentLeaf,
-} from "./mergeTreeNodes.js";
+import { 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";
@@ -103,6 +99,7 @@ function findMergeTreeWithRevert(trackable: Trackable): MergeTreeWithRevert {
 		const refCallbacks: MergeTreeWithRevert["__mergeTreeRevertible"]["refCallbacks"] = {
 			afterSlide: (r: LocalReferencePosition) => {
 				if (mergeTree.referencePositionToLocalPosition(r) === DetachedReferencePosition) {
+					// eslint-disable-next-line import/no-deprecated
 					const refs = LocalReferenceCollection.setOrGet(detachedReferences);
 					refs.addAfterTombstones([r]);
 				}
@@ -246,7 +243,7 @@ export function discardMergeTreeDeltaRevertible(
 			t.trackingCollection.unlink(r.trackingGroup);
 			// remove untracked local references
 			if (t.trackingCollection.empty && !t.isLeaf()) {
-				const segment: ISegmentInternal | undefined = t.getSegment();
+				const segment: ISegmentLeaf | undefined = t.getSegment();
 				segment?.localRefs?.removeLocalRef(t);
 			}
 		}
@@ -287,7 +284,7 @@ function revertLocalRemove(
 
 		assert(!tracked.isLeaf(), 0x3f4 /* removes must track local refs */);
 
-		const refSeg: ISegmentInternal | undefined = tracked.getSegment();
+		const refSeg: ISegmentLeaf | undefined = tracked.getSegment();
 		let realPos = mergeTreeWithRevert.referencePositionToLocalPosition(tracked);
 
 		// References which are on EndOfStringSegment don't return detached for pos,
@@ -340,7 +337,7 @@ function revertLocalRemove(
 			insertSegment.parent!,
 			insertSegment,
 			undefined,
-			(seg: ISegmentInternal) => {
+			(seg: ISegmentLeaf) => {
 				if (seg.localRefs?.empty === false) {
 					return seg.localRefs.walkReferences(refHandler, undefined, forward);
 				}
@@ -359,6 +356,7 @@ function revertLocalRemove(
 		}
 
 		if (insertRef !== undefined) {
+			// eslint-disable-next-line import/no-deprecated
 			const localRefs = LocalReferenceCollection.setOrGet(insertSegment);
 			if (insertRef.before?.empty === false) {
 				localRefs.addBeforeTombstones(insertRef.before.map((n) => n.data));
@@ -372,7 +370,7 @@ function revertLocalRemove(
 			tg.link(insertSegment);
 			tg.unlink(tracked);
 		}
-		const segment: ISegmentInternal | undefined = tracked.getSegment();
+		const segment: ISegmentLeaf | undefined = tracked.getSegment();
 		segment?.localRefs?.removeLocalRef(tracked);
 	}
 }
@@ -393,7 +391,7 @@ function revertLocalAnnotate(
 	}
 }
 
-function getPosition(mergeTreeWithRevert: MergeTreeWithRevert, segment: ISegment): number {
+function getPosition(mergeTreeWithRevert: MergeTreeWithRevert, segment: ISegmentLeaf): number {
 	return mergeTreeWithRevert.getPosition(
 		segment,
 		mergeTreeWithRevert.collabWindow.currentSeq,

package/src/snapshotLoader.ts

@@ -24,7 +24,7 @@ import {
 import { Client } from "./client.js";
 import { NonCollabClient, UniversalSequenceNumber } from "./constants.js";
 import { MergeTree } from "./mergeTree.js";
-import { ISegment } from "./mergeTreeNodes.js";
+import { ISegmentLeaf } from "./mergeTreeNodes.js";
 import { IJSONSegment } from "./ops.js";
 import {
 	IJSONSegmentWithMergeInfo,
@@ -96,8 +96,8 @@ export class SnapshotLoader {
 
 	private readonly specToSegment = (
 		spec: IJSONSegment | IJSONSegmentWithMergeInfo,
-	): ISegment => {
-		let seg: ISegment;
+	): ISegmentLeaf => {
+		let seg: ISegmentLeaf;
 
 		if (hasMergeInfo(spec)) {
 			seg = this.client.specToSegment(spec.json);
@@ -207,7 +207,7 @@ export class SnapshotLoader {
 		}
 
 		let chunksWithAttribution = chunk1.attribution === undefined ? 0 : 1;
-		const segs: ISegment[] = [];
+		const segs: ISegmentLeaf[] = [];
 		let lengthSofar = chunk1.length;
 		for (
 			let chunkIndex = 1;
@@ -244,7 +244,7 @@ export class SnapshotLoader {
 
 		// Helper to insert segments at the end of the MergeTree.
 		const mergeTree = this.mergeTree;
-		const append = (segments: ISegment[], cli: number, seq: number): void => {
+		const append = (segments: ISegmentLeaf[], cli: number, seq: number): void => {
 			mergeTree.insertSegments(
 				mergeTree.root.cachedLength ?? 0,
 				segments,
@@ -256,7 +256,7 @@ export class SnapshotLoader {
 		};
 
 		// Helpers to batch-insert segments that are below the min seq
-		const batch: ISegment[] = [];
+		const batch: ISegmentLeaf[] = [];
 		const flushBatch = (): void => {
 			if (batch.length > 0) {
 				append(batch, NonCollabClient, UniversalSequenceNumber);
@@ -280,7 +280,7 @@ export class SnapshotLoader {
 		flushBatch();
 	}
 
-	private extractAttribution(segments: ISegment[], chunk: MergeTreeChunkV1): void {
+	private extractAttribution(segments: ISegmentLeaf[], chunk: MergeTreeChunkV1): void {
 		if (chunk.attribution) {
 			const { attributionPolicy } = this.mergeTree;
 			if (attributionPolicy === undefined) {

package/src/snapshotV1.ts

@@ -22,7 +22,7 @@ import { IAttributionCollection } from "./attributionCollection.js";
 import { UnassignedSequenceNumber } from "./constants.js";
 import { MergeTree } from "./mergeTree.js";
 import { walkAllChildSegments } from "./mergeTreeNodeWalk.js";
-import { ISegment } from "./mergeTreeNodes.js";
+import { ISegmentLeaf } from "./mergeTreeNodes.js";
 import type { IJSONSegment } from "./ops.js";
 import { PropertySet, matchProperties } from "./properties.js";
 import {
@@ -208,7 +208,7 @@ export class SnapshotV1 {
 		};
 
 		// Helper to serialize the given `segment` and add it to the snapshot (if a segment is provided).
-		const pushSeg = (segment?: ISegment): void => {
+		const pushSeg = (segment?: ISegmentLeaf): void => {
 			if (segment) {
 				if (segment.properties !== undefined && Object.keys(segment.properties).length === 0) {
 					segment.properties = undefined;
@@ -221,8 +221,8 @@ export class SnapshotV1 {
 			}
 		};
 
-		let prev: ISegment | undefined;
-		const extractSegment = (segment: ISegment): boolean => {
+		let prev: ISegmentLeaf | undefined;
+		const extractSegment = (segment: ISegmentLeaf): boolean => {
 			// Elide segments that do not need to be included in the snapshot.  A segment may be elided if
 			// either condition is true:
 			//   a) The segment has not yet been ACKed.  We do not need to snapshot unACKed segments because

package/src/snapshotlegacy.ts

@@ -18,7 +18,7 @@ import {
 
 import { NonCollabClient, UnassignedSequenceNumber } from "./constants.js";
 import { MergeTree } from "./mergeTree.js";
-import { ISegment, type ISegmentLeaf } from "./mergeTreeNodes.js";
+import { type ISegmentLeaf } from "./mergeTreeNodes.js";
 import { matchProperties } from "./properties.js";
 import {
 	JsonSegmentSpecs,
@@ -55,7 +55,7 @@ export class SnapshotLegacy {
 
 	private header: SnapshotHeader | undefined;
 	private seq: number | undefined;
-	private segments: ISegment[] | undefined;
+	private segments: ISegmentLeaf[] | undefined;
 	private readonly logger: ITelemetryLoggerExt;
 	private readonly chunkSize: number;
 
@@ -71,11 +71,11 @@ export class SnapshotLegacy {
 	}
 
 	private getSeqLengthSegs(
-		allSegments: ISegment[],
+		allSegments: ISegmentLeaf[],
 		approxSequenceLength: number,
 		startIndex = 0,
 	): MergeTreeChunkLegacy {
-		const segs: ISegment[] = [];
+		const segs: ISegmentLeaf[] = [];
 		let sequenceLength = 0;
 		let segCount = 0;
 		let segsWithAttribution = 0;
@@ -191,7 +191,7 @@ export class SnapshotLegacy {
 		return builder.getSummaryTree();
 	}
 
-	extractSync(): ISegment[] {
+	extractSync(): ISegmentLeaf[] {
 		const collabWindow = this.mergeTree.collabWindow;
 		const seq = (this.seq = collabWindow.minSeq);
 		this.header = {
@@ -204,7 +204,7 @@ export class SnapshotLegacy {
 
 		let originalSegments = 0;
 
-		const segs: ISegment[] = [];
+		const segs: ISegmentLeaf[] = [];
 		let prev: ISegmentLeaf | undefined;
 		const extractSegment = (
 			segment: ISegmentLeaf,

package/src/sortedSegmentSet.ts

@@ -4,7 +4,7 @@
  */
 
 import { LocalReferencePosition } from "./localReference.js";
-import { ISegment } from "./mergeTreeNodes.js";
+import { ISegmentInternal } from "./mergeTreeNodes.js";
 // eslint-disable-next-line import/no-deprecated
 import { SortedSet } from "./sortedSet.js";
 
@@ -12,9 +12,9 @@ import { SortedSet } from "./sortedSet.js";
  * @internal
  */
 export type SortedSegmentSetItem =
-	| ISegment
+	| ISegmentInternal
 	| LocalReferencePosition
-	| { readonly segment: ISegment };
+	| { readonly segment: ISegmentInternal };
 
 /**
  * Stores a unique and sorted set of segments, or objects with segments
@@ -29,10 +29,9 @@ export type SortedSegmentSetItem =
  * @internal
  */
 // eslint-disable-next-line import/no-deprecated
-export class SortedSegmentSet<T extends SortedSegmentSetItem = ISegment> extends SortedSet<
-	T,
-	string
-> {
+export class SortedSegmentSet<
+	T extends SortedSegmentSetItem = ISegmentInternal,
+> extends SortedSet<T, string> {
 	protected getKey(item: T): string {
 		const maybeRef = item as Partial<LocalReferencePosition>;
 		if (maybeRef.getSegment !== undefined && maybeRef.isLeaf?.() === false) {
@@ -43,12 +42,12 @@ export class SortedSegmentSet<T extends SortedSegmentSetItem = ISegment> extends
 			// All that matters is that it's consistent.
 			return lref.getSegment()?.ordinal ?? "";
 		}
-		const maybeObject = item as { readonly segment: ISegment };
+		const maybeObject = item as { readonly segment: ISegmentInternal };
 		if (maybeObject?.segment) {
 			return maybeObject.segment.ordinal;
 		}
 
-		const maybeSegment = item as ISegment;
+		const maybeSegment = item as ISegmentInternal;
 		return maybeSegment.ordinal;
 	}
 

package/src/zamboni.ts

@@ -11,7 +11,7 @@ import { MergeTreeMaintenanceType } from "./mergeTreeDeltaCallback.js";
 import {
 	type MergeBlock,
 	IMergeNode,
-	ISegment,
+	ISegmentLeaf,
 	Marker,
 	MaxNodesInBlock,
 	seqLTE,
@@ -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: ISegment | undefined;
+	let prevSegment: ISegmentLeaf | undefined;
 	for (let k = 0; k < node.childCount; k++) {
 		// TODO Non null asserting, why is this not null?
 		const childNode = node.children[k]!;