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

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

Open
wants to merge 65 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
ab97045
SynchronizationContextTest changes for scheduleFixedDelay with Duration
SreeramdasLavanya Sep 20, 2024
fef4c92
Revert "SynchronizationContextTest changes for scheduleFixedDelay wit…
SreeramdasLavanya Sep 20, 2024
778cfb4
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 23, 2024
328bcbf
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 24, 2024
6a66054
Merge branch 'grpc:master' into master
SreeramdasLavanya Sep 26, 2024
4113845
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 1, 2024
09c3509
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 8, 2024
62a88ec
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 9, 2024
f658685
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 11, 2024
c51a5e4
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 15, 2024
02e92c5
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 17, 2024
4c31880
api: Javadoc changes for LoadBalancer method signatures
SreeramdasLavanya Oct 17, 2024
9ddcb09
api: Changes for UNAVAILABLE to Status.UNAVAILABLE and Status.OK
SreeramdasLavanya Oct 21, 2024
596d11d
api: Check style fix for UNAVAILABLE to Status.UNAVAILABLE and Status.OK
SreeramdasLavanya Oct 21, 2024
d9bf85e
api: Check style fix for Status.UNAVAILABLE and Status.OK
SreeramdasLavanya Oct 21, 2024
401a7d2
api: Check style fix for Status.UNAVAILABLE
SreeramdasLavanya Oct 21, 2024
f388ac2
api: Check style fix for Status.UNAVAILABLE
SreeramdasLavanya Oct 21, 2024
6e4efc7
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 25, 2024
cb315f0
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Oct 25, 2024
18b74c0
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 28, 2024
380345c
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Oct 28, 2024
846eb00
api/util/services: Deprected handleResolvedAddresses method and relat…
SreeramdasLavanya Oct 28, 2024
ee36c4e
interop-testing: Changes for deprecated handleResolvedAddresses metho…
SreeramdasLavanya Oct 29, 2024
b1f857f
xds: Changes for deprecated handleResolvedAddresses method and relate…
SreeramdasLavanya Oct 29, 2024
d236b88
Merge branch 'grpc:master' into master
SreeramdasLavanya Oct 30, 2024
891b547
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Oct 30, 2024
6d3abf0
api: Reverted changes for LoadBalancer and LoadBalancerTest
SreeramdasLavanya Nov 4, 2024
ca3e613
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Nov 4, 2024
f9ffbc6
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 4, 2024
47002fe
util: Replaced handleResolvedAddress to acceptResolvedAddresses.
SreeramdasLavanya Nov 4, 2024
cb85563
api: Reverted back to acceptResolvedAddress
SreeramdasLavanya Nov 5, 2024
b44e402
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 6, 2024
8bfedb0
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Nov 6, 2024
b9cced0
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 7, 2024
66a3495
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Nov 7, 2024
45d3c75
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 8, 2024
b67b7ab
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 12, 2024
1b0ddaa
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 14, 2024
cfaab92
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 18, 2024
a0e5bf2
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 19, 2024
35f0769
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 22, 2024
bddc31c
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 25, 2024
b9a49a0
Merge branch 'master' into FixIssue-11194
SreeramdasLavanya Nov 25, 2024
1e6fef9
api/util: Addressed the re-review points
SreeramdasLavanya Nov 25, 2024
1674b6d
api/util: Resolved Deprecation warnings
SreeramdasLavanya Nov 25, 2024
60b4a39
api/util: Resolved checkstyle issues
SreeramdasLavanya Nov 25, 2024
8b02cd4
api/util: Resolved deprecation warnings
SreeramdasLavanya Nov 26, 2024
5ece923
Merge branch 'grpc:master' into master
SreeramdasLavanya Nov 26, 2024
d746ef8
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Nov 26, 2024
516e75b
util/xds: Resolved deprecation warnings
SreeramdasLavanya Nov 26, 2024
36ecadb
util: Resolved deprecation warnings
SreeramdasLavanya Nov 26, 2024
aa43806
Merge branch 'grpc:master' into master
SreeramdasLavanya Dec 3, 2024
d756690
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Dec 3, 2024
d2e6f04
util: Included suppress warnings for updateChildrenWithResolvedAddres…
SreeramdasLavanya Dec 3, 2024
2ab1ae2
Merge branch 'grpc:master' into master
SreeramdasLavanya Dec 9, 2024
4a690a2
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Dec 9, 2024
f66c084
Merge branch 'grpc:master' into master
SreeramdasLavanya Dec 10, 2024
8c75ed0
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Dec 10, 2024
60932d8
Merge branch 'grpc:master' into master
SreeramdasLavanya Jan 20, 2025
4b542f7
Merge branch 'grpc:master' into FixIssue-11194
SreeramdasLavanya Jan 20, 2025
9fc5391
Merge branch 'grpc:master' into master
SreeramdasLavanya Feb 20, 2025
af00e50
Merge branch 'master' into FixIssue-11194
SreeramdasLavanya Feb 20, 2025
ea42960
util: Changed deprecated method to newly added method
SreeramdasLavanya Feb 20, 2025
226301c
util: Removed delegate for acceptResolved method
SreeramdasLavanya Feb 20, 2025
e6bea7f
util: Removed override annotation
SreeramdasLavanya Feb 20, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
util/xds: Resolved deprecation warnings
  • Loading branch information
