@fluidframework/merge-tree 2.1.0 → 2.2.0

package/src/attributionPolicy.ts

@@ -136,25 +136,22 @@ function createPropertyTrackingMergeTreeCallbacks(
 ): AttributionCallbacks {
 	const toTrack = propNames.map((entry) => ({ propName: entry, channelName: entry }));
 	const attributeAnnotateOnSegments = (
+		isLocal: boolean,
 		deltaSegments: IMergeTreeSegmentDelta[],
-		{ op, sequencedMessage }: IMergeTreeDeltaOpArgs,
+		{ op }: IMergeTreeDeltaOpArgs,
 		key: AttributionKey,
 	): void => {
-		for (const { segment } of deltaSegments) {
+		for (const { segment, propertyDeltas } of deltaSegments) {
 			for (const { propName, channelName } of toTrack) {
 				const shouldAttributeInsert =
 					op.type === MergeTreeDeltaType.INSERT &&
 					segment.properties?.[propName] !== undefined;
 
-				const isLocal = sequencedMessage === undefined;
 				const shouldAttributeAnnotate =
 					op.type === MergeTreeDeltaType.ANNOTATE &&
 					// Only attribute annotations which change the tracked property
 					op.props[propName] !== undefined &&
-					// Local changes to the tracked property always take effect
-					(isLocal ||
-						// Acked changes only take effect if there isn't a pending local change
-						(!isLocal && !segment.propertyManager?.hasPendingProperty(propName)));
+					(isLocal || (propertyDeltas !== undefined && propName in propertyDeltas));
 
 				if (shouldAttributeInsert || shouldAttributeAnnotate) {
 					segment.attribution?.update(
@@ -170,6 +167,7 @@ function createPropertyTrackingMergeTreeCallbacks(
 			const { op, sequencedMessage } = opArgs;
 			if (op.type === MergeTreeDeltaType.ANNOTATE || op.type === MergeTreeDeltaType.INSERT) {
 				attributeAnnotateOnSegments(
+					sequencedMessage === undefined,
 					deltaSegments,
 					opArgs,
 					getAttributionKey(client, sequencedMessage),
@@ -179,6 +177,7 @@ function createPropertyTrackingMergeTreeCallbacks(
 		maintenance: ({ deltaSegments, operation }, opArgs, client): void => {
 			if (operation === MergeTreeMaintenanceType.ACKNOWLEDGED && opArgs !== undefined) {
 				attributeAnnotateOnSegments(
+					true,
 					deltaSegments,
 					opArgs,
 					getAttributionKey(client, opArgs.sequencedMessage),

package/src/client.ts

@@ -7,7 +7,7 @@
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { type IEventThisPlaceHolder, IFluidHandle } from "@fluidframework/core-interfaces";
-import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
+import { assert, unreachableCase, isObject } from "@fluidframework/core-utils/internal";
 import {
 	IFluidDataStoreRuntime,
 	IChannelStorageService,
@@ -29,7 +29,7 @@ import { MergeTreeTextHelper } from "./MergeTreeTextHelper.js";
 import { DoublyLinkedList, RedBlackTree } from "./collections/index.js";
 import { UnassignedSequenceNumber, UniversalSequenceNumber } from "./constants.js";
 import { LocalReferencePosition, SlidingPreference } from "./localReference.js";
-import { IMergeTreeOptions, MergeTree } from "./mergeTree.js";
+import { IMergeTreeOptions, MergeTree, errorIfOptionNotTrue } from "./mergeTree.js";
 import type {
 	IMergeTreeClientSequenceArgs,
 	IMergeTreeDeltaCallbackArgs,
@@ -40,7 +40,6 @@ import { walkAllChildSegments } from "./mergeTreeNodeWalk.js";
 import {
 	// eslint-disable-next-line import/no-deprecated
 	CollaborationWindow,
-	IMoveInfo,
 	ISegment,
 	ISegmentAction,
 	ISegmentLeaf,
@@ -48,6 +47,7 @@ import {
 	// eslint-disable-next-line import/no-deprecated
 	SegmentGroup,
 	compareStrings,
+	toMoveInfo,
 } from "./mergeTreeNodes.js";
 import {
 	createAnnotateMarkerOp,
@@ -73,7 +73,7 @@ import {
 	MergeTreeDeltaType,
 	ReferenceType,
 } from "./ops.js";
-import { PropertySet, createMap } from "./properties.js";
+import { PropertySet } from "./properties.js";
 import { DetachedReferencePosition, ReferencePosition } from "./referencePositions.js";
 import { SnapshotLoader } from "./snapshotLoader.js";
 import { SnapshotV1 } from "./snapshotV1.js";
@@ -84,14 +84,6 @@ import { IMergeTreeTextHelper } from "./textSegment.js";
 type IMergeTreeDeltaRemoteOpArgs = Omit<IMergeTreeDeltaOpArgs, "sequencedMessage"> &
 	Required<Pick<IMergeTreeDeltaOpArgs, "sequencedMessage">>;
 
-function removeMoveInfo(segment: Partial<IMoveInfo>): void {
-	delete segment.movedSeq;
-	delete segment.movedSeqs;
-	delete segment.localMovedSeq;
-	delete segment.movedClientIds;
-	delete segment.wasMovedOnInsert;
-}
-
 /**
  * A range [start, end)
  * @internal
@@ -825,18 +817,30 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 						segment.seq === UnassignedSequenceNumber,
 						0x037 /* "Segment already has assigned sequence number" */,
 					);
-					let segInsertOp = segment;
-					// The suppression is needed because the segment needs to have a type of any.
-					// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-					if (typeof resetOp.seg === "object" && resetOp.seg.props !== undefined) {
-						segInsertOp = segment.clone();
-						segInsertOp.properties = createMap();
-						// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
-						segInsertOp.addProperties(resetOp.seg.props);
-					}
-					if (segment.movedSeq !== UnassignedSequenceNumber) {
-						removeMoveInfo(segment);
+					const moveInfo = toMoveInfo(segment);
+
+					if (moveInfo !== undefined) {
+						errorIfOptionNotTrue(
+							this._mergeTree.options,
+							"mergeTreeEnableObliterateReconnect",
+						);
+						if (moveInfo.movedSeq !== UnassignedSequenceNumber) {
+							// the segment was remotely obliterated, so is considered removed
+							// we set the seq to the universal seq and remove the local seq,
+							// so its length is not considered for subsequent local changes
+							// this allows us to not send the op as even the local client will ignore the segment
+							segment.seq = UniversalSequenceNumber;
+							segment.localSeq = undefined;
+							break;
+						}
 					}
+
+					const segInsertOp: ISegment = segment.clone();
+					const opProps =
+						isObject(resetOp.seg) && "props" in resetOp.seg && isObject(resetOp.seg.props)
+							? { ...resetOp.seg.props }
+							: undefined;
+					segInsertOp.properties = opProps;
 					newOp = createInsertSegmentOp(segmentPosition, segInsertOp);
 					break;
 				}
@@ -857,6 +861,7 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 					break;
 				}
 				case MergeTreeDeltaType.OBLITERATE: {
+					errorIfOptionNotTrue(this._mergeTree.options, "mergeTreeEnableObliterateReconnect");
 					if (
 						segment.localMovedSeq !== undefined &&
 						segment.movedSeq === UnassignedSequenceNumber &&

package/src/index.ts

@@ -122,6 +122,12 @@ export {
 } from "./referencePositions.js";
 export { SegmentGroupCollection } from "./segmentGroupCollection.js";
 export { PropertiesManager, PropertiesRollback } from "./segmentPropertiesManager.js";
+export {
+	InteriorSequencePlace,
+	Side,
+	SequencePlace,
+	endpointPosAndSide,
+} from "./sequencePlace.js";
 export { SortedSet } from "./sortedSet.js";
 export { SortedSegmentSet, SortedSegmentSetItem } from "./sortedSegmentSet.js";
 export { IJSONTextSegment, IMergeTreeTextHelper, TextSegment } from "./textSegment.js";

package/src/localReference.ts

@@ -70,6 +70,13 @@ export interface LocalReferencePosition extends ReferencePosition {
 	 * special segments representing the position before or after the tree
 	 */
 	readonly canSlideToEndpoint?: boolean;
+
+	/**
+	 * @param newProps - Properties to add to this reference.
+	 * @remarks Note that merge-tree does not broadcast changes to other clients. It is up to the consumer
+	 * to ensure broadcast happens if that is desired.
+	 */
+	addProperties(newProps: PropertySet): void;
 }
 
 /**
@@ -125,7 +132,7 @@ class LocalReference implements LocalReferencePosition {
 		this.offset = offset;
 	}
 
-	public isLeaf(): boolean {
+	public isLeaf(): this is ISegment {
 		return false;
 	}
 

package/src/mergeTree.ts

@@ -85,7 +85,9 @@ import {
 	refHasTileLabel,
 	refTypeIncludesFlag,
 } from "./referencePositions.js";
+// eslint-disable-next-line import/no-deprecated
 import { PropertiesRollback } from "./segmentPropertiesManager.js";
+import { endpointPosAndSide, type SequencePlace } from "./sequencePlace.js";
 import { zamboniSegments } from "./zamboni.js";
 
 function wasRemovedAfter(seg: ISegment, seq: number): boolean {
@@ -190,6 +192,23 @@ export interface IMergeTreeOptions {
 	 * Default value: false
 	 */
 	mergeTreeEnableObliterate?: boolean;
+
+	/**
+	 * Enables support for reconnecting when obliterate operations are present
+	 *
+	 * Obliterate is currently experimental and may not work in all scenarios.
+	 *
+	 * @defaultValue `false`
+	 */
+	mergeTreeEnableObliterateReconnect?: boolean;
+}
+export function errorIfOptionNotTrue(
+	options: IMergeTreeOptions | undefined,
+	option: keyof IMergeTreeOptions,
+): void {
+	if (options?.[option] !== true) {
+		throw new Error(`${option} is not enabled.`);
+	}
 }
 
 /**
@@ -1636,7 +1655,11 @@ export class MergeTree {
 		return { next };
 	};
 
-	private ensureIntervalBoundary(pos: number, refSeq: number, clientId: number): void {
+	private ensureIntervalBoundary(
+		pos: number | "start" | "end",
+		refSeq: number,
+		clientId: number,
+	): void {
 		const splitNode = this.insertingWalk(
 			this.root,
 			pos,
@@ -1684,14 +1707,22 @@ export class MergeTree {
 
 	private insertingWalk(
 		block: MergeBlock,
-		pos: number,
+		pos: number | "start" | "end",
 		refSeq: number,
 		clientId: number,
 		seq: number,
 		context: InsertContext,
 		isLastChildBlock: boolean = true,
 	): MergeBlock | undefined {
-		let _pos = pos;
+		let _pos: number;
+		if (pos === "start") {
+			_pos = 0;
+		} else if (pos === "end") {
+			_pos = this.root.mergeTree?.getLength(refSeq, clientId) ?? 0;
+		} else {
+			_pos = pos;
+		}
+
 		const children = block.children;
 		let childIndex: number;
 		let child: IMergeNode;
@@ -1849,6 +1880,7 @@ export class MergeTree {
 		clientId: number,
 		seq: number,
 		opArgs: IMergeTreeDeltaOpArgs,
+		// eslint-disable-next-line import/no-deprecated
 		rollback: PropertiesRollback = PropertiesRollback.None,
 	): void {
 		this.ensureIntervalBoundary(start, refSeq, clientId);
@@ -1910,20 +1942,30 @@ export class MergeTree {
 	}
 
 	public obliterateRange(
-		start: number,
-		end: number,
+		start: SequencePlace,
+		end: SequencePlace,
 		refSeq: number,
 		clientId: number,
 		seq: number,
 		overwrite: boolean = false,
 		opArgs: IMergeTreeDeltaOpArgs,
 	): void {
-		if (!this.options?.mergeTreeEnableObliterate) {
-			throw new UsageError("Attempted to send obliterate op without enabling feature flag.");
-		}
+		errorIfOptionNotTrue(this.options, "mergeTreeEnableObliterate");
 
-		this.ensureIntervalBoundary(start, refSeq, clientId);
-		this.ensureIntervalBoundary(end, refSeq, clientId);
+		const { startPos, startSide, endPos, endSide } = endpointPosAndSide(start, end);
+
+		assert(
+			startPos !== undefined &&
+				endPos !== undefined &&
+				startSide !== undefined &&
+				endSide !== undefined &&
+				startPos !== "end" &&
+				endPos !== "start",
+			0x9e2 /* start and end cannot be undefined because they were not passed in as undefined */,
+		);
+
+		this.ensureIntervalBoundary(startPos, refSeq, clientId);
+		this.ensureIntervalBoundary(endPos, refSeq, clientId);
 
 		let _overwrite = overwrite;
 		const localOverlapWithRefs: ISegment[] = [];
@@ -1944,6 +1986,8 @@ export class MergeTree {
 			_end: number,
 		): boolean => {
 			const existingMoveInfo = toMoveInfo(segment);
+			if (startSide) segment.startSide = startSide;
+			if (endSide) segment.endSide = endSide;
 
 			if (
 				clientId !== segment.clientId &&
@@ -2259,6 +2303,7 @@ export class MergeTree {
 						this.collabWindow.clientId,
 						UniversalSequenceNumber,
 						{ op: annotateOp },
+						// eslint-disable-next-line import/no-deprecated
 						PropertiesRollback.Rollback,
 					);
 					i++;
@@ -2662,18 +2707,28 @@ export class MergeTree {
 		leaf: ISegmentAction<TClientData>,
 		accum: TClientData,
 		post?: BlockAction<TClientData>,
-		start: number = 0,
-		end?: number,
+		start: SequencePlace = 0,
+		end?: SequencePlace,
 		localSeq?: number,
 		visibilitySeq: number = refSeq,
 	): void {
-		const endPos = end ?? this.nodeLength(this.root, refSeq, clientId, localSeq) ?? 0;
-		if (endPos === start) {
+		const maybeEndPos = end ?? this.nodeLength(this.root, refSeq, clientId, localSeq) ?? 0;
+		if (maybeEndPos === start) {
 			return;
 		}
 
 		let pos = 0;
+		let { startPos, endPos } = endpointPosAndSide(start, end);
 
+		startPos = startPos === "start" || startPos === undefined ? 0 : startPos;
+		endPos =
+			endPos === "end" || endPos === undefined
+				? this.root.mergeTree?.getLength(refSeq, clientId) ?? 0
+				: endPos;
+		assert(
+			startPos !== "end" && endPos !== "start",
+			0x9e3 /* start cannot be 'end' and end cannot be 'start' */,
+		);
 		depthFirstNodeWalk(
 			this.root,
 			this.root.children[0],
@@ -2701,13 +2756,15 @@ export class MergeTree {
 
 				const nextPos = pos + lenAtRefSeq;
 				// start is beyond the current node, so we can skip it
-				if (start >= nextPos) {
+				if (typeof startPos === "number" && startPos >= nextPos) {
 					pos = nextPos;
 					return NodeAction.Skip;
 				}
 
 				if (node.isLeaf()) {
-					if (leaf(node, pos, refSeq, clientId, start - pos, endPos - pos, accum) === false) {
+					if (
+						leaf(node, pos, refSeq, clientId, startPos - pos, endPos - pos, accum) === false
+					) {
 						return NodeAction.Exit;
 					}
 					pos = nextPos;
@@ -2717,7 +2774,7 @@ export class MergeTree {
 			post === undefined
 				? undefined
 				: (block): boolean =>
-						post(block, pos, refSeq, clientId, start - pos, endPos - pos, accum),
+						post(block, pos, refSeq, clientId, startPos - pos, endPos - pos, accum),
 		);
 	}
 }

package/src/mergeTreeNodes.ts

@@ -26,8 +26,11 @@ import {
 	refGetTileLabels,
 	refTypeIncludesFlag,
 } from "./referencePositions.js";
+// eslint-disable-next-line import/no-deprecated
 import { SegmentGroupCollection } from "./segmentGroupCollection.js";
+// eslint-disable-next-line import/no-deprecated
 import { PropertiesManager, PropertiesRollback } from "./segmentPropertiesManager.js";
+import { Side } from "./sequencePlace.js";
 
 /**
  * Common properties for a node in a merge tree.
@@ -181,6 +184,10 @@ export function toMoveInfo(maybe: Partial<IMoveInfo> | undefined): IMoveInfo | u
  */
 export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Partial<IMoveInfo> {
 	readonly type: string;
+	/**
+	 * @deprecated - This property should not be used externally and will be removed in a subsequent release.
+	 */
+	// eslint-disable-next-line import/no-deprecated
 	readonly segmentGroups: SegmentGroupCollection;
 	readonly trackingCollection: TrackingGroupCollection;
 	/**
@@ -217,7 +224,10 @@ export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Parti
 
 	/**
 	 * Manages pending local state for properties on this segment.
+	 *
+	 * @deprecated - This property should not be used externally and will be removed in a subsequent release.
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	propertyManager?: PropertiesManager;
 	/**
 	 * Local seq at which this segment was inserted.
@@ -253,10 +263,20 @@ export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Parti
 	 * Properties that have been added to this segment via annotation.
 	 */
 	properties?: PropertySet;
+	/**
+	 * Stores side information passed to obliterate for the start of a range.
+	 */
+	startSide?: Side.Before | Side.After;
+	/**
+	 * Stores side information passed to obliterate for the end of a range.
+	 */
+	endSide?: Side.Before | Side.After;
 
 	/**
 	 * Add properties to this segment via annotation.
 	 *
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
+	 *
 	 * @remarks This function should not be called directly. Properties should
 	 * be added through the `annotateRange` functions.
 	 */
@@ -264,6 +284,7 @@ export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Parti
 		newProps: PropertySet,
 		seq?: number,
 		collaborating?: boolean,
+		// eslint-disable-next-line import/no-deprecated
 		rollback?: PropertiesRollback,
 	): PropertySet;
 	clone(): ISegment;
@@ -274,6 +295,7 @@ export interface ISegment extends IMergeNodeCommon, Partial<IRemovalInfo>, Parti
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	toJSONObject(): any;
 	/**
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
 	 * Acks the current segment against the segment group, op, and merge tree.
 	 *
 	 * @param segmentGroup - Pending segment group associated with this op.
@@ -499,12 +521,22 @@ export abstract class BaseSegment implements ISegment {
 	public ordinal: string = "";
 	public cachedLength: number = 0;
 
+	/**
+	 * {@inheritdoc ISegment.segmentGroups}
+	 * @deprecated - This property should not be used externally and will be removed in a subsequent release.
+	 */
+	// eslint-disable-next-line import/no-deprecated
 	public readonly segmentGroups: SegmentGroupCollection = new SegmentGroupCollection(this);
 	public readonly trackingCollection: TrackingGroupCollection = new TrackingGroupCollection(
 		this,
 	);
 	/***/
 	public attribution?: IAttributionCollection<AttributionKey>;
+	/**
+	 * {@inheritdoc ISegment.propertyManager}
+	 * @deprecated - This property should not be used externally and will be removed in a subsequent release.
+	 */
+	// eslint-disable-next-line import/no-deprecated
 	public propertyManager?: PropertiesManager;
 	public properties?: PropertySet;
 	public localRefs?: LocalReferenceCollection;
@@ -513,12 +545,24 @@ export abstract class BaseSegment implements ISegment {
 	public localRemovedSeq?: number;
 	public localMovedSeq?: number;
 
+	public constructor(properties?: PropertySet) {
+		if (properties !== undefined) {
+			this.properties = clone(properties);
+		}
+	}
+
+	/**
+	 * {@inheritdoc ISegment.addProperties}
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
+	 */
 	public addProperties(
 		newProps: PropertySet,
 		seq?: number,
 		collaborating?: boolean,
+		// eslint-disable-next-line import/no-deprecated
 		rollback: PropertiesRollback = PropertiesRollback.None,
 	): PropertySet {
+		// eslint-disable-next-line import/no-deprecated
 		this.propertyManager ??= new PropertiesManager();
 		// 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
@@ -569,6 +613,10 @@ export abstract class BaseSegment implements ISegment {
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	public abstract toJSONObject(): any;
 
+	/**
+	 * {@inheritdoc ISegment.ack}
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
+	 */
 	public ack(segmentGroup: SegmentGroup, opArgs: IMergeTreeDeltaOpArgs): boolean {
 		const currentSegmentGroup = this.segmentGroups.dequeue();
 		assert(
@@ -676,13 +724,18 @@ export abstract class BaseSegment implements ISegment {
 	}
 
 	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,
-			);
+		if (this.properties !== undefined) {
+			if (this.propertyManager) {
+				// eslint-disable-next-line import/no-deprecated
+				other.propertyManager = new PropertiesManager();
+				other.properties = this.propertyManager.copyTo(
+					this.properties,
+					other.properties,
+					other.propertyManager,
+				);
+			} else {
+				other.properties = clone(this.properties);
+			}
 		}
 	}
 
@@ -755,15 +808,14 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 	public readonly type = Marker.type;
 
 	public static make(refType: ReferenceType, props?: PropertySet): Marker {
-		const marker = new Marker(refType);
-		if (props) {
-			marker.addProperties(props);
-		}
-		return marker;
+		return new Marker(refType, props);
 	}
 
-	constructor(public refType: ReferenceType) {
-		super();
+	constructor(
+		public refType: ReferenceType,
+		props?: PropertySet,
+	) {
+		super(props);
 		this.cachedLength = 1;
 	}
 

package/src/properties.ts

@@ -69,17 +69,14 @@ export function matchProperties(
  */
 export function extend<T>(base: MapLike<T>, extension: MapLike<T> | undefined): MapLike<T> {
 	if (extension !== undefined) {
-		// eslint-disable-next-line guard-for-in, no-restricted-syntax
-		for (const key in extension) {
-			const v = extension[key];
-			// TODO Non null asserting, why is this not null?
-			if (v === null) {
+		for (const [key, v] of Object.entries(extension)) {
+			if (v === undefined) {
+				continue;
+			} else if (v === null) {
 				// eslint-disable-next-line @typescript-eslint/no-dynamic-delete
 				delete base[key];
 			} else {
-				// Non null aseerting here since we are checking if v is not null
-				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-				base[key] = v!;
+				base[key] = v;
 			}
 		}
 	}
@@ -96,16 +93,7 @@ export function clone<T>(extension: MapLike<T> | undefined): MapLike<T> | undefi
 		return undefined;
 	}
 	const cloneMap = createMap<T>();
-	// eslint-disable-next-line guard-for-in, no-restricted-syntax
-	for (const key in extension) {
-		const v = extension[key];
-		if (v !== null) {
-			// If `v` is undefined, undefined must have been assignable to `T`.
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-			cloneMap[key] = v!;
-		}
-	}
-	return cloneMap;
+	return extend(cloneMap, extension);
 }
 
 /**
@@ -118,10 +106,7 @@ export function addProperties(
 	oldProps: PropertySet | undefined,
 	newProps: PropertySet,
 ): PropertySet {
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	const _oldProps = oldProps ?? createMap<any>();
-	extend(_oldProps, newProps);
-	return { ..._oldProps };
+	return extend(oldProps ?? createMap<unknown>(), newProps);
 }
 
 /**

package/src/referencePositions.ts

@@ -101,6 +101,12 @@ export interface ReferencePosition {
 	 * @param newProps - Properties to add to this reference.
 	 * @remarks Note that merge-tree does not broadcast changes to other clients. It is up to the consumer
 	 * to ensure broadcast happens if that is desired.
+	 *
+	 * @deprecated - This function should not be used externally and will be removed in a subsequent release.
+	 *
+	 * @privateRemarks This interface is used by both marker segments and local reference positions. We will remove
+	 * this function from segments, but keep it on local reference positions for now. So it has been added to local reference
+	 * positions, and must be removed here to not apply to marker segments.
 	 */
 	addProperties(newProps: PropertySet): void;
 	isLeaf(): this is ISegment;

package/src/segmentGroupCollection.ts

@@ -8,8 +8,11 @@ import { DoublyLinkedList, walkList } from "./collections/index.js";
 import { ISegment, SegmentGroup } from "./mergeTreeNodes.js";
 
 /**
+ * @deprecated - This class should not be used externally and will be removed in a subsequent release.
  * @legacy
  * @alpha
+ *
+ * @privateRemarks After the deprecation period this class should be remove from this package's exports, and only be used internally
  */
 export class SegmentGroupCollection {
 	// eslint-disable-next-line import/no-deprecated

package/src/segmentPropertiesManager.ts

@@ -9,11 +9,15 @@ import { assert } from "@fluidframework/core-utils/internal";
 
 import { UnassignedSequenceNumber, UniversalSequenceNumber } from "./constants.js";
 import { IMergeTreeAnnotateMsg } from "./ops.js";
-import { MapLike, PropertySet, createMap } from "./properties.js";
+import { MapLike, PropertySet, clone, createMap, extend } from "./properties.js";
 
 /**
  * @legacy
  * @alpha
+ *
+ * @deprecated - This enum should not be used externally and will be removed in a subsequent release.
+ *
+ * @privateRemarks This enum should be made internal after the deprecation period
  */
 export enum PropertiesRollback {
 	/**
@@ -30,6 +34,10 @@ export enum PropertiesRollback {
 /**
  * @legacy
  * @alpha
+ *
+ * @deprecated - This class should not be used externally and will be removed in a subsequent release.
+ *
+ * @privateRemarks This class should be made internal after the deprecation period
  */
 export class PropertiesManager {
 	private pendingKeyUpdateCount: MapLike<number> | undefined;
@@ -125,14 +133,10 @@ export class PropertiesManager {
 			if (!newManager) {
 				throw new Error("Must provide new PropertyManager");
 			}
-			for (const key of Object.keys(oldProps)) {
-				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-				newProps[key] = oldProps[key];
-			}
-			newManager.pendingKeyUpdateCount = createMap<number>();
-			for (const key of Object.keys(this.pendingKeyUpdateCount!)) {
-				// TODO Non null asserting, why is this not null?
-				newManager.pendingKeyUpdateCount[key] = this.pendingKeyUpdateCount![key]!;
+			extend(newProps, oldProps);
+
+			if (this.pendingKeyUpdateCount) {
+				newManager.pendingKeyUpdateCount = clone(this.pendingKeyUpdateCount);
 			}
 		}
 		return newProps;