@fluidframework/datastore 2.70.0-361788 → 2.71.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.70.0-361788",
+  "version": "2.71.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,29 +69,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@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/driver-utils": "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/telemetry-utils": "2.70.0-361788",
+    "@fluid-internal/client-utils": "~2.71.0",
+    "@fluidframework/container-definitions": "~2.71.0",
+    "@fluidframework/core-interfaces": "~2.71.0",
+    "@fluidframework/core-utils": "~2.71.0",
+    "@fluidframework/datastore-definitions": "~2.71.0",
+    "@fluidframework/driver-definitions": "~2.71.0",
+    "@fluidframework/driver-utils": "~2.71.0",
+    "@fluidframework/id-compressor": "~2.71.0",
+    "@fluidframework/runtime-definitions": "~2.71.0",
+    "@fluidframework/runtime-utils": "~2.71.0",
+    "@fluidframework/telemetry-utils": "~2.71.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.70.0-361788",
+    "@fluid-internal/mocha-test-setup": "~2.71.0",
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
-    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.63.0",
-    "@fluidframework/eslint-config-fluid": "^6.1.0",
-    "@fluidframework/test-runtime-utils": "2.70.0-361788",
+    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.70.0",
+    "@fluidframework/eslint-config-fluid": "^7.0.0",
+    "@fluidframework/test-runtime-utils": "~2.71.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^10.0.10",
@@ -109,14 +109,7 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {
-      "Class_FluidDataStoreRuntime": {
-        "backCompat": false
-      },
-      "ClassStatics_FluidDataStoreRuntime": {
-        "backCompat": false
-      }
-    },
+    "broken": {},
     "entrypoint": "legacy"
   },
   "scripts": {
@@ -149,8 +142,8 @@
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib {alpha,beta,internal,legacy}.d.ts \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
-    "eslint": "eslint --format stylish src",
-    "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
+    "eslint": "eslint --quiet --format stylish src",
+    "eslint:fix": "eslint --quiet --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
     "lint": "fluid-build . --task lint",

package/src/dataStoreRuntime.ts

@@ -29,8 +29,7 @@ import type {
 	IFluidDataStoreRuntime,
 	IFluidDataStoreRuntimeEvents,
 	IDeltaManagerErased,
-	// eslint-disable-next-line import/no-deprecated
-	IFluidDataStoreRuntimeExperimental,
+	IFluidDataStoreRuntimeAlpha,
 } from "@fluidframework/datastore-definitions/internal";
 import {
 	type IClientDetails,
@@ -61,12 +60,11 @@ import {
 	type IInboundSignalMessage,
 	type IRuntimeMessageCollection,
 	type IRuntimeMessagesContent,
-	// eslint-disable-next-line import/no-deprecated
-	type IContainerRuntimeBaseExperimental,
 	notifiesReadOnlyState,
 	encodeHandlesInContainerRuntime,
 	type IFluidDataStorePolicies,
 	type MinimumVersionForCollab,
+	asLegacyAlpha,
 } from "@fluidframework/runtime-definitions/internal";
 import {
 	GCDataBuilder,
@@ -137,6 +135,17 @@ export enum DataStoreMessageType {
 	ChannelOp = "op",
 }
 
+/**
+ * Outgoing {@link FluidDataStoreRuntime} message structures.
+ * @internal
+ *
+ * @privateRemarks
+ * The types here are required to satisfy {@link @fluidframework/runtime-definitions#FluidDataStoreMessage} interface.
+ */
+export type LocalFluidDataStoreRuntimeMessage =
+	| { type: DataStoreMessageType.ChannelOp; content: IEnvelope }
+	| { type: DataStoreMessageType.Attach; content: IAttachMessage };
+
 /**
  * @legacy @beta
  */
@@ -328,6 +337,7 @@ export class FluidDataStoreRuntime
 			namespace: "FluidDataStoreRuntime",
 			properties: {
 				all: { dataStoreId: uuid(), dataStoreVersion: pkgVersion },
+				error: { inStagingMode: () => this.inStagingMode, isDirty: () => this.isDirty },
 			},
 		});
 
@@ -447,31 +457,20 @@ export class FluidDataStoreRuntime
 		this.localChangesTelemetryCount =
 			this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount") ?? 10;
 
-		// Reference these properties to avoid unused private member errors.
-		// They're accessed via IFluidDataStoreRuntimeExperimental interface.
-		// eslint-disable-next-line no-void
-		void [this.inStagingMode, this.isDirty];
-
 		this.minVersionForCollab = this.dataStoreContext.minVersionForCollab;
 	}
 
 	/**
-	 * Implementation of IFluidDataStoreRuntimeExperimental.inStagingMode
+	 * Implementation of IFluidDataStoreRuntimeAlpha.inStagingMode
 	 */
