@fluidframework/sequence 2.33.0-333010 → 2.33.0

package/src/intervalCollection.ts

@@ -215,6 +215,7 @@ export class LocalIntervalCollection {
 		end: SequencePlace,
 		props?: PropertySet,
 		op?: ISequencedDocumentMessage,
+		rollback?: boolean,
 	) {
 		// This check is intended to prevent scenarios where a random interval is created and then
 		// inserted into a collection. The aim is to ensure that the collection is created first
@@ -238,6 +239,7 @@ export class LocalIntervalCollection {
 			undefined,
 			this.options.mergeTreeReferencesCanSlideToEndpoint,
 			props,
+			rollback,
 		);
 
 		this.add(interval);
@@ -391,7 +393,7 @@ class IntervalCollectionIterator implements Iterator<SequenceIntervalClass> {
  * Change events emitted by `IntervalCollection`s
  * @legacy
  * @alpha
- * @remarks The generic version of this interface is no longer used and will be removed. Use {@link ISequenceIntervalCollectionEvents} instead.
+ * @deprecated The generic version of this interface is no longer used and will be removed. Use {@link ISequenceIntervalCollectionEvents} instead.
  */
 export interface IIntervalCollectionEvent<TInterval extends ISerializableInterval>
 	extends IEvent {
@@ -1075,6 +1077,59 @@ export class IntervalCollection
 		return true;
 	}
 
+	public rollback(
+		op: IIntervalCollectionTypeOperationValue,
+		localOpMetadata: IMapMessageLocalMetadata,
+	) {
+		const { opName, value } = op;
+		const { id, properties } = getSerializedProperties(value);
+		const { localSeq, previous } = localOpMetadata;
+		switch (opName) {
+			case "add": {
+				const interval = this.getIntervalById(id);
+				if (interval) {
+					this.deleteExistingInterval({ interval, local: true, rollback: true });
+				}
+				break;
+			}
+			case "change": {
+				assert(previous !== undefined, 0xb7c /* must have previous for change */);
+
+				const endpointsChanged = value.start !== undefined && value.end !== undefined;
+				const start = endpointsChanged
+					? toOptionalSequencePlace(previous.start, previous.startSide)
+					: undefined;
+				const end = endpointsChanged
+					? toOptionalSequencePlace(previous.end, previous.endSide)
+					: undefined;
+				this.change(id, {
+					start,
+					end,
+					props: Object.keys(properties).length > 0 ? properties : undefined,
+					rollback: true,
+				});
+				this.localSeqToSerializedInterval.delete(localSeq);
+				if (endpointsChanged) {
+					this.removePendingChange(value);
+				}
+				break;
+			}
+			case "delete": {
+				assert(previous !== undefined, 0xb7d /* must have previous for delete */);
+				this.add({
+					id,
+					start: toSequencePlace(previous.start, previous.startSide),
+					end: toSequencePlace(previous.end, previous.endSide),
+					props: Object.keys(properties).length > 0 ? properties : undefined,
+					rollback: true,
+				});
+				break;
+			}
+			default:
+				unreachableCase(opName);
+		}
+	}
+
 	public process(
 		op: IIntervalCollectionTypeOperationValue,
 		local: boolean,
@@ -1339,11 +1394,13 @@ export class IntervalCollection
 		start,
 		end,
 		props,
+		rollback,
 	}: {
 		id?: string;
 		start: SequencePlace;
 		end: SequencePlace;
 		props?: PropertySet;
+		rollback?: boolean;
 	}): SequenceIntervalClass {
 		if (!this.localCollection) {
 			throw new LoggingError("attach must be called prior to adding intervals");
@@ -1366,6 +1423,8 @@ export class IntervalCollection
 			toSequencePlace(startPos, startSide),
 			toSequencePlace(endPos, endSide),
 			props,
+			undefined,
+			rollback,
 		);
 
 		if (interval) {
@@ -1375,19 +1434,19 @@ export class IntervalCollection
 			}
 			const serializedInterval: ISerializedInterval = interval.serialize();
 			const localSeq = this.getNextLocalSeq();
-			if (this.isCollaborating) {
+			if (this.isCollaborating && rollback !== true) {
 				this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
-			}
 
-			this.submitDelta(
-				{
-					opName: "add",
-					value: serializedInterval,
-				},
-				{
-					localSeq,
-				},
-			);
+				this.submitDelta(
+					{
+						opName: "add",
+						value: serializedInterval,
+					},
+					{
+						localSeq,
+					},
+				);
+			}
 		}
 
 		this.emit("addInterval", interval, true, undefined);
@@ -1395,11 +1454,17 @@ export class IntervalCollection
 		return interval;
 	}
 
