appium-ios-device 3.1.9 → 3.1.11

package/lib/instrument/transformer/nskeyed.js

@@ -1,10 +1,10 @@
-import plistlib, { parseBuffer } from 'bplist-parser';
+import plistlib, {parseBuffer} from 'bplist-parser';
 import bplistCreate from 'bplist-creator';
-import { parse as uuidParse } from '../../util/uuid/parse';
-import { stringify as uuidStringify } from '../../util/uuid/stringify';
+import {parse as uuidParse} from '../../util/uuid/parse';
+import {stringify as uuidStringify} from '../../util/uuid/stringify';
 import _ from 'lodash';
-import { format as stringFormat } from 'node:util';
-import { log } from '../../logger';
+import {format as stringFormat} from 'node:util';
+import {log} from '../../logger';
 
 const NSKEYED_ARCHIVE_VERSION = 100_000;
 // @ts-ignore UID is not exposed to typedefs
@@ -17,7 +17,6 @@ const UNIX2APPLE_TIMESTAMP_SECOND = 978307200;
 const FORMAT_VERSION = 'formatVersion';
 const NS_OBJECT = 'NSObject';
 
-
 class ArchivedObject {
   /**
    * Stateful wrapper around Archive for an object being archived.
@@ -121,7 +120,7 @@ class NSError extends BaseArchiveHandler {
       $class: 'NSError',
       domain: archive.decode('NSDomain'),
       userinfo: archive.decode('NSUserInfo'),
-      code: archive.decode('NSCode')
+      code: archive.decode('NSCode'),
     };
   }
 }
@@ -132,7 +131,7 @@ class NSException extends BaseArchiveHandler {
       $class: 'NSException',
       reason: archive.decode('NS.reason'),
       userinfo: archive.decode('userinfo'),
-      name: archive.decode('NS.name')
+      name: archive.decode('NS.name'),
     };
   }
 }
@@ -150,7 +149,11 @@ class NSURL extends BaseArchiveHandler {
   }
 
   decodeArchive(archive) {
-    return { $class: 'NSURL', base: archive.decode('NS.base'), relative: archive.decode('NS.relative') };
+    return {
+      $class: 'NSURL',
+      base: archive.decode('NS.base'),
+      relative: archive.decode('NS.relative'),
+    };
   }
 
   encodeArchive(obj, archive) {
@@ -247,7 +250,7 @@ class NSNull extends BaseArchiveHandler {
 class XCTestConfiguration extends BaseArchiveHandler {
   static _default = {
     aggregateStatisticsBeforeCrash: {
-      XCSuiteRecordsKey: {}
+      XCSuiteRecordsKey: {},
     },
     automationFrameworkPath: '/Developer/Library/PrivateFrameworks/XCTAutomationSupport.framework',
     baselineFileRelativePath: undefined,
@@ -278,7 +281,7 @@ class XCTestConfiguration extends BaseArchiveHandler {
     testsToRun: undefined,
     testsToSkip: undefined,
     treatMissingBaselinesAsFailures: false,
-    userAttachmentLifetime: 1
+    userAttachmentLifetime: 1,
   };
 
   /**
@@ -298,7 +301,7 @@ class XCTestConfiguration extends BaseArchiveHandler {
     if (!(data.testBundleURL instanceof NSURL)) {
       throw new TypeError(
         // @ts-ignore constructor is always present
-        `Expected testBundleURL to be a valid NSURL instance, got ${data.testBundleURL.constructor.name} instead`
+        `Expected testBundleURL to be a valid NSURL instance, got ${data.testBundleURL.constructor.name} instead`,
       );
     }
     if (typeof data.sessionIdentifier === 'string') {
@@ -307,10 +310,10 @@ class XCTestConfiguration extends BaseArchiveHandler {
     if (!(data.sessionIdentifier instanceof NSUUID)) {
       throw new TypeError(
         // @ts-ignore constructor is always present
-        `Expected sessionIdentifier to be a valid NSUUID instance, got ${data.sessionIdentifier.constructor.name} instead`
+        `Expected sessionIdentifier to be a valid NSUUID instance, got ${data.sessionIdentifier.constructor.name} instead`,
       );
     }
-    this._data = { ...XCTestConfiguration._default, ...data };
+    this._data = {...XCTestConfiguration._default, ...data};
   }
 
   getBytes() {
@@ -456,7 +459,7 @@ class Archive {
     const val = new plistlib.UID(this.objects.length);
     this.objects.push({
       $classes: [archiver, ...addition],
-      $classname: archiver
+      $classname: archiver,
     });
     return val;
   }
@@ -530,7 +533,10 @@ class Archive {
    */
   encodeXCTestConfiguration(obj, archiveObj) {
     archiveObj.$class = this.uidForArchiver('XCTestConfiguration', NS_OBJECT);
-    _.entries(obj._data).forEach(([key, value]) => archiveObj[key] = (key === FORMAT_VERSION) ? this.archive(value) : this.encode(value));
+    _.entries(obj._data).forEach(
+      ([key, value]) =>
+        (archiveObj[key] = key === FORMAT_VERSION ? this.archive(value) : this.encode(value)),
+    );
   }
 
   toBytes() {
@@ -541,8 +547,8 @@ class Archive {
       $version: NSKEYED_ARCHIVE_VERSION,
       $archiver: NSKEYEDARCHIVER,
       // @ts-ignore UID is not exposed to typedefs
-      $top: { root: new plistlib.UID(1) },
-      $objects: this.objects
+      $top: {root: new plistlib.UID(1)},
+      $objects: this.objects,
     };
     return bplistCreate(d);
   }
@@ -572,8 +578,12 @@ function unarchive(inputBytes) {
  * @param {BaseArchiveHandler} subClass inherit from BaseArchiveHandler class
  */
 function updateNSKeyedArchiveClass(name, subClass) {
-  // @ts-ignore prototype always exists
-  if (!_.isFunction(subClass.prototype?.decodeArchive) && !_.isFunction(subClass.prototype?.encodeArchive)) {
+  if (
+    // @ts-ignore prototype always exists
+    !_.isFunction(subClass.prototype?.decodeArchive) &&
+    // @ts-ignore prototype always exists
+    !_.isFunction(subClass.prototype?.encodeArchive)
+  ) {
     throw new Error('subClass must have decodeArchive or encodeArchive methods');
   }
   if (!(name in UNARCHIVE_CLASS_MAP)) {
@@ -581,4 +591,13 @@ function updateNSKeyedArchiveClass(name, subClass) {
   }
 }
 
-export { updateNSKeyedArchiveClass, BaseArchiveHandler, NSURL, NSUUID, NSDate, XCTestConfiguration, unarchive, archive };
+export {
+  updateNSKeyedArchiveClass,
+  BaseArchiveHandler,
+  NSURL,
+  NSUUID,
+  NSDate,
+  XCTestConfiguration,
+  unarchive,
+  archive,
+};

package/lib/lockdown/index.js

@@ -1,6 +1,5 @@
 import _ from 'lodash';
-import { BaseServicePlist } from '../base-service';
-
+import {BaseServicePlist} from '../base-service';
 
 const LOCKDOWN_PORT = 62078;
 const LABEL = 'usbmuxd';
@@ -12,12 +11,15 @@ class Lockdown extends BaseServicePlist {
    * @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
    * @returns {Promise<any>}
    */
-  async queryType (timeout = 5000) {
-    const data = await this._plistService.sendPlistAndReceive({
-      Label: LABEL,
-      ProtocolVersion: PROTOCOL_VERSION,
-      Request: 'QueryType'
-    }, timeout);
+  async queryType(timeout = 5000) {
+    const data = await this._plistService.sendPlistAndReceive(
+      {
+        Label: LABEL,
+        ProtocolVersion: PROTOCOL_VERSION,
+        Request: 'QueryType',
+      },
+      timeout,
+    );
     if (data.Request === 'QueryType' && data.Type === 'com.apple.mobile.lockdown') {
       return data;
     } else {
@@ -32,17 +34,20 @@ class Lockdown extends BaseServicePlist {
    * @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
    * @returns {Promise<any>}
    */
-  async startSession (hostID, systemBUID, timeout = 5000) {
-    const data = await this._plistService.sendPlistAndReceive({
-      Label: LABEL,
-      ProtocolVersion: PROTOCOL_VERSION,
-      Request: 'StartSession',
-      HostID: hostID,
-      SystemBUID: systemBUID
-    }, timeout);
+  async startSession(hostID, systemBUID, timeout = 5000) {
+    const data = await this._plistService.sendPlistAndReceive(
+      {
+        Label: LABEL,
+        ProtocolVersion: PROTOCOL_VERSION,
+        Request: 'StartSession',
+        HostID: hostID,
+        SystemBUID: systemBUID,
+      },
+      timeout,
+    );
 
     if (data.Request === 'StartSession' && data.SessionID) {
-      return { sessionID: data.SessionID, enableSessionSSL: data.EnableSessionSSL };
+      return {sessionID: data.SessionID, enableSessionSSL: data.EnableSessionSSL};
     } else {
       throw new Error(`Unexpected data: ${JSON.stringify(data)}`);
     }
@@ -53,16 +58,16 @@ class Lockdown extends BaseServicePlist {
    * @param {Buffer} hostPrivateKey the private key which can be retrieved from the pair record
    * @param {Buffer} hostCertificate the certificate which can be retrieved from the pair record
    */
-  enableSessionSSL (hostPrivateKey, hostCertificate) {
+  enableSessionSSL(hostPrivateKey, hostCertificate) {
     this._plistService.enableSessionSSL(hostPrivateKey, hostCertificate);
   }
 
   /**
-  * @typedef {Object} Query
-  *
-  * @property {string} Key The key we want to access
-  * @property {string} Domain The domain where we want to access
-  */
+   * @typedef {Object} Query
+   *
+   * @property {string} Key The key we want to access
+   * @property {string} Domain The domain where we want to access
+   */
 
   /**
    * Gets values from the device according to the query passed
@@ -72,19 +77,20 @@ class Lockdown extends BaseServicePlist {
    * @returns {Promise<any>} The actual response value. It should never be `null` or `undefined`
    * @throws {Error} If an unexpected response is received from lockdownd
    */
-  async getValue (query = {}, timeout = 5000) {
+  async getValue(query = {}, timeout = 5000) {
     const plist = {
       Label: LABEL,
       ProtocolVersion: PROTOCOL_VERSION,
       Request: 'GetValue',
-      ...query
+      ...query,
     };
     const data = await this._plistService.sendPlistAndReceive(plist, timeout);
     if (data?.Request === 'GetValue' && !_.isNil(data?.Value)) {
       return data.Value;
     }
-    throw new Error(`Unexpected data received for ${JSON.stringify(query)} request: ` +
-      JSON.stringify(data));
+    throw new Error(
+      `Unexpected data received for ${JSON.stringify(query)} request: ` + JSON.stringify(data),
+    );
   }
 
   /**
@@ -93,13 +99,16 @@ class Lockdown extends BaseServicePlist {
    * @param {number} [timeout=5000] the timeout of receiving a response from lockdownd
    * @returns {Promise<any>}
    */
-  async startService (serviceName, timeout = 5000) {
-    const data = await this._plistService.sendPlistAndReceive({
-      Label: LABEL,
-      ProtocolVersion: PROTOCOL_VERSION,
-      Request: 'StartService',
-      Service: serviceName,
-    }, timeout);
+  async startService(serviceName, timeout = 5000) {
+    const data = await this._plistService.sendPlistAndReceive(
+      {
+        Label: LABEL,
+        ProtocolVersion: PROTOCOL_VERSION,
+        Request: 'StartService',
+        Service: serviceName,
+      },
+      timeout,
+    );
 
     if (data.Error) {
       throw new Error(`Unexpected data: ${JSON.stringify(data)}`);
@@ -109,5 +118,5 @@ class Lockdown extends BaseServicePlist {
   }
 }
 
-export { Lockdown, LOCKDOWN_PORT };
+export {Lockdown, LOCKDOWN_PORT};
 export default Lockdown;

package/lib/logger.js

@@ -1,3 +1,3 @@
-import { logger } from '@appium/support';
+import {logger} from '@appium/support';
 
 export const log = logger.getLogger('ios-device');

package/lib/mcinstall/index.js

@@ -1,11 +1,10 @@
 import {BaseServicePlist} from '../base-service';
 import {fs, plist} from '@appium/support';
 
-
 const MC_INSTALL_SERVICE_NAME = 'com.apple.mobile.MCInstall';
 const ACKNOWLEDGED = 'Acknowledged';
 
-function checkACK (res, name) {
+function checkACK(res, name) {
   if (res.Status !== ACKNOWLEDGED) {
     throw new Error(`${name} error: ${JSON.stringify(res)}`);
   }
@@ -13,7 +12,7 @@ function checkACK (res, name) {
 }
 
 class MCInstallProxyService extends BaseServicePlist {
-  constructor (socketClient) {
+  constructor(socketClient) {
     super(socketClient);
   }
 
@@ -48,7 +47,7 @@ class MCInstallProxyService extends BaseServicePlist {
    *   Status: 'Acknowledged'
    * }
    */
-  async getProfileList () {
+  async getProfileList() {
     const res = await this._plistService.sendPlistAndReceive({RequestType: 'GetProfileList'});
     return checkACK(res, 'getProfileList');
   }
@@ -59,9 +58,12 @@ class MCInstallProxyService extends BaseServicePlist {
    * e.g: /Downloads/charles-certificate.pem
    * @returns {Promise<Record<any, any>>} e.g. {Status: 'Acknowledged'}
    */
-  async installProfile (path) {
+  async installProfile(path) {
     const payload = await fs.readFile(path);
-    const res = await this._plistService.sendPlistAndReceive({'RequestType': 'InstallProfile', 'Payload': payload});
+    const res = await this._plistService.sendPlistAndReceive({
+      RequestType: 'InstallProfile',
+      Payload: payload,
+    });
     return checkACK(res, 'installProfile');
   }
 
@@ -70,20 +72,25 @@ class MCInstallProxyService extends BaseServicePlist {
    * @param {String} ident  Query identifier list through getProfileList method
    * @returns {Promise<Record<any, any>>} e.g. {Status: 'Acknowledged'}
    */
-  async removeProfile (ident) {
+  async removeProfile(ident) {
     const profiles = await this.getProfileList();
     const meta = profiles.ProfileMetadata[ident];
     if (!meta) {
       throw new Error(`not find installed profile ident:${ident}`);
     }
-    const data = plist.createBinaryPlist({'PayloadType': 'Configuration',
-                                          'PayloadIdentifier': ident,
-                                          'PayloadUUID': meta.PayloadUUID,
-                                          'PayloadVersion': meta.PayloadVersion});
-    const res = await this._plistService.sendPlistAndReceive({'RequestType': 'RemoveProfile', 'ProfileIdentifier': data});
+    const data = plist.createBinaryPlist({
+      PayloadType: 'Configuration',
+      PayloadIdentifier: ident,
+      PayloadUUID: meta.PayloadUUID,
+      PayloadVersion: meta.PayloadVersion,
+    });
+    const res = await this._plistService.sendPlistAndReceive({
+      RequestType: 'RemoveProfile',
+      ProfileIdentifier: data,
+    });
     return checkACK(res, 'removeProfile');
   }
 }
 
-export { MCInstallProxyService, MC_INSTALL_SERVICE_NAME };
+export {MCInstallProxyService, MC_INSTALL_SERVICE_NAME};
 export default MCInstallProxyService;

package/lib/notification-proxy/index.js

@@ -1,11 +1,10 @@
-import { PlistServiceEncoder } from '../plist-service/transformer/plist-service-encoder';
-import { PlistServiceDecoder } from '../plist-service/transformer/plist-service-decoder';
-import { LengthBasedSplitter } from '../util/transformer/length-based-splitter';
-import { KB } from '../constants';
+import {PlistServiceEncoder} from '../plist-service/transformer/plist-service-encoder';
+import {PlistServiceDecoder} from '../plist-service/transformer/plist-service-decoder';
+import {LengthBasedSplitter} from '../util/transformer/length-based-splitter';
+import {KB} from '../constants';
 import _ from 'lodash';
-import { BaseServiceSocket } from '../base-service';
-import { getMaxFrameLength } from '../utilities';
-
+import {BaseServiceSocket} from '../base-service';
+import {getMaxFrameLength} from '../utilities';
 
 const NOTIFICATION_PROXY_SERVICE_NAME = 'com.apple.mobile.notification_proxy';
 const MAX_FRAME_SIZE = 16 * KB;
@@ -14,7 +13,7 @@ const RELAY_NOTIFICATION = 'RelayNotification';
 const PROXY_DEATH = 'ProxyDeath';
 
 class NotificationProxyService extends BaseServiceSocket {
-  constructor (socketClient) {
+  constructor(socketClient) {
     super(socketClient);
 
     this._decoder = new PlistServiceDecoder();
@@ -36,7 +35,7 @@ class NotificationProxyService extends BaseServiceSocket {
     this._decoder.on('data', this._handleData.bind(this));
   }
 
-  _handleData (data) {
+  _handleData(data) {
     switch (data.Command) {
       case RELAY_NOTIFICATION: {
         const listener = this._listeners[data.Name];
@@ -69,14 +68,16 @@ class NotificationProxyService extends BaseServiceSocket {
    * @param {string} notification The name of the notification which is desired to be observed
    * @param {Object} listener The listener object which will be invoked when there is a notification or if the proxy is dead
    */
-  observeNotification (notification, listener) {
+  observeNotification(notification, listener) {
     if (this._listeners[notification]) {
-      throw new Error(`Notification listener for ${notification} already exists. Another one can't be added`);
+      throw new Error(
+        `Notification listener for ${notification} already exists. Another one can't be added`,
+      );
     }
     this._listeners[notification] = listener;
     this._encoder.write({
       Command: 'ObserveNotification',
-      Name: notification
+      Name: notification,
     });
   }
 
@@ -84,27 +85,27 @@ class NotificationProxyService extends BaseServiceSocket {
    * The api to broadcast notifications to the phone. This allows the client to talk to the daemons or apps on the phone
    * @param {*} notification The name of the notification which is desired notified
    */
-  postNotification (notification) {
+  postNotification(notification) {
     this._encoder.write({
       Command: 'PostNotification',
-      Name: notification
+      Name: notification,
     });
   }
 
   /**
    * The api to shutdown the proxy. Consequently, all the notifications that are observing will receive the proxyDeath response
    */
-  shutdown () {
+  shutdown() {
     this._encoder.write({
       Command: 'Shutdown',
     });
   }
 
-  close () {
+  close() {
     this.shutdown();
     super.close();
   }
 }
 
 export default NotificationProxyService;
-export { NotificationProxyService, NOTIFICATION_PROXY_SERVICE_NAME };
+export {NotificationProxyService, NOTIFICATION_PROXY_SERVICE_NAME};

package/lib/plist-service/index.js

@@ -1,19 +1,18 @@
 import B from 'bluebird';
-import { upgradeToSSL } from '../ssl-helper';
-import { PlistServiceEncoder } from './transformer/plist-service-encoder';
-import { PlistServiceDecoder } from './transformer/plist-service-decoder';
-import { LengthBasedSplitter } from '../util/transformer/length-based-splitter';
-import { BaseServiceSocket } from '../base-service';
-import { getMaxFrameLength } from '../utilities';
-import { MB } from '../constants';
-
+import {upgradeToSSL} from '../ssl-helper';
+import {PlistServiceEncoder} from './transformer/plist-service-encoder';
+import {PlistServiceDecoder} from './transformer/plist-service-decoder';
+import {LengthBasedSplitter} from '../util/transformer/length-based-splitter';
+import {BaseServiceSocket} from '../base-service';
+import {getMaxFrameLength} from '../utilities';
+import {MB} from '../constants';
 
 const MAX_FRAME_SIZE = 1 * MB;
 
 const CHECK_FREQ_MS = 50;
 
 class PlistService extends BaseServiceSocket {
-  constructor (socketClient) {
+  constructor(socketClient) {
     super(socketClient);
 
     this._decoder = new PlistServiceDecoder();
@@ -35,19 +34,19 @@ class PlistService extends BaseServiceSocket {
     this._decoder.on('data', (data) => this.replyQueue.push(data));
   }
 
-  async sendPlistAndReceive (json, timeout = 5000) {
+  async sendPlistAndReceive(json, timeout = 5000) {
     this.sendPlist(json);
     return await this.receivePlist(timeout);
   }
 
-  sendPlist (json) {
+  sendPlist(json) {
     if (!json) {
       throw new Error('Cant send a null a object');
     }
     this._encoder.write(json);
   }
 
-  async receivePlist (timeout = 5000) {
+  async receivePlist(timeout = 5000) {
     return await new B((resolve, reject) => {
       const queue = this.replyQueue;
       const data = queue.shift();
@@ -70,7 +69,7 @@ class PlistService extends BaseServiceSocket {
     });
   }
 
-  enableSessionSSL (hostPrivateKey, hostCertificate) {
+  enableSessionSSL(hostPrivateKey, hostCertificate) {
     this._socketClient.unpipe(this._splitter);
     this._encoder.unpipe(this._socketClient);
     this._socketClient = upgradeToSSL(this._socketClient, hostPrivateKey, hostCertificate);
@@ -79,5 +78,5 @@ class PlistService extends BaseServiceSocket {
   }
 }
 
-export { PlistService };
+export {PlistService};
 export default PlistService;

package/lib/plist-service/transformer/plist-service-decoder.js

@@ -1,21 +1,20 @@
 import _ from 'lodash';
 import Stream from 'node:stream';
-import { plist } from '@appium/support';
+import {plist} from '@appium/support';
 
 const HEADER_LENGTH = 4;
 
 class PlistServiceDecoder extends Stream.Transform {
-
-  constructor () {
-    super({ objectMode: true });
+  constructor() {
+    super({objectMode: true});
   }
 
-  _transform (data, encoding, onData) {
+  _transform(data, encoding, onData) {
     this._decode(data);
     onData();
   }
 
-  _decode (data) {
+  _decode(data) {
     const payload = data.slice(HEADER_LENGTH, data.length);
     if (_.isEmpty(payload)) {
       return;
@@ -28,5 +27,5 @@ class PlistServiceDecoder extends Stream.Transform {
   }
 }
 
-export { PlistServiceDecoder };
+export {PlistServiceDecoder};
 export default PlistServiceDecoder;

package/lib/plist-service/transformer/plist-service-encoder.js

@@ -1,20 +1,19 @@
 import Stream from 'node:stream';
-import { plist } from '@appium/support';
-
+import {plist} from '@appium/support';
 
 const HEADER_LENGTH = 4;
 
 class PlistServiceEncoder extends Stream.Transform {
-  constructor () {
-    super({ objectMode: true });
+  constructor() {
+    super({objectMode: true});
   }
 
-  _transform (data, encoding, onData) {
+  _transform(data, encoding, onData) {
     this.push(this._encode(data), 'binary');
     onData();
   }
 
-  _encode (data) {
+  _encode(data) {
     const payloadBuffer = plist.createBinaryPlist(data);
     const headerBuffer = Buffer.alloc(HEADER_LENGTH);
     headerBuffer.writeUInt32BE(payloadBuffer.length, 0);
@@ -22,5 +21,5 @@ class PlistServiceEncoder extends Stream.Transform {
   }
 }
 
-export { PlistServiceEncoder };
+export {PlistServiceEncoder};
 export default PlistServiceEncoder;