@fluidframework/sequence 2.91.0 → 2.93.0

package/src/revertibles.ts

@@ -6,12 +6,15 @@
 /* eslint-disable no-bitwise */
 
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	LocalReferencePosition,
 	MergeTreeDeltaOperationType,
 	MergeTreeDeltaRevertible,
-	MergeTreeDeltaType,
 	PropertySet,
+	InteriorSequencePlace,
+} from "@fluidframework/merge-tree/internal";
+import {
+	MergeTreeDeltaType,
 	ReferenceType,
 	SlidingPreference,
 	appendToMergeTreeDeltaRevertibles,
@@ -20,7 +23,6 @@ import {
 	isMergeTreeDeltaRevertible,
 	refTypeIncludesFlag,
 	revertMergeTreeDeltaRevertibles,
-	InteriorSequencePlace,
 	Side,
 	type ISegmentInternal,
 	segmentIsRemoved,
@@ -28,9 +30,10 @@ import {
 	type ISegment,
 } from "@fluidframework/merge-tree/internal";
 
-import { IntervalOpType, SequenceInterval, SequenceIntervalClass } from "./intervals/index.js";
-import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
-import { ISharedString, SharedStringSegment } from "./sharedString.js";
+import type { SequenceInterval } from "./intervals/index.js";
+import { IntervalOpType, SequenceIntervalClass } from "./intervals/index.js";
+import type { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
+import type { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
@@ -321,7 +324,7 @@ export function appendSharedStringDeltaToRevertibles(
 			};
 
 			// add an interval for each startInterval, accounting for any corresponding endIntervals
-			startIntervals.forEach(({ interval, offset }) => {
+			for (const { interval, offset } of startIntervals) {
 				// find any corresponding end for this interval
 				const endIntervalIndex = endIntervals.findIndex((end) => {
 					return end.interval === interval;
@@ -338,16 +341,16 @@ export function appendSharedStringDeltaToRevertibles(
 					startOffset: offset,
 					endOffset,
 				});
-			});
+			}
 
 			// add any remaining endIntervals that aren't matched with a startInterval
-			endIntervals.forEach(({ interval, offset }) => {
+			for (const { interval, offset } of endIntervals) {
 				revertible.intervals.push({
 					intervalId: interval.getIntervalId(),
 					label: interval.start.properties?.referenceRangeLabels[0],
 					endOffset: offset,
 				});
-			});
+			}
 
 			revertibles.push(revertible);
 			return;
@@ -375,14 +378,14 @@ export function discardSharedStringRevertibles(
 	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
-	revertibles.forEach((r) => {
+	for (const r of revertibles) {
 		if (isMergeTreeDeltaRevertible(r)) {
 			discardMergeTreeDeltaRevertible([r]);
 		} else if (r.event === IntervalOpType.CHANGE || r.event === IntervalOpType.DELETE) {
 			sharedString.removeLocalReferencePosition(r.start);
 			sharedString.removeLocalReferencePosition(r.end);
 		}
-	});
+	}
 }
 
 function getSlidePosition(
@@ -478,11 +481,11 @@ function revertLocalDelete(
 			props,
 		});
 
-		idMap.forEach((newId, oldId) => {
+		for (const [oldId, newId] of idMap.entries()) {
 			if (intervalId === newId) {
 				idMap.set(oldId, getUpdatedIdFromInterval(int));
 			}
-		});
+		}
 		idMap.set(intervalId, int.getIntervalId());
 	}
 
@@ -587,9 +590,9 @@ function revertLocalSequenceRemove(
 	const saveSegments = (event: SequenceDeltaEvent) => {
 		if (event.ranges.length > 0) {
 			let length = 0;
-			event.ranges.forEach((range) => {
+			for (const range of event.ranges) {
 				length += range.segment.cachedLength;
-			});
+			}
 			restoredRanges.addOrUpdate({
 				ranges: event.ranges,
 				length,
@@ -601,7 +604,7 @@ function revertLocalSequenceRemove(
 	revertMergeTreeDeltaRevertibles(sharedString, [revertible.mergeTreeRevertible]);
 	sharedString.off("sequenceDelta", saveSegments);
 
-	revertible.intervals.forEach((intervalInfo) => {
+	for (const intervalInfo of revertible.intervals) {
 		const intervalCollection = sharedString.getIntervalCollection(intervalInfo.label);
 		const intervalId = getUpdatedId(intervalInfo.intervalId);
 		const interval = intervalCollection.getIntervalById(intervalId);
@@ -627,10 +630,10 @@ function revertLocalSequenceRemove(
 				});
 			}
 		}
-	});
+	}
 
 	// fix up the local references used by delete and change revertibles
-	revertible.revertibleRefs.forEach((revertibleRef) => {
+	for (const revertibleRef of revertible.revertibleRefs) {
 		assert(
 			revertibleRef.revertible.event === IntervalOpType.CHANGE ||
 				revertibleRef.revertible.event === IntervalOpType.DELETE,
@@ -660,7 +663,7 @@ function revertLocalSequenceRemove(
 				revertibleRef.revertible.end = newRef;
 			}
 		}
-	});
+	}
 }
 
 /**
@@ -677,23 +680,29 @@ export function revertSharedStringRevertibles(
 		if ("event" in r) {
 			const event = r.event;
 			switch (event) {
-				case IntervalOpType.ADD:
+				case IntervalOpType.ADD: {
 					revertLocalAdd(sharedString, r);
 					break;
-				case IntervalOpType.DELETE:
+				}
+				case IntervalOpType.DELETE: {
 					revertLocalDelete(sharedString, r);
 					break;
-				case IntervalOpType.CHANGE:
+				}
+				case IntervalOpType.CHANGE: {
 					revertLocalChange(sharedString, r);
 					break;
-				case IntervalOpType.PROPERTY_CHANGED:
+				}
+				case IntervalOpType.PROPERTY_CHANGED: {
 					revertLocalPropertyChanged(sharedString, r);
 					break;
-				case IntervalOpType.POSITION_REMOVE:
+				}
+				case IntervalOpType.POSITION_REMOVE: {
 					revertLocalSequenceRemove(sharedString, r);
 					break;
-				default:
+				}
+				default: {
 					unreachableCase(event);
+				}
 			}
 		} else {
 			revertMergeTreeDeltaRevertibles(sharedString, [r]);

package/src/sequence.ts

@@ -4,19 +4,16 @@
  */
 
 import { bufferToString } from "@fluid-internal/client-utils";
-import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
+import type { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	IChannelAttributes,
 	IFluidDataStoreRuntime,
 	IChannelStorageService,
 } from "@fluidframework/datastore-definitions/internal";
-import {
-	MessageType,
-	ISequencedDocumentMessage,
-} from "@fluidframework/driver-definitions/internal";
-import {
-	Client,
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import { MessageType } from "@fluidframework/driver-definitions/internal";
+import type {
 	IJSONSegment,
 	IMergeTreeAnnotateMsg,
 	IMergeTreeDeltaOp,
@@ -30,12 +27,15 @@ import {
 	ISegment,
 	ISegmentAction,
 	LocalReferencePosition,
-	MergeTreeDeltaType,
 	MergeTreeRevertibleDriver,
 	PropertySet,
 	ReferencePosition,
 	ReferenceType,
 	SlidingPreference,
+} from "@fluidframework/merge-tree/internal";
+import {
+	Client,
+	MergeTreeDeltaType,
 	createAnnotateRangeOp,
 	createGroupOp,
 	createInsertOp,
@@ -46,7 +46,7 @@ import {
 	type InteriorSequencePlace,
 	type MapLike,
 } from "@fluidframework/merge-tree/internal";
-import {
+import type {
 	ISummaryTreeWithStats,
 	ITelemetryContext,
 	IRuntimeMessageCollection,
@@ -57,12 +57,12 @@ import {
 	ObjectStoragePartition,
 	SummaryTreeBuilder,
 } from "@fluidframework/runtime-utils/internal";
-import {
+import type {
 	IFluidSerializer,
+	ISharedObject,
 	ISharedObjectEvents,
-	SharedObject,
-	type ISharedObject,
 } from "@fluidframework/shared-object-base/internal";
+import { SharedObject } from "@fluidframework/shared-object-base/internal";
 import {
 	LoggingError,
 	createChildLogger,
@@ -72,12 +72,12 @@ import {
 import Deque from "double-ended-queue";
 
 import type { ISequenceIntervalCollection } from "./intervalCollection.js";
-import { IMapOperation, IntervalCollectionMap } from "./intervalCollectionMap.js";
+import type { IMapOperation } from "./intervalCollectionMap.js";
+import { IntervalCollectionMap } from "./intervalCollectionMap.js";
 import type { SequenceOptions } from "./intervalCollectionMapInterfaces.js";
+import type { SequenceDeltaEvent, SequenceMaintenanceEvent } from "./sequenceDeltaEvent.js";
 import {
-	SequenceDeltaEvent,
 	SequenceDeltaEventClass,
-	SequenceMaintenanceEvent,
 	SequenceMaintenanceEventClass,
 } from "./sequenceDeltaEvent.js";
 
@@ -416,9 +416,10 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 					break;
 				}
 
-				case MergeTreeDeltaType.INSERT:
+				case MergeTreeDeltaType.INSERT: {
 					ops.push(createInsertOp(r.position, r.segment.clone().toJSONObject()));
 					break;
+				}
 
 				case MergeTreeDeltaType.REMOVE: {
 					const lastRem = ops[ops.length - 1] as IMergeTreeRemoveMsg;
@@ -831,7 +832,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			);
 
 			// process the catch up ops, and finishing the loading process
-			(await catchupOpsP).forEach((m) => {
+			for (const m of await catchupOpsP) {
 				const collabWindow = this.client.getCollabWindow();
 				if (
 					m.minimumSequenceNumber < collabWindow.minSeq ||
@@ -855,7 +856,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 					);
 				}
 				this.processMergeTreeMsg(m);
-			});
+			}
 
 			// Initialize the interval collections
 			this.initializeIntervalCollections();
@@ -946,9 +947,9 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
 		this.processMinSequenceNumberChanged(minSeq);
 
-		this.messagesSinceMSNChange.forEach((m) => {
+		for (const m of this.messagesSinceMSNChange) {
 			m.minimumSequenceNumber = minSeq;
-		});
+		}
 
 		return this.client.summarize(
 			this.runtime,
@@ -970,10 +971,8 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		}
 		const needsTransformation = message.referenceSequenceNumber !== message.sequenceNumber - 1;
 		let stashMessage: Readonly<ISequencedDocumentMessage> = message;
-		if (this.runtime.options.newMergeTreeSnapshotFormat !== true) {
-			if (needsTransformation) {
-				this.on("sequenceDelta", transformOps);
-			}
+		if (this.runtime.options.newMergeTreeSnapshotFormat !== true && needsTransformation) {
+			this.on("sequenceDelta", transformOps);
 		}
 
 		this.client.applyMsg(message, local);
@@ -986,7 +985,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				stashMessage = {
 					...message,
 					referenceSequenceNumber: stashMessage.sequenceNumber - 1,
-					contents: ops.length !== 1 ? createGroupOp(...ops) : ops[0],
+					contents: ops.length === 1 ? ops[0] : createGroupOp(...ops),
 				};
 			}
 

package/src/sequenceDeltaEvent.ts

@@ -4,7 +4,7 @@
  */
 
 import { assert, Lazy } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	Client,
 	IMergeTreeDeltaCallbackArgs,
 	IMergeTreeDeltaOpArgs,
@@ -12,9 +12,11 @@ import {
 	ISegment,
 	MergeTreeDeltaOperationType,
 	MergeTreeDeltaOperationTypes,
+	PropertySet,
+} from "@fluidframework/merge-tree/internal";
+import {
 	MergeTreeDeltaType,
 	MergeTreeMaintenanceType,
-	PropertySet,
 	SortedSegmentSet,
 } from "@fluidframework/merge-tree/internal";
 
@@ -88,7 +90,7 @@ export abstract class SequenceEventClass<
 
 		this.sortedRanges = new Lazy<SortedSegmentSet<ISequenceDeltaRange<TOperation>>>(() => {
 			const set = new SortedSegmentSet<ISequenceDeltaRange<TOperation>>();
-			this.deltaArgs.deltaSegments.forEach((delta) => {
+			for (const delta of this.deltaArgs.deltaSegments) {
 				const newRange: ISequenceDeltaRange<TOperation> = {
 					operation: this.deltaArgs.operation,
 					position: this.mergeTreeClient.getPosition(delta.segment),
@@ -96,7 +98,7 @@ export abstract class SequenceEventClass<
 					segment: delta.segment,
 				};
 				set.addOrUpdate(newRange);
-			});
+			}
 			return set;
 		});
 

package/src/sequenceFactory.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IChannelAttributes,
 	IChannelFactory,
 	IFluidDataStoreRuntime,
@@ -13,11 +13,13 @@ import { Marker, TextSegment } from "@fluidframework/merge-tree/internal";
 import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { pkgVersion } from "./packageVersion.js";
-import { SharedStringClass, SharedStringSegment, type ISharedString } from "./sharedString.js";
+import type { ISharedString, SharedStringSegment } from "./sharedString.js";
+import { SharedStringClass } from "./sharedString.js";
 
 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?)
+	// New type string, to be activated once the migration has been fully shipped dark and is safe to flip.
+	// See LegacyTypeAwareRegistry in packages/runtime/datastore/src/dataStoreRuntime.ts.
+	// public static Type = "mergeTree";
 	public static Type = "https://graph.microsoft.com/types/mergeTree";
 
 	public static readonly Attributes: IChannelAttributes = {

package/src/sharedSequence.ts

@@ -4,17 +4,13 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	IChannelAttributes,
 	IFluidDataStoreRuntime,
 	Serializable,
 } from "@fluidframework/datastore-definitions/internal";
-import {
-	BaseSegment,
-	IJSONSegment,
-	ISegment,
-	PropertySet,
-} from "@fluidframework/merge-tree/internal";
+import type { IJSONSegment, ISegment, PropertySet } from "@fluidframework/merge-tree/internal";
+import { BaseSegment } from "@fluidframework/merge-tree/internal";
 
 import { SharedSegmentSequence } from "./sequence.js";
 

package/src/sharedString.ts

@@ -3,21 +3,19 @@
  * Licensed under the MIT License.
  */
 
-import {
+import type {
 	IChannelAttributes,
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions/internal";
-import {
+import type {
 	IMergeTreeTextHelper,
 	IRelativePosition,
 	ISegment,
 	ISegmentAction,
-	Marker,
 	PropertySet,
 	ReferenceType,
-	TextSegment,
-	refHasTileLabel,
 } from "@fluidframework/merge-tree/internal";
+import { Marker, TextSegment, refHasTileLabel } from "@fluidframework/merge-tree/internal";
 
 import { SharedSegmentSequence, type ISharedSegmentSequence } from "./sequence.js";
 import { SharedStringFactory } from "./sequenceFactory.js";