@fluidframework/odsp-driver 2.0.4 → 2.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/odsp-driver",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Socket storage implementation for SPO and ODC",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -77,15 +77,15 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.0.4",
-    "@fluidframework/core-interfaces": "~2.0.4",
-    "@fluidframework/core-utils": "~2.0.4",
-    "@fluidframework/driver-base": "~2.0.4",
-    "@fluidframework/driver-definitions": "~2.0.4",
-    "@fluidframework/driver-utils": "~2.0.4",
-    "@fluidframework/odsp-doclib-utils": "~2.0.4",
-    "@fluidframework/odsp-driver-definitions": "~2.0.4",
-    "@fluidframework/telemetry-utils": "~2.0.4",
+    "@fluid-internal/client-utils": "~2.0.6",
+    "@fluidframework/core-interfaces": "~2.0.6",
+    "@fluidframework/core-utils": "~2.0.6",
+    "@fluidframework/driver-base": "~2.0.6",
+    "@fluidframework/driver-definitions": "~2.0.6",
+    "@fluidframework/driver-utils": "~2.0.6",
+    "@fluidframework/odsp-doclib-utils": "~2.0.6",
+    "@fluidframework/odsp-driver-definitions": "~2.0.6",
+    "@fluidframework/telemetry-utils": "~2.0.6",
     "node-fetch": "^2.6.9",
     "socket.io-client": "^4.7.3",
     "uuid": "^9.0.0"
@@ -93,7 +93,7 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "~2.0.4",
+    "@fluid-internal/mocha-test-setup": "~2.0.6",
     "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0",

package/src/createFile.ts

@@ -16,6 +16,7 @@ import {
 } from "@fluidframework/odsp-driver-definitions/internal";
 import {
 	ITelemetryLoggerExt,
+	loggerToMonitoringContext,
 	PerformanceEvent,
 } from "@fluidframework/telemetry-utils/internal";
 
@@ -36,6 +37,7 @@ import {
 	buildOdspShareLinkReqParams,
 	createCacheSnapshotKey,
 	getWithRetryForTokenRefresh,
+	snapshotWithLoadingGroupIdSupported,
 } from "./odspUtils.js";
 import { pkgVersion as driverVersion } from "./packageVersion.js";
 import { runWithRetry } from "./retryUtils.js";
@@ -110,7 +112,13 @@ export async function createNewFluidFile(
 			summaryHandle,
 		);
 		// caching the converted summary
-		await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);
+		await epochTracker.put(
+			createCacheSnapshotKey(
+				odspResolvedUrl,
+				snapshotWithLoadingGroupIdSupported(loggerToMonitoringContext(logger).config),
+			),
+			snapshot,
+		);
 	}
 	return odspResolvedUrl;
 }

package/src/createNewContainerOnExistingFile.ts

@@ -11,7 +11,10 @@ import {
 	IOdspResolvedUrl,
 	InstrumentedStorageTokenFetcher,
 } from "@fluidframework/odsp-driver-definitions/internal";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import {
+	ITelemetryLoggerExt,
+	loggerToMonitoringContext,
+} from "@fluidframework/telemetry-utils/internal";
 
 import { IWriteSummaryResponse } from "./contracts.js";
 import { ClpCompliantAppHeader } from "./contractsPublic.js";
@@ -24,7 +27,11 @@ import { createOdspUrl } from "./createOdspUrl.js";
 import { EpochTracker } from "./epochTracker.js";
 import { OdspDriverUrlResolver } from "./odspDriverUrlResolver.js";
 import { getApiRoot } from "./odspUrlHelper.js";
