@limrun/appium-xcuitest-driver 10.11.0-lim.3 → 10.14.6-lim.1

package/lib/driver.ts

@@ -21,6 +21,8 @@ import {LRUCache} from 'lru-cache';
 import EventEmitter from 'node:events';
 import path from 'node:path';
 import url from 'node:url';
+import {Ios} from '@limrun/api';
+import {setLimrunIosClient} from 'appium-xcode';
 import {
   SUPPORTED_EXTENSIONS,
   SAFARI_BUNDLE_ID,
@@ -41,7 +43,7 @@ import * as clipboardCommands from './commands/clipboard';
 import * as conditionCommands from './commands/condition';
 import * as contentSizeCommands from './commands/content-size';
 import * as contextCommands from './commands/context';
-import * as deviceInfoCommands from './commands/deviceInfo';
+import * as deviceInfoCommands from './commands/device-info';
 import * as elementCommands from './commands/element';
 import * as executeCommands from './commands/execute';
 import * as fileMovementCommands from './commands/file-movement';
@@ -121,7 +123,7 @@ import type { PerfRecorder } from './commands/performance';
 import type { AudioRecorder } from './commands/record-audio';
 import type { TrafficCapture } from './commands/pcap';
 import type { ScreenRecorder } from './commands/recordscreen';
-import type { DVTServiceWithConnection } from './commands/condition.js';
+import type { DVTServiceWithConnection } from 'appium-ios-remotexpc';
 import type { IOSDeviceLog } from './device/log/ios-device-log';
 import type { IOSSimulatorLog } from './device/log/ios-simulator-log';
 import type { IOSCrashLog } from './device/log/ios-crash-log';
@@ -242,8 +244,6 @@ const MEMOIZED_FUNCTIONS = ['getStatusBarHeight', 'getDevicePixelRatio', 'getScr
 // Capabilities that do not have xcodebuild process
 const CAP_NAMES_NO_XCODEBUILD_REQUIRED = ['webDriverAgentUrl', 'usePreinstalledWDA'];
 
-const BUNDLE_VERSION_PATTERN = /CFBundleVersion\s+=\s+"?([^(;|")]+)/;
-
 export class XCUITestDriver
   extends BaseDriver<XCUITestDriverConstraints, StringRecord>
   implements ExternalDriver<XCUITestDriverConstraints, FullContext|string, StringRecord> {
@@ -278,7 +278,7 @@ export class XCUITestDriver
   _device: Simulator | RealDevice;
   _iosSdkVersion: string | null;
   _wda: WebDriverAgent | null;
-  remote: RemoteDebugger | null;
+  _remote: RemoteDebugger | null;
   logs: DriverLogs;
   _bidiServerLogListener: LogListener | undefined;
 
@@ -293,6 +293,7 @@ export class XCUITestDriver
   pageLoadMs: number;
   landscapeWebCoordsOffset: number;
   mjpegStream?: mjpeg.MJpegStream;
+  _limClient?: Ios.InstanceClient;
 
   constructor(opts: XCUITestDriverOpts, shouldValidateCaps = true) {
     super(opts, shouldValidateCaps);
@@ -337,10 +338,20 @@ export class XCUITestDriver
     this.lifecycleData = {};
     this._audioRecorder = null;
     this.appInfosCache = new AppInfosCache(this.log);
-    this.remote = null;
+    this._remote = null;
     this.doesSupportBidi = true;
     this._wda = null;
   }
+  /**
+   * Gets the Limrun iOS instance client.
+   * @throws {Error} If the client has not been initialized.
+   */
+  get limClient(): Ios.InstanceClient {
+    if (!this._limClient) {
+      throw new Error('Limrun client not initialized. Ensure limInstanceApiUrl and limInstanceToken capabilities are provided.');
+    }
+    return this._limClient;
+  }
 
   // Override methods from BaseDriver
   override async createSession(
@@ -358,6 +369,15 @@ export class XCUITestDriver
       if (this.mergeCliArgsToOpts()) {
         this.validateDesiredCaps({...caps, ...this.cliArgs});
       }
+      if (!this.opts.limInstanceApiUrl || !this.opts.limInstanceToken) {
+        throw new Error('limInstanceApiUrl and limInstanceToken are required');
+      }
+      this._limClient = await Ios.createInstanceClient({
+        apiUrl: this.opts.limInstanceApiUrl,
+        token: this.opts.limInstanceToken,
+        logLevel: 'debug',
+      });
+      setLimrunIosClient(this._limClient);
 
       await this.start();
 
@@ -456,7 +476,7 @@ export class XCUITestDriver
       }
     }
 
