Runtime: Expose readonly directly off the datastore runtime

packages/runtime/container-runtime/src/channelCollection.ts

@@ -149,7 +149,7 @@ export function wrapContext(context: IFluidParentContext): IFluidParentContext {
 		get attachState() {
 			return context.attachState;
 		},
-		get readonly() {
+		get readonly(): boolean | undefined {
 			return context.readonly;
 		},
 		containerRuntime: context.containerRuntime,
@@ -1120,12 +1120,12 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 	}
 
 	/**
-	 * Enumerates the contexts and calls setReadOnlyState on them.
+	 * Enumerates the contexts and calls notifyReadOnlyState on them.
 	 */
-	public setReadOnlyState(readonly: boolean): void {
+	public notifyReadOnlyState(readonly: boolean): void {
 		for (const [fluidDataStoreId, context] of this.contexts) {
 			try {
-				context.setReadOnlyState(readonly);
+				context.notifyReadOnlyState(readonly);
 			} catch (error) {
 				this.mc.logger.sendErrorEvent(
 					{

packages/runtime/container-runtime/src/containerRuntime.ts

@@ -1723,7 +1723,7 @@ export class ContainerRuntime
 			new Map<string, string>(dataStoreAliasMap),
 			async (runtime: ChannelCollection) => provideEntryPoint,
 		);
-		this._deltaManager.on("readonly", (readonly) => this.setReadOnlyState(readonly));
+		this._deltaManager.on("readonly", (readonly) => this.notifyReadOnlyState(readonly));
 
 		this.blobManager = new BlobManager({
 			routeContext: this.handleContext,
@@ -2565,8 +2565,8 @@ export class ContainerRuntime
 		return this._loadIdCompressor;
 	}
 
-	public setReadOnlyState(readonly: boolean): void {
-		this.channelCollection.setReadOnlyState(readonly);
+	public notifyReadOnlyState(readonly: boolean): void {
+		this.channelCollection.notifyReadOnlyState(readonly);
 	}
 
 	public setConnectionState(connected: boolean, clientId?: string): void {

packages/runtime/container-runtime/src/dataStoreContext.ts

@@ -686,10 +686,10 @@ export abstract class FluidDataStoreContext
 		this.channel!.setConnectionState(connected, clientId);
 	}
 
-	public setReadOnlyState(readonly: boolean): void {
-		this.verifyNotClosed("setReadOnlyState", false /* checkTombstone */);
+	public notifyReadOnlyState(readonly: boolean): void {
+		this.verifyNotClosed("notifyReadOnlyState", false /* checkTombstone */);
 
-		this.channel?.setReadOnlyState?.(readonly);
+		this.channel?.notifyReadOnlyState?.(readonly);
 		this._contextDeltaManagerProxy.setReadonly(readonly);
 	}
 

packages/runtime/container-runtime/src/runtimeLayerCompatState.ts

@@ -11,7 +11,7 @@ import {
 import type { ICriticalContainerError } from "@fluidframework/container-definitions";
 import {
 	encodeHandlesInContainerRuntime,
-	setReadOnlyState,
+	notifiesReadOnlyState,
 } from "@fluidframework/runtime-definitions/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
@@ -69,7 +69,7 @@ export const runtimeCompatDetailsForDataStore: ILayerCompatDetails = {
 	/**
 	 * The features supported by the Runtime layer across the Runtime / DataStore boundary.
 	 */
-	supportedFeatures: new Set<string>([encodeHandlesInContainerRuntime, setReadOnlyState]),
+	supportedFeatures: new Set<string>([encodeHandlesInContainerRuntime, notifiesReadOnlyState]),
 };
 
 /**

packages/runtime/datastore/api-report/datastore.legacy.alpha.api.md

@@ -67,6 +67,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
     // (undocumented)
     get logger(): ITelemetryLoggerExt;
     makeVisibleAndAttachGraph(): void;
+    notifyReadOnlyState(readonly: boolean): void;
     // (undocumented)
     get objectsRoutingContext(): this;
     // (undocumented)
@@ -90,7 +91,6 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
     setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
     // (undocumented)
     setConnectionState(connected: boolean, clientId?: string): void;
-    setReadOnlyState(readonly: boolean): void;
     // (undocumented)
     submitMessage(type: DataStoreMessageType, content: any, localOpMetadata: unknown): void;
     submitSignal(type: string, content: unknown, targetClientId?: string): void;

packages/runtime/datastore/src/dataStoreRuntime.ts

@@ -57,7 +57,7 @@ import {
 	IInboundSignalMessage,
 	type IRuntimeMessageCollection,
 	type IRuntimeMessagesContent,
-	setReadOnlyState,
+	notifiesReadOnlyState,
 	encodeHandlesInContainerRuntime,
 } from "@fluidframework/runtime-definitions/internal";
 import {
@@ -110,7 +110,7 @@ type PickRequired<T extends Record<never, unknown>, K extends keyof T> = Omit<T,
 
 interface IFluidDataStoreContextFeaturesToTypes {
 	[encodeHandlesInContainerRuntime]: IFluidDataStoreContext; // No difference in typing with this feature
-	[setReadOnlyState]: PickRequired<IFluidDataStoreContext, "readonly">;
+	[notifiesReadOnlyState]: PickRequired<IFluidDataStoreContext, "readonly">;
 }
 
 function contextSupportsFeature<K extends keyof IFluidDataStoreContextFeaturesToTypes>(
@@ -290,12 +290,12 @@ export class FluidDataStoreRuntime
 			dataStoreContext as FluidObject<ILayerCompatDetails>;
 		validateRuntimeCompatibility(runtimeCompatDetails, this.dispose.bind(this));
 
-		if (contextSupportsFeature(dataStoreContext, setReadOnlyState)) {
+		if (contextSupportsFeature(dataStoreContext, notifiesReadOnlyState)) {
 			this._readonly = dataStoreContext.readonly;
 		} else {
 			this._readonly = this.dataStoreContext.deltaManager.readOnlyInfo.readonly === true;
 			this.dataStoreContext.deltaManager.on("readonly", (readonly) =>
-				this.setReadOnlyState(readonly),
+				this.notifyReadOnlyState(readonly),
 			);
 		}
 
@@ -692,7 +692,7 @@ export class FluidDataStoreRuntime
 	 * readonly state of this object. It should not be invoked by
 	 * any other callers.
 	 */
-	public setReadOnlyState(readonly: boolean) {
+	public notifyReadOnlyState(readonly: boolean): void {
 		this.verifyNotClosed();
 		if (readonly !== this._readonly) {
 			this._readonly = readonly;

packages/runtime/runtime-definitions/api-report/runtime-definitions.legacy.alpha.api.md

@@ -129,6 +129,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
     getAttachSummary(telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
     getGCData(fullGC?: boolean): Promise<IGarbageCollectionData>;
     makeVisibleAndAttachGraph(): void;
+    notifyReadOnlyState?(readonly: boolean): void;
     processMessages(messageCollection: IRuntimeMessageCollection): void;
     processSignal(message: IInboundSignalMessage, local: boolean): void;
     // (undocumented)
@@ -138,7 +139,6 @@ export interface IFluidDataStoreChannel extends IDisposable {
     // (undocumented)
     setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void;
     setConnectionState(connected: boolean, clientId?: string): any;
-    setReadOnlyState?(readonly: boolean): void;
     summarize(fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
     updateUsedRoutes(usedRoutes: string[]): void;
 }

packages/runtime/runtime-definitions/src/dataStoreContext.ts

@@ -373,7 +373,7 @@ export interface IFluidDataStoreChannel extends IDisposable {
 	/**
 	 * Notifies this object about changes in the readonly state
 	 */
-	setReadOnlyState?(readonly: boolean): void;
+	notifyReadOnlyState?(readonly: boolean): void;
 
 	/**
 	 * Ask the DDS to resubmit a message. This could be because we reconnected and this message was not acked.

packages/runtime/runtime-definitions/src/index.ts

@@ -55,7 +55,7 @@ export type {
 } from "./protocol.js";
 export {
 	encodeHandlesInContainerRuntime,
-	setReadOnlyState,
+	notifiesReadOnlyState,
 } from "./runtimeLayerCompatFeatureNames.js";
 export type {
 	CreateChildSummarizerNodeParam,

packages/runtime/runtime-definitions/src/runtimeLayerCompatFeatureNames.ts

@@ -12,8 +12,8 @@
 export const encodeHandlesInContainerRuntime = "encodeHandlesInContainerRuntime" as const;
 
 /**
- * This feature indicates that the datastore context will call setReadOnlyState on the
+ * This feature indicates that the datastore context will call notifyReadOnlyState on the
  * datastore runtime.
  * @internal
  */
-export const setReadOnlyState = "setReadOnlyState" as const;
+export const notifiesReadOnlyState = "notifiesReadOnlyState" as const;

packages/runtime/test-runtime-utils/api-report/test-runtime-utils.legacy.alpha.api.md

@@ -458,6 +458,8 @@ export class MockFluidDataStoreRuntime extends EventEmitter implements IFluidDat
     // (undocumented)
     makeVisibleAndAttachGraph(): void;
     // (undocumented)
+    notifyReadOnlyState(readonly: boolean): void;
+    // (undocumented)
     get objectsRoutingContext(): IFluidHandleContext;
     // (undocumented)
     options: Record<string | number, any>;
@@ -490,8 +492,6 @@ export class MockFluidDataStoreRuntime extends EventEmitter implements IFluidDat
     // (undocumented)
     setConnectionState(connected: boolean, clientId?: string): void;
     // (undocumented)
-    setReadOnlyState(readonly: boolean): void;
-    // (undocumented)
     submitMessage(type: MessageType, content: any): null;
     // (undocumented)
     submitSignal(type: string, content: any): null;

packages/runtime/test-runtime-utils/src/mocks.ts

@@ -1040,7 +1040,7 @@ export class MockFluidDataStoreRuntime
 		return;
 	}
 
-	public setReadOnlyState(readonly: boolean) {
+	public notifyReadOnlyState(readonly: boolean): void {
 		this.readonly = readonly;
 	}