@fluidframework/merge-tree 2.5.0 → 2.10.0-304831

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/merge-tree",
-  "version": "2.5.0",
+  "version": "2.10.0-304831",
   "description": "Merge tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,30 +81,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.5.0",
-    "@fluidframework/container-definitions": "~2.5.0",
-    "@fluidframework/core-interfaces": "~2.5.0",
-    "@fluidframework/core-utils": "~2.5.0",
-    "@fluidframework/datastore-definitions": "~2.5.0",
-    "@fluidframework/driver-definitions": "~2.5.0",
-    "@fluidframework/runtime-definitions": "~2.5.0",
-    "@fluidframework/runtime-utils": "~2.5.0",
-    "@fluidframework/shared-object-base": "~2.5.0",
-    "@fluidframework/telemetry-utils": "~2.5.0"
+    "@fluid-internal/client-utils": "2.10.0-304831",
+    "@fluidframework/container-definitions": "2.10.0-304831",
+    "@fluidframework/core-interfaces": "2.10.0-304831",
+    "@fluidframework/core-utils": "2.10.0-304831",
+    "@fluidframework/datastore-definitions": "2.10.0-304831",
+    "@fluidframework/driver-definitions": "2.10.0-304831",
+    "@fluidframework/runtime-definitions": "2.10.0-304831",
+    "@fluidframework/runtime-utils": "2.10.0-304831",
+    "@fluidframework/shared-object-base": "2.10.0-304831",
+    "@fluidframework/telemetry-utils": "2.10.0-304831"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.16.4",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.5.0",
-    "@fluid-private/stochastic-test-utils": "~2.5.0",
-    "@fluid-private/test-pairwise-generator": "~2.5.0",
+    "@fluid-internal/mocha-test-setup": "2.10.0-304831",
+    "@fluid-private/stochastic-test-utils": "2.10.0-304831",
+    "@fluid-private/test-pairwise-generator": "2.10.0-304831",
     "@fluid-tools/benchmark": "^0.50.0",
-    "@fluid-tools/build-cli": "^0.49.0",
+    "@fluid-tools/build-cli": "^0.50.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.49.0",
+    "@fluidframework/build-tools": "^0.50.0",
     "@fluidframework/eslint-config-fluid": "^5.4.0",
-    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@~2.4.0",
-    "@fluidframework/test-runtime-utils": "~2.5.0",
+    "@fluidframework/merge-tree-previous": "npm:@fluidframework/merge-tree@2.5.0",
+    "@fluidframework/test-runtime-utils": "2.10.0-304831",
     "@microsoft/api-extractor": "7.47.8",
     "@types/diff": "^3.5.1",
     "@types/mocha": "^9.1.1",
@@ -124,7 +124,79 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Class_BaseSegment": {
+        "backCompat": false
+      },
+      "Class_Marker": {
+        "backCompat": false
+      },
+      "Class_MergeNode": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "Class_TextSegment": {
+        "backCompat": false
+      },
+      "Class_TrackingGroup": {
+        "backCompat": false
+      },
+      "Class_SegmentGroupCollection": {
+        "backCompat": false,
+        "forwardCompat": false
+      },
+      "ClassStatics_BaseSegment": {
+        "backCompat": false
+      },
+      "ClassStatics_Marker": {
+        "backCompat": false
+      },
+      "ClassStatics_MergeNode": {
+        "backCompat": false
+      },
+      "ClassStatics_TextSegment": {
+        "backCompat": false
+      },
+      "ClassStatics_TrackingGroup": {
+        "backCompat": false
+      },
+      "ClassStatics_SegmentGroupCollection": {
+        "backCompat": false
+      },
+      "Interface_IMergeTreeDeltaCallbackArgs": {
+        "backCompat": false
+      },
+      "Interface_IMergeTreeMaintenanceCallbackArgs": {
+        "backCompat": false
+      },
+      "Interface_IMergeTreeSegmentDelta": {
+        "backCompat": false
+      },
+      "Interface_IMoveInfo": {
+        "backCompat": false
+      },
+      "Interface_ISegment": {
+        "backCompat": false
+      },
+      "Interface_ITrackingGroup": {
+        "backCompat": false
+      },
+      "Interface_ObliterateInfo": {
+        "backCompat": false
+      },
+      "Interface_ReferencePosition": {
+        "backCompat": false
+      },
+      "Interface_SegmentGroup": {
+        "backCompat": false
+      },
+      "TypeAlias_MergeTreeDeltaRevertible": {
+        "backCompat": false
+      },
+      "TypeAlias_Trackable": {
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/client.ts

@@ -29,7 +29,11 @@ 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, errorIfOptionNotTrue } from "./mergeTree.js";
+import {
+	MergeTree,
+	errorIfOptionNotTrue,
+	type IMergeTreeOptionsInternal,
+} from "./mergeTree.js";
 import type {
 	IMergeTreeClientSequenceArgs,
 	IMergeTreeDeltaCallbackArgs,
@@ -100,9 +104,7 @@ export interface IIntegerRange {
  * Emitted before this client's merge-tree normalizes its segments on reconnect, potentially
  * ordering them. Useful for DDS-like consumers built atop the merge-tree to compute any information
  * they need for rebasing their ops on reconnection.
- * @legacy
- * @alpha
- * @deprecated  This functionality was not meant to be exported and will be removed in a future release
+ * @internal
  */
 export interface IClientEvents {
 	(event: "normalize", listener: (target: IEventThisPlaceHolder) => void): void;
@@ -125,9 +127,12 @@ export interface IClientEvents {
 }
 
 /**
- * @deprecated This functionality was not meant to be exported and will be removed in a future release
- * @legacy
- * @alpha
+ * This class encapsulates a merge-tree, and provides a local client specific view over it and
+ * the capability to modify it as the local client. Additionally it provides
+ * binding for processing remote ops on the encapsulated merge tree, and projects local and remote events
+ * caused by all modification to the underlying merge-tree.
+ *
+ * @internal
  */
 export class Client extends TypedEventEmitter<IClientEvents> {
 	public longClientId: string | undefined;
@@ -155,7 +160,7 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 	constructor(
 		public readonly specToSegment: (spec: IJSONSegment) => ISegment,
 		public readonly logger: ITelemetryLoggerExt,
-		options?: IMergeTreeOptions & PropertySet,
+		options?: IMergeTreeOptionsInternal & PropertySet,
 		private readonly getMinInFlightRefSeq: () => number | undefined = (): undefined =>
 			undefined,
 	) {
@@ -857,7 +862,7 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 	private resetPendingDeltaToOps(
 		resetOp: IMergeTreeDeltaOp,
 		// eslint-disable-next-line import/no-deprecated
-		segmentGroup: SegmentGroup,
+		segmentGroup: SegmentGroup<ISegmentLeaf>,
 	): IMergeTreeDeltaOp[] {
 		assert(!!segmentGroup, 0x033 /* "Segment group undefined" */);
 		const NACKedSegmentGroup = this.pendingRebase?.shift()?.data;
@@ -890,7 +895,7 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 			a.ordinal < b.ordinal ? -1 : 1,
 		)) {
 			assert(
-				segment.segmentGroups.remove?.(segmentGroup) === true,
+				segment.segmentGroups?.remove?.(segmentGroup) === true,
 				0x035 /* "Segment group not in segment pending queue" */,
 			);
 			assert(
@@ -1010,7 +1015,6 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 					opList.push(newOp);
 				}
 			} else if (newOp) {
-				// eslint-disable-next-line import/no-deprecated
 				const newSegmentGroup: SegmentGroup = {
 					segments: [],
 					localSeq: segmentGroup.localSeq,
@@ -1174,7 +1178,6 @@ export class Client extends TypedEventEmitter<IClientEvents> {
 		segmentGroup: SegmentGroup | SegmentGroup[],
 	): IMergeTreeOp {
 		if (this.pendingRebase === undefined || this.pendingRebase.empty) {
-			// eslint-disable-next-line import/no-deprecated
 			let firstGroup: SegmentGroup;
 			if (Array.isArray(segmentGroup)) {
 				if (segmentGroup.length === 0) {

package/src/index.ts

@@ -42,6 +42,7 @@ export {
 	AttributionPolicy,
 	IMergeTreeAttributionOptions,
 	IMergeTreeOptions,
+	IMergeTreeOptionsInternal,
 	getSlideToSegoff,
 } from "./mergeTree.js";
 export {
@@ -65,7 +66,6 @@ export {
 	ISegment,
 	ISegmentAction,
 	Marker,
-	MergeNode,
 	reservedMarkerIdKey,
 	reservedMarkerSimpleTypeKey,
 	SegmentGroup,
@@ -123,8 +123,11 @@ export {
 	reservedRangeLabelsKey,
 	reservedTileLabelsKey,
 } from "./referencePositions.js";
-export { SegmentGroupCollection } from "./segmentGroupCollection.js";
-export { PropertiesManager, PropertiesRollback } from "./segmentPropertiesManager.js";
+export {
+	copyPropertiesAndManager,
+	PropertiesManager,
+	PropertiesRollback,
+} from "./segmentPropertiesManager.js";
 export {
 	InteriorSequencePlace,
 	Side,

package/src/mergeTree.ts

@@ -10,7 +10,6 @@ import { assert, Heap, IComparer } from "@fluidframework/core-utils/internal";
 import { DataProcessingError, UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import { IAttributionCollectionSerializer } from "./attributionCollection.js";
-// eslint-disable-next-line import/no-deprecated
 import { Client } from "./client.js";
 import { DoublyLinkedList, ListNode } from "./collections/index.js";
 import {
@@ -80,7 +79,7 @@ import {
 } from "./ops.js";
 import { PartialSequenceLengths } from "./partialLengths.js";
 import { PerspectiveImpl, isSegmentPresent } from "./perspective.js";
-import { PropertySet, clone, createMap, extend, extendIfUndefined } from "./properties.js";
+import { PropertySet, createMap, extend, extendIfUndefined } from "./properties.js";
 import {
 	DetachedReferencePosition,
 	ReferencePosition,
@@ -91,7 +90,11 @@ import {
 // 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 {
+	copyPropertiesAndManager,
+	PropertiesManager,
+	PropertiesRollback,
+} from "./segmentPropertiesManager.js";
 import { Side, type InteriorSequencePlace } from "./sequencePlace.js";
 import { SortedSegmentSet } from "./sortedSegmentSet.js";
 import { zamboniSegments } from "./zamboni.js";
@@ -143,6 +146,70 @@ const LRUSegmentComparer: IComparer<LRUSegment> = {
 	compare: (a, b) => a.maxSeq - b.maxSeq,
 };
 
+function ackSegment(
+	segment: ISegmentLeaf,
+	segmentGroup: SegmentGroup,
+	opArgs: IMergeTreeDeltaOpArgs,
+): boolean {
+	const currentSegmentGroup = segment.segmentGroups?.dequeue();
+	assert(currentSegmentGroup === segmentGroup, 0x043 /* "On ack, unexpected segmentGroup!" */);
+	switch (opArgs.op.type) {
+		case MergeTreeDeltaType.ANNOTATE: {
+			assert(
+				!!segment.propertyManager,
+				0x044 /* "On annotate ack, missing segment property manager!" */,
+			);
+			segment.propertyManager.ackPendingProperties(opArgs.op);
+			return true;
+		}
+
+		case MergeTreeDeltaType.INSERT: {
+			assert(
+				segment.seq === UnassignedSequenceNumber,
+				0x045 /* "On insert, seq number already assigned!" */,
+			);
+			segment.seq = opArgs.sequencedMessage!.sequenceNumber;
+			segment.localSeq = undefined;
+			return true;
+		}
+
+		case MergeTreeDeltaType.REMOVE: {
+			const removalInfo: IRemovalInfo | undefined = toRemovalInfo(segment);
+			assert(removalInfo !== undefined, 0x046 /* "On remove ack, missing removal info!" */);
+			segment.localRemovedSeq = undefined;
+			if (removalInfo.removedSeq === UnassignedSequenceNumber) {
+				removalInfo.removedSeq = opArgs.sequencedMessage!.sequenceNumber;
+				return true;
+			}
+			return false;
+		}
+
+		case MergeTreeDeltaType.OBLITERATE:
+		case MergeTreeDeltaType.OBLITERATE_SIDED: {
+			const moveInfo: IMoveInfo | undefined = toMoveInfo(segment);
+			assert(moveInfo !== undefined, 0x86e /* On obliterate ack, missing move info! */);
+			const obliterateInfo = segmentGroup.obliterateInfo;
+			assert(obliterateInfo !== undefined, 0xa40 /* must have obliterate info */);
+			segment.localMovedSeq = obliterateInfo.localSeq = undefined;
+			const seqIdx = moveInfo.movedSeqs.indexOf(UnassignedSequenceNumber);
+			assert(seqIdx !== -1, 0x86f /* expected movedSeqs to contain unacked seq */);
+			moveInfo.movedSeqs[seqIdx] = obliterateInfo.seq =
+				opArgs.sequencedMessage!.sequenceNumber;
+
+			if (moveInfo.movedSeq === UnassignedSequenceNumber) {
+				moveInfo.movedSeq = opArgs.sequencedMessage!.sequenceNumber;
+				return true;
+			}
+
+			return false;
+		}
+
+		default: {
+			throw new Error(`${opArgs.op.type} is in unrecognized operation type`);
+		}
+	}
+}
+
 /**
  * @legacy
  * @alpha
@@ -177,11 +244,6 @@ export interface IMergeTreeOptions {
 	 */
 	newMergeTreeSnapshotFormat?: boolean;
 
-	/**
-	 * Options related to attribution
-	 */
-	attribution?: IMergeTreeAttributionOptions;
-
 	/**
 	 * Enables support for the obliterate operation -- a stronger form of remove
 	 * which deletes concurrently inserted segments
@@ -212,6 +274,17 @@ export interface IMergeTreeOptions {
 	 */
 	mergeTreeEnableSidedObliterate?: boolean;
 }
+
+/**
+ * @internal
+ */
+export interface IMergeTreeOptionsInternal extends IMergeTreeOptions {
+	/**
+	 * Options related to attribution
+	 */
+	attribution?: IMergeTreeAttributionOptions;
+}
+
 export function errorIfOptionNotTrue(
 	options: IMergeTreeOptions | undefined,
 	option: keyof IMergeTreeOptions,
@@ -222,9 +295,7 @@ export function errorIfOptionNotTrue(
 }
 
 /**
- * @legacy
- * @alpha
- * @deprecated  This functionality was not meant to be exported and will be removed in a future release
+ * @internal
  */
 export interface IMergeTreeAttributionOptions {
 	/**
@@ -250,9 +321,7 @@ export interface IMergeTreeAttributionOptions {
 /**
  * Implements policy dictating which kinds of operations should be attributed and how.
  * @sealed
- * @legacy
- * @alpha
- * @deprecated This functionality was not meant to be exported and will be removed in a future release
+ * @internal
  */
 export interface AttributionPolicy {
 	/**
@@ -262,7 +331,6 @@ export interface AttributionPolicy {
 	 *
 	 * This must be done in an eventually consistent fashion.
 	 */
-	// eslint-disable-next-line import/no-deprecated
 	attach: (client: Client) => void;
 	/**
 	 * Disables tracking attribution information on segments.
@@ -477,7 +545,6 @@ class Obliterates {
 		const overlapping: ObliterateInfo[] = [];
 		for (const start of this.startOrdered.items) {
 			if (start.getSegment()!.ordinal <= seg.ordinal) {
-				// eslint-disable-next-line import/no-deprecated
 				const ob = start.properties?.obliterate as ObliterateInfo;
 				if (ob.end.getSegment()!.ordinal >= seg.ordinal) {
 					overlapping.push(ob);
@@ -527,7 +594,7 @@ export class MergeTree {
 
 	private readonly obliterates = new Obliterates(this);
 
-	public constructor(public options?: IMergeTreeOptions) {
+	public constructor(public options?: IMergeTreeOptionsInternal) {
 		this._root = this.makeBlock(0);
 		this._root.mergeTree = this;
 		this.attributionPolicy = options?.attribution?.policyFactory?.();
@@ -1234,7 +1301,7 @@ export class MergeTree {
 			const deltaSegments: IMergeTreeSegmentDelta[] = [];
 			const overlappingRemoves: boolean[] = [];
 			pendingSegmentGroup.segments.map((pendingSegment: ISegmentLeaf) => {
-				const overlappingRemove = !pendingSegment.ack(pendingSegmentGroup, opArgs);
+				const overlappingRemove = !ackSegment(pendingSegment, pendingSegmentGroup, opArgs);
 
 				overwrite = overlappingRemove || overwrite;
 
@@ -1538,10 +1605,8 @@ export class MergeTree {
 					continue;
 				}
 
-				// eslint-disable-next-line import/no-deprecated
 				let oldest: ObliterateInfo | undefined;
 				let normalizedOldestSeq: number = 0;
-				// eslint-disable-next-line import/no-deprecated
 				let newest: ObliterateInfo | undefined;
 				let normalizedNewestSeq: number = 0;
 				const movedClientIds: number[] = [];
@@ -1615,28 +1680,14 @@ export class MergeTree {
 		const next: ISegmentLeaf = segment.splitAt(pos)!;
 
 		if (segment?.segmentGroups) {
-			// eslint-disable-next-line import/no-deprecated
 			next.segmentGroups ??= new SegmentGroupCollection(next);
-			segment.segmentGroups.copyTo(next);
+			segment.segmentGroups.copyTo(next.segmentGroups);
 		}
 
 		if (segment.prevObliterateByInserter) {
 			next.prevObliterateByInserter = segment.prevObliterateByInserter;
 		}
-
-		if (segment.properties) {
-			if (segment.propertyManager === undefined) {
-				next.properties = clone(segment.properties);
-			} else {
-				// eslint-disable-next-line import/no-deprecated
-				next.propertyManager ??= new PropertiesManager();
-				next.properties = segment.propertyManager.copyTo(
-					segment.properties,
-					next.properties,
-					next.propertyManager,
-				);
-			}
-		}
+		copyPropertiesAndManager(segment, next);
 		if (segment.localRefs) {
 			segment.localRefs.split(pos, next);
 		}
@@ -1876,7 +1927,6 @@ export class MergeTree {
 				0x5ad /* Cannot change the markerId of an existing marker */,
 			);
 
-			// eslint-disable-next-line import/no-deprecated
 			const propertyManager = (segment.propertyManager ??= new PropertiesManager());
 			const properties = (segment.properties ??= createMap());
 			const propertyDeltas = propertyManager.addProperties(
@@ -2363,7 +2413,6 @@ export class MergeTree {
 						UniversalSequenceNumber,
 						{ op: annotateOp },
 
-						// eslint-disable-next-line import/no-deprecated
 						PropertiesRollback.Rollback,
 					);
 					i++;