appium-uiautomator2-driver 1.65.1 → 1.67.0

package/lib/commands/gestures.js

@@ -328,7 +328,7 @@ commands.mobileScrollBackTo = async function (opts = {}) {
 
 /**
  * @typedef {Object} ScrollOpts
- * @property {?string} element The identifier of an element. It is required this element
+ * @property {?string} elementId The identifier of an element. It is required this element
  * is a valid scrollable container and it was located by `-android uiautomator`
  * strategy. If this property is not provided then the first currently available scrollable view
  * is selected for the interaction.
@@ -356,15 +356,16 @@ commands.mobileScrollBackTo = async function (opts = {}) {
  * @throws {Error} if the scrolling operation cannot be performed
  */
 commands.mobileScroll = async function (opts = {}) {
-  const {element, strategy, selector, maxSwipes} = opts;
+  const {
+    element, elementId, // `element` is deprecated, use `elementId` instead
+    strategy, selector, maxSwipes
+  } = opts;
   if (!strategy || !selector) {
     throw new errors.InvalidArgumentError(`Both strategy and selector arguments must be provided`);
   }
   return await this.uiautomator2.jwproxy.command('/touch/scroll', 'POST', {
-    params: {
-      origin: toOrigin(element),
-      strategy, selector, maxSwipes
-    },
+    origin: toOrigin(elementId || element),
+    params: {strategy, selector, maxSwipes},
   });
 };
 

package/lib/driver.js

@@ -1,6 +1,8 @@
 import _ from 'lodash';
 import { BaseDriver, DeviceSettings } from 'appium-base-driver';
-import { UiAutomator2Server, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID } from './uiautomator2';
+import {
+  UiAutomator2Server, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID
+} from './uiautomator2';
 import { fs, util, mjpeg } from 'appium-support';
 import { retryInterval } from 'asyncbox';
 import B from 'bluebird';
@@ -8,9 +10,11 @@ import logger from './logger';
 import commands from './commands/index';
 import { DEFAULT_ADB_PORT } from 'appium-adb';
 import uiautomator2Helpers from './helpers';
-import { androidHelpers, androidCommands, SETTINGS_HELPER_PKG_ID } from 'appium-android-driver';
+import {
+  androidHelpers, androidCommands, SETTINGS_HELPER_PKG_ID
+} from 'appium-android-driver';
 import desiredCapConstraints from './desired-caps';
-import { findAPortNotInUse } from 'portscanner';
+import { findAPortNotInUse, checkPortStatus } from 'portscanner';
 import os from 'os';
 import path from 'path';
 import { APK_EXTENSION, APKS_EXTENSION } from './extensions';
@@ -37,6 +41,8 @@ const DEVICE_PORT = 6790;
 // device.
 const MJPEG_SERVER_DEVICE_PORT = 7810;
 
+const LOCALHOST_IP4 = '127.0.0.1';
+
 // NO_PROXY contains the paths that we never want to proxy to UiAutomator2 server.
 // TODO:  Add the list of paths that we never want to proxy to UiAutomator2 server.
 // TODO: Need to segregate the paths better way using regular expressions wherever applicable.
@@ -274,6 +280,12 @@ class AndroidUiautomator2Driver extends BaseDriver {
   async allocateSystemPort () {
     const forwardPort = async (localPort) => {
       logger.debug(`Forwarding UiAutomator2 Server port ${DEVICE_PORT} to local port ${localPort}`);
+      if ((await checkPortStatus(localPort, LOCALHOST_IP4)) === 'open') {
+        logger.errorAndThrow(`UiAutomator2 Server cannot start because the local port #${localPort} is busy. ` +
+          `Make sure the port you provide via 'systemPort' capability is not occupied. ` +
+          `This situation might often be a result of an inaccurate sessions management, e.g. ` +
+          `old automation sessions on the same device must always be closed before starting new ones.`);
+      }
       await this.adb.forwardPort(localPort, DEVICE_PORT);
     };
 
@@ -459,7 +471,7 @@ class AndroidUiautomator2Driver extends BaseDriver {
   async initUiAutomator2Server () {
     // broken out for readability
     const uiautomator2Opts = {
-      host: this.opts.remoteAdbHost || this.opts.host || '127.0.0.1',
+      host: this.opts.remoteAdbHost || this.opts.host || LOCALHOST_IP4,
       systemPort: this.opts.systemPort,
       devicePort: DEVICE_PORT,
       adb: this.adb,

package/lib/uiautomator2.js

@@ -2,8 +2,14 @@ import _ from 'lodash';
 import { JWProxy, errors } from 'appium-base-driver';
 import { waitForCondition } from 'asyncbox';
 import log from './logger';
-import { SERVER_APK_PATH as apkPath, TEST_APK_PATH as testApkPath, version as serverVersion } from 'appium-uiautomator2-server';
-import { util, logger, tempDir, fs, timing } from 'appium-support';
+import {
+  SERVER_APK_PATH as apkPath,
+  TEST_APK_PATH as testApkPath,
+  version as serverVersion
+} from 'appium-uiautomator2-server';
+import {
+  util, logger, tempDir, fs, timing
+} from 'appium-support';
 import B from 'bluebird';
 import helpers from './helpers';
 import axios from 'axios';
@@ -302,13 +308,13 @@ class UiAutomator2Server {
         url: `http://${this.host}:${this.systemPort}/wd/hub/sessions`,
         timeout: 500,
       })).data;
-      const activeSessionIds = value.map((sess) => sess.id);
+      const activeSessionIds = value.map(({id}) => id).filter(Boolean);
       if (activeSessionIds.length) {
         log.debug(`The following obsolete sessions are still running: ${JSON.stringify(activeSessionIds)}`);
-        log.debug('Cleaning up the obsolete sessions');
-        await B.all(activeSessionIds.map((id) =>
-          axios.delete(`http://${this.host}:${this.systemPort}/wd/hub/session/${id}`)
-        ));
+        log.debug(`Cleaning up ${util.pluralize('obsolete session', activeSessionIds.length, true)}`);
+        await B.all(activeSessionIds
+          .map((id) => axios.delete(`http://${this.host}:${this.systemPort}/wd/hub/session/${id}`))
+        );
         // Let all sessions to be properly terminated before continuing
         await B.delay(1000);
       } else {

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "1.65.1",
+  "version": "1.67.0",
   "author": "appium",
   "license": "Apache-2.0",
   "repository": {
@@ -42,11 +42,11 @@
   "dependencies": {
     "@babel/runtime": "^7.0.0",
     "appium-adb": "^8.10.0",
-    "appium-android-driver": "^4.40.0",
+    "appium-android-driver": "^4.47.0",
     "appium-base-driver": "^7.0.0",
     "appium-chromedriver": "^4.23.1",
     "appium-support": "^2.49.0",
-    "appium-uiautomator2-server": "^4.20.0",
+    "appium-uiautomator2-server": "^4.23.0",
     "asyncbox": "^2.3.1",
     "axios": "^0.x",
     "bluebird": "^3.5.1",
@@ -89,13 +89,13 @@
     "eslint-config-appium": "^4.0.1",
     "gps-demo-app": "^2.1.1",
     "gulp": "^4.0.0",
-    "mocha": "^8.2.1",
+    "mocha": "^9.0.0",
     "mocha-junit-reporter": "^2.0.0",
     "mocha-multi-reporters": "^1.1.7",
     "pngjs": "^6.0.0",
     "pre-commit": "^1.2.2",
     "rimraf": "^3.0.0",
-    "sinon": "^10.0.0",
+    "sinon": "^11.0.0",
     "unzipper": "^0.10.0",
     "wd": "^1.10.3",
     "xmldom": "^0.x",