appium-remote-debugger 11.5.6 → 11.5.8

package/lib/utils.js

@@ -1,4 +1,3 @@
-import log from './logger';
 import _ from 'lodash';
 import B from 'bluebird';
 import { errorFromMJSONWPStatusCode } from '@appium/base-driver';
@@ -7,49 +6,22 @@ import nodeFs from 'node:fs';
 import path from 'node:path';
 
 const MODULE_NAME = 'appium-remote-debugger';
-
-const WEB_CONTENT_BUNDLE_ID = 'com.apple.WebKit.WebContent';
-const WEB_CONTENT_PROCESS_BUNDLE_ID = 'process-com.apple.WebKit.WebContent';
-const SAFARI_VIEW_PROCESS_BUNDLE_ID = 'process-SafariViewService';
-const SAFARI_VIEW_BUNDLE_ID = 'com.apple.SafariViewService';
-const WILDCARD_BUNDLE_ID = '*';
-
+export const WEB_CONTENT_BUNDLE_ID = 'com.apple.WebKit.WebContent';
 const INACTIVE_APP_CODE = 0;
-
 // values for the page `WIRTypeKey` entry
 const ACCEPTED_PAGE_TYPES = [
   'WIRTypeWeb', // up to iOS 11.3
   'WIRTypeWebPage', // iOS 11.4
   'WIRTypePage', // iOS 11.4 webview
 ];
-
 export const RESPONSE_LOG_LENGTH = 100;
 
-/**
- * @typedef {Object} DeferredPromise
- * @property {B<any>} promise
- * @property {(...args: any[]) => void} resolve
- * @property {(err?: Error) => void} reject
- */
-
-/**
- * @typedef {Object} AppInfo
- * @property {string} id
- * @property {boolean} isProxy
- * @property {string} name
- * @property {string} bundleId
- * @property {string} [hostId]
- * @property {boolean} isActive
- * @property {boolean|string} isAutomationEnabled
- * @property {import('./mixins/connect').Page[]} [pageArray]
- */
-
 /**
  * Takes a dictionary from the remote debugger and makes a more manageable
  * dictionary whose keys are understandable
  *
  * @param {Record<string, any>} dict
- * @returns {[string, AppInfo]}
+ * @returns {[string, import('./types').AppInfo]}
  */
 export function appInfoFromDict (dict) {
   const id = dict.WIRApplicationIdentifierKey;
@@ -70,6 +42,7 @@ export function appInfoFromDict (dict) {
       isAutomationEnabled = !!dict.WIRAutomationAvailabilityKey;
     }
   }
