@fluidframework/datastore 2.23.0 → 2.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.23.0",
+  "version": "2.31.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,44 +69,45 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.23.0",
-    "@fluidframework/container-definitions": "~2.23.0",
-    "@fluidframework/core-interfaces": "~2.23.0",
-    "@fluidframework/core-utils": "~2.23.0",
-    "@fluidframework/datastore-definitions": "~2.23.0",
-    "@fluidframework/driver-definitions": "~2.23.0",
-    "@fluidframework/driver-utils": "~2.23.0",
-    "@fluidframework/id-compressor": "~2.23.0",
-    "@fluidframework/runtime-definitions": "~2.23.0",
-    "@fluidframework/runtime-utils": "~2.23.0",
-    "@fluidframework/telemetry-utils": "~2.23.0",
+    "@fluid-internal/client-utils": "~2.31.0",
+    "@fluidframework/container-definitions": "~2.31.0",
+    "@fluidframework/core-interfaces": "~2.31.0",
+    "@fluidframework/core-utils": "~2.31.0",
+    "@fluidframework/datastore-definitions": "~2.31.0",
+    "@fluidframework/driver-definitions": "~2.31.0",
+    "@fluidframework/driver-utils": "~2.31.0",
+    "@fluidframework/id-compressor": "~2.31.0",
+    "@fluidframework/runtime-definitions": "~2.31.0",
+    "@fluidframework/runtime-utils": "~2.31.0",
+    "@fluidframework/telemetry-utils": "~2.31.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.23.0",
+    "@fluid-internal/mocha-test-setup": "~2.31.0",
     "@fluid-tools/build-cli": "^0.54.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.54.0",
-    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.22.0",
+    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.30.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@fluidframework/test-runtime-utils": "~2.23.0",
-    "@microsoft/api-extractor": "7.47.8",
+    "@fluidframework/test-runtime-utils": "~2.31.0",
+    "@microsoft/api-extractor": "7.50.1",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
+    "@types/sinon": "^17.0.3",
     "@types/uuid": "^9.0.2",
     "c8": "^8.0.1",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "~8.55.0",
