feat(instrumentation): Add binder IPC call tracing

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add Binder IPC call instrumentation ([#1159](https://github.com/getsentry/sentry-android-gradle-plugin/pull/1159))
+
 ## 6.9.0
 
 ### Fixes

plugin-build/src/main/kotlin/io/sentry/android/gradle/AndroidComponentsConfig.kt

@@ -196,6 +196,7 @@ fun ApplicationAndroidComponentsExtension.configure(
             extension.includeSourceContext,
             extension.dexguardEnabled,
             extension.tracingInstrumentation.appStart.enabled,
+            extension.tracingInstrumentation.binder.enabled,
           )
         /**
          * We have to register SentryModulesService as a build event listener, so it will not be
@@ -228,6 +229,7 @@ fun ApplicationAndroidComponentsExtension.configure(
           params.appStartEnabled.setDisallowChanges(
             extension.tracingInstrumentation.appStart.enabled
           )
+          params.binderEnabled.setDisallowChanges(extension.tracingInstrumentation.binder.enabled)
           params.tmpDir.set(
             project.layout.buildDirectory.dir("sentry-logs/instrumentation/${variant.name}")
           )

plugin-build/src/main/kotlin/io/sentry/android/gradle/extensions/BinderExtension.kt

@@ -0,0 +1,15 @@
+package io.sentry.android.gradle.extensions
+
+import javax.inject.Inject
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+
+open class BinderExtension @Inject constructor(objects: ObjectFactory) {
+  /**
+   * Enables or disables Binder IPC call instrumentation. Defaults to true. This requires
+   * sentry-android-core version TODO or above, and needs to be enabled. See
+   * https://docs.sentry.io/platforms/android/configuration/gradle/#tracing-auto-instrumentation for
+   * more details.
+   */
+  val enabled: Property<Boolean> = objects.property(Boolean::class.java).convention(true)
+}

plugin-build/src/main/kotlin/io/sentry/android/gradle/extensions/TracingInstrumentationExtension.kt

@@ -71,6 +71,12 @@ open class TracingInstrumentationExtension @Inject constructor(objects: ObjectFa
   fun appStart(appStartExtensionAction: Action<AppStartExtension>) {
     appStartExtensionAction.execute(appStart)
   }
+
+  val binder: BinderExtension = objects.newInstance(BinderExtension::class.java)
+
+  fun binder(binderAction: Action<BinderExtension>) {
+    binderAction.execute(binder)
+  }
 }
 
 enum class InstrumentationFeature(val integrationName: String) {

plugin-build/src/main/kotlin/io/sentry/android/gradle/instrumentation/SpanAddingClassVisitorFactory.kt

@@ -13,6 +13,7 @@ import io.sentry.android.gradle.instrumentation.androidx.sqlite.database.Android
 import io.sentry.android.gradle.instrumentation.androidx.sqlite.statement.AndroidXSQLiteStatement
 import io.sentry.android.gradle.instrumentation.appstart.Application
 import io.sentry.android.gradle.instrumentation.appstart.ContentProvider
+import io.sentry.android.gradle.instrumentation.binder.Binder
 import io.sentry.android.gradle.instrumentation.logcat.Logcat
 import io.sentry.android.gradle.instrumentation.logcat.LogcatLevel
 import io.sentry.android.gradle.instrumentation.okhttp.OkHttp
@@ -63,6 +64,8 @@ abstract class SpanAddingClassVisitorFactory :
     @get:Input val logcatEnabled: Property<Boolean>
 
     @get:Input val appStartEnabled: Property<Boolean>
+
+    @get:Input val binderEnabled: Property<Boolean>
   }
 
   private val instrumentable: ClassInstrumentable
@@ -106,6 +109,7 @@ abstract class SpanAddingClassVisitorFactory :
             RemappingInstrumentable().takeIf { sentryModulesService.isFileIOInstrEnabled() },
             ComposeNavigation().takeIf { sentryModulesService.isComposeInstrEnabled() },
             Logcat().takeIf { sentryModulesService.isLogcatInstrEnabled() },
+            Binder().takeIf { sentryModulesService.isBinderInstrEnabled() },
             Application().takeIf { sentryModulesService.isAppStartInstrEnabled() },
             ContentProvider().takeIf { sentryModulesService.isAppStartInstrEnabled() },
           )

plugin-build/src/main/kotlin/io/sentry/android/gradle/instrumentation/binder/Binder.kt

@@ -0,0 +1,32 @@
+package io.sentry.android.gradle.instrumentation.binder
+
+import com.android.build.api.instrumentation.ClassContext
+import io.sentry.android.gradle.instrumentation.ClassInstrumentable
+import io.sentry.android.gradle.instrumentation.CommonClassVisitor
+import io.sentry.android.gradle.instrumentation.SpanAddingClassVisitorFactory
+import io.sentry.android.gradle.instrumentation.util.isSentryClass
+import org.objectweb.asm.ClassVisitor
+
+class Binder : ClassInstrumentable {
+
+  companion object {
+    private const val CLASSNAME = "Binder"
+  }
+
+  override fun getVisitor(
+    instrumentableContext: ClassContext,
+    apiVersion: Int,
+    originalVisitor: ClassVisitor,
+    parameters: SpanAddingClassVisitorFactory.SpanAddingParameters,
+  ): ClassVisitor {
+    return CommonClassVisitor(
+      apiVersion,
+      originalVisitor,
+      CLASSNAME,
+      listOf(BinderMethodInstrumentable()),
+      parameters,
+    )
+  }
+
+  override fun isInstrumentable(data: ClassContext) = !data.isSentryClass()
+}