feat!: deprecate RetrySettings.isJittered [gax-java] (#1308)

* feat!: deprecate RetrySettings.isJittered * fix: Address comments
googleapis · Feb 19, 2021 · 68644a4 · 68644a4
1 parent ee370f6
commit 68644a4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/gax/src/main/java/com/google/api/gax/retrying/ExponentialRetryAlgorithm.java b/gax/src/main/java/com/google/api/gax/retrying/ExponentialRetryAlgorithm.java
@@ -187,7 +187,7 @@ public boolean shouldRetry(TimedAttemptSettings nextAttemptSettings) {
 
   // Injecting Random is not possible here, as Random does not provide nextLong(long bound) method
   protected long nextRandomLong(long bound) {
-    return bound > 0 && globalSettings.isJittered()
+    return bound > 0 && globalSettings.isJittered() // Jitter check needed for testing purposes.
         ? ThreadLocalRandom.current().nextLong(bound)
         : bound;
   }

diff --git a/gax/src/main/java/com/google/api/gax/retrying/RetrySettings.java b/gax/src/main/java/com/google/api/gax/retrying/RetrySettings.java
@@ -30,6 +30,7 @@
 package com.google.api.gax.retrying;
 
 import com.google.auto.value.AutoValue;
+import com.google.common.annotations.VisibleForTesting;
 import java.io.Serializable;
 import org.threeten.bp.Duration;
 
@@ -112,7 +113,11 @@ public abstract class RetrySettings implements Serializable {
    * <pre>{@code actualDelay = rand_between(0, min(maxRetryDelay, delay))}</pre>
    *
    * The default value is {@code true}.
+   *
+   * @deprecated Retries always jitter.
    */
+  @Deprecated
+  @VisibleForTesting
   public abstract boolean isJittered();
 
   /**
@@ -194,13 +199,17 @@ public abstract static class Builder {
     public abstract Builder setMaxAttempts(int maxAttempts);
 
     /**
-     * Jitter determines if the delay time should be randomized. In most cases, if jitter is set to
-     * {@code true} the actual delay time is calculated in the following way:
+     * Jitter determines if the delay time should be randomized. If jitter is set to {@code true}
+     * the actual delay time is calculated in the following way:
      *
      * <pre>{@code actualDelay = rand_between(0, min(maxRetryDelay, exponentialDelay))}</pre>
      *
-     * The default value is {@code true}.
+     * The default value is {@code true}, and this method will be a no-op soon.
+     *
+     * @deprecated Retries always jitter.
      */
+    @Deprecated
+    @VisibleForTesting
     public abstract Builder setJittered(boolean jittered);
 
     /**