@fluidframework/merge-tree 2.30.0 → 2.31.0

package/src/mergeTreeDeltaCallback.ts

@@ -140,15 +140,11 @@ export interface IMergeTreeDeltaOpArgs {
 	 * This field is omitted for deltas corresponding to unacknowledged changes.
 	 */
 	readonly sequencedMessage?: ISequencedDocumentMessage;
-}
 
-/**
- * @internal
- */
-export interface IMergeTreeClientSequenceArgs {
-	readonly clientId: number;
-	readonly referenceSequenceNumber: number;
-	readonly sequenceNumber: number;
+	/**
+	 * Set to true if this delta is being performed as part of a rollback of unsent local changes.
+	 */
+	readonly rollback?: true;
 }
 
 /**

package/src/mergeTreeNodes.ts

@@ -7,12 +7,18 @@ import { assert } from "@fluidframework/core-utils/internal";
 import { AttributionKey } from "@fluidframework/runtime-definitions/internal";
 
 import { IAttributionCollection } from "./attributionCollection.js";
-import { LocalClientId, UnassignedSequenceNumber } from "./constants.js";
+import {
+	LocalClientId,
+	NonCollabClient,
+	UnassignedSequenceNumber,
+	UniversalSequenceNumber,
+} from "./constants.js";
 import { LocalReferenceCollection, type LocalReferencePosition } from "./localReference.js";
 import { TrackingGroupCollection } from "./mergeTreeTracking.js";
 import { IJSONSegment, IMarkerDef, ReferenceType } from "./ops.js";
 import { computeHierarchicalOrdinal } from "./ordinal.js";
 import type { PartialSequenceLengths } from "./partialLengths.js";
+import { LocalDefaultPerspective, PriorPerspective, type Perspective } from "./perspective.js";
 import { PropertySet, clone, createMap, type MapLike } from "./properties.js";
 import { ReferencePosition } from "./referencePositions.js";
 import { SegmentGroupCollection } from "./segmentGroupCollection.js";
@@ -20,16 +26,15 @@ import {
 	hasProp,
 	isInserted,
 	isMergeNodeInfo as isMergeNode,
-	isMoved,
 	isRemoved,
 	overwriteInfo,
-	type IInsertionInfo,
+	type IHasInsertionInfo,
 	type IMergeNodeInfo,
-	type IMoveInfo,
-	type IRemovalInfo,
+	type IHasRemovalInfo,
 	type SegmentWithInfo,
 } from "./segmentInfos.js";
 import { PropertiesManager } from "./segmentPropertiesManager.js";
+import type { OperationStamp, SliceRemoveOperationStamp } from "./stamps.js";
 
 /**
  * This interface exposes internal things to dds that leverage merge tree,
@@ -91,7 +96,7 @@ export interface ISegmentPrivate extends ISegmentInternal {
 	obliteratePrecedingInsertion?: ObliterateInfo;
 }
 /**
- * Segment leafs are segments that have both IMergeNodeInfo and IInsertionInfo. This means they
+ * Segment leafs are segments that have both IMergeNodeInfo and IHasInsertionInfo. This means they
  * are inserted at a position, and bound via their parent MergeBlock to the merge tree. MergeBlocks'
  * children are either a segment leaf, or another merge block for interior nodes of the tree. When working
  * within the tree it is generally unnecessary to use type coercions methods common to the infos, and segment
@@ -99,7 +104,7 @@ export interface ISegmentPrivate extends ISegmentInternal {
  * merge tree, like via client's public methods, it becomes necessary to use the type coercions methods
  * to ensure the passed in segment objects are correctly bound to the merge tree.
  */
-export type ISegmentLeaf = SegmentWithInfo<IMergeNodeInfo & IInsertionInfo>;
+export type ISegmentLeaf = SegmentWithInfo<IMergeNodeInfo & IHasInsertionInfo>;
 /**
  * A type-guard which determines if the segment has segment leaf, and
  * returns true if it does, along with applying strong typing.
@@ -130,7 +135,7 @@ export const assertSegmentLeaf: (segmentLike: unknown) => asserts segmentLike is
  * type as segments may not yet be bound to the tree, so lack merge node info which is required for
  * segment leafs.
  */