SreeramdasLavanya committed Nov 26, 2024
commit 516e75bcb014f30ff7516205f42f360b62a168ed
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,6 @@ public void canHandleEmptyAddressListFromNameResolutionForwardedToLatestPolicy()
assertThat(gracefulSwitchLb.canHandleEmptyAddressListFromNameResolution()).isTrue();
}

@Deprecated
@Test
public void handleResolvedAddressesAndNameResolutionErrorForwardedToLatestPolicy() {
ResolvedAddresses addresses = newFakeAddresses();
Expand Down
11 changes: 9 additions & 2 deletions xds/src/test/java/io/grpc/xds/MetadataLoadBalancerProvider.java
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,19 @@ protected LoadBalancer delegate() {
return delegateLb;
}

/**
* Handles newly resolved addresses and metadata attributes from name resolution system.
*
* @deprecated As of release 1.69.0,
* use instead {@link #acceptResolvedAddresses(ResolvedAddresses)}
*/
@Deprecated
@Override
public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) {
MetadataLoadBalancerConfig config
= (MetadataLoadBalancerConfig) resolvedAddresses.getLoadBalancingPolicyConfig();
helper.setMetadata(config.metadataKey, config.metadataValue);
return delegateLb.acceptResolvedAddresses(resolvedAddresses);
delegateLb.handleResolvedAddresses(resolvedAddresses);
}
}

Expand Down
52 changes: 31 additions & 21 deletions xds/src/test/java/io/grpc/xds/PriorityLoadBalancerTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,9 @@ public void tearDown() {
assertThat(fakeClock.getPendingTasks()).isEmpty();
}

