appium-uiautomator2-driver 4.1.2 → 4.1.4

package/lib/commands/app-management.js

@@ -22,19 +22,6 @@ export async function mobileInstallMultipleApks(apks, options) {
   await this.adb.installMultipleApks(configuredApks, options);
 }
 
-/**
- * Puts the app to background and waits the given number of seconds then restores the app
- * if necessary. The call is blocking.
- *
- * @this {AndroidUiautomator2Driver}
- * @param {number} [seconds=-1] The amount of seconds to wait between putting the app to background and restoring it.
- * Any negative value means to not restore the app after putting it to background.
- * @returns {Promise<void>}
- */
-export async function mobileBackgroundApp(seconds = -1) {
-  await this.background(seconds);
-}
-
 /**
  * @typedef {import('../driver').AndroidUiautomator2Driver} AndroidUiautomator2Driver
  */

package/lib/driver.ts

@@ -53,7 +53,6 @@ import {
 } from './commands/alert';
 import {
   mobileInstallMultipleApks,
-  mobileBackgroundApp,
 } from './commands/app-management';
 import {
   mobileGetBatteryInfo,
@@ -1010,7 +1009,6 @@ class AndroidUiautomator2Driver
   postDismissAlert = postDismissAlert;
 
   mobileInstallMultipleApks = mobileInstallMultipleApks;
-  mobileBackgroundApp = mobileBackgroundApp;
 
   mobileGetBatteryInfo = mobileGetBatteryInfo;
 

package/lib/execute-method-map.ts

@@ -214,13 +214,6 @@ export const executeMethodMap = {
     }
   },
 