-export type IMergeNodeBuilder = MergeBlock | SegmentWithInfo<IInsertionInfo>;
+export type IMergeNodeBuilder = MergeBlock | SegmentWithInfo<IHasInsertionInfo>;
 
 /**
  * This type is used by MergeBlocks to define their children, which are either segments or other
@@ -211,12 +216,12 @@ export interface ISegmentAction<TClientData> {
 	): boolean;
 }
 export interface ISegmentChanges {
-	next?: SegmentWithInfo<IInsertionInfo>;
-	replaceCurrent?: SegmentWithInfo<IInsertionInfo>;
+	next?: SegmentWithInfo<IHasInsertionInfo>;
+	replaceCurrent?: SegmentWithInfo<IHasInsertionInfo>;
 }
 
 export interface InsertContext {
-	candidateSegment?: SegmentWithInfo<IInsertionInfo>;
+	candidateSegment?: SegmentWithInfo<IHasInsertionInfo>;
 	leaf: (segment: ISegmentLeaf | undefined, pos: number, ic: InsertContext) => ISegmentChanges;
 	continuePredicate?: (continueFromBlock: MergeBlock) => boolean;
 }
@@ -225,9 +230,7 @@ export interface ObliterateInfo {
 	start: LocalReferencePosition;
 	end: LocalReferencePosition;
 	refSeq: number;
-	clientId: number;
-	seq: number;
-	localSeq: number | undefined;
+	stamp: SliceRemoveOperationStamp;
 	segmentGroup: SegmentGroup | undefined;
 }
 
@@ -358,26 +361,18 @@ export abstract class BaseSegment implements ISegment {
 	protected cloneInto(b: ISegment): void {
 		const seg: ISegmentPrivate = b;
 		if (isInserted(this)) {
-			overwriteInfo<IInsertionInfo>(seg, {
-				clientId: this.clientId,
-				seq: this.seq,
+			overwriteInfo<IHasInsertionInfo>(seg, {
+				insert: this.insert,
 			});
 		}
 		// TODO: deep clone properties
 		seg.properties = clone(this.properties);
 		if (isRemoved(this)) {
-			overwriteInfo<IRemovalInfo>(seg, {
-				removedSeq: this.removedSeq,
-				removedClientIds: [...this.removedClientIds],
-			});
-		}
-		if (isMoved(this)) {
-			overwriteInfo<IMoveInfo>(seg, {
-				movedSeq: this.movedSeq,
-				movedSeqs: [...this.movedSeqs],
-				movedClientIds: [...this.movedClientIds],
+			overwriteInfo<IHasRemovalInfo>(seg, {
+				removes: [...this.removes],
 			});
 		}
+
 		seg.attribution = this.attribution?.clone();
 	}
 
@@ -421,25 +416,11 @@ export abstract class BaseSegment implements ISegment {
 		}
 
 		if (isInserted(this)) {
-			overwriteInfo<IInsertionInfo>(leafSegment, {
-				seq: this.seq,
-				localSeq: this.localSeq,
-				clientId: this.clientId,
-			});
+			overwriteInfo<IHasInsertionInfo>(leafSegment, { insert: this.insert });
 		}
 		if (isRemoved(this)) {
-			overwriteInfo<IRemovalInfo>(leafSegment, {
-				removedClientIds: [...this.removedClientIds],
-				removedSeq: this.removedSeq,
-				localRemovedSeq: this.localRemovedSeq,
-			});
-		}
-		if (isMoved(this)) {
-			overwriteInfo<IMoveInfo>(leafSegment, {
-				movedClientIds: [...this.movedClientIds],
-				movedSeq: this.movedSeq,
-				movedSeqs: [...this.movedSeqs],
-				localMovedSeq: this.localMovedSeq,
+			overwriteInfo<IHasRemovalInfo>(leafSegment, {
+				removes: [...this.removes],
 			});
 		}
 
@@ -583,6 +564,32 @@ export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 	}
 }
 
+/**
+ * Returns a stamp that occurs at the minimum sequence number.
+ * @privateRemarks
+ * This is a free function over something obtainable on CollaborationWindow to avoid exposing Perspective
+ * and OperationStamp from the package (even internally), at least for now.
+ * If/when `Client`'s API is refactored to be structured similarly to MergeTree (so that SharedString passes in
+ * things closer to `Perspective`s when calling methods on `Client` rather than refSeq/localSeq/clientId etc),
+ * it may be more reasonable to expose this more directly on `CollaborationWindow`.
+ */
+export function getMinSeqStamp(collabWindow: CollaborationWindow): OperationStamp {
+	return { seq: collabWindow.minSeq, clientId: NonCollabClient };
+}
+
+/**
+ * Returns a perspective representing a readonly client's view of the tree at the minimum sequence number.
+ * @privateRemarks
+ * This is a free function over something obtainable on CollaborationWindow to avoid exposing Perspective
+ * and OperationStamp from the package (even internally), at least for now.
+ * If/when `Client`'s API is refactored to be structured similarly to MergeTree (so that SharedString passes in
+ * things closer to `Perspective`s when calling methods on `Client` rather than refSeq/localSeq/clientId etc),
+ * it may be more reasonable to expose this more directly on `CollaborationWindow`.
+ */
+export function getMinSeqPerspective(collabWindow: CollaborationWindow): Perspective {
+	return new PriorPerspective(collabWindow.minSeq, NonCollabClient);
+}
+
 /**
  * This class is used to track facts about the current window of collaboration. This window is defined by the server
  * specified minimum sequence number to the last sequence number seen. Additionally, it track state for outstanding
@@ -667,12 +674,26 @@ export class CollaborationWindow {
 	 */
 	localSeq = 0;
 
-	loadFrom(a: CollaborationWindow): void {
+	public localPerspective: Perspective = new LocalDefaultPerspective(this.clientId);
+
+	public loadFrom(a: CollaborationWindow): void {
 		this.clientId = a.clientId;
 		this.collaborating = a.collaborating;
 		this.minSeq = a.minSeq;
 		this.currentSeq = a.currentSeq;
 	}
+
+	public mintNextLocalOperationStamp(): OperationStamp {
+		if (this.collaborating) {
+			this.localSeq++;
+		}
+
+		return {
+			seq: this.collaborating ? UnassignedSequenceNumber : UniversalSequenceNumber,
+			clientId: this.clientId,
+			localSeq: this.localSeq,
+		};
+	}
 }
 
 /**