@fluidframework/odsp-driver 2.93.0 → 2.101.0

package/src/epochTracker.ts

@@ -25,14 +25,18 @@ import {
 	snapshotKey,
 	snapshotWithLoadingGroupIdKey,
 } from "@fluidframework/odsp-driver-definitions/internal";
+import type { TelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import {
-	type ITelemetryLoggerExt,
 	PerformanceEvent,
+	extractTelemetryLoggerExt,
 	isFluidError,
 	loggerToMonitoringContext,
 	normalizeError,
+	toITelemetryLoggerExt,
 	wrapError,
 } from "@fluidframework/telemetry-utils/internal";
+// eslint-disable-next-line import-x/no-internal-modules -- Needed to avoid specialized /internal ITelemetryLoggerExt
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/legacy";
 import { v4 as uuid } from "uuid";
 
 import { type IVersionedValueWithEpoch, persistedCacheValueVersion } from "./contracts.js";
@@ -90,6 +94,9 @@ export const Odsp409Error = "Odsp409Error";
  * then it also clears all the cached entries for the given container.
  * @legacy
  * @beta
+ *
+ * @privateRemarks
+ * This class should be hidden and an interface exposed to better manage internal types like telemetry logger.
  */
 export class EpochTracker implements IPersistedFileCache {
 	private _fluidEpoch: string | undefined;
@@ -99,12 +106,15 @@ export class EpochTracker implements IPersistedFileCache {
 	private readonly driverId = uuid();
 	// This tracks the request number made by the driver instance.
 	private networkCallNumber = 1;
+	private readonly loggerInternal: TelemetryLoggerExt;
 	constructor(
 		protected readonly cache: IPersistedCache,
 		protected readonly fileEntry: IFileEntry,
 		protected readonly logger: ITelemetryLoggerExt,
 		protected readonly clientIsSummarizer?: boolean,
 	) {
+		this.loggerInternal = extractTelemetryLoggerExt(logger);
+
 		// Limits the max number of concurrent requests to 24.
 		this.rateLimiter = new RateLimiter(24);
 
@@ -121,7 +131,7 @@ export class EpochTracker implements IPersistedFileCache {
 		assert(this._fluidEpoch === undefined, 0x1db /* "epoch exists" */);
 		this._fluidEpoch = epoch;
 
-		this.logger.sendTelemetryEvent({
+		this.loggerInternal.sendTelemetryEvent({
 			eventName: "EpochLearnedFirstTime",
 			epoch,
 			fetchType,
@@ -137,7 +147,7 @@ export class EpochTracker implements IPersistedFileCache {
 			const value = (await this.cache.get(
 				this.fileEntryFromEntry(entry),
 			)) as IVersionedValueWithEpoch;
-			// Version mismatch between what the runtime expects and what it recieved.
+			// Version mismatch between what the runtime expects and what it received.
 			// The cached value should not be used
 			// eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- using ?. could change behavior
 			if (value === undefined || value.version !== persistedCacheValueVersion) {
@@ -161,7 +171,7 @@ export class EpochTracker implements IPersistedFileCache {
 					cacheTime === undefined ||
 					currentTime - cacheTime >= this.snapshotCacheExpiryTimeoutMs
 				) {
-					this.logger.sendTelemetryEvent({
+					this.loggerInternal.sendTelemetryEvent({
 						eventName: "odspVersionsCacheExpired",
 						duration: currentTime - cacheTime,
 						maxCacheAgeMs: this.snapshotCacheExpiryTimeoutMs,
@@ -172,7 +182,10 @@ export class EpochTracker implements IPersistedFileCache {
 			}
 			return value.value;
 		} catch (error) {
-			this.logger.sendErrorEvent({ eventName: "cacheFetchError", type: entry.type }, error);
+			this.loggerInternal.sendErrorEvent(
+				{ eventName: "cacheFetchError", type: entry.type },
+				error,
+			);
 			return undefined;
 		}
 	}
@@ -194,7 +207,10 @@ export class EpochTracker implements IPersistedFileCache {
 			fluidEpoch: this._fluidEpoch,
 		};
 		return this.cache.put(this.fileEntryFromEntry(entry), data).catch((error) => {
-			this.logger.sendErrorEvent({ eventName: "cachePutError", type: entry.type }, error);
+			this.loggerInternal.sendErrorEvent(
+				{ eventName: "cachePutError", type: entry.type },
+				error,
+			);
 			throw error;
 		});
 	}
@@ -203,7 +219,7 @@ export class EpochTracker implements IPersistedFileCache {
 		try {
 			return await this.cache.removeEntries(this.fileEntry);
 		} catch (error) {
-			this.logger.sendErrorEvent({ eventName: "removeCacheEntries" }, error);
+			this.loggerInternal.sendErrorEvent({ eventName: "removeCacheEntries" }, error);
 		}
 	}
 
@@ -456,7 +472,10 @@ export class EpochTracker implements IPersistedFileCache {
 					fromCache,
 					fetchType,
 				});
-				this.logger.sendErrorEvent({ eventName: "fileOverwrittenInStorage" }, epochError);
+				this.loggerInternal.sendErrorEvent(
+					{ eventName: "fileOverwrittenInStorage" },
+					epochError,
+				);
 				// If the epoch mismatches, then clear all entries for such file entry from cache.
 				await this.removeEntries();
 				throw epochError;
@@ -502,10 +521,10 @@ export class EpochTrackerWithRedemption extends EpochTracker {
 	constructor(
 		protected readonly cache: IPersistedCache,
 		protected readonly fileEntry: IFileEntry,
-		protected readonly logger: ITelemetryLoggerExt,
+		logger: TelemetryLoggerExt,
 		protected readonly clientIsSummarizer?: boolean,
 	) {
-		super(cache, fileEntry, logger, clientIsSummarizer);
+		super(cache, fileEntry, toITelemetryLoggerExt(logger), clientIsSummarizer);
 		// Handles the rejected promise within treesLatestDeferral.
 		this.treesLatestDeferral.promise.catch(() => {});
 	}
@@ -635,7 +654,7 @@ export function createOdspCacheAndTracker(
 	persistedCacheArg: IPersistedCache,
 	nonpersistentCache: INonPersistentCache,
 	fileEntry: IFileEntry,
-	logger: ITelemetryLoggerExt,
+	logger: TelemetryLoggerExt,
 	clientIsSummarizer?: boolean,
 ): ICacheAndTracker {
 	const epochTracker = new EpochTrackerWithRedemption(

package/src/fetchSnapshot.ts

@@ -28,8 +28,8 @@ import {
 	type InstrumentedStorageTokenFetcher,
 	OdspErrorTypes,
 } from "@fluidframework/odsp-driver-definitions/internal";
+import type { TelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import {
-	type ITelemetryLoggerExt,
 	PerformanceEvent,
 	isFluidError,
 	wrapError,
@@ -94,7 +94,7 @@ export async function fetchSnapshot(
 	versionId: string,
 	fetchFullSnapshot: boolean,
 	forceAccessTokenViaAuthorizationHeader: boolean,
-	logger: ITelemetryLoggerExt,
+	logger: TelemetryLoggerExt,
 	snapshotDownloader: (url: string) => Promise<IOdspResponse<unknown>>,
 ): Promise<ISnapshot> {
 	const path = `/trees/${versionId}`;
@@ -121,7 +121,7 @@ export async function fetchSnapshotWithRedeem(
 	storageTokenFetcher: InstrumentedStorageTokenFetcher,
 	snapshotOptions: ISnapshotOptions | undefined,
 	forceAccessTokenViaAuthorizationHeader: boolean,
-	logger: ITelemetryLoggerExt,
+	logger: TelemetryLoggerExt,
 	snapshotDownloader: (
 		finalOdspResolvedUrl: IOdspResolvedUrl,
 		getAuthHeader: InstrumentedStorageTokenFetcher,
@@ -239,7 +239,7 @@ export async function fetchSnapshotWithRedeem(
 async function redeemSharingLink(
 	odspResolvedUrl: IOdspResolvedUrl,
 	getAuthHeader: InstrumentedStorageTokenFetcher,
-	logger: ITelemetryLoggerExt,
+	logger: TelemetryLoggerExt,
 ): Promise<void> {
 	await PerformanceEvent.timedExecAsync(
 		logger,
@@ -306,7 +306,7 @@ async function fetchLatestSnapshotCore(
 	odspResolvedUrl: IOdspResolvedUrl,
 	getAuthHeader: InstrumentedStorageTokenFetcher,
 	snapshotOptions: ISnapshotOptions | undefined,
-	logger: ITelemetryLoggerExt,
+	logger: TelemetryLoggerExt,
 	snapshotDownloader: (
 		finalOdspResolvedUrl: IOdspResolvedUrl,
 		getAuthHeader: InstrumentedStorageTokenFetcher,
@@ -713,15 +713,18 @@ function getTreeStatsCore(snapshotTree: ISnapshotTree, stats: ITreeStats): void
 /**
  * This function fetches the snapshot and parse it according to what is mentioned in response headers.
  * @param odspResolvedUrl - resolved odsp url.
- * @param storageToken - token to do the auth for network request.
- * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
+ * @param getAuthHeader - function to fetch the auth header for the network request.
+ * @param tokenFetchOptions - options for fetching the token.
  * @param loadingGroupIds - loadingGroupIds for which snapshot needs to be downloaded. Note:
  * 1.) If undefined, then legacy trees latest call will be used where no groupId query param would be specified.
  * 2.) If [] is passed, then snapshot with all ungrouped data will be fetched.
  * 3.) If any groupId is specified like ["g1"], then snapshot for g1 group will be fetched.
+ * @param snapshotOptions - Options used to specify how and what to fetch in the snapshot.
+ * @param logger - logger for sending telemetry events.
  * @param snapshotFormatFetchType - Snapshot format to fetch.
  * @param controller - abort controller if caller needs to abort the network call.
  * @param epochTracker - epoch tracker used to add/validate epoch in the network call.
+ * @param scenarioName - scenario name for telemetry.
  * @returns fetched snapshot.
  */
 export const downloadSnapshot = mockify(
@@ -731,6 +734,7 @@ export const downloadSnapshot = mockify(
 		tokenFetchOptions: TokenFetchOptionsEx,
 		loadingGroupIds: string[] | undefined,
 		snapshotOptions: ISnapshotOptions | undefined,
+		logger?: TelemetryLoggerExt,
 		snapshotFormatFetchType?: SnapshotFormatSupportType,
 		controller?: AbortController,
 		epochTracker?: EpochTracker,
@@ -787,6 +791,7 @@ export const downloadSnapshot = mockify(
 			"downloadSnapshot",
 		);
 		assert(authHeader !== null, 0x1e5 /* "Storage token should not be null" */);
+		logger?.sendTelemetryEvent({ eventName: "SnapshotAuthHeaderObtained" });
 		const { body, headers } = getFormBodyAndHeaders(odspResolvedUrl, authHeader, header);
 		const fetchOptions = {
 			body,
@@ -813,6 +818,7 @@ export const downloadSnapshot = mockify(
 			true,
 			scenarioName,
 		) ?? fetchHelper(url, fetchOptions));
+		logger?.sendTelemetryEvent({ eventName: "SnapshotFetchResponseReceived" });
 
 		return {
 			odspResponse,

package/src/odspDelayLoadedDeltaStream.ts

@@ -416,10 +416,6 @@ export class OdspDelayLoadedDeltaStream {
 		const disableJoinSessionRefresh = this.mc.config.getBoolean(
 			"Fluid.Driver.Odsp.disableJoinSessionRefresh",
 		);
-		// Previous gate "Fluid.Driver.Odsp.setSensitivityLabelHeader" was removed because it was sensitive to a timestamp-related bug that was fixed by PR #26318; using this new gate ensures that the bug fix is present.
-		const setSensitivityLabelHeader = this.mc.config.getBoolean(
-			"Fluid.Driver.Odsp.setSensitivityLabelHeaderPostFix",
-		);
 		const executeFetch = async (): Promise<{
 			entryTime: number;
 			joinSessionResponse: ISocketStorageDiscovery;
@@ -434,7 +430,6 @@ export class OdspDelayLoadedDeltaStream {
 				requestSocketToken,
 				options,
 				disableJoinSessionRefresh,
-				setSensitivityLabelHeader,
 				isRefreshingJoinSession,
 				displayName,
 			);

package/src/odspDeltaStorageService.ts

@@ -4,6 +4,7 @@
  */
 
 import type { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
+import { LogLevel } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
 import { validateMessages } from "@fluidframework/driver-base/internal";
 import type {
@@ -246,13 +247,17 @@ export class OdspDeltaStorageWithCache implements IDocumentDeltaStorageService {
 
 		return streamObserver(stream, (result) => {
 			if (result.done && opsFromSnapshot + opsFromCache + opsFromStorage !== 0) {
-				this.logger.sendPerformanceEvent({
-					eventName: "CacheOpsRetrieved",
-					opsFromSnapshot,
-					opsFromCache,
-					opsFromStorage,
-					reason: fetchReason,
-				});
+				this.logger.sendPerformanceEvent(
+					{
+						eventName: "CacheOpsRetrieved",
+						opsFromSnapshot,
+						opsFromCache,
+						opsFromStorage,
+						reason: fetchReason,
+					},
+					undefined, // error
+					LogLevel.info,
+				);
 			}
 		});
 	}

package/src/odspDocumentStorageManager.ts

@@ -639,6 +639,7 @@ export class OdspDocumentStorageService extends OdspDocumentStorageServiceBase {
 				tokenFetchOptions,
 				loadingGroupId,
 				options,
+				this.logger,
 				this.snapshotFormatFetchType,
 				controller,
 				this.epochTracker,

package/src/packageVersion.ts

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

package/src/prefetchLatestSnapshot.ts

@@ -110,6 +110,7 @@ export async function prefetchLatestSnapshot(
 			tokenFetchOptions,
 			loadingGroupId,
 			snapshotOptions,
+			odspLogger,
 			undefined,
 			controller,
 		);
@@ -174,7 +175,7 @@ export async function prefetchLatestSnapshot(
 					}, 5000);
 				})
 				.catch((error) => {
-					// Remove it from the non persistent cache if an error occured.
+					// Remove it from the non persistent cache if an error occurred.
 					snapshotNonPersistentCache?.remove(nonPersistentCacheKey);
 					snapshotContentsWithEpochP.reject(error);
 					throw error;

package/src/vroom.ts

@@ -38,7 +38,6 @@ interface IJoinSessionBody {
  * which is used when establishing websocket connection with collab session backend service.
  * @param options - Options to fetch the token.
  * @param disableJoinSessionRefresh - Whether the caller wants to disable refreshing join session periodically.
- * @param setSensitivityLabelHeader - Whether the caller wants to set the Return-Sensitivity-Labels Prefer header in the join session request.
  * @param isRefreshingJoinSession - whether call is to refresh the session before expiry.
  * @param displayName - display name used to identify client joining a session.
  * This is optional and used only when collab session is being joined by client acting in app-only mode (i.e. without user context).
@@ -55,7 +54,6 @@ export const fetchJoinSession = mockify(
 		requestSocketToken: boolean,
 		options: TokenFetchOptionsEx,
 		disableJoinSessionRefresh: boolean | undefined,
-		setSensitivityLabelHeader: boolean | undefined,
 		isRefreshingJoinSession: boolean,
 		displayName: string | undefined,
 	): Promise<ISocketStorageDiscovery> => {
@@ -74,7 +72,6 @@ export const fetchJoinSession = mockify(
 			requestSocketToken,
 			...tokenRefreshProps,
 			refreshingSession: isRefreshingJoinSession,
-			setSensitivityLabelHeader: setSensitivityLabelHeader ?? false,
 		};
 
 		return PerformanceEvent.timedExecAsync(
@@ -94,9 +91,7 @@ export const fetchJoinSession = mockify(
 				if (!disableJoinSessionRefresh) {
 					postBody += `Prefer: FluidRemoveCheckAccess\r\n`;
 				}
-				if (setSensitivityLabelHeader) {
-					postBody += `Prefer: Return-Sensitivity-Labels\r\n`;
-				}
+				postBody += `Prefer: Return-Sensitivity-Labels\r\n`;
 				postBody += `_post: 1\r\n`;
 
 				let requestBody: IJoinSessionBody | undefined;