appium-webdriveragent 12.1.0 → 12.2.0

package/lib/webdriveragent.ts

@@ -1,8 +1,5 @@
 import {waitForCondition} from 'asyncbox';
-import _ from 'lodash';
 import path from 'node:path';
-import url from 'node:url';
-import B from 'bluebird';
 import {JWProxy} from '@appium/base-driver';
 import {fs, util, plist} from '@appium/support';
 import type {AppiumLogger, StringRecord} from '@appium/types';
@@ -34,41 +31,42 @@ const WDA_AGENT_PORT = 8100;
 const WDA_CF_BUNDLE_NAME = 'WebDriverAgentRunner-Runner';
 const SHARED_RESOURCES_GUARD = new AsyncLock();
 const RECENT_MODULE_VERSION_ITEM_NAME = 'recentWdaModuleVersion';
+const URL_PROTOCOL_SEPARATOR = '://';
 
 export class WebDriverAgent {
   bootstrapPath: string;
   agentPath: string;
   readonly args: WebDriverAgentArgs;
-  private readonly log: AppiumLogger;
   readonly device: AppleDevice;
   readonly platformVersion?: string;
   readonly platformName?: string;
   readonly iosSdkVersion?: string;
   readonly host?: string;
   readonly isRealDevice: boolean;
-  private readonly wdaBundlePath?: string;
-  private readonly wdaLocalPort?: number;
   readonly wdaRemotePort: number;
   readonly wdaBaseUrl: string;
   readonly wdaBindingIP?: string;
-  private readonly prebuildWDA?: boolean;
   webDriverAgentUrl?: string;
   started: boolean;
+  updatedWDABundleId?: string;
+  noSessionProxy?: NoSessionProxy;
+  jwproxy?: JWProxy;
+  proxyReqRes?: any;
+  private readonly log: AppiumLogger;
+  private readonly wdaBundlePath?: string;
+  private readonly wdaLocalPort?: number;
+  private readonly prebuildWDA?: boolean;
   private readonly wdaConnectionTimeout?: number;
   private readonly useXctestrunFile?: boolean;
   private readonly usePrebuiltWDA?: boolean;
   private readonly derivedDataPath?: string;
   private readonly mjpegServerPort?: number;
-  updatedWDABundleId?: string;
   private readonly wdaLaunchTimeout: number;
   private readonly usePreinstalledWDA?: boolean;
-  private xctestApiClient?: Xctest | null;
   private readonly updatedWDABundleIdSuffix: string;
+  private xctestApiClient?: Xctest | null;
   private _xcodebuild?: XcodeBuild | null;
-  noSessionProxy?: NoSessionProxy;
-  jwproxy?: JWProxy;
-  proxyReqRes?: any;
-  private _url?: url.UrlWithStringQuery;
+  private _url?: URL;
 
   /**
    * Creates a new WebDriverAgent instance.
@@ -76,7 +74,7 @@ export class WebDriverAgent {
    * @param log - Optional logger instance
    */
   constructor(args: WebDriverAgentArgs, log: AppiumLogger | null = null) {
-    this.args = _.clone(args);
+    this.args = {...args};
     this.log = log ?? defaultLogger;
 
     this.device = args.device;
@@ -185,6 +183,62 @@ export class WebDriverAgent {
     return `${this.updatedWDABundleId ? this.updatedWDABundleId : WDA_RUNNER_BUNDLE_ID}${this.updatedWDABundleIdSuffix}`;
   }
 
+  /**
+   * Gets the base path for the WebDriverAgent URL.
+   * @returns The base path (empty string if root path)
+   */
+  get basePath(): string {
+    if (this.url.pathname === '/') {
+      return '';
+    }
+    return this.url.pathname || '';
+  }
+
+  /**
+   * Gets the WebDriverAgent URL.
+   * Constructs the URL from webDriverAgentUrl if provided, otherwise
+   * builds it from wdaBaseUrl, wdaBindingIP, and wdaLocalPort.
+   * @returns The parsed URL object
+   */
+  get url(): URL {
+    if (!this._url) {
+      if (this.webDriverAgentUrl) {
+        this._url = this.toUrl(this.webDriverAgentUrl);
+      } else {
+        const port = this.wdaLocalPort || WDA_AGENT_PORT;
+        const parsedBaseUrl = this.toUrl(this.wdaBaseUrl || WDA_BASE_URL);
+        this._url = new URL(
+          `${parsedBaseUrl.protocol}//${this.wdaBindingIP || parsedBaseUrl.hostname}:${port}`,
+        );
+      }
+    }
+    return this._url;
+  }
+
+  /**
+   * Gets whether WebDriverAgent has fully started.
+   * @returns `true` if WDA has started, `false` otherwise
+   */
+  get fullyStarted(): boolean {
+    return this.started;
+  }
+
+  /**
+   * Sets whether WebDriverAgent has fully started.
+   * @param started - `true` if WDA has started, `false` otherwise
+   */
+  set fullyStarted(started: boolean) {
+    this.started = started ?? false;
+  }
+
+  /**
+   * Sets the WebDriverAgent URL.
+   * @param _url - The URL string to parse and set
+   */
+  set url(_url: string) {
+    this._url = this.toUrl(_url);
+  }
+
   /**
    * Cleans up obsolete cached processes from previous WDA sessions
    * that are listening on the same port but belong to different devices.
@@ -197,7 +251,7 @@ export class WebDriverAgent {
         !cmdLine.toLowerCase().includes(this.device.udid.toLowerCase()),
     );
 
-    if (_.isEmpty(obsoletePids)) {
+    if (obsoletePids.length === 0) {
       this.log.debug(
         `No obsolete cached processes from previous WDA sessions ` +
           `listening on port ${this.url.port} have been found`,
@@ -220,14 +274,6 @@ export class WebDriverAgent {
   }
 
   /**
-   * Gets the base path for the WebDriverAgent URL.
-   * @returns The base path (empty string if root path)
-   */
-  get basePath(): string {
-    if (this.url.path === '/') {
-      return '';
-    }
-    return this.url.path || '';
   }
 
   /**
@@ -307,56 +353,10 @@ export class WebDriverAgent {
    * @returns `true` if source is fresh (all required files exist), `false` otherwise
    */
   async isSourceFresh(): Promise<boolean> {
-    const existsPromises = ['Resources', `Resources${path.sep}WebDriverAgent.bundle`].map(
+    const existsPromises = ['Resources', path.join('Resources', 'WebDriverAgent.bundle')].map(
       (subPath) => fs.exists(path.resolve(this.bootstrapPath, subPath)),
     );
-    return (await B.all(existsPromises)).some((v) => v === false);
-  }
-
-  private async parseBundleId(wdaBundlePath: string): Promise<string> {
-    const infoPlistPath = path.join(wdaBundlePath, 'Info.plist');
-    const infoPlist = (await plist.parsePlist(await fs.readFile(infoPlistPath))) as {
-      CFBundleIdentifier?: string;
-    };
-    if (!infoPlist.CFBundleIdentifier) {
-      throw new Error(`Could not find bundle id in '${infoPlistPath}'`);
-    }
-    return infoPlist.CFBundleIdentifier;
-  }
-
-  private async fetchWDABundle(): Promise<string> {
-    if (!this.derivedDataPath) {
-      return await bundleWDASim(this.xcodebuild);
-    }
-    const wdaBundlePaths = await fs.glob(`${this.derivedDataPath}/**/*${WDA_RUNNER_APP}/`, {
-      absolute: true,
-    });
-    if (_.isEmpty(wdaBundlePaths)) {
-      throw new Error(`Could not find the WDA bundle in '${this.derivedDataPath}'`);
-    }
-    return wdaBundlePaths[0];
-  }
-
-  private setupProxies(sessionId: string): void {
-    const proxyOpts: any = {
-      log: this.log,
-      server: this.url.hostname ?? undefined,
-      port: parseInt(this.url.port ?? '', 10) || undefined,
-      base: this.basePath,
-      timeout: this.wdaConnectionTimeout,
-      keepAlive: true,
-      scheme: this.url.protocol ? this.url.protocol.replace(':', '') : 'http',
-      headers: this.args.extraRequestHeaders,
-    };
-    if (this.args.reqBasePath) {
-      proxyOpts.reqBasePath = this.args.reqBasePath;
-    }
-
-    this.jwproxy = new JWProxy(proxyOpts);
-    this.jwproxy.sessionId = sessionId;
-    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);
-
-    this.noSessionProxy = new NoSessionProxy(proxyOpts);
+    return (await Promise.all(existsPromises)).every((v) => v === true);
   }
 
   /**
@@ -401,49 +401,6 @@ export class WebDriverAgent {
     }
   }
 
-  /**
-   * Gets the WebDriverAgent URL.
-   * Constructs the URL from webDriverAgentUrl if provided, otherwise
-   * builds it from wdaBaseUrl, wdaBindingIP, and wdaLocalPort.
-   * @returns The parsed URL object
-   */
-  get url(): url.UrlWithStringQuery {
-    if (!this._url) {
-      if (this.webDriverAgentUrl) {
-        this._url = url.parse(this.webDriverAgentUrl);
-      } else {
-        const port = this.wdaLocalPort || WDA_AGENT_PORT;
-        const {protocol, hostname} = url.parse(this.wdaBaseUrl || WDA_BASE_URL);
-        this._url = url.parse(`${protocol}//${this.wdaBindingIP || hostname}:${port}`);
-      }
-    }
-    return this._url;
-  }
-
-  /**
-   * Sets the WebDriverAgent URL.
-   * @param _url - The URL string to parse and set
-   */
-  set url(_url: string) {
-    this._url = url.parse(_url);
-  }
-
-  /**
-   * Gets whether WebDriverAgent has fully started.
-   * @returns `true` if WDA has started, `false` otherwise
-   */
-  get fullyStarted(): boolean {
-    return this.started;
-  }
-
-  /**
-   * Sets whether WebDriverAgent has fully started.
-   * @param started - `true` if WDA has started, `false` otherwise
-   */
-  set fullyStarted(started: boolean) {
-    this.started = started ?? false;
-  }
-
   /**
    * Retrieves the Xcode derived data path for WebDriverAgent.
    * @returns The derived data path, or `undefined` if xcodebuild is skipped
@@ -497,7 +454,7 @@ export class WebDriverAgent {
     if (
       actualUpgradeTimestamp &&
       upgradedAt &&
-      _.toLower(`${actualUpgradeTimestamp}`) !== _.toLower(`${upgradedAt}`)
+      `${actualUpgradeTimestamp}`.toLowerCase() !== `${upgradedAt}`.toLowerCase()
     ) {
       this.log.info(
         'Will uninstall running WDA since it has different version in comparison to the one ' +
@@ -523,6 +480,64 @@ export class WebDriverAgent {
     await this.uninstall();
   }
 
+  private async parseBundleId(wdaBundlePath: string): Promise<string> {
+    const infoPlistPath = path.join(wdaBundlePath, 'Info.plist');
+    const infoPlist = (await plist.parsePlist(await fs.readFile(infoPlistPath))) as {
+      CFBundleIdentifier?: string;
+    };
+    if (!infoPlist.CFBundleIdentifier) {
+      throw new Error(`Could not find bundle id in '${infoPlistPath}'`);
+    }
+    return infoPlist.CFBundleIdentifier;
+  }
+
+  private async fetchWDABundle(): Promise<string> {
+    if (!this.derivedDataPath) {
+      return await bundleWDASim(this.xcodebuild);
+    }
+    const wdaBundlePaths = await fs.glob(`${this.derivedDataPath}/**/*${WDA_RUNNER_APP}/`, {
+      absolute: true,
+    });
+    if (wdaBundlePaths.length === 0) {
+      throw new Error(`Could not find the WDA bundle in '${this.derivedDataPath}'`);
+    }
+    return wdaBundlePaths[0];
+  }
+
+  private setupProxies(sessionId: string): void {
+    const proxyOpts: any = {
+      log: this.log,
+      server: this.url.hostname ?? undefined,
+      port: parseInt(this.url.port ?? '', 10) || undefined,
+      base: this.basePath,
+      timeout: this.wdaConnectionTimeout,
+      keepAlive: true,
+      scheme: this.url.protocol ? this.url.protocol.replace(':', '') : 'http',
+      headers: this.args.extraRequestHeaders,
+    };
+    if (this.args.reqBasePath) {
+      proxyOpts.reqBasePath = this.args.reqBasePath;
+    }
+
+    this.jwproxy = new JWProxy(proxyOpts);
+    this.jwproxy.sessionId = sessionId;
+    this.proxyReqRes = this.jwproxy.proxyReqRes.bind(this.jwproxy);
+
+    this.noSessionProxy = new NoSessionProxy(proxyOpts);
+  }
+
+  private toUrl(value: string): URL {
+    // Treat values without `://` as host/path inputs and normalize to http.
+    if (!value.includes(URL_PROTOCOL_SEPARATOR)) {
+      return new URL(`http://${value}`);
+    }
+    try {
+      return new URL(value);
+    } catch {
+      throw new Error(`Invalid URL: ${value}`);
+    }
+  }
+
   private setWDAPaths(bootstrapPath?: string, agentPath?: string): void {
     // allow the user to specify a place for WDA. This is undocumented and
     // only here for the purposes of testing development of WDA
@@ -572,7 +587,7 @@ export class WebDriverAgent {
     const sendGetStatus = async () =>
       (await noSessionProxy.command('/status', 'GET')) as StringRecord;
 
-    if (_.isNil(timeoutMs) || timeoutMs <= 0) {
+    if (timeoutMs == null || timeoutMs <= 0) {
       try {
         return await sendGetStatus();
       } catch (err: any) {
@@ -619,7 +634,7 @@ export class WebDriverAgent {
   private async uninstall(): Promise<void> {
     try {
       const bundleIds = await this.device.getUserInstalledBundleIdsByBundleName(WDA_CF_BUNDLE_NAME);
-      if (_.isEmpty(bundleIds)) {
+      if (bundleIds.length === 0) {
         this.log.debug('No WDAs on the device.');
         return;
       }

package/lib/xcodebuild.ts

@@ -3,15 +3,15 @@ import {SubProcess, exec} from 'teen_process';
 import {logger, timing} from '@appium/support';
 import type {AppiumLogger, StringRecord} from '@appium/types';
 import {log as defaultLogger} from './logger';
-import B from 'bluebird';
 import {
   setRealDeviceSecurity,
   setXctestrunFile,
   killProcess,
   getWDAUpgradeTimestamp,
   isTvOS,
+  escapeRegExp,
+  truncateString,
 } from './utils';
-import _ from 'lodash';
 import path from 'node:path';
 import {WDA_RUNNER_BUNDLE_ID} from './constants';
 import type {AppleDevice, XcodeBuildArgs} from './types';
@@ -30,7 +30,7 @@ const IGNORED_ERRORS = [
   'Failed to remove screenshot at path',
 ];
 const IGNORED_ERRORS_PATTERN = new RegExp(
-  '(' + IGNORED_ERRORS.map((errStr) => _.escapeRegExp(errStr)).join('|') + ')',
+  '(' + IGNORED_ERRORS.map((errStr) => escapeRegExp(errStr)).join('|') + ')',
 );
 
 const RUNNER_SCHEME_TV = 'WebDriverAgentRunner_tvOS';
@@ -44,27 +44,28 @@ const xcodeLog = logger.getLogger('Xcode');
 export class XcodeBuild {
   xcodebuild?: SubProcess;
   readonly device: AppleDevice;
-  private readonly log: AppiumLogger;
   readonly realDevice: boolean;
   readonly agentPath: string;
   readonly bootstrapPath: string;
   readonly platformVersion?: string;
   readonly platformName?: string;
   readonly iosSdkVersion?: string;
+  readonly xcodeSigningId: string;
+  usePrebuiltWDA?: boolean;
+  derivedDataPath?: string;
+  agentUrl?: string;
+  private readonly log: AppiumLogger;
   private readonly showXcodeLog?: boolean;
   private readonly xcodeConfigFile?: string;
   private readonly xcodeOrgId?: string;
-  readonly xcodeSigningId: string;
   private readonly keychainPath?: string;
   private readonly keychainPassword?: string;
-  usePrebuiltWDA?: boolean;
   private readonly useSimpleBuildTest?: boolean;
   private readonly useXctestrunFile?: boolean;
   private readonly launchTimeout?: number;
   private readonly wdaRemotePort?: number;
   private readonly wdaBindingIP?: string;
   private readonly updatedWDABundleId?: string;
-  derivedDataPath?: string;
   private readonly mjpegServerPort?: number;
   private readonly prebuildDelay: number;
   private readonly allowProvisioningDeviceRegistration?: boolean;
@@ -75,7 +76,6 @@ export class XcodeBuild {
   private _derivedDataPathPromise?: Promise<string | undefined>;
   private noSessionProxy?: NoSessionProxy;
   private xctestrunFilePath?: string;
-  agentUrl?: string;
 
   /**
    * Creates a new XcodeBuild instance.
@@ -119,7 +119,8 @@ export class XcodeBuild {
 
     this.mjpegServerPort = args.mjpegServerPort;
 
-    this.prebuildDelay = _.isNumber(args.prebuildDelay) ? args.prebuildDelay : PREBUILD_DELAY;
+    this.prebuildDelay =
+      typeof args.prebuildDelay === 'number' ? args.prebuildDelay : PREBUILD_DELAY;
 
     this.allowProvisioningDeviceRegistration = args.allowProvisioningDeviceRegistration;
 
@@ -183,7 +184,7 @@ export class XcodeBuild {
       const pattern = /^\s*BUILD_DIR\s+=\s+(\/.*)/m;
       const match = pattern.exec(stdout);
       if (!match) {
-        this.log.warn(`Cannot parse WDA build dir from ${_.truncate(stdout, {length: 300})}`);
+        this.log.warn(`Cannot parse WDA build dir from ${truncateString(stdout, 300)}`);
         return;
       }
       this.log.debug(`Parsed BUILD_DIR configuration value: '${match[1]}'`);
@@ -207,7 +208,7 @@ export class XcodeBuild {
 
     if (this.prebuildDelay > 0) {
       // pause a moment
-      await B.delay(this.prebuildDelay);
+      await new Promise((resolve) => setTimeout(resolve, this.prebuildDelay));
     }
   }
 
@@ -242,7 +243,7 @@ export class XcodeBuild {
       throw new Error('xcodebuild subprocess was not created');
     }
     const xcodebuild = this.xcodebuild;
-    return await new B((resolve, reject) => {
+    return await new Promise<StringRecord | void>((resolve, reject) => {
       xcodebuild.once('exit', (code, signal) => {
         xcodeLog.error(`xcodebuild exited with code '${code}' and signal '${signal}'`);
         xcodebuild.removeAllListeners();
@@ -415,9 +416,10 @@ export class XcodeBuild {
     });
 
     let logXcodeOutput = !!this.showXcodeLog;
-    const logMsg = _.isBoolean(this.showXcodeLog)
-      ? `Output from xcodebuild ${this.showXcodeLog ? 'will' : 'will not'} be logged`
-      : 'Output from xcodebuild will only be logged if any errors are present there';
+    const logMsg =
+      typeof this.showXcodeLog === 'boolean'
+        ? `Output from xcodebuild ${this.showXcodeLog ? 'will' : 'will not'} be logged`
+        : 'Output from xcodebuild will only be logged if any errors are present there';
     this.log.debug(`${logMsg}. To change this, use 'showXcodeLog' desired capability`);
 
     const onStreamLine = (line: string) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-webdriveragent",
-  "version": "12.1.0",
+  "version": "12.2.0",
   "description": "Package bundling WebDriverAgent",
   "main": "./build/lib/index.js",
   "types": "./build/lib/index.d.ts",
@@ -54,16 +54,14 @@
     "@appium/types": "^1.0.0-rc.1",
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/bluebird": "^3.5.38",
-    "@types/lodash": "^4.14.196",
     "@types/mocha": "^10.0.1",
     "@types/node": "^25.0.0",
     "appium-xcode": "^6.0.0",
     "chai": "^6.0.0",
     "chai-as-promised": "^8.0.0",
     "conventional-changelog-conventionalcommits": "^9.0.0",
-    "node-simctl": "^8.0.0",
     "mocha": "^11.0.1",
+    "node-simctl": "^8.0.0",
     "prettier": "^3.0.0",
     "semantic-release": "^25.0.2",
     "semver": "^7.3.7",
@@ -80,8 +78,6 @@
     "async-lock": "^1.0.0",
     "asyncbox": "^6.1.0",
     "axios": "^1.4.0",
-    "bluebird": "^3.5.5",
-    "lodash": "^4.17.11",
     "teen_process": "^4.0.7"
   },
   "files": [