@fluidframework/sequence 2.0.0-internal.6.1.1 → 2.0.0-internal.6.3.0

package/src/sequence.ts

@@ -2,8 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { Deferred, bufferToString, assert } from "@fluidframework/common-utils";
-import { createChildLogger } from "@fluidframework/telemetry-utils";
+import { assert, Deferred } from "@fluidframework/core-utils";
+import { bufferToString } from "@fluid-internal/client-utils";
+import { LoggingError, createChildLogger } from "@fluidframework/telemetry-utils";
 import { ISequencedDocumentMessage, MessageType } from "@fluidframework/protocol-definitions";
 import {
 	IChannelAttributes,
@@ -13,6 +14,7 @@ import {
 import {
 	Client,
 	createAnnotateRangeOp,
+	// eslint-disable-next-line import/no-deprecated
 	createGroupOp,
 	createInsertOp,
 	createRemoveRangeOp,
@@ -46,9 +48,8 @@ import {
 	ISharedObjectEvents,
 	SummarySerializer,
 } from "@fluidframework/shared-object-base";
-import { IEventThisPlaceHolder } from "@fluidframework/common-definitions";
+import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
 import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
-
 import { DefaultMap, IMapOperation } from "./defaultMap";
 import { IMapMessageLocalMetadata, IValueChanged } from "./defaultMapInterfaces";
 import { SequenceInterval } from "./intervals";
@@ -119,6 +120,21 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		return this.loadedDeferred.promise;
 	}
 
+	/**
+	 * This is a safeguard to avoid problematic reentrancy of local ops. This type of scenario occurs if the user of SharedString subscribes
+	 * to the `sequenceDelta` event and uses the callback for a local op to submit further local ops.
+	 * Historically (before 2.0.0-internal.6.1.0), doing so would result in eventual consistency issues or a corrupted document.
+	 * These issues were fixed in #16815 which makes such reentrancy no different from applying the ops in order but not from within the change events,
+	 * but there is still little test coverage for reentrant scenarios.
+	 * Additionally, applications submitting ops from inside change events need to take extreme care that their data models also support reentrancy.
+	 * Since this is likely not the case, by default SharedString throws when encountering reentrant ops.
+	 *
+	 * An application using SharedString which explicitly wants to opt in to allowing reentrancy anyway can set `sharedStringPreventReentrancy`
+	 * on the data store options to `false`.
+	 * @internal
+	 */
+	protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
+
 	private static createOpsFromDelta(event: SequenceDeltaEvent): IMergeTreeDeltaOp[] {
 		const ops: IMergeTreeDeltaOp[] = [];
 		for (const r of event.ranges) {
@@ -194,6 +210,19 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	) {
 		super(id, dataStoreRuntime, attributes, "fluid_sequence_");
 
+		this.guardReentrancy =
+			dataStoreRuntime.options.sharedStringPreventReentrancy ?? true
+				? ensureNoReentrancy
+				: createReentrancyDetector((depth) => {
+						if (totalReentrancyLogs > 0) {
+							totalReentrancyLogs--;
+							this.logger.sendTelemetryEvent(
+								{ eventName: "LocalOpReentry", depth },
+								new LoggingError(reentrancyErrorMessage),
+							);
+						}
+				  });
+
 		this.loadedDeferred.promise.catch((error) => {
 			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
 		});
@@ -233,14 +262,14 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * @param end - The exclusive end of the range to remove
 	 */
 	public removeRange(start: number, end: number): IMergeTreeRemoveMsg {
-		return this.client.removeRangeLocal(start, end);
+		return this.guardReentrancy(() => this.client.removeRangeLocal(start, end));
 	}
 
 	/**
 	 * @deprecated - The ability to create group ops will be removed in an upcoming release, as group ops are redundant with the native batching capabilities of the runtime
 	 */
 	public groupOperation(groupOp: IMergeTreeGroupMsg) {
-		this.client.localTransaction(groupOp);
+		this.guardReentrancy(() => this.client.localTransaction(groupOp));
 	}
 
 	/**
@@ -286,7 +315,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		props: PropertySet,
 		combiningOp?: ICombiningOp,
 	) {
-		this.client.annotateRangeLocal(start, end, props, combiningOp);
+		this.guardReentrancy(() => this.client.annotateRangeLocal(start, end, props, combiningOp));
 	}
 
 	public getPropertiesAtPosition(pos: number) {
@@ -415,6 +444,9 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		this.client.walkSegments(handler, start, end, accum as TClientData, splitRange);
 	}
 
+	/**
+	 * @deprecated - this functionality is no longer supported and will be removed
+	 */
 	public getStackContext(startPos: number, rangeLabels: string[]): RangeStackMap {
 		return this.client.getStackContext(startPos, rangeLabels);
 	}
@@ -433,7 +465,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * @param segment - The segment to insert
 	 */
 	public insertAtReferencePosition(pos: ReferencePosition, segment: T) {
-		this.client.insertAtReferencePositionLocal(pos, segment);
+		this.guardReentrancy(() => this.client.insertAtReferencePositionLocal(pos, segment));
 	}
 	/**
 	 * Inserts a segment
@@ -442,7 +474,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 */
 	public insertFromSpec(pos: number, spec: IJSONSegment) {
 		const segment = this.segmentFromSpec(spec);
-		this.client.insertSegmentLocal(pos, segment);
+		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -722,6 +754,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				stashMessage = {
 					...message,
 					referenceSequenceNumber: stashMessage.sequenceNumber - 1,
+					// eslint-disable-next-line import/no-deprecated
 					contents: ops.length !== 1 ? createGroupOp(...ops) : ops[0],
 				};
 			}
@@ -803,3 +836,41 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		}
 	}
 }
+
+function createReentrancyDetector(
+	onReentrancy: (depth: number) => void,
+): <T>(callback: () => T) => T {
+	let depth = 0;
+	function detectReentrancy<T>(callback: () => T): T {
+		if (depth > 0) {
+			onReentrancy(depth);
+		}
+		depth++;
+		try {
+			return callback();
+		} finally {
+			depth--;
+		}
+	}
+
+	return detectReentrancy;
+}
+
+/**
+ * Apps which generate reentrant behavior may do so at a high frequency.
+ * Logging even per-SharedSegmentSequence instance might be too noisy, and having a few logs from a session
+ * is likely enough.
+ */
+let totalReentrancyLogs = 3;
+
+/**
+ * Resets the reentrancy log counter. Test-only API.
+ */
+export function resetReentrancyLogCounter() {
+	totalReentrancyLogs = 3;
+}
+
+const reentrancyErrorMessage = "Reentrancy detected in sequence local ops";
+const ensureNoReentrancy = createReentrancyDetector(() => {
+	throw new LoggingError(reentrancyErrorMessage);
+});

package/src/sequenceDeltaEvent.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import {
 	Client,
 	IMergeTreeDeltaCallbackArgs,

package/src/sharedIntervalCollection.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { bufferToString } from "@fluidframework/common-utils";
+import { bufferToString } from "@fluid-internal/client-utils";
 import {
 	IChannelAttributes,
 	IFluidDataStoreRuntime,

package/src/sharedSequence.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import { BaseSegment, IJSONSegment, ISegment, PropertySet } from "@fluidframework/merge-tree";
 import {
 	IChannelAttributes,
@@ -14,10 +14,16 @@ import { SharedSegmentSequence } from "./sequence";
 
 const MaxRun = 128;
 
+/**
+ * @deprecated - IJSONRunSegment will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ */
 export interface IJSONRunSegment<T> extends IJSONSegment {
 	items: Serializable<T>[];
 }
 
+/**
+ * @deprecated - SubSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ */
 export class SubSequence<T> extends BaseSegment {
 	public static readonly typeString: string = "SubSequence";
 	public static is(segment: ISegment): segment is SubSequence<any> {
@@ -98,6 +104,9 @@ export class SubSequence<T> extends BaseSegment {
 	}
 }
 
+/**
+ * @deprecated - SharedSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
+ */
 export class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
 	constructor(
 		document: IFluidDataStoreRuntime,

package/src/sharedString.ts

@@ -118,7 +118,7 @@ export class SharedString
 		}
 
 		const pos = this.posFromRelativePos(relativePos1);
-		this.client.insertSegmentLocal(pos, segment);
+		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -134,7 +134,7 @@ export class SharedString
 			segment.addProperties(props);
 		}
 
-		return this.client.insertSegmentLocal(pos, segment);
+		return this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -150,7 +150,7 @@ export class SharedString
 		}
 
 		const pos = this.posFromRelativePos(relativePos1);
-		this.client.insertSegmentLocal(pos, segment);
+		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -162,7 +162,7 @@ export class SharedString
 			segment.addProperties(props);
 		}
 
-		this.client.insertSegmentLocal(pos, segment);
+		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
 	/**
@@ -197,7 +197,9 @@ export class SharedString
 		props: PropertySet,
 		callback: (m: Marker) => void,
 	) {
-		this.client.annotateMarkerNotifyConsensus(marker, props, callback);
+		this.guardReentrancy(() =>
+			this.client.annotateMarkerNotifyConsensus(marker, props, callback),
+		);
 	}
 
 	/**
@@ -207,7 +209,7 @@ export class SharedString
 	 * @param combiningOp - Optional. Specifies how to combine values for the property, such as "incr" for increment.
 	 */
 	public annotateMarker(marker: Marker, props: PropertySet, combiningOp?: ICombiningOp) {
-		this.client.annotateMarker(marker, props, combiningOp);
+		this.guardReentrancy(() => this.client.annotateMarker(marker, props, combiningOp));
 	}
 
 	/**