appium-xcuitest-driver 7.6.1 → 7.7.0

package/lib/commands/file-movement.js

@@ -93,7 +93,7 @@ async function createService(udid, remotePath) {
 /**
  * Save the given base64 data chunk as a binary file on the Simulator under test.
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../driver').Simulator} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The remote path on the device. This variable can be prefixed with
@@ -140,7 +140,7 @@ async function pushFileToSimulator(device, remotePath, base64Data) {
 /**
  * Save the given base64 data chunk as a binary file on the device under test.
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../real-device').RealDevice} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The remote path on the device. This variable can be prefixed with
@@ -179,7 +179,7 @@ async function deleteFileOrFolder(device, remotePath, isSimulator) {
  * Get the content of given file or folder from iOS Simulator and return it as base-64 encoded string.
  * Folder content is recursively packed into a zip archive.
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../driver').Simulator} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The path to a file or a folder, which exists in the corresponding application
@@ -225,7 +225,7 @@ async function pullFromSimulator(device, remotePath, isFile) {
  * Get the content of given file or folder from the real device under test and return it as base-64 encoded string.
  * Folder content is recursively packed into a zip archive.
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../real-device').RealDevice} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The path to an existing remote file on the device. This variable can be prefixed with
@@ -266,7 +266,7 @@ async function pullFromRealDevice(device, remotePath, isFile) {
 /**
  * Remove the file or folder from the device
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../driver').Simulator} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The path to a file or a folder, which exists in the corresponding application
@@ -304,7 +304,7 @@ async function deleteFromSimulator(device, remotePath) {
 /**
  * Remove the file or folder from the device
  *
- * @param {Object} device - The device object, which represents the device under test.
+ * @param {import('../real-device').RealDevice} device - The device object, which represents the device under test.
  *                          This object is expected to have the `udid` property containing the
  *                          valid device ID.
  * @param {string} remotePath - The path to an existing remote file on the device. This variable can be prefixed with
@@ -361,10 +361,8 @@ export default {
       base64Data = Buffer.from(base64Data).toString('utf8');
     }
     return this.isSimulator()
-      ? // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pushFileToSimulator(this.opts.device, remotePath, base64Data)
-      : // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pushFileToRealDevice(this.opts.device, remotePath, base64Data);
+      ? await pushFileToSimulator(/** @type {import('../driver').Simulator} */ (this.device), remotePath, base64Data)
+      : await pushFileToRealDevice(/** @type {import('../real-device').RealDevice} */ (this.device), remotePath, base64Data);
   },
 
   /**
@@ -398,10 +396,8 @@ export default {
       );
     }
     return this.isSimulator()
-      ? // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pullFromSimulator(this.opts.device, remotePath, true)
-      : // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pullFromRealDevice(this.opts.device, remotePath, true);
+      ? await pullFromSimulator(/** @type {import('../driver').Simulator} */ (this.device), remotePath, true)
+      : await pullFromRealDevice(/** @type {import('../real-device').RealDevice} */ (this.device), remotePath, true);
   },
 
   /**
@@ -427,8 +423,7 @@ export default {
     if (!remotePath.endsWith('/')) {
       remotePath = `${remotePath}/`;
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await deleteFileOrFolder(this.opts.device, remotePath, this.isSimulator());
+    await deleteFileOrFolder(this.device, remotePath, this.isSimulator());
   },
 
   /**
@@ -445,8 +440,7 @@ export default {
           `'${remotePath}' is given instead`,
       );
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await deleteFileOrFolder(this.opts.device, remotePath, this.isSimulator());
+    await deleteFileOrFolder(this.device, remotePath, this.isSimulator());
   },
 
   /**
@@ -463,10 +457,8 @@ export default {
       remotePath = `${remotePath}/`;
     }
     return this.isSimulator()
-      ? // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pullFromSimulator(this.opts.device, remotePath, false)
-      : // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        await pullFromRealDevice(this.opts.device, remotePath, false);
+      ? await pullFromSimulator(/** @type {import('../driver').Simulator} */ (this.device), remotePath, false)
+      : await pullFromRealDevice(/** @type {import('../real-device').RealDevice} */ (this.device), remotePath, false);
   },
 
   /**

package/lib/commands/general.js

@@ -169,8 +169,7 @@ const commands = {
     if (this.isRealDevice()) {
       await this.proxyCommand('/url', 'POST', {url});
     } else {
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      await this.opts.device.simctl.openUrl(url);
+      await /** @type {import('../driver').Simulator} */ (this.device).simctl.openUrl(url);
     }
   },
   /**

package/lib/commands/gesture.js

@@ -57,8 +57,7 @@ const commands = {
     if (!this.isSimulator()) {
       throw new errors.UnknownError('Shake is not supported on real devices');
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await this.opts.device.shake();
+    await /** @type {import('../driver').Simulator} */ (this.device).shake();
   },
   /**
    * @this {XCUITestDriver}

package/lib/commands/keychains.js

@@ -14,7 +14,7 @@ export default {
    */
   async mobileClearKeychains() {
     assertSimulator(this);
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await this.opts.device.clearKeychains();
+
+    await /** @type {import('../driver').Simulator} */ (this.device).clearKeychains();
   },
 };

