@fluidframework/shared-object-base 2.70.0-361248 → 2.70.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/shared-object-base",
-  "version": "2.70.0-361248",
+  "version": "2.70.0",
   "description": "Fluid base class for shared distributed data structures",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,30 +69,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "2.70.0-361248",
-    "@fluidframework/container-definitions": "2.70.0-361248",
-    "@fluidframework/core-interfaces": "2.70.0-361248",
-    "@fluidframework/core-utils": "2.70.0-361248",
-    "@fluidframework/datastore": "2.70.0-361248",
-    "@fluidframework/datastore-definitions": "2.70.0-361248",
-    "@fluidframework/driver-definitions": "2.70.0-361248",
-    "@fluidframework/id-compressor": "2.70.0-361248",
-    "@fluidframework/runtime-definitions": "2.70.0-361248",
-    "@fluidframework/runtime-utils": "2.70.0-361248",
-    "@fluidframework/telemetry-utils": "2.70.0-361248",
+    "@fluid-internal/client-utils": "~2.70.0",
+    "@fluidframework/container-definitions": "~2.70.0",
+    "@fluidframework/core-interfaces": "~2.70.0",
+    "@fluidframework/core-utils": "~2.70.0",
+    "@fluidframework/datastore": "~2.70.0",
+    "@fluidframework/datastore-definitions": "~2.70.0",
+    "@fluidframework/driver-definitions": "~2.70.0",
+    "@fluidframework/id-compressor": "~2.70.0",
+    "@fluidframework/runtime-definitions": "~2.70.0",
+    "@fluidframework/runtime-utils": "~2.70.0",
+    "@fluidframework/telemetry-utils": "~2.70.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.70.0-361248",
-    "@fluid-private/test-pairwise-generator": "2.70.0-361248",
+    "@fluid-internal/mocha-test-setup": "~2.70.0",
+    "@fluid-private/test-pairwise-generator": "~2.70.0",
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
     "@fluidframework/eslint-config-fluid": "^6.1.0",
     "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@2.63.0",
-    "@fluidframework/test-runtime-utils": "2.70.0-361248",
+    "@fluidframework/test-runtime-utils": "~2.70.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/benchmark": "^2.1.0",
     "@types/mocha": "^10.0.10",

package/src/handle.ts

@@ -5,9 +5,8 @@
 
 import type { IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
 import { FluidObjectHandle } from "@fluidframework/datastore/internal";
-// eslint-disable-next-line import/no-deprecated
-import type { IFluidDataStoreRuntimeExperimental } from "@fluidframework/datastore-definitions/internal";
-import { isFluidHandle } from "@fluidframework/runtime-utils";
+import type { IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions/internal";
+import { isFluidHandle, asLegacyAlpha } from "@fluidframework/runtime-utils/internal";
 
 import type { ISharedObject } from "./types.js";
 
@@ -92,8 +91,7 @@ export class SharedObjectHandle
 	constructor(
 		protected readonly value: ISharedObject,
 		path: string,
-		// eslint-disable-next-line import/no-deprecated
-		private readonly runtime: IFluidDataStoreRuntimeExperimental,
+		private readonly runtime: IFluidDataStoreRuntime,
 	) {
 		super(value, path, runtime.IFluidHandleContext);
 	}
@@ -125,7 +123,7 @@ export class SharedObjectHandle
 		// We don't bind handles in staging mode to defer the attachment of any new objects
 		// until we've exited staging mode. This way if we discard changes or a new handle is not present in the final
 		// committed state, we will never end up attaching the discarded object.
-		if (this.runtime.inStagingMode === true) {
+		if (asLegacyAlpha(this.runtime).inStagingMode === true) {
 			return;
 		}
 

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "2.70.0-361248";
+export const pkgVersion = "2.70.0";

package/src/sharedObject.ts

@@ -178,20 +178,6 @@ export abstract class SharedObjectCore<
 		const { opProcessingHelper, callbacksHelper } = this.setUpSampledTelemetryHelpers();
 		this.opProcessingHelper = opProcessingHelper;
 		this.callbacksHelper = callbacksHelper;
-
-		const processMessagesCore = this.processMessagesCore?.bind(this);
-		this.processMessagesHelper =
-			processMessagesCore === undefined
-				? (messagesCollection: IRuntimeMessageCollection) =>
-						processHelper(messagesCollection, this.process.bind(this))
-				: (messagesCollection: IRuntimeMessageCollection) => {
-						processMessagesCoreHelper(
-							messagesCollection,
-							this.opProcessingHelper,
-							this.emitInternal.bind(this),
-							processMessagesCore,
-						);
-					};
 	}
 
 	/**
@@ -409,25 +395,9 @@ export abstract class SharedObjectCore<
 		return;
 	}
 
-	/**
-	 * Derived classes must override this to do custom processing on a remote message.
-	 * @param message - The message to process
-	 * @param local - True if the shared object is local
-	 * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
-	 * For messages from a remote client, this will be undefined.
-	 *
-	 * @deprecated Replaced by {@link SharedObjectCore.processMessagesCore}.
-	 */
-	protected abstract processCore(
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-	): void;
-
 	/* eslint-disable jsdoc/check-indentation */
 	/**
-	 * Process a 'bunch' of messages for this shared object.
-	 *
+	 * Derived classes must override this to do custom processing on a 'bunch' of remote messages.
 	 * @remarks
 	 * A 'bunch' is a group of messages that have the following properties:
 	 * - They are all part of the same grouped batch, which entails:
@@ -441,16 +411,7 @@ export abstract class SharedObjectCore<
 	 *
 	 */
 	/* eslint-enable jsdoc/check-indentation */
-	protected processMessagesCore?(messagesCollection: IRuntimeMessageCollection): void;
-
-	/**
-	 * Calls {@link SharedObjectCore.processCore} or {@link SharedObjectCore.processMessagesCore} depending on whether
-	 * processMessagesCore is defined. This helper is used to keep the code cleaner while we have to support both these
-	 * function.
-	 */
-	private readonly processMessagesHelper: (
-		messagesCollection: IRuntimeMessageCollection,
-	) => void;
+	protected abstract processMessagesCore(messagesCollection: IRuntimeMessageCollection): void;
 
 	/**
 	 * Called when the object has disconnected from the delta stream.
@@ -628,39 +589,6 @@ export abstract class SharedObjectCore<
 		}
 	}
 
-	/**
-	 * Handles a message being received from the remote delta server.
-	 * @param message - The message to process
-	 * @param local - Whether the message originated from the local client
-	 * @param localOpMetadata - For local client messages, this is the metadata that was submitted with the message.
-	 * For messages from a remote client, this will be undefined.
-	 *
-	 * @deprecated Replaced by {@link SharedObjectCore.processMessages}.
-	 */
-	private process(
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-	): void {
-		this.verifyNotClosed(); // This will result in container closure.
-		this.emitInternal("pre-op", message, local, this);
-
-		this.opProcessingHelper.measure(
-			(): ICustomData<ProcessTelemetryProperties> => {
-				this.processCore(message, local, localOpMetadata);
-				const telemetryProperties: ProcessTelemetryProperties = {
-					sequenceDifference: message.sequenceNumber - message.referenceSequenceNumber,
-				};
-				return {
-					customData: telemetryProperties,
-				};
-			},
-			local ? "local" : "remote",
-		);
-
-		this.emitInternal("op", message, local, this);
-	}
-
 	/* eslint-disable jsdoc/check-indentation */
 	/**
 	 * Process a bunch of messages for this shared object. A bunch is group of messages that have the following properties:
@@ -677,13 +605,11 @@ export abstract class SharedObjectCore<
 	private processMessages(messagesCollection: IRuntimeMessageCollection): void {
 		this.verifyNotClosed(); // This will result in container closure.
 
+		const { envelope, local, messagesContent } = messagesCollection;
+
 		// Decode any handles in the contents before processing the messages.
 		const decodedMessagesContent: IRuntimeMessagesContent[] = [];
-		for (const {
-			contents,
-			localOpMetadata,
-			clientSequenceNumber,
-		} of messagesCollection.messagesContent) {
+		for (const { contents, localOpMetadata, clientSequenceNumber } of messagesContent) {
 			const decodedMessageContent: IRuntimeMessagesContent = {
 				contents: parseHandles(contents, this.serializer),
 				localOpMetadata,
@@ -692,11 +618,36 @@ export abstract class SharedObjectCore<
 			decodedMessagesContent.push(decodedMessageContent);
 		}
 
-		const decodedMessagesCollection: IRuntimeMessageCollection = {
-			...messagesCollection,
-			messagesContent: decodedMessagesContent,
+		const emitEvents = (event: "pre-op" | "op"): void => {
+			for (const { contents, clientSequenceNumber } of decodedMessagesContent) {
+				const message: ISequencedDocumentMessage = {
+					...envelope,
+					contents,
+					clientSequenceNumber,
+				};
+				this.emitInternal(event, message, local);
+			}
 		};
-		this.processMessagesHelper(decodedMessagesCollection);
+
+		emitEvents("pre-op");
+		this.opProcessingHelper.measure(
+			(): ICustomData<ProcessTelemetryProperties> => {
+				const decodedMessagesCollection: IRuntimeMessageCollection = {
+					envelope,
+					local,
+					messagesContent: decodedMessagesContent,
+				};
+				this.processMessagesCore(decodedMessagesCollection);
+				const telemetryProperties: ProcessTelemetryProperties = {
+					sequenceDifference: envelope.sequenceNumber - envelope.referenceSequenceNumber,
+				};
+				return {
+					customData: telemetryProperties,
+				};
+			},
+			local ? "local" : "remote",
+		);
+		emitEvents("op");
 	}
 
 	/**
@@ -1070,75 +1021,3 @@ function isChannel(loadable: IFluidLoadable): loadable is IChannel {
 	// This assumes no other IFluidLoadable has an `attributes` field, and thus may not be fully robust.
 	return (loadable as IChannel).attributes !== undefined;
 }
-
-/**
- * Utility that processes the given messages in the message collection together by calling `processMessagesCore`.
- * This will be called when {@link SharedObjectCore.processMessagesCore} is defined.
- */
-function processMessagesCoreHelper(
-	messagesCollection: IRuntimeMessageCollection,
-	opProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>,
-	emitInternal: (
-		event: "pre-op" | "op",
-		op: ISequencedDocumentMessage,
-		local: boolean,
-	) => void,
-	processMessagesCore: (messagesCollection: IRuntimeMessageCollection) => void,
-): void {
-	const { envelope, local, messagesContent } = messagesCollection;
-
-	const emitEvents = (
-		event: "pre-op" | "op",
-		messagesContentForEvent: readonly IRuntimeMessagesContent[],
-	): void => {
-		for (const { contents, clientSequenceNumber } of messagesContentForEvent) {
-			const message: ISequencedDocumentMessage = {
-				...envelope,
-				contents,
-				clientSequenceNumber,
-			};
-			emitInternal(event, message, local);
-		}
-	};
-
-	emitEvents("pre-op", messagesContent);
-	opProcessingHelper.measure(
-		(): ICustomData<ProcessTelemetryProperties> => {
-			processMessagesCore(messagesCollection);
-			const telemetryProperties: ProcessTelemetryProperties = {
-				sequenceDifference: envelope.sequenceNumber - envelope.referenceSequenceNumber,
-			};
-			return {
-				customData: telemetryProperties,
-			};
-		},
-		local ? "local" : "remote",
-	);
-	emitEvents("op", messagesContent);
-}
-
-/**
- * Utility that processes the given messages in the message collection one by one by calling `process`. This will
- * be called when {@link SharedObjectCore.processMessagesCore} is not defined.
- */
-function processHelper(
-	messagesCollection: IRuntimeMessageCollection,
-	process: (
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-	) => void,
-): void {
-	const { envelope, local, messagesContent } = messagesCollection;
-	for (const { contents, localOpMetadata, clientSequenceNumber } of messagesContent) {
-		process(
-			{
-				...envelope,
-				contents,
-				clientSequenceNumber,
-			},
-			local,
-			localOpMetadata,
-		);
-	}
-}

package/src/sharedObjectKernel.ts

@@ -203,10 +203,6 @@ class SharedObjectFromKernel<
 		this.#kernel.applyStashedOp(content);
 	}
 
-	protected override processCore(): void {
-		fail("processCore should not be called");
-	}
-
 	protected override processMessagesCore(messagesCollection: IRuntimeMessageCollection): void {
 		this.#kernel.processMessagesCore(messagesCollection);
 	}