Merge branch 'main' into feat/e2e-console-app-samples

Author: adinauer

.cursor/rules/coding.mdc

@@ -0,0 +1,53 @@
+---
+alwaysApply: true
+description: Cursor Coding Rules
+---
+
+# Contributing Rules for Agents
+
+## Overview
+
+sentry-java is the Java and Android SDK for Sentry. This repository contains the source code and examples for SDK usage.
+
+## Tech Stack
+
+- **Language**: Java and Kotlin
+- **Build Framework**: Gradle
+
+## Key Commands
+
+```bash
+# Format code and regenerate .api files
+./gradlew spotlessApply apiDump
+
+# Run all tests and linter
+./gradlew check
+
+# Run unit tests for a specific file
+./gradle ':<module>:testDebugUnitTest' --tests="*<file name>*" --info
+```
+
+## Contributing Guidelines
+
+1. Follow existing code style and language
+2. Do not modify the API files (e.g. sentry.api) manually, instead run `./gradlew  apiDump` to regenerate them
+3. Write comprehensive tests
+4. New features should always be opt-in by default, extend `SentryOptions` or similar Option classes with getters and setters to enable/disable a new feature
+5. Consider backwards compatibility
+
+## Coding rules
+
+1. First think through the problem, read the codebase for relevant files, and propose a plan
+2. Before you begin working, check in with me and I will verify the plan
+3. Then, begin working on the todo items, marking them as complete as you go
+4. Please do not describe every step of the way and just give me a high level explanation of what changes you made
+5. Make every task and code change you do as simple as possible. We want to avoid making any massive or complex changes. Every change should impact as little code as possible. Everything is about simplicity.
+6. Once you're done, format the code and regenerate the .api files using the following command `./gradlew spotlessApply apiDump`
+7. As a last step, git stage the relevant files and propose (but not execute) a single git commit command (e.g. `git commit -m "<git commit message>"`)
+
+
+## Useful Resources
+
+- Main SDK documentation: https://develop.sentry.dev/sdk/overview/
+- Internal contributing guide: https://docs.sentry.io/internal/contributing/
+- Git commit messages conventions: https://develop.sentry.dev/engineering-practices/commit-messages/

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ## Unreleased
 
