@fluidframework/datastore 2.32.0 → 2.33.0

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.50.1"
+      "packageVersion": "7.52.5"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.32.0",
+  "version": "2.33.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,30 +69,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.32.0",
-    "@fluidframework/container-definitions": "~2.32.0",
-    "@fluidframework/core-interfaces": "~2.32.0",
-    "@fluidframework/core-utils": "~2.32.0",
-    "@fluidframework/datastore-definitions": "~2.32.0",
-    "@fluidframework/driver-definitions": "~2.32.0",
-    "@fluidframework/driver-utils": "~2.32.0",
-    "@fluidframework/id-compressor": "~2.32.0",
-    "@fluidframework/runtime-definitions": "~2.32.0",
-    "@fluidframework/runtime-utils": "~2.32.0",
-    "@fluidframework/telemetry-utils": "~2.32.0",
+    "@fluid-internal/client-utils": "~2.33.0",
+    "@fluidframework/container-definitions": "~2.33.0",
+    "@fluidframework/core-interfaces": "~2.33.0",
+    "@fluidframework/core-utils": "~2.33.0",
+    "@fluidframework/datastore-definitions": "~2.33.0",
+    "@fluidframework/driver-definitions": "~2.33.0",
+    "@fluidframework/driver-utils": "~2.33.0",
+    "@fluidframework/id-compressor": "~2.33.0",
+    "@fluidframework/runtime-definitions": "~2.33.0",
+    "@fluidframework/runtime-utils": "~2.33.0",
+    "@fluidframework/telemetry-utils": "~2.33.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.32.0",
+    "@fluid-internal/mocha-test-setup": "~2.33.0",
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
-    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.31.0",
+    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.32.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@fluidframework/test-runtime-utils": "~2.32.0",
-    "@microsoft/api-extractor": "7.50.1",
+    "@fluidframework/test-runtime-utils": "~2.33.0",
+    "@microsoft/api-extractor": "7.52.5",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
@@ -105,13 +105,16 @@
     "eslint": "~8.55.0",
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
-    "moment": "^2.21.0",
     "rimraf": "^4.4.0",
     "sinon": "^18.0.1",
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Class_FluidDataStoreRuntime": {
+        "forwardCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/dataStoreRuntime.ts

