Do not traverse children if a touch event is not within view groups bounds

Author: romtsn

sentry-android-core/src/main/java/io/sentry/android/core/internal/gestures/AndroidViewGestureTargetLocator.java

@@ -18,7 +18,6 @@ public final class AndroidViewGestureTargetLocator implements GestureTargetLocat
   private static final String ORIGIN = "old_view_system";
 
   private final boolean isAndroidXAvailable;
-  private final int[] coordinates = new int[2];
 
   public AndroidViewGestureTargetLocator(final boolean isAndroidXAvailable) {
     this.isAndroidXAvailable = isAndroidXAvailable;
@@ -31,13 +30,11 @@ public AndroidViewGestureTargetLocator(final boolean isAndroidXAvailable) {
       return null;
     }
     final View view = (View) root;
-    if (touchWithinBounds(view, x, y)) {
-      if (targetType == UiElement.Type.CLICKABLE && isViewTappable(view)) {
-        return createUiElement(view);
-      } else if (targetType == UiElement.Type.SCROLLABLE
-          && isViewScrollable(view, isAndroidXAvailable)) {
-        return createUiElement(view);
-      }
+    if (targetType == UiElement.Type.CLICKABLE && isViewTappable(view)) {
+      return createUiElement(view);
+    } else if (targetType == UiElement.Type.SCROLLABLE
+        && isViewScrollable(view, isAndroidXAvailable)) {
+      return createUiElement(view);
     }
     return null;
   }
@@ -52,17 +49,6 @@ private UiElement createUiElement(final @NotNull View targetView) {
     }
   }
 
-  private boolean touchWithinBounds(final @NotNull View view, final float x, final float y) {
-    view.getLocationOnScreen(coordinates);
-    int vx = coordinates[0];
-    int vy = coordinates[1];
-
-    int w = view.getWidth();
-    int h = view.getHeight();
-
-    return !(x < vx || x > vx + w || y < vy || y > vy + h);
-  }
-
   private static boolean isViewTappable(final @NotNull View view) {
     return view.isClickable() && view.getVisibility() == View.VISIBLE;
   }

sentry-android-core/src/main/java/io/sentry/android/core/internal/gestures/ViewUtils.java

@@ -16,6 +16,32 @@
 @ApiStatus.Internal
 public final class ViewUtils {
 
+  private static final int[] coordinates = new int[2];
+
+  /**
+   * Verifies if the given touch coordinates are within the bounds of the given view.
+   *
+   * @param view the view to check if the touch coordinates are within its bounds
+   * @param x - the x coordinate of a {@link MotionEvent}
+   * @param y - the y coordinate of {@link MotionEvent}
+   * @return true if the touch coordinates are within the bounds of the view, false otherwise
+   */
+  private static boolean touchWithinBounds(
+      final @Nullable View view, final float x, final float y) {
+    if (view == null) {
+      return false;
+    }
+
+    view.getLocationOnScreen(coordinates);
+    int vx = coordinates[0];
+    int vy = coordinates[1];
+
+    int w = view.getWidth();
+    int h = view.getHeight();
+
+    return !(x < vx || x > vx + w || y < vy || y > vy + h);
+  }
+
   /**
    * Finds a target view, that has been selected/clicked by the given coordinates x and y and the
    * given {@code viewTargetSelector}.
@@ -41,6 +67,11 @@ public final class ViewUtils {
     while (queue.size() > 0) {
       final View view = queue.poll();
 
+      if (!touchWithinBounds(view, x, y)) {
+        // if the touch is not hitting the view, skip traversal of its children
+        continue;
+      }
+
       if (view instanceof ViewGroup) {
         final ViewGroup viewGroup = (ViewGroup) view;
         for (int i = 0; i < viewGroup.getChildCount(); i++) {
@@ -53,7 +84,7 @@ public final class ViewUtils {
         if (newTarget != null) {
           if (targetType == UiElement.Type.CLICKABLE) {
             target = newTarget;
-          } else {
+          } else if (targetType == UiElement.Type.SCROLLABLE) {
             return newTarget;
           }
         }

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

@@ -140,7 +140,7 @@ class UserInteractionIntegrationTest {
             )
         )
 
-        sut.register(fixture.hub, fixture.options)
+        sut.register(fixture.scopes, fixture.options)
         sut.onActivityPaused(fixture.activity)
 
         verify(fixture.window).callback = null
@@ -161,7 +161,7 @@ class UserInteractionIntegrationTest {
             )
         )
 
-        sut.register(fixture.hub, fixture.options)
+        sut.register(fixture.scopes, fixture.options)
         sut.onActivityPaused(fixture.activity)
 
         verify(fixture.window).callback = delegate
@@ -172,7 +172,7 @@ class UserInteractionIntegrationTest {
         val callback = mock<SentryWindowCallback>()
         val sut = fixture.getSut(callback)
 
-        sut.register(fixture.hub, fixture.options)
+        sut.register(fixture.scopes, fixture.options)
         sut.onActivityPaused(fixture.activity)
 
         verify(callback).stopTracking()
@@ -192,7 +192,7 @@ class UserInteractionIntegrationTest {
         )
         val sut = fixture.getSut(existingCallback)
 
-        sut.register(fixture.hub, fixture.options)
+        sut.register(fixture.scopes, fixture.options)
         sut.onActivityResumed(fixture.activity)
 
         val argumentCaptor = argumentCaptor<Window.Callback>()

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

@@ -223,7 +223,7 @@ class SentryGestureListenerClickTest {
 
         val event = mock<MotionEvent>()
         val sut = fixture.getSut<LocalView>(event, attachViewsToRoot = false)
-        fixture.window.mockDecorView<ViewGroup>(event = event, touchWithinBounds = false) {
+        fixture.window.mockDecorView<ViewGroup>(event = event, touchWithinBounds = true) {
             whenever(it.childCount).thenReturn(1)
             whenever(it.getChildAt(0)).thenReturn(fixture.target)
         }
@@ -244,7 +244,7 @@ class SentryGestureListenerClickTest {
 
         val event = mock<MotionEvent>()
         val sut = fixture.getSut<LocalView>(event, attachViewsToRoot = false)
-        fixture.window.mockDecorView<ViewGroup>(event = event, touchWithinBounds = false) {
+        fixture.window.mockDecorView<ViewGroup>(event = event, touchWithinBounds = true) {
             whenever(it.childCount).thenReturn(1)
             whenever(it.getChildAt(0)).thenReturn(fixture.target)
         }
@@ -253,4 +253,18 @@ class SentryGestureListenerClickTest {
 
         verify(fixture.scope).propagationContext = any()
     }
+
+    @Test
+    fun `if touch is not within view group bounds does not traverse its children`() {
+        val event = mock<MotionEvent>()
+        val sut = fixture.getSut<View>(event, attachViewsToRoot = true)
+        fixture.window.mockDecorView<ViewGroup>(event = event, touchWithinBounds = false) {
+            whenever(it.childCount).thenReturn(1)
+            whenever(it.getChildAt(0)).thenReturn(fixture.target)
+        }
+
+        sut.onSingleTapUp(event)
+
+        verify(fixture.scopes, never()).addBreadcrumb(any<Breadcrumb>())
+    }
 }