fixup! ref(transport): Measure rate-limit backoff on a monotonic clock (JAVA-574)

Author: runningcode

CHANGELOG.md

@@ -17,7 +17,7 @@
 
 - Add an internal `MonotonicTicker` abstraction with `Deadline` and `Stopwatch` primitives ([#6028](https://github.com/getsentry/sentry-java/pull/6028))
 - Add internal `Timestamp`, `EpochClock` and `AnchoredClock`, so related instants project from one wall-clock reading instead of each reading the clock ([#6045](https://github.com/getsentry/sentry-java/pull/6045))
-- Deprecate `RateLimiter(ICurrentDateProvider, SentryOptions)` in favour of `RateLimiter(MonotonicClock, RateLimiterConfig)` ([#6030](https://github.com/getsentry/sentry-java/pull/6030))
+- Deprecate `RateLimiter(ICurrentDateProvider, SentryOptions)` in favour of `RateLimiter(MonotonicTicker, RateLimiterConfig)` ([#6030](https://github.com/getsentry/sentry-java/pull/6030))
 
 ## 8.55.0
 

sentry/api/sentry.api

@@ -7706,7 +7706,7 @@ public final class io/sentry/transport/NoOpTransportGate : io/sentry/transport/I
 
 public final class io/sentry/transport/RateLimiter : java/io/Closeable {
 	public fun <init> (Lio/sentry/SentryOptions;)V
-	public fun <init> (Lio/sentry/time/MonotonicClock;Lio/sentry/transport/RateLimiterConfig;)V
+	public fun <init> (Lio/sentry/time/MonotonicTicker;Lio/sentry/transport/RateLimiterConfig;)V
 	public fun <init> (Lio/sentry/transport/ICurrentDateProvider;Lio/sentry/SentryOptions;)V
 	public fun addRateLimitObserver (Lio/sentry/transport/RateLimiter$IRateLimitObserver;)V
 	public fun close ()V

sentry/src/main/java/io/sentry/transport/RateLimiter.java

@@ -15,7 +15,7 @@
 import io.sentry.hints.Retryable;
 import io.sentry.hints.SubmissionResult;
 import io.sentry.time.Deadline;
-import io.sentry.time.MonotonicClock;
+import io.sentry.time.MonotonicTicker;
 import io.sentry.util.AutoClosableReentrantLock;
 import io.sentry.util.HintUtils;
 import io.sentry.util.StringUtils;
@@ -40,7 +40,7 @@ public final class RateLimiter implements Closeable {
 
   private static final long HTTP_RETRY_AFTER_DEFAULT_DELAY_MILLIS = 60_000;
 
-  private final @NotNull MonotonicClock clock;
+  private final @NotNull MonotonicTicker ticker;
   private final @NotNull RateLimiterConfig config;
   private final @NotNull Map<DataCategory, @NotNull Deadline> sentryRetryAfterLimit =
       new ConcurrentHashMap<>();
@@ -49,17 +49,18 @@ public final class RateLimiter implements Closeable {
   private final @NotNull AutoClosableReentrantLock notifyFuturesLock =
       new AutoClosableReentrantLock();
 
-  public RateLimiter(final @NotNull MonotonicClock clock, final @NotNull RateLimiterConfig config) {
-    this.clock = clock;
+  public RateLimiter(
+      final @NotNull MonotonicTicker ticker, final @NotNull RateLimiterConfig config) {
+    this.ticker = ticker;
     this.config = config;
   }
 
   public RateLimiter(final @NotNull SentryOptions options) {
-    this(options.getMonotonicClock(), options);
+    this(options.getMonotonicTicker(), options);
   }
 
   /**
-   * @deprecated backoff is measured on {@link SentryOptions#getMonotonicClock()}; use {@link
+   * @deprecated backoff is measured on {@link SentryOptions#getMonotonicTicker()}; use {@link
    *     #RateLimiter(SentryOptions)}. An injected wall clock is adapted so that an existing custom
    *     transport keeps the behaviour it has today, but it is not monotonic and can step.
    */
@@ -70,7 +71,7 @@ public RateLimiter(
     // ICurrentDateProvider is itself a `long ()` interface, so an unadorned lambda matches this
     // constructor as readily as the intended one. The cast is what makes the call non-recursive.
     this(
-        (MonotonicClock)
+        (MonotonicTicker)
             () -> TimeUnit.MILLISECONDS.toNanos(currentDateProvider.getCurrentTimeMillis()),
         options);
   }
@@ -349,7 +350,7 @@ private void applyRetryAfterOnlyIfLonger(
         // let's use the default then
       }
     }
-    return Deadline.after(clock, retryAfterMillis, TimeUnit.MILLISECONDS);
+    return Deadline.after(ticker, retryAfterMillis, TimeUnit.MILLISECONDS);
   }
 
   private void notifyRateLimitObservers() {

sentry/src/test/java/io/sentry/transport/RateLimiterTest.kt

@@ -39,7 +39,7 @@ import io.sentry.protocol.SentryId
 import io.sentry.protocol.SentryTransaction
 import io.sentry.protocol.User
 import io.sentry.test.getProperty
-import io.sentry.time.TestMonotonicClock
+import io.sentry.time.TestMonotonicTicker
 import io.sentry.util.HintUtils
 import java.io.File
 import java.util.UUID
@@ -65,7 +65,7 @@ import org.mockito.kotlin.whenever
 
 class RateLimiterTest {
   private class Fixture {
-    val clock = TestMonotonicClock()
+    val ticker = TestMonotonicTicker()
     val clientReportRecorder = mock<IClientReportRecorder>()
     val serializer = mock<ISerializer>()
     var executorService: SentryExecutorService? = null
@@ -79,7 +79,7 @@ class RateLimiterTest {
 
       SentryOptionsManipulator.setClientReportRecorder(options, clientReportRecorder)
 
-      return RateLimiter(clock, options)
+      return RateLimiter(ticker, options)
     }
   }
 
@@ -104,7 +104,7 @@ class RateLimiterTest {
     )
 
     // the shortest limit in the header has now lapsed
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNotNull(result)
@@ -148,7 +148,7 @@ class RateLimiterTest {
     )
 
     // the shortest limit in the header has now lapsed
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNotNull(result)
@@ -176,7 +176,7 @@ class RateLimiterTest {
     rateLimiter.updateRetryAfterLimits("1::key, 60:default;error;security:organization", null, 1)
 
     // the shortest limit in the header has now lapsed
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNull(result)
@@ -191,7 +191,7 @@ class RateLimiterTest {
     rateLimiter.updateRetryAfterLimits("60:error:key, 1:error:organization", null, 1)
 
     // the shortest limit in the header has now lapsed
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNull(result)
@@ -206,7 +206,7 @@ class RateLimiterTest {
     rateLimiter.updateRetryAfterLimits("1:error:key, 5:error:organization", null, 1)
 
     // the shortest limit in the header has now lapsed
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNull(result)
@@ -221,7 +221,7 @@ class RateLimiterTest {
     rateLimiter.updateRetryAfterLimits(null, null, 429)
 
     // a second in, the 60s default delay is still running
-    fixture.clock.advance(1001, MILLISECONDS)
+    fixture.ticker.advance(1001, MILLISECONDS)
 
     val result = rateLimiter.filter(envelope, Hint())
     assertNull(result)
@@ -392,10 +392,10 @@ class RateLimiterTest {
 
     rateLimiter.updateRetryAfterLimits("1:error:key", null, 1)
 
-    fixture.clock.advance(999, MILLISECONDS)
+    fixture.ticker.advance(999, MILLISECONDS)
     assertTrue(rateLimiter.isActiveForCategory(DataCategory.Error))
 
-    fixture.clock.advance(1, MILLISECONDS)
+    fixture.ticker.advance(1, MILLISECONDS)
     assertFalse(rateLimiter.isActiveForCategory(DataCategory.Error))
   }
 
@@ -698,7 +698,7 @@ class RateLimiterTest {
     rateLimiter.updateRetryAfterLimits("1:replay:key", null, 1)
 
     // the notification is scheduled ~1s out in real time; by then the limit has lapsed
-    fixture.clock.advance(2, SECONDS)
+    fixture.ticker.advance(2, SECONDS)
 
     await.untilFalse(applied)
     assertFalse(applied.get())