Feat/androidx navigation tracing

.craft.yml

@@ -41,3 +41,5 @@ targets:
       maven:io.sentry:sentry-apollo:
       maven:io.sentry:sentry-jdbc:
       maven:io.sentry:sentry-graphql:
+      maven:io.sentry:sentry-android-navigation:
+      maven:io.sentry:sentry-compose:

build.gradle.kts

@@ -1,6 +1,7 @@
 import com.diffplug.spotless.LineEnding
 import com.vanniktech.maven.publish.MavenPublishPlugin
 import com.vanniktech.maven.publish.MavenPublishPluginExtension
+import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.gradle.api.tasks.testing.logging.TestLogEvent
 
@@ -89,6 +90,14 @@ allprojects {
 }
 
 subprojects {
+    plugins.withId(Config.QualityPlugins.detektPlugin) {
+        configure<DetektExtension> {
+            buildUponDefaultConfig = true
+            allRules = true
+            config.setFrom("${rootProject.rootDir}/detekt.yml")
+        }
+    }
+
     if (!this.name.contains("sample") && !this.name.contains("integration-tests") && this.name != "sentry-test-support") {
         apply<DistributionPlugin>()
 

detekt.yml

@@ -0,0 +1,3 @@
+style:
+  ReturnCount:
+    max: 3

sentry-android-fragment/build.gradle.kts

@@ -1,5 +1,4 @@
 import io.gitlab.arturbosch.detekt.Detekt
-import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 
 plugins {
     id("com.android.library")
@@ -79,8 +78,3 @@ tasks.withType<Detekt> {
     // Target version of the generated JVM bytecode. It is used for type resolution.
     jvmTarget = JavaVersion.VERSION_1_8.toString()
 }
-
-configure<DetektExtension> {
-    buildUponDefaultConfig = true
-    allRules = true
-}

sentry-android-integration-tests/sentry-uitest-android-benchmark/build.gradle.kts

@@ -1,5 +1,4 @@
 import io.gitlab.arturbosch.detekt.Detekt
-import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import net.ltgt.gradle.errorprone.errorprone
 
 plugins {
@@ -122,11 +121,6 @@ tasks.withType<Detekt> {
     jvmTarget = JavaVersion.VERSION_1_8.toString()
 }
 
-configure<DetektExtension> {
-    buildUponDefaultConfig = true
-    allRules = true
-}
-
 kotlin {
     explicitApi()
 }

sentry-android-integration-tests/sentry-uitest-android/build.gradle.kts

@@ -1,5 +1,4 @@
 import io.gitlab.arturbosch.detekt.Detekt
-import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import net.ltgt.gradle.errorprone.errorprone
 
 plugins {
@@ -120,11 +119,6 @@ tasks.withType<Detekt> {
     jvmTarget = JavaVersion.VERSION_1_8.toString()
 }
 
-configure<DetektExtension> {
-    buildUponDefaultConfig = true
-    allRules = true
-}
-
 kotlin {
     explicitApi()
 }

sentry-android-navigation/api/sentry-android-navigation.api

@@ -7,9 +7,16 @@ public final class io/sentry/android/navigation/BuildConfig {
 }
 
 public final class io/sentry/android/navigation/SentryNavigationListener : androidx/navigation/NavController$OnDestinationChangedListener {
+	public static final field Companion Lio/sentry/android/navigation/SentryNavigationListener$Companion;
+	public static final field NAVIGATION_OP Ljava/lang/String;
 	public fun <init> ()V
 	public fun <init> (Lio/sentry/IHub;)V
-	public synthetic fun <init> (Lio/sentry/IHub;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/sentry/IHub;Z)V
+	public fun <init> (Lio/sentry/IHub;ZZ)V
+	public synthetic fun <init> (Lio/sentry/IHub;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun onDestinationChanged (Landroidx/navigation/NavController;Landroidx/navigation/NavDestination;Landroid/os/Bundle;)V
 }
 
+public final class io/sentry/android/navigation/SentryNavigationListener$Companion {
+}
+

sentry-android-navigation/build.gradle.kts

@@ -1,5 +1,4 @@
 import io.gitlab.arturbosch.detekt.Detekt
-import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 
 plugins {
     id("com.android.library")
@@ -88,8 +87,3 @@ tasks.withType<Detekt> {
     // Target version of the generated JVM bytecode. It is used for type resolution.
     jvmTarget = JavaVersion.VERSION_1_8.toString()
 }
-
-configure<DetektExtension> {
-    buildUponDefaultConfig = true
-    allRules = true
-}

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

@@ -1,64 +1,151 @@
 package io.sentry.android.navigation
 
+import android.content.res.Resources.NotFoundException
 import android.os.Bundle
 import androidx.navigation.NavController
 import androidx.navigation.NavDestination
 import io.sentry.Breadcrumb
 import io.sentry.Hint
 import io.sentry.HubAdapter
 import io.sentry.IHub
+import io.sentry.ITransaction
+import io.sentry.SentryLevel.DEBUG
 import io.sentry.SentryLevel.INFO
+import io.sentry.SpanStatus
 import io.sentry.TypeCheckHint
 import java.lang.ref.WeakReference
 
 class SentryNavigationListener @JvmOverloads constructor(
-    private val hub: IHub = HubAdapter.getInstance()
+    private val hub: IHub = HubAdapter.getInstance(),
+    private val enableNavigationBreadcrumbs: Boolean = true,
+    private val enableNavigationTracing: Boolean = true
 ) : NavController.OnDestinationChangedListener {
 
     private var previousDestinationRef: WeakReference<NavDestination>? = null
     private var previousArgs: Bundle? = null
 
+    private val isPerformanceEnabled get() = hub.options.isTracingEnabled && enableNavigationTracing
+
+    private var activeTransaction: ITransaction? = null
+
     override fun onDestinationChanged(
         controller: NavController,
         destination: NavDestination,
         arguments: Bundle?
     ) {
-        addBreadcrumb(destination, arguments)
+        val toArguments = arguments.refined()
+
+        addBreadcrumb(destination, toArguments)
+        startTracing(controller, destination, toArguments)
         previousDestinationRef = WeakReference(destination)
         previousArgs = arguments
     }
 
-    private fun addBreadcrumb(destination: NavDestination, arguments: Bundle?) {
+    private fun addBreadcrumb(destination: NavDestination, arguments: Map<String, Any?>) {
+        if (!enableNavigationBreadcrumbs) {
+            return
+        }
         val breadcrumb = Breadcrumb().apply {
-            type = "navigation"
-            category = "navigation"
+            type = NAVIGATION_OP
+            category = NAVIGATION_OP
 
             val from = previousDestinationRef?.get()?.route
-            from?.let { data["from"] = it }
-            previousArgs?.let { args ->
-                val fromArguments = args.keySet().filter {
-                    it != NavController.KEY_DEEP_LINK_INTENT // there's a lot of unrelated stuff
-                }.associateWith { args[it] }
-                if (fromArguments.isNotEmpty()) {
-                    data["from_arguments"] = fromArguments
-                }
+            from?.let { data["from"] = "/$it" }
+            val fromArguments = previousArgs.refined()
+            if (fromArguments.isNotEmpty()) {
+                data["from_arguments"] = fromArguments
             }
 
             val to = destination.route
-            to?.let { data["to"] = it }
-            arguments?.let { args ->
-                val toArguments = args.keySet().filter {
-                    it != NavController.KEY_DEEP_LINK_INTENT // there's a lot of unrelated stuff
-                }.associateWith { args[it] }
-                if (toArguments.isNotEmpty()) {
-                    data["to_arguments"] = toArguments
-                }
+            to?.let { data["to"] = "/$it" }
+            if (arguments.isNotEmpty()) {
+                data["to_arguments"] = arguments
             }
 
             level = INFO
         }
         val hint = Hint()
         hint.set(TypeCheckHint.ANDROID_NAV_DESTINATION, destination)
-        hub.addBreadcrumb(breadcrumb)
+        hub.addBreadcrumb(breadcrumb, hint)
+    }
+
+    private fun startTracing(
+        controller: NavController,
+        destination: NavDestination,
+        arguments: Map<String, Any?>
+    ) {
+        if (!isPerformanceEnabled) {
+            return
+        }
+
+        // we can only have one nav transaction at a time
+        if (activeTransaction != null) {
+            stopTracing()
+        }
+
+        if (destination.navigatorName == "activity") {
+            // we do not trace navigation between activities to avoid clashing with activity lifecycle tracing
+            hub.options.logger.log(
+                DEBUG,
+                "Navigating to activity destination, no transaction captured."
+            )
+            return
+        }
+
+        @Suppress("SwallowedException") // we swallow it on purpose
+        var name = destination.route ?: try {
+            controller.context.resources.getResourceEntryName(destination.id)
+        } catch (e: NotFoundException) {
+            hub.options.logger.log(
+                DEBUG,
+                "Destination id cannot be retrieved from Resources, no transaction captured."
+            )
+            return
+        }
+
+        // we add '/' to the name to match dart and web pattern
+        name = "/" + name.substringBefore('/') // strip out arguments from the tx name
+
+        val transaction =
+            hub.startTransaction(name, NAVIGATION_OP, true, hub.options.idleTimeout, true)
+
+        if (arguments.isNotEmpty()) {
+            transaction.setData("arguments", arguments)
+        }
+        hub.configureScope { scope ->
+            scope.withTransaction { tx ->
+                if (tx == null) {
+                    scope.transaction = transaction
+                }
+            }
+        }
+        activeTransaction = transaction
+    }
+
+    private fun stopTracing() {
+        val status = activeTransaction?.status ?: SpanStatus.OK
+        activeTransaction?.finish(status)
+
+        // clear transaction from scope so others can bind to it
+        hub.configureScope { scope ->
+            scope.withTransaction { tx ->
+                if (tx == activeTransaction) {
+                    scope.clearTransaction()
+                }
+            }
+        }
+
+        activeTransaction = null
+    }
+
+    private fun Bundle?.refined(): Map<String, Any?> =
+        this?.let { args ->
+            args.keySet().filter {
+                it != NavController.KEY_DEEP_LINK_INTENT // there's a lot of unrelated stuff
+            }.associateWith { args[it] }
+        } ?: emptyMap()
+
+    companion object {
+        const val NAVIGATION_OP = "navigation"
     }
 }