Skip to content

Remove containerPackageInfo parameter in createOdspCreateContainerRequest #23872

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

Closed

Conversation

MarioJGMsoft
Copy link
Contributor

@MarioJGMsoft MarioJGMsoft commented Feb 18, 2025

Description

With PR: #22849 we introduced a parameter for ODSP that will not be used.
Since it is public, we will first mark it as deprecated, and then in the next release remove it. Make sure we inform Loop to not take dependency on it.

This is the follow up task to ensure that the parameter is deleted.

Reviewer Guidance

Please let me know if there's anything that I should change or be aware of. Thanks!

Fixes: AB#31049

@github-actions github-actions bot added area: driver Driver related issues area: odsp-driver base: main PRs targeted against main branch labels Feb 18, 2025
@MarioJGMsoft MarioJGMsoft changed the title Deprecate containerPackageInfo parameter in createOdspCreateContainerRequest Remove containerPackageInfo parameter in createOdspCreateContainerRequest Feb 19, 2025
@MarioJGMsoft MarioJGMsoft marked this pull request as ready for review February 20, 2025 00:02
@Copilot Copilot AI review requested due to automatic review settings February 20, 2025 00:02
@MarioJGMsoft MarioJGMsoft requested review from a team as code owners February 20, 2025 00:02
@MarioJGMsoft MarioJGMsoft requested review from a team, pragya91, markfields, jason-ha, jatgarg, kian-thompson, WillieHabi and rajatch5 and removed request for a team February 20, 2025 00:02
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts:35

  • With the removal of the containerPackageInfo parameter and its associated URL fragment, please ensure that any parts of the system relying on containerPackageName being sent through createOdspCreateContainerRequest are updated (for example, by using OdspDriverUrlResolverForShareLink as described).
)}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`,

packages/drivers/odsp-driver/src/test/odspDriverResolverTest.spec.ts:457

  • The removal of the containerPackageInfo parameter led to the deletion of this test case. Please confirm that the new behavior (i.e. setting the container package name via OdspDriverUrlResolverForShareLink) is covered elsewhere in the tests.
it("Should create request with containerPackageName and resolve it", async () => {

Copy link
Member

@tylerbutler tylerbutler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocking merge only to help with release race-conditions. I'll remove this block once release branch is created.

@tylerbutler tylerbutler dismissed their stale review February 20, 2025 05:48

Release is unblocked.

Comment on lines -40 to +35
)}${containerPackageInfo ? `&containerPackageName=${getContainerPackageName(containerPackageInfo)}` : ""}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`,
)}${shareLinkRequestParams ? `&${shareLinkRequestParams}` : ""}`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking behavioral change. Is there a deprecation PR planned before this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes there is, I'm working on one but I'm having trouble making the deprecation. I'm not sure how to deprecate the parameter within the function.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can't deprecate the parameter, but you can deprecate calling the function with that form. Example:

interface Test {
  /** @deprecated */
  fn(a: string, b: boolean): void;
  fn(a: string): void;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created deprecation PR: #23919

Copy link
Contributor

github-actions bot commented Mar 5, 2025

🔗 Found some broken links! 💔

Run a link check locally to find them. See
https://github.com/microsoft/FluidFramework/wiki/Checking-for-broken-links-in-the-documentation for more information.

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...

http://localhost:3000/docs/data-structures/tree
- (36:97) 'the Shar..' => http://localhost:3000/docs/api/tree (HTTP 404)

http://localhost:3000/docs/data-structures/tree/
- (36:97) 'the Shar..' => http://localhost:3000/docs/api/tree (HTTP 404)

http://localhost:3000/docs/data-structures/tree/schema-definition
- (30:128) 'SharedTr..' => http://localhost:3000/docs/api/tree (HTTP 404)

http://localhost:3000/docs/start/tree-start
- (44:4) 'the API ..' => http://localhost:3000/docs/api/tree/schemafactory-class (HTTP 404)
- (61:7) 'the API' => http://localhost:3000/docs/api/tree/treechangeevents-interface (HTTP 404)


Stats:
  162477 links
    1326 destination URLs
    1558 URLs ignored
       0 warnings
       3 errors

 ELIFECYCLE  Command failed with exit code 1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: driver Driver related issues area: odsp-driver base: main PRs targeted against main branch public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants