Fix unexpected pointer change (#129765)

Drop invalid scroll event for panZoom type

MotionEvent.isFromSource() is not mockable because it's from super class in InputEvent.
So we need to change if condition from "if (!isPointerEvent || !isMovementEvent)"
to "if (isPointerEvent || isMovementEvent)". Without this change, this test case will
end up with "wanted but not invoked" error.

Signed-off-by: Xiaohu Hu <[email protected]>

Author: LoveJello

shell/platform/android/io/flutter/embedding/android/AndroidTouchProcessor.java

@@ -192,23 +192,24 @@ public boolean onGenericMotionEvent(@NonNull MotionEvent event) {
     boolean isMovementEvent =
         (event.getActionMasked() == MotionEvent.ACTION_HOVER_MOVE
             || event.getActionMasked() == MotionEvent.ACTION_SCROLL);
-    if (!isPointerEvent || !isMovementEvent) {
-      return false;
-    }
 
-    int pointerChange = getPointerChangeForAction(event.getActionMasked());
-    ByteBuffer packet =
-        ByteBuffer.allocateDirect(
-            event.getPointerCount() * POINTER_DATA_FIELD_COUNT * BYTES_PER_FIELD);
-    packet.order(ByteOrder.LITTLE_ENDIAN);
-
-    // ACTION_HOVER_MOVE always applies to a single pointer only.
-    addPointerForIndex(event, event.getActionIndex(), pointerChange, 0, IDENTITY_TRANSFORM, packet);
-    if (packet.position() % (POINTER_DATA_FIELD_COUNT * BYTES_PER_FIELD) != 0) {
-      throw new AssertionError("Packet position is not on field boundary.");
+    if (isPointerEvent || isMovementEvent) {
+      int pointerChange = getPointerChangeForAction(event.getActionMasked());
+      ByteBuffer packet =
+          ByteBuffer.allocateDirect(
+              event.getPointerCount() * POINTER_DATA_FIELD_COUNT * BYTES_PER_FIELD);
+      packet.order(ByteOrder.LITTLE_ENDIAN);
+
+      // ACTION_HOVER_MOVE always applies to a single pointer only.
+      addPointerForIndex(
+          event, event.getActionIndex(), pointerChange, 0, IDENTITY_TRANSFORM, packet);
+      if (packet.position() % (POINTER_DATA_FIELD_COUNT * BYTES_PER_FIELD) != 0) {
+        throw new AssertionError("Packet position is not on field boundary.");
+      }
+      renderer.dispatchPointerDataPacket(packet, packet.position());
+      return true;
     }
-    renderer.dispatchPointerDataPacket(packet, packet.position());
-    return true;
+    return false;
   }
 
   // TODO(mattcarroll): consider creating a PointerPacket class instead of using a procedure that
@@ -224,12 +225,6 @@ private void addPointerForIndex(
       return;
     }
 
-    long motionEventId = 0;
-    if (trackMotionEvents) {
-      MotionEventTracker.MotionEventId trackedEvent = motionEventTracker.track(event);
-      motionEventId = trackedEvent.getId();
-    }
-
     int pointerKind = getPointerDeviceTypeForToolType(event.getToolType(pointerIndex));
     // We use this in lieu of using event.getRawX and event.getRawY as we wish to support
     // earlier versions than API level 29.
@@ -252,7 +247,20 @@ private void addPointerForIndex(
       buttons = 0;
     }
 
+    int panZoomType = -1;
     boolean isTrackpadPan = ongoingPans.containsKey(event.getPointerId(pointerIndex));
+    if (isTrackpadPan) {
+      panZoomType = getPointerChangeForPanZoom(pointerChange);
+      if (panZoomType == -1) {
+        return;
+      }
+    }
+
+    long motionEventId = 0;
+    if (trackMotionEvents) {
+      MotionEventTracker.MotionEventId trackedEvent = motionEventTracker.track(event);
+      motionEventId = trackedEvent.getId();
+    }
 
     int signalKind =
         event.getActionMasked() == MotionEvent.ACTION_SCROLL
@@ -264,7 +272,7 @@ private void addPointerForIndex(
     packet.putLong(motionEventId); // motionEventId
     packet.putLong(timeStamp); // time_stamp
     if (isTrackpadPan) {
-      packet.putLong(getPointerChangeForPanZoom(pointerChange)); // change
+      packet.putLong(panZoomType); // change
       packet.putLong(PointerDeviceKind.TRACKPAD); // kind
     } else {
       packet.putLong(pointerChange); // change
@@ -355,7 +363,7 @@ private void addPointerForIndex(
     packet.putDouble(1.0); // scale
     packet.putDouble(0.0); // rotation
 
-    if (isTrackpadPan && getPointerChangeForPanZoom(pointerChange) == PointerChange.PAN_ZOOM_END) {
+    if (isTrackpadPan && (panZoomType == PointerChange.PAN_ZOOM_END)) {
       ongoingPans.remove(event.getPointerId(pointerIndex));
     }
   }
@@ -401,7 +409,7 @@ private int getPointerChangeForPanZoom(int pointerChange) {
     } else if (pointerChange == PointerChange.UP || pointerChange == PointerChange.CANCEL) {
       return PointerChange.PAN_ZOOM_END;
     }
-    throw new AssertionError("Unexpected pointer change");
+    return -1;
   }
 
   @PointerDeviceKind

shell/platform/android/test/io/flutter/embedding/android/AndroidTouchProcessorTest.java

@@ -218,4 +218,59 @@ public void unexpectedMaskedAction() {
     touchProcessor.onTouchEvent(mocker.mockEvent(MotionEvent.ACTION_BUTTON_PRESS, 0.0f, 0.0f, 0));
     verify(mockRenderer, never()).dispatchPointerDataPacket(ByteBuffer.allocate(0), 0);
   }
+
+  @Test
+  public void unexpectedPointerChange() {
+    // Regression test for https://github.com/flutter/flutter/issues/129765
+
+    MotionEventMocker mocker =
+        new MotionEventMocker(0, InputDevice.SOURCE_MOUSE, MotionEvent.TOOL_TYPE_MOUSE);
+
+    touchProcessor.onTouchEvent(mocker.mockEvent(MotionEvent.ACTION_DOWN, 0.0f, 0.0f, 0));
+    InOrder inOrder = inOrder(mockRenderer);
+    inOrder
+        .verify(mockRenderer)
+        .dispatchPointerDataPacket(packetCaptor.capture(), packetSizeCaptor.capture());
+    ByteBuffer packet = packetCaptor.getValue();
+    assertEquals(AndroidTouchProcessor.PointerChange.PAN_ZOOM_START, readPointerChange(packet));
+    assertEquals(AndroidTouchProcessor.PointerDeviceKind.TRACKPAD, readPointerDeviceKind(packet));
+    assertEquals(AndroidTouchProcessor.PointerSignalKind.NONE, readPointerSignalKind(packet));
+    assertEquals(0.0, readPointerPhysicalX(packet));
+    assertEquals(0.0, readPointerPhysicalY(packet));
+
+    touchProcessor.onTouchEvent(mocker.mockEvent(MotionEvent.ACTION_MOVE, 10.0f, 5.0f, 0));
+    inOrder
+        .verify(mockRenderer)
+        .dispatchPointerDataPacket(packetCaptor.capture(), packetSizeCaptor.capture());
+    packet = packetCaptor.getValue();
+    assertEquals(AndroidTouchProcessor.PointerChange.PAN_ZOOM_UPDATE, readPointerChange(packet));
+    assertEquals(AndroidTouchProcessor.PointerDeviceKind.TRACKPAD, readPointerDeviceKind(packet));
+    assertEquals(AndroidTouchProcessor.PointerSignalKind.NONE, readPointerSignalKind(packet));
+    assertEquals(0.0, readPointerPhysicalX(packet));
+    assertEquals(0.0, readPointerPhysicalY(packet));
+    assertEquals(10.0, readPointerPanX(packet));
+    assertEquals(5.0, readPointerPanY(packet));
+
+    touchProcessor.onGenericMotionEvent(mocker.mockEvent(MotionEvent.ACTION_SCROLL, 0.0f, 0.0f, 0));
+    inOrder
+        .verify(mockRenderer)
+        .dispatchPointerDataPacket(packetCaptor.capture(), packetSizeCaptor.capture());
+    packet = packetCaptor.getValue();
+    packet.rewind();
+    while (packet.hasRemaining()) {
+      assertEquals(0, packet.get());
+    }
+
+    touchProcessor.onTouchEvent(mocker.mockEvent(MotionEvent.ACTION_UP, 10.0f, 5.0f, 0));
+    inOrder
+        .verify(mockRenderer)
+        .dispatchPointerDataPacket(packetCaptor.capture(), packetSizeCaptor.capture());
+    packet = packetCaptor.getValue();
+    assertEquals(AndroidTouchProcessor.PointerChange.PAN_ZOOM_END, readPointerChange(packet));
+    assertEquals(AndroidTouchProcessor.PointerDeviceKind.TRACKPAD, readPointerDeviceKind(packet));
+    assertEquals(AndroidTouchProcessor.PointerSignalKind.NONE, readPointerSignalKind(packet));
+    assertEquals(0.0, readPointerPhysicalX(packet));
+    assertEquals(0.0, readPointerPhysicalY(packet));
+    inOrder.verifyNoMoreInteractions();
+  }
 }