appium-remote-debugger 15.2.14 → 15.3.1

package/lib/atoms.ts

@@ -1,5 +1,5 @@
 import { fs } from '@appium/support';
-import path from 'path';
+import path from 'node:path';
 import _ from 'lodash';
 import { log } from './logger';
 import { getModuleRoot } from './utils';

package/lib/remote-debugger.ts

@@ -1,4 +1,4 @@
-import { EventEmitter } from 'events';
+import { EventEmitter } from 'node:events';
 import { log as defaultLog } from './logger';
 import { RpcClientSimulator } from './rpc';
 import { getModuleProperties } from './utils';

package/lib/rpc/remote-messages.ts

@@ -155,7 +155,7 @@ export class RemoteMessages {
     const realParams = {
       targetId,
       message: JSON.stringify({
-        id,
+        id: parseInt(id, 10),
         method,
         params: Object.assign({
           objectGroup: OBJECT_GROUP,
@@ -198,7 +198,7 @@ export class RemoteMessages {
     const realParams = {
       targetId,
       message: JSON.stringify({
-        id,
+        id: parseInt(id, 10),
         method,
         params,
       }),
@@ -233,7 +233,7 @@ export class RemoteMessages {
     const plist = {
       __argument: {
         WIRSocketDataKey: {
-          id,
+          id: parseInt(id, 10),
           method,
           params,
         },

package/lib/rpc/rpc-client-real-device.ts

@@ -0,0 +1,68 @@
+import { log } from '../logger';
+import { RpcClient } from './rpc-client';
+import { services } from 'appium-ios-device';
+import type { RemoteCommand } from '../types';
+
+/**
+ * RPC client implementation for real iOS devices.
+ * Extends RpcClient to provide device-specific connection handling.
+ */
+export class RpcClientRealDevice extends RpcClient {
+  protected service?: any;
+
+  /**
+   * Connects to the Web Inspector service on a real iOS device.
+   * Starts the Web Inspector service and sets up message listening.
+   */
+  override async connect(): Promise<void> {
+    this.service = await services.startWebInspectorService(this.udid, {
+      osVersion: this.platformVersion,
+      isSimulator: false,
+      verbose: this.logAllCommunication,
+      verboseHexDump: this.logAllCommunicationHexDump,
+      socketChunkSize: this.socketChunkSize,
+      maxFrameLength: this.webInspectorMaxFrameLength,
+    });
+
+    this.service.listenMessage(this.receive.bind(this));
+    this.isConnected = true;
+  }
+
+  /**
+   * Disconnects from the Web Inspector service on the real device.
+   * Closes the service connection and cleans up resources.
+   */
+  override async disconnect(): Promise<void> {
+    if (!this.isConnected) {
+      return;
+    }
+
+    log.debug('Disconnecting from remote debugger');
+    await super.disconnect();
+    this.service?.close();
+    this.isConnected = false;
+  }
+
+  /**
+   * Sends a command message to the Web Inspector service.
+   *
+   * @param cmd - The command to send to the device.
+   */
+  override async sendMessage(cmd: RemoteCommand): Promise<void> {
+    if (!this.service) {
+      throw new Error('RPC service is not initialized. Is the client connected?');
+    }
+    this.service.sendMessage(cmd);
+  }
+
+  /**
+   * Receives data from the Web Inspector service and handles it.
+   *
+   * @param data - The data received from the service.
+   */
+  override async receive(data: any): Promise<void> {
+    if (this.isConnected) {
+      await this.messageHandler.handleMessage(data);
+    }
+  }
+}

package/lib/rpc/{rpc-client-simulator.js → rpc-client-simulator.ts}

@@ -1,30 +1,29 @@
 import { log } from '../logger';
 import _ from 'lodash';
 import B from 'bluebird';
-import net from 'net';
+import net from 'node:net';
 import { RpcClient } from './rpc-client';
 import { services } from 'appium-ios-device';
+import type { RpcClientOptions, RpcClientSimulatorOptions, RemoteCommand } from '../types';
 
+/**
+ * RPC client implementation for iOS simulators.
+ * Extends RpcClient to provide simulator-specific connection handling
+ * via TCP sockets or Unix domain sockets.
+ */
 export class RpcClientSimulator extends RpcClient {
-  /** @type {string|undefined} */
-  host;
-
-  /** @type {number|undefined} */
-  port;
-
-  /** @type {any} */
-  messageProxy;
-
-  /** @type {import('node:net').Socket|null} */
-  socket;
-
-  /** @type {string|undefined} */
-  socketPath;
+  protected readonly host?: string;
+  protected port?: number;
+  protected readonly messageProxy?: any;
+  protected socket: net.Socket | null;
+  protected readonly socketPath?: string;
+  protected service?: any;
 
   /**
-   * @param {import('./rpc-client').RpcClientOptions & RpcClientSimulatorOptions} [opts={}]
+   * @param opts - Options for configuring the RPC client, including
+   *                simulator-specific options like socketPath, host, and port.
    */
-  constructor (opts = {}) {
+  constructor(opts: RpcClientOptions & RpcClientSimulatorOptions = {}) {
     super(opts);
 
     const {
@@ -44,9 +43,10 @@ export class RpcClientSimulator extends RpcClient {
   }
 
   /**
-   * @override
+   * Connects to the Web Inspector service on an iOS simulator.
+   * Supports both Unix domain sockets and TCP connections, with optional proxy support.
    */
-  async connect () {
+  override async connect(): Promise<void> {
     // create socket and handle its messages
     if (this.socketPath) {
       if (this.messageProxy) {
@@ -57,10 +57,11 @@ export class RpcClientSimulator extends RpcClient {
         // Forward the actual socketPath to the proxy
         this.socket.once('connect', () => {
           log.debug(`Forwarding the actual web inspector socket to the proxy: '${this.socketPath}'`);
-          // @ts-ignore socket must be efined here
-          this.socket.write(JSON.stringify({
-            socketPath: this.socketPath
-          }));
+          if (this.socket) {
+            this.socket.write(JSON.stringify({
+              socketPath: this.socketPath
+            }));
+          }
         });
 
       } else {
@@ -77,7 +78,11 @@ export class RpcClientSimulator extends RpcClient {
       // tcp socket
       log.debug(`Connecting to remote debugger ${this.messageProxy ? 'via proxy ' : ''}through TCP: ${this.host}:${this.port}`);
       this.socket = new net.Socket();
-      this.socket.connect(/** @type {number} */ (this.port), /** @type {String} */ (this.host));
+      if (this.port && this.host) {
+        this.socket.connect(this.port, this.host);
+      } else {
+        throw new Error('Both port and host must be defined for TCP connection');
+      }
     }
 
     this.socket.setNoDelay(true);
@@ -103,16 +108,17 @@ export class RpcClientSimulator extends RpcClient {
     this.service.listenMessage(this.receive.bind(this));
 
     // connect the socket
-    return await new B((resolve, reject) => {
+    return await new B<void>((resolve, reject) => {
       // only resolve this function when we are actually connected
-      // @ts-ignore socket must be defined here
+      if (!this.socket) {
+        return reject(new Error('RPC socket is not connected. Please contact developers'));
+      }
       this.socket.on('connect', () => {
         log.debug(`Debugger socket connected`);
         this.isConnected = true;
 
         resolve();
       });
-      // @ts-ignore socket must be defined here
       this.socket.on('error', (err) => {
         if (this.isConnected) {
           log.error(`Socket error: ${err.message}`);
@@ -126,37 +132,41 @@ export class RpcClientSimulator extends RpcClient {
   }
 
   /**
-   * @override
+   * Disconnects from the Web Inspector service on the simulator.
+   * Closes the socket and service connection, and cleans up resources.
    */
-  async disconnect () {
+  override async disconnect(): Promise<void> {
     if (!this.isConnected) {
       return;
     }
 
     log.debug('Disconnecting from remote debugger');
     await super.disconnect();
-    this.service.close();
+    this.service?.close();
     this.isConnected = false;
   }
 
   /**
-   * @override
+   * Sends a command message to the Web Inspector service via the socket.
+   * Handles socket errors and ensures the socket is available before sending.
+   *
+   * @param cmd - The command to send to the simulator.
    */
-  async sendMessage (cmd) {
-    let onSocketError;
+  override async sendMessage(cmd: RemoteCommand): Promise<void> {
+    let onSocketError: ((err: Error) => void) | undefined;
 
-    return await new B((resolve, reject) => {
+    return await new B<void>((resolve, reject) => {
       // handle socket problems
-      onSocketError = (err) => {
+      onSocketError = (err: Error) => {
         log.error(`Socket error: ${err.message}`);
 
         // the connection was refused, so reject the connect promise
         reject(err);
       };
 
-      if (!this.socket) {
+      if (!this.socket || !this.service) {
         return reject(
-          new Error('The RPC socket is not defined. Have you called `connect()` before sending a message?')
+          new Error('The RPC client is not connected. Have you called `connect()` before sending a message?')
         );
       }
       this.socket.on('error', onSocketError);
@@ -165,22 +175,20 @@ export class RpcClientSimulator extends RpcClient {
     })
     .finally(() => {
       // remove this listener, so we don't exhaust the system
-      try {
-        // @ts-ignore socket must be defined
+      if (this.socket && onSocketError) {
         this.socket.removeListener('error', onSocketError);
-      } catch {}
+      }
     });
   }
 
   /**
-   * @override
+   * Receives data from the Web Inspector service and handles it.
+   * Converts Buffer data to strings for certain message keys.
+   *
+   * @param data - The data received from the service.
    */
-  async receive (data) {
-    if (!this.isConnected) {
-      return;
-    }
-
-    if (!data) {
+  override async receive(data: any): Promise<void> {
+    if (!this.isConnected || !data) {
       return;
     }
 
@@ -189,17 +197,6 @@ export class RpcClientSimulator extends RpcClient {
         data[key] = data[key].toString('utf8');
       }
     }
-    // @ts-ignore messageHandler must be defined
     await this.messageHandler.handleMessage(data);
   }
 }
-
-export default RpcClientSimulator;
-
-/**
- * @typedef {Object} RpcClientSimulatorOptions
- * @property {string} [socketPath]
- * @property {string} [host='::1']
- * @property {number} [port]
- * @property {any} [messageProxy]
- */