feat(android): add device.tap() and device.longPress().

detox/android/detox/src/full/java/com/wix/detox/espresso/EspressoDetox.java

@@ -121,5 +121,52 @@ public void run() {
             }
         });
     }
+
+    public static void tap(Integer x, Integer y) {
+        onView(isRoot()).perform(new ViewAction() {
+            @Override
+            public Matcher<View> getConstraints() {
+                return isRoot();
+            }
+
+            @Override
+            public String getDescription() {
+                return "tap on screen";
+            }
+
+            @Override
+            public void perform(UiController uiController, View view) {
+                int adjustedY = true ? y + UiAutomatorHelper.getStatusBarHeight(view) : y;
+                ViewAction action = DetoxAction.tapAtLocation(x, adjustedY);
+                action.perform(uiController, view);
+                uiController.loopMainThreadUntilIdle();
+            }
+        });
+    }
+
+    public static void longPress(Integer x, Integer y) {
+        longPress(x, y, null);
+    }
+
+    public static void longPress(Integer x, Integer y, Integer duration) {
+        onView(isRoot()).perform(new ViewAction() {
+            @Override
+            public Matcher<View> getConstraints() {
+                return isRoot();
+            }
+
+            @Override
+            public String getDescription() {
+                return "long press on screen";
+            }
+
+            @Override
+            public void perform(UiController uiController, View view) {
+                ViewAction action = DetoxAction.longPress(x, y, duration);
+                action.perform(uiController, view);
+                uiController.loopMainThreadUntilIdle();
+            }
+        });
+    }
 }
 

detox/android/detox/src/full/java/com/wix/detox/espresso/UiAutomatorHelper.java

@@ -1,8 +1,13 @@
 package com.wix.detox.espresso;
 
+import android.annotation.SuppressLint;
+import android.content.Context;
 import android.os.Handler;
+import android.util.DisplayMetrics;
 import android.util.Log;
+import android.util.TypedValue;
 import android.view.Choreographer;
+import android.view.View;
 
 import com.wix.detox.common.UIThread;
 import com.wix.detox.espresso.action.common.utils.UiControllerUtils;
@@ -111,4 +116,11 @@ public void doFrame(long frameTimeNanos) {
         }
     }
 
+    @SuppressLint({"DiscouragedApi", "InternalInsetResource"})
+    public static int getStatusBarHeight(View view) {
+        Context context = view.getContext();
+        int resourceId = context.getResources().getIdentifier("status_bar_height", "dimen", "android");
+        return (int) (context.getResources().getDimensionPixelSize(resourceId) / ((float) context.getResources().getDisplayMetrics().densityDpi / DisplayMetrics.DENSITY_DEFAULT));
+        //return resourceId > 0 ? context.getResources().getDimensionPixelSize(resourceId) : 0;
+    }
 }

detox/detox.d.ts

