Skip to content

Remove parameter in createOdspCreateContainerRequest() in v2.40 #23882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MarioJGMsoft opened this issue Feb 19, 2025 · 1 comment · Fixed by #23919 · May be fixed by #24456
Open

Remove parameter in createOdspCreateContainerRequest() in v2.40 #23882

MarioJGMsoft opened this issue Feb 19, 2025 · 1 comment · Fixed by #23919 · May be fixed by #24456
Assignees
Labels
breaking change This PR or issue would introduce a breaking change

Comments

@MarioJGMsoft
Copy link
Contributor

MarioJGMsoft commented Feb 19, 2025

The containerPackageInfo parameter of the createOdspCreateContainerRequest() function will be deprecated and removed in 2.40. Please update your code accordingly to avoid any disruptions.

Context
The parameter containerPackageInfo in createOdspCreateContainerRequest() makes it so that when a request is resolved, the appropriate information can be extracted from the request and stored. In version 2.23, OdspDriverUrlResolverForShareLink constructor takes optional IContainerPackageInfo that will provide functionality more efficiently.

Approach
This will mean that the name of the containerPackage can no longer be sent through the request. Instead, it can be added in the constructor of OdspDriverUrlResolverForShareLink. Then it will be processed and added to the SharingLink when said resolver resolves a request.

If using a custom resolver, update it to provide this capability similar to #23878.

Expected Timeline

To be removed in version 2.40.

@MarioJGMsoft MarioJGMsoft added the breaking change This PR or issue would introduce a breaking change label Feb 19, 2025
@MarioJGMsoft MarioJGMsoft changed the title Removal of createOdspCreateContainerRequest().containerPackageInfo in v2.40 Removal of createOdspCreateContainerRequest().containerPackageInfo in v2.40 Feb 19, 2025
@MarioJGMsoft MarioJGMsoft changed the title Removal of createOdspCreateContainerRequest().containerPackageInfo in v2.40 Removal of deprecated parameter in createOdspCreateContainerRequest() in v2.40 Feb 19, 2025
@MarioJGMsoft MarioJGMsoft self-assigned this Feb 19, 2025
@MarioJGMsoft MarioJGMsoft changed the title Removal of deprecated parameter in createOdspCreateContainerRequest() in v2.40 Remove deprecated parameter in createOdspCreateContainerRequest() in v2.40 Feb 20, 2025
@MarioJGMsoft MarioJGMsoft changed the title Remove deprecated parameter in createOdspCreateContainerRequest() in v2.40 Remove parameter in createOdspCreateContainerRequest() in v2.40 Feb 24, 2025
jatgarg added a commit that referenced this issue Apr 14, 2025
…nerRequest` (#23919)

## Description

As of PR #22849
(released in 2.23), preferred pattern to add "containerPackageName"
parameter to request is via URL resolver instead of
`createOdspCreateContainerRequest`'s last parameter.
Tag calling `createOdspCreateContainerRequest` with that parameter as
deprecated now, and then in the 2.40 release remove that form
altogether.

## Future Breaking Changes

See [issue
23882](#23882) for
more details.

## Reviewer Guidance

Please let me know if there's anything else I should be aware of or can
do better, thanks!

Fixes:
[AB#31450](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/31450)

---------

Co-authored-by: Jatin Garg <48029724+jatgarg@users.noreply.github.com>
@jason-ha
Copy link
Contributor

@jatgarg, that PR did not have the removal - re-opening

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This PR or issue would introduce a breaking change
Projects
None yet
2 participants