Check for compose classes via reflection instead of try-catch

Author: romtsn

buildSrc/src/main/java/Config.kt

@@ -131,6 +131,7 @@ object Config {
         val composeNavigation = "androidx.navigation:navigation-compose:$navigationVersion"
         val composeActivity = "androidx.activity:activity-compose:1.4.0"
         val composeFoundation = "androidx.compose.foundation:foundation:$composeVersion"
+        val composeUi = "androidx.compose.ui:ui:$composeVersion"
         val composeFoundationLayout = "androidx.compose.foundation:foundation-layout:$composeVersion"
         val composeMaterial = "androidx.compose.material3:material3:1.0.0-alpha13"
 

sentry-android-core/build.gradle.kts

@@ -108,6 +108,8 @@ dependencies {
     testImplementation(projects.sentryTestSupport)
     testImplementation(projects.sentryAndroidFragment)
     testImplementation(projects.sentryAndroidTimber)
+    testImplementation(projects.sentryComposeHelper)
+    testImplementation(projects.sentryAndroidNdk)
     testRuntimeOnly(Config.Libs.timber)
     testRuntimeOnly(Config.Libs.fragment)
 }

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

@@ -41,6 +41,11 @@
 @SuppressWarnings("Convert2MethodRef") // older AGP versions do not support method references
 final class AndroidOptionsInitializer {
 
+  static final String SENTRY_COMPOSE_INTEGRATION_CLASS_NAME =
+    "io.sentry.compose.gestures.ComposeGestureTargetLocator";
+
+  static final String COMPOSE_CLASS_NAME = "androidx.compose.ui.node.Owner";
+
   /** private ctor */
   private AndroidOptionsInitializer() {}
 
@@ -143,15 +148,15 @@ static void initializeIntegrationsAndProcessors(
     if (options.getGestureTargetLocators().isEmpty()) {
       final List<GestureTargetLocator> gestureTargetLocators = new ArrayList<>(2);
       gestureTargetLocators.add(new AndroidViewGestureTargetLocator(isAndroidXScrollViewAvailable));
-      try {
+
+      final boolean isComposeUpstreamAvailable =
+        loadClass.isClassAvailable(COMPOSE_CLASS_NAME, options);
+      final boolean isComposeAvailable =
+        (isComposeUpstreamAvailable
+          && loadClass.isClassAvailable(SENTRY_COMPOSE_INTEGRATION_CLASS_NAME, options));
+
+      if (isComposeAvailable) {
         gestureTargetLocators.add(new ComposeGestureTargetLocator());
-      } catch (NoClassDefFoundError error) {
-        options
-            .getLogger()
-            .log(
-                SentryLevel.DEBUG,
-                "ComposeGestureTargetLocator not available, consider adding the `sentry-compose` library.",
-                error);
       }
       options.setGestureTargetLocators(gestureTargetLocators);
     }

sentry-android-core/src/test/AndroidManifest.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:tools="http://schemas.android.com/tools" xmlns:android="http://schemas.android.com/apk/res/android">
+
+  <uses-sdk
+    tools:overrideLibrary="
+    io.sentry.compose,
+    io.sentry.android.ndk,
+    androidx.navigation.compose,
+    androidx.activity.compose,
+    androidx.compose.animation,
+    androidx.lifecycle.viewmodel.compose,
+    androidx.compose.foundation.layout,
+    androidx.compose.animation.core,
+    androidx.compose.ui,
+    androidx.compose.ui.text,
+    androidx.compose.runtime.saveable,
+    androidx.compose.ui.graphics,
+    androidx.compose.ui.unit,
+    androidx.compose.ui.geometry,
+    androidx.compose.ui.util"/>
+</manifest>

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

@@ -8,12 +8,15 @@ import io.sentry.ILogger
 import io.sentry.MainEventProcessor
 import io.sentry.SentryOptions
 import io.sentry.android.core.cache.AndroidEnvelopeCache
+import io.sentry.android.core.internal.gestures.AndroidViewGestureTargetLocator
 import io.sentry.android.core.internal.modules.AssetsModulesLoader
 import io.sentry.android.core.internal.util.AndroidMainThreadChecker
 import io.sentry.android.fragment.FragmentLifecycleIntegration
 import io.sentry.android.timber.SentryTimberIntegration
+import io.sentry.compose.gestures.ComposeGestureTargetLocator
 import org.junit.runner.RunWith
 import org.mockito.kotlin.any
+import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.whenever
 import java.io.File
@@ -66,7 +69,7 @@ class AndroidOptionsInitializerTest {
 
         fun initSutWithClassLoader(
             minApi: Int = 16,
-            classToLoad: Class<*>? = null,
+            classesToLoad: List<String> = emptyList(),
             isFragmentAvailable: Boolean = false,
             isTimberAvailable: Boolean = false
         ) {
@@ -89,7 +92,7 @@ class AndroidOptionsInitializerTest {
                 sentryOptions,
                 context,
                 buildInfo,
-                createClassMock(classToLoad),
+                createClassMock(classesToLoad),
                 isFragmentAvailable,
                 isTimberAvailable
             )
@@ -101,10 +104,14 @@ class AndroidOptionsInitializerTest {
             return buildInfo
         }
 
-        private fun createClassMock(clazz: Class<*>?): LoadClass {
+        private fun createClassMock(classes: List<String>): LoadClass {
             val loadClassMock = mock<LoadClass>()
-            whenever(loadClassMock.loadClass(any(), any())).thenReturn(clazz)
-            whenever(loadClassMock.isClassAvailable(any(), any<ILogger>())).thenReturn(clazz != null)
+            classes.forEach {
+                whenever(loadClassMock.loadClass(eq(it), any()))
+                    .thenReturn(Class.forName(it, false, this::class.java.classLoader))
+                whenever(loadClassMock.isClassAvailable(eq(it), any<SentryOptions>()))
+                    .thenReturn(true)
+            }
             return loadClassMock
         }
     }
@@ -267,23 +274,23 @@ class AndroidOptionsInitializerTest {
 
     @Test
     fun `NdkIntegration will load SentryNdk class and add to the integration list`() {
-        fixture.initSutWithClassLoader(classToLoad = SentryNdk::class.java)
+        fixture.initSutWithClassLoader(classesToLoad = listOfNotNull(NdkIntegration.SENTRY_NDK_CLASS_NAME))
 
         val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
         assertNotNull((actual as NdkIntegration).sentryNdkClass)
     }
 
     @Test
     fun `NdkIntegration won't be enabled because API is lower than 16`() {
-        fixture.initSutWithClassLoader(minApi = 14, classToLoad = SentryNdk::class.java)
+        fixture.initSutWithClassLoader(minApi = 14, classesToLoad = listOfNotNull(NdkIntegration.SENTRY_NDK_CLASS_NAME))
 
         val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
         assertNull((actual as NdkIntegration).sentryNdkClass)
     }
 
     @Test
     fun `NdkIntegration won't be enabled, if class not found`() {
-        fixture.initSutWithClassLoader(classToLoad = null)
+        fixture.initSutWithClassLoader(classesToLoad = emptyList())
 
         val actual = fixture.sentryOptions.integrations.firstOrNull { it is NdkIntegration }
         assertNull((actual as NdkIntegration).sentryNdkClass)
@@ -455,4 +462,26 @@ class AndroidOptionsInitializerTest {
 
         assertTrue { fixture.sentryOptions.mainThreadChecker is AndroidMainThreadChecker }
     }
+
+    @Test
+    fun `does not install ComposeGestureTargetLocator, if sentry-compose is not available`() {
+        fixture.initSutWithClassLoader()
+
+        assertTrue { fixture.sentryOptions.gestureTargetLocators.size == 1 }
+        assertTrue { fixture.sentryOptions.gestureTargetLocators[0] is AndroidViewGestureTargetLocator }
+    }
+
+    @Test
+    fun `installs ComposeGestureTargetLocator, if sentry-compose is available`() {
+        fixture.initSutWithClassLoader(
+            classesToLoad = listOf(
+                AndroidOptionsInitializer.COMPOSE_CLASS_NAME,
+                AndroidOptionsInitializer.SENTRY_COMPOSE_INTEGRATION_CLASS_NAME
+            )
+        )
+
+        assertTrue { fixture.sentryOptions.gestureTargetLocators.size == 2 }
+        assertTrue { fixture.sentryOptions.gestureTargetLocators[0] is AndroidViewGestureTargetLocator }
+        assertTrue { fixture.sentryOptions.gestureTargetLocators[1] is ComposeGestureTargetLocator }
+    }
 }

sentry-compose/proguard-rules.pro

@@ -1,5 +1,9 @@
 ##---------------Begin: proguard configuration for Compose  ----------
 
+# The Android SDK checks at runtime if these classes are available via Class.forName
+-keep class io.sentry.compose.gestures.ComposeGestureTargetLocator { <init>(...); }
+-keepnames interface androidx.compose.ui.node.Owner
+
 # To ensure that stack traces is unambiguous
 # https://developer.android.com/studio/build/shrink-code#decode-stack-trace
 -keepattributes LineNumberTable,SourceFile