@fluidframework/datastore 2.90.0 → 2.92.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/datastore",
-  "version": "2.90.0",
+  "version": "2.92.0",
   "description": "Fluid data store implementation",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,29 +69,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.90.0",
-    "@fluidframework/container-definitions": "~2.90.0",
-    "@fluidframework/core-interfaces": "~2.90.0",
-    "@fluidframework/core-utils": "~2.90.0",
-    "@fluidframework/datastore-definitions": "~2.90.0",
-    "@fluidframework/driver-definitions": "~2.90.0",
-    "@fluidframework/driver-utils": "~2.90.0",
-    "@fluidframework/id-compressor": "~2.90.0",
-    "@fluidframework/runtime-definitions": "~2.90.0",
-    "@fluidframework/runtime-utils": "~2.90.0",
-    "@fluidframework/telemetry-utils": "~2.90.0",
+    "@fluid-internal/client-utils": "~2.92.0",
+    "@fluidframework/container-definitions": "~2.92.0",
+    "@fluidframework/core-interfaces": "~2.92.0",
+    "@fluidframework/core-utils": "~2.92.0",
+    "@fluidframework/datastore-definitions": "~2.92.0",
+    "@fluidframework/driver-definitions": "~2.92.0",
+    "@fluidframework/driver-utils": "~2.92.0",
+    "@fluidframework/id-compressor": "~2.92.0",
+    "@fluidframework/runtime-definitions": "~2.92.0",
+    "@fluidframework/runtime-utils": "~2.92.0",
+    "@fluidframework/telemetry-utils": "~2.92.0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
-    "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.90.0",
-    "@fluid-tools/build-cli": "^0.63.0",
+    "@biomejs/biome": "~2.4.5",
+    "@fluid-internal/mocha-test-setup": "~2.92.0",
+    "@fluid-tools/build-cli": "^0.64.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.63.0",
-    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.83.0",
-    "@fluidframework/eslint-config-fluid": "~2.90.0",
-    "@fluidframework/test-runtime-utils": "~2.90.0",
+    "@fluidframework/build-tools": "^0.64.0",
+    "@fluidframework/datastore-previous": "npm:@fluidframework/datastore@2.91.0",
+    "@fluidframework/eslint-config-fluid": "^9.0.0",
+    "@fluidframework/test-runtime-utils": "~2.92.0",
     "@microsoft/api-extractor": "7.52.11",
     "@types/lodash": "^4.14.118",
     "@types/mocha": "^10.0.10",
@@ -115,7 +115,7 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
+    "api-extractor:commonjs": "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist",
     "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",

package/src/dataStoreRuntime.ts

@@ -157,6 +157,78 @@ export interface ISharedObjectRegistry {
 	get(name: string): IChannelFactory | undefined;
 }
 
+/**
+ * The common URL prefix used by legacy DDS type strings.
+ * Factories originally used full URLs (e.g. `"https://graph.microsoft.com/types/map"`);
+ * new factories use only the trailing path segment (e.g. `"map"`).
+ *
+ * Support for reading both formats was added in 2.92.0.
+ * @remarks
+ * This is encoded using base64 to avoid replacement of URL-like values that we have seen some reverse proxies perform.
+ * The value at runtime is "https://graph.microsoft.com/types/".
+ */
+const legacyTypeUrlPrefix = atob("aHR0cHM6Ly9ncmFwaC5taWNyb3NvZnQuY29tL3R5cGVzLw==");
+
+/**
+ * Wraps an {@link ISharedObjectRegistry} to transparently redirect legacy URL-based DDS type
+ * strings to the factories registered under the corresponding short-name path segment.
+ *
+ * When a lookup by the full URL fails, this wrapper retries using only the portion of the URL
+ * after `"https://graph.microsoft.com/types/"`. This allows old documents whose summaries
+ * contain URL-based type strings to be loaded against a registry built with the current
+ * short-name factory types.
+ *
+ * @remarks
+ * See {@link legacyTypeUrlPrefix} for details on old vs. new formats
+ */
+export class LegacyTypeAwareRegistry implements ISharedObjectRegistry {
+	public constructor(private readonly base: ISharedObjectRegistry) {}
+
+	public get(name: string): IChannelFactory | undefined {
+		let factory = this.base.get(name);
+		if (factory !== undefined) {
+			return factory;
+		}
+
+		// eslint-disable-next-line unicorn/prefer-ternary -- This is more readable as an if statement to clearly delineate which logic can be later removed vs. which needs to stay.
+		if (name.startsWith(legacyTypeUrlPrefix)) {
+			// Back-compat: if the name is a legacy URL-based type string, retry with just the trailing path segment.
+			factory = this.base.get(name.slice(legacyTypeUrlPrefix.length));
+		} else {
+			// Temporary compat: if the name is *not* a legacy URL-based type string and we haven't found a match yet, check if we have a match with the
+			// corresponding legacy scheme. This ensures that if a client containing an older code version with the legacy attribute types loads a document
+			// written by a newer code version, they are still able to find the correct factories. This block can be removed once collaboration between clients
+			// with legacy vs. new attribute types in their code is no longer supported.
+			factory = this.base.get(`${legacyTypeUrlPrefix}${name}`);
+		}
+
+		if (factory !== undefined) {
+			return factory;
+		}
+
+		if (isURL(name) && name.includes("graph.microsoft")) {
+			// Reasonably strong signal that this the document refers to a DDS type string that is using the legacy URL format, but
+			// the base URL was likely changed by a reverse proxy or similar. Assume that its final segment is still the short (modern) name of
+			// a valid DDS type and look it up as such.
+			const finalSegment = name.split("/").slice(-1)[0];
+			if (finalSegment !== undefined) {
+				return (
+					this.base.get(finalSegment) ?? this.base.get(`${legacyTypeUrlPrefix}${finalSegment}`)
+				);
+			}
+		}
+	}
+}
+
+function isURL(str: string): boolean {
+	try {
+		new URL(str);
+		return true;
+	} catch {
+		return false;
+	}
+}
+
 const defaultPolicies: IFluidDataStorePolicies = {
 	readonlyInStagingMode: false,
 };
@@ -277,6 +349,7 @@ export class FluidDataStoreRuntime
 		ISequencedDocumentMessage,
 		IDocumentMessage
 	>;
+	private readonly sharedObjectRegistry: ISharedObjectRegistry;
 	private readonly quorum: IQuorumClients;
 	private readonly audience: IAudience;
 	private readonly mc: MonitoringContext;
@@ -327,12 +400,13 @@ export class FluidDataStoreRuntime
 	 */
 	public constructor(
 		private readonly dataStoreContext: IFluidDataStoreContext,
-		private readonly sharedObjectRegistry: ISharedObjectRegistry,
+		sharedObjectRegistry: ISharedObjectRegistry,
 		existing: boolean,
 		provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>,
 		policies?: Partial<IFluidDataStorePolicies>,
 	) {
 		super();
+		this.sharedObjectRegistry = new LegacyTypeAwareRegistry(sharedObjectRegistry);
 
 		assert(
 			!dataStoreContext.id.includes("/"),

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/datastore";
-export const pkgVersion = "2.90.0";
+export const pkgVersion = "2.92.0";