appium-xcuitest-driver 9.8.1 → 9.9.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [9.9.0](https://github.com/appium/appium-xcuitest-driver/compare/v9.8.1...v9.9.0) (2025-06-26)
+
+### Features
+
+* add download-wda-sim to download prebuilt WDA for Sim ([#2587](https://github.com/appium/appium-xcuitest-driver/issues/2587)) ([c1fb5a4](https://github.com/appium/appium-xcuitest-driver/commit/c1fb5a4df52cc8d8816c0a362916570d8236275d))
+
 ## [9.8.1](https://github.com/appium/appium-xcuitest-driver/compare/v9.8.0...v9.8.1) (2025-06-25)
 
 ### Miscellaneous Chores

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "9.8.1",
+  "version": "9.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "9.8.1",
+      "version": "9.9.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^0.x",
@@ -480,9 +480,9 @@
       "license": "MIT"
     },
     "node_modules/@types/lodash": {
-      "version": "4.17.18",
-      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.18.tgz",
-      "integrity": "sha512-KJ65INaxqxmU6EoCiJmRPZC9H9RVWCRd349tXM2M3O5NA7cY6YL7c0bHAHQ93NOfTObEQ004kd2QVHs/r0+m4g==",
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-NYqRyg/hIQrYPT9lbOeYc3kIRabJDn/k4qQHIXUpx88CBDww2fD15Sg5kbXlW86zm2XEW4g0QxkTI3/Kfkc7xQ==",
       "license": "MIT"
     },
     "node_modules/@types/node": {

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "9.8.1",
+  "version": "9.9.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -33,7 +33,8 @@
     "scripts": {
       "build-wda": "./scripts/build-wda.js",
       "open-wda": "./scripts/open-wda.js",
-      "tunnel-creation": "./scripts/tunnel-creation.mjs"
+      "tunnel-creation": "./scripts/tunnel-creation.mjs",
+      "download-wda-sim": "./scripts/download-wda-sim.mjs"
     },
     "schema": {
       "$schema": "http://json-schema.org/draft-07/schema",

package/scripts/build-wda.js

@@ -3,20 +3,10 @@ const xcode = require('appium-xcode');
 const {Simctl} = require('node-simctl');
 const {getSimulator} = require('appium-ios-simulator');
 const {logger} = require('appium/support');
+const {parseArgValue} = require('./utils');
 
 const log = logger.getLogger('WDA');
 
-function parseArgValue(argName) {
-  const argNamePattern = new RegExp(`^--${argName}\\b`);
-  for (let i = 1; i < process.argv.length; ++i) {
-    const arg = process.argv[i];
-    if (argNamePattern.test(arg)) {
-      return arg.includes('=') ? arg.split('=')[1] : process.argv[i + 1];
-    }
-  }
-  return null;
-}
-
 async function build() {
   const customDevice = parseArgValue('name');
   const xcodeVersion = await xcode.getVersion(true);

package/scripts/download-wda-sim.mjs

@@ -0,0 +1,68 @@
+import {fs, logger, zip, net, node} from 'appium/support.js';
+import _ from 'lodash';
+import os from 'os';
+import path from 'path';
+import {parseArgValue} from './utils.js';
+
+const log = logger.getLogger('download-wda-sim');
+const wdaUrl = (version, zipFileName) =>
+  `https://github.com/appium/WebDriverAgent/releases/download/v${version}/${zipFileName}`;
+const destZip = (platform) => {
+  const scheme = `WebDriverAgentRunner${_.toLower(platform) === 'tvos' ? '_tvOS' : ''}`;
+  return `${scheme}-Build-Sim-${os.arch() === 'arm64' ? 'arm64' : 'x86_64'}.zip`;
+};
+
+/**
+ * Return installed appium-webdriveragent package version
+ * @returns {number}
+ */
+async function webdriveragentPkgVersion() {
+  const pkgPath = path.join(
+    node.getModuleRootSync('appium-xcuitest-driver', import.meta.url),
+    'node_modules',
+    'appium-webdriveragent',
+    'package.json'
+  );
+  return JSON.parse(await fs.readFile(pkgPath, 'utf8')).version;
+};
+
+/**
+ * Prepare the working root directory.
+ * @returns {string} Root directory to download and unzip.
+ */
+async function prepareRootDir() {
+  const destDirRoot = parseArgValue('outdir');
+  if (!destDirRoot) {
+    throw new Error(`--outdir is required`);
+  }
+  const destDir = path.resolve(process.cwd(), destDirRoot);
+  if (await fs.exists(destDir)) {
+    throw new Error(`${destDir} already exists`);
+  }
+  await fs.mkdir(destDir, {recursive: true});
+  return destDir;
+}
+
+async function getWDAPrebuiltPackage() {
+  const destDir = await prepareRootDir();
+  const platform = parseArgValue('platform');
+  const zipFileName = destZip(platform);
+  const wdaVersion = await webdriveragentPkgVersion();
+  const urlToDownload = wdaUrl(wdaVersion, zipFileName);
+  const downloadedZipFile = path.join(destDir, zipFileName);
+  try {
+    log.info(`Downloading ${urlToDownload}`);
+    await net.downloadFile(urlToDownload, downloadedZipFile);
+
+    log.info(`Unpacking ${downloadedZipFile} into ${destDir}`);
+    await zip.extractAllTo(downloadedZipFile, destDir);
+
+    log.info(`Deleting ${downloadedZipFile}`);
+  } finally {
+    if (await fs.exists(downloadedZipFile)) {
+      await fs.unlink(downloadedZipFile);
+    }
+  }
+}
+
+(async () => await getWDAPrebuiltPackage())();

package/scripts/tunnel-creation.mjs

@@ -3,7 +3,7 @@
  * Test script for creating lockdown service, starting CoreDeviceProxy, and creating tunnel
  * This script demonstrates the tunnel creation workflow for all connected devices
  */
-import {logger, node} from '@appium/support';
+import {logger, node} from 'appium/support.js';
 import _ from 'lodash';
 /* eslint-disable import/no-unresolved */
 import {

package/scripts/utils.js

@@ -0,0 +1,16 @@
+/**
+ * Get the value of the given argument name.
+ *
+ * @param {string} argName
+ * @returns {string?} The value of the given 'argName'.
+ */
+export function parseArgValue(argName) {
+  const argNamePattern = new RegExp(`^--${argName}\\b`);
+  for (let i = 1; i < process.argv.length; ++i) {
+    const arg = process.argv[i];
+    if (argNamePattern.test(arg)) {
+      return arg.includes('=') ? arg.split('=')[1] : process.argv[i + 1];
+    }
+  }
+  return null;
+}