+### Features
+
+- Add deadlineTimeout 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))
+- Prevent repeated scroll target determination during a single scroll gesture ([#4557](https://github.com/getsentry/sentry-java/pull/4557))
+  - This should reduce the number of ANRs seen in `SentryGestureListener`
 
 ## 8.17.0
 

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

@@ -189,8 +189,12 @@ private void startTracing(final @NotNull Activity activity) {
         }
 
         final TransactionOptions transactionOptions = new TransactionOptions();
+
+        // Set deadline timeout based on configured option
+        final long deadlineTimeoutMillis = options.getDeadlineTimeout();
+        // No deadline when zero or negative value is set
         transactionOptions.setDeadlineTimeout(
-            TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION);
+            deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);
 
         if (options.isEnableActivityLifecycleTracingAutoFinish()) {
           transactionOptions.setIdleTimeout(options.getIdleTimeout());

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

@@ -127,6 +127,8 @@ final class ManifestMetadataReader {
   static final String ENABLE_AUTO_TRACE_ID_GENERATION =
       "io.sentry.traces.enable-auto-id-generation";
 
+  static final String DEADLINE_TIMEOUT = "io.sentry.traces.deadline-timeout";
+
   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 +448,9 @@ static void applyMetadata(
                 ENABLE_AUTO_TRACE_ID_GENERATION,
                 options.isEnableAutoTraceIdGeneration()));
 
+        options.setDeadlineTimeout(
+            readLong(metadata, logger, DEADLINE_TIMEOUT, options.getDeadlineTimeout()));
+
         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/internal/gestures/SentryGestureListener.java

@@ -139,6 +139,7 @@ public boolean onScroll(
         options
             .getLogger()
             .log(SentryLevel.DEBUG, "Unable to find scroll target. No breadcrumb captured.");
+        scrollState.type = GestureType.Scroll;
         return false;
       } else {
         options
@@ -249,8 +250,13 @@ private void startTracing(final @NotNull UiElement target, final @NotNull Gestur
 
     final TransactionOptions transactionOptions = new TransactionOptions();
     transactionOptions.setWaitForChildren(true);
+
+    // Set deadline timeout based on configured option
+    final long deadlineTimeoutMillis = options.getDeadlineTimeout();
+    // No deadline when zero or negative value is set
     transactionOptions.setDeadlineTimeout(
-        TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION);
+        deadlineTimeoutMillis <= 0 ? null : deadlineTimeoutMillis);
+
     transactionOptions.setIdleTimeout(options.getIdleTimeout());
     transactionOptions.setTrimEnd(true);
     transactionOptions.setOrigin(TRACE_ORIGIN + "." + target.getOrigin());

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

@@ -225,6 +225,80 @@ class ActivityLifecycleIntegrationTest {
       )
   }
 
+  @Test
+  fun `Activity transaction uses custom deadline timeout when autoTransactionDeadlineTimeoutMillis is set to positive value`() {
+    val sut = fixture.getSut()
+    fixture.options.tracesSampleRate = 1.0
+    fixture.options.deadlineTimeout = 60000L // 60 seconds
+
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { transactionOptions ->
+          assertEquals(60000L, transactionOptions.deadlineTimeout)
+        },
+      )
+  }
+
+  @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.deadlineTimeout = 0L // No deadline
+
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), 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()
+    fixture.options.tracesSampleRate = 1.0
+    fixture.options.deadlineTimeout = -1L // No deadline
+
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { transactionOptions ->
+          assertNull(transactionOptions.deadlineTimeout)
+        },
+      )
+  }
+
+  @Test
+  fun `Activity transaction uses default deadline timeout when autoTransactionDeadlineTimeoutMillis is default`() {
+    val sut = fixture.getSut()
+    fixture.options.tracesSampleRate = 1.0
+
+    sut.register(fixture.scopes, fixture.options)
+    sut.onActivityCreated(mock(), fixture.bundle)
+
+    verify(fixture.scopes)
+      .startTransaction(
+        any<TransactionContext>(),
+        check<TransactionOptions> { transactionOptions ->
+          assertEquals(
+            TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION,
+            transactionOptions.deadlineTimeout,
+          )
+        },
+      )
+  }
+
   @Test
   fun `Activity gets added to ActivityFramesTracker during transaction creation`() {
     val sut = fixture.getSut()

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

@@ -9,6 +9,7 @@ import io.sentry.ILogger
 import io.sentry.ProfileLifecycle
 import io.sentry.SentryLevel
 import io.sentry.SentryReplayOptions
+import io.sentry.TransactionOptions
 import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -1091,6 +1092,35 @@ class ManifestMetadataReaderTest {
     assertEquals(expectedIdleTimeout.toLong(), fixture.options.idleTimeout)
   }
 
+  @Test
+  fun `applyMetadata reads autoTransactionDeadlineTimeoutMillis from metadata`() {
+    // Arrange
+    val expectedTimeout = 60000
+    val bundle = bundleOf(ManifestMetadataReader.DEADLINE_TIMEOUT to expectedTimeout)
+    val context = fixture.getContext(metaData = bundle)
+
+    // Act
+    ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+    // Assert
+    assertEquals(expectedTimeout.toLong(), fixture.options.deadlineTimeout)
+  }
+
+  @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(
+      TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION,
+      fixture.options.deadlineTimeout,
+    )
+  }
+
   @Test
   fun `applyMetadata without specifying idleTimeout, stays default`() {
     // Arrange

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/SentryGestureListenerScrollTest.kt

@@ -11,11 +11,13 @@ import android.widget.AbsListView
 import android.widget.ListAdapter
 import androidx.core.view.ScrollingView
 import io.sentry.Breadcrumb
+import io.sentry.ILogger
 import io.sentry.IScope
 import io.sentry.IScopes
 import io.sentry.PropagationContext
 import io.sentry.Scope
 import io.sentry.ScopeCallback
+import io.sentry.SentryLevel
 import io.sentry.SentryLevel.INFO
 import io.sentry.android.core.SentryAndroidOptions
 import kotlin.test.Test
@@ -28,6 +30,7 @@ import org.mockito.kotlin.doAnswer
 import org.mockito.kotlin.inOrder
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
+import org.mockito.kotlin.times
 import org.mockito.kotlin.verify
 import org.mockito.kotlin.verifyNoMoreInteractions
 import org.mockito.kotlin.whenever
@@ -56,7 +59,7 @@ class SentryGestureListenerScrollTest {
     val directions = setOf("up", "down", "left", "right")
 
     internal inline fun <reified T : View> getSut(
-      resourceName: String = "test_scroll_view",
+      resourceName: String? = "test_scroll_view",
       touchWithinBounds: Boolean = true,
       direction: String = "",
     ): SentryGestureListener {
@@ -229,6 +232,22 @@ class SentryGestureListenerScrollTest {
     verify(fixture.scope).propagationContext = any()
   }
 
+  @Test
+  fun `logs error message only once per gesture when no scroll target is found`() {
+    val logger = mock<ILogger>()
+    fixture.options.setLogger(logger)
+    fixture.options.isDebug = true
+    val sut = fixture.getSut<ScrollableListView>(resourceName = null)
+
+    sut.onDown(fixture.firstEvent)
+    fixture.eventsInBetween.forEach { sut.onScroll(fixture.firstEvent, it, 10.0f, 0f) }
+    sut.onUp(fixture.endEvent)
+
+    // Verify that the error message is logged only once during the entire gesture
+    verify(logger, times(1))
+      .log(SentryLevel.DEBUG, "Unable to find scroll target. No breadcrumb captured.")
+  }
+
   internal class ScrollableView : View(mock()), ScrollingView {
     override fun computeVerticalScrollOffset(): Int = 0
 

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/ViewHelpers.kt

@@ -67,6 +67,11 @@ internal inline fun <reified T : View> mockView(
   return mockView
 }
 
-internal fun Resources.mockForTarget(target: View, expectedResourceName: String) {
-  whenever(getResourceEntryName(target.id)).thenReturn(expectedResourceName)
+internal fun Resources.mockForTarget(target: View, expectedResourceName: String?) {
+  if (expectedResourceName == null) {
+    whenever(getResourceEntryName(target.id))
+      .thenThrow(Resources.NotFoundException("res not found"))
+  } else {
+    whenever(getResourceEntryName(target.id)).thenReturn(expectedResourceName)
+  }
 }

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

@@ -131,7 +131,12 @@ constructor(
       TransactionOptions().also {
         it.isWaitForChildren = true
         it.idleTimeout = scopes.options.idleTimeout
-        it.deadlineTimeout = TransactionOptions.DEFAULT_DEADLINE_TIMEOUT_AUTO_TRANSACTION
+
+        // Set deadline timeout based on configured option
+        val deadlineTimeoutMillis = scopes.options.deadlineTimeout
+        // No deadline when zero or negative value is set
+        it.deadlineTimeout = if (deadlineTimeoutMillis <= 0) null else deadlineTimeoutMillis
+
         it.isTrimEnd = true
       }