chore: Optimize screen size calculation for mouse gestures emulation (#…

…181)
appium · Jul 13, 2023 · 14dad04 · 14dad04
1 parent 487a05c
commit 14dad04
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 6 deletions.
diff --git a/lib/commands/gestures.js b/lib/commands/gestures.js
@@ -11,6 +11,7 @@ import {
   toMouseButtonInput,
   toMouseMoveInput,
   toMouseWheelInput,
+  getVirtualScreenSize,
 } from './winapi/user32';
 import { errors } from 'appium/driver';
 import B from 'bluebird';
@@ -437,6 +438,7 @@ commands.windowsClickAndDrag = async function windowsClickAndDrag (opts = {}) {
     durationMs = 500,
   } = opts;
 
+  const screenSize = await getVirtualScreenSize();
   const [modifierKeyDownInputs, modifierKeyUpInputs] = modifierKeysToInputs.bind(this)(modifierKeys);
   const [[startAbsoluteX, startAbsoluteY], [endAbsoluteX, endAbsoluteY]] = await B.all([
     toAbsoluteCoordinates.bind(this)(startElementId, startX, startY, 'Starting drag point'),
@@ -448,9 +450,9 @@ commands.windowsClickAndDrag = async function windowsClickAndDrag (opts = {}) {
   let moveEndInput;
   try {
     [moveStartInput, clickDownInput, moveEndInput, clickUpInput] = await B.all([
-      toMouseMoveInput({x: startAbsoluteX, y: startAbsoluteY}),
+      toMouseMoveInput({x: startAbsoluteX, y: startAbsoluteY}, screenSize),
       toMouseButtonInput({button: MOUSE_BUTTON.LEFT, action: MOUSE_BUTTON_ACTION.DOWN}),
-      toMouseMoveInput({x: endAbsoluteX, y: endAbsoluteY}),
+      toMouseMoveInput({x: endAbsoluteX, y: endAbsoluteY}, screenSize),
       toMouseButtonInput({button: MOUSE_BUTTON.LEFT, action: MOUSE_BUTTON_ACTION.UP}),
     ]);
   } catch (e) {
@@ -520,6 +522,7 @@ commands.windowsHover = async function windowsHover (opts = {}) {
     durationMs = 500,
   } = opts;
 
+  const screenSize = await getVirtualScreenSize();
   const [modifierKeyDownInputs, modifierKeyUpInputs] = modifierKeysToInputs.bind(this)(modifierKeys);
   const [[startAbsoluteX, startAbsoluteY], [endAbsoluteX, endAbsoluteY]] = await B.all([
     toAbsoluteCoordinates.bind(this)(startElementId, startX, startY, 'Starting hover point'),
@@ -533,7 +536,7 @@ commands.windowsHover = async function windowsHover (opts = {}) {
     const promise = B.resolve(toMouseMoveInput({
       x: startAbsoluteX + Math.trunc((endAbsoluteX - startAbsoluteX) * step / stepsCount),
       y: startAbsoluteY + Math.trunc((endAbsoluteY - startAbsoluteY) * step / stepsCount),
-    }));
+    }, screenSize));
     inputPromises.push(promise);
     // This is needed to avoid 'Error: Too many asynchronous calls are running'
     inputPromisesChunk.push(promise);

diff --git a/lib/commands/winapi/user32.js b/lib/commands/winapi/user32.js
@@ -201,6 +201,10 @@ async function getSystemMetrics(nIndex) {
   return await getUser32().GetSystemMetrics(nIndex);
 }
 
+const isLeftMouseButtonSwapped = _.memoize(async function isLeftMouseButtonSwapped () {
+  return Boolean(await getSystemMetrics(SM_SWAPBUTTON));
+});
+
 function createMouseInput (params = {}) {
   return {
     type: INPUT_MOUSE,
@@ -247,7 +251,7 @@ export async function toMouseButtonInput({button, action}) {
 
   // If the host is configured to swap left & right buttons, inject swapped
   // events to un-do that re-mapping.
-  if (await getSystemMetrics(SM_SWAPBUTTON)) {
+  if (await isLeftMouseButtonSwapped()) {
     if (button === MOUSE_BUTTON.LEFT) {
       button = MOUSE_BUTTON.RIGHT;
     } else if (button === MOUSE_BUTTON.RIGHT) {
@@ -305,18 +309,19 @@ function clamp (num, min, max) {
  * input structure
  *
  * @param {MouseMoveOptions} opts
+ * @param {Size?} screenSize
  * @returns {Promise<INPUT>} The resulting input structure
  * @throws {Error} If the input data is invalid
  */
-export async function toMouseMoveInput({dx, dy, x, y}) {
+export async function toMouseMoveInput({dx, dy, x, y}, screenSize = null) {
   const isAbsolute = _.isInteger(x) && _.isInteger(y);
   const isRelative = _.isInteger(dx) && _.isInteger(dy);
   if (!isAbsolute && !isRelative) {
     throw createInvalidArgumentError('Either relative or absolute move coordinates must be provided');
   }
 
   if (isAbsolute) {
-    const [width, height] = await B.all([SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN].map(getSystemMetrics));
+    const {width, height} = screenSize ?? await getVirtualScreenSize();
     if (width <= 1 || height <= 1) {
       throw new Error('Cannot retrieve virtual screen dimensions via GetSystemMetrics WinAPI');
     }
@@ -408,3 +413,19 @@ export function toUnicodeKeyInputs(text) {
   }
   return result;
 }
+
+/**
+ * @typedef {Object} Size
+ * @property {number} width
+ * @property {number} height
+ */
+
+/**
+ * Fetches the size of the virtual screen
+ *
+ * @returns {Promise[Size]}
+ */
+export async function getVirtualScreenSize () {
+  const [width, height] = await B.all([SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN].map(getSystemMetrics));
+  return {width, height};
+}