@@ -16,6 +16,7 @@ import { IFluidHandleContext } from "@fluidframework/core-interfaces/internal";
 import type { IFluidHandleInternal } from "@fluidframework/core-interfaces/internal";
 import {
 	assert,
+	debugAssert,
 	Deferred,
 	LazyPromise,
 	unreachableCase,
@@ -56,6 +57,10 @@ import {
 	IInboundSignalMessage,
 	type IRuntimeMessageCollection,
 	type IRuntimeMessagesContent,
+	// eslint-disable-next-line import/no-deprecated
+	type IContainerRuntimeBaseExperimental,
+	notifiesReadOnlyState,
+	encodeHandlesInContainerRuntime,
 } from "@fluidframework/runtime-definitions/internal";
 import {
 	GCDataBuilder,
@@ -102,6 +107,22 @@ import {
 import { pkgVersion } from "./packageVersion.js";
 import { RemoteChannelContext } from "./remoteChannelContext.js";
 
+type PickRequired<T extends Record<never, unknown>, K extends keyof T> = Omit<T, K> &
+	Required<Pick<T, K>>;
+
+interface IFluidDataStoreContextFeaturesToTypes {
+	[encodeHandlesInContainerRuntime]: IFluidDataStoreContext; // No difference in typing with this feature
+	[notifiesReadOnlyState]: PickRequired<IFluidDataStoreContext, "isReadOnly">;
+}
+
+function contextSupportsFeature<K extends keyof IFluidDataStoreContextFeaturesToTypes>(
+	obj: IFluidDataStoreContext,
+	feature: K,
+): obj is IFluidDataStoreContextFeaturesToTypes[K] {
+	const { ILayerCompatDetails } = obj as FluidObject<ILayerCompatDetails>;
+	return ILayerCompatDetails?.supportedFeatures.has(feature) ?? false;
+}
+
 /**
  * @legacy
  * @alpha
@@ -140,6 +161,11 @@ export class FluidDataStoreRuntime
 		return this.dataStoreContext.connected;
 	}
 
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.isReadOnly}
+	 */
+	public readonly isReadOnly = (): boolean => this._readonly;
+
 	public get clientId(): string | undefined {
 		return this.dataStoreContext.clientId;
 	}
@@ -229,6 +255,15 @@ export class FluidDataStoreRuntime
 	 */
 	public readonly ILayerCompatDetails?: unknown = dataStoreCompatDetailsForRuntime;
 
+	/**
+	 * See IFluidDataStoreRuntimeInternalConfig.submitMessagesWithoutEncodingHandles
+	 *
+	 * Note: this class doesn't declare that it implements IFluidDataStoreRuntimeInternalConfig,
+	 * and we keep this property as private, but consumers may optimistically cast
+	 * to the internal interface to access this property.
+	 */
+	private readonly submitMessagesWithoutEncodingHandles: boolean;
+
 	/**
 	 * Create an instance of a DataStore runtime.
 	 *
@@ -254,11 +289,25 @@ export class FluidDataStoreRuntime
 		);
 
 		// Validate that the Runtime is compatible with this DataStore.
-		const maybeRuntimeCompatDetails = dataStoreContext as FluidObject<ILayerCompatDetails>;
-		validateRuntimeCompatibility(
-			maybeRuntimeCompatDetails.ILayerCompatDetails,
-			this.dispose.bind(this),
+		const { ILayerCompatDetails: runtimeCompatDetails } =
+			dataStoreContext as FluidObject<ILayerCompatDetails>;
+		validateRuntimeCompatibility(runtimeCompatDetails, this.dispose.bind(this));
+
+		if (contextSupportsFeature(dataStoreContext, notifiesReadOnlyState)) {
+			this._readonly = dataStoreContext.isReadOnly();
+		} else {
+			this._readonly = this.dataStoreContext.deltaManager.readOnlyInfo.readonly === true;
+			this.dataStoreContext.deltaManager.on("readonly", (readonly) =>
+				this.notifyReadOnlyState(readonly),
+			);
+		}
+
+		this.submitMessagesWithoutEncodingHandles = contextSupportsFeature(
+			dataStoreContext,
+			encodeHandlesInContainerRuntime,
 		);
+		// We read this property here to avoid a compiler error (unused private member)
+		debugAssert(() => this.submitMessagesWithoutEncodingHandles !== undefined);
 
 		this.mc = createChildMonitoringContext({
 			logger: dataStoreContext.baseLogger,
@@ -356,6 +405,18 @@ export class FluidDataStoreRuntime
 		// By default, a data store can log maximum 10 local changes telemetry in summarizer.
 		this.localChangesTelemetryCount =
 			this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount") ?? 10;
+
+		// eslint-disable-next-line import/no-deprecated
+		const base: IContainerRuntimeBaseExperimental | undefined =
+			// eslint-disable-next-line import/no-deprecated
+			this.dataStoreContext.containerRuntime satisfies IContainerRuntimeBaseExperimental;
+		if (base !== undefined && "inStagingMode" in base) {
+			Object.defineProperty(this, "inStagingMode", {
+				get: () => {
+					return base.inStagingMode;
+				},
+			});
+		}
 	}
 
 	get deltaManager(): IDeltaManagerErased {
@@ -640,6 +701,20 @@ export class FluidDataStoreRuntime
 		raiseConnectedEvent(this.logger, this, connected, clientId);
 	}
 
+	private _readonly: boolean;
+	/**
+	 * This function is used by the datastore context to configure the
+	 * readonly state of this object. It should not be invoked by
+	 * any other callers.
+	 */
+	public notifyReadOnlyState(readonly: boolean): void {
+		this.verifyNotClosed();
+		if (readonly !== this._readonly) {
+			this._readonly = readonly;
+			this.emit("readonly", readonly);
+		}
+	}
+
 	public getQuorum(): IQuorumClients {
 		return this.quorum;
 	}

package/src/packageVersion.ts

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