appium-xcuitest-driver 10.8.3 → 10.9.0

package/lib/commands/log.js

@@ -1,13 +1,13 @@
 import _ from 'lodash';
 import B from 'bluebird';
 import {DEFAULT_WS_PATHNAME_PREFIX} from 'appium/driver';
-import {IOSCrashLog} from '../device-log/ios-crash-log';
-import {IOSSimulatorLog} from '../device-log/ios-simulator-log';
-import {IOSDeviceLog} from '../device-log/ios-device-log';
+import {IOSCrashLog} from '../device/log/ios-crash-log';
+import {IOSSimulatorLog} from '../device/log/ios-simulator-log';
+import {IOSDeviceLog} from '../device/log/ios-device-log';
 import WebSocket from 'ws';
-import { SafariConsoleLog } from '../device-log/safari-console-log';
-import { SafariNetworkLog } from '../device-log/safari-network-log';
-import { toLogEntry } from '../device-log/helpers';
+import { SafariConsoleLog } from '../device/log/safari-console-log';
+import { SafariNetworkLog } from '../device/log/safari-network-log';
+import { toLogEntry } from '../device/log/helpers';
 import { NATIVE_WIN } from '../utils';
 import { BIDI_EVENT_NAME } from './bidi/constants';
 import { makeLogEntryAddedEvent } from './bidi/models';
