@fluidframework/sequence 2.0.0-dev-rc.3.0.0.254866 → 2.0.0-dev-rc.5.0.0.263932

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -16,7 +16,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 
@@ -182,7 +182,7 @@ export class OverlappingIntervalsIndex<TInterval extends ISerializableInterval>
  * @alpha
  */
 export function createOverlappingIntervalsIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): IOverlappingIntervalsIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new OverlappingIntervalsIndex<SequenceInterval>(client, sequenceIntervalHelpers);

package/src/intervalIndex/overlappingSequenceIntervalsIndex.ts

@@ -19,7 +19,7 @@ import {
 	createPositionReferenceFromSegoff,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { OverlappingIntervalsIndex } from "./overlappingIntervalsIndex.js";
 import { SequenceIntervalIndexes } from "./sequenceIntervalIndexes.js";
@@ -76,7 +76,7 @@ class OverlappingSequenceIntervalsIndex
  * @internal
  */
 export function createOverlappingSequenceIntervalsIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): SequenceIntervalIndexes.Overlapping {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new OverlappingSequenceIntervalsIndex(client);

package/src/intervalIndex/startpointInRangeIndex.ts

@@ -14,7 +14,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 import { HasComparisonOverride, compareOverrideables, forceCompare } from "./intervalIndexUtils.js";
@@ -110,7 +110,7 @@ export class StartpointInRangeIndex<TInterval extends ISerializableInterval>
  * @internal
  */
 export function createStartpointInRangeIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): IStartpointInRangeIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new StartpointInRangeIndex<SequenceInterval>(client, sequenceIntervalHelpers);

package/src/intervals/interval.ts

@@ -89,7 +89,7 @@ export class Interval implements ISerializableInterval {
 			start: this.start,
 		};
 		if (this.properties) {
-			serializedInterval.properties = this.properties;
+			serializedInterval.properties = { ...this.properties };
 		}
 		return serializedInterval;
 	}

package/src/intervals/sequenceInterval.ts

@@ -198,7 +198,7 @@ export class SequenceInterval implements ISerializableInterval {
 		};
 
 		if (this.properties) {
-			serializedInterval.properties = this.properties;
+			serializedInterval.properties = { ...this.properties };
 		}
 
 		return serializedInterval;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.0-dev-rc.3.0.0.254866";
+export const pkgVersion = "2.0.0-dev-rc.5.0.0.263932";

package/src/revertibles.ts