-	private deleteExistingInterval(
-		interval: SequenceIntervalClass,
-		local: boolean,
-		op?: ISequencedDocumentMessage,
-	) {
+	private deleteExistingInterval({
+		interval,
+		local,
+		op,
+		rollback,
+	}: {
+		interval: SequenceIntervalClass;
+		local: boolean;
+		op?: ISequencedDocumentMessage;
+		rollback?: boolean;
+	}) {
 		if (!this.localCollection) {
 			throw new LoggingError("Attach must be called before accessing intervals");
 		}
@@ -1408,7 +1473,7 @@ export class IntervalCollection
 
 		if (interval) {
 			// Local ops get submitted to the server. Remote ops have the deserializer run.
-			if (local) {
+			if (local && rollback !== true) {
 				this.submitDelta(
 					{
 						opName: "delete",
@@ -1416,6 +1481,7 @@ export class IntervalCollection
 					},
 					{
 						localSeq: this.getNextLocalSeq(),
+						previous: interval.serialize(),
 					},
 				);
 			} else {
@@ -1437,7 +1503,7 @@ export class IntervalCollection
 		}
 		const interval = this.localCollection.idIntervalIndex.getIntervalById(id);
 		if (interval) {
-			this.deleteExistingInterval(interval, true, undefined);
+			this.deleteExistingInterval({ interval, local: true });
 		}
 		return interval;
 	}
@@ -1446,7 +1512,12 @@ export class IntervalCollection
 	 */
 	public change(
 		id: string,
-		{ start, end, props }: { start?: SequencePlace; end?: SequencePlace; props?: PropertySet },
+		{
+			start,
+			end,
+			props,
+			rollback,
+		}: { start?: SequencePlace; end?: SequencePlace; props?: PropertySet; rollback?: boolean },
 	): SequenceIntervalClass | undefined {
 		if (!this.localCollection) {
 			throw new LoggingError("Attach must be called before accessing intervals");
@@ -1477,7 +1548,7 @@ export class IntervalCollection
 			let deltaProps: PropertySet | undefined;
 			let newInterval: SequenceIntervalClass | undefined;
 			if (props !== undefined) {
-				deltaProps = interval.changeProperties(props);
+				deltaProps = interval.changeProperties(props, undefined, rollback);
 			}
 			const changeEndpoints = start !== undefined && end !== undefined;
 			if (changeEndpoints) {
@@ -1487,28 +1558,28 @@ export class IntervalCollection
 					setSlideOnRemove(newInterval.end);
 				}
 			}
-			// Emit a property bag containing the ID and the other (if any) properties changed
-			const serializedInterval: SerializedIntervalDelta = (
-				newInterval ?? interval
-			).serializeDelta({
-				props,
-				includeEndpoints: changeEndpoints,
-			});
 
-			const localSeq = this.getNextLocalSeq();
-			if (this.isCollaborating) {
+			if (this.isCollaborating && rollback !== true) {
+				// Emit a property bag containing the ID and the other (if any) properties changed
+				const serializedInterval: SerializedIntervalDelta = (
+					newInterval ?? interval
+				).serializeDelta({ props, includeEndpoints: changeEndpoints });
+				const localSeq = this.getNextLocalSeq();
+
 				this.localSeqToSerializedInterval.set(localSeq, serializedInterval);
-			}
+				this.addPendingChange(id, serializedInterval);
 
-			this.submitDelta(
-				{
-					opName: "change",
-					value: serializedInterval,
-				},
-				{
-					localSeq,
-				},
-			);
+				this.submitDelta(
+					{
+						opName: "change",
+						value: serializedInterval,
+					},
+					{
+						localSeq,
+						previous: interval.serialize(),
+					},
+				);
+			}
 			if (deltaProps !== undefined) {
 				this.emit("propertyChanged", interval, deltaProps, true, undefined);
 				this.emit(
@@ -1521,7 +1592,6 @@ export class IntervalCollection
 				);
 			}
 			if (newInterval) {
-				this.addPendingChange(id, serializedInterval);
 				this.emitChange(newInterval, interval, true, false);
 				this.client?.removeLocalReferencePosition(interval.start);
 				this.client?.removeLocalReferencePosition(interval.end);
@@ -1955,7 +2025,7 @@ export class IntervalCollection
 		const { id } = getSerializedProperties(serializedInterval);
 		const interval = this.localCollection.idIntervalIndex.getIntervalById(id);
 		if (interval) {
-			this.deleteExistingInterval(interval, local, op);
+			this.deleteExistingInterval({ interval, local, op });
 		}
 	}
 

package/src/intervalCollectionMap.ts

@@ -206,6 +206,19 @@ export class IntervalCollectionMap {
 		return false;
 	}
 
+	public tryRollback(content: any, localOpMetadata: unknown) {
+		if (isMapOperation(content)) {
+			const localValue = this.data.get(content.key);
+
+			assert(localValue !== undefined, 0xb7e /* Local value expected on rollback */);
+
+			localValue.rollback(content.value, localOpMetadata as IMapMessageLocalMetadata);
+
+			return true;
+		}
+		return false;
+	}
+
 	public tryApplyStashedOp(content: unknown): boolean {
 		if (isMapOperation(content)) {
 			const { value, key } = content;

package/src/intervalCollectionMapInterfaces.ts

@@ -19,6 +19,7 @@ import {
 
 export interface IMapMessageLocalMetadata {
 	localSeq: number;
+	previous?: ISerializedInterval;
 }
 
 /**

package/src/intervalIndex/intervalIndex.ts

@@ -16,7 +16,7 @@ import { ISerializableInterval, type SequenceInterval } from "../intervals/index
  * @legacy
  * @alpha
  *
- * @remarks The generic version of this interface is no longer used and will be removed. Use {@link SequenceIntervalIndex} instead.
+ * @deprecated The generic version of this interface is no longer used and will be removed. Use {@link SequenceIntervalIndex} instead.
  */
 export interface IntervalIndex<TInterval extends ISerializableInterval> {
 	/**

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -26,7 +26,7 @@ import { IntervalIndex, type SequenceIntervalIndex } from "./intervalIndex.js";
  * Use {@link ISequenceOverlappingIntervalsIndex} instead.
  * @legacy
  * @alpha
- * @remarks The generic version of this interface is no longer used and will be removed. Use {@link ISequenceOverlappingIntervalsIndex} instead.
+ * @deprecated The generic version of this interface is no longer used and will be removed. Use {@link ISequenceOverlappingIntervalsIndex} instead.
  */
 export interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval>
 	extends IntervalIndex<TInterval> {

package/src/intervals/sequenceInterval.ts

@@ -219,7 +219,11 @@ export class SequenceIntervalClass implements SequenceInterval {
 		return this.#props.properties;
 	}
 
-	public changeProperties(props: PropertySet | undefined, op?: ISequencedDocumentMessage) {
+	public changeProperties(
+		props: PropertySet | undefined,
+		op?: ISequencedDocumentMessage,
+		rollback?: boolean,
+	) {
 		if (props !== undefined) {
 			this.#props.propertyManager ??= new PropertiesManager();
 			return this.#props.propertyManager.handleProperties(
@@ -230,6 +234,7 @@ export class SequenceIntervalClass implements SequenceInterval {
 					: UniversalSequenceNumber,
 				op?.minimumSequenceNumber ?? UniversalSequenceNumber,
 				this.client.getCollabWindow().collaborating,
+				rollback,
 			);
 		}
 	}
@@ -573,6 +578,7 @@ export function createPositionReferenceFromSegoff(
 	fromSnapshot?: boolean,
 	slidingPreference?: SlidingPreference,
 	canSlideToEndpoint?: boolean,
+	rollback?: boolean,
 ): LocalReferencePosition {
 	if (segoff === "start" || segoff === "end") {
 		return client.createLocalReferencePosition(
@@ -606,7 +612,8 @@ export function createPositionReferenceFromSegoff(
 		!op &&
 		!localSeq &&
 		!fromSnapshot &&
-		!refTypeIncludesFlag(refType, ReferenceType.Transient)
+		!refTypeIncludesFlag(refType, ReferenceType.Transient) &&
+		!rollback
 	) {
 		throw new UsageError("Non-transient references need segment");
 	}
@@ -624,6 +631,7 @@ function createPositionReference(
 	slidingPreference?: SlidingPreference,
 	exclusive: boolean = false,
 	useNewSlidingBehavior: boolean = false,
+	rollback?: boolean,
 ): LocalReferencePosition {
 	let segoff;
 
@@ -661,6 +669,7 @@ function createPositionReference(
 		fromSnapshot,
 		slidingPreference,
 		exclusive,
+		rollback,
 	);
 }
 
@@ -690,6 +699,7 @@ export function createSequenceInterval(
 	fromSnapshot?: boolean,
 	useNewSlidingBehavior: boolean = false,
 	props?: PropertySet,
+	rollback?: boolean,
 ): SequenceIntervalClass {
 	const { startPos, startSide, endPos, endSide } = endpointPosAndSide(
 		start ?? "start",
@@ -731,6 +741,7 @@ export function createSequenceInterval(
 		startReferenceSlidingPreference(stickiness),
 		startReferenceSlidingPreference(stickiness) === SlidingPreference.BACKWARD,
 		useNewSlidingBehavior,
+		rollback,
 	);
 
 	const endLref = createPositionReference(
@@ -743,6 +754,7 @@ export function createSequenceInterval(
 		endReferenceSlidingPreference(stickiness),
 		endReferenceSlidingPreference(stickiness) === SlidingPreference.FORWARD,
 		useNewSlidingBehavior,
+		rollback,
 	);
 
 	const rangeProp = {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.33.0-333010";
+export const pkgVersion = "2.33.0";

package/src/sequence.ts

@@ -796,6 +796,21 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		});
 	}
 
+	/**
+	 * Revert an op
+	 */
+	protected rollback(content: any, localOpMetadata: unknown): void {
+		const originalRefSeq = this.inFlightRefSeqs.pop();
+		assert(
+			originalRefSeq !== undefined,
+			0xb7f /* Expected a recorded refSeq when rolling back an op  */,
+		);
+
+		if (!this.intervalCollections.tryRollback(content, localOpMetadata)) {
+			this.client.rollback(content, localOpMetadata);
+		}
+	}
+
 	/**
 	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
 	 */

package/src/sharedIntervalCollection.ts

@@ -10,7 +10,7 @@ import { ISerializableInterval } from "./intervals/index.js";
 /**
  * @legacy
  * @alpha
- * @remarks This interface is no longer used and will be removed.
+ * @deprecated This interface is no longer used and will be removed.
  */
 export interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {
 	// eslint-disable-next-line import/no-deprecated

package/src/sharedString.ts

@@ -271,17 +271,6 @@ export class SharedStringClass
 	public getMarkerFromId(id: string): ISegment | undefined {
 		return this.client.getMarkerFromId(id);
 	}
-
-	/**
-	 * Revert an op
-	 */
-	protected rollback(content: any, localOpMetadata: unknown): void {
-		if (this.client.rollback !== undefined) {
-			this.client.rollback(content, localOpMetadata);
-		} else {
-			super.rollback(content, localOpMetadata);
-		}
-	}
 }
 
 interface ITextAndMarkerAccumulator {