Skip to content
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

Remove deprecated container connection APIs #10192

Merged
merged 23 commits into from
May 27, 2022

Conversation

scottn12
Copy link
Contributor

@scottn12 scottn12 commented May 6, 2022

This PR removes the APIs deprecated in 0.58 via #9439, which include Container.setAutoReconnect(), Container.resume(), IContainer.connected, and IFluidContainer.connected.
Additionally, this PR replaces any remaining usages/references of the above APIs with their respective replacements (see #9167).

Closes #9397

@scottn12 scottn12 requested review from markfields and vladsud May 6, 2022 19:44
@scottn12 scottn12 requested review from msfluid-bot and a team as code owners May 6, 2022 19:44
@github-actions github-actions bot added base: next PRs targeted against next branch area: definitions area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: tests Tests to add, test infrastructure improvements, etc breaking change This PR or issue would introduce a breaking change public api change Changes to a public API labels May 6, 2022
@scottn12 scottn12 marked this pull request as draft May 9, 2022 21:28
@scottn12
Copy link
Contributor Author

This PR is currently running into compat test issues due to the current LTS version:


@anthony-murphy, do you have any info/docs on how LTS versioning works? I'd love some more context to help determine what my next steps should be. cc @skylerjokiel

Copy link
Member

@markfields markfields left a comment

Choose a reason for hiding this comment

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

This will be great to get fully transitioned to the new APIs!

Couple things before signing off:

  1. I noticed none of these deprecated APIs have been cleaned up in the Loop codebase yet. Did we get an "upcoming" notification out in a previous release that communicated when they'd be removed? Do they have a task on their side tracking the migration work? If not we might want to wait and not remove these in 1.0. Or, if we are sufficiently motivated we could go make the changes in their code to ease the burden during FF bump (goal is to have the FF bump be a no-op by communicating enough for them to plan ahead)
  2. Take a look at my comment around duplicating waitContainerToCatchUp, I had another idea that might work without the duplicated code.

@scottn12
Copy link
Contributor Author

  1. I noticed none of these deprecated APIs have been cleaned up in the Loop codebase yet. Did we get an "upcoming" notification out in a previous release that communicated when they'd be removed? Do they have a task on their side tracking the migration work? If not we might want to wait and not remove these in 1.0. Or, if we are sufficiently motivated we could go make the changes in their code to ease the burden during FF bump (goal is to have the FF bump be a no-op by communicating enough for them to plan ahead)

@markfields, these changes were only communicated in BREAKING.md. I don't think it would be very difficult to make the changes, so I'm leaning towards doing it myself.

@@ -76,8 +76,10 @@
"ClassDeclaration_SharedDirectory": {"forwardCompat": false},
"ClassDeclaration_SharedString": {"forwardCompat": false},
"ClassDeclaration_FluidContainer": {"forwardCompat": false, "backCompat": false},
"InterfaceDeclaration_IFluidContainer": {"backCompat": false}
},
"disabled": true
Copy link
Member

Choose a reason for hiding this comment

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

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This also confused me 😅. I'm not sure exactly what happened, but when I merged the latest changes from the next branch, I noticed that there was a merge conflict here with "disabled": true. I checked both this branch and the next branch and it seemed to not exist on either. Either way I think we should be fine now

Copy link
Member

@markfields markfields left a comment

Choose a reason for hiding this comment

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

🎂 LGTM!

@scottn12 scottn12 changed the base branch from next to main May 27, 2022 18:45
@scottn12 scottn12 requested review from a team as code owners May 27, 2022 18:45
@scottn12 scottn12 changed the base branch from main to next May 27, 2022 18:46
@scottn12 scottn12 merged commit 3c923a5 into microsoft:next May 27, 2022
@scottn12 scottn12 deleted the replaceDepConnectAPIs branch May 27, 2022 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: definitions area: examples Changes that focus on our examples area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct area: loader Loader related issues area: tests Tests to add, test infrastructure improvements, etc base: next PRs targeted against next branch breaking change This PR or issue would introduce a breaking change public api change Changes to a public API
Projects
None yet
4 participants