Runtime: Expose readonly directly off the datastore runtime

packages/framework/aqueduct/package.json

@@ -154,7 +154,11 @@
 		"typescript": "~5.4.5"
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Interface_IDataObjectProps": {
+				"forwardCompat": false
+			}
+		},
 		"entrypoint": "legacy"
 	}
 }

packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts

@@ -238,6 +238,7 @@ declare type current_as_old_for_Interface_DataObjectTypes = requireAssignableTo<
  * typeValidation.broken:
  * "Interface_IDataObjectProps": {"forwardCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type old_as_current_for_Interface_IDataObjectProps = requireAssignableTo<TypeOnly<old.IDataObjectProps>, TypeOnly<current.IDataObjectProps>>
 
 /*

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

@@ -124,6 +124,7 @@ interface FluidDataStoreMessage {
  * Creates a shallow wrapper of {@link IFluidParentContext}. The wrapper can then have its methods overwritten as needed
  */
 export function wrapContext(context: IFluidParentContext): IFluidParentContext {
+	const isReadOnly = context.isReadOnly;
 	return {
 		get IFluidDataStoreRegistry() {
 			return context.IFluidDataStoreRegistry;
@@ -149,6 +150,7 @@ export function wrapContext(context: IFluidParentContext): IFluidParentContext {
 		get attachState() {
 			return context.attachState;
 		},
+		isReadOnly: isReadOnly === undefined ? undefined : () => isReadOnly(),
 		containerRuntime: context.containerRuntime,
 		scope: context.scope,
 		gcThrowOnTombstoneUsage: context.gcThrowOnTombstoneUsage,
@@ -1116,6 +1118,31 @@ export class ChannelCollection implements IFluidDataStoreChannel, IDisposable {
 		}
 	}
 
+	/**
+	 * Enumerates the contexts and calls notifyReadOnlyState on them.
+	 */
+	public notifyReadOnlyState(readonly: boolean): void {
+		for (const [fluidDataStoreId, context] of this.contexts) {
+			try {
+				context.notifyReadOnlyState(readonly);
+			} catch (error) {
+				this.mc.logger.sendErrorEvent(
+					{
+						eventName: "SetReadOnlyStateError",
+						...tagCodeArtifacts({
+							fluidDataStoreId,
+						}),
+						details: {
+							runtimeReadonly: this.parentContext.isReadOnly?.(),
+							readonly,
+						},
+					},
+					error,
+				);
+			}
+		}
+	}
+
 	public setAttachState(attachState: AttachState.Attaching | AttachState.Attached): void {
 		for (const [, context] of this.contexts) {
 			// Fire only for bounded stores.

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

@@ -165,6 +165,7 @@ import { ContainerFluidHandleContext } from "./containerHandleContext.js";
 import { channelToDataStore } from "./dataStore.js";
 import { FluidDataStoreRegistry } from "./dataStoreRegistry.js";
 import {
+	BaseDeltaManagerProxy,
 	DeltaManagerPendingOpsProxy,
 	DeltaManagerSummarizerProxy,
 } from "./deltaManagerProxies.js";
@@ -256,7 +257,6 @@ import {
 	idCompressorBlobName,
 	metadataBlobName,
 	rootHasIsolatedChannels,
-	summarizerClientType,
 	wrapSummaryInChannelsTree,
 	formCreateSummarizerFn,
 	summarizerRequestUrl,
@@ -268,6 +268,7 @@ import {
 	ISummaryConfiguration,
 	DefaultSummaryConfiguration,
 	isSummariesDisabled,
+	summarizerClientType,
 } from "./summary/index.js";
 import { Throttler, formExponentialFn } from "./throttler.js";
 
@@ -1105,6 +1106,8 @@ export class ContainerRuntime
 		return this._getAttachState();
 	}
 
+	public readonly isReadOnly = (): boolean => this.deltaManager.readOnlyInfo.readonly === true;
+
 	/**
 	 * Current session schema - defines what options are on & off.
 	 * It's overlap of document schema (controlled by summary & ops) and options controlling this session.
@@ -1719,6 +1722,7 @@ export class ContainerRuntime
 			new Map<string, string>(dataStoreAliasMap),
 			async (runtime: ChannelCollection) => provideEntryPoint,
 		);
+		this._deltaManager.on("readonly", this.notifyReadOnlyState);
 
 		this.blobManager = new BlobManager({
 			routeContext: this.handleContext,
@@ -2108,6 +2112,9 @@ export class ContainerRuntime
 		this.pendingStateManager.dispose();
 		this.inboundBatchAggregator.dispose();
 		this.deltaScheduler.dispose();
+		if (this._deltaManager instanceof BaseDeltaManagerProxy) {
+			this._deltaManager.dispose();
+		}
 		this.emit("dispose");
 		this.removeAllListeners();
 	}
@@ -2560,6 +2567,9 @@ export class ContainerRuntime
 		return this._loadIdCompressor;
 	}
 
+	private readonly notifyReadOnlyState = (readonly: boolean): void =>
+		this.channelCollection.notifyReadOnlyState(readonly);
+
 	public setConnectionState(connected: boolean, clientId?: string): void {
 		// Validate we have consistent state
 		const currentClientId = this._audience.getSelf()?.clientId;

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

@@ -5,11 +5,17 @@
 
 import { TypedEventEmitter, type ILayerCompatDetails } from "@fluid-internal/client-utils";
 import { AttachState, IAudience } from "@fluidframework/container-definitions";
-import { IDeltaManager } from "@fluidframework/container-definitions/internal";
+import {
+	IDeltaManager,
+	isIDeltaManagerFull,
+	type IDeltaManagerFull,
+	type ReadOnlyInfo,
+} from "@fluidframework/container-definitions/internal";
 import {
 	FluidObject,
 	IDisposable,
 	ITelemetryBaseProperties,
+	type IErrorBase,
 	type IEvent,
 } from "@fluidframework/core-interfaces";
 import {
@@ -75,6 +81,7 @@ import {
 	tagCodeArtifacts,
 } from "@fluidframework/telemetry-utils/internal";
 
+import { BaseDeltaManagerProxy } from "./deltaManagerProxies.js";
 import {
 	runtimeCompatDetailsForDataStore,
 	validateDatastoreCompatibility,
@@ -188,6 +195,58 @@ export interface IFluidDataStoreContextEvents extends IEvent {
 	(event: "attaching" | "attached", listener: () => void);
 }
 
+/**
+ * Eventually we should remove the delta manger from being exposed to Datastore runtimes via the context. However to remove that exposure we need to add new
+ * features, and those features themselves need forward and back compat. This proxy is here to enable that back compat. Each feature this proxy is used to
+ * support should be listed below, and as layer compat support goes away for those feature, we should also remove them from this proxy, with the eventual goal
+ * of completely removing this proxy.
+ *
+ * - Everything regarding readonly is to support older datastore runtimes which do not have the setReadonly function, so they must get their readonly state via the delta manager.
+ *
+ */
+class ContextDeltaManagerProxy extends BaseDeltaManagerProxy {
+	constructor(
+		base: IDeltaManagerFull,
+		private readonly isReadOnly: () => boolean,
+	) {
+		super(base, {
+			onReadonly: (): void => {
+				/* readonly is controlled from the context which calls setReadonly */
+			},
+		});
+	}
+
+	public get readOnlyInfo(): ReadOnlyInfo {
+		const readonly = this.isReadOnly();
+		if (readonly === this.deltaManager.readOnlyInfo.readonly) {
+			return this.deltaManager.readOnlyInfo;
+		} else {
+			return readonly === true
+				? {
+						readonly,
+						forced: false,
+						permissions: undefined,
+						storageOnly: false,
+					}
+				: { readonly };
+		}
+	}
+
+	/**
+	 * Called by the owning datastore context to configure the readonly
+	 * state of the delta manger that is project down to the datastore
+	 * runtime. This state may not align with that of the true delta
+	 * manager if the context wishes to control the read only state
+	 * differently than the delta manager itself.
+	 */
+	public setReadonly(
+		readonly: boolean,
+		readonlyConnectionReason?: { reason: string; error?: IErrorBase },
+	): void {
+		this.emit("readonly", readonly, readonlyConnectionReason);
+	}
+}
+
 /**
  * Represents the context for the store. This context is passed to the store runtime.
  * @internal
@@ -217,10 +276,13 @@ export abstract class FluidDataStoreContext
 		return this.parentContext.baseLogger;
 	}
 
+	private readonly _contextDeltaManagerProxy: ContextDeltaManagerProxy;
 	public get deltaManager(): IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> {
-		return this.parentContext.deltaManager;
+		return this._contextDeltaManagerProxy;
 	}
 
+	public isReadOnly = (): boolean => this.parentContext.isReadOnly?.() ?? false;
+
 	public get connected(): boolean {
 		return this.parentContext.connected;
 	}
@@ -420,6 +482,13 @@ export abstract class FluidDataStoreContext
 		// By default, a data store can log maximum 10 local changes telemetry in summarizer.
 		this.localChangesTelemetryCount =
 			this.mc.config.getNumber("Fluid.Telemetry.LocalChangesTelemetryCount") ?? 10;
+
+		assert(isIDeltaManagerFull(this.parentContext.deltaManager), "Invalid delta manager");
+
+		this._contextDeltaManagerProxy = new ContextDeltaManagerProxy(
+			this.parentContext.deltaManager,
+			() => this.isReadOnly(),
+		);
 	}
 
 	public dispose(): void {
@@ -437,6 +506,7 @@ export abstract class FluidDataStoreContext
 				})
 				.catch((error) => {});
 		}
+		this._contextDeltaManagerProxy.dispose();
 	}
 
 	/**
@@ -615,6 +685,13 @@ export abstract class FluidDataStoreContext
 		this.channel!.setConnectionState(connected, clientId);
 	}
 
+	public notifyReadOnlyState(readonly: boolean): void {
+		this.verifyNotClosed("notifyReadOnlyState", false /* checkTombstone */);
+
+		this.channel?.notifyReadOnlyState?.(readonly);
+		this._contextDeltaManagerProxy.setReadonly(readonly);
+	}
+
 	/**
 	 * Process messages for this data store. The messages here are contiguous messages for this data store in a batch.
 	 * @param messageCollection - The collection of messages to process.

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

@@ -211,6 +211,7 @@ export abstract class BaseDeltaManagerProxy
 		this.deltaManager.off("connect", this.eventHandlers.onConnect);
 		this.deltaManager.off("disconnect", this.eventHandlers.onDisconnect);
 		this.deltaManager.off("readonly", this.eventHandlers.onReadonly);
+		this.removeAllListeners();
 	}
 
 	public submitSignal(content: string, targetClientId?: string): void {

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

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

packages/runtime/container-runtime/src/test/createChildDataStoreSync.spec.ts

@@ -18,7 +18,10 @@ import {
 	type ISummarizerNodeWithGC,
 } from "@fluidframework/runtime-definitions/internal";
 import { isFluidError } from "@fluidframework/telemetry-utils/internal";
-import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils/internal";
+import {
+	MockDeltaManager,
+	MockFluidDataStoreRuntime,
+} from "@fluidframework/test-runtime-utils/internal";
 
 import {
 	FluidDataStoreContext,
@@ -89,6 +92,7 @@ describe("createChildDataStore", () => {
 					});
 				},
 			} satisfies Partial<IContainerRuntimeBase> as unknown as IContainerRuntimeBase,
+			deltaManager: new MockDeltaManager(),
 		} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 
 		const context = new testContext(

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

@@ -47,6 +47,7 @@ import {
 	isFluidError,
 } from "@fluidframework/telemetry-utils/internal";
 import {
+	MockDeltaManager,
 	MockFluidDataStoreRuntime,
 	validateAssertionError,
 } from "@fluidframework/test-runtime-utils/internal";
@@ -245,6 +246,7 @@ describe("Data Store Context Tests", () => {
 				parentContext = {
 					IFluidDataStoreRegistry: registryWithSubRegistries,
 					clientDetails: {} as unknown as IFluidParentContext["clientDetails"],
+					deltaManager: new MockDeltaManager(),
 				} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 				localDataStoreContext = new LocalFluidDataStoreContext({
 					id: dataStoreId,
@@ -541,6 +543,7 @@ describe("Data Store Context Tests", () => {
 				IFluidDataStoreRegistry: registry,
 				clientDetails: {} as unknown as IFluidParentContext["clientDetails"],
 				containerRuntime: parentContext as unknown as IContainerRuntimeBase,
+				deltaManager: new MockDeltaManager(),
 			} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 		});
 
@@ -1036,6 +1039,7 @@ describe("Data Store Context Tests", () => {
 				IFluidDataStoreRegistry: registry,
 				baseLogger: createChildLogger(),
 				clientDetails: {} as unknown as IFluidParentContext["clientDetails"],
+				deltaManager: new MockDeltaManager(),
 			} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 		});
 

packages/runtime/container-runtime/src/test/dataStoreCreation.spec.ts

@@ -19,7 +19,10 @@ import {
 	SummarizeInternalFn,
 } from "@fluidframework/runtime-definitions/internal";
 import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
-import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils/internal";
+import {
+	MockDeltaManager,
+	MockFluidDataStoreRuntime,
+} from "@fluidframework/test-runtime-utils/internal";
 
 import { LocalFluidDataStoreContext } from "../dataStoreContext.js";
 import { createRootSummarizerNodeWithGC } from "../summary/index.js";
@@ -111,6 +114,7 @@ describe("Data Store Creation Tests", () => {
 				IFluidDataStoreRegistry: globalRegistry,
 				baseLogger: createChildLogger(),
 				clientDetails: {} as unknown as IFluidParentContext["clientDetails"],
+				deltaManager: new MockDeltaManager(),
 			} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 			const summarizerNode = createRootSummarizerNodeWithGC(
 				createChildLogger(),

packages/runtime/container-runtime/src/test/dataStoreCreationHelper.ts

@@ -18,7 +18,10 @@ import {
 	type SummarizeInternalFn,
 } from "@fluidframework/runtime-definitions/internal";
 import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
-import { MockFluidDataStoreRuntime } from "@fluidframework/test-runtime-utils/internal";
+import {
+	MockDeltaManager,
+	MockFluidDataStoreRuntime,
+} from "@fluidframework/test-runtime-utils/internal";
 
 import {
 	LocalFluidDataStoreContext,
@@ -58,6 +61,7 @@ export function createParentContext(
 		baseLogger: logger,
 		clientDetails,
 		submitMessage: () => {},
+		deltaManager: new MockDeltaManager(),
 	} satisfies Partial<IFluidParentContext> as unknown as IFluidParentContext;
 }