moved autoTransactionDeadlineTimeoutMillis to SentryOptions

stefanosiano · stefanosiano · commit 176d0afab92a · 2025-07-16T17:17:05.000+02:00
small cleanup
updated changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add autoTransactionDeadlineTimeoutMillis option ([#4555](https://github.com/getsentry/sentry-java/pull/4555))
+
 ### Fixes
 
 - Allow multiple UncaughtExceptionHandlerIntegrations to be active at the same time ([#4462](https://github.com/getsentry/sentry-java/pull/4462))
diff --git a/IMPLEMENTATION_SUMMARY.md b/IMPLEMENTATION_SUMMARY.md
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java b/sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java
@@ -192,13 +192,9 @@ private void startTracing(final @NotNull Activity activity) {
 
         // Set deadline timeout based on configured option
         final long deadlineTimeoutMillis = options.getAutoTransactionDeadlineTimeoutMillis();
-        if (deadlineTimeoutMillis <= 0) {
-          // No deadline when zero or negative value is set
-          transactionOptions.setDeadlineTimeout(null);
-        } else {
-          // Use configured timeout when positive value is set
-          transactionOptions.setDeadlineTimeout(deadlineTimeoutMillis);
-        }
+        // No deadline when zero or negative value is set
+        transactionOptions.setDeadlineTimeout(
+            deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);
 
         if (options.isEnableActivityLifecycleTracingAutoFinish()) {
           transactionOptions.setIdleTimeout(options.getIdleTimeout());
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java b/sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java
@@ -173,16 +173,6 @@ public final class SentryAndroidOptions extends SentryOptions {
    */
   private boolean enableAutoTraceIdGeneration = true;
 
-  /**
-   * Controls the deadline timeout in milliseconds for automatic transactions. When set to a
-   * positive value, that value is used as the deadline timeout. When set to a value less than or
-   * equal to 0, no deadline is applied and transactions will only finish when explicitly finished
-   * or when the activity lifecycle ends.
-   *
-   * <p>Default is 30000 (30 seconds).
-   */
-  private long autoTransactionDeadlineTimeoutMillis = 30000;
-
   public interface BeforeCaptureCallback {
 
     /**
@@ -619,12 +609,4 @@ public boolean isEnableAutoTraceIdGeneration() {
   public void setEnableAutoTraceIdGeneration(final boolean enableAutoTraceIdGeneration) {
     this.enableAutoTraceIdGeneration = enableAutoTraceIdGeneration;
   }
-
-  public long getAutoTransactionDeadlineTimeoutMillis() {
-    return autoTransactionDeadlineTimeoutMillis;
-  }
-
-  public void setAutoTransactionDeadlineTimeoutMillis(long autoTransactionDeadlineTimeoutMillis) {
-    this.autoTransactionDeadlineTimeoutMillis = autoTransactionDeadlineTimeoutMillis;
-  }
 }
diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/internal/gestures/SentryGestureListener.java b/sentry-android-core/src/main/java/io/sentry/android/core/internal/gestures/SentryGestureListener.java
@@ -252,13 +252,9 @@ private void startTracing(final @NotNull UiElement target, final @NotNull Gestur
 
     // Set deadline timeout based on configured option
     final long deadlineTimeoutMillis = options.getAutoTransactionDeadlineTimeoutMillis();
-    if (deadlineTimeoutMillis <= 0) {
-      // No deadline when zero or negative value is set
-      transactionOptions.setDeadlineTimeout(null);
-    } else {
-      // Use configured timeout when positive value is set
-      transactionOptions.setDeadlineTimeout(deadlineTimeoutMillis);
-    }
+    // No deadline when zero or negative value is set
+    transactionOptions.setDeadlineTimeout(
+        deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);
 
     transactionOptions.setIdleTimeout(options.getIdleTimeout());
     transactionOptions.setTrimEnd(true);
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt
@@ -230,12 +230,9 @@ class ActivityLifecycleIntegrationTest {
     val sut = fixture.getSut()
     fixture.options.tracesSampleRate = 1.0
     fixture.options.autoTransactionDeadlineTimeoutMillis = 60000L // 60 seconds
-    sut.register(fixture.scopes, fixture.options)
-
-    setAppStartTime()
 
-    val activity = mock<Activity>()
-    sut.onActivityCreated(activity, fixture.bundle)
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
 
     verify(fixture.scopes)
       .startTransaction(
@@ -251,12 +248,9 @@ class ActivityLifecycleIntegrationTest {
     val sut = fixture.getSut()
     fixture.options.tracesSampleRate = 1.0
     fixture.options.autoTransactionDeadlineTimeoutMillis = 0L // No deadline
-    sut.register(fixture.scopes, fixture.options)
-
-    setAppStartTime()
 
-    val activity = mock<Activity>()
-    sut.onActivityCreated(activity, fixture.bundle)
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
 
     verify(fixture.scopes)
       .startTransaction(
@@ -272,12 +266,9 @@ class ActivityLifecycleIntegrationTest {
     val sut = fixture.getSut()
     fixture.options.tracesSampleRate = 1.0
     fixture.options.autoTransactionDeadlineTimeoutMillis = -1L // No deadline
-    sut.register(fixture.scopes, fixture.options)
-
-    setAppStartTime()
 
-    val activity = mock<Activity>()
-    sut.onActivityCreated(activity, fixture.bundle)
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
 
     verify(fixture.scopes)
       .startTransaction(
@@ -293,12 +284,9 @@ class ActivityLifecycleIntegrationTest {
     val sut = fixture.getSut()
     fixture.options.tracesSampleRate = 1.0
     // Don't set autoTransactionDeadlineTimeoutMillis, use default (30000)
-    sut.register(fixture.scopes, fixture.options)
-
-    setAppStartTime()
 
-    val activity = mock<Activity>()
-    sut.onActivityCreated(activity, fixture.bundle)
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
 
     verify(fixture.scopes)
       .startTransaction(
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt
@@ -1106,6 +1106,18 @@ class ManifestMetadataReaderTest {
     assertEquals(expectedTimeout.toLong(), fixture.options.autoTransactionDeadlineTimeoutMillis)
   }
 
+  @Test
+  fun `applyMetadata reads autoTransactionDeadlineTimeoutMillis from metadata and keep default value if not found`() {
+    // Arrange
+    val context = fixture.getContext()
+
+    // Act
+    ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+    // Assert
+    assertEquals(30000L, fixture.options.autoTransactionDeadlineTimeoutMillis)
+  }
+
   @Test
   fun `applyMetadata without specifying idleTimeout, stays default`() {
     // Arrange
diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidOptionsTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidOptionsTest.kt
@@ -181,33 +181,6 @@ class SentryAndroidOptionsTest {
     )
   }
 
-  @Test
-  fun `autoTransactionDeadlineTimeoutMillis option defaults to 30000`() {
-    val sentryOptions = SentryAndroidOptions()
-    assertEquals(30000L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
-  }
-
-  @Test
-  fun `autoTransactionDeadlineTimeoutMillis option can be changed`() {
-    val sentryOptions = SentryAndroidOptions()
-    sentryOptions.autoTransactionDeadlineTimeoutMillis = 60000L
-    assertEquals(60000L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
-  }
-
-  @Test
-  fun `autoTransactionDeadlineTimeoutMillis option can be set to zero value`() {
-    val sentryOptions = SentryAndroidOptions()
-    sentryOptions.autoTransactionDeadlineTimeoutMillis = 0L
-    assertEquals(0L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
-  }
-
-  @Test
-  fun `autoTransactionDeadlineTimeoutMillis option can be set to negative value`() {
-    val sentryOptions = SentryAndroidOptions()
-    sentryOptions.autoTransactionDeadlineTimeoutMillis = -1L
-    assertEquals(-1L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
-  }
-
   private class CustomDebugImagesLoader : IDebugImagesLoader {
     override fun loadDebugImages(): List<DebugImage>? = null
 
diff --git a/sentry-android-navigation/src/main/java/io/sentry/android/navigation/SentryNavigationListener.kt b/sentry-android-navigation/src/main/java/io/sentry/android/navigation/SentryNavigationListener.kt
@@ -133,21 +133,9 @@ constructor(
         it.idleTimeout = scopes.options.idleTimeout
 
         // Set deadline timeout based on configured option
-        val androidOptions =
-          if (scopes.options is io.sentry.android.core.SentryAndroidOptions) {
-            scopes.options as io.sentry.android.core.SentryAndroidOptions
-          } else {
-            null
-          }
-        val deadlineTimeoutMillis =
-          androidOptions?.autoTransactionDeadlineTimeoutMillis
-            ?: TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION
-
-        it.deadlineTimeout =
-          when {
-            deadlineTimeoutMillis <= 0 -> null // No deadline when zero or negative value is set
-            else -> deadlineTimeoutMillis // Use configured timeout when positive value is set
-          }
+        val deadlineTimeoutMillis = scopes.options.autoTransactionDeadlineTimeoutMillis
+        // No deadline when zero or negative value is set
+        it.deadlineTimeout = if (deadlineTimeoutMillis <= 0) null else deadlineTimeoutMillis
 
         it.isTrimEnd = true
       }
diff --git a/sentry-android-navigation/src/test/java/io/sentry/android/navigation/SentryNavigationListenerTest.kt b/sentry-android-navigation/src/test/java/io/sentry/android/navigation/SentryNavigationListenerTest.kt
@@ -399,6 +399,48 @@ class SentryNavigationListenerTest {
       )
   }
 
+  @Test
+  fun `Navigation listener uses custom deadline timeout when set to positive value`() {
+    val sut = fixture.getSut()
+    fixture.options.autoTransactionDeadlineTimeoutMillis = 60000L
+
+    sut.onDestinationChanged(fixture.navController, fixture.destination, null)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { options -> assertEquals(60000L, options.deadlineTimeout) },
+      )
+  }
+
+  @Test
+  fun `Navigation listener uses no deadline timeout when set to zero`() {
+    val sut = fixture.getSut()
+    fixture.options.autoTransactionDeadlineTimeoutMillis = 0L
+
+    sut.onDestinationChanged(fixture.navController, fixture.destination, null)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { options -> assertNull(options.deadlineTimeout) },
+      )
+  }
+
+  @Test
+  fun `Navigation listener uses no deadline timeout when set to negative value`() {
+    val sut = fixture.getSut()
+    fixture.options.autoTransactionDeadlineTimeoutMillis = -1L
+
+    sut.onDestinationChanged(fixture.navController, fixture.destination, null)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { options -> assertNull(options.deadlineTimeout) },
+      )
+  }
+
   @Test
   fun `onDestinationChanged sets scope screen`() {
     val sut = fixture.getSut()
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -3265,6 +3265,7 @@ public class io/sentry/SentryOptions {
 	public fun addScopeObserver (Lio/sentry/IScopeObserver;)V
 	public static fun empty ()Lio/sentry/SentryOptions;
 	public fun findPersistingScopeObserver ()Lio/sentry/cache/PersistingScopeObserver;
+	public fun getAutoTransactionDeadlineTimeoutMillis ()J
 	public fun getBackpressureMonitor ()Lio/sentry/backpressure/IBackpressureMonitor;
 	public fun getBeforeBreadcrumb ()Lio/sentry/SentryOptions$BeforeBreadcrumbCallback;
 	public fun getBeforeEnvelopeCallback ()Lio/sentry/SentryOptions$BeforeEnvelopeCallback;
@@ -3397,6 +3398,7 @@ public class io/sentry/SentryOptions {
 	public fun setAttachServerName (Z)V
 	public fun setAttachStacktrace (Z)V
 	public fun setAttachThreads (Z)V
+	public fun setAutoTransactionDeadlineTimeoutMillis (J)V
 	public fun setBackpressureMonitor (Lio/sentry/backpressure/IBackpressureMonitor;)V
 	public fun setBeforeBreadcrumb (Lio/sentry/SentryOptions$BeforeBreadcrumbCallback;)V
 	public fun setBeforeEnvelopeCallback (Lio/sentry/SentryOptions$BeforeEnvelopeCallback;)V
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
diff --git a/sentry/src/test/java/io/sentry/SentryOptionsTest.kt b/sentry/src/test/java/io/sentry/SentryOptionsTest.kt
