Update odsp driver for new header #24819

MarioJGMsoft · 2025-06-10T22:45:30Z

Description

A new header variable is necessary when redeeming a share link so that a certain type of user has temporal access to the document to which the link points to.

Reviewer Guidance

Let me know if there's something I need to add or be aware of.

Fixes: AB#41357

Copilot

Pull Request Overview

Adds support for a new isNonDurableRedeem header to enable temporal, non-durable access via share links. Key changes include:

Extending the resolver and contracts to extract and propagate the new header.
Modifying snapshot redemption and download flows to honor the non-durable flag.
Updating public API definitions and adding unit tests for the new behavior.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/drivers/odsp-driver/src/test/odspDriverUrlResolverForShareLink.spec.ts	Added tests verifying `isNonDurableRedeem` is set or ignored
packages/drivers/odsp-driver/src/odspDriverUrlResolverForShareLink.ts	Extract and attach `isNonDurableRedeem` to `shareLinkInfo`
packages/drivers/odsp-driver/src/fetchSnapshot.ts	Propagate `isNonDurableRedeem` into `prefer` headers for redeem and download APIs
packages/drivers/odsp-driver/src/contractsPublic.ts	Extended `SharingLinkHeader` enum and internal interface
packages/drivers/odsp-driver-definitions/src/resolvedUrl.ts	Added `isNonDurableRedeem` to `ShareLinkInfoType`
packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.legacy.alpha.api.md	Updated API report with new field

Comments suppressed due to low confidence (4)

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

This header may be omitted in normal requests. Consider making the property optional ([SharingLinkHeader.isNonDurableRedeem]?: boolean) to reflect its conditional presence.

[SharingLinkHeader.isNonDurableRedeem]: boolean;

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

[nitpick] Rename header to headers to clarify that this object holds multiple HTTP headers and align with the naming used elsewhere in the file.

const header = isNonDurableRedeem

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

[nitpick] The assertion message is generic. Consider specifying that you expect the isNonDurableRedeem flag to be true (e.g., Expected isNonDurableRedeem to be true).

"Sharing link should be set in resolved url",

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

[nitpick] This assertion message could more clearly reference isNonDurableRedeem (e.g., Expected isNonDurableRedeem to be undefined).

"Sharing link should not be set in resolved url",

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

jatgarg · 2025-06-13T20:05:59Z

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.


Link is not non durable. its redeem is non durable. Please update the comment accordingly.

Applied changes

jatgarg · 2025-06-13T20:06:21Z

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

+	/**
+	 * If the sharing link to redeem is a non-durable link, this flag will be set to true.
+	 */
+	isNonDurableRedeem?: boolean;


isNonDurableRedeem -> doNonDurableRedeem?

Applied changes

jatgarg · 2025-06-13T20:07:18Z

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
+	NonDurableRedeem = "NonDurableRedeem",


lets use camel case, same as above.

Applied change

jatgarg · 2025-06-13T20:13:12Z

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

