@fluidframework/odsp-driver 2.13.0 → 2.20.0

package/src/fetchSnapshot.ts

@@ -150,13 +150,8 @@ export async function fetchSnapshotWithRedeem(
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
 			if (enableRedeemFallback && isRedeemSharingLinkError(odspResolvedUrl, error)) {
 				// Execute the redeem fallback
+				await redeemSharingLink(odspResolvedUrl, storageTokenFetcher, logger);
 
-				await redeemSharingLink(
-					odspResolvedUrl,
-					storageTokenFetcher,
-					logger,
-					forceAccessTokenViaAuthorizationHeader,
-				);
 				const odspResolvedUrlWithoutShareLink: IOdspResolvedUrl = {
 					...odspResolvedUrl,
 					shareLinkInfo: {
@@ -213,7 +208,6 @@ async function redeemSharingLink(
 	odspResolvedUrl: IOdspResolvedUrl,
 	getAuthHeader: InstrumentedStorageTokenFetcher,
 	logger: ITelemetryLoggerExt,
-	forceAccessTokenViaAuthorizationHeader: boolean,
 ): Promise<void> {
 	await PerformanceEvent.timedExecAsync(
 		logger,
@@ -233,7 +227,12 @@ async function redeemSharingLink(
 			let redeemUrl: string | undefined;
 			async function callSharesAPI(baseUrl: string): Promise<void> {
 				await getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
-					redeemUrl = `${baseUrl}/_api/v2.0/shares/${encodedShareUrl}`;
+					// IMPORTANT: Note that redeemUrl has '/driveItem' in it. Technically it is not required for executing redeem operation.
+					// However, we have other cases that use '/shares' API and do require to specify '/driveItem' in order to get specific
+					// drive item properties. The reason this matters is when caller of this API must possess logical permissions to call
+					// this API (for instance, this will be the case when call is made with app-only token) then two separate logical
+					// permissions are needed for the '/shares' call with and without '/driveItem'.
+					redeemUrl = `${baseUrl}/_api/v2.0/shares/${encodedShareUrl}/driveItem`;
 					const url = redeemUrl;
 					const method = "GET";
 					const authHeader = await getAuthHeader(

package/src/getFileLink.ts

@@ -102,7 +102,7 @@ export async function getFileLink(
 }
 
 /**
- * Handles location redirection while fulfilling the getFilelink call. We don't want browser to handle
+ * Handles location redirection while fulfilling the getFileLink call. We don't want browser to handle
  * the redirection as the browser will retry with same auth token which will not work as we need app
  * to regenerate tokens for the new site domain. So when we will make the network calls below we will set
  * the redirect:manual header to manually handle these redirects.
@@ -125,7 +125,7 @@ async function getFileLinkWithLocationRedirectionHandling(
 	let locationRedirected = false;
 	for (let count = 1; count <= 5; count++) {
 		try {
-			const fileItem = await getFileItemLite(getToken, resolvedUrl, logger, true);
+			const fileItem = await getFileItemLite(getToken, resolvedUrl, logger);
 			// Sometimes the siteUrl in the actual file is different from the siteUrl in the resolvedUrl due to location
 			// redirection. This creates issues in the getSharingInformation call. So we need to update the siteUrl in the
 			// resolvedUrl to the siteUrl in the fileItem which is the updated siteUrl.
@@ -260,7 +260,6 @@ async function getFileItemLite(
 	getToken: TokenFetcher<OdspResourceTokenFetchOptions>,
 	odspUrlParts: IOdspUrlParts,
 	logger: ITelemetryLoggerExt,
-	forceAccessTokenViaAuthorizationHeader: boolean,
 ): Promise<FileItemLite> {
 	return PerformanceEvent.timedExecAsync(
 		logger,

package/src/odspDelayLoadedDeltaStream.ts

@@ -91,7 +91,7 @@ export class OdspDelayLoadedDeltaStream {
 			| undefined,
 		private readonly mc: MonitoringContext,
 		private readonly cache: IOdspCache,
-		_hostPolicy: HostStoragePolicy,
+		private readonly hostPolicy: HostStoragePolicy,
 		private readonly epochTracker: EpochTracker,
 		private readonly opsReceived: (ops: ISequencedDocumentMessage[]) => void,
 		private readonly metadataUpdateHandler: (metadata: Record<string, string>) => void,
@@ -156,6 +156,8 @@ export class OdspDelayLoadedDeltaStream {
 				requestWebsocketTokenFromJoinSession,
 				options,
 				false /* isRefreshingJoinSession */,
+				undefined /* clientId */,
+				this.hostPolicy.sessionOptions?.displayName,
 			);
 			const [websocketEndpoint, websocketToken] = await Promise.all([
 				joinSessionPromise.catch(annotateAndRethrowConnectionError("joinSession")),
@@ -273,6 +275,7 @@ export class OdspDelayLoadedDeltaStream {
 		delta: number,
 		requestSocketToken: boolean,
 		clientId: string | undefined,
+		displayName: string | undefined,
 	): Promise<void> {
 		if (this.joinSessionRefreshTimer !== undefined) {
 			this.clearJoinSessionTimer();
@@ -301,6 +304,7 @@ export class OdspDelayLoadedDeltaStream {
 						options,
 						true /* isRefreshingJoinSession */,
 						clientId,
+						displayName,
 					);
 					resolve();
 				}).catch((error) => {
@@ -314,7 +318,8 @@ export class OdspDelayLoadedDeltaStream {
 		requestSocketToken: boolean,
 		options: TokenFetchOptionsEx,
 		isRefreshingJoinSession: boolean,
-		clientId?: string,
+		clientId: string | undefined,
+		displayName: string | undefined,
 	): Promise<ISocketStorageDiscovery> {
 		// If this call is to refresh the join session for the current connection but we are already disconnected in
 		// the meantime or disconnected and then reconnected then do not make the call. However, we should not have
@@ -342,6 +347,7 @@ export class OdspDelayLoadedDeltaStream {
 			requestSocketToken,
 			options,
 			isRefreshingJoinSession,
+			displayName,
 		).catch((error) => {
 			if (hasFacetCodes(error) && error.facetCodes !== undefined) {
 				for (const code of error.facetCodes) {
@@ -378,6 +384,7 @@ export class OdspDelayLoadedDeltaStream {
 		requestSocketToken: boolean,
 		options: TokenFetchOptionsEx,
 		isRefreshingJoinSession: boolean,
+		displayName: string | undefined,
 	): Promise<ISocketStorageDiscovery> {
 		const disableJoinSessionRefresh = this.mc.config.getBoolean(
 			"Fluid.Driver.Odsp.disableJoinSessionRefresh",
@@ -397,6 +404,7 @@ export class OdspDelayLoadedDeltaStream {
 				options,
 				disableJoinSessionRefresh,
 				isRefreshingJoinSession,
+				displayName,
 			);
 			// Emit event only in case it is fetched from the network.
 			if (joinSessionResponse.sensitivityLabelsInfo !== undefined) {
@@ -450,6 +458,7 @@ export class OdspDelayLoadedDeltaStream {
 					response.refreshAfterDeltaMs,
 					requestSocketToken,
 					this.currentConnection?.clientId,
+					displayName,
 				).catch((error) => {
 					// Log the error and do nothing as the reconnection would fetch the join session.
 					this.mc.logger.sendTelemetryEvent(

package/src/odspDocumentStorageServiceBase.ts

@@ -257,9 +257,8 @@ export abstract class OdspDocumentStorageServiceBase implements IDocumentStorage
 	protected combineProtocolAndAppSnapshotTree(snapshotTree: ISnapshotTree): ISnapshotTree {
 		// When we upload the container snapshot, we upload appTree in ".app" and protocol tree in ".protocol"
 		// So when we request the snapshot we get ".app" as tree and not as commit node as in the case just above.
-		const hierarchicalAppTree: ISnapshotTree | undefined = snapshotTree.trees[".app"];
-		const hierarchicalProtocolTree: ISnapshotTree | undefined =
-			snapshotTree.trees[".protocol"];
+		const hierarchicalAppTree = snapshotTree.trees[".app"];
+		const hierarchicalProtocolTree = snapshotTree.trees[".protocol"];
 		const summarySnapshotTree: ISnapshotTree = {
 			blobs: {
 				...hierarchicalAppTree.blobs,

package/src/odspDriverUrlResolver.ts

@@ -108,7 +108,7 @@ export class OdspDriverUrlResolver implements IUrlResolver {
 
 			const searchParams = new URLSearchParams(queryString);
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
-			const fileName: string = request.headers[DriverHeader.createNew]?.fileName;
+			const fileName: string = request.headers[DriverHeader.createNew].fileName;
 			const driveID = searchParams.get("driveId");
 			const filePath = searchParams.get("path");
 			const packageName = searchParams.get("containerPackageName");

package/src/packageVersion.ts

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

package/src/vroom.ts

@@ -21,8 +21,8 @@ import { TokenFetchOptionsEx } from "./odspUtils.js";
 import { runWithRetry } from "./retryUtils.js";
 
 interface IJoinSessionBody {
-	requestSocketToken: boolean;
-	guestDisplayName?: string;
+	requestSocketToken?: boolean;
+	displayName?: string;
 }
 
 /**
@@ -38,8 +38,9 @@ interface IJoinSessionBody {
  * @param options - Options to fetch the token.
  * @param disableJoinSessionRefresh - Whether the caller wants to disable refreshing join session periodically.
  * @param isRefreshingJoinSession - whether call is to refresh the session before expiry.
- * @param guestDisplayName - display name used to identify guest user joining a session.
- * This is optional and used only when collab session is being joined via invite.
+ * @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).
+ * If not specified client display name is extracted from the access token that is used to join session.
  */
 export async function fetchJoinSession(
 	urlParts: IOdspUrlParts,
@@ -52,6 +53,7 @@ export async function fetchJoinSession(
 	options: TokenFetchOptionsEx,
 	disableJoinSessionRefresh: boolean | undefined,
 	isRefreshingJoinSession: boolean,
+	displayName: string | undefined,
 ): Promise<ISocketStorageDiscovery> {
 	const apiRoot = getApiRoot(new URL(urlParts.siteUrl));
 	const url = `${apiRoot}/drives/${urlParts.driveId}/items/${urlParts.itemId}/${path}?ump=1`;
@@ -89,11 +91,15 @@ export async function fetchJoinSession(
 			}
 			postBody += `_post: 1\r\n`;
 
+			let requestBody: IJoinSessionBody | undefined;
 			if (requestSocketToken) {
-				const body: IJoinSessionBody = {
-					requestSocketToken: true,
-				};
-				postBody += `\r\n${JSON.stringify(body)}\r\n`;
+				requestBody = { ...requestBody, requestSocketToken: true };
+			}
+			if (displayName) {
+				requestBody = { ...requestBody, displayName };
+			}
+			if (requestBody) {
+				postBody += `\r\n${JSON.stringify(requestBody)}\r\n`;
 			}
 			postBody += `\r\n--${formBoundary}--`;
 			const headers: { [index: string]: string } = {