@fluidframework/sequence 2.0.0-dev-rc.4.0.0.261659 → 2.0.0-dev-rc.5.0.0.263932

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.0.0-dev-rc.4.0.0.261659",
+  "version": "2.0.0-dev-rc.5.0.0.263932",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -87,34 +87,34 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/core-interfaces": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/core-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/merge-tree": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluid-internal/client-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/datastore-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/merge-tree": "2.0.0-dev-rc.5.0.0.263932",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/runtime-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/shared-object-base": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluidframework/runtime-definitions": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/runtime-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/shared-object-base": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluidframework/telemetry-utils": "2.0.0-dev-rc.5.0.0.263932",
     "double-ended-queue": "^2.1.0-0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-private/stochastic-test-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@fluid-private/test-dds-utils": "2.0.0-dev-rc.5.0.0.263932",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "0.38.0-259537",
+    "@fluid-tools/build-cli": "^0.38.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "0.38.0-259537",
-    "@fluidframework/container-definitions": "2.0.0-dev-rc.4.0.0.261659",
+    "@fluidframework/build-tools": "^0.38.0",
+    "@fluidframework/container-definitions": "2.0.0-dev-rc.5.0.0.263932",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
     "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.0.0-rc.3.0.0",
-    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.4.0.0.261659",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@fluidframework/test-runtime-utils": "2.0.0-dev-rc.5.0.0.263932",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/diff": "^3.5.1",
     "@types/double-ended-queue": "^2.1.0",
     "@types/mocha": "^9.1.1",
@@ -146,11 +146,21 @@
   "typeValidation": {
     "broken": {
       "RemovedClassDeclaration_SharedString": {
-        "backCompat": false
+        "backCompat": false,
+        "forwardCompat": false
       },
       "InterfaceDeclaration_ISharedString": {
         "forwardCompat": false
       },
+      "ClassDeclaration_SharedIntervalCollection": {
+        "forwardCompat": false
+      },
+      "ClassDeclaration_SharedSegmentSequence": {
+        "forwardCompat": false
+      },
+      "ClassDeclaration_SharedSequence": {
+        "forwardCompat": false
+      },
       "RemovedClassDeclaration_SharedStringFactory": {
         "backCompat": false,
         "forwardCompat": false

package/src/packageVersion.ts

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

package/src/sequence.ts

@@ -5,7 +5,7 @@
 
 import { bufferToString } from "@fluid-internal/client-utils";
 import { IEventThisPlaceHolder } from "@fluidframework/core-interfaces";
-import { assert, Deferred } from "@fluidframework/core-utils/internal";
+import { assert } from "@fluidframework/core-utils/internal";
 import {
 	IChannelAttributes,
 	IChannelStorageService,
@@ -117,8 +117,13 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	extends SharedObject<ISharedSegmentSequenceEvents>
 	implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver
 {
+	/**
+	 * This promise is always immediately resolved, and awaiting it has no effect.
+	 * @deprecated SharedSegmentSequence no longer supports partial loading.
+	 * References to this promise may safely be deleted without affecting behavior.
+	 */
 	get loaded(): Promise<void> {
-		return this.loadedDeferred.promise;
+		return Promise.resolve();
 	}
 
 	/**
@@ -240,25 +245,15 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * DDS submits over the wire. See `inFlightRefSeqs` for more details.
 	 */
 	private get currentRefSeq() {
-		return this.ongoingResubmitRefSeq ?? this.runtime.deltaManager.lastSequenceNumber;
+		return this.ongoingResubmitRefSeq ?? this.deltaManager.lastSequenceNumber;
 	}
 
 	// eslint-disable-next-line import/no-deprecated
 	protected client: Client;
-	/** `Deferred` that triggers once the object is loaded */
-	protected loadedDeferred = new Deferred<void>();
-	// cache out going ops created when partial loading
-	// eslint-disable-next-line import/no-deprecated
-	private readonly loadedDeferredOutgoingOps: [IMergeTreeOp, SegmentGroup | SegmentGroup[]][] =
-		[];
-	// cache incoming ops that arrive when partial loading
-	private deferIncomingOps = true;
-	private readonly loadedDeferredIncomingOps: ISequencedDocumentMessage[] = [];
-
 	private messagesSinceMSNChange: ISequencedDocumentMessage[] = [];
 	private readonly intervalCollections: IntervalCollectionMap<SequenceInterval>;
 	constructor(
-		private readonly dataStoreRuntime: IFluidDataStoreRuntime,
+		dataStoreRuntime: IFluidDataStoreRuntime,
 		public id: string,
 		attributes: IChannelAttributes,
 		public readonly segmentFromSpec: (spec: IJSONSegment) => ISegment,
@@ -279,10 +274,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 						}
 				  });
 
-		this.loadedDeferred.promise.catch((error) => {
-			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
-		});
-
 		// eslint-disable-next-line import/no-deprecated
 		this.client = new Client(
 			segmentFromSpec,
@@ -481,14 +472,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			message.type === MergeTreeDeltaType.GROUP ? message.ops.length : 1,
 		);
 
-		// if loading isn't complete, we need to cache
-		// local ops until loading is complete, and then
-		// they will be present
-		if (!this.loadedDeferred.isCompleted) {
-			this.loadedDeferredOutgoingOps.push(metadata ? [message, metadata] : (message as any));
-		} else {
-			this.submitLocalMessage(message, metadata);
-		}
+		this.submitLocalMessage(message, metadata);
 	}
 
 	/**
@@ -689,47 +673,38 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.serializer,
 			);
 
-			// setup a promise to process the
-			// catch up ops, and finishing the loading process
-			const loadCatchUpOps = catchupOpsP
-				.then((msgs) => {
-					msgs.forEach((m) => {
-						const collabWindow = this.client.getCollabWindow();
-						if (
-							m.minimumSequenceNumber < collabWindow.minSeq ||
-							m.referenceSequenceNumber < collabWindow.minSeq ||
-							m.sequenceNumber <= collabWindow.minSeq ||
-							// sequenceNumber could be the same if messages are part of a grouped batch
-							m.sequenceNumber < collabWindow.currentSeq
-						) {
-							throw new Error(
-								`Invalid catchup operations in snapshot: ${JSON.stringify({
-									op: {
-										seq: m.sequenceNumber,
-										minSeq: m.minimumSequenceNumber,
-										refSeq: m.referenceSequenceNumber,
-									},
-									collabWindow: {
-										seq: collabWindow.currentSeq,
-										minSeq: collabWindow.minSeq,
-									},
-								})}`,
-							);
-						}
-						this.processMergeTreeMsg(m);
-					});
-					this.loadFinished();
-				})
-				.catch((error) => {
-					this.loadFinished(error);
-				});
-			if (this.dataStoreRuntime.options.sequenceInitializeFromHeaderOnly !== true) {
-				// if we not doing partial load, await the catch up ops,
-				// and the finalization of the load
-				await loadCatchUpOps;
-			}
+			// process the catch up ops, and finishing the loading process
+			(await catchupOpsP).forEach((m) => {
+				const collabWindow = this.client.getCollabWindow();
+				if (
+					m.minimumSequenceNumber < collabWindow.minSeq ||
+					m.referenceSequenceNumber < collabWindow.minSeq ||
+					m.sequenceNumber <= collabWindow.minSeq ||
+					// sequenceNumber could be the same if messages are part of a grouped batch
+					m.sequenceNumber < collabWindow.currentSeq
+				) {
+					throw new Error(
+						`Invalid catchup operations in snapshot: ${JSON.stringify({
+							op: {
+								seq: m.sequenceNumber,
+								minSeq: m.minimumSequenceNumber,
+								refSeq: m.referenceSequenceNumber,
+							},
+							collabWindow: {
+								seq: collabWindow.currentSeq,
+								minSeq: collabWindow.minSeq,
+							},
+						})}`,
+					);
+				}
+				this.processMergeTreeMsg(m);
+			});
+
+			// Initialize the interval collections
+			this.initializeIntervalCollections();
 		} catch (error) {
-			this.loadFinished(error);
+			this.logger.sendErrorEvent({ eventName: "SequenceLoadFailed" }, error);
+			throw error;
 		}
 	}
 
@@ -753,27 +728,20 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			// assert(recordedRefSeq <= message.referenceSequenceNumber, "RefSeq mismatch");
 		}
 
-		// if loading isn't complete, we need to cache all
-		// incoming ops to be applied after loading is complete
-		if (this.deferIncomingOps) {
-			assert(!local, 0x072 /* "Unexpected local op when loading not finished" */);
-			this.loadedDeferredIncomingOps.push(message);
-		} else {
-			assert(
-				message.type === MessageType.Operation,
-				0x073 /* "Sequence message not operation" */,
-			);
+		assert(
+			message.type === MessageType.Operation,
+			0x073 /* "Sequence message not operation" */,
+		);
 
-			const handled = this.intervalCollections.tryProcessMessage(
-				message.contents as IMapOperation,
-				local,
-				message,
-				localOpMetadata,
-			);
+		const handled = this.intervalCollections.tryProcessMessage(
+			message.contents as IMapOperation,
+			local,
+			message,
+			localOpMetadata,
+		);
 
-			if (!handled) {
-				this.processMergeTreeMsg(message, local);
-			}
+		if (!handled) {
+			this.processMergeTreeMsg(message, local);
 		}
 	}
 
