feat: Support prebuiltWDAPath for iOS 17

lib/webdriveragent.js

@@ -1,3 +1,4 @@
+import { retryInterval } from 'asyncbox';
 import _ from 'lodash';
 import path from 'path';
 import url from 'url';
@@ -287,6 +288,73 @@ class WebDriverAgent {
     }
   }
 
+
+  /**
+   * @typedef {Object} LaunchingEnvironmentOptions
+   * @property {number} USE_PORT
+   * @property {string} WDA_PRODUCT_BUNDLE_IDENTIFIER
+   */
+
+  /**
+   * Launch WDA with preinstalled package with 'xcrun devicectl device process launch'.
+   * The WDA package must be prepared properly like published via
+   * https://github.com/appium/WebDriverAgent/releases
+   * with proper sign for this case.
+   *
+   * When we implement launching XCTest service via appium-ios-device,
+   * this implementation can be replaced with it.
+   *
+   * @param {LaunchingEnvironmentOptions}  launchingEnv launching environment for WebDriverAgent.
+   * @return {Promise<void>}
+   */
+
+  async _launchWdaViaDeviceCtl(launchingEnv) {
+    // FIXME: use appium-xcuitest-driver's Devicectl. Maybe it needs to be included in the `this.device`?
+
+    const envVar = {
+      // the port number must be string for the devicectl command.
+      USE_PORT: `${launchingEnv.USE_PORT}`,
+      WDA_PRODUCT_BUNDLE_IDENTIFIER: launchingEnv.WDA_PRODUCT_BUNDLE_IDENTIFIER
+    };
+
+    let xcrunBinnaryPath;
+    try {
+      xcrunBinnaryPath = await fs.which('xcrun');
+    } catch (e) {
+      throw new Error(
+        `xcrun has not been found in PATH. ` +
+          `Please make sure XCode development tools are installed`,
+      );
+    }
+
+    const {stdout} = await exec(xcrunBinnaryPath, [
+      'devicectl',
+      'device',
+      'process',
+      'launch',
+      `--device`, this.device.udid,
+      '--environment-variables', JSON.stringify(envVar),
+      '--terminate-existing',
+      this.bundleIdForXctest
+    ]);
+    this.log.debug(`The output of devicectl command: ${stdout}`);
+
+    // Launching app via decictl does not wait for the app start.
+    // We should wait for the app start by ourselves.
+    try {
+      await retryInterval(30, 1000, async () => {
+        if (_.isNull(await this.getStatus())) {
+          throw new Error();
+        }
+      });
+    } catch (err) {
+      throw new Error(
+        `Failed to start the preinstalled WebDriverAgent in ${30 * 1000} ms.` +
+        `The WebDriverAgent might not be properly built or the device might be locked.`
+      );
+    }
+  }
+
   /**
    * Launch WDA with preinstalled package without xcodebuild.
    * @param {string} sessionId Launch WDA and establish the session with this sessionId
@@ -302,8 +370,12 @@ class WebDriverAgent {
     }
     this.log.info('Launching WebDriverAgent on the device without xcodebuild');
     if (this.isRealDevice) {
-      this.xctestApiClient = new Xctest(this.device.udid, this.bundleIdForXctest, null, {env: xctestEnv});
-      await this.xctestApiClient.start();
+      if (util.compareVersions(this.platformVersion, '>=', '17.0')) {
+        await this._launchWdaViaDeviceCtl(xctestEnv);
+      } else {
+        this.xctestApiClient = new Xctest(this.device.udid, this.bundleIdForXctest, null, {env: xctestEnv});
+        await this.xctestApiClient.start();
+      }
     } else {
       await this.device.simctl.exec('launch', {
         args: [