@fluidframework/routerlicious-driver 2.117.0 → 3.0.0

package/src/documentServiceFactory.ts

@@ -6,6 +6,8 @@
 import type {
 	ILayerCompatDetails,
 	IProvideLayerCompatDetails,
+	ILayerCompatSupportRequirements,
+	IProvideLayerCompatSupportRequirements,
 } from "@fluid-internal/client-utils";
 import type { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
@@ -35,7 +37,10 @@ import type { ISnapshotTreeVersion } from "./definitions.js";
 import { DocumentService } from "./documentService.js";
 import { pkgVersion as driverVersion } from "./packageVersion.js";
 import type { IRouterliciousDriverPolicies } from "./policies.js";
-import { r11sDriverCompatDetailsForLoader } from "./r11sLayerCompatState.js";
+import {
+	r11sDriverCompatDetailsForLoader,
+	r11sDriverCompatRequirementsForLoader,
+} from "./r11sLayerCompatState.js";
 import {
 	RouterliciousOrdererRestWrapper,
 	RouterliciousStorageRestWrapper,
@@ -66,7 +71,10 @@ const defaultRouterliciousDriverPolicies: IRouterliciousDriverPolicies = {
  * @internal
  */
 export class RouterliciousDocumentServiceFactory
-	implements IDocumentServiceFactory, IProvideLayerCompatDetails
+	implements
+		IDocumentServiceFactory,
+		IProvideLayerCompatDetails,
+		IProvideLayerCompatSupportRequirements
 {
 	private readonly driverPolicies: IRouterliciousDriverPolicies;
 	private readonly blobCache: ICache<ArrayBufferLike>;
@@ -108,6 +116,15 @@ export class RouterliciousDocumentServiceFactory
 		return r11sDriverCompatDetailsForLoader;
 	}
 
+	/**
+	 * The requirements that the Loader layer must meet to be compatible with this Routerlicious Driver. This is
+	 * exposed to the Loader layer so that it can validate Loader / Driver compatibility on this Driver's behalf
+	 * (the Driver has no reference to the Loader to validate it directly).
+	 */
+	public get ILayerCompatSupportRequirements(): ILayerCompatSupportRequirements {
+		return r11sDriverCompatRequirementsForLoader;
+	}
+
 	/**
 	 * {@inheritDoc @fluidframework/driver-definitions#IDocumentServiceFactory.createContainer}
 	 *

package/src/index.ts

@@ -24,4 +24,7 @@ export {
 export type { IRouterliciousDriverPolicies } from "./policies.js";
 
 // Layer Compat details
-export { r11sDriverCompatDetailsForLoader } from "./r11sLayerCompatState.js";
+export {
+	r11sDriverCompatDetailsForLoader,
+	r11sDriverCompatRequirementsForLoader,
+} from "./r11sLayerCompatState.js";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/routerlicious-driver";
-export const pkgVersion = "2.117.0";
+export const pkgVersion = "3.0.0";

package/src/r11sLayerCompatState.ts

@@ -3,7 +3,12 @@
  * Licensed under the MIT License.
  */
 
-import { generation, type ILayerCompatDetails } from "@fluid-internal/client-utils";
+import {
+	generation,
+	LayerCompatibilityPolicyWindowMonths,
+	type ILayerCompatDetails,
+	type ILayerCompatSupportRequirements,
+} from "@fluid-internal/client-utils";
 
 import { pkgVersion } from "./packageVersion.js";
 
@@ -25,3 +30,26 @@ export const r11sDriverCompatDetailsForLoader: ILayerCompatDetails = {
 	 */
 	supportedFeatures: new Set<string>(),
 };
+
+/**
+ * The requirements that the Loader layer must meet to be compatible with this Routerlicious Driver. This is published
+ * to the Loader layer (which holds the reference to this Driver) so that it can validate Loader / Driver compatibility
+ * on this Driver's behalf.
+ * @internal
+ */
+export const r11sDriverCompatRequirementsForLoader: ILayerCompatSupportRequirements = {
+	/**
+	 * Minimum generation that Loader must be at to be compatible with this Driver. This is calculated based on the
+	 * LayerCompatibilityPolicyWindowMonths.NewDriverOldLoader value which defines how many months old can the Loader
+	 * layer be compared to the Driver layer for them to still be considered compatible.
+	 * The minimum valid generation value is 0.
+	 */
+	minSupportedGeneration: Math.max(
+		0,
+		generation - LayerCompatibilityPolicyWindowMonths.NewDriverOldLoader,
+	),
+	/**
+	 * The features that the Loader must support to be compatible with this Driver.
+	 */
+	requiredFeatures: [],
+};

package/src/shreddedSummaryDocumentStorageService.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import type { IsoBufferEncoding } from "@fluid-internal/client-utils";
 import { Uint8ArrayToString, stringToBuffer } from "@fluid-internal/client-utils";
 import type { ISummaryHandle, ISummaryTree } from "@fluidframework/driver-definitions";
 import type {
@@ -165,7 +166,13 @@ export class ShreddedSummaryDocumentStorageService implements IDocumentStorageSe
 			this.mc.config.getNumber("Fluid.Driver.ReadBlobTelemetrySampling"),
 		);
 		this.blobsShaCache.set(value.sha, "");
-		const bufferContent = stringToBuffer(value.content, value.encoding);
+		// stringToBuffer has only ever reliably supported limited encodings.
+		// Despite server `IBlob.encoding` type being string, cast as one of
+		// the supported types and expect throw under browser if not.
+		// TODO: AB:#81373: Consider formalizing `IBlob.encoding` literals allowed.
+		// Note: the origin of this type is repo local but a synchronized
+		// clone of the @fluidframework/gitresources interface.
+		const bufferContent = stringToBuffer(value.content, value.encoding as IsoBufferEncoding);
 		await this.blobCache?.put(this.getCacheKey(value.sha), bufferContent);
 		return bufferContent;
 	}

package/src/summaryTreeUploadManager.ts

@@ -90,8 +90,11 @@ export class SummaryTreeUploadManager implements ISummaryUploadManager {
 	private async writeSummaryBlob(content: string | Uint8Array): Promise<string> {
 		const { parsedContent, encoding } =
 			typeof content === "string"
-				? { parsedContent: content, encoding: "utf-8" }
-				: { parsedContent: Uint8ArrayToString(content, "base64"), encoding: "base64" };
+				? ({ parsedContent: content, encoding: "utf-8" } as const)
+				: ({
+						parsedContent: Uint8ArrayToString(content, "base64"),
+						encoding: "base64",
+					} as const);
 
 		// The gitHashFile would return the same hash as returned by the server as blob.sha
 		const hash = await gitHashFile(IsoBuffer.from(parsedContent, encoding));

package/src/wholeSummaryDocumentStorageService.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import type { IsoBufferEncoding } from "@fluid-internal/client-utils";
 import {
 	Uint8ArrayToString,
 	performanceNow,
@@ -222,7 +223,13 @@ export class WholeSummaryDocumentStorageService implements IDocumentStorageServi
 			undefined, // workers
 			this.mc.config.getNumber("Fluid.Driver.ReadBlobTelemetrySampling"),
 		);
-		const bufferValue = stringToBuffer(blob.content, blob.encoding);
+		// stringToBuffer has only ever reliably supported limited encodings.
+		// Despite server `IBlob.encoding` type being string, cast as one of
+		// the supported types and expect throw under browser if not.
+		// TODO: AB:#81373: Consider formalizing `IBlob.encoding` literals allowed.
+		// Note: the origin of this type is repo local but a synchronized
+		// clone of the @fluidframework/gitresources interface.
+		const bufferValue = stringToBuffer(blob.content, blob.encoding as IsoBufferEncoding);
 
 		await this.blobCache.put(this.getCacheKey(blob.sha), bufferValue);
 

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../../../common/build/build-common/tsconfig.node16.json",
+	"extends": "../../../common/build/build-common/tsconfig.node20.json",
 	"include": ["src/**/*"],
 	"exclude": ["src/test/**/*"],
 	"compilerOptions": {

package/internal.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/index.js";

package/legacy.d.ts

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/*
- * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
- * Generated by "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat" in @fluid-tools/build-cli.
- */
-
-export * from "./lib/legacy.js";