@fluidframework/tree 2.80.0 → 2.81.0-374083

package/src/core/tree/visitorUtils.ts

@@ -78,24 +78,40 @@ export function combineVisitors(visitors: readonly CombinableVisitor[]): Combine
 	return {
 		type: "Combined",
 		visitors: allVisitors,
-		free: () => visitors.forEach((v) => v.free()),
+		free: () => {
+			for (const v of visitors) {
+				v.free();
+			}
+		},
 		create: (...args) => {
-			allVisitors.forEach((v) => v.create(...args));
-			announcedVisitors.forEach((v) => v.afterCreate(...args));
+			for (const v of allVisitors) {
+				v.create(...args);
+			}
+			for (const v of announcedVisitors) {
+				v.afterCreate(...args);
+			}
 		},
 		destroy: (...args) => {
-			announcedVisitors.forEach((v) => v.beforeDestroy(...args));
-			allVisitors.forEach((v) => v.destroy(...args));
+			for (const v of announcedVisitors) {
+				v.beforeDestroy(...args);
+			}
+			for (const v of allVisitors) {
+				v.destroy(...args);
+			}
 		},
 		attach: (source: FieldKey, count: number, destination: PlaceIndex) => {
-			announcedVisitors.forEach((v) => v.beforeAttach(source, count, destination));
-			allVisitors.forEach((v) => v.attach(source, count, destination));
-			announcedVisitors.forEach((v) =>
+			for (const v of announcedVisitors) {
+				v.beforeAttach(source, count, destination);
+			}
+			for (const v of allVisitors) {
+				v.attach(source, count, destination);
+			}
+			for (const v of announcedVisitors) {
 				v.afterAttach(source, {
 					start: destination,
 					end: destination + count,
-				}),
-			);
+				});
+			}
 		},
 		detach: (
 			source: Range,
@@ -103,16 +119,36 @@ export function combineVisitors(visitors: readonly CombinableVisitor[]): Combine
 			id: DetachedNodeId,
 			isReplaced: boolean,
 		) => {
-			announcedVisitors.forEach((v) => v.beforeDetach(source, destination, isReplaced));
-			allVisitors.forEach((v) => v.detach(source, destination, id, isReplaced));
-			announcedVisitors.forEach((v) =>
-				v.afterDetach(source.start, source.end - source.start, destination, isReplaced),
-			);
+			for (const v of announcedVisitors) {
+				v.beforeDetach(source, destination, isReplaced);
+			}
+			for (const v of allVisitors) {
+				v.detach(source, destination, id, isReplaced);
+			}
+			for (const v of announcedVisitors) {
+				v.afterDetach(source.start, source.end - source.start, destination, isReplaced);
+			}
+		},
+		enterNode: (...args) => {
+			for (const v of allVisitors) {
+				v.enterNode(...args);
+			}
+		},
+		exitNode: (...args) => {
+			for (const v of allVisitors) {
+				v.exitNode(...args);
+			}
+		},
+		enterField: (...args) => {
+			for (const v of allVisitors) {
+				v.enterField(...args);
+			}
+		},
+		exitField: (...args) => {
+			for (const v of allVisitors) {
+				v.exitField(...args);
+			}
 		},
-		enterNode: (...args) => allVisitors.forEach((v) => v.enterNode(...args)),
-		exitNode: (...args) => allVisitors.forEach((v) => v.exitNode(...args)),
-		enterField: (...args) => allVisitors.forEach((v) => v.enterField(...args)),
-		exitField: (...args) => allVisitors.forEach((v) => v.exitField(...args)),
 	};
 }
 

package/src/feature-libraries/changeAtomIdBTree.ts

@@ -3,10 +3,23 @@
  * Licensed under the MIT License.
  */
 
-import type { ChangeAtomId, ChangesetLocalId, RevisionTag } from "../core/index.js";
-import type { TupleBTree } from "../util/index.js";
+import {
+	subtractChangeAtomIds,
+	type ChangeAtomId,
+	type ChangesetLocalId,
+	type RevisionTag,
+} from "../core/index.js";
+import type { RangeQueryResult, TupleBTree } from "../util/index.js";
 
