appium-xcuitest-driver 7.13.0 → 7.15.0

package/lib/real-device.js

@@ -1,23 +1,16 @@
-import {fs, timing, util} from 'appium/support';
+import {timing, util, fs} from 'appium/support';
 import path from 'path';
 import {services, utilities, INSTRUMENT_CHANNEL} from 'appium-ios-device';
 import B from 'bluebird';
 import defaultLogger from './logger';
 import _ from 'lodash';
-import {exec} from 'teen_process';
-import {extractBundleId, SAFARI_BUNDLE_ID} from './app-utils';
-import {pushFolder} from './ios-fs-helpers';
+import {SAFARI_BUNDLE_ID} from './app-utils';
+import {pushFile, pushFolder, IO_TIMEOUT_MS} from './ios-fs-helpers';
 import { Devicectl } from './devicectl';
 
 const APPLICATION_INSTALLED_NOTIFICATION = 'com.apple.mobile.application_installed';
-const INSTALLATION_STAGING_DIR = 'PublicStaging';
 const APPLICATION_NOTIFICATION_TIMEOUT_MS = 30 * 1000;
-const IOS_DEPLOY = 'ios-deploy';
-const APP_INSTALL_STRATEGY = Object.freeze({
-  SERIAL: 'serial',
-  PARALLEL: 'parallel',
-  IOS_DEPLOY,
-});
+const INSTALLATION_STAGING_DIR = 'PublicStaging';
 
 /**
  * @returns {Promise<string[]>}
@@ -26,6 +19,11 @@ export async function getConnectedDevices() {
   return await utilities.getConnectedDevices();
 }
 
+/**
+ * @typedef {Object} InstallOptions
+ * @param {number} [timeoutMs=240000] Application installation timeout in milliseconds
+ */
+
 /**
  * @typedef {Object} InstallOrUpgradeOptions
  * @property {number} timeout Install/upgrade timeout in milliseconds
@@ -71,82 +69,52 @@ export class RealDevice {
 
   /**
    *
-   * @param {string} app
-   * @param {number} timeout
-   * @param {'ios-deploy'|'serial'|'parallel'|null} strategy
-   * @privateRemarks This really needs type guards built out
+   * @param {string} appPath
+   * @param {string} bundleId
+   * @param {InstallOptions} [opts={}]
    */
