Handle location redirection URL error in getSharingInfo call in odsp driver

packages/drivers/odsp-driver/src/getFileLink.ts

@@ -11,8 +11,13 @@ import {
 	OdspErrorTypes,
 	OdspResourceTokenFetchOptions,
 	TokenFetcher,
+	type IOdspErrorAugmentations,
 } from "@fluidframework/odsp-driver-definitions/internal";
-import { ITelemetryLoggerExt, PerformanceEvent } from "@fluidframework/telemetry-utils/internal";
+import {
+	ITelemetryLoggerExt,
+	PerformanceEvent,
+	isFluidError,
+} from "@fluidframework/telemetry-utils/internal";
 
 import { getUrlAndHeadersWithAuth } from "./getUrlAndHeadersWithAuth.js";
 import {
@@ -55,7 +60,12 @@ export async function getFileLink(
 			fileLinkCore = await runWithRetry(
 				async () =>
 					runWithRetryForCoherencyAndServiceReadOnlyErrors(
-						async () => getFileLinkCore(getToken, odspUrlParts, logger),
+						async () =>
+							getFileLinkWithLocationRedirectionHandling(
+								getToken,
+								odspUrlParts,
+								logger,
+							),
 						"getFileLinkCore",
 						logger,
 					),
@@ -95,6 +105,48 @@ export async function getFileLink(
 	return fileLink;
 }
 
+/**
+ * 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.
+ * @param getToken - token fetcher to fetch the token.
+ * @param odspUrlParts - parts of odsp resolved url.
+ * @param logger - logger to send events.
+ * @returns Response from the API call.
+ * @alpha
+ */
+async function getFileLinkWithLocationRedirectionHandling(
+	getToken: TokenFetcher<OdspResourceTokenFetchOptions>,
+	odspUrlParts: IOdspUrlParts,
+	logger: ITelemetryLoggerExt,
+): Promise<string> {
+	// We can have chains of location redirection one after the other, so have a for loop
+	// so that we can keep handling the same type of error.
+	for (;;) {
+		try {
+			return await getFileLinkCore(getToken, odspUrlParts, logger);
+		} catch (error: unknown) {
+			if (
+				isFluidError(error) &&
+				error.errorType === OdspErrorTypes.fileNotFoundOrAccessDeniedError
+			) {
+				const redirectLocation = (error as IOdspErrorAugmentations).redirectLocation;
+				if (redirectLocation !== undefined) {
+					logger.sendTelemetryEvent({
+						eventName: "LocationRedirectionErrorForGetOdspFileLink",
+					});
+					// Generate the new SiteUrl from the redirection location.
+					const newSiteDomain = new URL(redirectLocation).origin;
+					const newSiteUrl = `${newSiteDomain}${new URL(odspUrlParts.siteUrl).pathname}`;
+					odspUrlParts.siteUrl = newSiteUrl;
+					continue;
+				}
+			}
+			throw error;
+		}
+	}
+}
+
 async function getFileLinkCore(
 	getToken: TokenFetcher<OdspResourceTokenFetchOptions>,
 	odspUrlParts: IOdspUrlParts,
@@ -133,11 +185,16 @@ async function getFileLinkCore(
 					storageToken,
 					true,
 				);
+				// The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
+				// Adding prefer: manualredirect header will make VROOM API return 404 instead of 308 and browser can not intercept it.
+				// This error thrown by server will contain the new redirect location. Look at the 404 error parsing
+				// for further reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
 				const requestInit = {
 					method: "POST",
 					headers: {
 						"Content-Type": "application/json;odata=verbose",
 						"Accept": "application/json;odata=verbose",
+						"prefer": "manualredirect",
 						...headers,
 					},
 				};
@@ -219,6 +276,11 @@ async function getFileItemLite(
 					storageToken,
 					forceAccessTokenViaAuthorizationHeader,
 				);
+				// The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
+				// Adding prefer: manualredirect header will make VROOM API return 404 instead of 308 and browser can not intercept it.
+				// This error thrown by server will contain the new redirect location. Look at the 404 error parsing
+				// for further reference here: \packages\utils\odsp-doclib-utils\src\odspErrorUtils.ts
+				headers.prefer = "manualredirect";
 				const requestInit = { method: "GET", headers };
 				const response = await fetchHelper(url, requestInit);
 				additionalProps = response.propsToLog;

packages/drivers/odsp-driver/src/test/getFileLink.spec.ts

@@ -20,6 +20,7 @@ import {
 
 describe("getFileLink", () => {
 	const siteUrl = "https://microsoft.sharepoint-df.com/siteUrl";
+	const newSiteUrl = "https://microsoft.sharepoint.com/siteUrl";
 	const driveId = "driveId";
 	const logger = new MockLogger();
 	const storageTokenFetcher = async (): Promise<string> => "StorageToken";
@@ -145,4 +146,101 @@ describe("getFileLink", () => {
 			"did not retries 5 times",
 		);
 	});
+
+	it("should handle location redirection once", async () => {
+		const result = await mockFetchMultiple(
+			async () =>
+				getFileLink(
+					storageTokenFetcher,
+					{ siteUrl, driveId, itemId: "itemId8" },
+					logger.toTelemetryLogger(),
+				),
+			[
+				async (): Promise<MockResponse> =>
+					createResponse(
+						{},
+						{
+							error: {
+								"message": "locationMoved",
+								"@error.redirectLocation": newSiteUrl,
+							},
+						},
+						404,
+					),
+				async (): Promise<MockResponse> => okResponse({}, fileItemResponse),
+				async (): Promise<MockResponse> =>
+					okResponse({}, { d: { directUrl: "sharelink" } }),
+			],
+		);
+		assert.strictEqual(
+			result,
+			"sharelink",
+			"File link should match url returned from sharing information",
+		);
+		// Should be present in cache now and subsequent calls should fetch from cache.
+		const sharelink2 = await getFileLink(
+			storageTokenFetcher,
+			{ siteUrl, driveId, itemId: "itemId8" },
+			logger.toTelemetryLogger(),
+		);
+		assert.strictEqual(
+			sharelink2,
+			"sharelink",
+			"File link should match url returned from sharing information from cache",
+		);
+	});
+
+	it("should handle location redirection multiple times", async () => {
+		const result = await mockFetchMultiple(
+			async () =>
+				getFileLink(
+					storageTokenFetcher,
+					{ siteUrl, driveId, itemId: "itemId9" },
+					logger.toTelemetryLogger(),
+				),
+			[
+				async (): Promise<MockResponse> =>
+					createResponse(
+						{},
+						{
+							error: {
+								"message": "locationMoved",
+								"@error.redirectLocation": newSiteUrl,
+							},
+						},
+						404,
+					),
+				async (): Promise<MockResponse> =>
+					createResponse(
+						{},
+						{
+							error: {
+								"message": "locationMoved",
+								"@error.redirectLocation": newSiteUrl,
+							},
+						},
+						404,
+					),
+				async (): Promise<MockResponse> => okResponse({}, fileItemResponse),
+				async (): Promise<MockResponse> =>
+					okResponse({}, { d: { directUrl: "sharelink" } }),
+			],
+		);
+		assert.strictEqual(
+			result,
+			"sharelink",
+			"File link should match url returned from sharing information",
+		);
+		// Should be present in cache now and subsequent calls should fetch from cache.
+		const sharelink2 = await getFileLink(
+			storageTokenFetcher,
+			{ siteUrl, driveId, itemId: "itemId9" },
+			logger.toTelemetryLogger(),
+		);
+		assert.strictEqual(
+			sharelink2,
+			"sharelink",
+			"File link should match url returned from sharing information from cache",
+		);
+	});
 });