chore: include devicectl in IOSDeploy object (#2352)

* chore: include devicectl in IOSDeploy object * add ignore * define once to reduce ignore * define once to reduce ignore * mofidy log
appium · Mar 25, 2024 · 6c5abd1 · 6c5abd1
1 parent e393989
commit 6c5abd1
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 16 deletions.
diff --git a/lib/commands/memory.js b/lib/commands/memory.js
@@ -1,5 +1,4 @@
 import _ from 'lodash';
-import { Devicectl } from '../devicectl';
 import { errors } from 'appium/driver';
 
 export default {
@@ -16,9 +15,11 @@ export default {
       throw new Error('Memory warning simulation is only supported on real devices');
     }
 
-    const devicectl = new Devicectl(this.opts.udid, this.log);
+    // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+    const device = this.opts.device;
+
     /** @type {import('../devicectl').AppInfo[]} */
-    const appInfos = await devicectl.listApps(bundleId);
+    const appInfos = await device.devicectl.listApps(bundleId);
     if (_.isEmpty(appInfos)) {
       throw new errors.InvalidArgumentError(
         `The application identified by ${bundleId} cannot be found on the device. Is it installed?`
@@ -36,7 +37,7 @@ export default {
     // allow to connect a bundle id to a process id.
     const pattern = new RegExp(`^${_.escapeRegExp(appInfos[0].url)}[^/]+$`);
     /** @type {number[]} */
-    const pids = (await devicectl.listProcesses())
+    const pids = (await device.devicectl.listProcesses())
       .filter(({executable}) => pattern.test(executable))
       .map(({processIdentifier}) => processIdentifier);
     if (_.isEmpty(pids)) {
@@ -45,7 +46,7 @@ export default {
       );
     }
     this.log.info(`Emulating Low Memory warning for the process id ${pids[0]}, bundle id ${bundleId}`);
-    await devicectl.sendMemoryWarning(pids[0]);
+    await device.devicectl.sendMemoryWarning(pids[0]);
   }
 };
 

diff --git a/lib/commands/xctest-record-screen.js b/lib/commands/xctest-record-screen.js
@@ -2,7 +2,6 @@ import _ from 'lodash';
 import {fs, util} from 'appium/support';
 import {encodeBase64OrUpload} from '../utils';
 import path from 'node:path';
-import {Devicectl} from '../devicectl';
 
 const MOV_EXT = '.mov';
 const FEATURE_NAME = 'xctest_screen_record';
@@ -60,8 +59,10 @@ async function retrieveRecodingFromSimulator(uuid) {
  * @returns {Promise<string>} The full path to the screen recording movie
  */
 async function retrieveRecodingFromRealDevice(uuid) {
-  const devicectl = new Devicectl(this.opts.udid, this.log);
-  const fileNames = await devicectl.listFiles(DOMAIN_TYPE, DOMAIN_IDENTIFIER, {
+  // @ts-expect-error - do not assign arbitrary properties to `this.opts`
+  const device = this.opts.device;
+
+  const fileNames = await device.devicectl.listFiles(DOMAIN_TYPE, DOMAIN_IDENTIFIER, {
     username: USERNAME,
     subdirectory: SUBDIRECTORY,
   });
@@ -71,7 +72,7 @@ async function retrieveRecodingFromRealDevice(uuid) {
     );
   }
   const videoPath = path.join(/** @type {string} */ (this.opts.tmpDir), `${uuid}${MOV_EXT}`);
-  await devicectl.pullFile(`${SUBDIRECTORY}/${uuid}`, videoPath, {
+  await device.devicectl.pullFile(`${SUBDIRECTORY}/${uuid}`, videoPath, {
     username: USERNAME,
     domainIdentifier: DOMAIN_IDENTIFIER,
     domainType: DOMAIN_TYPE,

diff --git a/lib/driver.js b/lib/driver.js
@@ -1230,7 +1230,7 @@ class XCUITestDriver extends BaseDriver {
         }
       }
 
-      const device = getRealDeviceObj(this.opts.udid);
+      const device = getRealDeviceObj(this.opts.udid, this.log);
       return {device, realDevice: true, udid: this.opts.udid};
     }
 

diff --git a/lib/real-device-management.js b/lib/real-device-management.js
@@ -124,11 +124,12 @@ async function installToRealDevice(device, app, bundleId, opts) {
 
 /**
  * @param {string} udid
+ * @param {import('@appium/types').AppiumLogger} logger
  * @returns {RealDevice}
  */
-function getRealDeviceObj(udid) {
+function getRealDeviceObj(udid, logger) {
   log.debug(`Creating iDevice object with udid '${udid}'`);
-  return new RealDevice(udid);
+  return new RealDevice(udid, logger);
 }
 
 export {

diff --git a/lib/real-device.js b/lib/real-device.js
@@ -21,8 +21,9 @@ const APP_INSTALL_STRATEGY = Object.freeze({
 });
 
 class RealDevice {
-  constructor(udid) {
+  constructor(udid, logger) {
     this.udid = udid;
+    this.devicectl = new Devicectl(this.udid, logger);
   }
 
   async remove(bundleId) {
@@ -211,15 +212,14 @@ class RealDevice {
       if (util.compareVersions(platformVersion, '>=', '17.0')) {
         log.debug(`Calling devicectl to kill the process`);
 
-        const devicectl = new Devicectl(this.udid, log);
-        const pids = (await devicectl.listProcesses())
+        const pids = (await this.devicectl.listProcesses())
           .filter(({executable}) => executable.endsWith(`/${executableName}`))
           .map(({processIdentifier}) => processIdentifier);
         if (_.isEmpty(pids)) {
           log.info(`The process of the bundle id '${bundleId}' was not running`);
           return false;
         }
-        await devicectl.sendSignalToProcess(pids[0], 2);
+        await this.devicectl.sendSignalToProcess(pids[0], 2);
       } else {
         instrumentService = await services.startInstrumentService(this.udid);
         const processes = await instrumentService.callChannel(