Skip to content

grpc: delete deprecated API WithBalancerName()#5232

Merged
easwars merged 1 commit intogrpc:masterfrom
easwars:delete_WithBalancerName
Mar 10, 2022
Merged

grpc: delete deprecated API WithBalancerName()#5232
easwars merged 1 commit intogrpc:masterfrom
easwars:delete_WithBalancerName

Conversation

@easwars
Copy link
Copy Markdown
Contributor

@easwars easwars commented Mar 9, 2022 •
edited
Loading

Summary of changes:

  • Deleted the WithBalancerName() API which has been deprecated for ages now.
    • This simplifies code in the ClientConn since we no longer need to handle special cases around balancer name being specified through a dial option
  • Test cleanups
    • Use WithDefaultServiceConfig instead of WithBalancerName wherever applicable
    • Use WithTransportCredentials(insecure.NewCredentials()) instead of WithInsecure() in tests already touched by the above change
    • Use defaultTestTimeout wherever applicable
    • Turn setupClient and setupServer functions into test helpers and significantly reduce boiler plate in individual tests in healthcheck_test.go

Fixes #5229

RELEASE NOTES:

@easwars easwars requested a review from dfawley March 9, 2022 17:38
@easwars easwars added the Type: API Change Breaking API changes (experimental APIs only!) label Mar 9, 2022
@easwars easwars added this to the 1.46 Release milestone Mar 9, 2022
@dfawley dfawley assigned easwars and unassigned dfawley Mar 10, 2022
@easwars easwars merged commit eead9a8 into grpc:master Mar 10, 2022
@easwars easwars mentioned this pull request Mar 16, 2022
Closed
@easwars easwars mentioned this pull request Mar 23, 2022
Closed
@easwars easwars deleted the delete_WithBalancerName branch March 30, 2022 14:47
@johanbrandhorst
Copy link
Copy Markdown
Contributor

johanbrandhorst commented Apr 22, 2022

Hi! I'm here from the new release notes. I think there is some confusion going on, because the release notes (and this PR) claims that WithBalancerName was deprecated 4 years ago, in #1697. However, it appears it was introduced 4 years ago. It appears to have been deprecated in #2900, which was 3 years ago. Could you perhaps provide a migration guide for users of this API to the release notes?

@menghanl
Copy link
Copy Markdown
Contributor

menghanl commented Apr 22, 2022 •
edited
Loading

For use cases that set the balancer for the client, grpc.WithDefaultServiceConfig should work.

- grpc.WithBalancerName(balancerName)
+ grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"loadBalancingConfig": [{"%s":{}}]}`, balancerName))

Note that there can be problems if the client receives service configs later with different load balancing policy (or without load balancing policy). The newer service config will override the default service config.
This behavior is different from grpc.WithBalancerName, where the load balancing policy in service config will be ignored.
There's also grpc.WithDisableServiceConfig, if you don't want service config at all.

@metalmatze metalmatze mentioned this pull request May 3, 2022
Closed
apesternikov added a commit to apesternikov/core that referenced this pull request Jun 9, 2022
@apesternikov
upgrade grpc to v1.47.0 & address deleted WithBalancerName that was d…
0d05163 
…eprecated for 2 years grpc/grpc-go#5232
@apesternikov apesternikov mentioned this pull request Jun 9, 2022
Merged
psFried pushed a commit to gazette/core that referenced this pull request Jun 15, 2022
@apesternikov
address WithBalancerName deleted in grpc v1.46.0 (#324)
0213e03 
* upgrade grpc to v1.47.0 & address deleted WithBalancerName that was deprecated for 2 years grpc/grpc-go#5232

* restore go.mod and go.sum
michaelschiff pushed a commit to michaelschiff/core that referenced this pull request Jun 16, 2022
@apesternikov @michaelschiff
address WithBalancerName deleted in grpc v1.46.0 (gazette#324)
bef939c 
* upgrade grpc to v1.47.0 & address deleted WithBalancerName that was deprecated for 2 years grpc/grpc-go#5232

* restore go.mod and go.sum
michaelschiff pushed a commit to michaelschiff/core that referenced this pull request Jun 16, 2022
@apesternikov @michaelschiff
address WithBalancerName deleted in grpc v1.46.0 (gazette#324)
1ac4103 
* upgrade grpc to v1.47.0 & address deleted WithBalancerName that was deprecated for 2 years grpc/grpc-go#5232

* restore go.mod and go.sum
@aarongable aarongable mentioned this pull request Aug 31, 2022
Merged
aarongable added a commit to letsencrypt/boulder that referenced this pull request Sep 1, 2022
@aarongable
Update grpc from v1.36.1 to v1.49.0 (#6336)
c706609 
Changelog: grpc/grpc-go@v1.36.1...v1.49.0

The biggest change for us is that grpc.WithBalancerName has
transitioned from deprecated to fully removed. The fix is to replace
it with a JSON-formatted "default config" object, as demonstrated in
grpc/grpc-go#5232 (comment).

This should unblock updating other dependencies which want to
transitively update gRPC as well.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@dfawley dfawley dfawley approved these changes

Assignees

@easwars easwars

Labels

Type: API Change Breaking API changes (experimental APIs only!)

Projects

None yet

Milestone

1.46 Release

Development

Successfully merging this pull request may close these issues.

grpc: delete deprecated dial option WithBalancerName

4 participants

@easwars @johanbrandhorst @menghanl @dfawley