-	// eslint-disable-next-line import/no-deprecated
-	private get inStagingMode(): IFluidDataStoreRuntimeExperimental["inStagingMode"] {
-		return (
-			// eslint-disable-next-line import/no-deprecated
-			(this.dataStoreContext.containerRuntime as IContainerRuntimeBaseExperimental)
-				?.inStagingMode
-		);
+	private get inStagingMode(): IFluidDataStoreRuntimeAlpha["inStagingMode"] {
+		return asLegacyAlpha(this.dataStoreContext.containerRuntime)?.inStagingMode;
 	}
 
 	/**
-	 * Implementation of IFluidDataStoreRuntimeExperimental.isDirty
+	 * Implementation of IFluidDataStoreRuntimeAlpha.isDirty
 	 */
-	// eslint-disable-next-line import/no-deprecated
-	private get isDirty(): IFluidDataStoreRuntimeExperimental["isDirty"] {
+	private get isDirty(): IFluidDataStoreRuntimeAlpha["isDirty"] {
 		return this.pendingOpCount.value > 0;
 	}
 
@@ -1229,7 +1228,7 @@ export class FluidDataStoreRuntime
 			type: channel.attributes.type,
 		};
 		this.pendingAttach.add(channel.id);
-		this.submit(DataStoreMessageType.Attach, message);
+		this.submit({ type: DataStoreMessageType.Attach, content: message });
 
 		const context = this.contexts.get(channel.id) as LocalChannelContextBase;
 		context.makeVisible();
@@ -1237,7 +1236,8 @@ export class FluidDataStoreRuntime
 
 	private submitChannelOp(address: string, contents: unknown, localOpMetadata: unknown): void {
 		const envelope: IEnvelope = { address, contents };
-		this.submit(DataStoreMessageType.ChannelOp, envelope, localOpMetadata);
+		this.verifyNotClosed();
+		this.submit({ type: DataStoreMessageType.ChannelOp, content: envelope }, localOpMetadata);
 	}
 
 	/**
@@ -1247,12 +1247,10 @@ export class FluidDataStoreRuntime
 	private readonly pendingOpCount: { value: number } = initializePendingOpCount();
 
 	private submit(
-		type: DataStoreMessageType,
-		content: unknown,
+		message: LocalFluidDataStoreRuntimeMessage,
 		localOpMetadata: unknown = undefined,
 	): void {
-		this.verifyNotClosed();
-		this.dataStoreContext.submitMessage(type, content, localOpMetadata);
+		this.dataStoreContext.submitMessage(message.type, message.content, localOpMetadata);
 		++this.pendingOpCount.value;
 	}
 
@@ -1262,6 +1260,14 @@ export class FluidDataStoreRuntime
 	 * This typically happens when we reconnect and there are unacked messages.
 	 * @param content - The content of the original message.
 	 * @param localOpMetadata - The local metadata associated with the original message.
+	 *
+	 * @privateRemarks
+	 * `type` parameter's type of `DataStoreMessageType` is a covariance exception
+	 * over `string` that `IFluidDataStoreChannel` specifies. So long as local
+	 * submissions conform to this type all is well. (`unreachableCase` might be
+	 * reachable over time without better typing in this area if a mistake is made.)
+	 * See {@link @fluidframework/runtime-definitions#FluidDataStoreMessage} comment
+	 * for opportunity to resolve this.
 	 */
 	public reSubmit(
 		type: DataStoreMessageType,
@@ -1289,7 +1295,8 @@ export class FluidDataStoreRuntime
 			}
 			case DataStoreMessageType.Attach: {
 				// For Attach messages, just submit them again.
-				this.submit(type, content, localOpMetadata);
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- `content` needs typed better than `any`
+				this.submit({ type, content }, localOpMetadata);
 				break;
 			}
 			default: {
@@ -1302,6 +1309,14 @@ export class FluidDataStoreRuntime
 	 * Revert a local op.
 	 * @param content - The content of the original message.
 	 * @param localOpMetadata - The local metadata associated with the original message.
+	 *
+	 * @privateRemarks
+	 * `type` parameter's type of `DataStoreMessageType` is a covariance exception
+	 * over `string` that `IFluidDataStoreChannel` specifies. So long as local
+	 * submissions conform to this type all is well. (`unreachableCase` might be
+	 * reachable over time without better typing in this area if a mistake is made.)
+	 * See {@link @fluidframework/runtime-definitions#FluidDataStoreMessage} comment
+	 * for opportunity to resolve this.
 	 */
 	public rollback?(
 		type: DataStoreMessageType,

package/src/index.ts

@@ -8,6 +8,7 @@ export {
 	DataStoreMessageType,
 	FluidDataStoreRuntime,
 	type ISharedObjectRegistry,
+	type LocalFluidDataStoreRuntimeMessage,
 	mixinRequestHandler,
 	mixinSummaryHandler,
 } from "./dataStoreRuntime.js";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.70.0-361788";
+export const pkgVersion = "2.71.0";