@fluid-experimental/tree 2.70.0-361092 → 2.70.0-361788

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-experimental/tree",
-  "version": "2.70.0-361092",
+  "version": "2.70.0-361788",
   "description": "Distributed tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -27,18 +27,18 @@
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "dependencies": {
-    "@fluid-internal/client-utils": "2.70.0-361092",
-    "@fluidframework/container-definitions": "2.70.0-361092",
-    "@fluidframework/core-interfaces": "2.70.0-361092",
-    "@fluidframework/core-utils": "2.70.0-361092",
-    "@fluidframework/datastore-definitions": "2.70.0-361092",
-    "@fluidframework/driver-definitions": "2.70.0-361092",
-    "@fluidframework/id-compressor": "2.70.0-361092",
-    "@fluidframework/runtime-definitions": "2.70.0-361092",
-    "@fluidframework/runtime-utils": "2.70.0-361092",
-    "@fluidframework/shared-object-base": "2.70.0-361092",
-    "@fluidframework/telemetry-utils": "2.70.0-361092",
-    "@fluidframework/tree": "2.70.0-361092",
+    "@fluid-internal/client-utils": "2.70.0-361788",
+    "@fluidframework/container-definitions": "2.70.0-361788",
+    "@fluidframework/core-interfaces": "2.70.0-361788",
+    "@fluidframework/core-utils": "2.70.0-361788",
+    "@fluidframework/datastore-definitions": "2.70.0-361788",
+    "@fluidframework/driver-definitions": "2.70.0-361788",
+    "@fluidframework/id-compressor": "2.70.0-361788",
+    "@fluidframework/runtime-definitions": "2.70.0-361788",
+    "@fluidframework/runtime-utils": "2.70.0-361788",
+    "@fluidframework/shared-object-base": "2.70.0-361788",
+    "@fluidframework/telemetry-utils": "2.70.0-361788",
+    "@fluidframework/tree": "2.70.0-361788",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "buffer": "^6.0.3",
     "denque": "^1.5.1",
@@ -48,20 +48,20 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.70.0-361092",
-    "@fluid-private/stochastic-test-utils": "2.70.0-361092",
-    "@fluid-private/test-drivers": "2.70.0-361092",
+    "@fluid-internal/mocha-test-setup": "2.70.0-361788",
+    "@fluid-private/stochastic-test-utils": "2.70.0-361788",
+    "@fluid-private/test-drivers": "2.70.0-361788",
     "@fluid-tools/benchmark": "^0.51.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/container-definitions": "2.70.0-361092",
-    "@fluidframework/container-loader": "2.70.0-361092",
-    "@fluidframework/container-runtime": "2.70.0-361092",
+    "@fluidframework/container-definitions": "2.70.0-361788",
+    "@fluidframework/container-loader": "2.70.0-361788",
+    "@fluidframework/container-runtime": "2.70.0-361788",
     "@fluidframework/eslint-config-fluid": "^6.1.0",
-    "@fluidframework/runtime-utils": "2.70.0-361092",
-    "@fluidframework/test-runtime-utils": "2.70.0-361092",
-    "@fluidframework/test-utils": "2.70.0-361092",
-    "@fluidframework/undo-redo": "2.70.0-361092",
+    "@fluidframework/runtime-utils": "2.70.0-361788",
+    "@fluidframework/test-runtime-utils": "2.70.0-361788",
+    "@fluidframework/test-utils": "2.70.0-361788",
+    "@fluidframework/undo-redo": "2.70.0-361788",
     "@microsoft/api-extractor": "7.52.11",
     "@types/chai": "^4.0.0",
     "@types/lru-cache": "^5.1.0",

package/src/SharedTree.ts

@@ -14,8 +14,12 @@ import {
 	IChannelServices,
 	IChannelStorageService,
 } from '@fluidframework/datastore-definitions/internal';
-import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
-import { ISummaryTreeWithStats, ITelemetryContext } from '@fluidframework/runtime-definitions/internal';
+import {
+	ISummaryTreeWithStats,
+	ITelemetryContext,
+	type IRuntimeMessageCollection,
+	type ISequencedMessageEnvelope,
+} from '@fluidframework/runtime-definitions/internal';
 import {
 	IFluidSerializer,
 	ISharedObjectEvents,
@@ -212,8 +216,8 @@ export class SharedTreeFactory implements IChannelFactory {
 
 	/**
 	 * Get a factory for SharedTree to register with the data store.
-	 * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
-	 * documentation](../docs/Write-Format.md) for more information.
+	 * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See {@link https://github.com/microsoft/FluidFramework/blob/main/experimental/dds/tree/docs/Write-Format.md | the write format
+	 * documentation} for more information.
 	 * @param options - Configuration options for this tree
 	 * @returns A factory that creates `SharedTree`s and loads them from storage.
 	 */
@@ -379,7 +383,7 @@ export interface StashedLocalOpMetadata {
 const stashedSessionId = '8477b8d5-cf6c-4673-8345-8f076a8f9bc6' as SessionId;
 
 /**
- * A [distributed tree](../Readme.md).
+ * A {@link https://github.com/microsoft/FluidFramework/blob/main/experimental/dds/tree/README.md | distributed tree}.
  * @alpha
  */
 export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeIdContext {
@@ -397,7 +401,7 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 	 * that was initialized with a newer write version connects to the session. Care must be taken when changing this value,
 	 * as a staged rollout must of occurred such that all collaborating clients must have the code to read at least the version
 	 * written.
-	 * See [the write format documentation](../docs/Write-Format.md) for more information.
+	 * See {@link https://github.com/microsoft/FluidFramework/blob/main/experimental/dds/tree/docs/Write-Format.md | the write format documentation} for more information.
 	 * @param options - Configuration options for this tree
 	 * @returns A factory that creates `SharedTree`s and loads them from storage.
 	 */
@@ -530,8 +534,8 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 	 * Create a new SharedTree.
 	 * @param runtime - The runtime the SharedTree will be associated with
 	 * @param id - Unique ID for the SharedTree
-	 * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See [the write format
-	 * documentation](../docs/Write-Format.md) for more information.
+	 * @param writeFormat - Determines the format version the SharedTree will write ops and summaries in. See {@link https://github.com/microsoft/FluidFramework/blob/main/experimental/dds/tree/docs/Write-Format.md | the write format
+	 * documentation} for more information.
 	 * @param options - Configuration options for this tree
 	 */
 	public constructor(runtime: IFluidDataStoreRuntime, id: string, ...args: SharedTreeArgs<WriteFormat.v0_0_2>);
@@ -995,14 +999,19 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 	}
 
 	/**
-	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}
+	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processMessagesCore}
 	 */
-	protected processCore(message: unknown, local: boolean): void {
-		const typedMessage = message as Omit<ISequencedDocumentMessage, 'contents'> & {
-			contents: SharedTreeOp_0_0_2 | SharedTreeOp;
-		};
-		this.cachingLogViewer.setMinimumSequenceNumber(typedMessage.minimumSequenceNumber);
-		const op = typedMessage.contents;
+	protected processMessagesCore(messagesCollection: IRuntimeMessageCollection): void {
+		const { envelope, messagesContent } = messagesCollection;
+		for (const messageContent of messagesContent) {
+			this.processMessage(envelope, messageContent.contents);
+		}
+	}
+
+	private processMessage(messageEnvelope: ISequencedMessageEnvelope, contents: unknown): void {
+		const typedContents = contents as SharedTreeOp_0_0_2 | SharedTreeOp;
+		this.cachingLogViewer.setMinimumSequenceNumber(messageEnvelope.minimumSequenceNumber);
+		const op = typedContents;
 		if (op.version === undefined) {
 			// Back-compat: some legacy documents may contain trailing ops with an unstamped version; normalize them.
 			(op as { version: WriteFormat | undefined }).version = WriteFormat.v0_0_2;
@@ -1024,7 +1033,7 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 				if (op.version === WriteFormat.v0_1_1) {
 					this.internStringsFromEdit(edit);
 				}
-				this.processSequencedEdit(edit, typedMessage);
+				this.processSequencedEdit(edit, messageEnvelope);
 			}
 		} else if (type === SharedTreeOpType.Update) {
 			this.processVersionUpdate(op.version);
@@ -1071,7 +1080,7 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 		}
 	}
 
-	private processSequencedEdit(edit: Edit<ChangeInternal>, message: ISequencedDocumentMessage): void {
+	private processSequencedEdit(edit: Edit<ChangeInternal>, messageEnvelope: ISequencedMessageEnvelope): void {
 		const { id: editId } = edit;
 		const wasLocalEdit = this.editLog.isLocalEdit(editId);
 
@@ -1086,9 +1095,9 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 		}
 
 		if (wasLocalEdit) {
-			this.editLog.addSequencedEdit(edit, message);
+			this.editLog.addSequencedEdit(edit, messageEnvelope);
 		} else {
-			this.applyEditLocally(edit, message);
+			this.applyEditLocally(edit, messageEnvelope);
 		}
 	}
 
@@ -1311,10 +1320,10 @@ export class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeI
 		}
 	}
 
-	private applyEditLocally(edit: Edit<ChangeInternal>, message: ISequencedDocumentMessage | undefined): void {
-		const isSequenced = message !== undefined;
+	private applyEditLocally(edit: Edit<ChangeInternal>, messageEnvelope: ISequencedMessageEnvelope | undefined): void {
+		const isSequenced = messageEnvelope !== undefined;
 		if (isSequenced) {
-			this.editLog.addSequencedEdit(edit, message);
+			this.editLog.addSequencedEdit(edit, messageEnvelope);
 		} else {
 			this.editLog.addLocalEdit(edit);
 		}

package/src/migration-shim/migrationShim.ts

@@ -265,7 +265,7 @@ export class MigrationShim extends EventEmitterWithErrorHandling<IMigrationEvent
 	 * twice, we will be in a "v2" state even though we really are in a "v1" state. We will encounter unexpected op
 	 * dropping behavior or lack thereof and may corrupt the document.
 	 * @param services - the services to generate the shim services from
-	 * @returns - shim services
+	 * @returns shim services
 	 */
 	private generateShimServicesOnce(services: IChannelServices): IShimChannelServices {
 		assert(