appium-xcuitest-driver 5.14.2 → 5.15.1

package/lib/devicectl.js

@@ -0,0 +1,174 @@
+import {exec, SubProcess} from 'teen_process';
+import {util} from 'appium/support';
+import _ from 'lodash';
+
+const XCRUN = 'xcrun';
+
+/**
+ * @typedef {Object} ProcessInfo
+ * @property {number} processIdentifier
+ * @property {string} executable
+ */
+
+/*
+  Example:
+    {
+      "executable" : "file:///sbin/launchd",
+      "processIdentifier" : 1
+    },
+*/
+
+/**
+ * @typedef {Object} AppInfo
+ * @property {boolean} appClip
+ * @property {boolean} builtByDeveloper
+ * @property {string} bundleIdentifier
+ * @property {string} bundleVersion
+ * @property {boolean} defaultApp
+ * @property {boolean} hidden
+ * @property {boolean} internalApp
+ * @property {string} name
+ * @property {boolean} removable
+ * @property {string} url
+ * @property {string} version
+ */
+
+/*
+  Example:
+    {
+      "appClip" : false,
+      "builtByDeveloper" : false,
+      "bundleIdentifier" : "com.apple.mobilesafari",
+      "bundleVersion" : "8617.1.17.10.9",
+      "defaultApp" : true,
+      "hidden" : false,
+      "internalApp" : false,
+      "name" : "Safari",
+      "removable" : false,
+      "url" : "file:///Applications/MobileSafari.app/",
+      "version" : "17.2"
+    }
+*/
+
+/**
+ * @typedef {Object} ExecuteOptions
+ * @property {boolean} [logStdout=false]
+ * @property {boolean} [asJson=true]
+ * @property {boolean} [asynchronous=false]
+ * @property {string[]|string} [subcommandOptions]
+ */
+
+/**
+ * @typedef {{asynchronous: true}} TAsyncOpts
+ */
+
+export class Devicectl {
+  /**
+   * @since Xcode 15, iOS 17
+   * @param {string} udid
+   * @param {import('@appium/types').AppiumLogger} log
+   */
+  constructor(udid, log) {
+    this.udid = udid;
+    this.log = log;
+  }
+
+  /**
+   * @template {ExecuteOptions} TExecOpts
+   * @param {string[]} subcommand
+   * @param {TExecOpts} [opts]
+   * @return {Promise<TExecOpts extends TAsyncOpts ? import('teen_process').SubProcess : import('teen_process').TeenProcessExecResult>}
+   */
+  async execute(subcommand, opts) {
+    const {
+      logStdout = false,
+      asynchronous = false,
+      asJson = true,
+      subcommandOptions,
+    } = opts ?? {};
+
+    const finalArgs = [
+      'devicectl', ...subcommand,
+      '--device', this.udid,
+    ];
+    if (subcommandOptions && !_.isEmpty(subcommandOptions)) {
+      finalArgs.push(
+        ...(Array.isArray(subcommandOptions) ? subcommandOptions : [subcommandOptions])
+      );
+    }
+    if (asJson) {
+      finalArgs.push('--quiet', '--json-output', '-');
+    }
+    const cmdStr = util.quote([XCRUN, ...finalArgs]);
+    this.log.debug(`Executing ${cmdStr}`);
+    try {
+      if (asynchronous) {
+        const result = new SubProcess(XCRUN, finalArgs);
+        await result.start(0);
+        // @ts-ignore TS does not understand it
+        return result;
+      }
+      const result = await exec(XCRUN, finalArgs);
+      if (logStdout) {
+        this.log.debug(`Command output: ${result.stdout}`);
+      }
+      // @ts-ignore TS does not understand it
+      return result;
+    } catch (e) {
+      throw new Error(`'${cmdStr}' failed. Original error: ${e.stderr || e.stdout || e.message}`);
+    }
+  }
+
+  /**
+   * Simulates memory warning for the process with the given PID
+   *
+   * @param {number|string} pid The process identifier to simulate the Low Memory warning for
+   * @return {Promise<void>}
+   */
+  async sendMemoryWarning(pid) {
+    await this.execute(['device', 'process', 'sendMemoryWarning'], {
+      subcommandOptions: ['--pid', `${pid}`]
+    });
+  }
+
+  /**
+   * Lists running processes on the device
+   *
+   * @returns {Promise<ProcessInfo[]>}
+   */
+  async listProcesses() {
+    const {stdout} = await this.execute(['device', 'info', 'processes']);
+    return JSON.parse(stdout).result.runningProcesses;
+  }
+
+  /**
+   * Send POSIX signal to the running process
+   *
+   * @param {number|string} pid The process identifier to send a signal to
+   * @param {number|string} signal The signal to send to a process. See 'man signal' for a list of signals
+   * @returns {Promise<void>}
+   */
+  async sendSignalToProcess(pid, signal) {
+    await this.execute(['device', 'process', 'signal'], {
+      subcommandOptions: ['--signal', `${signal}`, '--pid', `${pid}`]
+    });
+  }
+
+  /**
+   * Retrieves the list of installed apps from the device
+   *
+   * @param {string?} [bundleId=null] Provide the target bundle identifier
+   * to speed up the lookup.
+   * @returns {Promise<AppInfo[]>} Empty array is returned if no matching apps are found
+   */
+  async listApps(bundleId = null) {
+    const subcommandOptions = ['--include-all-apps'];
+    if (bundleId) {
+      subcommandOptions.push('--bundle-id', bundleId);
+    }
+    const {stdout} = await this.execute(['device', 'info', 'apps'], {
+      subcommandOptions,
+    });
+    return JSON.parse(stdout).result.apps;
+  }
+}

