(compat) Added supported features and generation across Loader / Driver boundary - Part 2

packages/drivers/local-driver/src/index.ts

@@ -9,5 +9,5 @@ export { createLocalDocumentService, LocalDocumentService } from "./localDocumen
 export { LocalDocumentServiceFactory } from "./localDocumentServiceFactory.js";
 export { LocalDocumentStorageService } from "./localDocumentStorageService.js";
 export { createLocalResolverCreateNewRequest, LocalResolver } from "./localResolver.js";
-export { localDriverCompatDetailsForLoader } from "./localRuntimeLayerCompatState.js";
+export { localDriverCompatDetailsForLoader } from "./localLayerCompatState.js";
 export { LocalSessionStorageDbFactory } from "./localSessionStorageDb.js";

packages/drivers/local-driver/src/localDocumentService.ts

@@ -27,7 +27,7 @@ import { TestHistorian } from "@fluidframework/server-test-utils";
 import { LocalDeltaStorageService } from "./localDeltaStorageService.js";
 import { LocalDocumentDeltaConnection } from "./localDocumentDeltaConnection.js";
 import { LocalDocumentStorageService } from "./localDocumentStorageService.js";
-import { localDriverCompatDetailsForLoader } from "./localRuntimeLayerCompatState.js";
+import { localDriverCompatDetailsForLoader } from "./localLayerCompatState.js";
 
 /**
  * Basic implementation of a document service for local use.

packages/drivers/odsp-driver/src/index.ts

@@ -66,3 +66,6 @@ export {
 	ISnapshotContentsWithProps,
 	parseCompactSnapshotResponse,
 } from "./compactSnapshotParser.js";
+
+// Layer Compat details
+export { odspDriverCompatDetailsForLoader } from "./odspLayerCompatState.js";

packages/drivers/odsp-driver/src/localOdspDriver/localOdspDocumentService.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 { IClient } from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaStorageService,
@@ -18,6 +18,7 @@ import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
 import { LocalOdspDeltaStorageService } from "./localOdspDeltaStorageService.js";
 import { LocalOdspDocumentStorageService } from "./localOdspDocumentStorageManager.js";
+import { localOdspDriverCompatDetailsForLoader } from "./localOdspLayerCompatState.js";
 
 /**
  * IDocumentService implementation that provides explicit snapshot to the document storage service.
@@ -37,6 +38,14 @@ export class LocalOdspDocumentService
 		super();
 	}
 
+	/**
+	 * The compatibility details of the Local ODSP Driver layer that is exposed to the Loader layer
+	 * for validating Loader-Driver compatibility.
+	 */
+	public get ILayerCompatDetails(): ILayerCompatDetails {
+		return localOdspDriverCompatDetailsForLoader;
+	}
+
 	public get resolvedUrl(): IResolvedUrl {
 		return this.odspResolvedUrl;
 	}

packages/drivers/odsp-driver/src/localOdspDriver/localOdspLayerCompatState.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type ILayerCompatDetails } from "@fluid-internal/client-utils";
+
+import { pkgVersion } from "../packageVersion.js";
+
+/**
+ * Local ODSP Driver's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export const localOdspDriverCompatDetailsForLoader: ILayerCompatDetails = {
+	/**
+	 * The package version of the Local ODSP Driver layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the Local ODSP Driver layer.
+	 */
+	generation: 1,
+	/**
+	 * The features supported by the Local ODSP Driver layer across the Driver / Loader boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};

packages/drivers/odsp-driver/src/odspDocumentService.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 { assert } from "@fluidframework/core-utils/internal";
 import { IClient } from "@fluidframework/driver-definitions";
 import {
@@ -38,6 +38,7 @@ import {
 	OdspDeltaStorageWithCache,
 } from "./odspDeltaStorageService.js";
 import { OdspDocumentStorageService } from "./odspDocumentStorageManager.js";
+import { odspDriverCompatDetailsForLoader } from "./odspLayerCompatState.js";
 import { hasOdcOrigin } from "./odspUrlHelper.js";
 import { getOdspResolvedUrl } from "./odspUtils.js";
 import { OpsCache } from "./opsCaching.js";
@@ -100,6 +101,14 @@ export class OdspDocumentService
 		);
 	}
 
+	/**
+	 * The compatibility details of the ODSP Driver layer that is exposed to the Loader layer
+	 * for validating Loader-Driver compatibility.
+	 */
+	public get ILayerCompatDetails(): ILayerCompatDetails {
+		return odspDriverCompatDetailsForLoader;
+	}
+
 	private storageManager?: OdspDocumentStorageService;
 
 	private readonly mc: MonitoringContext;

packages/drivers/odsp-driver/src/odspLayerCompatState.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type ILayerCompatDetails } from "@fluid-internal/client-utils";
+
+import { pkgVersion } from "./packageVersion.js";
+
+/**
+ * ODSP Driver's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export const odspDriverCompatDetailsForLoader: ILayerCompatDetails = {
+	/**
+	 * The package version of the ODSP Driver layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the ODSP Driver layer.
+	 */
+	generation: 1,
+	/**
+	 * The features supported by the ODSP Driver layer across the Driver / Loader boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};

packages/drivers/replay-driver/package.json

@@ -102,7 +102,11 @@
 		}
 	},
 	"typeValidation": {
-		"broken": {},
+		"broken": {
+			"Class_ReplayDocumentService": {
+				"forwardCompat": false
+			}
+		},
 		"entrypoint": "internal"
 	}
 }

packages/drivers/replay-driver/src/replayDocumentService.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { TypedEventEmitter, type ILayerCompatDetails } from "@fluid-internal/client-utils";
+import type { FluidObject } from "@fluidframework/core-interfaces";
 import { IClient } from "@fluidframework/driver-definitions";
 import {
 	IDocumentServiceEvents,
@@ -41,12 +42,22 @@ export class ReplayDocumentService
 			await documentService.connectToDeltaStorage(),
 			controller,
 		);
-		return new ReplayDocumentService(controller, deltaConnection);
+		const maybeDriverCompatDetails = documentService as FluidObject<ILayerCompatDetails>;
+		return new ReplayDocumentService(
+			controller,
+			deltaConnection,
+			maybeDriverCompatDetails.ILayerCompatDetails,
+		);
 	}
 
 	constructor(
 		private readonly controller: IDocumentStorageService,
 		private readonly deltaStorage: IDocumentDeltaConnection,
+		/**
+		 * The compatibility details of the base Driver layer that is exposed to the Loader layer
+		 * for validating Loader-Driver compatibility.
+		 */
+		public readonly ILayerCompatDetails: ILayerCompatDetails | undefined,
 	) {
 		super();
 	}

