appium-xcuitest-driver 7.12.0 → 7.14.0

package/lib/driver.js

@@ -12,15 +12,12 @@ import EventEmitter from 'node:events';
 import path from 'node:path';
 import url from 'node:url';
 import {
-  APP_EXT,
-  IPA_EXT,
+  SUPPORTED_EXTENSIONS,
   SAFARI_BUNDLE_ID,
   extractBundleId,
   extractBundleVersion,
-  fetchSupportedAppPlatforms,
-  findApps,
-  isAppBundle,
-  isolateAppBundle,
+  onPostConfigureApp,
+  onDownloadApp,
   verifyApplicationPlatform,
 } from './app-utils';
 import commands from './commands';
@@ -70,8 +67,6 @@ import {
 const SHUTDOWN_OTHER_FEAT_NAME = 'shutdown_other_sims';
 const CUSTOMIZE_RESULT_BUNDLE_PATH = 'customize_result_bundle_path';
 
-const SUPPORTED_EXTENSIONS = [IPA_EXT, APP_EXT];
-const MAX_ARCHIVE_SCAN_DEPTH = 1;
 const defaultServerCaps = {
   webStorageEnabled: false,
   locationContextEnabled: false,
@@ -1065,107 +1060,12 @@ export class XCUITestDriver extends BaseDriver {
     }
 
     this.opts.app = await this.helpers.configureApp(this.opts.app, {
-      onPostProcess: this.onPostConfigureApp.bind(this),
+      onPostProcess: onPostConfigureApp.bind(this),
+      onDownload: onDownloadApp.bind(this),
       supportedExtensions: SUPPORTED_EXTENSIONS,
     });
   }
 
-  /**
-   * Unzip the given archive and find a matching .app bundle in it
-   *
-   * @param {string} appPath The path to the archive.
-   * @param {number} depth [0] the current nesting depth. App bundles whose nesting level
-   * is greater than 1 are not supported.
-   * @returns {Promise<string>} Full path to the first matching .app bundle..
-   * @throws If no matching .app bundles were found in the provided archive.
-   */
-  async unzipApp(appPath, depth = 0) {
-    if (depth > MAX_ARCHIVE_SCAN_DEPTH) {
-      throw new Error('Nesting of package bundles is not supported');
-    }
-    const [rootDir, matchedPaths] = await findApps(appPath, SUPPORTED_EXTENSIONS);
-    if (_.isEmpty(matchedPaths)) {
-      this.log.debug(`'${path.basename(appPath)}' has no bundles`);
-    } else {
-      this.log.debug(
-        `Found ${util.pluralize('bundle', matchedPaths.length, true)} in ` +
-          `'${path.basename(appPath)}': ${matchedPaths}`,
-      );
-    }
-    try {
-      for (const matchedPath of matchedPaths) {
-        const fullPath = path.join(rootDir, matchedPath);
-        if (await isAppBundle(fullPath)) {
-          const supportedPlatforms = await fetchSupportedAppPlatforms(fullPath);
-          if (this.isSimulator() && !supportedPlatforms.some((p) => _.includes(p, 'Simulator'))) {
-            this.log.info(
-              `'${matchedPath}' does not have Simulator devices in the list of supported platforms ` +
-                `(${supportedPlatforms.join(',')}). Skipping it`,
-            );
-            continue;
-          }
-          if (this.isRealDevice() && !supportedPlatforms.some((p) => _.includes(p, 'OS'))) {
-            this.log.info(
-              `'${matchedPath}' does not have real devices in the list of supported platforms ` +
-                `(${supportedPlatforms.join(',')}). Skipping it`,
-            );
-            continue;
-          }
-          this.log.info(
-            `'${matchedPath}' is the resulting application bundle selected from '${appPath}'`,
-          );
-          return await isolateAppBundle(fullPath);
-        } else if (_.endsWith(_.toLower(fullPath), IPA_EXT) && (await fs.stat(fullPath)).isFile()) {
-          try {
-            return await this.unzipApp(fullPath, depth + 1);
-          } catch (e) {
-            this.log.warn(`Skipping processing of '${matchedPath}': ${e.message}`);
-          }
-        }
-      }
-    } finally {
-      await fs.rimraf(rootDir);
-    }
-    throw new Error(
-      `${this.opts.app} did not have any matching ${APP_EXT} or ${IPA_EXT} ` +
-        `bundles. Please make sure the provided package is valid and contains at least one matching ` +
-        `application bundle which is not nested.`,
-    );
-  }
-
-  async onPostConfigureApp({cachedAppInfo, isUrl, appPath}) {
-    // Pick the previously cached entry if its integrity has been preserved
-    if (
-      _.isPlainObject(cachedAppInfo) &&
-      (await fs.stat(appPath)).isFile() &&
-      (await fs.hash(appPath)) === cachedAppInfo.packageHash &&
-      (await fs.exists(cachedAppInfo.fullPath)) &&
-      (
-        await fs.glob('**/*', {
-          cwd: cachedAppInfo.fullPath,
-        })
-      ).length === cachedAppInfo.integrity.folder
-    ) {
-      this.log.info(`Using '${cachedAppInfo.fullPath}' which was cached from '${appPath}'`);
-      return {appPath: cachedAppInfo.fullPath};
-    }
-
-    // Only local .app bundles that are available in-place should not be cached
-    if (await isAppBundle(appPath)) {
-      return false;
-    }
-
-    // Extract the app bundle and cache it
-    try {
-      return {appPath: await this.unzipApp(appPath)};
-    } finally {
-      // Cleanup previously downloaded archive
-      if (isUrl) {
-        await fs.rimraf(appPath);
-      }
-    }
-  }
-
   async determineDevice() {
     // in the one case where we create a sim, we will set this state
     this.lifecycleData.createSim = false;
@@ -1951,6 +1851,7 @@ export class XCUITestDriver extends BaseDriver {
   /** @deprecated */
   setValueImmediate = commands.elementExtensions.setValueImmediate;
   setValue = commands.elementExtensions.setValue;
+  setValueWithWebAtom = commands.elementExtensions.setValueWithWebAtom;
   keys = commands.elementExtensions.keys;
   clear = commands.elementExtensions.clear;
   getContentSize = commands.elementExtensions.getContentSize;

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "7.12.0",
+  "version": "7.14.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "7.12.0",
+      "version": "7.14.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",
@@ -137,11 +137,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 +209,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 +265,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 +299,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 +922,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 +944,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",
@@ -4217,9 +4217,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.12.0",
+  "version": "7.14.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",