@fluidframework/merge-tree 2.1.0-276985 → 2.1.0

package/src/mergeTreeNodeWalk.ts

@@ -189,7 +189,8 @@ export function walkAllChildSegments(
 		startBlock.children[0],
 		ancestors.size === 0
 			? undefined
-			: (node) => (ancestors.has(node.parent) ? NodeAction.Exit : NodeAction.Continue),
+			: (node): false | undefined =>
+					ancestors.has(node.parent) ? NodeAction.Exit : NodeAction.Continue,
 		leafAction,
 	);
 }

package/src/mergeTreeNodes.ts

@@ -20,7 +20,6 @@ import { TrackingGroupCollection } from "./mergeTreeTracking.js";
 import { IJSONSegment, IMarkerDef, MergeTreeDeltaType, ReferenceType } from "./ops.js";
 import { computeHierarchicalOrdinal } from "./ordinal.js";
 import type { PartialSequenceLengths } from "./partialLengths.js";
-// eslint-disable-next-line import/no-deprecated
 import { PropertySet, clone, createMap, type MapLike } from "./properties.js";
 import {
 	ReferencePosition,
@@ -78,6 +77,8 @@ export interface IRemovalInfo {
 }
 
 /**
+ * Returns the removal information for a segment.
+ *
  * @internal
  */
 export function toRemovalInfo(
@@ -269,6 +270,8 @@ export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Parti
 	canAppend(segment: ISegment): boolean;
 	append(segment: ISegment): void;
 	splitAt(pos: number): ISegment | undefined;
+	// Changing this to something other than any would break consumers.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	toJSONObject(): any;
 	/**
 	 * Acks the current segment against the segment group, op, and merge tree.
@@ -442,14 +445,16 @@ export class MergeBlock implements IMergeNodeCommon {
 	partialLengths?: PartialSequenceLengths;
 
 	public constructor(public childCount: number) {
+		// Suppression needed due to the way the merge tree children are initalized - we
+		// allocate 8 children blocks, but any unused blocks are not counted in the childCount.
+		// Using Array.from leads to unused children being undefined, which are counted in childCount.
+		// eslint-disable-next-line unicorn/no-new-array
 		this.children = new Array<IMergeNode>(MaxNodesInBlock);
-		// eslint-disable-next-line import/no-deprecated
 		this.rightmostTiles = createMap<Marker>();
-		// eslint-disable-next-line import/no-deprecated
 		this.leftmostTiles = createMap<Marker>();
 	}
 
-	public setOrdinal(child: IMergeNode, index: number) {
+	public setOrdinal(child: IMergeNode, index: number): void {
 		const childCount = this.childCount;
 		assert(
 			childCount >= 1 && childCount <= MaxNodesInBlock,
@@ -463,7 +468,7 @@ export class MergeBlock implements IMergeNodeCommon {
 		);
 	}
 
-	public assignChild(child: IMergeNode, index: number, updateOrdinal = true) {
+	public assignChild(child: IMergeNode, index: number, updateOrdinal = true): void {
 		child.parent = this;
 		child.index = index;
 		if (updateOrdinal) {
@@ -473,7 +478,7 @@ export class MergeBlock implements IMergeNodeCommon {
 	}
 }
 
-export function seqLTE(seq: number, minOrRefSeq: number) {
+export function seqLTE(seq: number, minOrRefSeq: number): boolean {
 	return seq !== UnassignedSequenceNumber && seq <= minOrRefSeq;
 }
 
@@ -513,9 +518,10 @@ export abstract class BaseSegment implements ISegment {
 		seq?: number,
 		collaborating?: boolean,
 		rollback: PropertiesRollback = PropertiesRollback.None,
-	) {
+	): PropertySet {
 		this.propertyManager ??= new PropertiesManager();
-		// eslint-disable-next-line import/no-deprecated
+		// A property set must be able to hold properties of any type, so the any is needed.
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		this.properties ??= createMap<any>();
 		return this.propertyManager.addProperties(
 			this.properties,
@@ -534,10 +540,9 @@ export abstract class BaseSegment implements ISegment {
 		return true;
 	}
 
-	protected cloneInto(b: ISegment) {
+	protected cloneInto(b: ISegment): void {
 		b.clientId = this.clientId;
 		// TODO: deep clone properties
-		// eslint-disable-next-line import/no-deprecated
 		b.properties = clone(this.properties);
 		b.removedClientIds = this.removedClientIds?.slice();
 		// TODO: copy removed client overlap and branch removal info
@@ -554,15 +559,16 @@ export abstract class BaseSegment implements ISegment {
 		return false;
 	}
 
-	protected addSerializedProps(jseg: IJSONSegment) {
+	protected addSerializedProps(jseg: IJSONSegment): void {
 		if (this.properties) {
 			jseg.props = { ...this.properties };
 		}
 	}
-
+	// This has to return any type because the return type is different for different segment types.
+	// TODO: If possible, change the return type to match what should be returned for each segment type.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public abstract toJSONObject(): any;
 
-	/***/
 	public ack(segmentGroup: SegmentGroup, opArgs: IMergeTreeDeltaOpArgs): boolean {
 		const currentSegmentGroup = this.segmentGroups.dequeue();
 		assert(
@@ -570,15 +576,16 @@ export abstract class BaseSegment implements ISegment {
 			0x043 /* "On ack, unexpected segmentGroup!" */,
 		);
 		switch (opArgs.op.type) {
-			case MergeTreeDeltaType.ANNOTATE:
+			case MergeTreeDeltaType.ANNOTATE: {
 				assert(
 					!!this.propertyManager,
 					0x044 /* "On annotate ack, missing segment property manager!" */,
 				);
 				this.propertyManager.ackPendingProperties(opArgs.op);
 				return true;
+			}
 
-			case MergeTreeDeltaType.INSERT:
+			case MergeTreeDeltaType.INSERT: {
 				assert(
 					this.seq === UnassignedSequenceNumber,
 					0x045 /* "On insert, seq number already assigned!" */,
@@ -586,8 +593,9 @@ export abstract class BaseSegment implements ISegment {
 				this.seq = opArgs.sequencedMessage!.sequenceNumber;
 				this.localSeq = undefined;
 				return true;
+			}
 
-			case MergeTreeDeltaType.REMOVE:
+			case MergeTreeDeltaType.REMOVE: {
 				const removalInfo: IRemovalInfo | undefined = toRemovalInfo(this);
 				assert(removalInfo !== undefined, 0x046 /* "On remove ack, missing removal info!" */);
 				this.localRemovedSeq = undefined;
@@ -596,8 +604,9 @@ export abstract class BaseSegment implements ISegment {
 					return true;
 				}
 				return false;
+			}
 
-			case MergeTreeDeltaType.OBLITERATE:
+			case MergeTreeDeltaType.OBLITERATE: {
 				const moveInfo: IMoveInfo | undefined = toMoveInfo(this);
 				assert(moveInfo !== undefined, 0x86e /* On obliterate ack, missing move info! */);
 				this.localMovedSeq = undefined;
@@ -611,9 +620,11 @@ export abstract class BaseSegment implements ISegment {
 				}
 
 				return false;
+			}
 
-			default:
+			default: {
 				throw new Error(`${opArgs.op.type} is in unrecognized operation type`);
+			}
 		}
 	}
 
@@ -629,13 +640,16 @@ export abstract class BaseSegment implements ISegment {
 		}
 
 		this.copyPropertiesTo(leafSegment);
-		// eslint-disable-next-line @typescript-eslint/no-this-alias
+		// eslint-disable-next-line @typescript-eslint/no-this-alias, unicorn/no-this-assignment
 		const thisAsMergeSegment: ISegmentLeaf = this;
 		leafSegment.parent = thisAsMergeSegment.parent;
 
 		// Give the leaf a temporary yet valid ordinal.
 		// when this segment is put in the tree, it will get its real ordinal,
 		// but this ordinal meets all the necessary invariants for now.
+		// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.
+		// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.
+		// eslint-disable-next-line unicorn/prefer-code-point
 		leafSegment.ordinal = this.ordinal + String.fromCharCode(0);
 
 		leafSegment.removedClientIds = this.removedClientIds?.slice();
@@ -661,16 +675,14 @@ export abstract class BaseSegment implements ISegment {
 		return leafSegment;
 	}
 
-	private copyPropertiesTo(other: ISegment) {
-		if (this.propertyManager) {
-			if (this.properties) {
-				other.propertyManager = new PropertiesManager();
-				other.properties = this.propertyManager.copyTo(
-					this.properties,
-					other.properties,
-					other.propertyManager,
-				);
-			}
+	private copyPropertiesTo(other: ISegment): void {
+		if (this.propertyManager && this.properties) {
+			other.propertyManager = new PropertiesManager();
+			other.properties = this.propertyManager.copyTo(
+				this.properties,
+				other.properties,
+				other.propertyManager,
+			);
 		}
 	}
 
@@ -742,7 +754,7 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 	}
 	public readonly type = Marker.type;
 
-	public static make(refType: ReferenceType, props?: PropertySet) {
+	public static make(refType: ReferenceType, props?: PropertySet): Marker {
 		const marker = new Marker(refType);
 		if (props) {
 			marker.addProperties(props);
@@ -755,34 +767,34 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 		this.cachedLength = 1;
 	}
 
-	toJSONObject() {
+	toJSONObject(): IJSONMarkerSegment {
 		const obj: IJSONMarkerSegment = { marker: { refType: this.refType } };
 		super.addSerializedProps(obj);
 		return obj;
 	}
 
-	static fromJSONObject(spec: any) {
+	static fromJSONObject(spec: IJSONSegment): Marker | undefined {
 		if (spec && typeof spec === "object" && "marker" in spec) {
-			return Marker.make(spec.marker.refType, spec.props as PropertySet);
+			return Marker.make((spec.marker as Marker).refType, spec.props as PropertySet);
 		}
 		return undefined;
 	}
 
-	clone() {
+	clone(): Marker {
 		const b = Marker.make(this.refType, this.properties);
 		this.cloneInto(b);
 		return b;
 	}
 
-	getSegment() {
+	getSegment(): Marker {
 		return this;
 	}
 
-	getOffset() {
+	getOffset(): number {
 		return 0;
 	}
 
-	getProperties() {
+	getProperties(): PropertySet | undefined {
 		return this.properties;
 	}
 
@@ -790,11 +802,11 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 		return this.properties?.[reservedMarkerIdKey] as string;
 	}
 
-	toString() {
+	toString(): string {
 		return `M${this.getId()}`;
 	}
 
-	protected createSplitSegmentAt(pos: number) {
+	protected createSplitSegmentAt(pos: number): undefined {
 		return undefined;
 	}
 
@@ -802,7 +814,7 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 		return false;
 	}
 
-	append() {
+	append(): void {
 		throw new Error("Can not append to marker");
 	}
 }
@@ -890,7 +902,7 @@ export class CollaborationWindow {
 	 */
 	localSeq = 0;
 
-	loadFrom(a: CollaborationWindow) {
+	loadFrom(a: CollaborationWindow): void {
 		this.clientId = a.clientId;
 		this.collaborating = a.collaborating;
 		this.minSeq = a.minSeq;
@@ -899,14 +911,14 @@ export class CollaborationWindow {
 }
 
 /**
- * @internal
+ * Compares two numbers.
  */
-export const compareNumbers = (a: number, b: number) => a - b;
+export const compareNumbers = (a: number, b: number): number => a - b;
 
 /**
- * @internal
+ * Compares two strings.
  */
-export const compareStrings = (a: string, b: string) => a.localeCompare(b);
+export const compareStrings = (a: string, b: string): number => a.localeCompare(b);
 
 /**
  * Get a human-readable string for a given {@link Marker}.
@@ -942,9 +954,10 @@ export function debugMarkerToString(marker: Marker): string {
 		pbuf += JSON.stringify(marker.properties, (key, value) => {
 			// Avoid circular reference when stringifying makers containing handles.
 			// (Substitute a debug string instead.)
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
 			const handle = !!value && value.IFluidHandle;
 
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-return
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access
 			return handle ? `#Handle(${handle.routeContext.path}/${handle.path})` : value;
 		});
 	}

package/src/mergeTreeTracking.ts

@@ -78,7 +78,7 @@ export class UnorderedTrackingGroup implements ITrackingGroup {
 	}
 
 	public get tracked(): readonly Trackable[] {
-		return Array.from(this.trackedSet);
+		return [...this.trackedSet];
 	}
 
 	public get size(): number {
@@ -149,9 +149,9 @@ export class TrackingGroupCollection {
 	}
 
 	public copyTo(trackable: Trackable): void {
-		this._trackingGroups.forEach((sg) => {
+		for (const sg of this._trackingGroups) {
 			trackable.trackingCollection.link(sg);
-		});
+		}
 	}
 
 	public get empty(): boolean {

package/src/opBuilder.ts

@@ -98,6 +98,7 @@ export function createObliterateRangeOp(start: number, end: number): IMergeTreeO
 }
 
 /**
+ * Creates an op for inserting a segment at the specified position.
  *
  * @param pos - The position to insert the segment at
  * @param segment - The segment to insert
@@ -109,9 +110,12 @@ export function createInsertSegmentOp(pos: number, segment: ISegment): IMergeTre
 }
 
 /**
+ * Creates the op for inserting a segment from its JSON representation at
+ * the specified position.
+ *
  * @internal
  */
-export function createInsertOp(pos: number, segSpec: any): IMergeTreeInsertMsg {
+export function createInsertOp(pos: number, segSpec: unknown): IMergeTreeInsertMsg {
 	return {
 		pos1: pos,
 		seg: segSpec,
@@ -120,6 +124,7 @@ export function createInsertOp(pos: number, segSpec: any): IMergeTreeInsertMsg {
 }
 
 /**
+ * Creates a group op from the provided ops.
  *
  * @param ops - The ops to group
  *

package/src/ops.ts

@@ -121,6 +121,9 @@ export interface IMergeTreeInsertMsg extends IMergeTreeDelta {
 	relativePos1?: IRelativePosition;
 	pos2?: number;
 	relativePos2?: IRelativePosition;
+	// The segment must be allowed to be of any type in order to acommodate converting from
+	// JSON to a segment.
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	seg?: any;
 }
 
@@ -169,6 +172,7 @@ export interface IMergeTreeAnnotateMsg extends IMergeTreeDelta {
 	relativePos1?: IRelativePosition;
 	pos2?: number;
 	relativePos2?: IRelativePosition;
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	props: Record<string, any>;
 }
 
@@ -190,6 +194,7 @@ export interface IMergeTreeGroupMsg extends IMergeTreeDelta {
  * @alpha
  */
 export interface IJSONSegment {
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	props?: Record<string, any>;
 }
 

package/src/ordinal.ts

@@ -11,7 +11,7 @@ export function computeHierarchicalOrdinal(
 	actualCount: number,
 	parentOrdinal: string,
 	previousOrdinal: string | undefined,
-) {
+): string {
 	assert(
 		maxCount <= 16 && actualCount <= maxCount,
 		0x3f0 /* count must be less than max, and max must be 16 or less */,
@@ -20,10 +20,17 @@ export function computeHierarchicalOrdinal(
 	const ordinalWidth = 1 << (maxCount - actualCount);
 	let ordinal: string;
 	if (previousOrdinal === undefined) {
+		// Ordinals exist purely for lexicographical sort order and use a small set of valid bytes for each string character.
+		// The extra handling fromCodePoint has for things like surrogate pairs is therefore unnecessary.
+		// disable the rule to use code points when dealing with ordinals.
+		// eslint-disable-next-line unicorn/prefer-code-point
 		ordinal = parentOrdinal + String.fromCharCode(ordinalWidth - 1);
 	} else {
+		// eslint-disable-next-line unicorn/prefer-code-point
 		const prevOrdCode = previousOrdinal.charCodeAt(previousOrdinal.length - 1);
+		assert(prevOrdCode !== undefined, 0x9ad /* previous ordinal should not be empty */);
 		const localOrdinal = prevOrdCode + ordinalWidth;
+		// eslint-disable-next-line unicorn/prefer-code-point
 		ordinal = parentOrdinal + String.fromCharCode(localOrdinal);
 	}