-    if (this.remote) {
+    if (this._remote) {
       this.log.debug('Found a remote debugger session. Removing...');
       await this.stopRemote();
     }
@@ -502,7 +522,7 @@ export class XCUITestDriver
     this.log.debug(`Executing command '${cmd}'`);
 
     if (cmd === 'receiveAsyncResponse') {
-      return await this.receiveAsyncResponse(...args);
+      return await this.receiveAsyncResponse(args[0], args[1]);
     }
     // TODO: once this fix gets into base driver remove from here
     if (cmd === 'getStatus') {
@@ -673,6 +693,13 @@ export class XCUITestDriver
     return this._wda;
   }
 
+  get remote(): RemoteDebugger {
+    if (!this._remote) {
+      throw new Error('Remote debugger is not initialized');
+    }
+    return this._remote;
+  }
+
   get driverData(): Record<string, any> {
     // TODO fill out resource info here
     return {};
@@ -860,8 +887,7 @@ export class XCUITestDriver
     await this.runReset();
 
     this._wda = new WebDriverAgent(
-      // @ts-ignore This property is not used by WDA, and will be removed in the future
-      this.xcodeVersion,
+      undefined,
       {
         ...this.opts,
         device: this.device,
@@ -1344,10 +1370,9 @@ export class XCUITestDriver
           try {
             const device = await getSimulator(this.opts.udid, {
               devicesSetPath: this.opts.simulatorDevicesSetPath,
+              limClient: this.limClient,
               // @ts-ignore This is ok
               logger: this.log,
-              limInstanceApiUrl: this.opts.limInstanceApiUrl,
-              limInstanceToken: this.opts.limInstanceToken,
             });
             return {device, realDevice: false, udid: this.opts.udid};
           } catch {
@@ -1741,7 +1766,7 @@ export class XCUITestDriver
     this.implicitWaitMs = 0;
     this.pageLoadMs = 6000;
     this.landscapeWebCoordsOffset = 0;
-    this.remote = null;
+    this._remote = null;
     this._conditionInducerService = null;
     this._remoteXPCConditionInducerConnection = null;
 

package/lib/execute-method-map.ts

@@ -215,7 +215,6 @@ export const executeMethodMap = {
     command: 'getViewportRect',
   },
   'mobile: startPerfRecord': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'mobileStartPerfRecord',
     params: {
       optional: ['timeout', 'profileName', 'pid'],
@@ -253,7 +252,6 @@ export const executeMethodMap = {
     command: 'mobileListCertificates',
   },
   'mobile: startLogsBroadcast': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'mobileStartLogsBroadcast',
   },
   'mobile: stopLogsBroadcast': {
@@ -468,28 +466,24 @@ export const executeMethodMap = {
     command: 'mobileResetLocationService',
   },
   'mobile: startPcap': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'mobileStartPcap',
     params: {
       optional: ['timeLimitSec', 'forceRestart'],
     },
   },
   'mobile: stopPcap': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'mobileStopPcap',
   },
   'mobile: listConditionInducers': {
     command: 'listConditionInducers',
   },
   'mobile: enableConditionInducer': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'enableConditionInducer',
     params: {
       required: ['conditionID', 'profileID'],
     },
   },
   'mobile: disableConditionInducer': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'disableConditionInducer',
   },
   'mobile: updateSafariPreferences': {
@@ -499,7 +493,6 @@ export const executeMethodMap = {
     },
   },
   'mobile: calibrateWebToRealCoordinatesTranslation': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'mobileCalibrateWebToRealCoordinatesTranslation',
   },
   'mobile: keys': {
@@ -532,7 +525,6 @@ export const executeMethodMap = {
     command: 'mobileShake',
   },
   'mobile: startAudioRecording': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'startAudioRecording',
     params: {
       required: ['audioInput'],
@@ -547,7 +539,6 @@ export const executeMethodMap = {
     },
   },
   'mobile: stopAudioRecording': {
-    // @ts-expect-error Class field assignment - method exists on XCUITestDriver
     command: 'stopAudioRecording',
   },
   'mobile: hideKeyboard': {

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "10.11.0-lim.3",
+  "version": "10.14.6-lim.1",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -82,14 +82,15 @@
   "dependencies": {
     "@appium/strongbox": "^1.0.0-rc.1",
     "@colors/colors": "^1.6.0",
+    "@limrun/api": "^0.18.3",
     "appium-idb": "^2.0.0",
     "appium-ios-device": "^3.0.0",
-    "appium-ios-simulator": "npm:@limrun/appium-ios-simulator@8.0.7-lim.3",
+    "appium-ios-simulator": "npm:@limrun/appium-ios-simulator@8.0.9-lim.2",
     "appium-remote-debugger": "npm:@limrun/appium-remote-debugger@15.2.7-lim.4",
     "appium-webdriveragent": "npm:@limrun/appium-webdriveragent@10.4.2-lim.1",
-    "appium-xcode": "npm:@limrun/appium-xcode@6.1.3-lim.1",
+    "appium-xcode": "npm:@limrun/appium-xcode@6.1.6-lim.1",
     "async-lock": "^1.4.0",
-    "asyncbox": "^3.0.0",
+    "asyncbox": "^4.0.1",
     "bluebird": "^3.7.2",
     "commander": "^14.0.1",
     "css-selector-parser": "^3.0.0",
@@ -99,7 +100,7 @@
     "moment": "^2.29.4",
     "moment-timezone": "^0.x",
     "node-devicectl": "^1.1.0",
-    "node-simctl": "npm:@limrun/node-simctl@8.1.1-lim.4",
+    "node-simctl": "npm:@limrun/node-simctl@8.1.3-lim.1",
     "portscanner": "^2.2.0",
     "semver": "^7.5.4",
     "teen_process": "^3.0.0",

package/lib/commands/active-app-info.js

@@ -1,12 +0,0 @@
-/**
- * Returns information about the active application.
- *
- * @returns {Promise<import('./types').ActiveAppInfo>} Active app information
- * @throws {Error} if an error raised by command
- * @this {import('../driver').XCUITestDriver}
- */
-export async function mobileGetActiveAppInfo() {
-  return /** @type {import('./types').ActiveAppInfo} */ (
-    await this.proxyCommand('/wda/activeAppInfo', 'GET')
-  );
-}

package/lib/commands/alert.js

@@ -1,88 +0,0 @@
-/**
- * @this {XCUITestDriver}
- */
-export async function getAlertText() {
-  return /** @type {string|null} */ (await this.proxyCommand('/alert/text', 'GET'));
-}
-
-/**
- * @param {string} value
- * @this {XCUITestDriver}
- * @returns {Promise<void>}
- */
-export async function setAlertText(value) {
-  await this.proxyCommand('/alert/text', 'POST', {value});
-}
-
-/**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
- */
-export async function postAcceptAlert(opts = {}) {
-  await this.proxyCommand('/alert/accept', 'POST', toAlertParams(opts));
-}
-
-/**
- * @param { {buttonLabel?: string} } opts
- * @returns {Promise<void>}
- * @this {XCUITestDriver}
- */
-export async function postDismissAlert(opts = {}) {
-  await this.proxyCommand('/alert/dismiss', 'POST', toAlertParams(opts));
-}
-
-/**
- * @internal
- * @this {XCUITestDriver}
- * @returns {Promise<string[]>} The list of button labels
- */
-export async function getAlertButtons() {
-  return /** @type {string[]} */ (await this.proxyCommand('/wda/alert/buttons', 'GET'));
-}
-
-/**
- * Tries to apply the given action to the currently visible alert.
- *
- * @param {AlertAction} action - The actual action to apply.
- * @param {string} [buttonLabel] - The name of the button used to perform the chosen alert action. Only makes sense if the action is `accept` or `dismiss`.
- * @returns {Promise<string[]|void>} If `action` is `getButtons`, a list of alert button labelsp; otherwise nothing.
- * @remarks This should really be separate commands.
- * @this {XCUITestDriver}
- */
-export async function mobileHandleAlert(action, buttonLabel) {
-  switch (action) {
-    case 'accept':
-      return await this.postAcceptAlert({buttonLabel});
-    case 'dismiss':
-      return await this.postDismissAlert({buttonLabel});
-    case 'getButtons':
-      return await this.getAlertButtons();
-    default:
-      throw new Error(
-        `The 'action' value should be either 'accept', 'dismiss' or 'getButtons'. ` +
-          `'${action}' is provided instead.`,
-      );
-  }
-}
-
-/**
- *
- * @param { {buttonLabel?: string} } opts
- * @returns { {name?: string} }
- */
-function toAlertParams(opts = {}) {
-  const params = {};
-  if (opts.buttonLabel) {
-    params.name = opts.buttonLabel;
-  }
-  return params;
-}
-
-/**
- * @typedef {'accept'|'dismiss'|'getButtons'} AlertAction
- */
-
-/**
- * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
- */