-    "mocha": "^10.2.0",
+    "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
+    "sinon": "^18.0.1",
     "typescript": "~5.4.5"
   },
   "typeValidation": {
@@ -138,7 +139,6 @@
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
-    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
@@ -148,7 +148,6 @@
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
-    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
     "place:cjs:package-stub": "copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",

package/src/channelDeltaConnection.ts

@@ -8,7 +8,6 @@ import {
 	IDeltaConnection,
 	IDeltaHandler,
 } from "@fluidframework/datastore-definitions/internal";
-import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import type {
 	IRuntimeMessageCollection,
 	IRuntimeMessagesContent,
@@ -100,30 +99,20 @@ export class ChannelDeltaConnection implements IDeltaConnection {
 	}
 
 	public processMessages(messageCollection: IRuntimeMessageCollection): void {
-		const { envelope, messagesContent, local } = messageCollection;
 		// catches as data processing error whether or not they come from async pending queues
 		try {
-			const newMessagesContent = getContentsWithStashedOpHandling(messagesContent);
-			if (this.handler.processMessages !== undefined) {
-				this.handler.processMessages({
-					...messageCollection,
-					messagesContent: newMessagesContent,
-				});
-			} else {
-				for (const { contents, localOpMetadata, clientSequenceNumber } of newMessagesContent) {
-					const compatMessage: ISequencedDocumentMessage = {
-						...envelope,
-						contents,
-						clientSequenceNumber,
-					};
-					this.handler.process(compatMessage, local, localOpMetadata);
-				}
-			}
+			const newMessagesContent = getContentsWithStashedOpHandling(
+				messageCollection.messagesContent,
+			);
+			this.handler.processMessages({
+				...messageCollection,
+				messagesContent: newMessagesContent,
+			});
 		} catch (error) {
 			throw DataProcessingError.wrapIfUnrecognized(
 				error,
 				"channelDeltaConnectionFailedToProcessMessages",
-				envelope,
+				messageCollection.envelope,
 			);
 		}
 	}

package/src/dataStoreLayerCompatState.ts

@@ -0,0 +1,85 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import {
+	checkLayerCompatibility,
+	type ILayerCompatDetails,
+	type ILayerCompatSupportRequirements,
+} from "@fluid-internal/client-utils";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+
+import { pkgVersion } from "./packageVersion.js";
+
+/**
+ * The core compatibility details of the DataStore layer that is the same across all layer boundaries.
+ * @internal
+ */
+export const dataStoreCoreCompatDetails = {
+	/**
+	 * The package version of the Runtime layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the Runtime layer.
+	 */
+	generation: 1,
+};
+
+/**
+ * DataStore's compatibility details that is exposed to the Runtime layer.
+ * @internal
+ */
+export const dataStoreCompatDetailsForRuntime: ILayerCompatDetails = {
+	...dataStoreCoreCompatDetails,
+	/**
+	 * The features supported by the DataStore layer across the DataStore / Runtime boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};
+
+/**
+ * The requirements that the Runtime layer must meet to be compatible with this DataStore.
+ * @internal
+ */
+export const runtimeSupportRequirements: ILayerCompatSupportRequirements = {
+	/**
+	 * Minimum generation that Runtime must be at to be compatible with DataStore. Note that 0 is used here so
+	 * that Runtime layers before the introduction of the layer compatibility enforcement are compatible.
+	 */
+	minSupportedGeneration: 0,
+	/**
+	 * The features that the Runtime must support to be compatible with DataStore.
+	 */
+	requiredFeatures: [],
+};
+
+/**
+ * Validates that the Runtime layer is compatible with this DataStore.
+ * @internal
+ */
+export function validateRuntimeCompatibility(
+	maybeRuntimeCompatDetails: ILayerCompatDetails | undefined,
+	disposeFn: () => void,
+): void {
+	const layerCheckResult = checkLayerCompatibility(
+		runtimeSupportRequirements,
+		maybeRuntimeCompatDetails,
+	);
+	if (!layerCheckResult.isCompatible) {
+		const error = new UsageError("DataStore is not compatible with Runtime", {
+			errorDetails: JSON.stringify({
+				dataStoreVersion: dataStoreCoreCompatDetails.pkgVersion,
+				runtimeVersion: maybeRuntimeCompatDetails?.pkgVersion,
+				dataStoreGeneration: dataStoreCoreCompatDetails.generation,
+				runtimeGeneration: maybeRuntimeCompatDetails?.generation,
+				minSupportedGeneration: runtimeSupportRequirements.minSupportedGeneration,
+				isGenerationCompatible: layerCheckResult.isGenerationCompatible,
+				unsupportedFeatures: layerCheckResult.unsupportedFeatures,
+			}),
+		});
+		disposeFn();
+		throw error;
+	}
+}

package/src/dataStoreRuntime.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { TypedEventEmitter, type ILayerCompatDetails } from "@fluid-internal/client-utils";
 import { AttachState, IAudience } from "@fluidframework/container-definitions";
 import { IDeltaManager } from "@fluidframework/container-definitions/internal";
 import {
@@ -88,6 +88,11 @@ import {
 import { v4 as uuid } from "uuid";
 
 import { IChannelContext, summarizeChannel } from "./channelContext.js";
+import {
+	dataStoreCompatDetailsForRuntime,
+	// dataStoreCompatDetailsForRuntime,
+	validateRuntimeCompatibility,
+} from "./dataStoreLayerCompatState.js";
 import { FluidObjectHandle } from "./fluidHandle.js";
 import {
 	LocalChannelContext,
@@ -215,6 +220,15 @@ export class FluidDataStoreRuntime
 	 */
 	private localChangesTelemetryCount: number;
 
+	/**
+	 * The compatibility details of the DataStore layer that is exposed to the Runtime layer
+	 * for validating Runtime-DataStore compatibility.
+	 * @remarks This is for internal use only.
+	 * The type of this should be ILayerCompatDetails. However, ILayerCompatDetails is internal and this class
+	 * is currently marked as legacy alpha. So, using unknown here.
+	 */
+	public readonly ILayerCompatDetails?: unknown = dataStoreCompatDetailsForRuntime;
+
 	/**
 	 * Create an instance of a DataStore runtime.
 	 *
@@ -239,6 +253,13 @@ export class FluidDataStoreRuntime
 			0x30e /* Id cannot contain slashes. DataStoreContext should have validated this. */,
 		);
 
+		// Validate that the Runtime is compatible with this DataStore.
+		const maybeRuntimeCompatDetails = dataStoreContext as FluidObject<ILayerCompatDetails>;
+		validateRuntimeCompatibility(
+			maybeRuntimeCompatDetails.ILayerCompatDetails,
+			this.dispose.bind(this),
+		);
+
 		this.mc = createChildMonitoringContext({
 			logger: dataStoreContext.baseLogger,
 			namespace: "FluidDataStoreRuntime",
@@ -463,7 +484,7 @@ export class FluidDataStoreRuntime
 			 * in the snapshot.
 			 * So, return short ids only if explicitly enabled via feature flags. Else, return uuid();
 			 */
-			if (this.mc.config.getBoolean("Fluid.Runtime.UseShortIds") === true) {
+			if (this.mc.config.getBoolean("Fluid.Runtime.IsShortIdEnabled") === true) {
 				// We use three non-overlapping namespaces:
 				// - detached state: even numbers
 				// - attached state: odd numbers
@@ -788,29 +809,6 @@ export class FluidDataStoreRuntime
 		}
 	}
 
-	/**
-	 * back-compat ADO 21575.
-	 * @deprecated {@link FluidDataStoreRuntime.processMessages} should be used instead to process messages. This is still here for back-compat
-	 * because it exists on IFluidDataStoreChannel. Once it is removed from the interface, this method can be removed.
-	 */
-	public process(
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-	) {
-		this.processMessages({
-			envelope: message,
-			messagesContent: [
-				{
-					contents: message.contents,
-					localOpMetadata,
-					clientSequenceNumber: message.clientSequenceNumber,
-				},
-			],
-			local,
-		});
-	}
-
 	public processSignal(message: IInboundSignalMessage, local: boolean) {
 		this.emit("signal", message, local);
 	}

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.23.0";
+export const pkgVersion = "2.31.0";

package/prettier.config.cjs

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	...require("@fluidframework/build-common/prettier.config.cjs"),
-};