appium-remote-debugger 15.7.3 → 15.8.1

package/lib/remote-debugger.ts

@@ -10,50 +10,16 @@ import * as cookieMixins from './mixins/cookies';
 import * as screenshotMixins from './mixins/screenshot';
 import * as eventMixins from './mixins/events';
 import * as miscellaneousMixins from './mixins/misc';
-import _ from 'lodash';
+import {util} from '@appium/support';
 import type {RemoteDebuggerOptions, AppDict, EventListener, PageIdKey, AppIdKey} from './types';
 import type {AppiumLogger, StringRecord} from '@appium/types';
 import type {RpcClient} from './rpc/rpc-client';
-import type B from 'bluebird';
 
 export const REMOTE_DEBUGGER_PORT = 27753;
 const PAGE_READY_TIMEOUT_MS = 5000;
 const {version: MODULE_VERSION} = getModuleProperties();
 
 export class RemoteDebugger extends EventEmitter {
-  protected _skippedApps: string[];
-  protected _clientEventListeners: StringRecord<EventListener[]>;
-  protected _appDict: AppDict;
-  protected _appIdKey?: AppIdKey;
-  protected _pageIdKey?: PageIdKey;
-  protected _connectedDrivers?: StringRecord[];
-  protected _currentState?: string;
-  protected _pageLoadDelay?: B<void>;
-  protected _rpcClient: RpcClient | null;
-  protected _pageLoading: boolean;
-  protected _navigatingToPage: boolean;
-  protected _allowNavigationWithoutReload: boolean;
-  protected _pageLoadMs?: number;
-  protected readonly _pageLoadStrategy?: string;
-  protected readonly _log: AppiumLogger;
-  protected readonly _bundleId?: string;
-  protected readonly _additionalBundleIds?: string[];
-  protected readonly _ignoredBundleIds?: string[];
-  protected readonly _platformVersion?: string;
-  protected readonly _isSafari: boolean;
-  protected readonly _includeSafari: boolean;
-  protected readonly _garbageCollectOnExecute: boolean;
-  protected readonly _host?: string;
-  protected readonly _port?: number;
-  protected readonly _socketPath?: string;
-  protected readonly _remoteDebugProxy?: any;
-  protected readonly _pageReadyTimeout: number;
-  protected readonly _logAllCommunication: boolean;
-  protected readonly _logAllCommunicationHexDump: boolean;
-  protected readonly _socketChunkSize?: number;
-  protected readonly _webInspectorMaxFrameLength?: number;
-  protected readonly _fullPageInitialization?: boolean;
-
   // events
   static readonly EVENT_PAGE_CHANGE: string;
   static readonly EVENT_DISCONNECT: string;
@@ -90,7 +56,7 @@ export class RemoteDebugger extends EventEmitter {
   garbageCollect = miscellaneousMixins.garbageCollect;
   isJavascriptExecutionBlocked = miscellaneousMixins.isJavascriptExecutionBlocked;
 
-  // Callbacks
+  // callbacks
   onPageChange = messageHandlerMixins.onPageChange;
   onConnectedApplicationList = messageHandlerMixins.onConnectedApplicationList;
   onAppConnect = messageHandlerMixins.onAppConnect;
@@ -100,6 +66,39 @@ export class RemoteDebugger extends EventEmitter {
   onCurrentState = messageHandlerMixins.onCurrentState;
   frameDetached = navigationMixins.frameDetached;
 
+  protected _skippedApps: string[];
+  protected _clientEventListeners: StringRecord<EventListener[]>;
+  protected _appDict: AppDict;
+  protected _appIdKey?: AppIdKey;
+  protected _pageIdKey?: PageIdKey;
+  protected _connectedDrivers?: StringRecord[];
+  protected _currentState?: string;
+  protected _pageLoadDelay?: ReturnType<typeof util.cancellableDelay>;
+  protected _rpcClient: RpcClient | null;
+  protected _pageLoading: boolean;
+  protected _navigatingToPage: boolean;
+  protected _allowNavigationWithoutReload: boolean;
+  protected _pageLoadMs?: number;
+  protected readonly _pageLoadStrategy?: string;
+  protected readonly _log: AppiumLogger;
+  protected readonly _bundleId?: string;
+  protected readonly _additionalBundleIds?: string[];
+  protected readonly _ignoredBundleIds?: string[];
+  protected readonly _platformVersion?: string;
+  protected readonly _isSafari: boolean;
+  protected readonly _includeSafari: boolean;
+  protected readonly _garbageCollectOnExecute: boolean;
+  protected readonly _host?: string;
+  protected readonly _port?: number;
+  protected readonly _socketPath?: string;
+  protected readonly _remoteDebugProxy?: any;
+  protected readonly _pageReadyTimeout: number;
+  protected readonly _logAllCommunication: boolean;
+  protected readonly _logAllCommunicationHexDump: boolean;
+  protected readonly _socketChunkSize?: number;
+  protected readonly _webInspectorMaxFrameLength?: number;
+  protected readonly _fullPageInitialization?: boolean;
+
   constructor(opts: RemoteDebuggerOptions = {}) {
     super();
 
@@ -146,13 +145,12 @@ export class RemoteDebugger extends EventEmitter {
     this._remoteDebugProxy = remoteDebugProxy;
     this._pageReadyTimeout = pageReadyTimeout;
 
-    this._logAllCommunication = _.isNil(logAllCommunication)
-      ? !!logFullResponse
-      : !!logAllCommunication;
+    this._logAllCommunication =
+      logAllCommunication == null ? !!logFullResponse : !!logAllCommunication;
     this._logAllCommunicationHexDump = logAllCommunicationHexDump;
     this._socketChunkSize = socketChunkSize;
 
-    if (_.isInteger(webInspectorMaxFrameLength)) {
+    if (Number.isInteger(webInspectorMaxFrameLength)) {
       this._webInspectorMaxFrameLength = webInspectorMaxFrameLength;
     }
 
@@ -168,6 +166,41 @@ export class RemoteDebugger extends EventEmitter {
     return this._log;
   }
 
+  get isConnected(): boolean {
+    return !!this._rpcClient?.isConnected;
+  }
+
+  // Only use this getter to read the appDict value.
+  // Any changes to it don't mutate the original property
+  // because the getter always returns the copy of it
+  get appDict(): AppDict {
+    return structuredClone(this._appDict);
+  }
+
+  get allowNavigationWithoutReload(): boolean {
+    return !!this._allowNavigationWithoutReload;
+  }
+
+  get currentState(): string | undefined {
+    return this._currentState;
+  }
+
+  get connectedDrivers(): StringRecord[] | undefined {
+    return this._connectedDrivers;
+  }
+
+  get pageLoadMs(): number {
+    return this._pageLoadMs ?? navigationMixins.DEFAULT_PAGE_READINESS_TIMEOUT_MS;
+  }
+
+  set allowNavigationWithoutReload(allow: boolean) {
+    this._allowNavigationWithoutReload = allow;
+  }
+
+  set pageLoadMs(value: number) {
+    this._pageLoadMs = value;
+  }
+
   requireRpcClient(checkConnected: boolean = false): RpcClient {
     if (!this._rpcClient) {
       throw new Error(`rpcClient is undefined. Has 'initRpcClient' been called before?`);
@@ -228,44 +261,9 @@ export class RemoteDebugger extends EventEmitter {
       pageLoadTimeoutMs: this._pageLoadMs,
     });
   }
-
-  get isConnected(): boolean {
-    return !!this._rpcClient?.isConnected;
-  }
-
-  // Only use this getter to read the appDict value.
-  // Any changes to it don't mutate the original property
-  // because the getter always returns the copy of it
-  get appDict(): AppDict {
-    return _.cloneDeep(this._appDict);
-  }
-
-  set allowNavigationWithoutReload(allow: boolean) {
-    this._allowNavigationWithoutReload = allow;
-  }
-
-  get allowNavigationWithoutReload(): boolean {
-    return !!this._allowNavigationWithoutReload;
-  }
-
-  get currentState(): string | undefined {
-    return this._currentState;
-  }
-
-  get connectedDrivers(): StringRecord[] | undefined {
-    return this._connectedDrivers;
-  }
-
-  get pageLoadMs(): number {
-    return this._pageLoadMs ?? navigationMixins.DEFAULT_PAGE_READINESS_TIMEOUT_MS;
-  }
-
-  set pageLoadMs(value: number) {
-    this._pageLoadMs = value;
-  }
 }
 
-for (const [name, event] of _.toPairs(eventMixins.events)) {
+for (const [name, event] of Object.entries(eventMixins.events)) {
   RemoteDebugger[name] = event;
 }
 

package/lib/rpc/remote-messages.ts

@@ -1,4 +1,3 @@
-import _ from 'lodash';
 import {getProtocolCommand} from '../protocol';
 import type {
   RawRemoteCommand,
@@ -15,6 +14,12 @@ const MINIMAL_COMMAND = 'getMinimalCommand';
 const FULL_COMMAND = 'getFullCommand';
 const DIRECT_COMMAND = 'getDirectCommand';
 
+function omitNilValues<T extends Record<string, any>>(obj: T): Partial<T> {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([, value]) => value !== null && value !== undefined),
+  ) as Partial<T>;
+}
+
 // mapping of commands to the function for getting the command
 // defaults to `getMinimalCommand`, so no need to have those listed here
 const COMMANDS = {
@@ -117,7 +122,7 @@ export class RemoteMessages {
     return {
       __argument: {
         WIRApplicationIdentifierKey: appIdKey,
-        WIRIndicateEnabledKey: _.isNil(enabled) ? true : enabled,
+        WIRIndicateEnabledKey: enabled == null ? true : enabled,
         WIRConnectionIdentifierKey: connId,
         WIRPageIdentifierKey: pageIdKey,
       },
@@ -191,7 +196,7 @@ export class RemoteMessages {
       },
       __selector: '_rpc_forwardSocketData:',
     };
-    return _.omitBy(plist, _.isNil) as RawRemoteCommand;
+    return omitNilValues(plist) as RawRemoteCommand;
   }
 
   /**
@@ -227,7 +232,7 @@ export class RemoteMessages {
       },
       __selector: '_rpc_forwardSocketData:',
     };
-    return _.omitBy(plist, _.isNil) as RawRemoteCommand;
+    return omitNilValues(plist) as RawRemoteCommand;
   }
 
   /**
@@ -254,7 +259,7 @@ export class RemoteMessages {
       },
       __selector: '_rpc_forwardSocketData:',
     };
-    return _.omitBy(plist, _.isNil) as RawRemoteCommand;
+    return omitNilValues(plist) as RawRemoteCommand;
   }
 
   /**

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

@@ -1,9 +1,9 @@
 import {log} from '../logger';
+import {isPlainObject} from '../utils';
 import {RpcClient} from './rpc-client';
 import type {RemoteCommand, RpcClientOptions} from '../types';
 import type {StringRecord} from '@appium/types';
 import type {WebInspectorService, RemoteXpcConnection} from 'appium-ios-remotexpc';
-import _ from 'lodash';
 
 /**
  * Options specific to RpcClientRealDeviceShim.
@@ -190,7 +190,7 @@ export class RpcClientRealDeviceShim extends RpcClient {
     };
 
     // Convert buffer data to strings where necessary
-    if (_.isPlainObject(message.__argument)) {
+    if (isPlainObject(message.__argument)) {
       const args = {...message.__argument};
 
       // Handle WIRMessageDataKey and WIRSocketDataKey which may be buffers
@@ -213,7 +213,7 @@ export class RpcClientRealDeviceShim extends RpcClient {
    * @returns The translated arguments for the shim service.
    */
   private translateArguments(args: any): StringRecord {
-    if (!_.isPlainObject(args)) {
+    if (!isPlainObject(args)) {
       return {};
     }
 

package/lib/rpc/rpc-client-simulator.ts

@@ -1,6 +1,4 @@
 import {log} from '../logger';
-import _ from 'lodash';
-import B from 'bluebird';
 import net from 'node:net';
 import {RpcClient} from './rpc-client';
 import {services} from 'appium-ios-device';
@@ -110,7 +108,7 @@ export class RpcClientSimulator extends RpcClient {
     this.service.listenMessage(this.receive.bind(this));
 
     // connect the socket
-    return await new B<void>((resolve, reject) => {
+    return await new Promise<void>((resolve, reject) => {
       // only resolve this function when we are actually connected
       if (!this.socket) {
         return reject(new Error('RPC socket is not connected. Please contact developers'));
@@ -157,7 +155,7 @@ export class RpcClientSimulator extends RpcClient {
   override async sendMessage(cmd: RemoteCommand): Promise<void> {
     let onSocketError: ((err: Error) => void) | undefined;
 
-    return await new B<void>((resolve, reject) => {
+    return await new Promise<void>((resolve, reject) => {
       // handle socket problems
       onSocketError = (err: Error) => {
         log.error(`Socket error: ${err.message}`);
@@ -196,7 +194,7 @@ export class RpcClientSimulator extends RpcClient {
     }
 
     for (const key of ['WIRMessageDataKey', 'WIRDestinationKey', 'WIRSocketDataKey']) {
-      if (!_.isUndefined(data[key])) {
+      if (data[key] !== undefined) {
         data[key] = data[key].toString('utf8');
       }
     }