@@ -119,7 +119,7 @@ export async function startLogCapture() {
     [this.logs.syslog,] = assignBiDiLogListener.bind(this)(
       this.isRealDevice()
         ? new IOSDeviceLog({
-          udid: this.opts.udid,
+          udid: /** @type {string} */ (this.opts.udid),
           showLogs: this.opts.showIOSLog,
           log: this.log,
         })

package/lib/commands/memory.js

@@ -14,7 +14,7 @@ export async function mobileSendMemoryWarning(bundleId) {
     throw new Error('Memory warning simulation is only supported on real devices');
   }
 
-  const device = /** @type {import('../real-device').RealDevice} */ (this.device);
+  const device = /** @type {import('../device/real-device-management').RealDevice} */ (this.device);
 
   const appInfos = await device.devicectl.listApps(bundleId);
   if (_.isEmpty(appInfos)) {

package/lib/commands/notifications.js

@@ -34,7 +34,7 @@ export async function mobilePushNotification(bundleId, payload) {
         `Got ${JSON.stringify(payload.aps)} instead`,
     );
   }
-  return await /** @type {import('../driver').Simulator} */ (this.device).pushNotification({
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).pushNotification({
     ...payload,
     'Simulator Target Bundle': bundleId,
   });

package/lib/commands/pasteboard.js

@@ -16,7 +16,7 @@ export async function mobileSetPasteboard(content, encoding = 'utf8') {
     // can be empty string
     throw new Error('Pasteboard content is mandatory to set');
   }
-  return await /** @type {import('../driver').Simulator} */ (this.device).simctl.setPasteboard(
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.setPasteboard(
     content, /** @type {BufferEncoding} */ (encoding)
   );
 }
@@ -34,7 +34,7 @@ export async function mobileGetPasteboard(encoding = 'utf8') {
   if (!this.isSimulator()) {
     throw new Error('Getting pasteboard content is not supported on real devices');
   }
-  return await /** @type {import('../driver').Simulator} */ (this.device).simctl.getPasteboard(encoding);
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getPasteboard(encoding);
 }
 
 /**

package/lib/commands/pcap.js

@@ -1,4 +1,4 @@
-import { Pyidevice } from '../real-device-clients/py-ios-device-client';
+import { Pyidevice } from '../device/clients/py-ios-device-client';
 import {fs, tempDir, util} from 'appium/support';
 import {encodeBase64OrUpload} from '../utils';
 import {errors} from 'appium/driver';

package/lib/commands/performance.js

@@ -3,7 +3,6 @@ import path from 'path';
 import {fs, zip, logger, util, tempDir} from 'appium/support';
 import {SubProcess, exec} from 'teen_process';
 import {encodeBase64OrUpload} from '../utils';
-import { XCRUN, requireXcrun } from '../xcrun';
 import {waitForCondition} from 'asyncbox';
 import B from 'bluebird';
 
@@ -20,6 +19,7 @@ const DEFAULT_EXT = '.trace';
 const DEFAULT_PID = 'current';
 const INSTRUMENTS = 'instruments';
 const XCTRACE = 'xctrace';
+const XCRUN = 'xcrun';
 
 /**
  * Starts performance profiling for the device under test.
@@ -387,6 +387,17 @@ export class PerfRecorder {
   }
 }
 
+async function requireXcrun() {
+  try {
+    return await fs.which(XCRUN);
+  } catch {
+    throw new Error(
+      `${XCRUN} has not been found in PATH. ` +
+        `Please make sure XCode development tools are installed`,
+    );
+  }
+}
+
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  */

package/lib/commands/permissions.js

@@ -55,7 +55,7 @@ export async function mobileGetPermission(bundleId, service) {
   assertSimulator(this);
 
   return /** @type {import('./types').PermissionState} */ (
-    await /** @type {import('../driver').Simulator} */ (this.device).getPermission(
+    await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).getPermission(
       bundleId, String(service)
     )
   );
@@ -77,7 +77,7 @@ export async function mobileSetPermissions(access, bundleId) {
   }
   assertSimulator(this);
 
-  await /** @type {import('../driver').Simulator} */ (this.device).setPermissions(bundleId, access);
+  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).setPermissions(bundleId, access);
 }
 
 /**

package/lib/commands/proxy-helper.js

@@ -69,9 +69,6 @@ export async function proxyCommand(url, method, body, isSessionCommand = true) {
     );
   }
 
-  if (!this.wda) {
-    throw new Error('Cannot call proxyCommand without WDA driver active');
-  }
   const proxy = isSessionCommand ? this.wda.jwproxy : this.wda.noSessionProxy;
   if (!proxy) {
     throw new Error('Cannot call proxyCommand without WDA proxy active');

package/lib/commands/screenshots.js

@@ -60,7 +60,7 @@ export async function getScreenshot() {
   // simulator attempt
   if (this.isSimulator()) {
     this.log.info(`Falling back to 'simctl io screenshot' API`);
-    const payload = await /** @type {import('../driver').Simulator} */ (this.device).simctl.getScreenshot();
+    const payload = await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.getScreenshot();
     if (!payload) {
       throw new errors.UnableToCaptureScreen();
     }

package/lib/commands/simctl.js

@@ -53,7 +53,7 @@ export async function mobileSimctl(command, args = [], timeout = undefined) {
       `Available subcommands are ${SUBCOMMANDS_HAS_DEVICE.join(',')}`);
   }
 
-  return await /** @type {import('./../driver').Simulator} */ (this.device).simctl.exec(
+  return await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).simctl.exec(
     command,
     {args: [this.opts.udid, ...args], timeout}
   );

package/lib/commands/web.js

@@ -960,7 +960,7 @@ export async function mobileUpdateSafariPreferences(preferences) {
   }
 
   this.log.debug(`About to update Safari preferences: ${JSON.stringify(preferences)}`);
-  await /** @type {import('../driver').Simulator} */ (this.device).updateSafariSettings(preferences);
+  await /** @type {import('appium-ios-simulator').Simulator} */ (this.device).updateSafariSettings(preferences);
 }
 
 /**

package/lib/commands/xctest-record-screen.js

@@ -32,7 +32,7 @@ const SUBDIRECTORY = 'Attachments';
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromSimulator(uuid) {
-  const device = /** @type {import('../driver').Simulator} */ (this.device);
+  const device = /** @type {import('appium-ios-simulator').Simulator} */ (this.device);
   const dataRoot = /** @type {string} */ (device.getDir());
   // On Simulators the path looks like
   // $HOME/Library/Developer/CoreSimulator/Devices/F8E1968A-8443-4A9A-AB86-27C54C36A2F6/data/Containers/Data/InternalDaemon/4E3FE8DF-AD0A-41DA-B6EC-C35E5798C219/Attachments/A044DAF7-4A58-4CD5-95C3-29B4FE80C377
@@ -58,7 +58,7 @@ async function retrieveRecodingFromSimulator(uuid) {
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromRealDevice(uuid) {
-  const device = /** @type {import('../real-device').RealDevice} */ (this.device);
+  const device = /** @type {import('../device/real-device-management').RealDevice} */ (this.device);
 
   const fileNames = await device.devicectl.listFiles(DOMAIN_TYPE, DOMAIN_IDENTIFIER, {
     username: USERNAME,

package/lib/{desired-caps.js → desired-caps.ts}

@@ -1,8 +1,10 @@
+import type {Constraints} from '@appium/types';
+
 // These platform names should be valid in simulator name
-const PLATFORM_NAME_IOS = 'iOS';
-const PLATFORM_NAME_TVOS = 'tvOS';
+export const PLATFORM_NAME_IOS = 'iOS';
+export const PLATFORM_NAME_TVOS = 'tvOS';
 
-const desiredCapConstraints = /** @type {const} */ ({
+export const desiredCapConstraints = {
   platformName: {
     // override
     presence: true,
@@ -391,7 +393,6 @@ const desiredCapConstraints = /** @type {const} */ ({
     isString: true,
     inclusionCaseInsensitive: ['none', 'eager', 'normal']
   }
-});
+} as const satisfies Constraints;
 
-export {desiredCapConstraints, PLATFORM_NAME_IOS, PLATFORM_NAME_TVOS};
-export default desiredCapConstraints;
+export type XCUITestDriverConstraints = typeof desiredCapConstraints;

package/lib/{real-device-clients → device/clients}/py-ios-device-client.ts

@@ -4,7 +4,7 @@ import path from 'path';
 import { BaseDeviceClient } from './base-device-client';
 import type { BaseDeviceClientOptions, InstallProfileArgs } from './base-device-client';
 import type { TeenProcessExecResult } from 'teen_process';
-import type { CertificateList } from '../commands/types';
+import type { CertificateList } from '../../commands/types';
 
 // https://github.com/YueChen-C/py-ios-device
 

package/lib/{device-connections-factory.js → device/device-connections-factory.ts}

@@ -5,30 +5,39 @@ import {logger, util, timing} from 'appium/support';
 import {utilities} from 'appium-ios-device';
 import {checkPortStatus} from 'portscanner';
 import {waitForCondition} from 'asyncbox';
+import type { AppiumLogger } from '@appium/types';
 
 const LOCALHOST = '127.0.0.1';
 
 class iProxy {
-  constructor(udid, localport, deviceport) {
-    this.localport = parseInt(localport, 10);
-    this.deviceport = parseInt(deviceport, 10);
+  private readonly localport: number;
+  private readonly deviceport: number;
+  private readonly udid: string;
+  private localServer: net.Server | null;
+  private readonly log: AppiumLogger;
+  private onBeforeProcessExit: (() => void) | null;
+
+  constructor(udid: string, localport: string | number, deviceport: string | number) {
+    this.localport = parseInt(String(localport), 10);
+    this.deviceport = parseInt(String(deviceport), 10);
     this.udid = udid;
     this.localServer = null;
     this.log = logger.getLogger(`iProxy@${udid.substring(0, 8)}:${this.localport}`);
+    this.onBeforeProcessExit = null;
   }
 
-  async start() {
+  async start(): Promise<void> {
     if (this.localServer) {
       return;
     }
 
-    this.localServer = net.createServer(async (localSocket) => {
-      let remoteSocket;
+    this.localServer = net.createServer(async (localSocket: net.Socket) => {
+      let remoteSocket: any;
       try {
         // We can only connect to the remote socket after the local socket connection succeeds
         remoteSocket = await utilities.connectPort(this.udid, this.deviceport);
       } catch (e) {
-        this.log.debug(e.message);
+        this.log.debug((e as Error).message);
         localSocket.destroy();
         return;
       }
@@ -42,19 +51,23 @@ class iProxy {
         localSocket.destroy();
       });
       // not all remote socket errors are critical for the user
-      remoteSocket.on('error', (e) => this.log.debug(e));
+      remoteSocket.on('error', (e: Error) => this.log.debug(e));
       localSocket.once('end', destroyCommChannel);
       localSocket.once('close', () => {
         destroyCommChannel();
         remoteSocket.destroy();
       });
-      localSocket.on('error', (e) => this.log.warn(e.message));
+      localSocket.on('error', (e: Error) => this.log.warn(e.message));
       localSocket.pipe(remoteSocket);
       remoteSocket.pipe(localSocket);
     });
-    const listeningPromise = new B((resolve, reject) => {
-      /** @type {net.Server} */ (this.localServer).once('listening', resolve);
-      /** @type {net.Server} */ (this.localServer).once('error', reject);
+    const listeningPromise = new B<void>((resolve, reject) => {
+      if (this.localServer) {
+        this.localServer.once('listening', resolve);
+        this.localServer.once('error', reject);
+      } else {
+        reject(new Error('Local server is not initialized'));
+      }
     });
     this.localServer.listen(this.localport);
     try {
@@ -63,8 +76,8 @@ class iProxy {
       this.localServer = null;
       throw e;
     }
-    this.localServer.on('error', (e) => this.log.warn(e.message));
-    this.localServer.once('close', (e) => {
+    this.localServer.on('error', (e: Error) => this.log.warn(e.message));
+    this.localServer.once('close', (e?: Error) => {
       if (e) {
         this.log.info(`The connection has been closed with error ${e.message}`);
       } else {
@@ -75,20 +88,12 @@ class iProxy {
 
     this.onBeforeProcessExit = this._closeLocalServer.bind(this);
     // Make sure we free up the socket on process exit
-    process.on('beforeExit', this.onBeforeProcessExit);
-  }
-
-  _closeLocalServer() {
-    if (!this.localServer) {
-      return;
+    if (this.onBeforeProcessExit) {
+      process.on('beforeExit', this.onBeforeProcessExit);
     }
-
-    this.log.debug(`Closing the connection`);
-    this.localServer.close();
-    this.localServer = null;
   }
 
-  stop() {
+  stop(): void {
     if (this.onBeforeProcessExit) {
       process.off('beforeExit', this.onBeforeProcessExit);
       this.onBeforeProcessExit = null;
@@ -96,43 +101,34 @@ class iProxy {
 
     this._closeLocalServer();
   }
+
+  private _closeLocalServer(): void {
+    if (!this.localServer) {
+      return;
+    }
+
+    this.log.debug(`Closing the connection`);
+    this.localServer.close();
+    this.localServer = null;
+  }
 }
 
 const log = logger.getLogger('DevCon Factory');
 const PORT_CLOSE_TIMEOUT = 15 * 1000; // 15 seconds
 const SPLITTER = ':';
 
-class DeviceConnectionsFactory {
+export class DeviceConnectionsFactory {
+  private _connectionsMapping: ConnectionMapping;
+
   constructor() {
     this._connectionsMapping = {};
   }
 
-  _udidAsToken(udid) {
-    return `${util.hasValue(udid) ? udid : ''}${SPLITTER}`;
-  }
-
-  _portAsToken(port) {
-    return `${SPLITTER}${util.hasValue(port) ? port : ''}`;
-  }
-
-  _toKey(udid = null, port = null) {
-    return `${util.hasValue(udid) ? udid : ''}${SPLITTER}${util.hasValue(port) ? port : ''}`;
-  }
-
-  _releaseProxiedConnections(connectionKeys) {
-    const keys = connectionKeys.filter((k) => _.has(this._connectionsMapping[k], 'iproxy'));
-    for (const key of keys) {
-      log.info(`Releasing the listener for '${key}'`);
-      try {
-        this._connectionsMapping[key].iproxy.stop();
-      } catch (e) {
-        log.debug(e);
-      }
-    }
-    return keys;
-  }
-
-  listConnections(udid = null, port = null, strict = false) {
+  listConnections(
+    udid: string | null = null,
+    port: string | number | null = null,
+    strict: boolean = false
+  ): string[] {
     if (!udid && !port) {
       return [];
     }
@@ -149,7 +145,11 @@ class DeviceConnectionsFactory {
     );
   }
 
-  async requestConnection(udid, port, options = {}) {
+  async requestConnection(
+    udid?: string | null,
+    port?: string | number | null,
+    options: RequestConnectionOptions = {}
+  ): Promise<void> {
     if (!udid || !port) {
       log.warn('Did not know how to request the connection:');
       if (!udid) {
@@ -174,7 +174,7 @@ class DeviceConnectionsFactory {
     }
 
     if (usePortForwarding) {
-      let isPortBusy = (await checkPortStatus(port, LOCALHOST)) === 'open';
+      let isPortBusy = (await checkPortStatus(Number(port), LOCALHOST)) === 'open';
       if (isPortBusy) {
         log.warn(`Port #${port} is busy. Did you quit the previous driver session(s) properly?`);
         if (!_.isEmpty(connectionsOnPort)) {
@@ -187,7 +187,7 @@ class DeviceConnectionsFactory {
             await waitForCondition(
               async () => {
                 try {
-                  if ((await checkPortStatus(port, LOCALHOST)) !== 'open') {
+                  if ((await checkPortStatus(Number(port), LOCALHOST)) !== 'open') {
                     log.info(
                       `Port #${port} has been successfully released after ` +
                         `${timer.getDuration().asMilliSeconds.toFixed(0)}ms`,
@@ -221,7 +221,10 @@ class DeviceConnectionsFactory {
     }
     const currentKey = this._toKey(udid, port);
     if (usePortForwarding) {
-      const iproxy = new iProxy(udid, port, devicePort);
+      if (!_.isInteger(devicePort)) {
+        throw new Error('devicePort is required when usePortForwarding is true');
+      }
+      const iproxy = new iProxy(udid, port, Number(devicePort));
       try {
         await iproxy.start();
         this._connectionsMapping[currentKey] = {iproxy};
@@ -239,7 +242,7 @@ class DeviceConnectionsFactory {
     log.info(`Successfully requested the connection for ${currentKey}`);
   }
 
-  releaseConnection(udid = null, port = null) {
+  releaseConnection(udid: string | null = null, port: string | number | null = null): void {
     if (!udid && !port) {
       log.warn(
         'Neither device UDID nor local port is set. ' +
@@ -261,9 +264,42 @@ class DeviceConnectionsFactory {
     }
     log.debug(`Cached connections count: ${_.size(this._connectionsMapping)}`);
   }
+
+  private _udidAsToken(udid?: string | null): string {
+    return `${util.hasValue(udid) ? udid : ''}${SPLITTER}`;
+  }
+
+  private _portAsToken(port?: string | number | null): string {
+    return `${SPLITTER}${util.hasValue(port) ? port : ''}`;
+  }
+
+  private _toKey(udid: string | null = null, port: string | number | null = null): string {
+    return `${util.hasValue(udid) ? udid : ''}${SPLITTER}${util.hasValue(port) ? port : ''}`;
+  }
+
+  private _releaseProxiedConnections(connectionKeys: string[]): string[] {
+    const keys = connectionKeys.filter((k) => _.has(this._connectionsMapping[k], 'iproxy'));
+    for (const key of keys) {
+      log.info(`Releasing the listener for '${key}'`);
+      try {
+        this._connectionsMapping[key].iproxy?.stop();
+      } catch (e) {
+        log.debug(e);
+      }
+    }
+    return keys;
+  }
 }
 
-const DEVICE_CONNECTIONS_FACTORY = new DeviceConnectionsFactory();
+export const DEVICE_CONNECTIONS_FACTORY = new DeviceConnectionsFactory();
+
+interface ConnectionMapping {
+  [key: string]: {
+    iproxy?: iProxy;
+  };
+}
 
-export {DEVICE_CONNECTIONS_FACTORY, DeviceConnectionsFactory};
-export default DEVICE_CONNECTIONS_FACTORY;
+interface RequestConnectionOptions {
+  usePortForwarding?: boolean;
+  devicePort?: number | null;
+}

package/lib/{device-log → device/log}/helpers.ts

@@ -1,4 +1,4 @@
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 import { fs } from 'appium/support';
 import { createInterface } from 'node:readline';
 import _ from 'lodash';

package/lib/{device-log → device/log}/ios-crash-log.ts

@@ -2,13 +2,13 @@ import {fs, tempDir, util} from 'appium/support';
 import B from 'bluebird';
 import path from 'path';
 import _ from 'lodash';
-import {Pyidevice} from '../real-device-clients/py-ios-device-client';
+import {Pyidevice} from '../clients/py-ios-device-client';
 import {IOSLog} from './ios-log';
 import { toLogEntry, grepFile } from './helpers';
 import type { AppiumLogger } from '@appium/types';
-import type { BaseDeviceClient } from '../real-device-clients/base-device-client';
+import type { BaseDeviceClient } from '../clients/base-device-client';
 import type { Simulator } from 'appium-ios-simulator';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 // The file format has been changed from '.crash' to '.ips' since Monterey.
 const CRASH_REPORTS_GLOB_PATTERN = '**/*.@(crash|ips)';

package/lib/{device-log → device/log}/ios-log.ts

@@ -1,6 +1,6 @@
 import {EventEmitter} from 'events';
 import { LRUCache } from 'lru-cache';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 import type { AppiumLogger } from '@appium/types';
 import {logger} from 'appium/support';
 

package/lib/{device-log → device/log}/line-consuming-log.ts

@@ -1,6 +1,6 @@
 import {IOSLog} from './ios-log';
 import { toLogEntry } from './helpers';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 type TSerializedEntry = [string, number];
 

package/lib/{device-log → device/log}/safari-console-log.ts

@@ -7,7 +7,7 @@ import {
   MAX_BUFFERED_EVENTS_COUNT
 } from './helpers';
 import { IOSLog } from './ios-log';
-import type { LogEntry } from '../commands/types';
+import type { LogEntry } from '../../commands/types';
 
 const LOG_LEVELS_MAP = {
   error: 'SEVERE',