+  /** @type {import('./types').AppInfo} */
   const entry = {
     id,
     isProxy,
@@ -88,7 +61,7 @@ export function appInfoFromDict (dict) {
  * dictionary of pages available.
  *
  * @param {import('@appium/types').StringRecord} pageDict
- * @returns {import('./mixins/connect').Page[]}
+ * @returns {import('./types').Page[]}
  */
 export function pageArrayFromDict (pageDict) {
   return _.values(pageDict)
@@ -103,84 +76,32 @@ export function pageArrayFromDict (pageDict) {
 }
 
 /**
- * Given a bundle id, finds the correct remote debugger app that is
- * connected.
+ *
  * @param {string} bundleId
- * @param {Record<string, any>} appDict
- * @returns {string|undefined}
+ * @param {import('./types').AppDict} appDict
+ * @returns {string[]}
  */
-export function getDebuggerAppKey (bundleId, appDict) {
-  let appId;
+export function appIdsForBundle (bundleId, appDict) {
+  /** @type {Set<string>} */
+  const appIds = new Set();
   for (const [key, data] of _.toPairs(appDict)) {
-    if (data.bundleId === bundleId) {
-      appId = key;
-      break;
+    if (data.bundleId.endsWith(bundleId)) {
+      appIds.add(key);
     }
   }
-  // now we need to determine if we should pick a proxy for this instead
-  if (appId) {
-    log.debug(`Found app id key '${appId}' for bundle '${bundleId}'`);
-    let proxyAppId;
-    for (const [key, data] of _.toPairs(appDict)) {
-      if (data.isProxy && data.hostId === appId) {
-        log.debug(`Found separate bundleId '${data.bundleId}' ` +
-                  `acting as proxy for '${bundleId}', with app id '${key}'`);
-        // set the app id... the last one will be used, so just keep re-assigning
-        proxyAppId = key;
-      }
-    }
-    if (proxyAppId) {
-      appId = proxyAppId;
-      log.debug(`Using proxied app id '${appId}'`);
-    }
+
+  // if nothing is found, try to get the generic app
+  if (appIds.size === 0 && bundleId !== WEB_CONTENT_BUNDLE_ID) {
+    return appIdsForBundle(WEB_CONTENT_BUNDLE_ID, appDict);
   }
 
-  return appId;
+  return Array.from(appIds);
 }
 
 /**
- * Find app keys based on assigned bundleIds from appDict
- * When bundleIds includes a wildcard ('*'), returns all appKeys in appDict.
- * @param {string[]} bundleIds
- * @param {Record<string, AppInfo>} appDict
- * @returns {string[]}
+ * @param {import('@appium/types').StringRecord} params
+ * @returns {void}
  */
-export function getPossibleDebuggerAppKeys(bundleIds, appDict) {
-  if (bundleIds.includes(WILDCARD_BUNDLE_ID)) {
-    log.debug('Skip checking bundle identifiers because the bundleIds includes a wildcard');
-    return _.uniq(Object.keys(appDict));
-  }
-
-  // go through the possible bundle identifiers
-  const possibleBundleIds = _.uniq([
-    WEB_CONTENT_BUNDLE_ID,
-    WEB_CONTENT_PROCESS_BUNDLE_ID,
-    SAFARI_VIEW_PROCESS_BUNDLE_ID,
-    SAFARI_VIEW_BUNDLE_ID,
-    WILDCARD_BUNDLE_ID,
-    ...bundleIds,
-  ]);
-  log.debug(`Checking for bundle identifiers: ${possibleBundleIds.join(', ')}`);
-  /** @type {Set<string>} */
-  const proxiedAppIds = new Set();
-  for (const bundleId of possibleBundleIds) {
-    // now we need to determine if we should pick a proxy for this instead
-    for (const appId of appIdsForBundle(bundleId, appDict)) {
-      proxiedAppIds.add(appId);
-      log.debug(`Found app id key '${appId}' for bundle '${bundleId}'`);
-      for (const [key, data] of _.toPairs(appDict)) {
-        if (data.isProxy && data.hostId === appId) {
-          log.debug(`Found separate bundleId '${data.bundleId}' ` +
-                    `acting as proxy for '${bundleId}', with app id '${key}'`);
-          proxiedAppIds.add(key);
-        }
-      }
-    }
-  }
-
-  return Array.from(proxiedAppIds);
-}
-
 export function checkParams (params) {
   // check if all parameters have a value
   const errors = _.toPairs(params)
@@ -191,6 +112,11 @@ export function checkParams (params) {
   }
 }
 
+/**
+ * @param {any} value
+ * @param {boolean} [multiline=false]
+ * @returns {string}
+ */
 export function simpleStringify (value, multiline = false) {
   if (!value) {
     return JSON.stringify(value);
@@ -206,7 +132,7 @@ export function simpleStringify (value, multiline = false) {
 }
 
 /**
- * @returns {DeferredPromise}
+ * @returns {import('./types').DeferredPromise}
  */
 export function deferredPromise () {
   // http://bluebirdjs.com/docs/api/deferred-migration.html
@@ -227,6 +153,11 @@ export function deferredPromise () {
   };
 }
 
+/**
+ *
+ * @param {any} res
+ * @returns {any}
+ */
 export function convertResult (res) {
   if (_.isUndefined(res)) {
     throw new Error(`Did not get OK result from remote debugger. Result was: ${_.truncate(simpleStringify(res), {length: RESPONSE_LOG_LENGTH})}`);
@@ -280,26 +211,3 @@ export function getModuleProperties() {
   const fullPath = path.resolve(getModuleRoot(), 'package.json');
   return JSON.parse(nodeFs.readFileSync(fullPath, 'utf8'));
 }
-
-/**
- *
- * @param {string} bundleId
- * @param {Record<string, any>} appDict
- * @returns {string[]}
- */
-function appIdsForBundle (bundleId, appDict) {
-  /** @type {Set<string>} */
-  const appIds = new Set();
-  for (const [key, data] of _.toPairs(appDict)) {
-    if (data.bundleId.endsWith(bundleId)) {
-      appIds.add(key);
-    }
-  }
-
-  // if nothing is found, try to get the generic app
-  if (appIds.size === 0 && bundleId !== WEB_CONTENT_BUNDLE_ID) {
-    return appIdsForBundle(WEB_CONTENT_BUNDLE_ID, appDict);
-  }
-
-  return Array.from(appIds);
-}

package/package.json

@@ -4,7 +4,7 @@
   "keywords": [
     "appium"
   ],
-  "version": "11.5.6",
+  "version": "11.5.8",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {