@fluidframework/merge-tree 2.30.0 → 2.31.0

package/src/snapshotlegacy.ts

@@ -16,11 +16,11 @@ import {
 	createChildLogger,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { NonCollabClient, UnassignedSequenceNumber } from "./constants.js";
+import { NonCollabClient } from "./constants.js";
 import { MergeTree } from "./mergeTree.js";
-import { type ISegmentPrivate } from "./mergeTreeNodes.js";
+import { isSegmentLeaf, type ISegmentPrivate } from "./mergeTreeNodes.js";
+import { PriorPerspective } from "./perspective.js";
 import { matchProperties } from "./properties.js";
-import { isInserted, isRemoved } from "./segmentInfos.js";
 import {
 	JsonSegmentSpecs,
 	MergeTreeChunkLegacy,
@@ -195,11 +195,9 @@ export class SnapshotLegacy {
 	extractSync(): ISegmentPrivate[] {
 		const collabWindow = this.mergeTree.collabWindow;
 		const seq = (this.seq = collabWindow.minSeq);
+		const minSeqPerspective = new PriorPerspective(this.seq, NonCollabClient);
 		this.header = {
-			segmentsTotalLength: this.mergeTree.getLength(
-				this.mergeTree.collabWindow.minSeq,
-				NonCollabClient,
-			),
+			segmentsTotalLength: this.mergeTree.getLength(minSeqPerspective),
 			seq: this.mergeTree.collabWindow.minSeq,
 		};
 
@@ -208,14 +206,7 @@ export class SnapshotLegacy {
 		const segs: ISegmentPrivate[] = [];
 		let prev: ISegmentPrivate | undefined;
 		const extractSegment = (segment: ISegmentPrivate): boolean => {
-			if (
-				isInserted(segment) &&
-				segment.seq !== UnassignedSequenceNumber &&
-				segment.seq <= seq &&
-				(!isRemoved(segment) ||
-					segment.removedSeq === UnassignedSequenceNumber ||
-					segment.removedSeq > seq)
-			) {
+			if (isSegmentLeaf(segment) && minSeqPerspective.isSegmentPresent(segment)) {
 				originalSegments += 1;
 				const properties =
 					segment.propertyManager?.getAtSeq(segment.properties, seq) ?? segment.properties;
@@ -230,7 +221,7 @@ export class SnapshotLegacy {
 			return true;
 		};
 
-		this.mergeTree.mapRange(extractSegment, this.seq, NonCollabClient, undefined);
+		this.mergeTree.mapRange(extractSegment, minSeqPerspective, undefined);
 
 		this.segments = [];
 		let totalLength: number = 0;

package/src/stamps.ts

@@ -130,7 +130,7 @@ export function isAcked(a: OperationStamp): boolean {
  * Inserts a stamp into a sorted list of stamps in the correct (sorted) position.
  *
  * Beware that this uses Array.splice, thus requires asymptotics considerations.
- * If inserting a variable number of timestamp, consider just pushing them and sorting the list
+ * If inserting a variable number of timestamps, consider just pushing them and sorting the list
  * after using {@link compare} instead.
  */
 export function spliceIntoList(list: OperationStamp[], stamp: OperationStamp): void {

package/src/textSegment.ts

@@ -104,16 +104,3 @@ export class TextSegment extends BaseSegment {
 		}
 	}
 }
-
-/**
- * @internal
- */
-export interface IMergeTreeTextHelper {
-	getText(
-		refSeq: number,
-		clientId: number,
-		placeholder: string,
-		start?: number,
-		end?: number,
-	): string;
-}

package/src/zamboni.ts

@@ -11,20 +11,25 @@ import { MergeTreeMaintenanceType } from "./mergeTreeDeltaCallback.js";
 import {
 	type MergeBlock,
 	assignChild,
+	getMinSeqStamp,
 	IMergeNode,
 	ISegmentPrivate,
 	Marker,
 	MaxNodesInBlock,
-	seqLTE,
 } from "./mergeTreeNodes.js";
 import { matchProperties } from "./properties.js";
-import { toRemovalInfo, toMoveInfo, removeMergeNodeInfo } from "./segmentInfos.js";
+import { toRemovalInfo, removeMergeNodeInfo } from "./segmentInfos.js";
+import * as opstampUtils from "./stamps.js";
+import type { OperationStamp } from "./stamps.js";
 
 export const zamboniSegmentsMax = 2;
 function underflow(node: MergeBlock): boolean {
 	return node.childCount < MaxNodesInBlock / 2;
 }
 
+// blockUpdatePathLengths requires an OperationStamp but it is unused when passing `newStructure: true`.
+const dummyStamp: OperationStamp = { seq: UnassignedSequenceNumber, clientId: -1 };
+
 export function zamboniSegments(
 	mergeTree: MergeTree,
 	zamboniSegmentsMaxCount = zamboniSegmentsMax,
@@ -67,7 +72,7 @@ export function zamboniSegments(
 					packParent(block.parent, mergeTree);
 				} else {
 					mergeTree.nodeUpdateOrdinals(block);
-					mergeTree.blockUpdatePathLengths(block, UnassignedSequenceNumber, -1, true);
+					mergeTree.blockUpdatePathLengths(block, dummyStamp, true);
 				}
 			}
 		}
@@ -129,7 +134,7 @@ export function packParent(parent: MergeBlock, mergeTree: MergeTree): void {
 		packParent(parent.parent, mergeTree);
 	} else {
 		mergeTree.nodeUpdateOrdinals(parent);
-		mergeTree.blockUpdatePathLengths(parent, UnassignedSequenceNumber, -1, true);
+		mergeTree.blockUpdatePathLengths(parent, dummyStamp, true);
 	}
 }
 
@@ -148,34 +153,10 @@ function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTr
 
 		const segment = childNode;
 		const removalInfo = toRemovalInfo(segment);
-		const moveInfo = toMoveInfo(segment);
-		if (removalInfo !== undefined || moveInfo !== undefined) {
-			// If the segment's removal is below the MSN and it's not being held onto by a tracking group,
-			// it can be unlinked (i.e. removed from the merge-tree)
-			if (
-				((!!removalInfo && seqLTE(removalInfo.removedSeq, mergeTree.collabWindow.minSeq)) ||
-					(!!moveInfo && seqLTE(moveInfo.movedSeq, mergeTree.collabWindow.minSeq))) &&
-				segment.trackingCollection.empty
-			) {
-				mergeTree.mergeTreeMaintenanceCallback?.(
-					{
-						operation: MergeTreeMaintenanceType.UNLINK,
-						deltaSegments: [{ segment }],
-					},
-					undefined,
-				);
-				if (Marker.is(segment)) {
-					mergeTree.unlinkMarker(segment);
-				}
-				removeMergeNodeInfo(segment);
-			} else {
-				holdNodes.push(segment);
-			}
-
-			prevSegment = undefined;
-		} else {
-			if (segment.seq <= mergeTree.collabWindow.minSeq) {
-				const segmentHasPositiveLength = (mergeTree.localNetLength(segment) ?? 0) > 0;
+		const minSeqStamp = getMinSeqStamp(mergeTree.collabWindow);
+		if (removalInfo === undefined) {
+			if (opstampUtils.lte(segment.insert, minSeqStamp)) {
+				const segmentHasPositiveLength = (mergeTree.leafLength(segment) ?? 0) > 0;
 				const canAppend =
 					prevSegment?.canAppend(segment) &&
 					matchProperties(prevSegment.properties, segment.properties) &&
@@ -202,6 +183,31 @@ function scourNode(node: MergeBlock, holdNodes: IMergeNode[], mergeTree: MergeTr
 				holdNodes.push(segment);
 				prevSegment = undefined;
 			}
+		} else {
+			const firstRemove = removalInfo.removes[0];
+			// If the segment's removal is below the MSN and it's not being held onto by a tracking group,
+			// it can be unlinked (i.e. removed from the merge-tree)
+			if (
+				!!firstRemove &&
+				opstampUtils.lte(firstRemove, minSeqStamp) &&
+				segment.trackingCollection.empty
+			) {
+				mergeTree.mergeTreeMaintenanceCallback?.(
+					{
+						operation: MergeTreeMaintenanceType.UNLINK,
+						deltaSegments: [{ segment }],
+					},
+					undefined,
+				);
+				if (Marker.is(segment)) {
+					mergeTree.unlinkMarker(segment);
+				}
+				removeMergeNodeInfo(segment);
+			} else {
+				holdNodes.push(segment);
+			}
+
+			prevSegment = undefined;
 		}
 	}
 }

package/tsconfig.json

@@ -7,6 +7,7 @@
 		"outDir": "./lib",
 		"preserveConstEnums": true,
 		"noImplicitAny": true,
+		// TODO: AB#34171 Enable noUncheckedIndexedAccess for packages/dds/merge-tree
 		"noUncheckedIndexedAccess": false,
 		"exactOptionalPropertyTypes": false,
 	},

package/prettier.config.cjs

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	...require("@fluidframework/build-common/prettier.config.cjs"),
-};