-import { IExistingFileInfo, createCacheSnapshotKey } from "./odspUtils.js";
+import {
+	IExistingFileInfo,
+	createCacheSnapshotKey,
+	snapshotWithLoadingGroupIdSupported,
+} from "./odspUtils.js";
 
 /**
  * Creates a new Fluid container on an existing file.
@@ -87,7 +94,13 @@ export async function createNewContainerOnExistingFile(
 			summaryHandle,
 		);
 		// caching the converted summary
-		await epochTracker.put(createCacheSnapshotKey(odspResolvedUrl), snapshot);
+		await epochTracker.put(
+			createCacheSnapshotKey(
+				odspResolvedUrl,
+				snapshotWithLoadingGroupIdSupported(loggerToMonitoringContext(logger).config),
+			),
+			snapshot,
+		);
 	}
 
 	return odspResolvedUrl;

package/src/epochTracker.ts

@@ -21,6 +21,7 @@ import {
 	OdspErrorTypes,
 	maximumCacheDurationMs,
 	snapshotKey,
+	snapshotWithLoadingGroupIdKey,
 } from "@fluidframework/odsp-driver-definitions/internal";
 import {
 	ITelemetryLoggerExt,
@@ -146,7 +147,7 @@ export class EpochTracker implements IPersistedFileCache {
 			}
 			// Expire the cached snapshot if it's older than snapshotCacheExpiryTimeoutMs and immediately
 			// expire all old caches that do not have cacheEntryTime
-			if (entry.type === snapshotKey) {
+			if (entry.type === snapshotKey || entry.type === snapshotWithLoadingGroupIdKey) {
 				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
 				const cacheTime = value.value?.cacheEntryTime;
 				const currentTime = Date.now();
@@ -177,7 +178,7 @@ export class EpochTracker implements IPersistedFileCache {
 		assert(this._fluidEpoch !== undefined, 0x1dd /* "no epoch" */);
 		// For snapshots, the value should have the cacheEntryTime.
 		// This will be used to expire snapshots older than snapshotCacheExpiryTimeoutMs.
