appium-ios-device 3.1.9 → 3.1.11

package/lib/instrument/headers.js

@@ -1,19 +1,19 @@
 import {archive, unarchive} from './transformer/nskeyed';
-import { parseBuffer } from 'bplist-parser';
+import {parseBuffer} from 'bplist-parser';
 import _ from 'lodash';
 
 const DTX_MESSAGE_PAYLOAD_HEADER_LENGTH = 16;
 const DTX_MESSAGE_HEADER_LENGTH = 32;
-const DTX_MESSAGE_HEADER_MAGIC = 0x1F3D5B79;
+const DTX_MESSAGE_HEADER_MAGIC = 0x1f3d5b79;
 const DTX_MESSAGE_HEADER_MAGIC_LEN = 4;
-const DTX_MESSAGE_AUX_HEADER = 0x01F0;
+const DTX_MESSAGE_AUX_HEADER = 0x01f0;
 const DTX_AUXILIARY_MAGIC = 0xa;
 
 const FLAG_TYPES = Object.freeze({
   push: 0,
   recv: 1,
   send: 2,
-  reply: 3
+  reply: 3,
 });
 
 const AUX_TYPES = Object.freeze({
@@ -21,7 +21,7 @@ const AUX_TYPES = Object.freeze({
   NSKeyed: 2,
   UInt32LE: 3,
   BigUInt64LE: 4,
-  BigInt64LE: 6
+  BigInt64LE: 6,
 });
 
 /**
@@ -56,7 +56,7 @@ class DTXMessageHeader {
    * @param {Partial<DTXMessageOptions>} data
    * @returns {Buffer} DTXMessageHeaderBuffer
    */
-  static build (data) {
+  static build(data) {
     const messageHeader = Buffer.alloc(DTX_MESSAGE_HEADER_LENGTH);
     messageHeader.writeUInt32LE(DTX_MESSAGE_HEADER_MAGIC, 0);
     messageHeader.writeUInt32LE(DTX_MESSAGE_HEADER_LENGTH, 4);
@@ -74,7 +74,7 @@ class DTXMessageHeader {
    * @param headerBuffer DTXMessageHeaderBuffer
    * @returns {Object}
    */
-  static parse (headerBuffer) {
+  static parse(headerBuffer) {
     return {
       magic: headerBuffer.readUInt32LE(0),
       headerLength: headerBuffer.readUInt32LE(4),
@@ -109,7 +109,7 @@ class DTXMessagePayloadHeader {
    * @param data {DTXMessagePayloadHeaderObject}
    * @returns {Buffer} DTXMessagePayloadHeaderBuffer
    */
-  static build (data) {
+  static build(data) {
     const messageHeader = Buffer.alloc(DTX_MESSAGE_PAYLOAD_HEADER_LENGTH);
     messageHeader.writeUInt32LE(data.flags, 0);
     messageHeader.writeUInt32LE(data.auxLength, 4);
@@ -121,21 +121,20 @@ class DTXMessagePayloadHeader {
    * @param headerBuffer
    * @returns {DTXMessagePayloadHeaderObject}
    */
-  static parse (headerBuffer) {
+  static parse(headerBuffer) {
     return {
       flags: headerBuffer.readUInt32LE(0),
       auxLength: headerBuffer.readUInt32LE(4),
-      totalLength: headerBuffer.readBigInt64LE(8)
+      totalLength: headerBuffer.readBigInt64LE(8),
     };
   }
 }
 
-
 class DTXMessageAux {
   /**
    * @param {any[] | DTXMessageAuxBuffer} data
    */
-  constructor (data = []) {
+  constructor(data = []) {
     this.data = data;
   }
 
@@ -143,7 +142,7 @@ class DTXMessageAux {
    * JS Array to Apple NSKeyed Buffer
    * @returns {Buffer}
    */
-  build () {
+  build() {
     if (this.data instanceof DTXMessageAuxBuffer) {
       return this.data.getBytes();
     }
@@ -169,7 +168,7 @@ class DTXMessageAux {
    * @param {DTXMessagePayloadHeaderObject} payloadHeader
    * @returns {any[]}
    */
-  static parse (headerBuffer, payloadHeader) {
+  static parse(headerBuffer, payloadHeader) {
     let cursor = 0;
     const data = [];
     const length = headerBuffer.readBigInt64LE(8);
@@ -221,20 +220,20 @@ class DTXMessageAux {
 }
 
 class InstrumentRPCParseError {
-  constructor (data) {
+  constructor(data) {
     this.data = data;
   }
 }
 
 class DTXMessageAuxBuffer {
-  constructor () {
+  constructor() {
     this._buf = Buffer.alloc(0);
   }
 
   /**
    * @param {number} value
    */
-  appendInt (value) {
+  appendInt(value) {
     const buf = Buffer.alloc(12);
     buf.writeUInt32LE(DTX_AUXILIARY_MAGIC, 0);
     buf.writeUInt32LE(3, 4);
@@ -245,7 +244,7 @@ class DTXMessageAuxBuffer {
   /**
    * @param {bigint} value
    */
-  appendLong (value) {
+  appendLong(value) {
     const buf = Buffer.alloc(16);
     buf.writeUInt32LE(DTX_AUXILIARY_MAGIC, 0);
     buf.writeUInt32LE(4, 4);
@@ -256,7 +255,7 @@ class DTXMessageAuxBuffer {
   /**
    * @param {number} value
    */
-  appendSignedInt (value) {
+  appendSignedInt(value) {
     const buf = Buffer.alloc(12);
     buf.writeUInt32LE(DTX_AUXILIARY_MAGIC, 0);
     buf.writeUInt32LE(3, 4);
@@ -267,7 +266,7 @@ class DTXMessageAuxBuffer {
   /**
    * @param {bigint} value
    */
-  appendSignedLong (value) {
+  appendSignedLong(value) {
     const buf = Buffer.alloc(16);
     buf.writeUInt32LE(DTX_AUXILIARY_MAGIC, 0);
     buf.writeUInt32LE(6, 4);
@@ -278,7 +277,7 @@ class DTXMessageAuxBuffer {
   /**
    * @param {Object} value
    */
-  appendObject (value) {
+  appendObject(value) {
     const buf = archive(value);
     const buf2 = Buffer.alloc(12);
     buf2.writeUInt32LE(DTX_AUXILIARY_MAGIC, 0);
@@ -287,7 +286,7 @@ class DTXMessageAuxBuffer {
     this._buf = Buffer.concat([this._buf, buf2, buf]);
   }
 
-  getBytes () {
+  getBytes() {
     const out = Buffer.alloc(16);
     out.writeUInt32LE(DTX_MESSAGE_AUX_HEADER, 0);
     out.writeUInt32LE(this._buf.length, 8);
@@ -295,20 +294,18 @@ class DTXMessageAuxBuffer {
   }
 }
 
-
-
 class DTXMessage {
   /**
    * @param {Partial<DTXMessageOptions>} opts
    */
-  constructor (opts = {}) {
+  constructor(opts = {}) {
     const {
       identifier,
       channelCode,
       selector,
       expectsReply,
       conversationIndex = 0,
-      flags = FLAG_TYPES.send
+      flags = FLAG_TYPES.send,
     } = opts;
     this._messageHeader = undefined;
     this._payloadHeader = undefined;
@@ -325,7 +322,7 @@ class DTXMessage {
    * get DTXMessageHeader identifier. Packet transmission sequence
    * @returns {number}
    */
-  get identifier () {
+  get identifier() {
     return this._messageHeader?.identifier;
   }
 
@@ -335,7 +332,7 @@ class DTXMessage {
    * call this method `InstrumentService.registerChannelCallback` get the channel message
    * @returns {number}
    */
-  get channelCode () {
+  get channelCode() {
     return this._messageHeader?.channel;
   }
 
@@ -344,7 +341,7 @@ class DTXMessage {
    * if expectsReply is true must reply ack message
    * @returns {boolean}
    */
-  get expectsReply () {
+  get expectsReply() {
     return this._messageHeader?.expectsReply;
   }
 
@@ -352,14 +349,14 @@ class DTXMessage {
    * call this method `InstrumentService.registerSelectorCallback` get the selector message
    * @returns {*} Unknown data
    */
-  get selector () {
+  get selector() {
     return this._selector;
   }
 
   /**
    * @param data
    */
-  set selector (data) {
+  set selector(data) {
     this._selector = data;
   }
 
@@ -367,7 +364,7 @@ class DTXMessage {
    * get DTXMessageHeader conversationIndex
    * @returns {number}
    */
-  get conversationIndex () {
+  get conversationIndex() {
     return this._messageHeader?.conversationIndex;
   }
 
@@ -375,7 +372,7 @@ class DTXMessage {
    * DTXMessage Buffer: DTXMessageHeader + PayloadHeader + DTXMessageAuxBuffer(nullable) + selector(nullable)
    * @returns {Buffer}
    */
-  build () {
+  build() {
     const sel = this._selector ? archive(this._selector) : Buffer.alloc(0);
     const aux = this.auxiliaries.build();
     const payloadHeader = DTXMessagePayloadHeader.build({
@@ -390,7 +387,7 @@ class DTXMessage {
       identifier: this._identifier,
       conversationIndex: this._conversationIndex,
       channelCode: this._channelCode,
-      expectsReply: this._expectsReply
+      expectsReply: this._expectsReply,
     });
     return Buffer.concat([messageHeader, payloadHeader, aux, sel]);
   }
@@ -401,14 +398,16 @@ class DTXMessage {
    * @param {Buffer} payloadBuf  PayloadHeaderBuffer + DTXMessageAuxBuffer(nullable) + selectorBuffer(nullable)
    * @returns {DTXMessage}
    */
-  static parse (headerBuf, payloadBuf) {
+  static parse(headerBuf, payloadBuf) {
     let cursor = 0;
     const ret = new DTXMessage();
     ret._messageHeader = DTXMessageHeader.parse(headerBuf);
     if (ret._messageHeader.payloadLength === 0) {
       return ret;
     }
-    ret._payloadHeader = DTXMessagePayloadHeader.parse(payloadBuf.slice(cursor, DTX_MESSAGE_PAYLOAD_HEADER_LENGTH));
+    ret._payloadHeader = DTXMessagePayloadHeader.parse(
+      payloadBuf.slice(cursor, DTX_MESSAGE_PAYLOAD_HEADER_LENGTH),
+    );
     cursor += DTX_MESSAGE_PAYLOAD_HEADER_LENGTH;
     // totalLength is bigint use 0n
     if (ret._payloadHeader.totalLength === 0n) {
@@ -416,7 +415,10 @@ class DTXMessage {
     }
     if (ret._payloadHeader.auxLength > 0) {
       // @ts-ignore Not 100% sure if this ok
-      ret.auxiliaries = DTXMessageAux.parse(payloadBuf.slice(cursor, cursor + ret._payloadHeader.auxLength), ret._payloadHeader);
+      ret.auxiliaries = DTXMessageAux.parse(
+        payloadBuf.slice(cursor, cursor + ret._payloadHeader.auxLength),
+        ret._payloadHeader,
+      );
       cursor += ret._payloadHeader.auxLength;
     }
 
@@ -436,6 +438,15 @@ class DTXMessage {
   }
 }
 
-export { DTXMessageHeader, DTXMessagePayloadHeader, DTXMessageAuxBuffer, DTXMessageAux, DTXMessage,
-  DTX_MESSAGE_PAYLOAD_HEADER_LENGTH, DTX_MESSAGE_HEADER_LENGTH, DTX_MESSAGE_HEADER_MAGIC, DTX_MESSAGE_HEADER_MAGIC_LEN,
-  FLAG_TYPES};
+export {
+  DTXMessageHeader,
+  DTXMessagePayloadHeader,
+  DTXMessageAuxBuffer,
+  DTXMessageAux,
+  DTXMessage,
+  DTX_MESSAGE_PAYLOAD_HEADER_LENGTH,
+  DTX_MESSAGE_HEADER_LENGTH,
+  DTX_MESSAGE_HEADER_MAGIC,
+  DTX_MESSAGE_HEADER_MAGIC_LEN,
+  FLAG_TYPES,
+};

package/lib/instrument/index.js

@@ -1,19 +1,20 @@
 // Adapted from https://github.com/YueChen-C/py-ios-device
 
-import { BaseServiceSocket } from '../base-service';
-import { DTXMessage, DTXMessageAuxBuffer, FLAG_TYPES } from './headers';
-import { DTXEncoder } from './transformer/dtx-encode';
-import { DTXDecoder } from './transformer/dtx-decode';
+import {BaseServiceSocket} from '../base-service';
+import {DTXMessage, DTXMessageAuxBuffer, FLAG_TYPES} from './headers';
+import {DTXEncoder} from './transformer/dtx-encode';
+import {DTXDecoder} from './transformer/dtx-decode';
 import events from 'node:events';
 import _ from 'lodash';
-import { waitForCondition } from 'asyncbox';
+import {waitForCondition} from 'asyncbox';
 
 const CHECK_FREQ_MS = 500;
 const WAIT_REPLY_TIME_MS = 10000;
 const CHANNEL_CANCELED = '_channelCanceled';
 const CHANNEL_OFFSET = 2 ** 32;
 
-const INSTRUMENT_SERVICE_NAME_VERSION_14 = 'com.apple.instruments.remoteserver.DVTSecureSocketProxy';
+const INSTRUMENT_SERVICE_NAME_VERSION_14 =
+  'com.apple.instruments.remoteserver.DVTSecureSocketProxy';
 const INSTRUMENT_SERVICE_NAME = 'com.apple.instruments.remoteserver';
 
 export const INSTRUMENT_CHANNEL = Object.freeze({
@@ -24,7 +25,7 @@ export const INSTRUMENT_CHANNEL = Object.freeze({
   MOBILE_NOTIFICATIONS: 'com.apple.instruments.server.services.mobilenotifications',
   GRAPHICS_OPENGL: 'com.apple.instruments.server.services.graphics.opengl',
   APPLICATION_LISTING: 'com.apple.instruments.server.services.device.applictionListing',
-  CONDITION_INDUCER: 'com.apple.instruments.server.services.ConditionInducer'
+  CONDITION_INDUCER: 'com.apple.instruments.server.services.ConditionInducer',
 });
 
 function defaultDict(createValue) {
@@ -34,14 +35,14 @@ function defaultDict(createValue) {
         storage[property] = createValue(property);
       }
       return storage[property];
-    }
+    },
   });
 }
 
 /** The callback function which will be called during the data transmission in instrument serve
  * @callback DTXCallback
  * @param {DTXMessage} object
-*/
+ */
 
 class InstrumentService extends BaseServiceSocket {
   /**
@@ -53,7 +54,7 @@ class InstrumentService extends BaseServiceSocket {
     this._undefinedCallback = event;
     this._callbacks = new events.EventEmitter();
     this._channelCallbacks = new events.EventEmitter();
-    const { proxy, revoke } = defaultDict(() => []);
+    const {proxy, revoke} = defaultDict(() => []);
     this._replyQueues = proxy;
     this._replyQueuesRevoker = revoke;
     this._channels = {};
@@ -141,19 +142,29 @@ class InstrumentService extends BaseServiceSocket {
       sync,
       channelCode,
       selector,
-      auxiliaries: (auxiliaries.length === 1 && auxiliaries[0] instanceof DTXMessageAuxBuffer) ? auxiliaries[0] : auxiliaries,
-      identifier
+      auxiliaries:
+        auxiliaries.length === 1 && auxiliaries[0] instanceof DTXMessageAuxBuffer
+          ? auxiliaries[0]
+          : auxiliaries,
+      identifier,
     });
     ++this._nextIdentifier;
     if (sync) {
       try {
-        return await waitForCondition(() => {
-          const queue = this._replyQueues[identifier];
-          const data = queue.shift();
-          if (!_.isUndefined(data)) {
-            return data;
-          }
-        }, { waitMs: WAIT_REPLY_TIME_MS, intervalMs: CHECK_FREQ_MS, error: 'reply channel data timeout' });
+        return await waitForCondition(
+          () => {
+            const queue = this._replyQueues[identifier];
+            const data = queue.shift();
+            if (!_.isUndefined(data)) {
+              return data;
+            }
+          },
+          {
+            waitMs: WAIT_REPLY_TIME_MS,
+            intervalMs: CHECK_FREQ_MS,
+            error: 'reply channel data timeout',
+          },
+        );
       } catch (err) {
         this.close();
         throw new Error(err);
@@ -196,7 +207,7 @@ class InstrumentService extends BaseServiceSocket {
       identifier: data.identifier,
       channelCode: data.channelCode,
       conversationIndex: data.conversationIndex + 1,
-      flags: FLAG_TYPES.reply
+      flags: FLAG_TYPES.reply,
     });
     this._socketClient.write(reply.build());
   }
@@ -212,4 +223,4 @@ class InstrumentService extends BaseServiceSocket {
   }
 }
 
-export { InstrumentService, INSTRUMENT_SERVICE_NAME_VERSION_14, INSTRUMENT_SERVICE_NAME };
+export {InstrumentService, INSTRUMENT_SERVICE_NAME_VERSION_14, INSTRUMENT_SERVICE_NAME};

package/lib/instrument/transformer/dtx-decode.js

@@ -1,41 +1,50 @@
 import Stream from 'node:stream';
 import {
-  DTX_MESSAGE_HEADER_LENGTH, DTX_MESSAGE_HEADER_MAGIC, DTX_MESSAGE_HEADER_MAGIC_LEN,
-  DTXMessageHeader, DTXMessage,
+  DTX_MESSAGE_HEADER_LENGTH,
+  DTX_MESSAGE_HEADER_MAGIC,
+  DTX_MESSAGE_HEADER_MAGIC_LEN,
+  DTXMessageHeader,
+  DTXMessage,
 } from '../headers';
-import { log } from '../../logger';
+import {log} from '../../logger';
 
 class DTXDecoder extends Stream.Transform {
-
-  constructor () {
-    super({ objectMode: true });
+  constructor() {
+    super({objectMode: true});
     this._dtxManager = {};
     this.buffer = Buffer.allocUnsafe(0);
     this.cursor = 0;
     this.header = undefined;
   }
 
-  _transform (data, encoding, onData) {
+  _transform(data, encoding, onData) {
     this._decode(data);
     onData();
   }
 
-  _decode (data) {
+  _decode(data) {
     // Merge packets
     this.buffer = Buffer.concat([this.buffer.slice(this.cursor, this.buffer.length), data]);
     this.cursor = 0;
     while (this.cursor < this.buffer.length) {
       const magic = this._recv(DTX_MESSAGE_HEADER_MAGIC_LEN);
-      if (!magic) { return; }
+      if (!magic) {
+        return;
+      }
       this.cursor -= DTX_MESSAGE_HEADER_MAGIC_LEN;
       if (magic && magic.readUInt32LE(0) === DTX_MESSAGE_HEADER_MAGIC) {
         const headerBuffer = this._recv(DTX_MESSAGE_HEADER_LENGTH);
-        if (!headerBuffer) { return; }
+        if (!headerBuffer) {
+          return;
+        }
         this.header = DTXMessageHeader.parse(headerBuffer);
         if (this.header.fragmentId === 0) {
           // only the 0th fragment contains a message header
           if (!(this.header.channel in this._dtxManager)) {
-            this._dtxManager[this.header.channel] = {headerBuffer, payloadBuffer: Buffer.allocUnsafe(0)};
+            this._dtxManager[this.header.channel] = {
+              headerBuffer,
+              payloadBuffer: Buffer.allocUnsafe(0),
+            };
           }
           if (this.header.fragmentCount > 1) {
             // Continue to get the next message fragments
@@ -44,11 +53,16 @@ class DTXDecoder extends Stream.Transform {
         }
       }
       const bodyBuffer = this._recv(this.header.payloadLength);
-      if (!bodyBuffer) { return; }
+      if (!bodyBuffer) {
+        return;
+      }
       if (this._dtxManager[this.header.channel]) {
-        this._dtxManager[this.header.channel].payloadBuffer = Buffer.concat([this._dtxManager[this.header.channel].payloadBuffer, bodyBuffer]);
+        this._dtxManager[this.header.channel].payloadBuffer = Buffer.concat([
+          this._dtxManager[this.header.channel].payloadBuffer,
+          bodyBuffer,
+        ]);
       }
-      if (this.header.fragmentId === (this.header.fragmentCount - 1)) {
+      if (this.header.fragmentId === this.header.fragmentCount - 1) {
         data = this._dtxManager[this.header.channel];
         delete this._dtxManager[this.header.channel];
         if (data) {
@@ -66,7 +80,7 @@ class DTXDecoder extends Stream.Transform {
     this.buffer = Buffer.allocUnsafe(0);
   }
 
-  _recv (length) {
+  _recv(length) {
     if (this.buffer.length < this.cursor + length) {
       return null;
     }
@@ -76,4 +90,4 @@ class DTXDecoder extends Stream.Transform {
   }
 }
 
-export { DTXDecoder };
+export {DTXDecoder};

package/lib/instrument/transformer/dtx-encode.js

@@ -1,25 +1,23 @@
 import Stream from 'node:stream';
 import {DTXMessage, DTXMessageAux} from '../headers';
 
-
 class DTXEncoder 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 {sync, channelCode, selector, auxiliaries, identifier} = data;
     const dtx = new DTXMessage({
       identifier,
       channelCode,
       selector,
-      expectsReply: sync
+      expectsReply: sync,
     });
     if (auxiliaries instanceof DTXMessageAux) {
       dtx.auxiliaries = auxiliaries;
@@ -30,4 +28,4 @@ class DTXEncoder extends Stream.Transform {
   }
 }
 
-export { DTXEncoder };
+export {DTXEncoder};