ref(time): Collapse the clocks into a single MonotonicClock (JAVA-571)

Two interfaces existed so that a call site could name which suspend
behaviour it needed, but only ANR detection wanted the one that excludes
deep sleep, and neither ANR path can be fooled by a suspend: ANRWatchDog
reports only once ActivityManager confirms NOT_RESPONDING, and
AnrProfilingIntegration parks its thread while backgrounded and resets
its baseline on wake.

That leaves one guarantee worth naming. Ticker, UptimeClock and
JavaUptimeClock are gone, and ElapsedRealtimeClock becomes
MonotonicClock, backed by elapsedRealtimeNanos() on Android and
nanoTime() on the JVM.

Author: runningcode

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Internal
 
-- Add internal `UptimeClock` and `ElapsedRealtimeClock` abstractions with `Deadline` and `Stopwatch` primitives ([#6028](https://github.com/getsentry/sentry-java/pull/6028))
+- Add an internal `MonotonicClock` abstraction with `Deadline` and `Stopwatch` primitives ([#6028](https://github.com/getsentry/sentry-java/pull/6028))
 
 ## 8.55.0
 

sentry-android-core/api/sentry-android-core.api

@@ -413,8 +413,8 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun getBeforeScreenshotCaptureCallback ()Lio/sentry/android/core/SentryAndroidOptions$BeforeCaptureCallback;
 	public fun getBeforeViewHierarchyCaptureCallback ()Lio/sentry/android/core/SentryAndroidOptions$BeforeCaptureCallback;
 	public fun getDebugImagesLoader ()Lio/sentry/android/core/IDebugImagesLoader;
-	public fun getElapsedRealtimeClock ()Lio/sentry/time/ElapsedRealtimeClock;
 	public fun getFrameMetricsCollector ()Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;
+	public fun getMonotonicClock ()Lio/sentry/time/MonotonicClock;
 	public fun getNativeSdkName ()Ljava/lang/String;
 	public fun getNdkAppHangTimeoutIntervalMillis ()J
 	public fun getNdkHandlerStrategy ()I

sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java

@@ -12,13 +12,13 @@
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.SpanStatus;
-import io.sentry.android.core.internal.time.AndroidElapsedRealtimeClock;
+import io.sentry.android.core.internal.time.AndroidMonotonicClock;
 import io.sentry.android.core.internal.util.RootChecker;
 import io.sentry.android.core.internal.util.SentryFrameMetricsCollector;
 import io.sentry.protocol.Mechanism;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.protocol.SentryId;
-import io.sentry.time.ElapsedRealtimeClock;
+import io.sentry.time.MonotonicClock;
 import io.sentry.util.SampleRateUtils;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
@@ -893,8 +893,8 @@ public void setEnableAnrFingerprinting(final boolean enableAnrFingerprinting) {
 
   @Override
   @ApiStatus.Internal
-  public @NotNull ElapsedRealtimeClock getElapsedRealtimeClock() {
-    return AndroidElapsedRealtimeClock.getInstance();
+  public @NotNull MonotonicClock getMonotonicClock() {
+    return AndroidMonotonicClock.getInstance();
   }
 
   static class AndroidUserFeedbackFormHandler implements SentryFeedbackOptions.IFormHandler {

…al/time/AndroidElapsedRealtimeClock.java …internal/time/AndroidMonotonicClock.javasentry-android-core/src/main/java/io/sentry/android/core/internal/time/AndroidElapsedRealtimeClock.java renamed to sentry-android-core/src/main/java/io/sentry/android/core/internal/time/AndroidMonotonicClock.java sentry-android-core/src/main/java/io/sentry/android/core/internal/time/AndroidElapsedRealtimeClock.java renamed to sentry-android-core/src/main/java/io/sentry/android/core/internal/time/AndroidMonotonicClock.java

@@ -1,26 +1,26 @@
 package io.sentry.android.core.internal.time;
 
 import android.os.SystemClock;
-import io.sentry.time.ElapsedRealtimeClock;
+import io.sentry.time.MonotonicClock;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * {@link ElapsedRealtimeClock} backed by {@link SystemClock#elapsedRealtimeNanos()}.
+ * {@link MonotonicClock} backed by {@link SystemClock#elapsedRealtimeNanos()}.
  *
  * <p>That is {@code CLOCK_BOOTTIME}, so it keeps counting while the device is suspended — unlike
  * {@link System#nanoTime()}, which the core module falls back to and which stops in deep sleep.
  */
 @ApiStatus.Internal
-public final class AndroidElapsedRealtimeClock implements ElapsedRealtimeClock {
+public final class AndroidMonotonicClock implements MonotonicClock {
 
-  private static final AndroidElapsedRealtimeClock instance = new AndroidElapsedRealtimeClock();
+  private static final AndroidMonotonicClock instance = new AndroidMonotonicClock();
 
-  public static @NotNull ElapsedRealtimeClock getInstance() {
+  public static @NotNull MonotonicClock getInstance() {
     return instance;
   }
 
-  private AndroidElapsedRealtimeClock() {}
+  private AndroidMonotonicClock() {}
 
   @Override
   public long tickNanos() {

…main/kotlin/io/sentry/time/TestTicker.kt …lin/io/sentry/time/TestMonotonicClock.ktsentry-test-support/src/main/kotlin/io/sentry/time/TestTicker.kt renamed to sentry-test-support/src/main/kotlin/io/sentry/time/TestMonotonicClock.kt sentry-test-support/src/main/kotlin/io/sentry/time/TestTicker.kt renamed to sentry-test-support/src/main/kotlin/io/sentry/time/TestMonotonicClock.kt

@@ -3,17 +3,13 @@ package io.sentry.time
 import java.util.concurrent.TimeUnit
 
 /**
- * A [Ticker] that only moves when a test tells it to.
+ * A [MonotonicClock] that only moves when a test tells it to.
  *
  * Advancing by an amount *and a unit* is the point: a stubbed `thenReturn(1001)` against a
  * nanosecond clock is off by a factor of a million and still compiles, whereas `advance(1001,
  * MILLISECONDS)` cannot be.
- *
- * Implements both clock guarantees so a test can inject it wherever either is declared. Production
- * code must never do this — the whole purpose of the two interfaces is that one object cannot
- * honestly promise both.
  */
-class TestTicker(private var nanos: Long = 0) : UptimeClock, ElapsedRealtimeClock {
+class TestMonotonicClock(private var nanos: Long = 0) : MonotonicClock {
   override fun tickNanos(): Long = nanos
 
   fun advance(amount: Long, unit: TimeUnit) {

sentry/api/sentry.api

@@ -3704,7 +3704,6 @@ public class io/sentry/SentryOptions {
 	public fun getDistributionController ()Lio/sentry/IDistributionApi;
 	public fun getDsn ()Ljava/lang/String;
 	public fun getEffectiveOrgId ()Ljava/lang/String;
-	public fun getElapsedRealtimeClock ()Lio/sentry/time/ElapsedRealtimeClock;
 	public fun getEnvelopeDiskCache ()Lio/sentry/cache/IEnvelopeCache;
 	public fun getEnvelopeReader ()Lio/sentry/IEnvelopeReader;
 	public fun getEnvironment ()Ljava/lang/String;
@@ -3741,6 +3740,7 @@ public class io/sentry/SentryOptions {
 	public fun getMaxTraceFileSize ()J
 	public fun getMetrics ()Lio/sentry/SentryOptions$Metrics;
 	public fun getModulesLoader ()Lio/sentry/internal/modules/IModulesLoader;
+	public fun getMonotonicClock ()Lio/sentry/time/MonotonicClock;
 	public fun getOnDiscard ()Lio/sentry/SentryOptions$OnDiscardCallback;
 	public fun getOnOversizedEvent ()Lio/sentry/SentryOptions$OnOversizedEventCallback;
 	public fun getOpenTelemetryMode ()Lio/sentry/SentryOpenTelemetryMode;
@@ -7599,37 +7599,26 @@ public final class io/sentry/rrweb/RRWebVideoEvent$JsonKeys {
 }
 
 public final class io/sentry/time/Deadline {
-	public static fun after (Lio/sentry/time/Ticker;JLjava/util/concurrent/TimeUnit;)Lio/sentry/time/Deadline;
+	public static fun after (Lio/sentry/time/MonotonicClock;JLjava/util/concurrent/TimeUnit;)Lio/sentry/time/Deadline;
 	public fun hasPassed ()Z
 	public fun isAfter (Lio/sentry/time/Deadline;)Z
-	public static fun passed (Lio/sentry/time/Ticker;)Lio/sentry/time/Deadline;
+	public static fun passed (Lio/sentry/time/MonotonicClock;)Lio/sentry/time/Deadline;
 	public fun remaining (Ljava/util/concurrent/TimeUnit;)J
 }
 
-public abstract interface class io/sentry/time/ElapsedRealtimeClock : io/sentry/time/Ticker {
-}
-
-public final class io/sentry/time/JavaElapsedRealtimeClock : io/sentry/time/ElapsedRealtimeClock {
-	public static fun getInstance ()Lio/sentry/time/ElapsedRealtimeClock;
+public final class io/sentry/time/JavaMonotonicClock : io/sentry/time/MonotonicClock {
+	public static fun getInstance ()Lio/sentry/time/MonotonicClock;
 	public fun tickNanos ()J
 }
 
-public final class io/sentry/time/JavaUptimeClock : io/sentry/time/UptimeClock {
-	public static fun getInstance ()Lio/sentry/time/UptimeClock;
-	public fun tickNanos ()J
+public abstract interface class io/sentry/time/MonotonicClock {
+	public abstract fun tickNanos ()J
 }
 
 public final class io/sentry/time/Stopwatch {
 	public fun elapsed (Ljava/util/concurrent/TimeUnit;)J
 	public fun elapsedNanos ()J
-	public static fun started (Lio/sentry/time/Ticker;)Lio/sentry/time/Stopwatch;
-}
-
-public abstract interface class io/sentry/time/Ticker {
-	public abstract fun tickNanos ()J
-}
-
-public abstract interface class io/sentry/time/UptimeClock : io/sentry/time/Ticker {
+	public static fun started (Lio/sentry/time/MonotonicClock;)Lio/sentry/time/Stopwatch;
 }
 
 public final class io/sentry/transport/AsyncHttpTransport : io/sentry/transport/ITransport {

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -21,8 +21,8 @@
 import io.sentry.metrics.IMetricsBatchProcessorFactory;
 import io.sentry.protocol.SdkVersion;
 import io.sentry.protocol.SentryTransaction;
-import io.sentry.time.ElapsedRealtimeClock;
-import io.sentry.time.JavaElapsedRealtimeClock;
+import io.sentry.time.JavaMonotonicClock;
+import io.sentry.time.MonotonicClock;
 import io.sentry.transport.ITransport;
 import io.sentry.transport.ITransportGate;
 import io.sentry.transport.NoOpEnvelopeCache;
@@ -3062,15 +3062,15 @@ public void setDateProvider(final @NotNull SentryDateProvider dateProvider) {
   }
 
   /**
-   * Returns the clock used to measure intervals that must include deep sleep, such as rate-limit
-   * windows and cache expiry.
+   * Returns the clock used to measure elapsed time, such as rate-limit windows, cache expiry and
+   * ANR thresholds.
    *
    * <p>Android overrides this with a {@code SystemClock.elapsedRealtimeNanos()}-backed clock, which
    * this module cannot reference. On the JVM there is no suspend state to account for.
    */
   @ApiStatus.Internal
-  public @NotNull ElapsedRealtimeClock getElapsedRealtimeClock() {
-    return JavaElapsedRealtimeClock.getInstance();
+  public @NotNull MonotonicClock getMonotonicClock() {
+    return JavaMonotonicClock.getInstance();
   }
 
   /**

sentry/src/main/java/io/sentry/time/Deadline.java

@@ -5,7 +5,7 @@
 import org.jetbrains.annotations.NotNull;
 
 /**
- * A point in the future, measured on a {@link Ticker}.
+ * A point in the future, measured on a {@link MonotonicClock}.
  *
  * <p>Exists so that callers never do arithmetic on raw ticks. A tick carries no unit and no epoch,
  * so spelling out {@code now - then < ttl} at every call site is where unit mix-ups, sentinels that
@@ -15,17 +15,17 @@
 @ApiStatus.Internal
 public final class Deadline {
 
-  private final @NotNull Ticker clock;
+  private final @NotNull MonotonicClock clock;
   private final long deadlineNanos;
 
-  private Deadline(final @NotNull Ticker clock, final long deadlineNanos) {
+  private Deadline(final @NotNull MonotonicClock clock, final long deadlineNanos) {
     this.clock = clock;
     this.deadlineNanos = deadlineNanos;
   }
 
   /** A deadline {@code amount} of {@code unit} from now. */
   public static @NotNull Deadline after(
-      final @NotNull Ticker clock, final long amount, final @NotNull TimeUnit unit) {
+      final @NotNull MonotonicClock clock, final long amount, final @NotNull TimeUnit unit) {
     return new Deadline(clock, clock.tickNanos() + unit.toNanos(amount));
   }
 
@@ -34,7 +34,7 @@ private Deadline(final @NotNull Ticker clock, final long deadlineNanos) {
    * "never set" needs no numeric sentinel and cannot be mistaken for fresh — {@code 0} is a real
    * and very recent instant on any boot-relative clock.
    */
-  public static @NotNull Deadline passed(final @NotNull Ticker clock) {
+  public static @NotNull Deadline passed(final @NotNull MonotonicClock clock) {
     return new Deadline(clock, clock.tickNanos());
   }