@fluidframework/tree 2.74.0-370705 → 2.80.0

package/src/feature-libraries/sequence-field/rebase.ts

@@ -5,15 +5,11 @@
 
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
 
+import type { ChangeAtomId, RevisionMetadataSource, RevisionTag } from "../../core/index.js";
+import { type IdAllocator, type Mutable, brand } from "../../util/index.js";
 import {
-	areEqualChangeAtomIds,
-	type ChangeAtomId,
-	type RevisionMetadataSource,
-	type RevisionTag,
-} from "../../core/index.js";
-import type { IdAllocator, Mutable } from "../../util/index.js";
-import {
-	type RebaseNodeManager,
+	type CrossFieldManager,
+	CrossFieldTarget,
 	type NodeChangeRebaser,
 	NodeAttachState,
 	type NodeId,
@@ -22,9 +18,16 @@ import {
 
 import { MarkListFactory } from "./markListFactory.js";
 import { MarkQueue } from "./markQueue.js";
-import type { NodeRangeQueryFunc } from "./moveEffectTable.js";
 import {
-	type Attach,
+	type MoveEffect,
+	type MoveEffectTable,
+	getMoveEffect,
+	isMoveIn,
+	isMoveMark,
+	isMoveOut,
+	setMoveEffect,
+} from "./moveEffectTable.js";
+import {
 	type CellId,
 	type CellMark,
 	type Changeset,
@@ -33,6 +36,8 @@ import {
 	type MarkEffect,
 	type MarkList,
 	type MoveId,
+	type MoveIn,
+	type MoveOut,
 	type NoopMark,
 	NoopMarkType,
 } from "./types.js";
@@ -44,18 +49,17 @@ import {
 	cloneMark,
 	compareCellPositionsUsingTombstones,
 	extractMarkEffect,
-	getAttachedRootId,
 	getDetachOutputCellId,
-	getDetachedRootId,
+	getEndpoint,
 	getInputCellId,
-	getOutputCellId,
-	isAttach,
+	isAttachAndDetachEffect,
 	isDetach,
 	isNewAttach,
 	isRename,
 	isTombstone,
 	markEmptiesCells,
 	markFillsCells,
+	splitMarkEffect,
 	withNodeChange,
 } from "./utils.js";
 
@@ -70,10 +74,17 @@ export function rebase(
 	base: Changeset,
 	rebaseChild: NodeChangeRebaser,
 	genId: IdAllocator,
-	manager: RebaseNodeManager,
+	manager: CrossFieldManager,
 	revisionMetadata: RebaseRevisionMetadata,
 ): Changeset {
-	return rebaseMarkList(change, base, revisionMetadata, rebaseChild, genId, manager);
+	return rebaseMarkList(
+		change,
+		base,
+		revisionMetadata,
+		rebaseChild,
+		genId,
+		manager as MoveEffectTable,
+	);
 }
 
 function rebaseMarkList(
@@ -82,7 +93,7 @@ function rebaseMarkList(
 	metadata: RebaseRevisionMetadata,
 	rebaseChild: NodeChangeRebaser,
 	genId: IdAllocator,
-	moveEffects: RebaseNodeManager,
+	moveEffects: CrossFieldManager<MoveEffect>,
 ): MarkList {
 	const factory = new MarkListFactory();
 	const queue = new RebaseQueue(baseMarkList, currMarkList, metadata, moveEffects);
@@ -118,28 +129,10 @@ class RebaseQueue {
 		baseMarks: Changeset,
 		newMarks: Changeset,
 		private readonly metadata: RevisionMetadataSource,
-		private readonly moveEffects: RebaseNodeManager,
+		private readonly moveEffects: MoveEffectTable,
 	) {
-		const queryFunc: NodeRangeQueryFunc = (mark) => {
-			if (isAttach(mark)) {
-				return moveEffects.getNewChangesForBaseAttach(getAttachedRootId(mark), mark.count)
-					.length;
-			} else if (isDetach(mark)) {
-				return moveEffects.doesBaseAttachNodes(getDetachedRootId(mark), mark.count).length;
-			}
-
-			let count = mark.count;
-			if (mark.type === "Rename") {
-				count = moveEffects.getNewRenameForBaseRename(mark.idOverride, count).length;
-			}
-
-			return mark.cellId !== undefined
-				? moveEffects.doesBaseAttachNodes(mark.cellId, count).length
-				: count;
-		};
-
-		this.baseMarks = new MarkQueue(baseMarks, queryFunc);
-		this.newMarks = new MarkQueue(newMarks, (mark) => mark.count);
+		this.baseMarks = new MarkQueue(baseMarks, moveEffects);
+		this.newMarks = new MarkQueue(newMarks, moveEffects);
 		this.baseMarksCellSources = cellSourcesFromMarks(baseMarks, getInputCellId);
 		this.newMarksCellSources = cellSourcesFromMarks(newMarks, getInputCellId);
 	}
@@ -179,14 +172,18 @@ class RebaseQueue {
 				this.metadata,
 			);
 			switch (comparison) {
-				case CellOrder.SameCell:
+				case CellOrder.SameCell: {
 					return this.dequeueBoth();
-				case CellOrder.OldThenNew:
+				}
+				case CellOrder.OldThenNew: {
 					return this.dequeueBase();
-				case CellOrder.NewThenOld:
+				}
+				case CellOrder.NewThenOld: {
 					return this.dequeueNew();
-				default:
+				}
+				default: {
 					unreachableCase(comparison);
+				}
 			}
 		} else if (areInputCellsEmpty(newMark)) {
 			return this.dequeueNew();
@@ -199,7 +196,7 @@ class RebaseQueue {
 
 	private dequeueBase(length?: number): RebaseMarks {
 		const baseMark =
-			length !== undefined ? this.baseMarks.dequeueUpTo(length) : this.baseMarks.dequeue();
+			length === undefined ? this.baseMarks.dequeue() : this.baseMarks.dequeueUpTo(length);
 
 		let newMark: Mark = generateNoOpWithCellId(baseMark);
 
@@ -246,14 +243,12 @@ class RebaseQueue {
  * @returns a mark which has the composite effect of `mark` and `effect`.
  */
 function addMovedMarkEffect(mark: Mark, effect: Detach): Mark {
-	if (isAttach(mark) && isDetach(effect)) {
+	if (isMoveIn(mark) && isMoveOut(effect)) {
 		return { ...mark, type: "Insert" };
-	} else if (isRename(mark) && isDetach(effect)) {
-		const result = { ...effect, count: mark.count };
-		if (!areEqualChangeAtomIds(mark.idOverride, getDetachedRootId(effect))) {
-			result.detachCellId = mark.idOverride;
-		}
-		return result;
+	} else if (isRename(mark) && isMoveOut(effect)) {
+		return { ...effect, count: mark.count, idOverride: mark.idOverride };
+	} else if (isAttachAndDetachEffect(mark) && isMoveIn(mark.attach) && isMoveOut(effect)) {
+		return { ...mark.detach, count: mark.count };
 	} else if (isTombstone(mark)) {
 		return { ...mark, ...effect };
 	}
@@ -273,7 +268,7 @@ function rebaseMark(
 	currMark: Mark,
 	baseMark: Mark,
 	rebaseChild: NodeChangeRebaser,
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 ): Mark {
 	const rebasedMark = rebaseNodeChange(cloneMark(currMark), baseMark, rebaseChild);
 	const movedNodeChanges = getMovedChangesFromBaseMark(moveEffects, baseMark);
@@ -283,6 +278,7 @@ function rebaseMark(
 			0x8dc /* Unexpected collision of new node changes */,
 		);
 		rebasedMark.changes = movedNodeChanges;
+		moveEffects.onMoveIn(movedNodeChanges);
 	}
 
 	return rebaseMarkIgnoreChild(rebasedMark, baseMark, moveEffects);
@@ -291,7 +287,7 @@ function rebaseMark(
 function rebaseMarkIgnoreChild(
 	currMark: Mark,
 	baseMark: Mark,
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 ): Mark {
 	let rebasedMark: Mark;
 	if (isDetach(baseMark)) {
@@ -304,112 +300,95 @@ function rebaseMarkIgnoreChild(
 			0x69d /* A new attach should not be rebased over its cell being emptied */,
 		);
 		const baseCellId = getDetachOutputCellId(baseMark);
-		const baseDetachId = getDetachedRootId(baseMark);
 
-		const { remains, follows } = separateEffectsForMove(
-			extractMarkEffect(currMark),
-			baseMark,
-			moveEffects,
-		);
-
-		moveRebasedChanges(moveEffects, baseDetachId, baseMark.count, currMark.changes, follows);
-		rebasedMark = { ...(remains ?? {}), count: baseMark.count };
-		return makeDetachedMark(rebasedMark, cloneCellId(baseCellId));
-	} else if (markFillsCells(baseMark)) {
-		return withCellId(currMark, undefined);
-	} else if (isRename(baseMark)) {
-		if (currMark.type === "Rename") {
-			const doesBaseMoveAndAttach = moveEffects.doesBaseAttachNodes(
-				baseMark.idOverride,
-				baseMark.count,
-			).value;
-
-			assert(baseMark.cellId !== undefined, "Rename should target empty cells");
-			const baseRootRename = moveEffects.getBaseRename(baseMark.cellId, baseMark.count).value;
-			const doesBaseMoveAndDetach =
-				baseRootRename !== undefined &&
-				!areEqualChangeAtomIds(baseRootRename, baseMark.idOverride);
-
-			if (doesBaseMoveAndAttach || doesBaseMoveAndDetach) {
-				// `newMark` represents a node-targeting rename.
-				// The base changeset has moved the node which was last detached from the cell,
-				// so we should remove the rename from this location.
-				return { cellId: baseMark.idOverride, count: baseMark.count };
+		if (isMoveOut(baseMark)) {
+			assert(isMoveMark(baseMark), 0x6f0 /* Only move marks have move IDs */);
+			assert(
+				!isNewAttach(currMark),
+				0x819 /* New attaches should not be rebased over moves */,
+			);
+			const { remains, follows } = separateEffectsForMove(extractMarkEffect(currMark));
+			if (follows !== undefined) {
+				sendEffectToDest(follows, moveEffects, getEndpoint(baseMark), baseMark.count);
 			}
-		}
 
-		const newRenameId = moveEffects.getNewRenameForBaseRename(
-			baseMark.idOverride,
-			baseMark.count,
-		).value;
-
-		if (newRenameId !== undefined && currMark.type !== "Insert") {
-			return {
-				type: "Rename",
-				cellId: baseMark.idOverride,
-				count: baseMark.count,
-				idOverride: newRenameId,
-			};
+			if (currMark.changes !== undefined) {
+				moveRebasedChanges(currMark.changes, moveEffects, getEndpoint(baseMark));
+			}
+			rebasedMark = { ...(remains ?? {}), count: baseMark.count };
+		} else {
+			rebasedMark = currMark;
 		}
-
-		return withCellId(currMark, getOutputCellId(baseMark));
+		rebasedMark = makeDetachedMark(rebasedMark, cloneCellId(baseCellId));
+	} else if (markFillsCells(baseMark)) {
+		rebasedMark = isAttachAndDetachEffect(currMark)
+			? withNodeChange({ ...currMark.detach, count: currMark.count }, currMark.changes)
+			: withCellId(currMark, undefined);
+	} else if (isAttachAndDetachEffect(baseMark)) {
+		assert(
+			baseMark.cellId !== undefined,
+			0x81a /* AttachAndDetach mark should target an empty cell */,
+		);
+		const halfRebasedMark = rebaseMarkIgnoreChild(
+			currMark,
+			{ ...baseMark.attach, cellId: cloneCellId(baseMark.cellId), count: baseMark.count },
+			moveEffects,
+		);
+		rebasedMark = rebaseMarkIgnoreChild(
+			halfRebasedMark,
+			{ ...baseMark.detach, count: baseMark.count },
+			moveEffects,
+		);
+	} else if (isRename(baseMark)) {
+		return withCellId(currMark, getDetachOutputCellId(baseMark));
 	} else {
-		return currMark;
+		rebasedMark = currMark;
 	}
+	return rebasedMark;
 }
 
 /**
  * Returns a pair of marks that represent the effects which should remain in place in the face of concurrent move,
  * and the effects that should be sent to the move destination.
  */
-function separateEffectsForMove(
-	mark: MarkEffect,
-	baseMark: CellMark<Detach>,
-	nodeManager: RebaseNodeManager,
-): {
+function separateEffectsForMove(mark: MarkEffect): {
 	remains?: MarkEffect;
 	follows?: Detach;
 } {
 	const type = mark.type;
 	switch (type) {
-		case NoopMarkType:
-			return {};
-		case "Remove": {
-			if (mark.cellRename !== undefined) {
-				return { remains: { type: "Rename", idOverride: mark.cellRename }, follows: mark };
+		case "Remove":
+		case "MoveOut": {
+			// There are two scenarios that lead to a Detach mark having an idOverride:
+			// 1. The detach is a rollback (the idOverride the original id that the cell had in the input context of the attach being rolled back).
+			// 2. The detach has been composed with a Rename (the idOverride is the cell id in the output context of the rename).
+			// Since rollbacks are never rebased, we can safely assume that the idOverride is due to a Rename (scenario #2).
+			// While the detach must follow the node that it targets, the rename must remain in place because it targets the cell.
+			if (mark.idOverride !== undefined) {
+				const remains: MarkEffect = { type: "Rename", idOverride: mark.idOverride };
+				const follows: Mutable<MarkEffect> = { ...mark };
+				delete follows.idOverride;
+				return { remains, follows };
 			}
-
-			const baseDetachId = getDetachedRootId(baseMark);
-			const outputCellId = getDetachOutputCellId(baseMark);
-			const doesBaseMoveNodes =
-				!areEqualChangeAtomIds(outputCellId, baseDetachId) ||
-				nodeManager.doesBaseAttachNodes(baseDetachId, baseMark.count).value;
-
-			// We should rename these cells unless the nodes are reattached elsewhere,
-			// in which case we will rename those cells instead.
-			const remains: MarkEffect = doesBaseMoveNodes
-				? {}
-				: {
-						type: "Rename",
-						idOverride: getDetachOutputCellId(mark),
-					};
-
-			return { remains, follows: mark };
+			return { follows: mark };
+		}
+		case "AttachAndDetach": {
+			return { follows: mark.detach, remains: mark.attach };
 		}
-		case "Rename":
+		case "MoveIn":
+		case "Rename": {
 			return { remains: mark };
+		}
+		case NoopMarkType: {
+			return {};
+		}
 		case "Insert": {
-			const follows: Mutable<Detach> = {
-				type: "Remove",
+			const follows: MoveOut = {
+				type: "MoveOut",
 				id: mark.id,
 			};
-
-			if (mark.detachCellId !== undefined) {
-				follows.detachCellId = mark.detachCellId;
-			}
-
-			const remains: Attach = {
-				type: "Insert",
+			const remains: MoveIn = {
+				type: "MoveIn",
 				id: mark.id,
 			};
 			if (mark.revision !== undefined) {
@@ -418,21 +397,76 @@ function separateEffectsForMove(
 			}
 			return { remains, follows };
 		}
-		default:
+		default: {
 			unreachableCase(type);
+		}
 	}
 }
 
-function moveRebasedChanges(
-	moveEffects: RebaseNodeManager,
-	baseId: ChangeAtomId,
+// TODO: Reduce the duplication between this and other MoveEffect helpers
+function sendEffectToDest(
+	markEffect: Detach,
+	moveEffects: MoveEffectTable,
+	{ revision, localId: id }: ChangeAtomId,
 	count: number,
-	nodeChange: NodeId | undefined,
-	newDetach: Detach | undefined,
 ): void {
-	const newId = newDetach !== undefined ? getDetachedRootId(newDetach) : undefined;
-	const detachCellId = newDetach?.detachCellId;
-	moveEffects.rebaseOverDetach(baseId, count, newId, nodeChange, detachCellId);
+	const effect = getMoveEffect(
+		moveEffects,
+		CrossFieldTarget.Destination,
+		revision,
+		id,
+		count,
+		false,
+	);
+	if (effect.length < count) {
+		const [markEffect1, markEffect2] = splitMarkEffect(markEffect, effect.length);
+		const newEffect =
+			effect.value === undefined
+				? { movedMark: markEffect1 }
+				: { ...effect.value, movedMark: markEffect1 };
+		setMoveEffect(
+			moveEffects,
+			CrossFieldTarget.Destination,
+			revision,
+			id,
+			effect.length,
+			newEffect,
+		);
+		sendEffectToDest(
+			markEffect2,
+			moveEffects,
+			{ revision, localId: brand(id + effect.length) },
+			count - effect.length,
+		);
+	} else {
+		const newEffect: MoveEffect =
+			effect.value === undefined
+				? { movedEffect: markEffect }
+				: { ...effect.value, movedEffect: markEffect };
+		setMoveEffect(moveEffects, CrossFieldTarget.Destination, revision, id, count, newEffect);
+	}
+}
+
+function moveRebasedChanges(
+	nodeChange: NodeId,
+	moveEffects: MoveEffectTable,
+	{ revision, localId: id }: ChangeAtomId,
+): void {
+	const effect = getMoveEffect(
+		moveEffects,
+		CrossFieldTarget.Destination,
+		revision,
+		id,
+		1,
+		false,
+	).value;
+
+	const newEffect =
+		effect === undefined
+			? { rebasedChanges: nodeChange }
+			: { ...effect, rebasedChanges: nodeChange };
+
+	setMoveEffect(moveEffects, CrossFieldTarget.Destination, revision, id, 1, newEffect);
 }
 
 function rebaseNodeChange(
@@ -475,12 +509,21 @@ function withCellId<TMark extends Mark>(mark: TMark, cellId: CellId | undefined)
 }
 
 function getMovedEffectFromBaseMark(
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 	baseMark: Mark,
 ): Detach | undefined {
-	return isAttach(baseMark)
-		? getMovedEffect(moveEffects, baseMark.revision, baseMark.id, baseMark.count)
-		: undefined;
+	if (isMoveIn(baseMark)) {
+		return getMovedEffect(moveEffects, baseMark.revision, baseMark.id, baseMark.count);
+	} else if (isAttachAndDetachEffect(baseMark) && isMoveIn(baseMark.attach)) {
+		return getMovedEffect(
+			moveEffects,
+			baseMark.attach.revision,
+			baseMark.attach.id,
+			baseMark.count,
+		);
+	} else {
+		return undefined;
+	}
 }
 
 // It is expected that the range from `id` to `id + count - 1` has the same move effect.
@@ -488,47 +531,47 @@ function getMovedEffectFromBaseMark(
 // to match the ranges in `moveEffects`.
 // TODO: Reduce the duplication between this and other MoveEffect helpers
 function getMovedEffect(
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 	revision: RevisionTag | undefined,
-	localId: MoveId,
+	id: MoveId,
 	count: number,
 ): Detach | undefined {
-	const entry = moveEffects.getNewChangesForBaseAttach({ revision, localId }, count);
-	assert(entry.length === count, 0x6f3 /* Expected effect to cover entire mark */);
-	const detachId = entry.value?.detachId;
-	if (detachId === undefined) {
-		assert(
-			entry.value?.cellRename === undefined,
-			"Cell detach should be accompanied by node detach",
-		);
+	const effect = getMoveEffect(moveEffects, CrossFieldTarget.Destination, revision, id, count);
+	assert(effect.length === count, 0x6f3 /* Expected effect to cover entire mark */);
+	const movedEffect = effect.value?.movedEffect;
+	if (movedEffect === undefined) {
 		return undefined;
 	}
-
-	const detach: Mutable<Detach> = {
-		type: "Remove",
-		revision: detachId.revision,
-		id: detachId.localId,
-	};
-	if (entry.value?.cellRename !== undefined) {
-		detach.detachCellId = entry.value.cellRename;
+	if (isMoveOut(movedEffect)) {
+		moveEffects.moveKey(CrossFieldTarget.Source, movedEffect.revision, movedEffect.id, count);
 	}
-
-	return detach;
+	return movedEffect;
 }
 
 function getMovedChangesFromBaseMark(
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 	baseMark: Mark,
 ): NodeId | undefined {
-	return isAttach(baseMark)
-		? getMovedNodeChanges(moveEffects, baseMark.revision, baseMark.id)
-		: undefined;
+	if (isMoveIn(baseMark)) {
+		return getMovedNodeChanges(moveEffects, baseMark.revision, baseMark.id, baseMark.count);
+	} else if (isAttachAndDetachEffect(baseMark) && isMoveIn(baseMark.attach)) {
+		return getMovedNodeChanges(
+			moveEffects,
+			baseMark.attach.revision,
+			baseMark.attach.id,
+			baseMark.count,
+		);
+	} else {
+		return undefined;
+	}
 }
 
 function getMovedNodeChanges(
-	moveEffects: RebaseNodeManager,
+	moveEffects: MoveEffectTable,
 	revision: RevisionTag | undefined,
-	localId: MoveId,
+	id: MoveId,
+	count: number,
 ): NodeId | undefined {
-	return moveEffects.getNewChangesForBaseAttach({ revision, localId }, 1).value?.nodeChange;
+	return getMoveEffect(moveEffects, CrossFieldTarget.Destination, revision, id, count).value
+		?.rebasedChanges;
 }

package/src/feature-libraries/sequence-field/relevantRemovedRoots.ts

@@ -0,0 +1,57 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { assert } from "@fluidframework/core-utils/internal";
+
+import { type DeltaDetachedNodeId, offsetDetachId } from "../../core/index.js";
+import { nodeIdFromChangeAtom } from "../deltaUtils.js";
+import type { RelevantRemovedRootsFromChild } from "../modular-schema/index.js";
+
+import type { Changeset, Mark } from "./types.js";
+import { isAttachAndDetachEffect, isDetachOfRemovedNodes, isInsert } from "./utils.js";
+
+export function* relevantRemovedRoots(
+	change: Changeset,
+	relevantRemovedRootsFromChild: RelevantRemovedRootsFromChild,
+): Iterable<DeltaDetachedNodeId> {
+	for (const mark of change) {
+		if (refersToRelevantRemovedRoots(mark)) {
+			assert(
+				mark.cellId !== undefined,
+				0x81d /* marks referring to removed trees must have an assigned cell ID */,
+			);
+			const nodeId = nodeIdFromChangeAtom(mark.cellId);
+			for (let i = 0; i < mark.count; i += 1) {
+				yield offsetDetachId(nodeId, i);
+			}
+		}
+		if (mark.changes !== undefined) {
+			yield* relevantRemovedRootsFromChild(mark.changes);
+		}
+	}
+}
+
+function refersToRelevantRemovedRoots(mark: Mark): boolean {
+	if (mark.cellId !== undefined) {
+		const effect = isAttachAndDetachEffect(mark) ? mark.attach : mark;
+		if (isInsert(effect)) {
+			// This tree is being inserted or restored.
+			return true;
+		} else if (isDetachOfRemovedNodes(mark)) {
+			// This removed tree is being restored as part of a detach.
+			return true;
+		}
+		if (mark.changes !== undefined) {
+			// This removed tree is being edited.
+			// Note: there is a possibility that the child changes only affect a distant descendant
+			// which may have been removed from this (removed) subtree. In such a case, this tree is not truly
+			// relevant, but including it is the conservative thing to do.
+			// In the future, we may represent changes to removed trees using the ID of the lowest removed
+			// ancestor, which would allow us to avoid including such trees when they truly are not needed.
+			return true;
+		}
+	}
+	return false;
+}