-  'mobile: backgroundApp': {
-    command: 'mobileBackgroundApp',
-    params: {
-      optional: ['seconds'],
-    }
-  },
-
   'mobile: pressKey': {
     command: 'mobilePressKey',
     params: {

package/lib/uiautomator2.js

@@ -11,12 +11,14 @@ import B from 'bluebird';
 import axios from 'axios';
 
 const REQD_PARAMS = ['adb', 'tmpDir', 'host', 'systemPort', 'devicePort', 'disableWindowAnimation'];
-const SERVER_LAUNCH_TIMEOUT = 30000;
+const SERVER_LAUNCH_TIMEOUT_MS = 30000;
 const SERVER_INSTALL_RETRIES = 20;
-const SERVICES_LAUNCH_TIMEOUT = 30000;
-const SERVER_PACKAGE_ID = 'io.appium.uiautomator2.server';
-const SERVER_TEST_PACKAGE_ID = `${SERVER_PACKAGE_ID}.test`;
-const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.AndroidJUnitRunner`;
+const SERVICES_LAUNCH_TIMEOUT_MS = 30000;
+const SERVER_SHUTDOWN_TIMEOUT_MS = 5000;
+const SERVER_REQUEST_TIMEOUT_MS = 500;
+export const SERVER_PACKAGE_ID = 'io.appium.uiautomator2.server';
+export const SERVER_TEST_PACKAGE_ID = `${SERVER_PACKAGE_ID}.test`;
+export const INSTRUMENTATION_TARGET = `${SERVER_TEST_PACKAGE_ID}/androidx.test.runner.AndroidJUnitRunner`;
 
 class UIA2Proxy extends JWProxy {
   /** @type {boolean} */
@@ -36,7 +38,7 @@ class UIA2Proxy extends JWProxy {
   }
 }
 
-class UiAutomator2Server {
+export class UiAutomator2Server {
   /** @type {string} */
   host;
 
@@ -209,7 +211,7 @@ class UiAutomator2Server {
   }
 
   async verifyServicesAvailability () {
-    this.log.debug(`Waiting up to ${SERVICES_LAUNCH_TIMEOUT}ms for services to be available`);
+    this.log.debug(`Waiting up to ${SERVICES_LAUNCH_TIMEOUT_MS}ms for services to be available`);
     let isPmServiceAvailable = false;
     let pmOutput = '';
     let pmError = null;
@@ -236,7 +238,7 @@ class UiAutomator2Server {
         }
         return isPmServiceAvailable;
       }, {
-        waitMs: SERVICES_LAUNCH_TIMEOUT,
+        waitMs: SERVICES_LAUNCH_TIMEOUT_MS,
         intervalMs: 1000,
       });
     } catch {
@@ -260,7 +262,7 @@ class UiAutomator2Server {
       this.log.info(`Using UIAutomator2 server from '${apkPath}' and test from '${testApkPath}'`);
     }
 
-    const timeout = caps.uiautomator2ServerLaunchTimeout || SERVER_LAUNCH_TIMEOUT;
+    const timeout = caps.uiautomator2ServerLaunchTimeout || SERVER_LAUNCH_TIMEOUT_MS;
     const timer = new timing.Timer().start();
     let retries = 0;
     const maxRetries = 2;
@@ -344,81 +346,67 @@ class UiAutomator2Server {
   }
 
   async stopInstrumentationProcess () {
-    if (!this.instrumentationProcess) {
-      return;
-    }
-
     try {
-      if (this.instrumentationProcess.isRunning) {
+      if (this.instrumentationProcess?.isRunning) {
         await this.instrumentationProcess.stop();
       }
     } finally {
-      this.instrumentationProcess.removeAllListeners();
+      this.instrumentationProcess?.removeAllListeners();
       this.instrumentationProcess = null;
     }
   }
 
   async deleteSession () {
     this.log.debug('Deleting UiAutomator2 server session');
-    // rely on jwproxy's intelligence to know what we're talking about and
-    // delete the current session
+
     try {
       await this.jwproxy.command('/', 'DELETE');
     } catch (err) {
-      this.log.warn(`Did not get confirmation UiAutomator2 deleteSession worked; ` +
-          `Error was: ${err}`);
+      this.log.warn(
+        `Did not get the confirmation of UiAutomator2 server session deletion. ` +
+        `Original error: ${err.message}`
+      );
     }
+
+    // Theoretically we could also force kill instumentation and server processes
+    // without waiting for them to properly quit on their own.
+    // This may cause unexpected error reports in device logs though.
+    await this._waitForTermination();
+
     try {
       await this.stopInstrumentationProcess();
     } catch (err) {
       this.log.warn(`Could not stop the instrumentation process. Original error: ${err.message}`);
     }
+
+    try {
+      await B.all([
+        this.adb.forceStop(SERVER_PACKAGE_ID),
+        this.adb.forceStop(SERVER_TEST_PACKAGE_ID)
+      ]);
+    } catch {}
   }
 
   async cleanupAutomationLeftovers (strictCleanup = false) {
     this.log.debug(`Performing ${strictCleanup ? 'strict' : 'shallow'} cleanup of automation leftovers`);
 
-    const axiosTimeout = 500;
-
-    const waitStop = async () => {
-      // Wait for the process stop by sending a status request to the port.
-      // We observed the process stop could be delayed, thus causing unexpected crashes
-      // in the middle of the session preparation process. It caused an invalid session error response
-      // by the uia2 server, but that was because the process stop's delay.
-      const timeout = 3000;
-      try {
-        await waitForCondition(async () => {
-          try {
-            await axios({
-              url: `http://${this.host}:${this.systemPort}/status`,
-              timeout: axiosTimeout,
-            });
-          } catch {
-            return true;
-          }
-        }, {
-          waitMs: timeout,
-          intervalMs: 100,
-        });
-      } catch {
-        this.log.warn(`The ${SERVER_TEST_PACKAGE_ID} process might fail to stop within ${timeout}ms timeout.`);
-      }
-    };
-
+    const serverBase = `http://${this.host}:${this.systemPort}`;
     try {
       const {value} = (await axios({
-        url: `http://${this.host}:${this.systemPort}/sessions`,
-        timeout: axiosTimeout,
+        url: `${serverBase}/sessions`,
+        timeout: SERVER_REQUEST_TIMEOUT_MS,
       })).data;
       const activeSessionIds = value.map(({id}) => id).filter(Boolean);
       if (activeSessionIds.length) {
-        this.log.debug(`The following obsolete sessions are still running: ${JSON.stringify(activeSessionIds)}`);
+        this.log.debug(`The following obsolete sessions are still running: ${activeSessionIds}`);
         this.log.debug(`Cleaning up ${util.pluralize('obsolete session', activeSessionIds.length, true)}`);
         await B.all(activeSessionIds
-          .map((id) => axios.delete(`http://${this.host}:${this.systemPort}/session/${id}`))
+          .map((/** @type {string} */ id) => axios.delete(`${serverBase}/session/${id}`, {
+            timeout: SERVER_REQUEST_TIMEOUT_MS,
+          }))
         );
-        // Let all sessions to be properly terminated before continuing
-        await B.delay(1000);
+        // Let the server to be properly terminated before continuing
+        await this._waitForTermination();
       } else {
         this.log.debug('No obsolete sessions have been detected');
       }
@@ -438,11 +426,35 @@ class UiAutomator2Server {
         await this.adb.killProcessesByName('uiautomator');
       } catch {}
     }
