Skip to content

api: Deprecate LoadBalancer.handleResolvedAddresses()#11623

Open
SreeramdasLavanya wants to merge 87 commits intogrpc:masterfrom
SreeramdasLavanya:FixIssue-11194
Open

api: Deprecate LoadBalancer.handleResolvedAddresses()#11623
SreeramdasLavanya wants to merge 87 commits intogrpc:masterfrom
SreeramdasLavanya:FixIssue-11194

Conversation

@SreeramdasLavanya
Copy link
Contributor

@SreeramdasLavanya SreeramdasLavanya commented Oct 17, 2024 •
edited by ejona86
Loading

Also deprecate its companion canHandleEmptyAddressListFromNameResolution().
Also fixup the Javadoc to align with the arguments/return values, so that people
would have a better idea of how to use it.

Fixes #11194

@SreeramdasLavanya
Copy link
Contributor Author

SreeramdasLavanya commented Oct 18, 2024

Below points have been addressed:

javadoc for public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses)

  • refers to non-existent argument servers

javadoc for public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses)

  • refers to an argument named addresses
  • refers to returning values not of the actual return type

@SreeramdasLavanya SreeramdasLavanya marked this pull request as ready for review October 18, 2024 12:40
kannanjgithub
kannanjgithub reviewed Oct 21, 2024
View reviewed changes
api/src/main/java/io/grpc/LoadBalancer.java Outdated
* single list if needed.
*
* <p>Implementations can choose to reject the given addresses by returning {@code false}.
* <p>Implementations can choose to reject the given addresses by returning {@code UNAVAILABLE}.
Copy link
Contributor

@kannanjgithub kannanjgithub Oct 21, 2024

Choose a reason for hiding this comment

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

Replace with {@code Status.UNAVAILABLE} . Also below.

@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Oct 22, 2024
@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Oct 22, 2024
ejona86
ejona86 reviewed May 7, 2025
View reviewed changes
@shivaspeaks shivaspeaks requested a review from ejona86 March 16, 2026 06:57
@shivaspeaks
Copy link
Member

shivaspeaks commented Mar 16, 2026

I worked on all the open comments and added the commit address comments.

use acceptResolvedAddresses inn ClusterImplLoadBalancer commit was to solve deprecate warning. The other work around was to use suppress warning. Should we suppress it in this PR to only have desired changes? I believe there could be more usages and we can move to acceptResolvedAddresses when cleaning up.

@shivaspeaks shivaspeaks added the kokoro:force-run Add this label to a PR to tell Kokoro to re-run all tests. Not generally necessary label Mar 16, 2026
@grpc-kokoro grpc-kokoro removed the kokoro:force-run Add this label to a PR to tell Kokoro to re-run all tests. Not generally necessary label Mar 16, 2026
ejona86 added 9 commits March 23, 2026 15:47
@ejona86
Remove useless docs added to GracefluwSwitchLb
1b87c80
@ejona86
Mark forwarding implementation deprecated instead of deleting
6ed0674 
We want to keep the old behavior until the old usages are removed.
@ejona86
Delete random formatting change to file
e44ca7d
@ejona86
Tweak doc tweaks
66e17cf
@ejona86
Don't implement ForwardingLb.acceptResolvedAddresses()
361c4b8 
Any old implementations that still implement handleResolvedAddresses()
will have their implementationed "skipped" by new callers of
acceptResolvedAddresses(). We've been having such forwarders implement
both methods instead. Since there's very few usages of
handleResolvedAddresses() left, out-of-tree implementations should
generally be fine just swapping to acceptResolvedAddresses.
@ejona86
Fix missed doc mentioning UNAVAILABLE
6edec88
@ejona86
Restore removed Override annotation
97cecbf
@ejona86
Remove useless doc
9e52edb
@ejona86
The test was for the old implementation
059f1cd 
It should have been completely deleted if the method was being deleted.
In this case, since I've restored the method we just need Deprecated on
the test.
@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 23, 2026
@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 23, 2026
ejona86
ejona86 approved these changes Mar 23, 2026
View reviewed changes
Copy link
Member

@ejona86 ejona86 left a comment

Choose a reason for hiding this comment

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

@shivaspeaks, you can see now how the change is basically just the deprecation annotation and the one ClusterImplLoadBalancer fix. My best guess for why ClusterImplLoadBalancer wasn't already migrated is because we might have been in the middle of L74 and didn't want to do any unnecessary changes that would conflict.

@shivaspeaks shivaspeaks mentioned this pull request Mar 24, 2026
Closed
@ejona86 ejona86 changed the title api: Javadoc changes for io.grpc.LoadBalancer method signatures api: Deprecate LoadBalancer.handleResolvedAddresses() Mar 24, 2026
@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 24, 2026
@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 24, 2026
@ejona86
Copy link
Member

ejona86 commented Mar 24, 2026

Looks like the version of checkstyle we use on Java 11+ fails to detect Javadoc <p> violations, whereas the one we use with Java 8 still does catch it. I wonder if the Java 17+ one would have caught the violation. (We use Java 8 in a github action, and macos)

@ejona86 ejona86 added the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 24, 2026
@grpc-kokoro grpc-kokoro removed the kokoro:run Add this label to a PR to tell Kokoro the code is safe and tests can be run label Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shivaspeaks shivaspeaks shivaspeaks approved these changes

@ejona86 ejona86 ejona86 approved these changes

@kannanjgithub kannanjgithub kannanjgithub approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

io.grpc.LoadBalancer method signatures don't match javadoc

5 participants

@SreeramdasLavanya @shivaspeaks @ejona86 @kannanjgithub @grpc-kokoro