Update odsp driver for new header

packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.legacy.alpha.api.md

@@ -241,6 +241,7 @@ export interface ShareLinkInfoType {
         error?: any;
         shareId?: string;
     };
+    isNonDurableRedeem?: boolean;
     sharingLinkToRedeem?: string;
 }
 

packages/drivers/odsp-driver-definitions/src/resolvedUrl.ts

@@ -95,6 +95,11 @@ export interface ShareLinkInfoType {
 	 * permission then this link can be redeemed for the permissions in the same network call.
 	 */
 	sharingLinkToRedeem?: string;
+
+	/**
+	 * If the sharing link to redeem is a non-durable link, this flag will be set to true.
+	 */
+	isNonDurableRedeem?: boolean;
 }
 /**
  * @legacy

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

@@ -24,13 +24,17 @@ export enum SharingLinkHeader {
 	// Can be used in request made to resolver, to tell the resolver that the passed in URL is a sharing link
 	// which can be redeemed at server to get permissions.
 	isSharingLinkToRedeem = "isSharingLinkToRedeem",
+	// When isSharingLinkToRedeem is true, this header can be used to tell the server that the sharing link
+	// is a non-durable link
+	isNonDurableRedeem = "isNonDurableRedeem",
 }
 
 /**
  * @internal
  */
 export interface ISharingLinkHeader {
 	[SharingLinkHeader.isSharingLinkToRedeem]: boolean;
+	[SharingLinkHeader.isNonDurableRedeem]: boolean;
 }
 /**
  * @internal

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

@@ -224,6 +224,9 @@ async function redeemSharingLink(
 				odspResolvedUrl.shareLinkInfo?.sharingLinkToRedeem,
 			);
 
+			const isNonDurableRedeem: boolean =
+				odspResolvedUrl.shareLinkInfo?.isNonDurableRedeem === true;
+
 			let redeemUrl: string | undefined;
 			async function callSharesAPI(baseUrl: string): Promise<void> {
 				await getWithRetryForTokenRefresh(async (tokenFetchOptions) => {
@@ -241,6 +244,9 @@ async function redeemSharingLink(
 					);
 					const headers = getHeadersWithAuth(authHeader);
 					headers.prefer = "redeemSharingLink";
+					if (isNonDurableRedeem) {
+						headers.prefer = "nonDurableRedeem";
+					}
 					await fetchAndParseAsJSONHelper(url, { headers, method });
 				});
 			}
@@ -724,11 +730,16 @@ export const downloadSnapshot = mockify(
 		const queryString = getQueryString(queryParams);
 		const url = `${snapshotUrl}/trees/latest${queryString}`;
 		const method = "POST";
+		const isNonDurableRedeem: boolean =
+			odspResolvedUrl.shareLinkInfo?.isNonDurableRedeem === true;
 		// The location of file can move on Spo in which case server returns 308(Permanent Redirect) error.
 		// Adding below header will make VROOM API return 404 instead of 308 and browser can 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 header = { prefer: "manualredirect" };
+		// If the share link is non-durable, we will add the nonDurableRedeem header to the header.prefer.
+		const header = isNonDurableRedeem
+			? { prefer: "manualredirect, nonDurableRedeem" }
+			: { prefer: "manualredirect" };
 		const authHeader = await getAuthHeader(
 			{ ...tokenFetchOptions, request: { url, method } },
 			"downloadSnapshot",

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

@@ -137,6 +137,8 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
 		const requestToBeResolved = { headers: request.headers, url: request.url };
 		const isSharingLinkToRedeem =
 			requestToBeResolved.headers?.[SharingLinkHeader.isSharingLinkToRedeem];
+		const isNonDurableRedeem =
+			requestToBeResolved.headers?.[SharingLinkHeader.isNonDurableRedeem];
 		try {
 			const url = new URL(request.url);
 
@@ -168,6 +170,11 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
 			odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo ?? {}, {
 				sharingLinkToRedeem: this.removeNavParam(request.url),
 			});
+			if (isNonDurableRedeem) {
+				odspResolvedUrl.shareLinkInfo = Object.assign(odspResolvedUrl.shareLinkInfo ?? {}, {
+					isNonDurableRedeem: true,
+				});
+			}
 		}
 		if (odspResolvedUrl.itemId) {
 			// Kick start the sharing link request if we don't have it already as a performance optimization.

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

@@ -356,6 +356,41 @@ describe("Tests for OdspDriverUrlResolverForShareLink resolver", () => {
 		);
 	});
 
+	it("isNonDurableRedeem should be set when isNonDurableRedeem header is set", async () => {
+		const url = new URL(sharelink);
+		const resolvedUrl = await mockGetFileLink(Promise.resolve(sharelink), async () => {
+			storeLocatorInOdspUrl(url, { siteUrl, driveId, itemId, dataStorePath });
+			return urlResolverWithShareLinkFetcher.resolve({
+				url: url.toString(),
+				headers: {
+					[SharingLinkHeader.isSharingLinkToRedeem]: true,
+					[SharingLinkHeader.isNonDurableRedeem]: true,
+				},
+			});
+		});
+		assert(
+			resolvedUrl.shareLinkInfo?.isNonDurableRedeem === true,
+			"Sharing link should be set in resolved url",
+		);
+	});
+
+	it("isNonDurableRedeem should not be set when isSharingLinkToRedeem header is not set", async () => {
+		const url = new URL(sharelink);
+		const resolvedUrl = await mockGetFileLink(Promise.resolve(sharelink), async () => {
+			storeLocatorInOdspUrl(url, { siteUrl, driveId, itemId, dataStorePath });
+			return urlResolverWithShareLinkFetcher.resolve({
+				url: url.toString(),
+				headers: {
+					[SharingLinkHeader.isNonDurableRedeem]: true,
+				},
+			});
+		});
+		assert(
+			resolvedUrl.shareLinkInfo?.isNonDurableRedeem === undefined,
+			"Sharing link should not be set in resolved url",
+		);
+	});
+
 	it("Encode and decode nav param", async () => {
 		const encodedUrl = new URL(sharelink);
 		storeLocatorInOdspUrl(encodedUrl, {