-		if (entry.type === snapshotKey) {
+		if (entry.type === snapshotKey || entry.type === snapshotWithLoadingGroupIdKey) {
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
 			value.cacheEntryTime = value.cacheEntryTime ?? Date.now();
 		}
@@ -519,7 +520,7 @@ export class EpochTrackerWithRedemption extends EpochTracker {
 		let result = super.get(entry);
 
 		// equivalence of what happens in fetchAndParseAsJSON()
-		if (entry.type === snapshotKey) {
+		if (entry.type === snapshotKey || entry.type === snapshotWithLoadingGroupIdKey) {
 			result = result
 				.then((value) => {
 					// If there is nothing in cache, we need to wait for network call to complete (and do redemption)

package/src/odspDocumentStorageManager.ts

@@ -32,6 +32,7 @@ import {
 	loggerToMonitoringContext,
 	normalizeError,
 	overwriteStack,
+	type IConfigProvider,
 } from "@fluidframework/telemetry-utils/internal";
 
 import {
@@ -62,6 +63,7 @@ import {
 	getWithRetryForTokenRefresh,
 	isInstanceOfISnapshot,
 	isSnapshotFetchForLoadingGroup,
+	snapshotWithLoadingGroupIdSupported,
 	useLegacyFlowWithoutGroupsForSnapshotFetch,
 	type TokenFetchOptionsEx,
 } from "./odspUtils.js";
@@ -85,6 +87,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 	private readonly snapshotUrl: string | undefined;
 	private readonly attachmentPOSTUrl: string | undefined;
 	private readonly attachmentGETUrl: string | undefined;
+	private readonly config: IConfigProvider;
 	// Driver specified limits for snapshot size and time.
 	/**
 	 * NOTE: While commit cfff6e3 added restrictions to prevent large payloads, snapshot failures will continue to
@@ -115,6 +118,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 		this.snapshotUrl = this.odspResolvedUrl.endpoints.snapshotStorageUrl;
 		this.attachmentPOSTUrl = this.odspResolvedUrl.endpoints.attachmentPOSTStorageUrl;
 		this.attachmentGETUrl = this.odspResolvedUrl.endpoints.attachmentGETStorageUrl;
+		this.config = loggerToMonitoringContext(logger).config;
 	}
 
 	public get isFirstSnapshotFromNetwork(): boolean | undefined {
@@ -278,7 +282,12 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 					// Here's the logic to grab the persistent cache snapshot implemented by the host
 					// Epoch tracker is responsible for communicating with the persistent cache, handling epochs and cache versions
 					const cachedSnapshotP: Promise<ISnapshot | undefined> = this.epochTracker
-						.get(createCacheSnapshotKey(this.odspResolvedUrl))
+						.get(
+							createCacheSnapshotKey(
+								this.odspResolvedUrl,
+								snapshotWithLoadingGroupIdSupported(this.config),
+							),
+						)
 						.then(
 							async (
 								// eslint-disable-next-line import/no-deprecated
@@ -564,7 +573,10 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 		// for initial snapshot, don't consult the prefetch cache.
 		if (!this.hostPolicy.avoidPrefetchSnapshotCache && this.firstSnapshotFetchCall) {
 			const prefetchCacheKey = getKeyForCacheEntry(
-				createCacheSnapshotKey(this.odspResolvedUrl),
+				createCacheSnapshotKey(
+					this.odspResolvedUrl,
+					snapshotWithLoadingGroupIdSupported(this.config),
+				),
 			);
 			const result = await this.cache.snapshotPrefetchResultCache
 				?.get(prefetchCacheKey)
@@ -627,7 +639,10 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 		};
 		const putInCache = async (valueWithEpoch: IVersionedValueWithEpoch): Promise<void> => {
 			return this.cache.persistedCache.put(
-				createCacheSnapshotKey(this.odspResolvedUrl),
+				createCacheSnapshotKey(
+					this.odspResolvedUrl,
+					snapshotWithLoadingGroupIdSupported(this.config),
+				),
 				// Epoch tracker will add the epoch and version to the value here. So just send value to cache.
 				valueWithEpoch.value,
 			);

package/src/odspUtils.ts

@@ -38,8 +38,10 @@ import {
 	isTokenFromCache,
 	snapshotKey,
 	tokenFromResponse,
+	snapshotWithLoadingGroupIdKey,
 } from "@fluidframework/odsp-driver-definitions/internal";
 import {
+	type IConfigProvider,
 	type IFluidErrorBase,
 	ITelemetryLoggerExt,
 	PerformanceEvent,
@@ -452,9 +454,12 @@ export function toInstrumentedOdspTokenFetcher(
 	};
 }
 
-export function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICacheEntry {
+export function createCacheSnapshotKey(
+	odspResolvedUrl: IOdspResolvedUrl,
+	snapshotWithLoadingGroupId: boolean | undefined,
+): ICacheEntry {
 	const cacheEntry: ICacheEntry = {
-		type: snapshotKey,
+		type: snapshotWithLoadingGroupId ? snapshotWithLoadingGroupIdKey : snapshotKey,
 		key: odspResolvedUrl.fileVersion ?? "",
 		file: {
 			resolvedUrl: odspResolvedUrl,
@@ -464,6 +469,12 @@ export function createCacheSnapshotKey(odspResolvedUrl: IOdspResolvedUrl): ICach
 	return cacheEntry;
 }
 
+export function snapshotWithLoadingGroupIdSupported(
+	config: IConfigProvider,
+): boolean | undefined {
+	return config.getBoolean("Fluid.Container.UseLoadingGroupIdForSnapshotFetch2");
+}
+
 // 80KB is the max body size that we can put in ump post body for server to be able to accept it.
 // Keeping it 78KB to be a little cautious. As per the telemetry 99p is less than 78KB.
 export const maxUmpPostBodySize = 79872;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/odsp-driver";
-export const pkgVersion = "2.0.4";
+export const pkgVersion = "2.0.6";

package/src/prefetchLatestSnapshot.ts

@@ -35,6 +35,7 @@ import {
 	createCacheSnapshotKey,
 	createOdspLogger,
 	getOdspResolvedUrl,
+	snapshotWithLoadingGroupIdSupported,
 	toInstrumentedOdspStorageTokenFetcher,
 	type TokenFetchOptionsEx,
 } from "./odspUtils.js";
@@ -75,9 +76,7 @@ export async function prefetchLatestSnapshot(
 ): Promise<boolean> {
 	const mc = createChildMonitoringContext({ logger, namespace: "PrefetchSnapshot" });
 	const odspLogger = createOdspLogger(mc.logger);
-	const useGroupIdsForSnapshotFetch = mc.config.getBoolean(
-		"Fluid.Container.UseLoadingGroupIdForSnapshotFetch2",
-	);
+	const useGroupIdsForSnapshotFetch = snapshotWithLoadingGroupIdSupported(mc.config);
 	// For prefetch, we just want to fetch the ungrouped data and want to use the new API if the
 	// feature gate is set, so provide an empty array.
 	const loadingGroupIds = useGroupIdsForSnapshotFetch ? [] : undefined;
@@ -112,7 +111,7 @@ export async function prefetchLatestSnapshot(
 			controller,
 		);
 	};
-	const snapshotKey = createCacheSnapshotKey(odspResolvedUrl);
+	const snapshotKey = createCacheSnapshotKey(odspResolvedUrl, useGroupIdsForSnapshotFetch);
 	let cacheP: Promise<void> | undefined;
 	let snapshotEpoch: string | undefined;
 	const putInCache = async (valueWithEpoch: IVersionedValueWithEpoch): Promise<void> => {