util: Mark GracefulSwitchLB.switchTo() deprecated

grpc · Jul 23, 2024 · 85e0a01 · 85e0a01
1 parent 9269050
commit 85e0a01
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/util/src/main/java/io/grpc/util/GracefulSwitchLoadBalancer.java b/util/src/main/java/io/grpc/util/GracefulSwitchLoadBalancer.java
@@ -142,7 +142,11 @@ public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
   /**
    * Gracefully switch to a new policy defined by the given factory, if the given factory isn't
    * equal to the current one.
+   *
+   * @deprecated Use {@code parseLoadBalancingPolicyConfig()} and pass the configuration to
+   *     {@link io.grpc.LoadBalancer.ResolvedAddresses.Builder#setLoadBalancingPolicyConfig}
    */
+  @Deprecated
   public void switchTo(LoadBalancer.Factory newBalancerFactory) {
     switchToCalled = true;
     switchToInternal(newBalancerFactory);

diff --git a/util/src/test/java/io/grpc/util/GracefulSwitchLoadBalancerTest.java b/util/src/test/java/io/grpc/util/GracefulSwitchLoadBalancerTest.java
@@ -86,6 +86,7 @@ public class GracefulSwitchLoadBalancerTest {
   // OLD TESTS
 
   @Test
+  @Deprecated
   public void switchTo_canHandleEmptyAddressListFromNameResolutionForwardedToLatestPolicy() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -115,6 +116,7 @@ public void switchTo_canHandleEmptyAddressListFromNameResolutionForwardedToLates
   }
 
   @Test
+  @Deprecated
   public void switchTo_handleResolvedAddressesAndNameResolutionErrorForwardedToLatestPolicy() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -155,6 +157,7 @@ public void switchTo_handleResolvedAddressesAndNameResolutionErrorForwardedToLat
   }
 
   @Test
+  @Deprecated
   public void switchTo_acceptResolvedAddressesAndNameResolutionErrorForwardedToLatestPolicy() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -195,6 +198,7 @@ public void switchTo_acceptResolvedAddressesAndNameResolutionErrorForwardedToLat
   }
 
   @Test
+  @Deprecated
   public void switchTo_shutdownTriggeredWhenSwitchAndForwardedWhenSwitchLbShutdown() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -226,6 +230,7 @@ public void switchTo_shutdownTriggeredWhenSwitchAndForwardedWhenSwitchLbShutdown
   }
 
   @Test
+  @Deprecated
   public void switchTo_requestConnectionForwardedToLatestPolicies() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -263,6 +268,7 @@ public void switchTo_requestConnectionForwardedToLatestPolicies() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_createSubchannelForwarded() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -289,6 +295,7 @@ public void switchTo_createSubchannelForwarded() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_updateBalancingStateIsGraceful() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -340,6 +347,7 @@ public void switchTo_updateBalancingStateIsGraceful() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_switchWhileOldPolicyIsNotReady() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -368,6 +376,7 @@ public void switchTo_switchWhileOldPolicyIsNotReady() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_switchWhileOldPolicyGoesFromReadyToNotReady() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -398,6 +407,7 @@ public void switchTo_switchWhileOldPolicyGoesFromReadyToNotReady() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_switchWhileOldPolicyGoesFromReadyToNotReadyWhileNewPolicyStillIdle() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -428,6 +438,7 @@ public void switchTo_switchWhileOldPolicyGoesFromReadyToNotReadyWhileNewPolicySt
   }
 
   @Test
+  @Deprecated
   public void switchTo_newPolicyNameTheSameAsPendingPolicy_shouldHaveNoEffect() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -445,6 +456,7 @@ public void switchTo_newPolicyNameTheSameAsPendingPolicy_shouldHaveNoEffect() {
   }
 
   @Test
+  @Deprecated
   public void switchTo_newPolicyNameTheSameAsCurrentPolicy_shouldShutdownPendingLb() {
     gracefulSwitchLb.switchTo(lbPolicies[0]);
     LoadBalancer lb0 = balancers.get(lbPolicies[0]);
@@ -468,6 +480,7 @@ public void switchTo_newPolicyNameTheSameAsCurrentPolicy_shouldShutdownPendingLb
 
 
   @Test
+  @Deprecated
   public void switchTo_newLbFactoryEqualToOldOneShouldHaveNoEffect() {
     final List<LoadBalancer> balancers = new ArrayList<>();