@Deprecated
@Test
public void acceptResolvedAddresses() {
public void handleResolvedAddresses() {
SocketAddress socketAddress = new InetSocketAddress(8080);
EquivalentAddressGroup eag = new EquivalentAddressGroup(socketAddress);
eag = AddressFilter.setPathFilter(eag, ImmutableList.of("p1"));
Expand All @@ -162,7 +163,7 @@ public void acceptResolvedAddresses() {
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1,
"p2", priorityChildConfig2),
ImmutableList.of("p0", "p1", "p2"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(addresses)
.setAttributes(attributes)
Expand All @@ -171,7 +172,7 @@ public void acceptResolvedAddresses() {
assertThat(fooBalancers).hasSize(1);
assertThat(barBalancers).isEmpty();
LoadBalancer fooBalancer0 = Iterables.getOnlyElement(fooBalancers);
verify(fooBalancer0).acceptResolvedAddresses(resolvedAddressesCaptor.capture());
verify(fooBalancer0).handleResolvedAddresses(resolvedAddressesCaptor.capture());
ResolvedAddresses addressesReceived = resolvedAddressesCaptor.getValue();
assertThat(addressesReceived.getAddresses()).isEmpty();
assertThat(addressesReceived.getAttributes()).isEqualTo(attributes);
Expand All @@ -182,7 +183,7 @@ public void acceptResolvedAddresses() {
assertThat(fooBalancers).hasSize(1);
assertThat(barBalancers).hasSize(1);
LoadBalancer barBalancer0 = Iterables.getOnlyElement(barBalancers);
verify(barBalancer0).acceptResolvedAddresses(resolvedAddressesCaptor.capture());
verify(barBalancer0).handleResolvedAddresses(resolvedAddressesCaptor.capture());
addressesReceived = resolvedAddressesCaptor.getValue();
assertThat(Iterables.getOnlyElement(addressesReceived.getAddresses()).getAddresses())
.containsExactly(socketAddress);
Expand All @@ -194,7 +195,7 @@ public void acceptResolvedAddresses() {
assertThat(fooBalancers).hasSize(2);
assertThat(barBalancers).hasSize(1);
LoadBalancer fooBalancer1 = Iterables.getLast(fooBalancers);
verify(fooBalancer1).acceptResolvedAddresses(resolvedAddressesCaptor.capture());
verify(fooBalancer1).handleResolvedAddresses(resolvedAddressesCaptor.capture());
addressesReceived = resolvedAddressesCaptor.getValue();
assertThat(addressesReceived.getAddresses()).isEmpty();
assertThat(addressesReceived.getAttributes()).isEqualTo(attributes);
Expand All @@ -211,14 +212,14 @@ public void acceptResolvedAddresses() {
ImmutableMap.of("p1",
new PriorityChildConfig(newChildConfig(barLbProvider, newBarConfig), true)),
ImmutableList.of("p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(newAddresses)
.setLoadBalancingPolicyConfig(newPriorityLbConfig)
.build());
assertThat(fooBalancers).hasSize(2);
assertThat(barBalancers).hasSize(1);
verify(barBalancer0, times(2)).acceptResolvedAddresses(resolvedAddressesCaptor.capture());
verify(barBalancer0, times(2)).handleResolvedAddresses(resolvedAddressesCaptor.capture());
addressesReceived = resolvedAddressesCaptor.getValue();
assertThat(Iterables.getOnlyElement(addressesReceived.getAddresses()).getAddresses())
.containsExactly(newSocketAddress);
Expand All @@ -232,6 +233,7 @@ public void acceptResolvedAddresses() {
verify(barBalancer0, never()).shutdown();
}

@Deprecated
@Test
public void handleNameResolutionError() {
Object fooConfig0 = new Object();
Expand All @@ -243,7 +245,7 @@ public void handleNameResolutionError() {

PriorityLbConfig priorityLbConfig =
new PriorityLbConfig(ImmutableMap.of("p0", priorityChildConfig0), ImmutableList.of("p0"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -255,7 +257,7 @@ public void handleNameResolutionError() {

priorityLbConfig =
new PriorityLbConfig(ImmutableMap.of("p1", priorityChildConfig1), ImmutableList.of("p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -271,6 +273,7 @@ public void handleNameResolutionError() {
verify(fooLb1).handleNameResolutionError(status);
}

@Deprecated
@Test
public void typicalPriorityFailOverFlow() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -286,7 +289,7 @@ public void typicalPriorityFailOverFlow() {
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1,
"p2", priorityChildConfig2, "p3", priorityChildConfig3),
ImmutableList.of("p0", "p1", "p2", "p3"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand Down Expand Up @@ -409,6 +412,7 @@ public PickResult pickSubchannel(PickSubchannelArgs args) {
verify(balancer3).shutdown();
}

@Deprecated
@Test
public void idleToConnectingDoesNotTriggerFailOver() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -419,7 +423,7 @@ public void idleToConnectingDoesNotTriggerFailOver() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -445,6 +449,7 @@ public void idleToConnectingDoesNotTriggerFailOver() {
assertThat(fooHelpers).hasSize(1);
}

@Deprecated
@Test
public void connectingResetFailOverIfSeenReadyOrIdleSinceTransientFailure() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -455,7 +460,7 @@ public void connectingResetFailOverIfSeenReadyOrIdleSinceTransientFailure() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand Down Expand Up @@ -487,6 +492,7 @@ public void connectingResetFailOverIfSeenReadyOrIdleSinceTransientFailure() {
assertThat(fooHelpers).hasSize(2);
}

@Deprecated
@Test
public void readyToConnectDoesNotFailOverButUpdatesPicker() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -497,7 +503,7 @@ public void readyToConnectDoesNotFailOverButUpdatesPicker() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand Down Expand Up @@ -530,7 +536,7 @@ public PickResult pickSubchannel(PickSubchannelArgs args) {

// resolution update without priority change does not trigger failover
Attributes.Key<String> fooKey = Attributes.Key.create("fooKey");
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -544,6 +550,7 @@ public PickResult pickSubchannel(PickSubchannelArgs args) {
assertThat(fooHelpers).hasSize(1);
}

@Deprecated
@Test
public void typicalPriorityFailOverFlowWithIdleUpdate() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -559,7 +566,7 @@ public void typicalPriorityFailOverFlowWithIdleUpdate() {
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1,
"p2", priorityChildConfig2, "p3", priorityChildConfig3),
ImmutableList.of("p0", "p1", "p2", "p3"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand Down Expand Up @@ -652,6 +659,7 @@ public void typicalPriorityFailOverFlowWithIdleUpdate() {
verify(balancer3).shutdown();
}

@Deprecated
@Test
public void bypassReresolutionRequestsIfConfiged() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -662,7 +670,7 @@ public void bypassReresolutionRequestsIfConfiged() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -680,6 +688,7 @@ public void bypassReresolutionRequestsIfConfiged() {
verify(helper).refreshNameResolution();
}

@Deprecated
@Test
public void raceBetweenShutdownAndChildLbBalancingStateUpdate() {
PriorityChildConfig priorityChildConfig0 =
Expand All @@ -690,7 +699,7 @@ public void raceBetweenShutdownAndChildLbBalancingStateUpdate() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -705,6 +714,7 @@ public void raceBetweenShutdownAndChildLbBalancingStateUpdate() {
verifyNoMoreInteractions(helper);
}

@Deprecated
@Test
public void noDuplicateOverallBalancingStateUpdate() {
FakeLoadBalancerProvider fakeLbProvider = new FakeLoadBalancerProvider();
Expand All @@ -717,7 +727,7 @@ public void noDuplicateOverallBalancingStateUpdate() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0),
ImmutableList.of("p0"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand All @@ -727,7 +737,7 @@ public void noDuplicateOverallBalancingStateUpdate() {
new PriorityLbConfig(
ImmutableMap.of("p0", priorityChildConfig0, "p1", priorityChildConfig1),
ImmutableList.of("p0", "p1"));
priorityLb.acceptResolvedAddresses(
priorityLb.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(ImmutableList.<EquivalentAddressGroup>of())
.setLoadBalancingPolicyConfig(priorityLbConfig)
Expand Down Expand Up @@ -800,11 +810,11 @@ static class FakeLoadBalancer extends LoadBalancer {
this.helper = helper;
}

@Deprecated
@Override
public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) {
helper.updateBalancingState(
TRANSIENT_FAILURE, new FixedResultPicker(PickResult.withError(Status.INTERNAL)));
return Status.OK;
}

@Override
Expand Down
Loading
Loading