@fluidframework/merge-tree 2.1.0-276985 → 2.1.0

package/src/localReference.ts

@@ -10,7 +10,6 @@ import { DoublyLinkedList, ListNode, walkList } from "./collections/index.js";
 import { ISegment } from "./mergeTreeNodes.js";
 import { TrackingGroup, TrackingGroupCollection } from "./mergeTreeTracking.js";
 import { ReferenceType } from "./ops.js";
-// eslint-disable-next-line import/no-deprecated
 import { PropertySet, addProperties } from "./properties.js";
 import { ReferencePosition, refTypeIncludesFlag } from "./referencePositions.js";
 
@@ -39,7 +38,7 @@ export const SlidingPreference = {
  */
 export type SlidingPreference = (typeof SlidingPreference)[keyof typeof SlidingPreference];
 
-function _validateReferenceType(refType: ReferenceType) {
+function _validateReferenceType(refType: ReferenceType): void {
 	let exclusiveCount = 0;
 	if (refTypeIncludesFlag(refType, ReferenceType.Transient)) {
 		++exclusiveCount;
@@ -106,7 +105,7 @@ class LocalReference implements LocalReferencePosition {
 		segment: ISegment | undefined,
 		offset: number,
 		listNode: ListNode<LocalReference> | undefined,
-	) {
+	): void {
 		if (listNode !== this.listNode && this.listNode !== undefined) {
 			this.segment?.localRefs?.removeLocalRef(this);
 		}
@@ -114,45 +113,45 @@ class LocalReference implements LocalReferencePosition {
 
 		if (segment !== this.segment) {
 			const groups: TrackingGroup[] = [];
-			this.trackingCollection.trackingGroups.forEach((tg) => {
+			for (const tg of this.trackingCollection.trackingGroups) {
 				tg.unlink(this);
 				groups.push(tg);
-			});
+			}
 
 			this.segment = segment;
 
-			groups.forEach((tg) => tg.link(this));
+			for (const tg of groups) tg.link(this);
 		}
 		this.offset = offset;
 	}
 
-	public isLeaf() {
+	public isLeaf(): boolean {
 		return false;
 	}
 
-	public addProperties(newProps: PropertySet) {
-		// eslint-disable-next-line import/no-deprecated
+	public addProperties(newProps: PropertySet): void {
 		this.properties = addProperties(this.properties, newProps);
 	}
 
-	public getSegment() {
+	public getSegment(): ISegment | undefined {
 		return this.segment;
 	}
 
-	public getOffset() {
+	public getOffset(): number {
 		return this.offset;
 	}
 
-	public getListNode() {
+	public getListNode(): ListNode<LocalReference> | undefined {
 		return this.listNode;
 	}
 
-	public getProperties() {
+	public getProperties(): PropertySet | undefined {
 		return this.properties;
 	}
 }
 
 /**
+ * Creates a new detached local reference.
  * @internal
  */
 export function createDetachedLocalReferencePosition(
@@ -168,12 +167,12 @@ interface IRefsAtOffset {
 	after?: DoublyLinkedList<LocalReference>;
 }
 
-function assertLocalReferences(lref: any): asserts lref is LocalReference {
+function assertLocalReferences(lref: unknown): asserts lref is LocalReference {
 	assert(lref instanceof LocalReference, 0x2e0 /* "lref not a Local Reference" */);
 }
 
 /**
- * @returns true if `func` returns true for any position within the collection
+ * Determines if the given function is true for any position within the collection.
  */
 export function anyLocalReferencePosition(
 	collection: LocalReferenceCollection,
@@ -189,8 +188,7 @@ export function anyLocalReferencePosition(
 }
 
 /**
- * @returns only the local reference positions for which the `predicate` returns
- * true
+ * Finds the local reference positions that satisfy the given predicate.
  */
 export function* filterLocalReferencePositions(
 	collection: LocalReferenceCollection,
@@ -209,7 +207,9 @@ export function* filterLocalReferencePositions(
  */
 let validateRefCount: ((collection?: LocalReferenceCollection) => void) | undefined;
 
-export function setValidateRefCount(cb?: (collection?: LocalReferenceCollection) => void) {
+export function setValidateRefCount(
+	cb?: (collection?: LocalReferenceCollection) => void,
+): void {
 	validateRefCount = cb;
 }
 
@@ -223,7 +223,7 @@ export function setValidateRefCount(cb?: (collection?: LocalReferenceCollection)
  * @alpha
  */
 export class LocalReferenceCollection {
-	public static append(seg1: ISegment, seg2: ISegment) {
+	public static append(seg1: ISegment, seg2: ISegment): void {
 		if (seg2.localRefs && !seg2.localRefs.empty) {
 			if (!seg1.localRefs) {
 				seg1.localRefs = new LocalReferenceCollection(seg1);
@@ -242,18 +242,21 @@ export class LocalReferenceCollection {
 		validateRefCount?.(seg2.localRefs);
 	}
 
-	public static setOrGet(segment: ISegment) {
+	public static setOrGet(segment: ISegment): LocalReferenceCollection {
 		return (segment.localRefs ??= new LocalReferenceCollection(segment));
 	}
 
 	private readonly refsByOffset: (IRefsAtOffset | undefined)[];
 	private refCount: number = 0;
 
-	/***/
 	private constructor(
-		/** Segment this `LocalReferenceCollection` is associated to. */
+		/**
+		 * The segment this `LocalReferenceCollection` is associated with.
+		 */
 		private readonly segment: ISegment,
-		initialRefsByfOffset = new Array<IRefsAtOffset | undefined>(segment.cachedLength),
+		initialRefsByfOffset: (IRefsAtOffset | undefined)[] = Array.from({
+			length: segment.cachedLength,
+		}),
 	) {
 		// Since javascript arrays are sparse the above won't populate any of the
 		// indices, but it will ensure the length property of the array matches
@@ -262,9 +265,13 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Returns an iterator over this LocalReferenceCollection.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public [Symbol.iterator]() {
+	public [Symbol.iterator](): {
+		next(): IteratorResult<LocalReferencePosition>;
+		[Symbol.iterator](): IterableIterator<LocalReferencePosition>;
+	} {
 		const subiterators: IterableIterator<ListNode<LocalReferencePosition>>[] = [];
 		for (const refs of this.refsByOffset) {
 			if (refs) {
@@ -283,7 +290,9 @@ export class LocalReferenceCollection {
 		const iterator = {
 			next(): IteratorResult<LocalReferencePosition> {
 				while (subiterators.length > 0) {
-					const next = subiterators[0].next();
+					// TODO Non null asserting, why is this not null?
+					// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+					const next = subiterators[0]!.next();
 					if (next.done === true) {
 						subiterators.shift();
 					} else {
@@ -293,7 +302,10 @@ export class LocalReferenceCollection {
 
 				return { value: undefined, done: true };
 			},
-			[Symbol.iterator]() {
+			[Symbol.iterator](): {
+				next(): IteratorResult<LocalReferencePosition>;
+				[Symbol.iterator](): IterableIterator<LocalReferencePosition>;
+			} {
 				return this;
 			},
 		};
@@ -301,14 +313,16 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Determines if the collection has no references in it.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public get empty() {
+	public get empty(): boolean {
 		validateRefCount?.(this);
 		return this.refCount === 0;
 	}
 
 	/**
+	 * Creates a new local reference.
 	 * @remarks This method should only be called by mergeTree.
 	 */
 	public createLocalRef(
@@ -328,9 +342,10 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Adds a local reference to the collection.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public addLocalRef(lref: LocalReferencePosition, offset: number) {
+	public addLocalRef(lref: LocalReferencePosition, offset: number): void {
 		assertLocalReferences(lref);
 		assert(
 			offset < this.segment.cachedLength,
@@ -352,6 +367,7 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Removes a local reference from the collection.
 	 * @remarks This method should only be called by mergeTree.
 	 */
 	public removeLocalRef(lref: LocalReferencePosition): LocalReferencePosition | undefined {
@@ -380,7 +396,7 @@ export class LocalReferenceCollection {
 	 *
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public append(other: LocalReferenceCollection) {
+	public append(other: LocalReferenceCollection): void {
 		if (!other || other.empty) {
 			return;
 		}
@@ -439,8 +455,11 @@ export class LocalReferenceCollection {
 	 *
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public split(offset: number, splitSeg: ISegment) {
-		if (!this.empty) {
+	public split(offset: number, splitSeg: ISegment): void {
+		if (this.empty) {
+			// shrink the offset array when empty and splitting
+			this.refsByOffset.length = offset;
+		} else {
 			const localRefs = new LocalReferenceCollection(
 				splitSeg,
 				this.refsByOffset.splice(offset, this.refsByOffset.length - offset),
@@ -453,17 +472,15 @@ export class LocalReferenceCollection {
 				this.refCount--;
 				localRefs.refCount++;
 			}
-		} else {
-			// shrink the offset array when empty and splitting
-			this.refsByOffset.length = offset;
 		}
 		validateRefCount?.(this);
 	}
 
 	/**
+	 * Insert a reference before tombstoned references.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public addBeforeTombstones(...refs: Iterable<LocalReferencePosition>[]) {
+	public addBeforeTombstones(...refs: Iterable<LocalReferencePosition>[]): void {
 		const beforeRefs = this.refsByOffset[0]?.before ?? new DoublyLinkedList();
 
 		if (this.refsByOffset[0]?.before === undefined) {
@@ -494,9 +511,10 @@ export class LocalReferenceCollection {
 		validateRefCount?.(this);
 	}
 	/**
+	 * Insert a reference after tombstoned references.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public addAfterTombstones(...refs: Iterable<LocalReferencePosition>[]) {
+	public addAfterTombstones(...refs: Iterable<LocalReferencePosition>[]): void {
 		const lastOffset = this.segment.cachedLength - 1;
 		const afterRefs = this.refsByOffset[lastOffset]?.after ?? new DoublyLinkedList();
 
@@ -525,9 +543,10 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Determines if a reference is after tombstoned references.
 	 * @remarks This method should only be called by mergeTree.
 	 */
-	public isAfterTombstone(lref: LocalReferencePosition) {
+	public isAfterTombstone(lref: LocalReferencePosition): boolean {
 		const after = this.refsByOffset[lref.getOffset()]?.after;
 		if (after) {
 			assertLocalReferences(lref);
@@ -537,13 +556,14 @@ export class LocalReferenceCollection {
 	}
 
 	/**
+	 * Walks all of the references in a collection.
 	 * @remarks This method should only be called by mergeTree.
 	 */
 	public walkReferences(
 		visitor: (lref: LocalReferencePosition) => boolean | void | undefined,
 		start?: LocalReferencePosition,
 		forward: boolean = true,
-	) {
+	): boolean {
 		if (start !== undefined) {
 			if (!this.has(start)) {
 				throw new UsageError("start must be in collection");
@@ -575,7 +595,7 @@ export class LocalReferenceCollection {
 			}
 		}
 
-		const listWalker = (pos: DoublyLinkedList<LocalReference>) => {
+		const listWalker = (pos: DoublyLinkedList<LocalReference>): boolean => {
 			return walkList(
 				pos,
 				(node) => visitor(node.data),
@@ -587,10 +607,8 @@ export class LocalReferenceCollection {
 		while (offset >= 0 && offset < this.refsByOffset.length) {
 			while (offsetPositions.length > 0) {
 				const offsetPos = forward ? offsetPositions.shift() : offsetPositions.pop();
-				if (offsetPos?.data !== undefined) {
-					if (listWalker(offsetPos.data) === false) {
-						return false;
-					}
+				if (offsetPos?.data !== undefined && listWalker(offsetPos.data) === false) {
+					return false;
 				}
 			}
 			offset += increment;