@@ -793,7 +761,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 */
 	protected initializeLocalCore() {
 		super.initializeLocalCore();
-		this.loadFinished();
+		this.initializeIntervalCollections();
 	}
 
 	/**
@@ -806,12 +774,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	}
 
 	private summarizeMergeTree(serializer: IFluidSerializer): ISummaryTreeWithStats {
-		// Are we fully loaded? If not, things will go south
-		assert(
-			this.loadedDeferred.isCompleted,
-			0x074 /* "Snapshot called when not fully loaded" */,
-		);
-		const minSeq = this.runtime.deltaManager.minimumSequenceNumber;
+		const minSeq = this.deltaManager.minimumSequenceNumber;
 
 		this.processMinSequenceNumberChanged(minSeq);
 
@@ -883,35 +846,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		}
 	}
 
-	private loadFinished(error?: any) {
-		if (!this.loadedDeferred.isCompleted) {
-			// Initialize the interval collections
-			this.initializeIntervalCollections();
-			if (error) {
-				this.loadedDeferred.reject(error);
-				throw error;
-			} else {
-				// it is important this series remains synchronous
-				// first we stop deferring incoming ops, and apply then all
-				this.deferIncomingOps = false;
-				for (const message of this.loadedDeferredIncomingOps) {
-					this.processCore(message, false, undefined);
-				}
-				this.loadedDeferredIncomingOps.length = 0;
-
-				// then resolve the loaded promise
-				// and resubmit all the outstanding ops, as the snapshot
-				// is fully loaded, and all outstanding ops are applied
-				this.loadedDeferred.resolve();
-
-				for (const [messageContent, opMetadata] of this.loadedDeferredOutgoingOps) {
-					this.reSubmitCore(messageContent, opMetadata);
-				}
-				this.loadedDeferredOutgoingOps.length = 0;
-			}
-		}
-	}
-
 	private initializeIntervalCollections() {
 		// Listen and initialize new SharedIntervalCollections
 		this.intervalCollections.eventEmitter.on(