package/lib/driver.js

@@ -1946,6 +1946,12 @@ class XCUITestDriver extends BaseDriver {
   pullFolder = commands.fileMovementExtensions.pullFolder;
   mobilePullFolder = commands.fileMovementExtensions.mobilePullFolder;
 
+  /*--------+
+   | MEMORY |
+   +--------+*/
+
+  mobileSendMemoryWarning = commands.memoryExtensions.mobileSendMemoryWarning;
+
   /*------+
    | FIND |
    +------+*/

package/lib/execute-method-map.ts

@@ -19,6 +19,12 @@ export const executeMethodMap = {
       optional: ['offset'],
     },
   },
+  'mobile: sendMemoryWarning': {
+    command: 'mobileSendMemoryWarning',
+    params: {
+      required: ['bundleId'],
+    },
+  },
   // https://developer.apple.com/documentation/xctest/xcuielement/1618668-swipeleft?language=objc
   // https://developer.apple.com/documentation/xctest/xcuielement/1618674-swiperight?language=objc
   // https://developer.apple.com/documentation/xctest/xcuielement/1618667-swipeup?language=objc

package/lib/ios-deploy.js

@@ -7,7 +7,7 @@ import _ from 'lodash';
 import {exec} from 'teen_process';
 import {extractBundleId} from './app-utils';
 import {pushFolder} from './ios-fs-helpers';
-import { requireXcrun } from './xcrun';
+import { Devicectl } from './devicectl';
 
 const APPLICATION_INSTALLED_NOTIFICATION = 'com.apple.mobile.application_installed';
 const INSTALLATION_STAGING_DIR = 'PublicStaging';
