Merge pull request #2651 from DataDog/yl/actions-tracking/fix-log-spam

Add Jetpack Compose specific log in gesture listener if target not found

Author: ambushwork

features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/internal/instrumentation/gestures/GesturesListener.kt

@@ -137,11 +137,12 @@ internal class GesturesListener(
         val queue = LinkedList<View>()
         queue.addFirst(decorView)
         var target: ViewTarget? = null
-
+        var composeViewDetected = false
         while (queue.isNotEmpty()) {
             // removeFirst can't fail because we checked isNotEmpty
             @Suppress("UnsafeThirdPartyFunctionCall")
             val view = queue.removeFirst()
+            composeViewDetected = composeViewDetected || isJetpackComposeView(view)
             val newTarget = if (isScroll) {
                 findTargetForScroll(view, x, y)
             } else {
@@ -159,10 +160,15 @@ internal class GesturesListener(
         }
 
         if (target == null) {
+            val msg = if (composeViewDetected) {
+                MSG_NO_COMPOSE_TARGET
+            } else {
+                MSG_NO_TARGET_ACTION
+            }
             internalLogger.log(
                 InternalLogger.Level.INFO,
                 InternalLogger.Target.USER,
-                { MSG_NO_TARGET_TAP }
+                { msg }
             )
         }
         return target
@@ -311,6 +317,13 @@ internal class GesturesListener(
         }
     }
 
+    private fun isJetpackComposeView(view: View): Boolean {
+        // startsWith here is to make testing easier: mocks don't have name exactly
+        // like this, and writing manual stub is not possible, because some necessary
+        // methods are final.
+        return view::class.java.name.startsWith("androidx.compose.ui.platform.ComposeView")
+    }
+
     // endregion
 
     companion object {
@@ -320,12 +333,11 @@ internal class GesturesListener(
         internal const val SCROLL_DIRECTION_UP = "up"
         internal const val SCROLL_DIRECTION_DOWN = "down"
 
-        internal val MSG_NO_TARGET_TAP = "We could not find a valid target for " +
-            "the ${RumActionType.TAP.name} event. " +
-            "The DecorView was empty and either transparent " +
-            "or not clickable for this Activity."
-        internal val MSG_NO_TARGET_SCROLL_SWIPE = "We could not find a valid target for " +
-            "the ${RumActionType.SCROLL.name} or ${RumActionType.SWIPE.name} event. " +
+        internal const val MSG_NO_COMPOSE_TARGET =
+            "We could not find a valid target for the gesture " +
+                "event. Compose actions tracking not enabled, or the compose view is not tagged."
+        internal const val MSG_NO_TARGET_ACTION = "We could not find a valid target for " +
+            "the gesture event. " +
             "The DecorView was empty and either transparent " +
             "or not clickable for this Activity."
     }

features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/instrumentation/gestures/GesturesListenerScrollSwipeTest.kt

@@ -466,8 +466,7 @@ internal class GesturesListenerScrollSwipeTest : AbstractGesturesListenerTest()
             InternalLogger.Level.INFO,
             InternalLogger.Target.USER,
             {
-                it == GesturesListener.MSG_NO_TARGET_SCROLL_SWIPE ||
-                    it == GesturesListener.MSG_NO_TARGET_TAP
+                it == GesturesListener.MSG_NO_TARGET_ACTION
             },
             mode = times(intermediaryEvents.size + 2)
         )

features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/internal/instrumentation/gestures/GesturesListenerTapTest.kt

@@ -333,7 +333,7 @@ internal class GesturesListenerTapTest : AbstractGesturesListenerTest() {
         mockInternalLogger.verifyLog(
             InternalLogger.Level.INFO,
             InternalLogger.Target.USER,
-            GesturesListener.MSG_NO_TARGET_TAP
+            GesturesListener.MSG_NO_TARGET_ACTION
         )
         verifyNoInteractions(rumMonitor.mockInstance)
     }