@@ -781,6 +781,31 @@ declare global {
              */
             setOrientation(orientation: Orientation): Promise<void>;
 
+            /**
+             * Perform a tap at arbitrary coordinates on the default display specified by the user. Currently only available in the Android Simulator.
+             * @param point coordinates in the element's coordinate space. Optional (default is the center of the element). defaults: x: 100, y: 100
+             * @example await device.tap();
+             * @example await device.tap({ x: 100, y: 150 });
+             */
+            tap(): Promise<void>;
+            tap(point: Point2D): Promise<void>;
+
+            /**
+             * Perform a long press at arbitrary coordinates on the default display specified by the user. Custom press duration if needed. Currently only available in the Android Simulator.
+             * @param point coordinates in the element's coordinate space. Optional (default is the center of the element). defaults: x: 100, y: 100
+             * @param duration custom press duration time, in milliseconds. Optional (defaults to the standard long-press duration for the platform).
+             *      Custom durations should be used cautiously, as they can affect test consistency and user experience expectations.
+             *      They are typically necessary when testing components that behave differently from the platform's defaults or when simulating unique user interactions.
+             * @example await device.longPress();
+             * @example await device.longPress({ x: 100, y: 150 });
+             * @example await device.longPress(2000);
+             * @example await device.longPress({ x: 100, y: 150 }, 2000);
+             */
+            longPress(): Promise<void>;
+            longPress(point: Point2D): Promise<void>;
+            longPress(duration: number): Promise<void>;
+            longPress(point: Point2D, duration: number): Promise<void>;
+
             /**
              * Sets the simulator/emulator location to the given latitude and longitude.
              *

detox/src/android/espressoapi/EspressoDetox.js

@@ -73,6 +73,77 @@ class EspressoDetox {
     };
   }
 
+  static tap(x, y) {
+    if (typeof x !== "number") throw new Error("x should be a number, but got " + (x + (" (" + (typeof x + ")"))));
+    if (typeof y !== "number") throw new Error("y should be a number, but got " + (y + (" (" + (typeof y + ")"))));
+    return {
+      target: {
+        type: "Class",
+        value: "com.wix.detox.espresso.EspressoDetox"
+      },
+      method: "tap",
+      args: [{
+        type: "Integer",
+        value: x
+      }, {
+        type: "Integer",
+        value: y
+      }]
+    };
+  }
+
+  static longPress(x, y) {
+    function longPress2(x, y) {
+      if (typeof x !== "number") throw new Error("x should be a number, but got " + (x + (" (" + (typeof x + ")"))));
+      if (typeof y !== "number") throw new Error("y should be a number, but got " + (y + (" (" + (typeof y + ")"))));
+      return {
+        target: {
+          type: "Class",
+          value: "com.wix.detox.espresso.EspressoDetox"
+        },
+        method: "longPress",
+        args: [{
+          type: "Integer",
+          value: x
+        }, {
+          type: "Integer",
+          value: y
+        }]
+      };
+    }
+
+    function longPress3(x, y, duration) {
+      if (typeof x !== "number") throw new Error("x should be a number, but got " + (x + (" (" + (typeof x + ")"))));
+      if (typeof y !== "number") throw new Error("y should be a number, but got " + (y + (" (" + (typeof y + ")"))));
+      if (typeof duration !== "number") throw new Error("duration should be a number, but got " + (duration + (" (" + (typeof duration + ")"))));
+      return {
+        target: {
+          type: "Class",
+          value: "com.wix.detox.espresso.EspressoDetox"
+        },
+        method: "longPress",
+        args: [{
+          type: "Integer",
+          value: x
+        }, {
+          type: "Integer",
+          value: y
+        }, {
+          type: "Integer",
+          value: duration
+        }]
+      };
+    }
+
+    if (arguments.length === 2) {
+      return longPress2.apply(null, arguments);
+    }
+
+    if (arguments.length === 3) {
+      return longPress3.apply(null, arguments);
+    }
+  }
+
 }
 
 module.exports = EspressoDetox;

detox/src/devices/runtime/RuntimeDevice.js

@@ -3,6 +3,7 @@
 const log = require('../../utils/logger').child({ cat: 'device' });
 const traceMethods = require('../../utils/traceMethods');
 const wrapWithStackTraceCutter = require('../../utils/wrapWithStackTraceCutter');
+const mapLongPressArguments = require('../../utils/mapLongPressArguments');
 
 const LaunchArgsEditor = require('./utils/LaunchArgsEditor');
 
@@ -283,6 +284,16 @@
     await this.deviceDriver.setOrientation(orientation);
   }
 
+  async tap(point, shouldIgnoreStatusBar) {
+    await this.deviceDriver.tap(point, shouldIgnoreStatusBar);
+  }
+
+  async longPress(arg1, arg2) {
+    let { point, duration } = mapLongPressArguments(arg1, arg2);
+
+    await this.deviceDriver.longPress(point, duration);
+  }
+
   async setLocation(lat, lon) {
     lat = String(lat);
     lon = String(lon);

detox/src/devices/runtime/RuntimeDevice.test.js

@@ -816,6 +816,23 @@ describe('Device', () => {
     expect(driverMock.driver.setOrientation).toHaveBeenCalledWith('param');
   });
 
+  it(`tap() should pass to device driver`, async () => {
+    const device = await aValidDevice();
+    const points = { x: 200, y: 200 };
+    await device.tap(points);
+
+    expect(driverMock.driver.tap).toHaveBeenCalledWith(points);
+  });
+
+  it(`longPress() should pass to device driver`, async () => {
+    const device = await aValidDevice();
+    const points = { x: 200, y: 200 };
+    const duration = 2000;
+    await device.longPress(points, duration);
+
+    expect(driverMock.driver.longPress).toHaveBeenCalledWith(points, duration);
+  });
+
   it(`sendUserNotification() should pass to device driver`, async () => {
     const device = await aValidDevice();
     await device.sendUserNotification('notif');

detox/src/devices/runtime/drivers/DeviceDriverBase.js

@@ -51,6 +51,14 @@
     return '';
   }
 
+  async tap(point, shouldIgnoreStatusBar) {
+    return '';
+  }
+
+  async longPress(arg1, arg2) {
+    return '';
+  }
+
   async sendToHome() {
     return '';
   }

detox/src/devices/runtime/drivers/android/AndroidDriver.js

@@ -245,6 +245,20 @@
     await this.invocationManager.execute(call);
   }
 
+  async tap(point, shouldIgnoreStatusBar = false) {
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    const call = EspressoDetoxApi.tap(x, y, shouldIgnoreStatusBar);
+    await this.invocationManager.execute(call);
+  }
+
+  async longPress(point, duration) {
+    let x = point?.x ?? 100;
+    let y = point?.y ?? 100;
+    const call = !!duration ? EspressoDetoxApi.longPress(x, y, duration): EspressoDetoxApi.longPress(x, y);
+    await this.invocationManager.execute(call);
+  }
+
   async generateViewHierarchyXml(shouldInjectTestIds) {
     const hierarchy = await this.invocationManager.execute(DetoxApi.generateViewHierarchyXml(shouldInjectTestIds));
     return hierarchy.result;

detox/test/e2e/06.device.test.js

@@ -98,4 +98,43 @@ describe('Device', () => {
     await device.pressBack();
     await expect(element(by.text('Back pressed !'))).toBeVisible();
   });
+
+  it(':android: tap on screen', async () => {
+    await device.launchApp({ newInstance: true });
+    await element(by.text('Device Tap')).tap();
+    await device.tap();
+    await expect(element(by.text('Screen Tapped'))).toBeVisible();
+  });
+
+  it(':android: tap on screen by coordinates', async () => {
+    await device.launchApp({ newInstance: true });
+    await element(by.text('Device Tap')).tap();
+    const point = {x: 210, y: 200}
+    await device.tap(point, true);
+    await expect(element(by.text('Button Tapped'))).toBeVisible();
+  });
+
+  it(':android: long press on screen by coordinates', async () => {
+    await device.launchApp({ newInstance: true });
+    await element(by.text('Device Tap')).tap();
+    const point = {x: 150, y: 300}
+    await device.longPress(point);
+    await expect(element(by.text('Screen Long Pressed'))).toBeVisible();
+  });
+
+  it(':android: long press on screen by coordinates with duration', async () => {
+    await device.launchApp({ newInstance: true });
+    await element(by.text('Device Tap')).tap();
+    const point = {x: 200, y: 190}
+    await device.longPress(point, 2000);
+    await expect(element(by.text('Screen Long Custom Duration Pressed'))).toBeVisible();
+  });
+
+  it(':android: long press on screen by coordinates with duration', async () => {
+    await device.launchApp({ newInstance: true });
+    await element(by.text('Device Tap')).tap();
+    const point = {x: 200, y: 190}
+    await device.longPress(2000);
+    await expect(element(by.text('Screen Long Custom Duration Pressed'))).toBeVisible();
+  });
 });

detox/test/src/Screens/DeviceTapScreen.tsx

@@ -0,0 +1,43 @@
+import React, { useCallback, useState } from 'react';
+import { Button, Text, TouchableOpacity, View } from 'react-native';
+
+const DeviceTapScreen = () => {
+  const [shouldShowScreenText, setShouldShowScreenText] = useState(false);
+  const [shouldShowButtonText, setShouldShowButtonText] = useState(false);
+  const [shouldShowLongText, setShouldShowLongText] = useState(false);
+  const [shouldShowLongCustomText, setShouldShowLongCustomText] = useState(false);
+
+  const onPressLongCustom = useCallback(() => {
+    setShouldShowLongCustomText(true);
+  }, [setShouldShowLongCustomText]);
+
+  const onPressScreen = useCallback(() => {
+    setShouldShowScreenText(true);
+  }, [setShouldShowScreenText]);
+
+  const onPressButton = useCallback(() => {
+    setShouldShowButtonText(true);
+  }, [setShouldShowButtonText]);
+
+  const onPressLong = useCallback(() => {
+    setShouldShowLongText(true);
+  }, [setShouldShowLongText]);
+
+  return (<>
+    <TouchableOpacity onLongPress={onPressLong} onPress={onPressScreen} style={{ flex: 1 }}>
+      <View style={{ left: 190, top: 190, position: 'absolute' }}>
+        <Button onPress={onPressButton} title="TAP ME" />
+      </View>
+      <TouchableOpacity delayLongPress={1500} onLongPress={onPressLongCustom} style={{ left: 150, top: 150, position: 'absolute' }}>
+        <Text>{'TAP LONG TIME'}</Text>
+      </TouchableOpacity>
+      {shouldShowLongCustomText && <Text>{'Screen Long Custom Duration Pressed'}</Text>}
+      {shouldShowLongText && <Text>{'Screen Long Pressed'}</Text>}
+      {shouldShowScreenText && <Text>{'Screen Tapped'}</Text>}
+      {shouldShowButtonText && <Text>{'Button Tapped'}</Text>}
+    </TouchableOpacity>
+  </>
+  );
+};
+
+export default DeviceTapScreen;

detox/test/src/Screens/index.js

@@ -22,6 +22,7 @@ import LaunchArgsScreen from './LaunchArgsScreen';
 import LaunchNotificationScreen from './LaunchNotificationScreen';
 import PickerViewScreen from './PickerViewScreen';
 import DeviceScreen from './DeviceScreen';
+import DeviceTapScreen from './DeviceTapScreen';
 import OverlayScreen from './OverlayScreen';
 import ElementScreenshotScreen from './ElementScreenshotScreen';
 import VirtualizedListStressScreen from './VirtualizedListStressScreen';
@@ -58,6 +59,7 @@ export {
   LaunchArgsScreen,
   LaunchNotificationScreen,
   DeviceScreen,
+  DeviceTapScreen,
   OverlayScreen,
   ElementScreenshotScreen,
   WebViewScreen,

detox/test/src/app.js

@@ -90,6 +90,7 @@ export default class example extends Component {
         {this.renderScreenButton('Network', Screens.NetworkScreen)}
         {this.renderAnimationScreenButtons()}
         {this.renderScreenButton('Device', Screens.DeviceScreen)}
+        {isAndroid && this.renderScreenButton('Device Tap', Screens.DeviceTapScreen)}
         {isIos && this.renderScreenButton('Overlay', Screens.OverlayScreen)}
         {this.renderScreenButton('Location', Screens.LocationScreen)}
         {this.renderScreenButton('DatePicker', Screens.DatePickerScreen)}