feat: introduce a wildcard usage for additionalWebviewBundleIds to get webview contexts of other apps

lib/utils.js

@@ -105,9 +105,12 @@ function pageArrayFromDict (pageDict) {
   return newPageArray;
 }
 
-/*
+/**
  * Given a bundle id, finds the correct remote debugger app that is
  * connected.
+ * @param {string} bundleId
+ * @param {Record<string, any>} appDict
+ * @returns {string|undefined}
  */
 function getDebuggerAppKey (bundleId, appDict) {
   let appId;
@@ -138,6 +141,12 @@ function getDebuggerAppKey (bundleId, appDict) {
   return appId;
 }
 
+/**
+ *
+ * @param {string} bundleId
+ * @param {Record<string, any>} appDict
+ * @returns {string|undefined}
+ */
 function appIdForBundle (bundleId, appDict) {
   let appId;
   for (const [key, data] of _.toPairs(appDict)) {
@@ -155,7 +164,18 @@ function appIdForBundle (bundleId, appDict) {
   return appId;
 }
 
-function getPossibleDebuggerAppKeys (bundleIds, appDict) {
+/**
+ * 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, any>} appDict
+ * @returns {string[]}
+ */
+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));
+  }
   let proxiedAppIds = [];
 
   // go through the possible bundle identifiers

test/unit/utils-specs.js

@@ -1,4 +1,6 @@
-import { pageArrayFromDict, checkParams, appInfoFromDict, getDebuggerAppKey } from '../../lib/utils';
+import {
+  pageArrayFromDict, checkParams, appInfoFromDict, getDebuggerAppKey, getPossibleDebuggerAppKeys
+} from '../../lib/utils';
 import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import _ from 'lodash';
@@ -57,6 +59,64 @@ describe('utils', function () {
       expect(getDebuggerAppKey('io.appium.bundle', {})).to.not.exist;
     });
   });
+  describe('getPossibleDebuggerAppKeys', function () {
+    it('should return the app key of the specified bundleIds', function () {
+      const appDict = {
+        ['42']: {
+          bundleId: 'io.appium.bundle1'
+        },
+        ['43']: {
+          bundleId: 'io.appium.bundle2'
+        },
+      };
+      expect(getPossibleDebuggerAppKeys(['io.appium.bundle1'], appDict)).to.eql(['42']);
+    });
+    const webviewBundleIds = [
+      'com.apple.WebKit.WebContent',
+      'process-com.apple.WebKit.WebContent',
+      'process-SafariViewService',
+      'com.apple.SafariViewService',
+      '*',
+    ];
+    for (const webviewBundleId of webviewBundleIds) {
+      it(`should return the app key of ${webviewBundleId}`, function () {
+        const appDict = {
+          ['42']: {
+            bundleId: webviewBundleId
+          }
+        };
+        expect(getPossibleDebuggerAppKeys([], appDict)).to.eql(['42']);
+      });
+    }
+    it('should return the app key for the bundleIds when proxied', function () {
+      const appDict = {
+        ['42']: {
+          bundleId: 'io.appium.bundle',
+          isProxy: false
+        },
+        ['43']: {
+          bundleId: 'io.appium.proxied.bundle',
+          isProxy: true,
+          hostId: '42'
+        }
+      };
+      expect(getPossibleDebuggerAppKeys(['io.appium.bundle'], appDict)).to.eql(['42', '43']);
+    });
+    it('should return an empty array when there is no appropriate app', function () {
+      expect(getPossibleDebuggerAppKeys('io.appium.bundle', {})).to.eql([]);
+    });
+    it('should return the all app keys when the bundlIds array includes a wildcard', function () {
+      const appDict = {
+        ['42']: {
+          bundleId: 'io.appium.bundle1'
+        },
+        ['43']: {
+          bundleId: 'io.appium.bundle2'
+        },
+      };
+      expect(getPossibleDebuggerAppKeys(['*'], appDict)).to.eql(['42', '43']);
+    });
+  });
   describe('pageArrayFromDict', function () {
     let basePageDict = {
       1: {