@@ -26,7 +26,7 @@ import {
 import { InteriorSequencePlace, Side } from "./intervalCollection.js";
 import { IntervalOpType, SequenceInterval } from "./intervals/index.js";
 import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
-import { SharedString, SharedStringSegment } from "./sharedString.js";
+import { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
@@ -111,7 +111,7 @@ export function appendAddIntervalToRevertibles(
  * @alpha
  */
 export function appendDeleteIntervalToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	interval: SequenceInterval,
 	revertibles: SharedStringRevertible[],
 ): SharedStringRevertible[] {
@@ -163,7 +163,7 @@ export function appendDeleteIntervalToRevertibles(
  * @alpha
  */
 export function appendChangeIntervalToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	newInterval: SequenceInterval,
 	previousInterval: SequenceInterval,
 	revertibles: SharedStringRevertible[],
@@ -273,7 +273,7 @@ function addIfRevertibleRef(
  * @alpha
  */
 export function appendSharedStringDeltaToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	delta: SequenceDeltaEvent,
 	revertibles: SharedStringRevertible[],
 ) {
@@ -366,7 +366,7 @@ export function appendSharedStringDeltaToRevertibles(
  * @alpha
  */
 export function discardSharedStringRevertibles(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
 	revertibles.forEach((r) => {
@@ -379,7 +379,11 @@ export function discardSharedStringRevertibles(
 	});
 }
 
-function getSlidePosition(string: SharedString, lref: LocalReferencePosition, pos: number): number {
+function getSlidePosition(
+	string: ISharedString,
+	lref: LocalReferencePosition,
+	pos: number,
+): number {
 	const slide = getSlideToSegoff(
 		{ segment: lref.getSegment(), offset: undefined },
 		lref.slidingPreference,
@@ -397,7 +401,7 @@ function isValidRange(
 	startSlide: SlidingPreference | undefined,
 	end: number,
 	endSlide: SlidingPreference | undefined,
-	string: SharedString,
+	string: ISharedString,
 ) {
 	return (
 		start >= 0 &&
@@ -412,7 +416,7 @@ function isValidRange(
 }
 
 function revertLocalAdd(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.ADD>,
 ) {
 	const id = getUpdatedIdFromInterval(revertible.interval);
@@ -441,7 +445,7 @@ function createSequencePlace(
 }
 
 function revertLocalDelete(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.DELETE>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -480,7 +484,7 @@ function revertLocalDelete(
 }
 
 function revertLocalChange(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.CHANGE>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -520,7 +524,7 @@ function revertLocalChange(
 }
 
 function revertLocalPropertyChanged(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.PROPERTY_CHANGED>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -554,7 +558,7 @@ function newPosition(offset: number | undefined, restoredRanges: SortedRangeSet)
 function newEndpointPosition(
 	offset: number | undefined,
 	restoredRanges: SortedRangeSet,
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ) {
 	const pos = newPosition(offset, restoredRanges);
 	return pos === undefined ? undefined : sharedString.getPosition(pos.segment) + pos.offset;
@@ -573,7 +577,7 @@ class SortedRangeSet extends SortedSet<RangeInfo, string> {
 }
 
 function revertLocalSequenceRemove(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.POSITION_REMOVE>,
 ) {
 	const restoredRanges = new SortedRangeSet();
@@ -657,7 +661,7 @@ function revertLocalSequenceRemove(
  * @alpha
  */
 export function revertSharedStringRevertibles(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
 	while (revertibles.length > 0) {

package/src/sequence.ts

@@ -5,7 +5,7 @@
 
 import { bufferToString } from "@fluid-internal/client-utils";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
-import { assert, Deferred } from "@fluidframework/core-utils/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
 	IChannelAttributes,
 	IChannelStorageService,
@@ -17,7 +17,9 @@ import {
 	IJSONSegment,
 	IMergeTreeAnnotateMsg,
 	IMergeTreeDeltaOp,
+	// eslint-disable-next-line import/no-deprecated
 	IMergeTreeGroupMsg,
+	// eslint-disable-next-line import/no-deprecated
 	IMergeTreeObliterateMsg,
 	IMergeTreeOp,
 	IMergeTreeRemoveMsg,
@@ -30,9 +32,11 @@ import {
 	PropertySet,
 	ReferencePosition,
 	ReferenceType,
+	// eslint-disable-next-line import/no-deprecated
 	SegmentGroup,
 	SlidingPreference,
-	createAnnotateRangeOp, // eslint-disable-next-line import/no-deprecated
+	createAnnotateRangeOp,
+	// eslint-disable-next-line import/no-deprecated
 	createGroupOp,
 	createInsertOp,
 	createObliterateRangeOp,
@@ -113,8 +117,13 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
 	implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver
 {
+	/**
+	 * This promise is always immediately resolved, and awaiting it has no effect.
+	 * @deprecated SharedSegmentSequence no longer supports partial loading.
+	 * References to this promise may safely be deleted without affecting behavior.
+	 */
 	get loaded(): Promise<void> {
-		return this.loadedDeferred.promise;
+		return Promise.resolve();
 	}
 
 	/**
@@ -180,6 +189,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				}
 
 				case MergeTreeDeltaType.OBLITERATE: {
+					// eslint-disable-next-line import/no-deprecated
 					const lastRem = ops[ops.length - 1] as IMergeTreeObliterateMsg;
 					if (lastRem?.pos1 === r.position) {
 						assert(
@@ -235,24 +245,15 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * DDS submits over the wire. See `inFlightRefSeqs` for more details.
 	 */
 	private get currentRefSeq() {
-		return this.ongoingResubmitRefSeq ?? this.runtime.deltaManager.lastSequenceNumber;
+		return this.ongoingResubmitRefSeq ?? this.deltaManager.lastSequenceNumber;
 	}
 
 	// eslint-disable-next-line import/no-deprecated
 	protected client: Client;
-	/** `Deferred` that triggers once the object is loaded */
-	protected loadedDeferred = new Deferred<void>();
-	// cache out going ops created when partial loading
-	private readonly loadedDeferredOutgoingOps: [IMergeTreeOp, SegmentGroup | SegmentGroup[]][] =
-		[];
-	// cache incoming ops that arrive when partial loading
-	private deferIncomingOps = true;
-	private readonly loadedDeferredIncomingOps: ISequencedDocumentMessage[] = [];
-
 	private messagesSinceMSNChange: ISequencedDocumentMessage[] = [];
 	private readonly intervalCollections: IntervalCollectionMap<SequenceInterval>;
 	constructor(
-		private readonly dataStoreRuntime: IFluidDataStoreRuntime,
+		dataStoreRuntime: IFluidDataStoreRuntime,
 		public id: string,
 		attributes: IChannelAttributes,
 		public readonly segmentFromSpec: (spec: IJSONSegment) => ISegment,
@@ -273,10 +274,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 						}
 				  });
 
-		this.loadedDeferred.promise.catch((error) => {
-			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
-		});
-
 		// eslint-disable-next-line import/no-deprecated
 		this.client = new Client(
 			segmentFromSpec,
@@ -340,6 +337,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * release, as group ops are redundant with the native batching capabilities
 	 * of the runtime
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	public groupOperation(groupOp: IMergeTreeGroupMsg) {
 		this.guardReentrancy(() => this.client.localTransaction(groupOp));
 	}
@@ -474,14 +472,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			message.type === MergeTreeDeltaType.GROUP ? message.ops.length : 1,
 		);
 
-		// if loading isn't complete, we need to cache
-		// local ops until loading is complete, and then
-		// they will be present
-		if (!this.loadedDeferred.isCompleted) {
-			this.loadedDeferredOutgoingOps.push(metadata ? [message, metadata] : (message as any));
-		} else {
-			this.submitLocalMessage(message, metadata);
-		}
+		this.submitLocalMessage(message, metadata);
 	}
 
 	/**
@@ -654,6 +645,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.submitSequenceMessage(
 					this.client.regeneratePendingOp(
 						content as IMergeTreeOp,
+						// eslint-disable-next-line import/no-deprecated
 						localOpMetadata as SegmentGroup | SegmentGroup[],
 					),
 				);
@@ -681,47 +673,38 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.serializer,
 			);
 
-			// setup a promise to process the
-			// catch up ops, and finishing the loading process
-			const loadCatchUpOps = catchupOpsP
-				.then((msgs) => {
-					msgs.forEach((m) => {
-						const collabWindow = this.client.getCollabWindow();
-						if (
-							m.minimumSequenceNumber < collabWindow.minSeq ||
-							m.referenceSequenceNumber < collabWindow.minSeq ||
-							m.sequenceNumber <= collabWindow.minSeq ||
-							// sequenceNumber could be the same if messages are part of a grouped batch
-							m.sequenceNumber < collabWindow.currentSeq
-						) {
-							throw new Error(
-								`Invalid catchup operations in snapshot: ${JSON.stringify({
-									op: {
-										seq: m.sequenceNumber,
-										minSeq: m.minimumSequenceNumber,
-										refSeq: m.referenceSequenceNumber,
-									},
-									collabWindow: {
-										seq: collabWindow.currentSeq,
-										minSeq: collabWindow.minSeq,
-									},
-								})}`,
-							);
-						}
-						this.processMergeTreeMsg(m);
-					});
-					this.loadFinished();
-				})
-				.catch((error) => {
-					this.loadFinished(error);
-				});
-			if (this.dataStoreRuntime.options.sequenceInitializeFromHeaderOnly !== true) {
-				// if we not doing partial load, await the catch up ops,
-				// and the finalization of the load
-				await loadCatchUpOps;
-			}
+			// process the catch up ops, and finishing the loading process
+			(await catchupOpsP).forEach((m) => {
+				const collabWindow = this.client.getCollabWindow();
+				if (
+					m.minimumSequenceNumber < collabWindow.minSeq ||
+					m.referenceSequenceNumber < collabWindow.minSeq ||
+					m.sequenceNumber <= collabWindow.minSeq ||
+					// sequenceNumber could be the same if messages are part of a grouped batch
+					m.sequenceNumber < collabWindow.currentSeq
+				) {
+					throw new Error(
+						`Invalid catchup operations in snapshot: ${JSON.stringify({
+							op: {
+								seq: m.sequenceNumber,
+								minSeq: m.minimumSequenceNumber,
+								refSeq: m.referenceSequenceNumber,
+							},
+							collabWindow: {
+								seq: collabWindow.currentSeq,
+								minSeq: collabWindow.minSeq,
+							},
+						})}`,
+					);
+				}
+				this.processMergeTreeMsg(m);
+			});
+
+			// Initialize the interval collections
+			this.initializeIntervalCollections();
 		} catch (error) {
-			this.loadFinished(error);
+			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
+			throw error;
 		}
 	}
 
@@ -745,27 +728,20 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			// assert(recordedRefSeq <= message.referenceSequenceNumber, "RefSeq mismatch");
 		}
 
-		// if loading isn't complete, we need to cache all
-		// incoming ops to be applied after loading is complete
-		if (this.deferIncomingOps) {
-			assert(!local, 0x072 /* "Unexpected local op when loading not finished" */);
-			this.loadedDeferredIncomingOps.push(message);
-		} else {
-			assert(
-				message.type === MessageType.Operation,
-				0x073 /* "Sequence message not operation" */,
-			);
+		assert(
+			message.type === MessageType.Operation,
+			0x073 /* "Sequence message not operation" */,
+		);
 
-			const handled = this.intervalCollections.tryProcessMessage(
-				message.contents as IMapOperation,
-				local,
-				message,
-				localOpMetadata,
-			);
+		const handled = this.intervalCollections.tryProcessMessage(
+			message.contents as IMapOperation,
+			local,
+			message,
+			localOpMetadata,
+		);
 
-			if (!handled) {
-				this.processMergeTreeMsg(message, local);
-			}
+		if (!handled) {
+			this.processMergeTreeMsg(message, local);
 		}
 	}
 
@@ -785,7 +761,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 */
 	protected initializeLocalCore() {
 		super.initializeLocalCore();
-		this.loadFinished();
+		this.initializeIntervalCollections();
 	}
 
 	/**
@@ -798,12 +774,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	private summarizeMergeTree(serializer: IFluidSerializer): ISummaryTreeWithStats {
-		// Are we fully loaded? If not, things will go south
-		assert(
-			this.loadedDeferred.isCompleted,
-			0x074 /* "Snapshot called when not fully loaded" */,
-		);
-		const minSeq = this.runtime.deltaManager.minimumSequenceNumber;
+		const minSeq = this.deltaManager.minimumSequenceNumber;
 
 		this.processMinSequenceNumberChanged(minSeq);
 
@@ -875,35 +846,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		}
 	}
 
-	private loadFinished(error?: any) {
-		if (!this.loadedDeferred.isCompleted) {
-			// Initialize the interval collections
-			this.initializeIntervalCollections();
-			if (error) {
-				this.loadedDeferred.reject(error);
-				throw error;
-			} else {
-				// it is important this series remains synchronous
-				// first we stop deferring incoming ops, and apply then all
-				this.deferIncomingOps = false;
-				for (const message of this.loadedDeferredIncomingOps) {
-					this.processCore(message, false, undefined);
-				}
-				this.loadedDeferredIncomingOps.length = 0;
-
-				// then resolve the loaded promise
-				// and resubmit all the outstanding ops, as the snapshot
-				// is fully loaded, and all outstanding ops are applied
-				this.loadedDeferred.resolve();
-
-				for (const [messageContent, opMetadata] of this.loadedDeferredOutgoingOps) {
-					this.reSubmitCore(messageContent, opMetadata);
-				}
-				this.loadedDeferredOutgoingOps.length = 0;
-			}
-		}
-	}
-
 	private initializeIntervalCollections() {
 		// Listen and initialize new SharedIntervalCollections
 		this.intervalCollections.eventEmitter.on(

package/src/sequenceDeltaEvent.ts

@@ -36,6 +36,9 @@ export abstract class SequenceEvent<
 	private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;
 
 	constructor(
+		/**
+		 * Arguments reflecting the type of change that caused this event.
+		 */
 		public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,
 		// eslint-disable-next-line import/no-deprecated
 		private readonly mergeTreeClient: Client,
@@ -73,7 +76,10 @@ export abstract class SequenceEvent<
 
 	/**
 	 * The in-order ranges affected by this delta.
-	 * These may not be continuous.
+	 * These are not necessarily contiguous.
+	 *
+	 * @remarks - If processing code doesn't care about the order of the ranges, it may instead consider using the
+	 * {@link @fluidframework/merge-tree#IMergeTreeDeltaCallbackArgs.deltaSegments|deltaSegments} field on {@link SequenceEvent.deltaArgs|deltaArgs}.
 	 */
 	public get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[] {
 		return this.sortedRanges.value.items;
@@ -140,6 +146,11 @@ export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationTyp
  */
 export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
 	constructor(
+		/**
+		 * Defined iff `deltaArgs.operation` is {@link @fluidframework/merge-tree#MergeTreeMaintenanceType.ACKNOWLEDGED|MergeTreeMaintenanceType.ACKNOWLEDGED}.
+		 *
+		 * In that case, this argument provides information about the change which was acknowledged.
+		 */
 		public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,
 		deltaArgs: IMergeTreeMaintenanceCallbackArgs,
 		// eslint-disable-next-line import/no-deprecated

package/src/sequenceFactory.ts

@@ -10,14 +10,13 @@ import {
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
 import { Marker, TextSegment } from "@fluidframework/merge-tree/internal";
+import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { pkgVersion } from "./packageVersion.js";
-import { SharedString, SharedStringSegment } from "./sharedString.js";
+import { SharedStringClass, SharedStringSegment, type ISharedString } from "./sharedString.js";
 
-/**
- * @alpha
- */
-export class SharedStringFactory implements IChannelFactory {
+export class SharedStringFactory implements IChannelFactory<ISharedString> {
 	// TODO rename back to https://graph.microsoft.com/types/mergeTree/string once paparazzi is able to dynamically
 	// load code (UPDATE: paparazzi is gone... anything to do here?)
 	public static Type = "https://graph.microsoft.com/types/mergeTree";
@@ -58,8 +57,8 @@ export class SharedStringFactory implements IChannelFactory {
 		id: string,
 		services: IChannelServices,
 		attributes: IChannelAttributes,
-	): Promise<SharedString> {
-		const sharedString = new SharedString(runtime, id, attributes);
+	): Promise<SharedStringClass> {
+		const sharedString = new SharedStringClass(runtime, id, attributes);
 		await sharedString.load(services);
 		return sharedString;
 	}
@@ -67,9 +66,22 @@ export class SharedStringFactory implements IChannelFactory {
 	/**
 	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
 	 */
-	public create(document: IFluidDataStoreRuntime, id: string): SharedString {
-		const sharedString = new SharedString(document, id, this.attributes);
+	public create(document: IFluidDataStoreRuntime, id: string): SharedStringClass {
+		const sharedString = new SharedStringClass(document, id, this.attributes);
 		sharedString.initializeLocal();
 		return sharedString;
 	}
 }
+
+/**
+ * Entrypoint for {@link ISharedString} creation.
+ * @alpha
+ */
+export const SharedString: ISharedObjectKind<ISharedString> =
+	createSharedObjectKind(SharedStringFactory);
+
+/**
+ * Alias for {@link ISharedString} for compatibility.
+ * @alpha
+ */
+export type SharedString = ISharedString;