Runtime: Expose readonly directly off the datastore runtime

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

@@ -91,7 +91,6 @@ export interface IFluidDataStoreRuntime extends IEventProvider<IFluidDataStoreRu
     readonly idCompressor: IIdCompressor | undefined;
     // (undocumented)
     readonly IFluidHandleContext: IFluidHandleContext;
-    // (undocumented)
     readonly isReadOnly: () => boolean;
     // (undocumented)
     readonly logger: ITelemetryBaseLogger;

packages/runtime/datastore-definitions/src/dataStoreRuntime.ts

@@ -34,6 +34,10 @@ export interface IFluidDataStoreRuntimeEvents extends IEvent {
 	(event: "op", listener: (message: ISequencedDocumentMessage) => void);
 	(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void);
 	(event: "connected", listener: (clientId: string) => void);
+	/*
+	 * The readonly event is fired when the readonly state of the datastore runtime changes.
+	 * The isReadOnly param will express the new readonly state.
+	 */
 	(event: "readonly", listener: (isReadOnly: boolean) => void);
 }
 
@@ -70,6 +74,10 @@ export interface IFluidDataStoreRuntime
 
 	readonly connected: boolean;
 
+	/**
+	 * Get the current readonly state.
+	 * @returns true if read-only, otherwise false
+	 */
 	readonly isReadOnly: () => boolean;
 
 	readonly logger: ITelemetryBaseLogger;

packages/runtime/datastore/src/dataStoreRuntime.ts

@@ -159,6 +159,9 @@ export class FluidDataStoreRuntime
 		return this.dataStoreContext.connected;
 	}
 
+	/**
+	 * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.isReadOnly}
+	 */
 	public readonly isReadOnly = (): boolean => this._readonly;
 
 	public get clientId(): string | undefined {

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

@@ -446,7 +446,7 @@ export interface IFluidParentContext
 	readonly clientId: string | undefined;
 	readonly connected: boolean;
 	/**
-	 * Indicates if the parent context is readonly. If readonly is true, the consumer of
+	 * Indicates if the parent context is readonly. If isReadOnly is true, the consumer of
 	 * the context should also consider themselves readonly.
 	 */
 	readonly isReadOnly?: () => boolean;

packages/test/local-server-tests/src/test/readonly.spec.ts

@@ -50,8 +50,8 @@ class DefaultDataStore {
 	get DefaultDataStore() {
 		return this;
 	}
-	get readonly() {
-		return this.runtime.readonly;
+	isReadOnly() {
+		return this.runtime.isReadOnly();
 	}
 
 	get handle() {
@@ -151,15 +151,15 @@ describe("readonly", () => {
 			"container entrypoint must be DefaultDataStore",
 		);
 
-		assert(entrypoint.DefaultDataStore.readonly === false, "shouldn't be readonly");
+		assert(entrypoint.DefaultDataStore.isReadOnly() === false, "shouldn't be readonly");
 		assert(
 			entrypoint.DefaultDataStore.readonlyEventCount === 0,
 			"shouldn't be any readonly events",
 		);
 
 		await container.attach(urlResolver.createCreateNewRequest("test"));
 
-		assert(entrypoint.DefaultDataStore.readonly === false, "shouldn't be readonly");
+		assert(entrypoint.DefaultDataStore.isReadOnly() === false, "shouldn't be readonly");
 		assert(
 			entrypoint.DefaultDataStore.readonlyEventCount === 0,
 			"shouldn't be any readonly events",
@@ -178,7 +178,7 @@ describe("readonly", () => {
 			"container entrypoint must be DefaultDataStore",
 		);
 
-		assert(entrypoint.DefaultDataStore.readonly === false, "shouldn't be readonly");
+		assert(entrypoint.DefaultDataStore.isReadOnly() === false, "shouldn't be readonly");
 		assert(
 			entrypoint.DefaultDataStore.readonlyEventCount === 0,
 			"shouldn't be any readonly events",
@@ -199,7 +199,7 @@ describe("readonly", () => {
 
 		loadedContainer.forceReadonly?.(true);
 
-		assert(entrypoint.DefaultDataStore.readonly === true, "should be readonly");
+		assert(entrypoint.DefaultDataStore.isReadOnly() === true, "should be readonly");
 		assert(
 			entrypoint.DefaultDataStore.readonlyEventCount === 1,
 			"should be any readonly events",
@@ -220,7 +220,7 @@ describe("readonly", () => {
 			"container entrypoint must be DefaultDataStore",
 		);
 
-		assert(entrypoint.DefaultDataStore.readonly === true, "should be readonly");
+		assert(entrypoint.DefaultDataStore.isReadOnly() === true, "should be readonly");
 		assert(
 			entrypoint.DefaultDataStore.readonlyEventCount === 0,
 			"shouldn't be any readonly events",