@@ -211,40 +211,15 @@ class IOSDeploy {
       if (util.compareVersions(platformVersion, '>=', '17.0')) {
         log.debug(`Calling devicectl to kill the process`);
 
-        // FIXME: replace `devicectl` command with a wrapper later
-        // or remove after implementing appium-ios-device for iOS 17+.
-
-        const xcrunBinnaryPath = await requireXcrun();
-        const {stdout} = await exec(xcrunBinnaryPath, [
-          'devicectl',
-          'device',
-          'info',
-          'processes',
-          `--device`, this.udid
-        ]);
-        // Each line has spaces. devicectl has JSON output option, but it writes it to a file only.
-        // Here parse the standard output directly.
-        // e.g.:
-        // 823   /private/var/containers/Bundle/Application/8E748312-8CBE-4C13-8295-C2EF3ED2C0C1/WebDriverAgentRunner-Runner.app/WebDriverAgentRunner-Runner
-        // 824   /Applications/MobileSafari.app/MobileSafari
-        // 825   /usr/libexec/debugserver
-        const executableLine = stdout.split('\n').find((line) => line.trim().endsWith(executableName));
-        if (!executableLine) {
+        const devicectl = new Devicectl(this.udid, log);
+        const pids = (await devicectl.listProcesses())
+          .filter(({executable}) => executable.endsWith(`/${executableName}`))
+          .map(({processIdentifier}) => processIdentifier);
+        if (_.isEmpty(pids)) {
           log.info(`The process of the bundle id '${bundleId}' was not running`);
           return false;
         }
-        await exec(xcrunBinnaryPath, [
-          'devicectl',
-          'device',
-          'process',
-          'signal',
-          '-s', `2`,
-          // e.g.
-          // '824   /Applications/MobileSafari.app/MobileSafari              '
-          // ' 999   /Applications/MobileSafari.app/MobileSafari              '  (can include spaces in the top)
-          '-p', `${executableLine.trim().split(/\s+/)[0]}`,
-          `--device`, this.udid
-        ]);
+        await devicectl.sendSignalToProcess(pids[0], 2);
       } else {
         instrumentService = await services.startInstrumentService(this.udid);
         const processes = await instrumentService.callChannel(

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "5.14.2",
+  "version": "5.15.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "5.14.2",
+      "version": "5.15.1",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
@@ -14,7 +14,7 @@
         "appium-ios-device": "^2.5.4",
         "appium-ios-simulator": "^5.5.1",
         "appium-remote-debugger": "^10.0.0",
-        "appium-webdriveragent": "^5.15.5",
+        "appium-webdriveragent": "~5.15.9",
         "appium-xcode": "^5.1.4",
         "async-lock": "^1.4.0",
         "asyncbox": "^3.0.0",
@@ -829,9 +829,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.11.7",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.7.tgz",
-      "integrity": "sha512-GPmeN1C3XAyV5uybAf4cMLWT9fDWcmQhZVtMFu7OR32WjrqGG+Wnk2V1d0bmtUyE/Zy1QJ9BxyiTih9z8Oks8A==",
+      "version": "20.11.14",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.14.tgz",
+      "integrity": "sha512-w3yWCcwULefjP9DmDDsgUskrMoOy5Z8MiwKHr1FvqGPtx7CvJzQvxD7eKpxNtklQxLruxSXWddyeRtyud0RcXQ==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }
@@ -1064,9 +1064,9 @@
       }
     },
     "node_modules/appium-webdriveragent": {
-      "version": "5.15.8",
-      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-5.15.8.tgz",
-      "integrity": "sha512-LUEoJFP49Jhh6uk1oFRUl/F/cmaLjpwWS6yWJ00+CkUYD6fbVco5JNA5lQJWgRf84Y2OuRkJktSLtcEO5jIjtg==",
+      "version": "5.15.9",
+      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-5.15.9.tgz",
+      "integrity": "sha512-03brYer2B68V+Jqjy8VVYNEeDftSzizZaXGazZsAq1ENDhvXgzIErKWjFAswTQWu/ciDmXASt8I96K6ks+Gy0A==",
       "dependencies": {
         "@appium/base-driver": "^9.0.0",
         "@appium/strongbox": "^0.x",

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "5.14.2",
+  "version": "5.15.1",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -81,7 +81,7 @@
     "appium-ios-device": "^2.5.4",
     "appium-ios-simulator": "^5.5.1",
     "appium-remote-debugger": "^10.0.0",
-    "appium-webdriveragent": "^5.15.5",
+    "appium-webdriveragent": "~5.15.9",
     "appium-xcode": "^5.1.4",
     "async-lock": "^1.4.0",
     "asyncbox": "^3.0.0",