Add configurable auto transaction deadline timeout with manifest support

Co-authored-by: stefano.siano <stefano.siano@sentry.io>

Author: cursoragent

IMPLEMENTATION_SUMMARY.md

@@ -11,14 +11,14 @@ Added a new configuration option `autoTransactionDeadlineTimeoutMillis` to `Sent
 #### 1. Added New Option to SentryAndroidOptions
 **File**: `/workspace/sentry-android-core/src/main/java/io/sentry/android/core/SentryAndroidOptions.java`
 
-- Added field `autoTransactionDeadlineTimeoutMillis` with default value `0`
+- Added field `autoTransactionDeadlineTimeoutMillis` with default value `30000`
 - Added getter `getAutoTransactionDeadlineTimeoutMillis()`
 - Added setter `setAutoTransactionDeadlineTimeoutMillis(long autoTransactionDeadlineTimeoutMillis)`
 
 **Behavior**:
-- `0` (default): Use the existing 30-second default timeout
+- `30000` (default): 30-second timeout (same as previous behavior)
 - Positive value: Use the specified timeout in milliseconds
-- Negative value: No deadline (transactions only finish when explicitly finished or activity lifecycle ends)
+- Zero or negative value: No deadline (transactions only finish when explicitly finished or activity lifecycle ends)
 
 #### 2. Updated ActivityLifecycleIntegration
 **File**: `/workspace/sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java`
@@ -35,36 +35,51 @@ Applied the same deadline timeout configuration logic for user interaction trans
 
 Modified to use the new configuration option with appropriate type checking since navigation listener works with base `SentryOptions`.
 
-#### 5. Added Tests
+#### 5. Added Manifest Support
+**File**: `/workspace/sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java`
+
+Added support for configuring the option via AndroidManifest.xml using the key `io.sentry.traces.auto-transaction-deadline-timeout-millis`.
+
+#### 6. Added Tests
 **Files**: 
 - `/workspace/sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidOptionsTest.kt`
 - `/workspace/sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt`
+- `/workspace/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt`
 
 Added comprehensive tests to verify:
-- Option defaults to 0
+- Option defaults to 30000
 - Option can be set to positive, negative, and zero values
 - ActivityLifecycleIntegration respects the new option
 - All three timeout behaviors work correctly (default, custom, disabled)
+- Manifest reading works correctly
 
 ### Usage Example
 
 ```kotlin
-// Disable deadline timeout (transactions only finish manually or on activity lifecycle)
+// Disable deadline timeout (solve the original issue - transactions only finish manually or on activity lifecycle)
 SentryAndroid.init(this) { options ->
-    options.autoTransactionDeadlineTimeoutMillis = -1
+    options.autoTransactionDeadlineTimeoutMillis = 0  // or any negative value
 }
 
 // Set custom 60-second timeout
 SentryAndroid.init(this) { options ->
     options.autoTransactionDeadlineTimeoutMillis = 60000
 }
 
