@fluidframework/sequence 2.0.0-dev.3.1.0.125672 → 2.0.0-dev.4.2.0.153917

package/src/intervalCollection.ts

@@ -78,9 +78,9 @@ export interface ISerializedInterval {
 	 * At the time of writing, it's not plumbed through to the reconnect/rebase code, however, which does need it.
 	 */
 	sequenceNumber: number;
-	/** Start position of the interval (inclusive) */
+	/** Start position of the interval */
 	start: number;
-	/** End position of the interval (inclusive) */
+	/** End position of the interval */
 	end: number;
 	/** Interval type to create */
 	intervalType: IntervalType;
@@ -209,6 +209,7 @@ export class Interval implements ISerializableInterval {
 	public auxProps: PropertySet[] | undefined;
 	/**
 	 * {@inheritDoc ISerializableInterval.propertyManager}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public propertyManager: PropertiesManager;
 	constructor(public start: number, public end: number, props?: PropertySet) {
@@ -223,11 +224,9 @@ export class Interval implements ISerializableInterval {
 	/**
 	 * {@inheritDoc ISerializableInterval.getIntervalId}
 	 */
-	public getIntervalId(): string | undefined {
+	public getIntervalId(): string {
 		const id = this.properties?.[reservedIntervalIdKey];
-		if (id === undefined) {
-			return undefined;
-		}
+		assert(id !== undefined, 0x5e1 /* interval ID should not be undefined */);
 		return `${id}`;
 	}
 
@@ -326,6 +325,7 @@ export class Interval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc IInterval.union}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public union(b: Interval) {
 		return new Interval(
@@ -341,6 +341,7 @@ export class Interval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc ISerializableInterval.addProperties}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public addProperties(
 		newProps: PropertySet,
@@ -362,6 +363,7 @@ export class Interval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc IInterval.modify}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public modify(label: string, start: number, end: number, op?: ISequencedDocumentMessage) {
 		const startPos = start ?? this.start;
@@ -396,6 +398,22 @@ export class Interval implements ISerializableInterval {
  * Interval impelmentation whose ends are associated with positions in a mutatable sequence.
  * As such, when content is inserted into the middle of the interval, the interval expands to
  * include that content.
+ *
+ * @remarks - The endpoint's position should be treated exclusively to get reasonable behavior--i.e.
+ * an interval referring to "hello" in "hello world" should have a start position of 0 and an end
+ * position of 5.
+ *
+ * To see why, consider what happens if "llo wor" is removed from the string to make "held".
+ * The interval's startpoint remains on the "h" (it isn't altered), but the interval's endpoint
+ * slides forward to the next unremoved position, which is the "l" in "held".
+ * Users would generally expect the interval to now refer to "he" (as it is the subset of content
+ * remaining after the removal), hence the "l" should be excluded.
+ * If the interval endpoint was treated inclusively, the interval would now refer to "hel", which
+ * is undesirable.
+ *
+ * Since the end of an interval is treated exclusively but cannot be greater than or equal to the
+ * length of the associated sequence, application models which leverage interval collections should
+ * consider inserting a marker at the end of the sequence to represent the end of the content.
  */
 export class SequenceInterval implements ISerializableInterval {
 	/**
@@ -404,6 +422,7 @@ export class SequenceInterval implements ISerializableInterval {
 	public properties: PropertySet;
 	/**
 	 * {@inheritDoc ISerializableInterval.propertyManager}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public propertyManager: PropertiesManager;
 
@@ -551,16 +570,15 @@ export class SequenceInterval implements ISerializableInterval {
 	/**
 	 * {@inheritDoc ISerializableInterval.getIntervalId}
 	 */
-	public getIntervalId(): string | undefined {
+	public getIntervalId(): string {
 		const id = this.properties?.[reservedIntervalIdKey];
-		if (id === undefined) {
-			return undefined;
-		}
+		assert(id !== undefined, 0x5e2 /* interval ID should not be undefined */);
 		return `${id}`;
 	}
 
 	/**
 	 * {@inheritDoc IInterval.union}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public union(b: SequenceInterval) {
 		return new SequenceInterval(
@@ -573,6 +591,7 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc ISerializableInterval.addProperties}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public addProperties(
 		newProps: PropertySet,
@@ -586,7 +605,6 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * @returns whether this interval overlaps two numerical positions.
-	 * @remarks - this is currently strict overlap, which doesn't align with the endpoint treatment of`.overlaps()`
 	 */
 	public overlapsPos(bstart: number, bend: number) {
 		const startPos = this.client.localReferencePositionToPosition(this.start);
@@ -596,6 +614,7 @@ export class SequenceInterval implements ISerializableInterval {
 
 	/**
 	 * {@inheritDoc IInterval.modify}
+	 * @deprecated - This API was never intended to be public and will be marked internal in a future release.
 	 */
 	public modify(
 		label: string,
@@ -671,6 +690,7 @@ function createPositionReferenceFromSegoff(
 	refType: ReferenceType,
 	op?: ISequencedDocumentMessage,
 	localSeq?: number,
+	fromSnapshot?: boolean,
 ): LocalReferencePosition {
 	if (segoff.segment) {
 		const ref = client.createLocalReferencePosition(
@@ -687,7 +707,12 @@ function createPositionReferenceFromSegoff(
 	// - References coming from a remote client (location may have been concurrently removed)
 	// - References being rebased to a new sequence number
 	//   (segment they originally referred to may have been removed with no suitable replacement)
-	if (!op && !localSeq && !refTypeIncludesFlag(refType, ReferenceType.Transient)) {
+	if (
+		!op &&
+		!localSeq &&
+		!fromSnapshot &&
+		!refTypeIncludesFlag(refType, ReferenceType.Transient)
+	) {
 		throw new UsageError("Non-transient references need segment");
 	}
 
@@ -720,7 +745,7 @@ function createPositionReference(
 		);
 		segoff = client.getContainingSegment(pos, undefined, localSeq);
 	}
-	return createPositionReferenceFromSegoff(client, segoff, refType, op, localSeq);
+	return createPositionReferenceFromSegoff(client, segoff, refType, op, localSeq, fromSnapshot);
 }
 
 export function createSequenceInterval(
@@ -945,7 +970,7 @@ export class LocalIntervalCollection<TInterval extends ISerializableInterval> {
 
 	/**
 	 * @returns an array of all intervals contained in this collection that overlap the range
-	 * `[startPosition, endPosition]`.
+	 * `[startPosition, endPosition)`.
 	 */
 	public findOverlappingIntervals(startPosition: number, endPosition: number) {
 		if (endPosition < startPosition || this.intervalTree.intervals.isEmpty()) {
@@ -1626,11 +1651,13 @@ export class IntervalCollection<TInterval extends ISerializableInterval> extends
 
 	/**
 	 * Creates a new interval and add it to the collection.
-	 * @param start - interval start position
-	 * @param end - interval end position
+	 * @param start - interval start position (inclusive)
+	 * @param end - interval end position (exclusive)
 	 * @param intervalType - type of the interval. All intervals are SlideOnRemove. Intervals may not be Transient.
 	 * @param props - properties of the interval
 	 * @returns - the created interval
+	 * @remarks - See documentation on {@link SequenceInterval} for comments on interval endpoint semantics: there are subtleties
+	 * with how the current half-open behavior is represented.
 	 */
 	public add(
 		start: number,
@@ -1931,6 +1958,13 @@ export class IntervalCollection<TInterval extends ISerializableInterval> extends
 		}
 	}
 
+	/**
+	 * @deprecated - This functionality was useful when adding two intervals at the same start/end positions resulted
+	 * in a conflict. This is no longer the case (as of PR#6407), as interval collections support multiple intervals
+	 * at the same location and gives each interval a unique id.
+	 *
+	 * As such, the conflict resolver is never invoked and unnecessary. This API will be removed in an upcoming release.
+	 */
 	public addConflictResolver(conflictResolver: IntervalConflictResolver<TInterval>): void {
 		if (!this.localCollection) {
 			throw new LoggingError("attachSequence must be called");

package/src/intervalTree.ts

@@ -61,7 +61,7 @@ export interface IInterval {
 	): IInterval | undefined;
 	/**
 	 * @returns whether this interval overlaps with `b`.
-	 * Since intervals are inclusive, this includes cases where endpoints are equal.
+	 * Intervals are considered to overlap if their intersection is non-empty.
 	 */
 	overlaps(b: IInterval): boolean;
 	/**
@@ -77,6 +77,13 @@ const intervalComparer = (a: IInterval, b: IInterval) => a.compare(b);
 
 export type IntervalNode<T extends IInterval> = RBNode<T, AugmentedIntervalNode>;
 
+/**
+ * @deprecated - This functionality was useful when adding two intervals at the same start/end positions resulted
+ * in a conflict. This is no longer the case (as of PR#6407), as interval collections support multiple intervals
+ * at the same location and gives each interval a unique id.
+ *
+ * As such, conflict resolvers are never invoked and unnecessary. They will be removed in an upcoming release.
+ */
 export type IntervalConflictResolver<TInterval> = (a: TInterval, b: TInterval) => TInterval;
 
 export class IntervalTree<T extends IInterval>

package/src/packageVersion.ts

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

package/src/sequence.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { Deferred, bufferToString, assert } from "@fluidframework/common-utils";
-import { ChildLogger, loggerToMonitoringContext } from "@fluidframework/telemetry-utils";
+import { ChildLogger } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
 	IChannelAttributes,
@@ -22,7 +22,6 @@ import {
 	IMergeTreeDeltaOp,
 	IMergeTreeGroupMsg,
 	IMergeTreeOp,
-	IMergeTreeOptions,
 	IMergeTreeRemoveMsg,
 	IRelativePosition,
 	ISegment,
@@ -197,22 +196,10 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
 		});
 
-		const mergeTreeOptions = {
-			...(dataStoreRuntime.options as IMergeTreeOptions),
-		};
-
-		const configSetAttribution = loggerToMonitoringContext(this.logger).config.getBoolean(
-			"Fluid.Attribution.EnableOnNewFile",
-		);
-		if (configSetAttribution !== undefined) {
-			mergeTreeOptions.attribution ??= {};
-			mergeTreeOptions.attribution.track = configSetAttribution;
-		}
-
 		this.client = new Client(
 			segmentFromSpec,
 			ChildLogger.create(this.logger, "SharedSegmentSequence.MergeTreeClient"),
-			mergeTreeOptions,
+			dataStoreRuntime.options,
 		);
 
 		this.client.on("delta", (opArgs, deltaArgs) => {

package/.editorconfig

@@ -1,7 +0,0 @@
-[*]
-indent_size = 4
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[package.json]
-indent_size = 2