fix: Replace the deprecated url.parse with new URL (#2735)

Author: mykola-mokhnach

lib/commands/recordscreen.ts

@@ -4,7 +4,6 @@ import {SubProcess} from 'teen_process';
 import {encodeBase64OrUpload} from '../utils';
 import {WDA_BASE_URL} from 'appium-webdriveragent';
 import {waitForCondition} from 'asyncbox';
-import url from 'node:url';
 import type {XCUITestDriver} from '../driver';
 import type {StartRecordingScreenOptions, StopRecordingScreenOptions} from './types';
 import type {WDASettings} from 'appium-webdriveragent';
@@ -86,7 +85,7 @@ export class ScreenRecorder {
   private mainProcess: SubProcess | null;
   private timeoutHandler: NodeJS.Timeout | null;
 
-  constructor(udid: string, log: any, videoPath: string, opts: ScreenRecorderOptions = {}) {
+  constructor(udid: string, log: any, videoPath: string, opts: ScreenRecorderOptions) {
     this.videoPath = videoPath;
     this.log = log;
     this.opts = opts;
@@ -144,8 +143,8 @@ export class ScreenRecorder {
     if ((videoFps && videoType === 'libx264') || videoTypeHWAccel) {
       args.push('-r', String(videoFps));
     }
-    const {protocol, hostname} = url.parse(remoteUrl || '');
-    args.push('-i', `${protocol}//${hostname}:${remotePort}`);
+    const parsed = new URL(remoteUrl);
+    args.push('-i', `${parsed.protocol}//${parsed.hostname}:${remotePort}`);
 
     if (videoFilters || videoScale) {
       args.push('-vf', videoFilters || `${scaleFilterHWAccel || 'scale'}=${videoScale}`);
@@ -283,10 +282,9 @@ export async function startRecordingScreen(
     suffix: MP4_EXT,
   });
 
-  const wdaBaseUrl = this.opts.wdaBaseUrl || WDA_BASE_URL;
   const screenRecorder = new ScreenRecorder(this.device.udid, this.log, videoPath, {
     remotePort: this.opts.mjpegServerPort || DEFAULT_MJPEG_SERVER_PORT,
-    remoteUrl: wdaBaseUrl,
+    remoteUrl: this.opts.wdaBaseUrl || WDA_BASE_URL,
     videoType,
     videoFilters,
     videoScale,
@@ -405,8 +403,8 @@ export async function stopRecordingScreen(
 
 interface ScreenRecorderOptions {
   hardwareAcceleration?: string;
-  remotePort?: number;
-  remoteUrl?: string;
+  remotePort: number;
+  remoteUrl: string;
   videoFps?: number;
   videoType?: string;
   videoScale?: string;

lib/driver.ts

@@ -20,7 +20,6 @@ import _ from 'lodash';
 import {LRUCache} from 'lru-cache';
 import EventEmitter from 'node:events';
 import path from 'node:path';
-import url from 'node:url';
 import {
   SUPPORTED_EXTENSIONS,
   SAFARI_BUNDLE_ID,
@@ -616,8 +615,9 @@ export class XCUITestDriver
     }
 
     if (_.isString(caps.webDriverAgentUrl)) {
-      const {protocol, host} = url.parse(caps.webDriverAgentUrl);
-      if (_.isEmpty(protocol) || _.isEmpty(host)) {
+      try {
+        new URL(caps.webDriverAgentUrl);
+      } catch {
         throw this.log.errorWithException(
           `'webDriverAgentUrl' capability is expected to contain a valid WebDriverAgent server URL. ` +
             `'${caps.webDriverAgentUrl}' is given instead`,

lib/utils.ts

@@ -5,7 +5,6 @@ import B from 'bluebird';
 import _ from 'lodash';
 import os from 'node:os';
 import path from 'node:path';
-import url from 'node:url';
 import * as semver from 'semver';
 import {exec} from 'teen_process';
 import {log} from './logger';
@@ -381,15 +380,23 @@ export async function removeAllSessionWebSocketHandlers(this: XCUITestDriver): P
   }
 }
 
+const LOCALHOST_HOSTNAMES = [
+  'localhost',
+  '127.0.0.1',
+  // WHATWG URL normalizes IPv6 hostnames with brackets and hex (e.g. ::ffff:127.0.0.1 -> ::ffff:7f00:1)
+  '[::1]',
+  '[::ffff:7f00:1]',
+];
+
 /**
  * Returns true if the urlString is localhost
  * @param urlString
  * @returns Return true if the urlString is localhost
  */
 export function isLocalHost(urlString: string): boolean {
   try {
-    const hostname = url.parse(urlString).hostname as string;
-    return ['localhost', '127.0.0.1', '::1', '::ffff:127.0.0.1'].includes(hostname);
+    const hostname = new URL(urlString).hostname;
+    return LOCALHOST_HOSTNAMES.includes(hostname);
   } catch {
     log.warn(`'${urlString}' cannot be parsed as a valid URL`);
   }