appium-remote-debugger 15.3.3 → 15.3.5

package/lib/rpc/rpc-message-handler.ts

@@ -1,8 +1,8 @@
-import { EventEmitter } from 'node:events';
-import { log } from '../logger';
+import {EventEmitter} from 'node:events';
+import {log} from '../logger';
 import _ from 'lodash';
-import { util } from '@appium/support';
-import type { StringRecord } from '@appium/types';
+import {util} from '@appium/support';
+import type {StringRecord} from '@appium/types';
 
 /**
  * Represents a data message from the Web Inspector.
@@ -46,24 +46,27 @@ export default class RpcMessageHandler extends EventEmitter {
     const argument = plist.__argument;
     switch (selector) {
       case '_rpc_reportSetup:':
-        this.emit('_rpc_reportSetup:',
+        this.emit(
+          '_rpc_reportSetup:',
           null,
           argument.WIRSimulatorNameKey,
           argument.WIRSimulatorBuildKey,
-          argument.WIRSimulatorProductVersionKey
+          argument.WIRSimulatorProductVersionKey,
         );
         break;
       case '_rpc_reportConnectedApplicationList:':
-        this.emit('_rpc_reportConnectedApplicationList:',
+        this.emit(
+          '_rpc_reportConnectedApplicationList:',
           null,
-          argument.WIRApplicationDictionaryKey
+          argument.WIRApplicationDictionaryKey,
         );
         break;
       case '_rpc_applicationSentListing:':
-        this.emit('_rpc_forwardGetListing:',
+        this.emit(
+          '_rpc_forwardGetListing:',
           null,
           argument.WIRApplicationIdentifierKey,
-          argument.WIRListingKey
+          argument.WIRListingKey,
         );
         break;
       case '_rpc_applicationConnected:':
@@ -85,8 +88,9 @@ export default class RpcMessageHandler extends EventEmitter {
         await this.handleDataMessage(plist);
         break;
       default:
-        log.debug(`Debugger got a message for '${selector}' and have no ` +
-          `handler, doing nothing.`);
+        log.debug(
+          `Debugger got a message for '${selector}' and have no ` + `handler, doing nothing.`,
+        );
     }
   }
 
@@ -124,7 +128,7 @@ export default class RpcMessageHandler extends EventEmitter {
     method: string | undefined,
     params: StringRecord | undefined,
     result: any,
-    error: Error | undefined
+    error: Error | undefined,
   ): Promise<void> {
     if (msgId) {
       if (this.listenerCount(msgId)) {
@@ -133,10 +137,12 @@ export default class RpcMessageHandler extends EventEmitter {
         }
         this.emit(msgId, error, result);
       } else {
-        log.error(`Web Inspector returned data for message '${msgId}' ` +
-          `but we were not waiting for that message! ` +
-          `result: '${JSON.stringify(result)}'; ` +
-          `error: '${JSON.stringify(error)}'`);
+        log.error(
+          `Web Inspector returned data for message '${msgId}' ` +
+            `but we were not waiting for that message! ` +
+            `result: '${JSON.stringify(result)}'; ` +
+            `error: '${JSON.stringify(error)}'`,
+        );
       }
       return;
     }
@@ -200,9 +206,10 @@ export default class RpcMessageHandler extends EventEmitter {
     const parseError = (): Error | undefined => {
       const defaultMessage = 'Error occurred in handling data message';
       if (result?.wasThrown) {
-        const message = (result?.result?.value || result?.result?.description)
-          ? (result?.result?.value || result?.result?.description)
-          : (dataKey.error ?? defaultMessage);
+        const message =
+          result?.result?.value || result?.result?.description
+            ? result?.result?.value || result?.result?.description
+            : (dataKey.error ?? defaultMessage);
         return new Error(message);
       }
       if (dataKey.error) {
@@ -224,9 +231,10 @@ export default class RpcMessageHandler extends EventEmitter {
       case 'Target.targetDestroyed':
       case 'Target.didCommitProvisionalTarget': {
         const app = plist.__argument.WIRApplicationIdentifierKey;
-        const args = method === 'Target.didCommitProvisionalTarget'
-          ? params
-          : (params.targetInfo ?? {targetId: params.targetId});
+        const args =
+          method === 'Target.didCommitProvisionalTarget'
+            ? params
+            : (params.targetInfo ?? {targetId: params.targetId});
         this.emit(method, null, app, args);
         return;
       }
@@ -241,7 +249,9 @@ export default class RpcMessageHandler extends EventEmitter {
           } catch (err: any) {
             // if this happens then some aspect of the protocol is missing to us
             // so print the entire message to get visibility into what is going on
-            log.error(`Unexpected message format from Web Inspector: ${util.jsonStringify(plist, null)}`);
+            log.error(
+              `Unexpected message format from Web Inspector: ${util.jsonStringify(plist, null)}`,
+            );
             throw err;
           }
         }

package/lib/types.ts

@@ -1,4 +1,4 @@
-import type { StringRecord, AppiumLogger } from '@appium/types';
+import type {StringRecord, AppiumLogger} from '@appium/types';
 
 export interface AppInfo {
   id: string;
@@ -77,7 +77,8 @@ interface RemoteDebuggerRealDeviceSpecificOptions {
   udid: string;
 }
 
-export type RemoteDebuggerRealDeviceOptions = RemoteDebuggerRealDeviceSpecificOptions & RemoteDebuggerOptions;
+export type RemoteDebuggerRealDeviceOptions = RemoteDebuggerRealDeviceSpecificOptions &
+  RemoteDebuggerOptions;
 
 /**
  * Options for configuring an RpcClient instance.
@@ -154,7 +155,6 @@ interface RemoteCommandTemplated<T extends SocketDataKey> {
 export type RawRemoteCommand = RemoteCommandTemplated<StringRecord>;
 export type RemoteCommand = RemoteCommandTemplated<Buffer>;
 
-
 /**
  * Target types.
  * 'frame' was added since iOS 26.2 beta.

package/lib/utils.ts

@@ -1,10 +1,10 @@
 import _ from 'lodash';
-import { errorFromMJSONWPStatusCode } from '@appium/base-driver';
-import { util, node } from '@appium/support';
+import {errorFromMJSONWPStatusCode} from '@appium/base-driver';
+import {util, node} from '@appium/support';
 import nodeFs from 'node:fs';
 import path from 'node:path';
-import type { StringRecord } from '@appium/types';
-import type { AppInfo, AppDict, Page } from './types';
+import type {StringRecord} from '@appium/types';
+import type {AppInfo, AppDict, Page} from './types';
 
 const MODULE_NAME = 'appium-remote-debugger';
 export const WEB_CONTENT_BUNDLE_ID = 'com.apple.WebKit.WebContent';
@@ -35,9 +35,10 @@ export function appInfoFromDict(dict: Record<string, any>): [string, AppInfo] {
   let isAutomationEnabled: boolean | string = !!dict.WIRRemoteAutomationEnabledKey;
   if (_.has(dict, 'WIRAutomationAvailabilityKey')) {
     if (_.isString(dict.WIRAutomationAvailabilityKey)) {
-      isAutomationEnabled = dict.WIRAutomationAvailabilityKey === 'WIRAutomationAvailabilityUnknown'
-        ? 'Unknown'
-        : dict.WIRAutomationAvailabilityKey === 'WIRAutomationAvailabilityAvailable';
+      isAutomationEnabled =
+        dict.WIRAutomationAvailabilityKey === 'WIRAutomationAvailabilityUnknown'
+          ? 'Unknown'
+          : dict.WIRAutomationAvailabilityKey === 'WIRAutomationAvailabilityAvailable';
     } else {
       isAutomationEnabled = !!dict.WIRAutomationAvailabilityKey;
     }
@@ -63,15 +64,19 @@ export function appInfoFromDict(dict: Record<string, any>): [string, AppInfo] {
  * @returns An array of Page objects representing the available pages.
  */
 export function pageArrayFromDict(pageDict: StringRecord): Page[] {
-  return _.values(pageDict)
-    // count only WIRTypeWeb pages and ignore all others (WIRTypeJavaScript etc)
-    .filter((dict) => _.isUndefined(dict.WIRTypeKey) || ACCEPTED_PAGE_TYPES.includes(dict.WIRTypeKey))
-    .map((dict) => ({
-      id: dict.WIRPageIdentifierKey,
-      title: dict.WIRTitleKey,
-      url: dict.WIRURLKey,
-      isKey: !_.isUndefined(dict.WIRConnectionIdentifierKey),
-    }));
+  return (
+    _.values(pageDict)
+      // count only WIRTypeWeb pages and ignore all others (WIRTypeJavaScript etc)
+      .filter(
+        (dict) => _.isUndefined(dict.WIRTypeKey) || ACCEPTED_PAGE_TYPES.includes(dict.WIRTypeKey),
+      )
+      .map((dict) => ({
+        id: dict.WIRPageIdentifierKey,
+        title: dict.WIRTitleKey,
+        url: dict.WIRURLKey,
+        isKey: !_.isUndefined(dict.WIRConnectionIdentifierKey),
+      }))
+  );
 }
 
 /**
@@ -145,7 +150,9 @@ export function simpleStringify(value: any, multiline: boolean = false): string
  */
 export function convertJavascriptEvaluationResult(res: any): any {
   if (_.isUndefined(res)) {
-    throw new Error(`Did not get OK result from remote debugger. Result was: ${_.truncate(simpleStringify(res), {length: RESPONSE_LOG_LENGTH})}`);
+    throw new Error(
+      `Did not get OK result from remote debugger. Result was: ${_.truncate(simpleStringify(res), {length: RESPONSE_LOG_LENGTH})}`,
+    );
   } else if (_.isString(res)) {
     try {
       res = JSON.parse(res);

package/package.json

@@ -4,7 +4,7 @@
   "keywords": [
     "appium"
   ],
-  "version": "15.3.3",
+  "version": "15.3.5",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {
@@ -49,6 +49,8 @@
     "dev": "npm run build -- --watch",
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
+    "format": "prettier -w ./lib ./test",
+    "format:check": "prettier --check ./lib ./test",
     "prepare": "npm run build",
     "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
     "e2e-test": "mocha --exit --timeout 1m \"./test/functional/**/*-specs.ts\"",