packages/drivers/replay-driver/src/test/types/validateReplayDriverPrevious.generated.ts

@@ -76,6 +76,7 @@ declare type current_as_old_for_Class_ReplayController = requireAssignableTo<Typ
  * typeValidation.broken:
  * "Class_ReplayDocumentService": {"forwardCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type old_as_current_for_Class_ReplayDocumentService = requireAssignableTo<TypeOnly<old.ReplayDocumentService>, TypeOnly<current.ReplayDocumentService>>
 
 /*

packages/drivers/routerlicious-driver/src/documentService.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 { assert } from "@fluidframework/core-utils/internal";
 import { IClient } from "@fluidframework/driver-definitions";
 import {
@@ -45,6 +45,7 @@ import {
 	TokenFetcher,
 } from "./restWrapper.js";
 import { RestWrapper } from "./restWrapperBase.js";
+import { r11sDriverCompatDetailsForLoader } from "./routerliciousLayerCompatState.js";
 import type { IGetSessionInfoResponse } from "./sessionInfoManager.js";
 import { SocketIOClientStatic } from "./socketModule.js";
 import { ITokenProvider } from "./tokens.js";
@@ -96,6 +97,14 @@ export class DocumentService
 		return this._policies;
 	}
 
+	/**
+	 * The compatibility details of the ODSP Driver layer that is exposed to the Loader layer
+	 * for validating Loader-Driver compatibility.
+	 */
+	public get ILayerCompatDetails(): ILayerCompatDetails {
+		return r11sDriverCompatDetailsForLoader;
+	}
+
 	public dispose() {}
 
 	/**

packages/drivers/routerlicious-driver/src/index.ts

@@ -22,3 +22,6 @@ export {
 
 // Configuration
 export { IRouterliciousDriverPolicies } from "./policies.js";
+
+// Layer Compat details
+export { r11sDriverCompatDetailsForLoader } from "./routerliciousLayerCompatState.js";

packages/drivers/routerlicious-driver/src/routerliciousLayerCompatState.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { type ILayerCompatDetails } from "@fluid-internal/client-utils";
+
+import { pkgVersion } from "./packageVersion.js";
+
+/**
+ * Routerlicious Driver's compatibility details that is exposed to the Loader layer.
+ * @internal
+ */
+export const r11sDriverCompatDetailsForLoader: ILayerCompatDetails = {
+	/**
+	 * The package version of the Routerlicious Driver layer.
+	 */
+	pkgVersion,
+	/**
+	 * The current generation of the Routerlicious Driver layer.
+	 */
+	generation: 1,
+	/**
+	 * The features supported by the Routerlicious Driver layer across the Driver / Loader boundary.
+	 */
+	supportedFeatures: new Set<string>(),
+};

packages/loader/driver-utils/src/documentServiceProxy.ts

@@ -3,7 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { TypedEventEmitter, type ILayerCompatDetails } from "@fluid-internal/client-utils";
+import type { FluidObject } from "@fluidframework/core-interfaces";
 import { IClient } from "@fluidframework/driver-definitions";
 import {
 	IDocumentDeltaConnection,
@@ -23,8 +24,16 @@ export abstract class DocumentServiceProxy
 	extends TypedEventEmitter<IDocumentServiceEvents>
 	implements IDocumentService
 {
+	/**
+	 * The compatibility details of the base Driver layer that is exposed to the Loader layer
+	 * for validating Loader-Driver compatibility.
+	 */
+	public readonly ILayerCompatDetails: ILayerCompatDetails | undefined;
+
 	constructor(private readonly _service: IDocumentService) {
 		super();
+		const maybeDriverCompatDetails = _service as FluidObject<ILayerCompatDetails>;
+		this.ILayerCompatDetails = maybeDriverCompatDetails.ILayerCompatDetails;
 	}
 
 	public get service(): IDocumentService {

packages/test/test-end-to-end-tests/package.json

@@ -107,10 +107,12 @@
 		"@fluidframework/matrix": "workspace:~",
 		"@fluidframework/merge-tree": "workspace:~",
 		"@fluidframework/odsp-doclib-utils": "workspace:~",
+		"@fluidframework/odsp-driver": "workspace:~",
 		"@fluidframework/odsp-driver-definitions": "workspace:~",
 		"@fluidframework/ordered-collection": "workspace:~",
 		"@fluidframework/register-collection": "workspace:~",
 		"@fluidframework/request-handler": "workspace:~",
+		"@fluidframework/routerlicious-driver": "workspace:~",
 		"@fluidframework/runtime-definitions": "workspace:~",
 		"@fluidframework/runtime-utils": "workspace:~",
 		"@fluidframework/sequence": "workspace:~",