-// Use default 30-second timeout (default behavior)
+// Use default 30-second timeout (default behavior - no configuration needed)
 SentryAndroid.init(this) { options ->
-    options.autoTransactionDeadlineTimeoutMillis = 0  // or just don't set it
+    // autoTransactionDeadlineTimeoutMillis defaults to 30000
 }
 ```
 
+**Via AndroidManifest.xml:**
+
+```xml
+<application>
+    <meta-data android:name="io.sentry.traces.auto-transaction-deadline-timeout-millis" android:value="0" />
+</application>
+```
+
 ### Backward Compatibility
 This change is fully backward compatible. Existing code will continue to work with the default 30-second timeout behavior. Only users who explicitly set the new option will experience different behavior.
 

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 negative value is set
+        if (deadlineTimeoutMillis <= 0) {
+          // No deadline when zero or negative value is set
           transactionOptions.setDeadlineTimeout(null);
-        } else if (deadlineTimeoutMillis == 0) {
-          // Use default timeout when 0 is set
-          transactionOptions.setDeadlineTimeout(
-              TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION);
         } else {
           // Use configured timeout when positive value is set
           transactionOptions.setDeadlineTimeout(deadlineTimeoutMillis);

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

@@ -127,6 +127,9 @@ final class ManifestMetadataReader {
   static final String ENABLE_AUTO_TRACE_ID_GENERATION =
       "io.sentry.traces.enable-auto-id-generation";
 
+  static final String AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS =
+      "io.sentry.traces.auto-transaction-deadline-timeout-millis";
+
   static final String FEEDBACK_NAME_REQUIRED = "io.sentry.feedback.is-name-required";
 
   static final String FEEDBACK_SHOW_NAME = "io.sentry.feedback.show-name";
@@ -446,6 +449,13 @@ static void applyMetadata(
                 ENABLE_AUTO_TRACE_ID_GENERATION,
                 options.isEnableAutoTraceIdGeneration()));
 
+        options.setAutoTransactionDeadlineTimeoutMillis(
+            readLong(
+                metadata,
+                logger,
+                AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS,
+                options.getAutoTransactionDeadlineTimeoutMillis()));
+
         if (options.getSessionReplay().getSessionSampleRate() == null) {
           final double sessionSampleRate =
               readDouble(metadata, logger, REPLAYS_SESSION_SAMPLE_RATE);

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

@@ -174,14 +174,14 @@ public final class SentryAndroidOptions extends SentryOptions {
   private boolean enableAutoTraceIdGeneration = true;
 
   /**
-   * Controls the deadline timeout in milliseconds for automatic transactions. When set to 0,
-   * the default timeout of 30 seconds is used. When set to a value greater than 0, that value
-   * is used as the deadline timeout. When set to a value less than 0, no deadline is applied
-   * and transactions will only finish when explicitly finished or when the activity lifecycle ends.
+   * 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 0 (use default 30 second timeout).
+   * <p>Default is 30000 (30 seconds).
    */
-  private long autoTransactionDeadlineTimeoutMillis = 0;
+  private long autoTransactionDeadlineTimeoutMillis = 30000;
 
   public interface BeforeCaptureCallback {
 

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 negative value is set
+    if (deadlineTimeoutMillis <= 0) {
+      // No deadline when zero or negative value is set
       transactionOptions.setDeadlineTimeout(null);
-    } else if (deadlineTimeoutMillis == 0) {
-      // Use default timeout when 0 is set
-      transactionOptions.setDeadlineTimeout(
-          TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION);
     } else {
       // Use configured timeout when positive value is set
       transactionOptions.setDeadlineTimeout(deadlineTimeoutMillis);

sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt

@@ -246,6 +246,27 @@ class ActivityLifecycleIntegrationTest {
       )
   }
 
+  @Test
+  fun `Activity transaction uses no deadline timeout when autoTransactionDeadlineTimeoutMillis is set to zero`() {
+    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)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { transactionOptions ->
+          assertNull(transactionOptions.deadlineTimeout)
+        },
+      )
+  }
+
   @Test
   fun `Activity transaction uses no deadline timeout when autoTransactionDeadlineTimeoutMillis is set to negative value`() {
     val sut = fixture.getSut()
@@ -268,10 +289,10 @@ class ActivityLifecycleIntegrationTest {
   }
 
   @Test
-  fun `Activity transaction uses default deadline timeout when autoTransactionDeadlineTimeoutMillis is set to 0`() {
+  fun `Activity transaction uses default deadline timeout when autoTransactionDeadlineTimeoutMillis is default`() {
     val sut = fixture.getSut()
     fixture.options.tracesSampleRate = 1.0
-    fixture.options.autoTransactionDeadlineTimeoutMillis = 0L // Use default
+    // Don't set autoTransactionDeadlineTimeoutMillis, use default (30000)
     sut.register(fixture.scopes, fixture.options)
 
     setAppStartTime()
@@ -283,10 +304,7 @@ class ActivityLifecycleIntegrationTest {
       .startTransaction(
         any<TransactionContext>(),
         check<TransactionOptions> { transactionOptions ->
-          assertEquals(
-            TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION,
-            transactionOptions.deadlineTimeout,
-          )
+          assertEquals(30000L, transactionOptions.deadlineTimeout)
         },
       )
   }

sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt

@@ -1091,6 +1091,20 @@ class ManifestMetadataReaderTest {
     assertEquals(expectedIdleTimeout.toLong(), fixture.options.idleTimeout)
   }
 
+  @Test
+  fun `applyMetadata reads autoTransactionDeadlineTimeoutMillis from metadata`() {
+    // Arrange
+    val expectedTimeout = 60000
+    val bundle = bundleOf(ManifestMetadataReader.AUTO_TRANSACTION_DEADLINE_TIMEOUT_MILLIS to expectedTimeout)
+    val context = fixture.getContext(metaData = bundle)
+
+    // Act
+    ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+    // Assert
+    assertEquals(expectedTimeout.toLong(), fixture.options.autoTransactionDeadlineTimeoutMillis)
+  }
+
   @Test
   fun `applyMetadata without specifying idleTimeout, stays default`() {
     // Arrange

sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidOptionsTest.kt

@@ -182,9 +182,9 @@ class SentryAndroidOptionsTest {
   }
 
   @Test
-  fun `autoTransactionDeadlineTimeoutMillis option defaults to 0`() {
+  fun `autoTransactionDeadlineTimeoutMillis option defaults to 30000`() {
     val sentryOptions = SentryAndroidOptions()
-    assertEquals(0L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
+    assertEquals(30000L, sentryOptions.autoTransactionDeadlineTimeoutMillis)
   }
 
   @Test
@@ -194,6 +194,13 @@ class SentryAndroidOptionsTest {
     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()

sentry-android-navigation/src/main/java/io/sentry/android/navigation/SentryNavigationListener.kt

@@ -138,11 +138,10 @@ constructor(
         } else {
           null
         }
-        val deadlineTimeoutMillis = androidOptions?.autoTransactionDeadlineTimeoutMillis ?: 0L
+        val deadlineTimeoutMillis = androidOptions?.autoTransactionDeadlineTimeoutMillis ?: TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION
 
         it.deadlineTimeout = when {
-          deadlineTimeoutMillis < 0 -> null // No deadline when negative value is set
-          deadlineTimeoutMillis == 0L -> TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION // Use default timeout when 0 is set
+          deadlineTimeoutMillis <= 0 -> null // No deadline when zero or negative value is set
           else -> deadlineTimeoutMillis // Use configured timeout when positive value is set
         }