package/lib/commands/localization.js

@@ -27,9 +27,6 @@ export default {
       // Assign skipSyncUiDialogTranslation: true option in order to avoid shutting down the WDA session
       localizationOptions.language = Object.assign(language, {skipSyncUiDialogTranslation: true});
     }
-    return /** @type {boolean} */ (
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      await this.opts.device.configureLocalization(localizationOptions)
-    );
+    return await /** @type {import('../driver').Simulator} */ (this.device).configureLocalization(localizationOptions);
   },
 };

package/lib/commands/location.js

@@ -77,8 +77,7 @@ export default {
     }
 
     if (this.isSimulator()) {
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      await this.opts.device.setGeolocation(`${latitude}`, `${longitude}`);
+      await /** @type {import('../driver').Simulator} */ (this.device).setGeolocation(`${latitude}`, `${longitude}`);
       return /** @type {Location} */ ({latitude, longitude, altitude: 0});
     }
 

package/lib/commands/log.js

@@ -103,8 +103,7 @@ export default {
     }
     if (_.isUndefined(this.logs.syslog)) {
       this.logs.crashlog = new IOSCrashLog({
-        // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-        sim: this.opts.device,
+        sim: this.device,
         udid: this.isRealDevice() ? this.opts.udid : undefined,
       });
 
@@ -115,8 +114,7 @@ export default {
         });
       } else {
         this.logs.syslog = new IOSSimulatorLog({
-          // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-          sim: this.opts.device,
+          sim: this.device,
           showLogs: this.opts.showIOSLog,
           xcodeVersion: this.xcodeVersion,
           iosSimulatorLogsPredicate: this.opts.iosSimulatorLogsPredicate,

package/lib/commands/memory.js

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

package/lib/commands/notifications.js

@@ -35,8 +35,7 @@ export default {
           `Got ${JSON.stringify(payload.aps)} instead`,
       );
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return await this.opts.device.pushNotification({
+    return await /** @type {import('../driver').Simulator} */ (this.device).pushNotification({
       ...payload,
       'Simulator Target Bundle': bundleId,
     });

package/lib/commands/pasteboard.js

@@ -17,8 +17,9 @@ export default {
       // can be empty string
       throw new Error('Pasteboard content is mandatory to set');
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return await this.opts.device.simctl.setPasteboard(content, encoding);
+    return await /** @type {import('../driver').Simulator} */ (this.device).simctl.setPasteboard(
+      content, /** @type {BufferEncoding} */ (encoding)
+    );
   },
 
   /**
@@ -34,8 +35,7 @@ export default {
     if (!this.isSimulator()) {
       throw new Error('Getting pasteboard content is not supported on real devices');
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return await this.opts.device.simctl.getPasteboard(encoding);
+    return await /** @type {import('../driver').Simulator} */ (this.device).simctl.getPasteboard(encoding);
   },
 };
 

package/lib/commands/pcap.js

@@ -110,8 +110,7 @@ export default {
       prefix: `appium_${util.uuidV4().substring(0, 8)}`,
       suffix: DEFAULT_EXT,
     });
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    const trafficCollector = new TrafficCapture(this.opts.device.udid, this.log, resultPath);
+    const trafficCollector = new TrafficCapture(this.device.udid, this.log, resultPath);
 
     const timeoutSeconds = parseInt(String(timeLimitSec), 10);
     if (isNaN(timeoutSeconds) || timeoutSeconds > MAX_CAPTURE_TIME_SEC || timeoutSeconds <= 0) {

package/lib/commands/performance.js

@@ -288,8 +288,7 @@ export default {
       for (const recorder of this._perfRecorders.filter((x) => x.profileName === profileName)) {
         if (recorder.isRunning()) {
           this.log.debug(
-            // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-            `Performance recorder for '${profileName}' on device '${this.opts.device.udid}' ` +
+            `Performance recorder for '${profileName}' on device '${this.device.udid}' ` +
               ` is already running. Doing nothing`,
           );
           return;
@@ -310,8 +309,7 @@ export default {
         realPid = pid;
       }
     }
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    const recorder = new PerfRecorder(await tempDir.openDir(), this.opts.device.udid, {
+    const recorder = new PerfRecorder(await tempDir.openDir(), this.device.udid, {
       timeout: parseInt(String(timeout), 10),
       profileName,
       pid: parseInt(String(realPid), 10),
@@ -364,8 +362,7 @@ export default {
     if (_.isEmpty(recorders)) {
       this.log.errorAndThrow(
         `There are no records for performance profile '${profileName}' ` +
-          // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-          `and device ${this.opts.device.udid}. Have you started the profiling before?`,
+          `and device ${this.device.udid}. Have you started the profiling before?`,
       );
     }
 
@@ -374,8 +371,7 @@ export default {
     if (!(await fs.exists(resultPath))) {
       this.log.errorAndThrow(
         `There is no ${DEFAULT_EXT} file found for performance profile '${profileName}' ` +
-          // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-          `and device ${this.opts.device.udid}. Make sure the selected profile is supported on this device`,
+          `and device ${this.device.udid}. Make sure the selected profile is supported on this device`,
       );
     }
 

package/lib/commands/permissions.js

@@ -55,8 +55,11 @@ export default {
     }
     assertSimulator(this);
 
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    return await this.opts.device.getPermission(bundleId, service);
+    return /** @type {import('./types').PermissionState} */ (
+      await /** @type {import('../driver').Simulator} */ (this.device).getPermission(
+        bundleId, String(service)
+      )
+    );
   },
 
   /**
@@ -75,8 +78,7 @@ export default {
     }
     assertSimulator(this);
 
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await this.opts.device.setPermissions(bundleId, access);
+    await /** @type {import('../driver').Simulator} */ (this.device).setPermissions(bundleId, access);
   },
 };
 

package/lib/commands/recordscreen.js

@@ -225,8 +225,7 @@ export default {
     });
 
     const wdaBaseUrl = this.opts.wdaBaseUrl || WDA_BASE_URL;
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    const screenRecorder = new ScreenRecorder(this.opts.device.udid, this.log, videoPath, {
+    const screenRecorder = new ScreenRecorder(this.device.udid, this.log, videoPath, {
       remotePort: this.opts.mjpegServerPort || DEFAULT_MJPEG_SERVER_PORT,
       remoteUrl: wdaBaseUrl,
       usePortForwarding: this.isRealDevice() && isLocalHost(wdaBaseUrl),

package/lib/commands/screenshots.js

@@ -1,10 +1,12 @@
 import {retryInterval} from 'asyncbox';
 import _ from 'lodash';
+import {errors} from 'appium/driver';
 import {util, imageUtil} from 'appium/support';
 
 export default {
   /**
    * @this {XCUITestDriver}
+   * @returns {Promise<string>}
    */
   async getScreenshot() {
     const getScreenshotFromWDA = async () => {
@@ -38,12 +40,15 @@ export default {
     // simulator attempt
     if (this.isSimulator()) {
       this.log.info(`Falling back to 'simctl io screenshot' API`);
-      // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-      return await this.opts.device.simctl.getScreenshot();
+      const payload = await /** @type {import('../driver').Simulator} */ (this.device).simctl.getScreenshot();
+      if (!payload) {
+        throw new errors.UnableToCaptureScreen();
+      }
+      return payload;
     }
 
     // Retry for real devices only. Fail fast on Simulator if simctl does not work as expected
-    return await retryInterval(2, 1000, getScreenshotFromWDA);
+    return /** @type {string} */ (await retryInterval(2, 1000, getScreenshotFromWDA));
   },
   /**
    * @this {XCUITestDriver}

package/lib/commands/web.js

@@ -995,8 +995,7 @@ const extensions = {
     }
 
     this.log.debug(`About to update Safari preferences: ${JSON.stringify(preferences)}`);
-    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-    await this.opts.device.updateSafariSettings(preferences);
+    await /** @type {import('../driver').Simulator} */ (this.device).updateSafariSettings(preferences);
   },
 };
 

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

@@ -32,8 +32,7 @@ const SUBDIRECTORY = 'Attachments';
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromSimulator(uuid) {
-  // @ts-ignore The property is there
-  const device = this.opts.device;
+  const device = /** @type {import('../driver').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
@@ -59,8 +58,7 @@ async function retrieveRecodingFromSimulator(uuid) {
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromRealDevice(uuid) {
-  // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-  const device = this.opts.device;
+  const device = /** @type {import('../real-device').RealDevice} */ (this.device);
 
   const fileNames = await device.devicectl.listFiles(DOMAIN_TYPE, DOMAIN_IDENTIFIER, {
     username: USERNAME,

package/lib/commands/xctest.js

@@ -16,15 +16,13 @@ const xctestLog = logger.getLogger('XCTest');
  * @param {XCUITestDriver['opts']} opts Opts object from the driver instance
  */
 export function assertIDB(opts) {
-  // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-  if (!opts.device?.idb || !opts.launchWithIDB) {
+  if (!this.device?.idb || !opts.launchWithIDB) {
     throw new Error(
       `To use XCTest runner, IDB (https://github.com/facebook/idb) must be installed ` +
         `and sessions must be run with the "launchWithIDB" capability`,
     );
   }
-  // @ts-expect-error - do not assign arbitrary properties to `this.opts`
-  return opts.device.idb;
+  return this.device.idb;
 }
 
 /**