appium-webdriveragent 10.1.3 → 10.2.0

package/lib/webdriveragent.js

@@ -36,11 +36,10 @@ export class WebDriverAgent {
 
   /**
    * @param {import('appium-xcode').XcodeVersion} xcodeVersion
-   * // TODO: make args typed
-   * @param {import('@appium/types').StringRecord} [args={}]
+   * @param {import('./types').WebDriverAgentArgs} args
    * @param {import('@appium/types').AppiumLogger?} [log=null]
    */
-  constructor (xcodeVersion, args = {}, log = null) {
+  constructor (xcodeVersion, args, log = null) {
     this.xcodeVersion = xcodeVersion;
 
     this.args = _.clone(args);
@@ -52,7 +51,7 @@ export class WebDriverAgent {
     this.iosSdkVersion = args.iosSdkVersion;
     this.host = args.host;
     this.isRealDevice = !!args.realDevice;
-    this.idb = (args.device || {}).idb;
+    this.idb = args.device.idb;
     this.wdaBundlePath = args.wdaBundlePath;
 
     this.setWDAPaths(args.bootstrapPath, args.agentPath);
@@ -61,7 +60,7 @@ export class WebDriverAgent {
     this.wdaRemotePort = ((this.isRealDevice ? args.wdaRemotePort : null) ?? args.wdaLocalPort)
       || WDA_AGENT_PORT;
     this.wdaBaseUrl = args.wdaBaseUrl || WDA_BASE_URL;
-
+    this.wdaBindingIP = args.wdaBindingIP;
     this.prebuildWDA = args.prebuildWDA;
 
     // this.args.webDriverAgentUrl guiarantees the capabilities acually
@@ -105,6 +104,7 @@ export class WebDriverAgent {
         updatedWDABundleId: this.updatedWDABundleId,
         launchTimeout: this.wdaLaunchTimeout,
         wdaRemotePort: this.wdaRemotePort,
+        wdaBindingIP: this.wdaBindingIP,
         useXctestrunFile: this.useXctestrunFile,
         derivedDataPath: args.derivedDataPath,
         mjpegServerPort: this.mjpegServerPort,
@@ -121,7 +121,7 @@ export class WebDriverAgent {
   get canSkipXcodebuild () {
     // Use this.args.webDriverAgentUrl to guarantee
     // the capabilities set gave the `appium:webDriverAgentUrl`.
-    return this.usePreinstalledWDA || this.args.webDriverAgentUrl;
+    return this.usePreinstalledWDA || !!this.args.webDriverAgentUrl;
   }
 
   /**
@@ -391,12 +391,15 @@ export class WebDriverAgent {
     if (this.mjpegServerPort) {
       xctestEnv.MJPEG_SERVER_PORT = this.mjpegServerPort;
     }
+    if (this.wdaBindingIP) {
+      xctestEnv.USE_IP = this.wdaBindingIP;
+    }
     this.log.info('Launching WebDriverAgent on the device without xcodebuild');
     if (this.isRealDevice) {
       // Current method to launch WDA process can be done via 'xcrun devicectl',
       // but it has limitation about the WDA preinstalled package.
       // https://github.com/appium/appium/issues/19206#issuecomment-2014182674
-      if (util.compareVersions(this.platformVersion, '>=', '17.0')) {
+      if (this.platformVersion && util.compareVersions(this.platformVersion, '>=', '17.0')) {
         await this._launchViaDevicectl({env: xctestEnv});
       } else {
         this.xctestApiClient = new Xctest(this.device.udid, this.bundleIdForXctest, null, {env: xctestEnv});
@@ -631,7 +634,7 @@ export class WebDriverAgent {
     if (!this.args.webDriverAgentUrl) {
       // if we populated the url ourselves (during `setupCaching` call, for instance)
       // then clean that up. If the url was supplied, we want to keep it
-      this.webDriverAgentUrl = null;
+      this.webDriverAgentUrl = undefined;
     }
   }
 

package/lib/xcodebuild.js

@@ -47,12 +47,11 @@ export class XcodeBuild {
 
   /**
    * @param {import('appium-xcode').XcodeVersion} xcodeVersion
-   * @param {any} device
-   * // TODO: make args typed
-   * @param {import('@appium/types').StringRecord} [args={}]
-   * @param {import('@appium/types').AppiumLogger?} [log=null]
+   * @param {import('./types').AppleDevice} device
+   * @param {import('./types').XcodeBuildArgs} args
+   * @param {import('@appium/types').AppiumLogger | null} [log=null]
    */
-  constructor (xcodeVersion, device, args = {}, log = null) {
+  constructor (xcodeVersion, device, args, log = null) {
     this.xcodeVersion = xcodeVersion;
 
     this.device = device;
@@ -84,6 +83,7 @@ export class XcodeBuild {
     this.launchTimeout = args.launchTimeout;
 
     this.wdaRemotePort = args.wdaRemotePort;
+    this.wdaBindingIP = args.wdaBindingIP;
 
     this.updatedWDABundleId = args.updatedWDABundleId;
     this.derivedDataPath = args.derivedDataPath;
@@ -110,13 +110,20 @@ export class XcodeBuild {
     this.noSessionProxy = noSessionProxy;
 
     if (this.useXctestrunFile) {
-      const deviveInfo = {
-        isRealDevice: this.realDevice,
+      /** @type {import('./utils').DeviceInfo} */
+      const deviceInfo = {
+        isRealDevice: !!this.realDevice,
         udid: this.device.udid,
-        platformVersion: this.platformVersion,
-        platformName: this.platformName
+        platformVersion: this.platformVersion || '',
+        platformName: this.platformName || ''
       };
-      this.xctestrunFilePath = await setXctestrunFile(deviveInfo, this.iosSdkVersion, this.bootstrapPath, this.wdaRemotePort);
+      this.xctestrunFilePath = await setXctestrunFile({
+          deviceInfo,
+          sdkVersion: this.iosSdkVersion || '',
+          bootstrapPath: this.bootstrapPath,
+          wdaRemotePort: this.wdaRemotePort || 8100,
+          wdaBindingIP: this.wdaBindingIP
+        });
       return;
     }
 
@@ -200,8 +207,8 @@ export class XcodeBuild {
    * @returns {Promise<void>}
    */
   async cleanProject () {
-    const libScheme = isTvOS(this.platformName) ? LIB_SCHEME_TV : LIB_SCHEME_IOS;
-    const runnerScheme = isTvOS(this.platformName) ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
+    const libScheme = isTvOS(this.platformName || '') ? LIB_SCHEME_TV : LIB_SCHEME_IOS;
+    const runnerScheme = isTvOS(this.platformName || '') ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
 
     for (const scheme of [libScheme, runnerScheme]) {
       this.log.debug(`Cleaning the project scheme '${scheme}' to make sure there are no leftovers from previous installs`);
@@ -249,7 +256,7 @@ export class XcodeBuild {
     if (this.useXctestrunFile && this.xctestrunFilePath) {
       args.push('-xctestrun', this.xctestrunFilePath);
     } else {
-      const runnerScheme = isTvOS(this.platformName) ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
+      const runnerScheme = isTvOS(this.platformName || '') ? RUNNER_SCHEME_TV : RUNNER_SCHEME_IOS;
       args.push('-project', this.agentPath, '-scheme', runnerScheme);
       if (this.derivedDataPath) {
         args.push('-derivedDataPath', this.derivedDataPath);
@@ -257,14 +264,16 @@ export class XcodeBuild {
     }
     args.push('-destination', `id=${this.device.udid}`);
 
-    const versionMatch = new RegExp(/^(\d+)\.(\d+)/).exec(this.platformVersion);
-    if (versionMatch) {
+    let versionMatch;
+    if (this.platformVersion && (versionMatch = new RegExp(/^(\d+)\.(\d+)/).exec(this.platformVersion))) {
       args.push(
-        `${isTvOS(this.platformName) ? 'TV' : 'IPHONE'}OS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`
+        `${isTvOS(this.platformName || '') ? 'TV' : 'IPHONE'}OS_DEPLOYMENT_TARGET=${versionMatch[1]}.${versionMatch[2]}`
       );
     } else {
-      this.log.warn(`Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
-        'Will build for the default platform instead');
+      this.log.warn(
+        `Cannot parse major and minor version numbers from platformVersion "${this.platformVersion}". ` +
+        'Will build for the default platform instead'
+      );
     }
 
     if (this.realDevice) {
@@ -413,10 +422,11 @@ export class XcodeBuild {
    */
   async waitForStart (timer) {
     // try to connect once every 0.5 seconds, until `launchTimeout` is up
-    this.log.debug(`Waiting up to ${this.launchTimeout}ms for WebDriverAgent to start`);
+    const timeout = this.launchTimeout || 60000; // Default to 60 seconds if not set
+    this.log.debug(`Waiting up to ${timeout}ms for WebDriverAgent to start`);
     let currentStatus = null;
     try {
-      const retries = Math.trunc(this.launchTimeout / 500);
+      const retries = Math.trunc(timeout / 500);
       await retryInterval(retries, 1000, async () => {
         if (this._didProcessExit) {
           // there has been an error elsewhere and we need to short-circuit
@@ -448,7 +458,7 @@ export class XcodeBuild {
     } catch (err) {
       this.log.debug(err.stack);
       throw new Error(
-        `We were not able to retrieve the /status response from the WebDriverAgent server after ${this.launchTimeout}ms timeout.` +
+        `We were not able to retrieve the /status response from the WebDriverAgent server after ${timeout}ms timeout.` +
         `Try to increase the value of 'appium:wdaLaunchTimeout' capability as a possible workaround.`
       );
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "10.1.3",
+  "version": "10.2.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",