-    await waitStop();
+  }
+
+  /**
+   * Blocks until UIA2 server stops running
+   * or SERVER_SHUTDOWN_TIMEOUT_MS expires
+   *
+   * @returns {Promise<void>}
+   */
+  async _waitForTermination() {
+    try {
+      await waitForCondition(async () => {
+        try {
+          return !(await this.adb.processExists(SERVER_PACKAGE_ID));
+        } catch {
+          return true;
+        }
+      }, {
+        waitMs: SERVER_SHUTDOWN_TIMEOUT_MS,
+        intervalMs: 300,
+      });
+    } catch {
+      this.log.warn(
+        `The UIA2 server did has not been terminated within ${SERVER_SHUTDOWN_TIMEOUT_MS}ms timeout. ` +
+        `Continuing anyway`
+      );
+    }
   }
 }
 
-export { UiAutomator2Server, INSTRUMENTATION_TARGET, SERVER_PACKAGE_ID, SERVER_TEST_PACKAGE_ID };
 export default UiAutomator2Server;
 
 /**

package/npm-shrinkwrap.json

@@ -1,16 +1,16 @@
 {
   "name": "appium-uiautomator2-driver",
-  "version": "4.1.2",
+  "version": "4.1.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-uiautomator2-driver",
-      "version": "4.1.2",
+      "version": "4.1.4",
       "license": "Apache-2.0",
       "dependencies": {
         "appium-adb": "^12.12.0",
-        "appium-android-driver": "^10.2.2",
+        "appium-android-driver": "^10.2.3",
         "appium-uiautomator2-server": "^7.2.0",
         "asyncbox": "^3.0.0",
         "axios": "^1.6.5",
@@ -68,17 +68,17 @@
       }
     },
     "node_modules/@appium/base-driver": {
-      "version": "9.16.3",
-      "resolved": "https://registry.npmjs.org/@appium/base-driver/-/base-driver-9.16.3.tgz",
-      "integrity": "sha512-+KviEBWMlHoBh/Ezs4bF1uRFw3gBHivljy8yp2dKHvFt4ZZlJo6wxmfmU5fknob0TuRkViwcD2auL64AQLsGAw==",
+      "version": "9.16.4",
+      "resolved": "https://registry.npmjs.org/@appium/base-driver/-/base-driver-9.16.4.tgz",
+      "integrity": "sha512-tWWf2vtJvDaKRtulqqMAq2YfWdtTDdVGnrtmp2DeaJX3rMjeRQPQ4Le+zMUdLIGSKNHZ9/f1BYnTtA1MToeEvQ==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/support": "^6.0.7",
+        "@appium/support": "^6.0.8",
         "@appium/types": "^0.25.2",
         "@colors/colors": "1.6.0",
         "async-lock": "1.4.1",
         "asyncbox": "3.0.0",
-        "axios": "1.8.2",
+        "axios": "1.8.3",
         "bluebird": "3.7.2",
         "body-parser": "1.20.3",
         "express": "4.21.2",
@@ -103,9 +103,9 @@
       }
     },
     "node_modules/@appium/base-driver/node_modules/axios": {
-      "version": "1.8.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.2.tgz",
-      "integrity": "sha512-ls4GYBm5aig9vWx8AWDSGLpnpDQRtWAfrjU+EuytuODrFBkqesN2RkOQCBzrA1RQNHw1SmRMSDDDSwzNAYQ6Rg==",
+      "version": "1.8.3",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.3.tgz",
+      "integrity": "sha512-iP4DebzoNlP/YN2dpwCgb8zoCmhtkajzS48JvwmkSkXvPI3DHc7m+XYL5tGnSlJtR6nImXZmdCuN5aP8dh1d8A==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -114,13 +114,13 @@
       }
     },
     "node_modules/@appium/base-plugin": {
-      "version": "2.3.4",
-      "resolved": "https://registry.npmjs.org/@appium/base-plugin/-/base-plugin-2.3.4.tgz",
-      "integrity": "sha512-m3iJ2+68OIEXF87VJ/RYPSg85jVGo73MqAfv5onYyvFuljWgnowZGRFL13lvfnTBxmI5sU9eF1QLO3n7KcQ/eg==",
+      "version": "2.3.5",
+      "resolved": "https://registry.npmjs.org/@appium/base-plugin/-/base-plugin-2.3.5.tgz",
+      "integrity": "sha512-/9WvjBvXWE5U5Pg7tvcfj/9Dv1tzLaThgUAgDGDh5Ve2ZXBAznz0fR6NSbjyeaFR7UbroF3f9sjlzPNVM180PA==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/base-driver": "^9.16.3",
-        "@appium/support": "^6.0.7"
+        "@appium/base-driver": "^9.16.4",
+        "@appium/support": "^6.0.8"
       },
       "engines": {
         "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -128,12 +128,12 @@
       }
     },
     "node_modules/@appium/docutils": {
-      "version": "1.0.33",
-      "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-1.0.33.tgz",
-      "integrity": "sha512-wY/bkewxrqUIvY69/LvYz1c7/XRFqqn/SND+EGvwWyyxzIfXTTN57SXZmRqWK8HO8v0hk5RMOvaNH+3Me94kTQ==",
+      "version": "1.0.34",
+      "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-1.0.34.tgz",
+      "integrity": "sha512-a3zzrx2e/xzoNAbKncuyDfUhExEvX+9wV2Lnb+9cfKlhMAqFudRcTF8aNf7dGVsZjfXPNH049qG6htL8Mn2Gow==",
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/support": "^6.0.7",
+        "@appium/support": "^6.0.8",
         "@appium/tsconfig": "^0.3.5",
         "@sliphua/lilconfig-ts-loader": "3.2.2",
         "chalk": "4.1.2",
@@ -192,9 +192,9 @@
       }
     },
     "node_modules/@appium/support": {
-      "version": "6.0.7",
-      "resolved": "https://registry.npmjs.org/@appium/support/-/support-6.0.7.tgz",
-      "integrity": "sha512-3LYvWhquHzlxq2ojvuAmta2tPk68B6oKZ9lMv2lyI6q7mR7FE8hl96Wy+qk9JjGfqJHYRNrrf9rTWr0E//UtQg==",
+      "version": "6.0.8",
+      "resolved": "https://registry.npmjs.org/@appium/support/-/support-6.0.8.tgz",
+      "integrity": "sha512-vhQtJwD89BbPDb7n+wvYFWKBF1sCd9XS/yTR8eA5mRGM+frCS9mlxy9VNAcjEbxfkLwSa4iqRhp3MzK8L4w4KA==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/logger": "^1.6.1",
@@ -202,7 +202,7 @@
         "@appium/types": "^0.25.2",
         "@colors/colors": "1.6.0",
         "archiver": "7.0.1",
-        "axios": "1.8.2",
+        "axios": "1.8.3",
         "base64-stream": "1.0.0",
         "bluebird": "3.7.2",
         "bplist-creator": "0.1.1",
@@ -243,9 +243,9 @@
       }
     },
     "node_modules/@appium/support/node_modules/axios": {
-      "version": "1.8.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.2.tgz",
-      "integrity": "sha512-ls4GYBm5aig9vWx8AWDSGLpnpDQRtWAfrjU+EuytuODrFBkqesN2RkOQCBzrA1RQNHw1SmRMSDDDSwzNAYQ6Rg==",
+      "version": "1.8.3",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.3.tgz",
+      "integrity": "sha512-iP4DebzoNlP/YN2dpwCgb8zoCmhtkajzS48JvwmkSkXvPI3DHc7m+XYL5tGnSlJtR6nImXZmdCuN5aP8dh1d8A==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -562,18 +562,18 @@
       }
     },
     "node_modules/appium": {
-      "version": "2.17.0",
-      "resolved": "https://registry.npmjs.org/appium/-/appium-2.17.0.tgz",
-      "integrity": "sha512-DY5/Bvz4KNOmW6uPgnXjWg9gOzXxT7ZTtguLcotXj2KKB3Ty0mNqpeLCLpyKDDeFheFWeFfrX73T2Y9PAa8WOA==",
+      "version": "2.17.1",
+      "resolved": "https://registry.npmjs.org/appium/-/appium-2.17.1.tgz",
+      "integrity": "sha512-aE4WuM+/gFblteSYxAxDkdeSFCCMM791KSM9msUvNnfRIn/ZNAvj6HkobCAzGMnFBkYYOISD5diXNPFo/a9rsQ==",
       "hasInstallScript": true,
       "license": "Apache-2.0",
       "dependencies": {
-        "@appium/base-driver": "^9.16.3",
-        "@appium/base-plugin": "^2.3.4",
-        "@appium/docutils": "^1.0.33",
+        "@appium/base-driver": "^9.16.4",
+        "@appium/base-plugin": "^2.3.5",
+        "@appium/docutils": "^1.0.34",
         "@appium/logger": "^1.6.1",
         "@appium/schema": "^0.8.1",
-        "@appium/support": "^6.0.7",
+        "@appium/support": "^6.0.8",
         "@appium/types": "^0.25.2",
         "@sidvind/better-ajv-errors": "3.0.1",
         "ajv": "8.17.1",
@@ -581,7 +581,7 @@
         "argparse": "2.0.1",
         "async-lock": "1.4.1",
         "asyncbox": "3.0.0",
-        "axios": "1.8.2",
+        "axios": "1.8.3",
         "bluebird": "3.7.2",
         "lilconfig": "3.1.3",
         "lodash": "4.17.21",
@@ -629,9 +629,9 @@
       }
     },
     "node_modules/appium-android-driver": {
-      "version": "10.2.2",
-      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-10.2.2.tgz",
-      "integrity": "sha512-NgjmxedfbUWlwO7AFK00vKedEOuXpfaxXO6KYDVhtL1gIkiLGhTWt3YByJGT6yEpdaKJ3/21ieQR2B/LkcKsZw==",
+      "version": "10.2.3",
+      "resolved": "https://registry.npmjs.org/appium-android-driver/-/appium-android-driver-10.2.3.tgz",
+      "integrity": "sha512-urP4jqS+rl8oU5zAyCYCyUJ+1Hi58rLB4gvfXIS2MCqe7AzLC3eoAoPgNWc0/A+lCBja5INk8SCpphBSoC+FXg==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/support": "^6.0.0",
@@ -662,9 +662,9 @@
       }
     },
     "node_modules/appium-chromedriver": {
-      "version": "7.0.9",
-      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-7.0.9.tgz",
-      "integrity": "sha512-7T0HTszqwz4jQbtZpZ669BQYgtLcEucyTIEmHnv72pvmshrwNr/KELouRkY7VcazzW88w+bpcYh3/3bzs9Si2w==",
+      "version": "7.0.10",
+      "resolved": "https://registry.npmjs.org/appium-chromedriver/-/appium-chromedriver-7.0.10.tgz",
+      "integrity": "sha512-ksW8PLm5cxzAUEnaesjSJ58e+Ey3baXtEdGZNyvzzFOuaO3NfGDN/g1RojQNL+N9QkMFy3gylwkrCcy+yIOuDw==",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/base-driver": "^9.1.0",
@@ -697,9 +697,9 @@
       }
     },
     "node_modules/appium/node_modules/axios": {
-      "version": "1.8.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.2.tgz",
-      "integrity": "sha512-ls4GYBm5aig9vWx8AWDSGLpnpDQRtWAfrjU+EuytuODrFBkqesN2RkOQCBzrA1RQNHw1SmRMSDDDSwzNAYQ6Rg==",
+      "version": "1.8.3",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.3.tgz",
+      "integrity": "sha512-iP4DebzoNlP/YN2dpwCgb8zoCmhtkajzS48JvwmkSkXvPI3DHc7m+XYL5tGnSlJtR6nImXZmdCuN5aP8dh1d8A==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -794,9 +794,9 @@
       "license": "MIT"
     },
     "node_modules/axios": {
-      "version": "1.8.3",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.3.tgz",
-      "integrity": "sha512-iP4DebzoNlP/YN2dpwCgb8zoCmhtkajzS48JvwmkSkXvPI3DHc7m+XYL5tGnSlJtR6nImXZmdCuN5aP8dh1d8A==",
+      "version": "1.8.4",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-1.8.4.tgz",
+      "integrity": "sha512-eBSYY4Y68NNlHbHBMdeDmKNtDgXWhQsJcGqzO3iLUM0GraQFSS9cVgPX5I9b3lbdFKyYoAEGAZF1DwhTaljNAw==",
       "license": "MIT",
       "dependencies": {
         "follow-redirects": "^1.15.6",
@@ -1420,9 +1420,9 @@
       }
     },
     "node_modules/css-selector-parser": {
-      "version": "3.0.5",
-      "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.0.5.tgz",
-      "integrity": "sha512-3itoDFbKUNx1eKmVpYMFyqKX04Ww9osZ+dLgrk6GEv6KMVeXUhUnp4I5X+evw+u3ZxVU6RFXSSRxlTeMh8bA+g==",
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/css-selector-parser/-/css-selector-parser-3.1.1.tgz",
+      "integrity": "sha512-Y+DuvJ7JAjpL1f4DeILe5sXCC3kRXMl0DxM4lAWbS8/jEZ29o3V0L5TL6zIifj4Csmj6c+jiF2ENjida2OVOGA==",
       "funding": [
         {
           "type": "github",

package/package.json

@@ -7,7 +7,7 @@
     "automated testing",
     "android"
   ],
-  "version": "4.1.2",
+  "version": "4.1.4",
   "bugs": {
     "url": "https://github.com/appium/appium-uiautomator2-driver/issues"
   },
@@ -57,7 +57,7 @@
   },
   "dependencies": {
     "appium-adb": "^12.12.0",
-    "appium-android-driver": "^10.2.2",
+    "appium-android-driver": "^10.2.3",
     "appium-uiautomator2-server": "^7.2.0",
     "asyncbox": "^3.0.0",
     "axios": "^1.6.5",