@@ -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 ?? {}, {


instead of doing it again, you can just do this above in the same assignment and set to true/false.

Applied change

jatgarg · 2025-06-13T20:14:20Z

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

@@ -241,6 +245,10 @@ async function redeemSharingLink(
 					);
 					const headers = getHeadersWithAuth(authHeader);
 					headers.prefer = "redeemSharingLink";
+					if (isNonDurableRedeem) {


You can use if/else to set to one or the other instead of setting it again.

Applied change

jatgarg · 2025-06-13T20:15:22Z

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

@@ -241,6 +245,10 @@ async function redeemSharingLink(
 					);
 					const headers = getHeadersWithAuth(authHeader);
 					headers.prefer = "redeemSharingLink";
+					if (isNonDurableRedeem) {
+						headers.prefer = "nonDurableRedeem";
+						setNDRHeader = true;


no, need of this. Just directly check and set in event.end and cancel.

Applied change

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

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

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

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

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

Josmithr · 2025-06-17T21:39:53Z

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

+	 * When a sharingLinkToRedeem is used, this parameter can be set to make the request with
+	 * the redemption expire after a certain time period.
+	 * The duration of the redemption is not set by Fluid.
+	 * @defaultValue false


@defaultValue is intended to describe the behavior that results from not specifying a value (or setting it to undefined). So here it should describe the default boolean value that will be used when this is undefined.

jatgarg · 2025-06-17T21:42:31Z

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

@@ -724,11 +727,16 @@ export const downloadSnapshot = mockify(
 		const queryString = getQueryString(queryParams);
 		const url = `${snapshotUrl}/trees/latest${queryString}`;
 		const method = "POST";
+		const isRedemptionNonDurable: boolean =


You can also set this in the event.end event of the fetchsnapshot function just like you are doing when doing redeem inside the fallback.

Are you referring to the event.end in fetchLatestSnapshotCore?

I decided to set it inside downloadSnapshot since that is where the authHeader with the header.prefer options are being set.

that is fine. I am talkign about the telemetry event.

I added the telemetry parameter to fetchLatestSnapshotCore

…ent.end()

github-actions · 2025-06-18T21:47:01Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  225443 links
    1710 destination URLs
    1941 URLs ignored
       0 warnings
       0 errors

update the shareLink enum

11cb41f

github-actions bot added base: main PRs targeted against main branch area: driver Driver related issues area: odsp-driver labels Jun 10, 2025

MarioJGMsoft changed the title ~~update the shareLink enum~~ Update odsp driver for new header Jun 10, 2025

feat: added non-durable redeem.

d51a137

github-actions bot added the public api change Changes to a public API label Jun 11, 2025

MarioJGMsoft added 6 commits June 11, 2025 12:57

Merge branch 'main' into ODSPHeaderNonDurableRedeem

9a2e061

fix: added nondurable redeem to manual redirect

282b9b9

docs: changed variable name

91aa627

docs: updated variable name

667cb44

test: added tests and covered edge case

11db37b

feat: added all logic to a single if.

c4686cb

MarioJGMsoft marked this pull request as ready for review June 11, 2025 22:11

Copilot AI review requested due to automatic review settings June 11, 2025 22:11

MarioJGMsoft requested a review from a team as a code owner June 11, 2025 22:11

Copilot AI reviewed Jun 11, 2025

View reviewed changes

packages/drivers/odsp-driver/src/fetchSnapshot.ts Outdated Show resolved Hide resolved

MarioJGMsoft added 6 commits June 12, 2025 18:15

fix: updated name of header variable

1f0cb9c

fix: fixed test variables

5169eef

test: initial test to review headers

ad1e6a1

test-fix: Fixed.only of test

073fbf9

test: added full test

f73a3c9

test: added event prop

57d56d7

jatgarg reviewed Jun 13, 2025

View reviewed changes

fix: applied changes based on feedback

fff21d2

Merge branch 'main' into ODSPHeaderNonDurableRedeem

4185ecb

Josmithr reviewed Jun 13, 2025

View reviewed changes

packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.legacy.alpha.api.md Outdated Show resolved Hide resolved

Josmithr reviewed Jun 13, 2025

View reviewed changes

packages/drivers/odsp-driver-definitions/src/resolvedUrl.ts Outdated Show resolved Hide resolved

Josmithr reviewed Jun 13, 2025

View reviewed changes

packages/drivers/odsp-driver/src/contractsPublic.ts Outdated Show resolved Hide resolved

MarioJGMsoft added 2 commits June 17, 2025 17:49

comments: applied changes based on comments

cd6cbeb

Merge branch 'main' into ODSPHeaderNonDurableRedeem

5e427f2

github-actions bot added the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Jun 17, 2025

MarioJGMsoft added 2 commits June 17, 2025 18:04

docs: updated comment

edc05b2

revert: reverted unnecessary change

e4a414d

github-actions bot removed the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Jun 17, 2025

Josmithr reviewed Jun 17, 2025

View reviewed changes

packages/drivers/odsp-driver-definitions/src/resolvedUrl.ts Show resolved Hide resolved

Josmithr reviewed Jun 17, 2025

View reviewed changes

packages/drivers/odsp-driver/src/contractsPublic.ts Outdated Show resolved Hide resolved

MarioJGMsoft added 2 commits June 17, 2025 20:17

docs: applied changes based on comments

6067787

Merge branch 'main' into ODSPHeaderNonDurableRedeem

e4e01d3

Josmithr reviewed Jun 17, 2025

View reviewed changes

jatgarg reviewed Jun 17, 2025

View reviewed changes

MarioJGMsoft added 2 commits June 18, 2025 17:05

telemetry: added isRedemptionNonDurable in fetchLatestSnapshotCore ev…

68181da

…ent.end()

test: updated assert error message

2967ca7

Update odsp driver for new header #24819

Are you sure you want to change the base?

Update odsp driver for new header #24819

Conversation

MarioJGMsoft commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Reviewer Guidance

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 18, 2025

linkcheck output

Uh oh!

Uh oh!

MarioJGMsoft commented Jun 10, 2025 •

edited

Loading