-export type ChangeAtomIdBTree<V> = TupleBTree<[RevisionTag | undefined, ChangesetLocalId], V>;
+/**
+ * A BTree which uses ChangeAtomId flattened into a tuple as the key.
+ * @remarks
+ * Read values with {@link getFromChangeAtomIdMap} and write values with {@link setInChangeAtomIdMap}.
+ */
+export type ChangeAtomIdBTree<V> = TupleBTree<
+	readonly [RevisionTag | undefined, ChangesetLocalId],
+	V
+>;
 
 export function getFromChangeAtomIdMap<T>(
 	map: ChangeAtomIdBTree<T>,
@@ -19,6 +32,25 @@ export function setInChangeAtomIdMap<T>(
 	map: ChangeAtomIdBTree<T>,
 	id: ChangeAtomId,
 	value: T,
-): void {
-	map.set([id.revision, id.localId], value);
+): boolean {
+	return map.set([id.revision, id.localId], value);
+}
+
+export function rangeQueryChangeAtomIdMap<T>(
+	map: ChangeAtomIdBTree<T>,
+	id: ChangeAtomId,
+	count: number,
+): RangeQueryResult<T | undefined> {
+	const pair = map.getPairOrNextHigher([id.revision, id.localId]);
+	if (pair === undefined) {
+		return { value: undefined, length: count };
+	}
+
+	const [[revision, localId], value] = pair;
+	const lengthBefore = subtractChangeAtomIds({ revision, localId }, id);
+	if (lengthBefore === 0) {
+		return { value, length: 1 };
+	}
+
+	return { value: undefined, length: Math.min(lengthBefore, count) };
 }

package/src/feature-libraries/chunked-forest/basicChunk.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert, oob, fail } from "@fluidframework/core-utils/internal";
+import { assert, oob, fail, debugAssert } from "@fluidframework/core-utils/internal";
 
 import {
 	CursorLocationType,
@@ -51,6 +51,12 @@ export class BasicChunk extends ReferenceCountedBase implements TreeChunk {
 		public value?: TreeValue,
 	) {
 		super();
+		debugAssert(() => {
+			for (const field of fields.values()) {
+				if (field.length === 0) return "field must have at least one child";
+			}
+			return true;
+		});
 	}
 
 	public clone(): BasicChunk {

package/src/feature-libraries/chunked-forest/chunkTree.ts

@@ -436,7 +436,12 @@ function newBasicChunkTree(
 ): BasicChunk {
 	return new BasicChunk(
 		cursor.type,
-		new Map(mapCursorFields(cursor, () => [cursor.getFieldKey(), chunkField(cursor, policy)])),
+		new Map(
+			mapCursorFields(cursor, () => {
+				debugAssert(() => cursor.getFieldLength() > 0 || "field must have at least one child");
+				return [cursor.getFieldKey(), chunkField(cursor, policy)];
+			}),
+		),
 		cursor.value,
 	);
 }

package/src/feature-libraries/chunked-forest/chunkedForest.ts

@@ -276,7 +276,9 @@ export class ChunkedForest implements IEditableForest {
 		};
 
 		const announcedVisitors: AnnouncedVisitor[] = [];
-		this.deltaVisitors.forEach((getVisitor) => announcedVisitors.push(getVisitor()));
+		for (const getVisitor of this.deltaVisitors) {
+			announcedVisitors.push(getVisitor());
+		}
 		const combinedVisitor = combineVisitors([forestVisitor, ...announcedVisitors]);
 		this.activeVisitor = combinedVisitor;
 		return combinedVisitor;

package/src/feature-libraries/chunked-forest/codec/compressedEncode.ts

@@ -590,6 +590,7 @@ class LazyFieldEncoder implements FieldEncoder {
 	}
 
 	private get encoder(): FieldEncoder {
+		// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- using ??= could change behavior if value is falsy
 		if (this.encoderLazy === undefined) {
 			this.encoderLazy = this.fieldEncoderFromPolicy(this.nodeBuilder, this.fieldSchema);
 		}