-  async install(app, timeout, strategy = null) {
-    if (
-      strategy &&
-      !_.values(APP_INSTALL_STRATEGY).includes(/** @type {any} */ (_.toLower(strategy)))
-    ) {
-      throw new Error(
-        `App installation strategy '${strategy}' is unknown. ` +
-          `Only the following strategies are supported: ${_.values(APP_INSTALL_STRATEGY)}`,
-      );
-    }
-    this.log.debug(
-      `Using '${strategy ?? APP_INSTALL_STRATEGY.SERIAL}' app deployment strategy. ` +
-        `You could change it by providing another value to the 'appInstallStrategy' capability`,
-    );
-
-    const installWithIosDeploy = async () => {
-      try {
-        await fs.which(IOS_DEPLOY);
-      } catch (err) {
-        throw new Error(`'${IOS_DEPLOY}' utility has not been found in PATH. Is it installed?`);
-      }
-      try {
-        await exec(IOS_DEPLOY, ['--id', this.udid, '--bundle', app], {timeout});
-      } catch (err) {
-        throw new Error(err.stderr || err.stdout || err.message);
-      }
-    };
-
+  async install(appPath, bundleId, opts = {}) {
+    const {
+      timeoutMs = IO_TIMEOUT_MS,
+    } = opts;
     const timer = new timing.Timer().start();
-    if (_.toLower(/** @type {'ios-deploy'} */ (strategy)) === APP_INSTALL_STRATEGY.IOS_DEPLOY) {
-      await installWithIosDeploy();
-    } else {
-      const afcService = await services.startAfcService(this.udid);
-      const enableParallelPush = _.toLower(/** @type {'parallel'} */ (strategy)) === APP_INSTALL_STRATEGY.PARALLEL;
-      try {
-        const bundleId = await extractBundleId(app);
-        const bundlePathOnPhone = path.join(INSTALLATION_STAGING_DIR, bundleId);
-        await pushFolder(afcService, app, bundlePathOnPhone, {
-          enableParallelPush,
-          timeoutMs: timeout,
+    const afcService = await services.startAfcService(this.udid);
+    try {
+      let bundlePathOnPhone;
+      if ((await fs.stat(appPath)).isFile()) {
+        // https://github.com/doronz88/pymobiledevice3/blob/6ff5001f5776e03b610363254e82d7fbcad4ef5f/pymobiledevice3/services/installation_proxy.py#L75
+        bundlePathOnPhone = `/${path.basename(appPath)}`;
+        await pushFile(afcService, appPath, bundlePathOnPhone, {
+          timeoutMs,
         });
-        await this.installOrUpgradeApplication(
-          bundlePathOnPhone,
-          {
-            timeout: Math.max(timeout - timer.getDuration().asMilliSeconds, 60000),
-            isUpgrade: await this.isAppInstalled(bundleId),
-          }
-        );
-      } catch (err) {
-        this.log.warn(`Error installing app '${app}': ${err.message}`);
-        if (err instanceof B.TimeoutError) {
-          this.log.info(
-            `Consider increasing the value of 'appPushTimeout' capability (the current value equals to ${timeout}ms)`
-          );
-          if (!enableParallelPush) {
-            this.log.info(`Consider setting the value of 'appInstallStrategy' capability to 'parallel'`);
-          }
-        }
-        this.log.warn(`Falling back to '${IOS_DEPLOY}' usage`);
-        try {
-          await installWithIosDeploy();
-        } catch (err1) {
-          throw new Error(
-            `Could not install '${app}':\n` + `  - ${err.message}\n` + `  - ${err1.message}`,
-          );
+      } else {
+        bundlePathOnPhone = `${INSTALLATION_STAGING_DIR}/${bundleId}`;
+        await pushFolder(afcService, appPath, bundlePathOnPhone, {
+          enableParallelPush: true,
+          timeoutMs,
+        });
+      }
+      await this.installOrUpgradeApplication(
+        bundlePathOnPhone,
+        {
+          timeout: Math.max(timeoutMs - timer.getDuration().asMilliSeconds, 60000),
+          isUpgrade: await this.isAppInstalled(bundleId),
         }
-      } finally {
-        afcService.close();
+      );
+    } catch (err) {
+      this.log.debug(err.stack);
+      let errMessage = `Cannot install the ${bundleId} application`;
+      if (err instanceof B.TimeoutError) {
+        errMessage += `. Consider increasing the value of 'appPushTimeout' capability (the current value equals to ${timeoutMs}ms)`;
       }
+      errMessage += `. Original error: ${err.message}`;
+      throw new Error(errMessage);
+    } finally {
+      afcService.close();
     }
-    this.log.info(`App installation succeeded after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
+    this.log.info(
+      `The installation of '${bundleId}' succeeded after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`
+    );
   }
 
   /**
@@ -164,10 +132,16 @@ export class RealDevice {
     const clientOptions = {PackageType: 'Developer'};
     try {
       if (isUpgrade) {
-        this.log.debug(`An upgrade of the existing application is going to be performed. Will timeout in ${timeout} ms`);
+        this.log.debug(
+          `An upgrade of the existing application is going to be performed. ` +
+          `Will timeout in ${timeout.toFixed(0)} ms`
+        );
         await installationService.upgradeApplication(bundlePathOnPhone, clientOptions, timeout);
       } else {
-        this.log.debug(`A new application installation is going to be performed. Will timeout in ${timeout} ms`);
+        this.log.debug(
+          `A new application installation is going to be performed. ` +
+          `Will timeout in ${timeout.toFixed(0)} ms`
+        );
         await installationService.installApplication(bundlePathOnPhone, clientOptions, timeout);
       }
       try {
@@ -187,12 +161,12 @@ export class RealDevice {
 
   /**
    * Alias for {@linkcode install}
-   * @param {string} app
-   * @param {number} timeout
-   * @param {'ios-deploy'|'serial'|'parallel'|null} strategy
+   * @param {string} appPath
+   * @param {string} bundleId
+   * @param {InstallOptions} [opts={}]
    */
-  async installApp(app, timeout, strategy) {
-    return await this.install(app, timeout, strategy);
+  async installApp(appPath, bundleId, opts = {}) {
+    return await this.install(appPath, bundleId, opts);
   }
 
   /**

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "7.13.0",
+  "version": "7.15.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "7.13.0",
+      "version": "7.15.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
@@ -83,16 +83,16 @@
         "npm": ">=8"
       },
       "peerDependencies": {
-        "appium": "^2.4.1"
+        "appium": "^2.5.4"
       }
     },
     "node_modules/@appium/base-driver": {
-      "version": "9.5.4",
-      "resolved": "https://registry.npmjs.org/@appium/base-driver/-/base-driver-9.5.4.tgz",
-      "integrity": "sha512-kYBYyfXu15RAvAaJ/FUR2gosm74E5Nl9N6A3AzX1SZVDqm7mLojSgBZCGrRsd/oMVE1vpMcwHWJt4JpYXkrbhw==",
+      "version": "9.6.0",
+      "resolved": "https://registry.npmjs.org/@appium/base-driver/-/base-driver-9.6.0.tgz",
+      "integrity": "sha512-8+pqWHQ4tbvtwOxNCtHa5m0SUwQIvAwHTVKq/YUbgDn18ep4nGhz5rlryvvqyNpXEgEOhbLInIRma1KIrYdX8Q==",
       "dependencies": {
-        "@appium/support": "^4.2.4",
-        "@appium/types": "^0.16.2",
+        "@appium/support": "^4.2.5",
+        "@appium/types": "^0.17.0",
         "@colors/colors": "1.6.0",
         "@types/async-lock": "1.4.2",
         "@types/bluebird": "3.5.42",
@@ -125,6 +125,14 @@
         "spdy": "4.0.2"
       }
     },
+    "node_modules/@appium/base-driver/node_modules/lru-cache": {
+      "version": "10.2.0",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.2.0.tgz",
+      "integrity": "sha512-2bIM8x+VAf6JT4bKAljS1qUWgMsqZRPGJS6FSahIMPVvctcNhyVp7AJu7quxOW9jwkryBReKZY5tY5JYv2n/7Q==",
+      "engines": {
+        "node": "14 || >=16.14"
+      }
+    },
     "node_modules/@appium/base-driver/node_modules/type-fest": {
       "version": "4.10.1",
       "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.10.1.tgz",
@@ -137,11 +145,11 @@
       }
     },
     "node_modules/@appium/docutils": {
-      "version": "1.0.6",
-      "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-1.0.6.tgz",
-      "integrity": "sha512-I7irwTyBlMfNPfhFAcNkGLsJdZxNvWXsbcgV/oW4PU5dBN0wfwqrfLJQrrfHGTDpgDukpaTl7J+Ro82WgATWfA==",
+      "version": "1.0.7",
+      "resolved": "https://registry.npmjs.org/@appium/docutils/-/docutils-1.0.7.tgz",
+      "integrity": "sha512-cuVcE3nNKlhJZsXrleubYkrr4VrEXaVKxq0GePb5+qmgpkx2OQb18imoPx1FKBlDbxHGrV7fuLxc/5LbmsV0dA==",
       "dependencies": {
-        "@appium/support": "^4.2.4",
+        "@appium/support": "^4.2.5",
         "@appium/tsconfig": "^0.3.3",
         "@sliphua/lilconfig-ts-loader": "3.2.2",
         "@types/which": "3.0.3",
@@ -209,12 +217,12 @@
       }
     },
     "node_modules/@appium/support": {
-      "version": "4.2.4",
-      "resolved": "https://registry.npmjs.org/@appium/support/-/support-4.2.4.tgz",
-      "integrity": "sha512-TfZ+sIm295EQzL89ympDwwWfuzRHnkiZv5SPDMBcrCJHXcJVcL7BhuQhkiPkHaZvNgKvyvcEb9kGNC+L2UtN+g==",
+      "version": "4.2.5",
+      "resolved": "https://registry.npmjs.org/@appium/support/-/support-4.2.5.tgz",
+      "integrity": "sha512-txTDZHjJF7UjEFi4uyj23gciz3yAq7OwzXFdJgtQBzkK1cIiCnywQ6igLmBg52jZp84ki8eZIDMXsQetVUuDDg==",
       "dependencies": {
         "@appium/tsconfig": "^0.3.3",
-        "@appium/types": "^0.16.2",
+        "@appium/types": "^0.17.0",
         "@colors/colors": "1.6.0",
         "@types/archiver": "6.0.2",
         "@types/base64-stream": "1.0.5",
@@ -265,7 +273,7 @@
         "type-fest": "4.10.1",
         "uuid": "9.0.1",
         "which": "4.0.0",
-        "yauzl": "3.1.2"
+        "yauzl": "3.1.3"
       },
       "engines": {
         "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -299,9 +307,9 @@
       }
     },
     "node_modules/@appium/types": {
-      "version": "0.16.2",
-      "resolved": "https://registry.npmjs.org/@appium/types/-/types-0.16.2.tgz",
-      "integrity": "sha512-4LpzS26hfTuK5rAXogotydMFjA0UdWKpQscpsIJKJQ3KGNYNNSQL0fpVcJ6hHHXA2/ySI6DtQeK9+ayUBCUqYg==",
+      "version": "0.17.0",
+      "resolved": "https://registry.npmjs.org/@appium/types/-/types-0.17.0.tgz",
+      "integrity": "sha512-7Q9C5Y4G8ZQzdU0uJIlfVqpGMAzNqdXpNWziQTUfZyD7fHbYz9ScZrlgs2/DYMITRrHiIblmzY/5yzfu00rQuA==",
       "dependencies": {
         "@appium/schema": "^0.5.0",
         "@appium/tsconfig": "^0.3.3",
@@ -922,9 +930,9 @@
       }
     },
     "node_modules/appium-remote-debugger": {
-      "version": "11.1.0",
-      "resolved": "https://registry.npmjs.org/appium-remote-debugger/-/appium-remote-debugger-11.1.0.tgz",
-      "integrity": "sha512-Hexj1V8e7BnnfhfDbUU+jDOd6ChK8lSZktm8eXXfaobABXo/0/pkfoyo6S5Gt/o9bmualQOLzjcsEWJOJEedtg==",
+      "version": "11.1.1",
+      "resolved": "https://registry.npmjs.org/appium-remote-debugger/-/appium-remote-debugger-11.1.1.tgz",
+      "integrity": "sha512-Fcu3U6mQtWBq+zQDb1fhnxoVTyZ5cmPi+dpM6zy+eVbYk/nR9n20v4uOQstH2ySnAknpNGVMSQVPBoZOP+YS2Q==",
       "dependencies": {
         "@appium/base-driver": "^9.0.0",
         "@appium/support": "^4.0.0",
@@ -944,9 +952,9 @@
       }
     },
     "node_modules/appium-webdriveragent": {
-      "version": "8.5.2",
-      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-8.5.2.tgz",
-      "integrity": "sha512-v7DfnS9sN4KD6ahAOixGF90ajJUZADYim9mxOSIH2Qs3hX/KHURbHD9khQJp5Kbu0jeIpmaLj+yXpbtAg8c+9g==",
+      "version": "8.5.6",
+      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-8.5.6.tgz",
+      "integrity": "sha512-9cfqCfgQ4RmVI66jWuw71Xf1u9EErVaB8KVDGMtOaYxpS3QH6DoGRTWDEzUfmhvOfOZg0mtkHnh4WM1fvscI7w==",
       "dependencies": {
         "@appium/base-driver": "^9.0.0",
         "@appium/strongbox": "^0.x",
@@ -2532,9 +2540,9 @@
       }
     },
     "node_modules/lru-cache": {
-      "version": "10.2.0",
-      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.2.0.tgz",
-      "integrity": "sha512-2bIM8x+VAf6JT4bKAljS1qUWgMsqZRPGJS6FSahIMPVvctcNhyVp7AJu7quxOW9jwkryBReKZY5tY5JYv2n/7Q==",
+      "version": "10.2.1",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.2.1.tgz",
+      "integrity": "sha512-tS24spDe/zXhWbNPErCHs/AGOzbKGHT+ybSBqmdLm8WZ1xXLWvH8Qn71QPAlqVhd0qUTWjy+Kl9JmISgDdEjsA==",
       "engines": {
         "node": "14 || >=16.14"
       }
@@ -4217,9 +4225,9 @@
       }
     },
     "node_modules/yauzl": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-3.1.2.tgz",
-      "integrity": "sha512-621iCPgEG1wXViDZS/L3h9F8TgrdQV1eayJlJ8j5A2SZg8OdY/1DLf+VxNeD+q5QbMFEAbjjR8nITj7g4nKa0Q==",
+      "version": "3.1.3",
+      "resolved": "https://registry.npmjs.org/yauzl/-/yauzl-3.1.3.tgz",
+      "integrity": "sha512-JCCdmlJJWv7L0q/KylOekyRaUrdEoUxWkWVcgorosTROCFWiS9p2NNPE9Yb91ak7b1N5SxAZEliWpspbZccivw==",
       "dependencies": {
         "buffer-crc32": "~0.2.3",
         "pend": "~1.2.0"

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "7.13.0",
+  "version": "7.15.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -131,7 +131,7 @@
     "singleQuote": true
   },
   "peerDependencies": {
-    "appium": "^2.4.1"
+    "appium": "^2.5.4"
   },
   "devDependencies": {
     "@appium/docutils": "^1.0.2",