api: Javadoc changes for io.grpc.LoadBalancer method signatures #11623

SreeramdasLavanya · 2024-10-17T15:56:10Z

Javadoc changes for io.grpc.LoadBalancer

Fixes #11194

…h Duration" This reverts commit ab97045.

SreeramdasLavanya · 2024-10-18T12:40:15Z

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

kannanjgithub · 2024-10-21T07:50:56Z

api/src/main/java/io/grpc/LoadBalancer.java

@@ -179,12 +179,12 @@ public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) {
   * EquivalentAddressGroup} addresses should be considered equivalent but may be flattened into a
   * 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}.


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

…ed changes

…d and related changes

…d changes

shivaspeaks · 2024-11-21T11:47:36Z

api/src/main/java/io/grpc/LoadBalancer.java

   *
   * @param resolvedAddresses the resolved server addresses, attributes, and config.
   * @since 1.21.0
   */
+  @Deprecated


Add a javadoc on Deprecated and what to use instead.

Included in Javadoc

util/src/main/java/io/grpc/util/GracefulSwitchLoadBalancer.java

ejona86 · 2024-11-21T18:05:04Z

util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

@@ -193,7 +193,7 @@ private List<ChildLbState> updateChildrenWithResolvedAddresses(
      newChildLbStates.add(childLbState);
      if (entry.getValue() != null) {
        childLbState.setResolvedAddresses(entry.getValue()); // update child
-        childLbState.lb.handleResolvedAddresses(entry.getValue()); // update child LB
+        childLbState.lb.acceptResolvedAddresses(entry.getValue()); // update child LB


This class needs to fix its handling of the Status. I think we should leave it as-is and create a tracking bug for it.

Leaving it as-is(handleResolvedAddresses) is resulting in build failure because of the deprecated warning, so i'm retaining this acceptResolvedAddresses for now to proceed further. Please confirm if this is ok and handling the Status can be done as part of a new defect.

Hmmm, we can definitely suppress warning here and create a tracking bug. Add a comment with TODO mentioning the tracking bug.

The tracking bug added was the already-existing bug this PR was fixing, which means it was going to be closed when this PR went in thus not be a tracking bug for the problem. But #11894 is now in, so this doesn't matter any more.

Merged with master branch latest changes

util/src/main/java/io/grpc/util/OutlierDetectionLoadBalancer.java

ejona86 · 2024-11-21T18:06:58Z

util/src/test/java/io/grpc/util/GracefulSwitchLoadBalancerTest.java

@@ -125,17 +125,17 @@ public void switchTo_handleResolvedAddressesAndNameResolutionErrorForwardedToLat
    helper0.updateBalancingState(READY, picker);

    ResolvedAddresses addresses = newFakeAddresses();
-    gracefulSwitchLb.handleResolvedAddresses(addresses);
-    verify(lb0).handleResolvedAddresses(addresses);
+    gracefulSwitchLb.acceptResolvedAddresses(addresses);


Don't change any of these. These shouldn't have caused warnings because they were already marked @Deprecated. They are testing the old code flow and need to remain until it is deleted. When the old flow is deleted, the entire set of "// OLD TESTS" will be outright deleted, as we already have tests below that test acceptResolvedAddresses (and test it more fully, as it checks the return value).

Handled as mentioned

ejona86 · 2024-11-21T18:14:15Z

util/src/main/java/io/grpc/util/ForwardingLoadBalancer.java

@@ -30,8 +30,8 @@ public abstract class ForwardingLoadBalancer extends LoadBalancer {
  protected abstract LoadBalancer delegate();

  @Override
-  public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) {


This will need some more thought. This change would prevent extending classes from seeing the addresses, if they are only overriding handleResolvedAddresses().

Can we mark this existing method as deprecated and introduce an override for acceptResolvedAddresses, please confirm

That would still break an implementation only implementing handleResolvedAddresses()

Marking handleResolveAddresses() deprecated and also calling newly introduced acceptResolvedAddresses() within it should we the way to go forward. Because acceptResolvedAddresses will delegate it to LoadBalancer and there we are using recursionCount to deal with things. So it works as far as I can think.

Something like,

@Deprecated @Override public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) { acceptResolvedAddresses(resolvedAddresses); } @Override public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) { return delegate().acceptResolvedAddresses(resolvedAddresses); }

@shivaspeaks After removing delegate().acceptResolvedAddresses() from deprecated handleResolvedAddresses() method we are getting the PR checked failure with below compilation error

warning: [InlineMeSuggester] This deprecated API looks inlineable. If you'd like the body of the API to be automatically inlined to its callers, please annotate it with @InlineMe. NOTE: the suggested fix makes the method final if it was not already.

For more details please refer to the PR logs: https://github.com/grpc/grpc-java/actions/runs/13436677696/job/37540488347?pr=11623

Looking into this issue.

api/src/main/java/io/grpc/LoadBalancer.java

# Conflicts: # util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

…ses method

ejona86 · 2025-02-20T00:20:52Z

util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

@@ -191,6 +192,7 @@ private List<ChildLbState> updateChildrenWithResolvedAddresses(
      }
      newChildLbStates.add(childLbState);
      if (entry.getValue() != null) {
+        //TODO - https://github.com/grpc/grpc-java/issues/11194
        childLbState.lb.handleResolvedAddresses(entry.getValue()); // update child LB


#11894 swapped this to acceptResolvedAddresses()

Merged with master branch latest changes

# Conflicts: # util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

SreeramdasLavanya and others added 12 commits September 20, 2024 14:25

SynchronizationContextTest changes for scheduleFixedDelay with Duration

ab97045

Revert "SynchronizationContextTest changes for scheduleFixedDelay wit…

fef4c92

…h Duration" This reverts commit ab97045.

Merge branch 'grpc:master' into master

778cfb4

Merge branch 'grpc:master' into master

328bcbf

Merge branch 'grpc:master' into master

6a66054

Merge branch 'grpc:master' into master

4113845

Merge branch 'grpc:master' into master

09c3509

Merge branch 'grpc:master' into master

62a88ec

Merge branch 'grpc:master' into master

f658685

Merge branch 'grpc:master' into master

c51a5e4

Merge branch 'grpc:master' into master

02e92c5

api: Javadoc changes for LoadBalancer method signatures

4c31880

SreeramdasLavanya marked this pull request as ready for review October 18, 2024 12:40

kannanjgithub reviewed Oct 21, 2024

View reviewed changes

SreeramdasLavanya added 5 commits October 21, 2024 09:40

api: Changes for UNAVAILABLE to Status.UNAVAILABLE and Status.OK

9ddcb09

api: Check style fix for UNAVAILABLE to Status.UNAVAILABLE and Status.OK

596d11d

api: Check style fix for Status.UNAVAILABLE and Status.OK

d9bf85e

api: Check style fix for Status.UNAVAILABLE

401a7d2

api: Check style fix for Status.UNAVAILABLE

f388ac2

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

SreeramdasLavanya and others added 8 commits October 25, 2024 08:02

Merge branch 'grpc:master' into master

6e4efc7

Merge branch 'grpc:master' into FixIssue-11194

cb315f0

Merge branch 'grpc:master' into master

18b74c0

Merge branch 'grpc:master' into FixIssue-11194

380345c

api/util/services: Deprected handleResolvedAddresses method and relat…

846eb00

…ed changes

interop-testing: Changes for deprecated handleResolvedAddresses metho…

ee36c4e

…d and related changes

xds: Changes for deprecated handleResolvedAddresses method and relate…

b1f857f

…d changes

Merge branch 'grpc:master' into master

d236b88

shivaspeaks approved these changes Nov 21, 2024

View reviewed changes

shivaspeaks reviewed Nov 21, 2024

View reviewed changes

ejona86 reviewed Nov 21, 2024

View reviewed changes

SreeramdasLavanya and others added 11 commits November 22, 2024 10:46

Merge branch 'grpc:master' into master

35f0769

Merge branch 'grpc:master' into master

bddc31c

Merge branch 'master' into FixIssue-11194

b9a49a0

# Conflicts: # util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

api/util: Addressed the re-review points

1e6fef9

api/util: Resolved Deprecation warnings

1674b6d

api/util: Resolved checkstyle issues

60b4a39

api/util: Resolved deprecation warnings

8b02cd4

Merge branch 'grpc:master' into master

5ece923

Merge branch 'grpc:master' into FixIssue-11194

d746ef8

util/xds: Resolved deprecation warnings

516e75b

util: Resolved deprecation warnings

36ecadb

shivaspeaks requested a review from ejona86 November 27, 2024 09:11

SreeramdasLavanya and others added 9 commits December 3, 2024 17:04

Merge branch 'grpc:master' into master

aa43806

Merge branch 'grpc:master' into FixIssue-11194

d756690

util: Included suppress warnings for updateChildrenWithResolvedAddres…

d2e6f04

…ses method

Merge branch 'grpc:master' into master

2ab1ae2

Merge branch 'grpc:master' into FixIssue-11194

4a690a2

Merge branch 'grpc:master' into master

f66c084

Merge branch 'grpc:master' into FixIssue-11194

8c75ed0

Merge branch 'grpc:master' into master

60932d8

Merge branch 'grpc:master' into FixIssue-11194

4b542f7

ejona86 reviewed Feb 20, 2025

View reviewed changes

SreeramdasLavanya and others added 5 commits February 20, 2025 10:55

Merge branch 'grpc:master' into master

9fc5391

Merge branch 'master' into FixIssue-11194

af00e50

# Conflicts: # util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

util: Changed deprecated method to newly added method

ea42960

util: Removed delegate for acceptResolved method

226301c

util: Removed override annotation

e6bea7f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: Javadoc changes for io.grpc.LoadBalancer method signatures #11623

api: Javadoc changes for io.grpc.LoadBalancer method signatures #11623

SreeramdasLavanya commented Oct 17, 2024 •

edited

Loading

SreeramdasLavanya commented Oct 18, 2024

kannanjgithub Oct 21, 2024

shivaspeaks Nov 21, 2024

SreeramdasLavanya Nov 25, 2024

ejona86 Nov 21, 2024

SreeramdasLavanya Nov 25, 2024

shivaspeaks Nov 27, 2024

SreeramdasLavanya Dec 4, 2024

ejona86 Feb 20, 2025

SreeramdasLavanya Feb 20, 2025

ejona86 Nov 21, 2024

SreeramdasLavanya Feb 20, 2025

ejona86 Nov 21, 2024

SreeramdasLavanya Nov 22, 2024

ejona86 Dec 2, 2024

shivaspeaks Feb 5, 2025

SreeramdasLavanya Feb 20, 2025 •

edited

Loading

ejona86 Feb 20, 2025

SreeramdasLavanya Feb 20, 2025

api: Javadoc changes for io.grpc.LoadBalancer method signatures #11623

Are you sure you want to change the base?

api: Javadoc changes for io.grpc.LoadBalancer method signatures #11623

Conversation

SreeramdasLavanya commented Oct 17, 2024 • edited Loading

SreeramdasLavanya commented Oct 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SreeramdasLavanya Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SreeramdasLavanya commented Oct 17, 2024 •

edited

Loading

SreeramdasLavanya Feb 20, 2025 •

edited

Loading