appium-xcuitest-driver 7.7.1 → 7.8.0

package/lib/commands/certificate.js

@@ -390,8 +390,7 @@ export default {
         }
 
         let isCertAlreadyInstalled = false;
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        if (util.compareVersions(this.opts.platformVersion, '>=', '12.2')) {
+        if (util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '>=', '12.2')) {
           if (await installPost122Certificate(this, cn)) {
             await clickElement(this, Settings.Profile);
             await trustCertificateInPreferences(this, cn);

package/lib/commands/context.js

@@ -49,9 +49,9 @@ const extensions = {
    * @this {XCUITestDriver}
    */
   useNewSafari() {
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return !this.isRealDevice() && this.opts.safari;
+    return this.isSimulator() && this.isSafari();
   },
+
   /**
    * @this {XCUITestDriver}
    */

package/lib/commands/memory.js

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 import { errors } from 'appium/driver';
-import RealDevice from '../real-device';
 
 export default {
   /**
@@ -16,7 +15,7 @@ export default {
       throw new Error('Memory warning simulation is only supported on real devices');
     }
 
-    const device = /** @type {RealDevice} */ (this.device);
+    const device = /** @type {import('../real-device').RealDevice} */ (this.device);
 
     /** @type {import('../devicectl').AppInfo[]} */
     const appInfos = await device.devicectl.listApps(bundleId);

package/lib/commands/web.js

@@ -523,8 +523,7 @@ const extensions = {
     const {
       nativeWebTapTabBarVisibility,
       nativeWebTapSmartAppBannerVisibility,
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      safariTabBarPosition = util.compareVersions(this.opts.platformVersion, '>=', '15.0') &&
+      safariTabBarPosition = util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '>=', '15.0') &&
       isIphone
         ? TAB_BAR_POSITION_BOTTOM
         : TAB_BAR_POSITION_TOP,
@@ -551,8 +550,7 @@ const extensions = {
     const orientation = realDims.h > realDims.w ? 'PORTRAIT' : 'LANDSCAPE';
 
     const notchOffset = isNotched
-      ? // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        util.compareVersions(this.opts.platformVersion, '=', '13.0')
+      ? util.compareVersions(/** @type {string} */ (this.opts.platformVersion), '=', '13.0')
         ? IPHONE_X_NOTCH_OFFSET_IOS_13
         : IPHONE_X_NOTCH_OFFSET_IOS
       : 0;
@@ -945,9 +943,7 @@ const extensions = {
       // restore the previous url
       await this.setUrl(currentUrl);
     }
-    /** @type {import('../types').CalibrationData} */
-    // @ts-ignore this.webviewCalibrationResult is always defined here
-    const result = this.webviewCalibrationResult;
+    const result = /** @type {import('../types').CalibrationData} */ (this.webviewCalibrationResult);
     return {
       ...result,
       offsetX: Math.round(result.offsetX),

package/lib/css-converter.js

@@ -210,18 +210,19 @@ function parseCssRule(cssRule) {
   }
 
   let iosClassChainSelector = '';
-  /** @type {import('css-selector-parser').AstClassName[]} */
-  // @ts-ignore This should work
-  const astClassNames = cssRule.items.filter(({type}) => type === 'ClassName');
+  const astClassNames = /** @type {import('css-selector-parser').AstClassName[]} */ (
+    cssRule.items.filter(({type}) => type === 'ClassName')
+  );
   const classNames = astClassNames.map(({name}) => name);
   if (classNames.length) {
     throw new errors.InvalidSelectorError(`'${[cssRule || '', ...classNames].join('.')}'
       is not a valid ios class. Must be a single string (e.g.: XCUIElementTypeWindow) without
       dots separating them`);
   }
-  /** @type {import('css-selector-parser').AstTagName|undefined} */
-  // @ts-ignore This should work
-  const astTag = cssRule.items.find(({type}) => type === 'TagName');
+
+  const astTag = /** @type {import('css-selector-parser').AstTagName|undefined} */ (
+    cssRule.items.find(({type}) => type === 'TagName')
+  );
   let tagName = astTag?.name ?? '';
   if (tagName && tagName !== '*' && !_.startsWith(_.toLower(tagName), 'xcuielementtype')) {
     const capitalizedTagName = tagName.charAt(0).toUpperCase() + tagName.slice(1);
@@ -231,22 +232,23 @@ function parseCssRule(cssRule) {
 
   /** @type {(string|{index: string|undefined}|undefined)[]} */
   const attrs = [];
-  /** @type {import('css-selector-parser').AstId[]} */
-  // @ts-ignore This should work
-  const astIds = cssRule.items.filter(({type}) => type === 'Id');
+
+  const astIds = /** @type {import('css-selector-parser').AstId[]} */ (
+    cssRule.items.filter(({type}) => type === 'Id')
+  );
   const ids = astIds.map(({name}) => name);
   if (ids.length) {
     attrs.push(`name == "${ids[0]}"`);
   }
-  /** @type {import('css-selector-parser').AstAttribute[]} */
-  // @ts-ignore This should work
-  const attributes = cssRule.items.filter(({type}) => type === 'Attribute');
+  const attributes = /** @type {import('css-selector-parser').AstAttribute[]} */ (
+    cssRule.items.filter(({type}) => type === 'Attribute')
+  );
   for (const attr of attributes) {
     attrs.push(parseAttr(attr));
   }
-  /** @type {import('css-selector-parser').AstPseudoClass[]} */
-  // @ts-ignore This should work
-  const pseudoClasses = cssRule.items.filter(({type}) => type === 'PseudoClass');
+  const pseudoClasses = /** @type {import('css-selector-parser').AstPseudoClass[]} */ (
+    cssRule.items.filter(({type}) => type === 'PseudoClass')
+  );
   for (const pseudo of pseudoClasses) {
     attrs.push(parsePseudo(pseudo));
   }

package/lib/desired-caps.js

@@ -364,6 +364,12 @@ const desiredCapConstraints = /** @type {const} */ ({
   skipSyncUiDialogTranslation: {
     isBoolean: true,
   },
+  forceSimulatorSoftwareKeyboardPresence: {
+    isBoolean: true,
+  },
+  appLaunchStateTimeoutSec: {
+    isNumber: true,
+  }
 });
 
 export {desiredCapConstraints, PLATFORM_NAME_IOS, PLATFORM_NAME_TVOS};

package/lib/driver.js

@@ -181,7 +181,7 @@ const BUNDLE_VERSION_PATTERN = /CFBundleVersion\s+=\s+"?([^(;|")]+)/;
  * @privateRemarks **This class should be considered "final"**. It cannot be extended
  * due to use of public class field assignments.  If extending this class becomes a hard requirement, refer to the implementation of `BaseDriver` on how to do so.
  */
-class XCUITestDriver extends BaseDriver {
+export class XCUITestDriver extends BaseDriver {
   static newMethodMap = newMethodMap;
 
   static executeMethodMap = executeMethodMap;
@@ -256,6 +256,12 @@ class XCUITestDriver extends BaseDriver {
   /** @type {import('./commands/pcap').TrafficCapture|null} */
   _trafficCapture;
 
+  /** @type {Simulator|RealDevice} */
+  _device;
+
+  /** @type {string|null} */
+  _iosSdkVersion;
+
   /**
    *
    * @param {XCUITestDriverOpts} opts
@@ -323,8 +329,6 @@ class XCUITestDriver extends BaseDriver {
   resetIos() {
     this.opts = this.opts || {};
     this.wda = null;
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    this.opts.device = null;
     this.jwpProxyActive = false;
     this.proxyReqRes = null;
     this.safari = false;
@@ -388,8 +392,7 @@ class XCUITestDriver extends BaseDriver {
    * @returns {Simulator|RealDevice}
    */
   get device() {
-    // @ts-ignore This property should exist
-    return this.opts?.device;
+    return this._device;
   }
 
   isXcodebuildNeeded() {
@@ -399,8 +402,6 @@ class XCUITestDriver extends BaseDriver {
   async createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData) {
     try {
       let [sessionId, caps] = await super.createSession(w3cCaps1, w3cCaps2, w3cCaps3, driverData);
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      this.opts.sessionId = sessionId;
 
       // merge cli args to opts, and if we did merge any, revalidate opts to ensure the final set
       // is also consistent
@@ -432,20 +433,16 @@ class XCUITestDriver extends BaseDriver {
         elementResponseAttributes: DEFAULT_SETTINGS.elementResponseAttributes,
         shouldUseCompactResponses: DEFAULT_SETTINGS.shouldUseCompactResponses,
       };
-      if (_.has(this.opts, 'elementResponseAttributes')) {
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+      if ('elementResponseAttributes' in this.opts && _.isString(this.opts.elementResponseAttributes)) {
         wdaSettings.elementResponseAttributes = this.opts.elementResponseAttributes;
       }
-      if (_.has(this.opts, 'shouldUseCompactResponses')) {
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+      if ('shouldUseCompactResponses' in this.opts && _.isBoolean(this.opts.shouldUseCompactResponses)) {
         wdaSettings.shouldUseCompactResponses = this.opts.shouldUseCompactResponses;
       }
-      if (_.has(this.opts, 'mjpegServerScreenshotQuality')) {
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+      if ('mjpegServerScreenshotQuality' in this.opts && _.isNumber(this.opts.mjpegServerScreenshotQuality)) {
         wdaSettings.mjpegServerScreenshotQuality = this.opts.mjpegServerScreenshotQuality;
       }
-      if (_.has(this.opts, 'mjpegServerFramerate')) {
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+      if ('mjpegServerFramerate' in this.opts && _.isNumber(this.opts.mjpegServerFramerate)) {
         wdaSettings.mjpegServerFramerate = this.opts.mjpegServerFramerate;
       }
       if (_.has(this.opts, 'screenshotQuality')) {
@@ -486,18 +483,13 @@ class XCUITestDriver extends BaseDriver {
     this.opts.fullReset = !!this.opts.fullReset;
 
     await printUser();
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    this.opts.iosSdkVersion = null; // For WDA and xcodebuild
+    this._iosSdkVersion = null; // For WDA and xcodebuild
     const {device, udid, realDevice} = await this.determineDevice();
     this.log.info(
       `Determining device to run tests on: udid: '${udid}', real device: ${realDevice}`,
     );
-    // TODO: extract device out of opts to a separate driver property
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    this.opts.device = device;
+    this._device = device;
     this.opts.udid = udid;
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    this.opts.realDevice = realDevice;
 
     if (this.opts.simulatorDevicesSetPath) {
       if (realDevice) {
@@ -528,8 +520,7 @@ class XCUITestDriver extends BaseDriver {
       this.opts.platformVersion = normalizedVersion;
     }
 
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    if (_.isEmpty(this.xcodeVersion) && (this.isXcodebuildNeeded() || !this.opts.realDevice)) {
+    if (_.isEmpty(this.xcodeVersion) && (this.isXcodebuildNeeded() || this.isSimulator())) {
       // no `webDriverAgentUrl`, or on a simulator, so we need an Xcode version
       this.xcodeVersion = await getAndCheckXcodeVersion();
     }
@@ -561,7 +552,12 @@ class XCUITestDriver extends BaseDriver {
 
     this.wda = new WebDriverAgent(
       /** @type {import('appium-xcode').XcodeVersion} */ (this.xcodeVersion),
-      this.opts,
+      {
+        ...this.opts,
+        device: this.device,
+        realDevice: this.isRealDevice(),
+        iosSdkVersion: this._iosSdkVersion,
+      },
       this.log,
     );
     // Derived data path retrieval is an expensive operation
@@ -635,8 +631,7 @@ class XCUITestDriver extends BaseDriver {
       }
     }
 
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await this.startWda(this.opts.sessionId);
+    await this.startWda();
 
     if (_.isString(this.opts.orientation)) {
       await this.setInitialOrientation(this.opts.orientation);
@@ -715,9 +710,8 @@ class XCUITestDriver extends BaseDriver {
 
   /**
    * Start WebDriverAgentRunner
-   * @param {string} sessionId - The id of the target session to launch WDA with.
    */
-  async startWda(sessionId) {
+  async startWda() {
     // Don't cleanup the processes if webDriverAgentUrl is set
     if (!util.hasValue(this.wda.webDriverAgentUrl)) {
       await this.wda.cleanupObsoleteProcesses();
@@ -824,7 +818,7 @@ class XCUITestDriver extends BaseDriver {
             await this.preparePreinstalledWda();
           }
 
-          this.cachedWdaStatus = await this.wda.launch(sessionId);
+          this.cachedWdaStatus = await this.wda.launch(/** @type {string} */ (this.sessionId));
         } catch (err) {
           this.logEvent('wdaStartFailed');
           this.log.debug(err.stack);
@@ -1170,16 +1164,14 @@ class XCUITestDriver extends BaseDriver {
     this.opts.deviceName = translateDeviceName(this.opts.platformVersion, this.opts.deviceName);
 
     const setupVersionCaps = async () => {
-      const iosSdkVersion = await getAndCheckIosSdkVersion();
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      this.opts.iosSdkVersion = iosSdkVersion;
-      this.log.info(`iOS SDK Version set to '${iosSdkVersion}'`);
-      if (!this.opts.platformVersion && iosSdkVersion) {
+      this._iosSdkVersion = await getAndCheckIosSdkVersion();
+      this.log.info(`iOS SDK Version set to '${this._iosSdkVersion}'`);
+      if (!this.opts.platformVersion && this._iosSdkVersion) {
         this.log.info(
-          `No platformVersion specified. Using the latest version Xcode supports: '${iosSdkVersion}'. ` +
+          `No platformVersion specified. Using the latest version Xcode supports: '${this._iosSdkVersion}'. ` +
             `This may cause problems if a simulator does not exist for this platform version.`,
         );
-        this.opts.platformVersion = normalizePlatformVersion(iosSdkVersion);
+        this.opts.platformVersion = normalizePlatformVersion(this._iosSdkVersion);
       }
     };
 
@@ -1355,9 +1347,9 @@ class XCUITestDriver extends BaseDriver {
       disableAutomaticScreenshots: this.opts.disableAutomaticScreenshots,
       shouldTerminateApp: this.opts.shouldTerminateApp ?? true,
       forceAppLaunch: this.opts.forceAppLaunch ?? true,
+      appLaunchStateTimeoutSec: this.opts.appLaunchStateTimeoutSec,
       useNativeCachingStrategy: this.opts.useNativeCachingStrategy ?? true,
       forceSimulatorSoftwareKeyboardPresence:
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
         this.opts.forceSimulatorSoftwareKeyboardPresence ??
         (this.opts.connectHardwareKeyboard === true ? false : true),
     });
@@ -1397,29 +1389,35 @@ class XCUITestDriver extends BaseDriver {
     return true;
   }
 
+  /**
+   * @returns {boolean}
+   */
   isSafari() {
     return !!this.safari;
   }
+
   /**
-   *
    * @returns {boolean}
    */
   isRealDevice() {
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return Boolean(this.opts.realDevice);
+    return 'devicectl' in (this.device ?? {});
   }
 
+  /**
+   * @returns {boolean}
+   */
   isSimulator() {
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return !this.opts.realDevice;
+    return 'simctl' in (this.device ?? {});
   }
 
+  /**
+   * @param {string} strategy
+   */
   validateLocatorStrategy(strategy) {
     super.validateLocatorStrategy(strategy, this.isWebContext());
   }
 
   /**
-   *
    * @param {any} caps
    * @returns {caps is import('@appium/types').DriverCaps<XCUITestDriverConstraints>}
    */
@@ -1556,22 +1554,6 @@ class XCUITestDriver extends BaseDriver {
     return true;
   }
 
-  /**
-   * @typedef {Object} AutInstallationStateOptions
-   * @property {Pick<XCUITestDriverOpts, "enforceAppInstall">} enforceAppInstall
-   * @property {Pick<XCUITestDriverOpts, "fullReset">} fullReset
-   * @property {Pick<XCUITestDriverOpts, "noReset">} noReset
-   * @property {Pick<XCUITestDriverOpts, "bundleId">} bundleId
-   * @property {Pick<XCUITestDriverOpts, "app">} app
-   * @property {Object} device - Real device object or simulator object
-   */
-
-  /**
-   * @typedef {Object} AutInstallationState
-   * @property {boolean} install - If the given app should install, or not need to install.
-   * @property {boolean} skipUninstall - If the installed app should be uninstalled, or not.
-   * /
-
   /**
    * Check if the given app can be installed, or should uninstall before installing it.
    *
@@ -1579,10 +1561,9 @@ class XCUITestDriver extends BaseDriver {
    * @returns {Promise<AutInstallationState>}
    */
   async checkAutInstallationState(opts) {
-    // @ts-expect-error - do not assign arbitrary properties to `opts`
-    const {enforceAppInstall, fullReset, noReset, bundleId, device, app} = opts ?? this.opts;
+    const {enforceAppInstall, fullReset, noReset, bundleId, app} = opts ?? this.opts;
 
-    const wasAppInstalled = await device.isAppInstalled(bundleId);
+    const wasAppInstalled = await this.device.isAppInstalled(bundleId);
     if (wasAppInstalled) {
       this.log.info(`App '${bundleId}' is already installed`);
       if (noReset) {
@@ -1613,8 +1594,8 @@ class XCUITestDriver extends BaseDriver {
     }
 
     const appBundleVersion = this.isRealDevice()
-      ? (await device.fetchAppInfo(bundleId))?.CFBundleVersion
-      : BUNDLE_VERSION_PATTERN.exec(await device.simctl.appInfo(bundleId))?.[1];
+      ? (await /** @type {RealDevice} */ (this.device).fetchAppInfo(bundleId))?.CFBundleVersion
+      : BUNDLE_VERSION_PATTERN.exec(await /** @type {Simulator} */ (this.device).simctl.appInfo(bundleId))?.[1];
     this.log.debug(`CFBundleVersion from installed app info: ${appBundleVersion}`);
     if (!appBundleVersion) {
       return {
@@ -2255,7 +2236,6 @@ function shouldSetInitialSafariUrl(opts) {
 }
 
 export default XCUITestDriver;
-export {XCUITestDriver};
 
 /**
  * @template {import('@appium/types').Constraints} C
@@ -2263,6 +2243,16 @@ export {XCUITestDriver};
  * @typedef {import('@appium/types').ExternalDriver<C, Ctx>} ExternalDriver
  */
 
+/**
+ * @typedef {Pick<XCUITestDriverOpts, 'enforceAppInstall' | 'fullReset' | 'noReset' | 'bundleId' | 'app'>} AutInstallationStateOptions
+ */
+
+/**
+ * @typedef {Object} AutInstallationState
+ * @property {boolean} install - If the given app should install, or not need to install.
+ * @property {boolean} skipUninstall - If the installed app should be uninstalled, or not.
+ */
+
 /**
  * @typedef {typeof desiredCapConstraints} XCUITestDriverConstraints
  * @typedef {import('@appium/types').DriverOpts<XCUITestDriverConstraints>} XCUITestDriverOpts
@@ -2271,4 +2261,4 @@ export {XCUITestDriver};
  * @typedef {import('appium-xcode').XcodeVersion} XcodeVersion
  * @typedef {import('appium-ios-simulator').Simulator} Simulator
  * @typedef {import('./real-device').RealDevice} RealDevice
- */
+ */

package/lib/types.ts

@@ -15,25 +15,6 @@ export interface LifecycleData {
   createSim?: boolean;
 }
 
-/**
- * All of these options are manually added to the `opts` property of the driver, which is strongly discouraged.
- *
- * Future versions of this driver should move these properties somewhere else.
- *
- * @todo If anyone knows anything about the types of these values, please fill them in.
- */
-export interface CustomOpts {
-  device: any;
-  realDevice: any;
-  SimulatorWindowCenter: any;
-  forceSimulatorSoftwareKeyboardPresence: any;
-  iosSdkVersion: string;
-  platformVersion: string;
-  safari: any;
-  sessionId: string | null;
-  elementResponseAttributes: any;
-}
-
 export interface WDASettings {
   elementResponseAttributes: string;
   shouldUseCompactResponses: boolean;

package/lib/utils.js

@@ -60,11 +60,14 @@ async function getAndCheckXcodeVersion() {
   return version;
 }
 
+/**
+ * @returns {Promise<string|null>}
+ */
 async function getAndCheckIosSdkVersion() {
   try {
     return await xcode.getMaxIOSSDK();
   } catch (err) {
-    log.errorAndThrow(`Could not determine iOS SDK version: ${err.message}`);
+    throw log.errorWithException(`Could not determine iOS SDK version: ${err.message}`);
   }
 }
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-xcuitest-driver",
-  "version": "7.7.1",
+  "version": "7.8.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-xcuitest-driver",
-      "version": "7.7.1",
+      "version": "7.8.0",
       "license": "Apache-2.0",
       "dependencies": {
         "@colors/colors": "^1.6.0",
@@ -14,7 +14,7 @@
         "appium-ios-device": "^2.5.4",
         "appium-ios-simulator": "^6.1.2",
         "appium-remote-debugger": "^11.0.0",
-        "appium-webdriveragent": "^8.1.0",
+        "appium-webdriveragent": "^8.2.1",
         "appium-xcode": "^5.1.4",
         "async-lock": "^1.4.0",
         "asyncbox": "^3.0.0",
@@ -999,9 +999,9 @@
       }
     },
     "node_modules/appium-webdriveragent": {
-      "version": "8.1.0",
-      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-8.1.0.tgz",
-      "integrity": "sha512-pexbyMiffrSBRQ3Ahr4GqbFHyw9xwySg9fvA8yIh6gfthXu4Q8MoGTbhYE9lZZq6mWqEGZQ7LoSShFL/NCzyPg==",
+      "version": "8.2.1",
+      "resolved": "https://registry.npmjs.org/appium-webdriveragent/-/appium-webdriveragent-8.2.1.tgz",
+      "integrity": "sha512-Ai4I5YSyNOKlD6+oGbaRfuPAeGINcLGDB0+CwowvkG4FnReYKm3zfYR6VOquoqoNqOZkzTW8PbxSG0dRSUBxMQ==",
       "dependencies": {
         "@appium/base-driver": "^9.0.0",
         "@appium/strongbox": "^0.x",

package/package.json

@@ -8,7 +8,7 @@
     "xcuitest",
     "xctest"
   ],
-  "version": "7.7.1",
+  "version": "7.8.0",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -81,7 +81,7 @@
     "appium-ios-device": "^2.5.4",
     "appium-ios-simulator": "^6.1.2",
     "appium-remote-debugger": "^11.0.0",
-    "appium-webdriveragent": "^8.1.0",
+    "appium-webdriveragent": "^8.2.1",
     "appium-xcode": "^5.1.4",
     "async-lock": "^1.4.0",
     "asyncbox": "^3.0.0",