appium-remote-debugger 11.5.9 → 12.0.0

package/lib/mixins/connect.js

@@ -66,19 +66,19 @@ export async function connect (timeout = APP_CONNECT_TIMEOUT_MS) {
       const timer = new timing.Timer().start();
       this.log.debug(`Waiting up to ${timeout}ms for applications to be reported`);
       try {
-        await waitForCondition(() => !_.isEmpty(this.appDict), {
+        await waitForCondition(() => !_.isEmpty(this._appDict), {
           waitMs: timeout,
           intervalMs: APP_CONNECT_INTERVAL_MS,
         });
         this.log.debug(
-          `Retrieved ${util.pluralize('application', _.size(this.appDict), true)} ` +
+          `Retrieved ${util.pluralize('application', _.size(this._appDict), true)} ` +
           `within ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`
         );
       } catch (err) {
         this.log.debug(`Timed out waiting for applications to be reported`);
       }
     }
-    return this.appDict || {};
+    return this._appDict || {};
   } catch (err) {
     this.log.error(`Error setting connection key: ${err.message}`);
     await this.disconnect();
@@ -92,8 +92,8 @@ export async function connect (timeout = APP_CONNECT_TIMEOUT_MS) {
  * @returns {Promise<void>}
  */
 export async function disconnect () {
-  if (this.rpcClient) {
-    await this.rpcClient.disconnect();
+  if (this._rpcClient) {
+    await this._rpcClient.disconnect();
   }
   this.emit(events.EVENT_DISCONNECT, true);
   this.teardown();
@@ -115,23 +115,23 @@ export async function selectApp (currentUrl = null, maxTries = SELECT_APP_RETRIE
   rpcClient.shouldCheckForTarget = false;
   try {
     const timer = new timing.Timer().start();
-    if (!this.appDict || _.isEmpty(this.appDict)) {
+    if (!this._appDict || _.isEmpty(this._appDict)) {
       this.log.debug('No applications currently connected.');
       return [];
     }
 
-    const { appIdKey } = await this.searchForApp(currentUrl, maxTries, ignoreAboutBlankUrl);
-    if (this.appIdKey !== appIdKey) {
-      this.log.debug(`Received altered app id, updating from '${this.appIdKey}' to '${appIdKey}'`);
-      this.appIdKey = appIdKey;
+    const { appIdKey } = await searchForApp.bind(this)(currentUrl, maxTries, ignoreAboutBlankUrl);
+    if (this._appIdKey !== appIdKey) {
+      this.log.debug(`Received altered app id, updating from '${this._appIdKey}' to '${appIdKey}'`);
+      this._appIdKey = appIdKey;
     }
     logApplicationDictionary.bind(this)();
     // translate the dictionary into a useful form, and return to sender
-    this.log.debug(`Finally selecting app ${this.appIdKey}`);
+    this.log.debug(`Finally selecting app ${this._appIdKey}`);
 
     /** @type {import('../types').Page[]} */
     const fullPageArray = [];
-    for (const [app, info] of _.toPairs(this.appDict)) {
+    for (const [app, info] of _.toPairs(this._appDict)) {
       if (!_.isArray(info.pageArray) || !info.isActive) {
         continue;
       }
@@ -153,6 +153,32 @@ export async function selectApp (currentUrl = null, maxTries = SELECT_APP_RETRIE
   }
 }
 
+/**
+ *
+ * @this {RemoteDebugger}
+ * @param {string|number} appIdKey
+ * @param {string|number} pageIdKey
+ * @param {boolean} [skipReadyCheck]
+ * @returns {Promise<void>}
+ */
+export async function selectPage (appIdKey, pageIdKey, skipReadyCheck = false) {
+  this._appIdKey = _.startsWith(`${appIdKey}`, 'PID:') ? `${appIdKey}` : `PID:${appIdKey}`;
+  this._pageIdKey = pageIdKey;
+
+  this.log.debug(`Selecting page '${pageIdKey}' on app '${this._appIdKey}' and forwarding socket setup`);
+
+  const timer = new timing.Timer().start();
+
+  await this.requireRpcClient().selectPage(this._appIdKey, pageIdKey);
+
+  if (!skipReadyCheck && !await this.checkPageIsReady()) {
+    await this.waitForDom();
+  }
+
+  this.log.debug(`Selected page after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
+}
+
+
 /**
  *
  * @this {RemoteDebugger}
@@ -161,10 +187,10 @@ export async function selectApp (currentUrl = null, maxTries = SELECT_APP_RETRIE
  * @param {boolean} ignoreAboutBlankUrl
  * @returns {Promise<import('../types').AppPage>}
  */
-export async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
-  const bundleIds = this.includeSafari && !this.isSafari
-    ? [this.bundleId, ...this.additionalBundleIds, SAFARI_BUNDLE_ID]
-    : [this.bundleId, ...this.additionalBundleIds];
+async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
+  const bundleIds = this._includeSafari && !this._isSafari
+    ? [this._bundleId, ...this._additionalBundleIds, SAFARI_BUNDLE_ID]
+    : [this._bundleId, ...this._additionalBundleIds];
   let retryCount = 0;
   return /** @type {import('../types').AppPage} */ (await retryInterval(maxTries, SELECT_APP_RETRY_SLEEP_MS, async () => {
     logApplicationDictionary.bind(this)();
@@ -172,7 +198,7 @@ export async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
     this.log.debug(`Trying out the possible app ids: ${possibleAppIds.join(', ')} (try #${retryCount + 1} of ${maxTries})`);
     for (const attemptedAppIdKey of possibleAppIds) {
       try {
-        if (!this.appDict[attemptedAppIdKey].isActive) {
+        if (!this._appDict[attemptedAppIdKey].isActive) {
           this.log.debug(`Skipping app '${attemptedAppIdKey}' because it is not active`);
           continue;
         }
@@ -190,12 +216,12 @@ export async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
         }
 
         // save the page array for this app
-        this.appDict[appIdKey].pageArray = pageArrayFromDict(pageDict);
+        this._appDict[appIdKey].pageArray = pageArrayFromDict(pageDict);
 
         // if we are looking for a particular url, make sure we
         // have the right page. Ignore empty or undefined urls.
         // Ignore about:blank if requested.
-        const result = this.searchForPage(this.appDict, currentUrl, ignoreAboutBlankUrl);
+        const result = searchForPage.bind(this)(this._appDict, currentUrl, ignoreAboutBlankUrl);
         if (result) {
           return result;
         }
@@ -225,7 +251,7 @@ export async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
  * @param {boolean} [ignoreAboutBlankUrl]
  * @returns {import('../types').AppPage?}
  */
-export function searchForPage (appsDict, currentUrl = null, ignoreAboutBlankUrl = false) {
+function searchForPage (appsDict, currentUrl = null, ignoreAboutBlankUrl = false) {
   for (const appDict of _.values(appsDict)) {
     if (!appDict || !appDict.isActive || !appDict.pageArray || _.isEmpty(appDict.pageArray)) {
       continue;
@@ -244,39 +270,13 @@ export function searchForPage (appsDict, currentUrl = null, ignoreAboutBlankUrl
   return null;
 }
 
-/**
- *
- * @this {RemoteDebugger}
- * @param {string|number} appIdKey
- * @param {string|number} pageIdKey
- * @param {boolean} [skipReadyCheck]
- * @returns {Promise<void>}
- */
-export async function selectPage (appIdKey, pageIdKey, skipReadyCheck = false) {
-  this.appIdKey = _.startsWith(`${appIdKey}`, 'PID:') ? `${appIdKey}` : `PID:${appIdKey}`;
-  this.pageIdKey = pageIdKey;
-
-  this.log.debug(`Selecting page '${pageIdKey}' on app '${this.appIdKey}' and forwarding socket setup`);
-
-  const timer = new timing.Timer().start();
-
-  await this.requireRpcClient().selectPage(this.appIdKey, pageIdKey);
-
-  // make sure everything is ready to go
-  if (!skipReadyCheck && !await this.checkPageIsReady()) {
-    await this.waitForDom();
-  }
-
-  this.log.debug(`Selected page after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
-}
-
 /**
  * @this {RemoteDebugger}
  * @returns {void}
  */
 function logApplicationDictionary () {
   this.log.debug('Current applications available:');
-  for (const [app, info] of _.toPairs(this.appDict)) {
+  for (const [app, info] of _.toPairs(this._appDict)) {
     this.log.debug(`    Application: "${app}"`);
     for (const [key, value] of _.toPairs(info)) {
       if (key === 'pageArray' && Array.isArray(value) && value.length) {
@@ -307,7 +307,7 @@ function logApplicationDictionary () {
 export function getPossibleDebuggerAppKeys(bundleIds) {
   if (bundleIds.includes(WILDCARD_BUNDLE_ID)) {
     this.log.debug('Skip checking bundle identifiers because the bundleIds includes a wildcard');
-    return _.uniq(Object.keys(this.appDict));
+    return _.uniq(Object.keys(this._appDict));
   }
 
   // go through the possible bundle identifiers
@@ -324,10 +324,10 @@ export function getPossibleDebuggerAppKeys(bundleIds) {
   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, this.appDict)) {
+    for (const appId of appIdsForBundle(bundleId, this._appDict)) {
       proxiedAppIds.add(appId);
       this.log.debug(`Found app id key '${appId}' for bundle '${bundleId}'`);
-      for (const [key, data] of _.toPairs(this.appDict)) {
+      for (const [key, data] of _.toPairs(this._appDict)) {
         if (data.isProxy && data.hostId === appId) {
           this.log.debug(
             `Found separate bundleId '${data.bundleId}' ` +
@@ -343,5 +343,19 @@ export function getPossibleDebuggerAppKeys(bundleIds) {
 }
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasConnectionRelatedProperties
+ * @property {string | null | undefined} _appIdKey
+ * @property {string | number | null | undefined} _pageIdKey
+ * @property {import('../types').AppDict} _appDict
+ * @property {string | undefined} _bundleId
+ * @property {import('../rpc/rpc-client').RpcClient | undefined} _rpcClient
+ * @property {boolean} _includeSafari
+ * @property {boolean} _isSafari
+ * @property {string[]} _additionalBundleIds
+ * @property {(this: RemoteDebugger, timeoutMs?: number | undefined) => Promise<boolean>} checkPageIsReady:
+ * @property {(this: RemoteDebugger, startPageLoadTimer?: timing.Timer | null | undefined) => Promise<void>} waitForDom:
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasConnectionRelatedProperties} RemoteDebugger
  */

package/lib/mixins/cookies.js

@@ -7,8 +7,8 @@
 export async function getCookies () {
   this.log.debug('Getting cookies');
   return await this.requireRpcClient().send('Page.getCookies', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey
   });
 }
 
@@ -21,8 +21,8 @@ export async function getCookies () {
 export async function setCookie (cookie) {
   this.log.debug('Setting cookie');
   return await this.requireRpcClient().send('Page.setCookie', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
     cookie
   });
 }
@@ -37,13 +37,19 @@ export async function setCookie (cookie) {
 export async function deleteCookie (cookieName, url) {
   this.log.debug(`Deleting cookie '${cookieName}' on '${url}'`);
   return await this.requireRpcClient().send('Page.deleteCookie', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
     cookieName,
     url,
   });
 }
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasCookiesRelatedProperties
+ * @property {string | null | undefined} _appIdKey
+ * @property {string | number | null | undefined} _pageIdKey
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasCookiesRelatedProperties} RemoteDebugger
  */

package/lib/mixins/events.js

@@ -10,7 +10,7 @@ export const events = {
  *
  * @this {RemoteDebugger}
  * @param {string} eventName
- * @param {(event: import('@appium/types').StringRecord) => any} listener
+ * @param {import('../types').EventListener} listener
  * @returns {void}
  */
 export function addClientEventListener (eventName, listener) {
@@ -30,8 +30,53 @@ export function removeClientEventListener (eventName) {
   }
 }
 
+/**
+ * @this {RemoteDebugger}
+ * @param {import('../types').EventListener} listener
+ * @returns {void}
+ */
+export function startConsole (listener) {
+  this.log.debug('Starting to listen for JavaScript console');
+  this.addClientEventListener('Console.messageAdded', listener);
+  this.addClientEventListener('Console.messageRepeatCountUpdated', listener);
+}
+
+/**
+ * @this {RemoteDebugger}
+ * @returns {void}
+ */
+export function stopConsole () {
+  this.log.debug('Stopping to listen for JavaScript console');
+  this.removeClientEventListener('Console.messageAdded');
+  this.removeClientEventListener('Console.messageRepeatCountUpdated');
+}
+
+/**
+ * @this {RemoteDebugger}
+ * @param {import('../types').EventListener} listener
+ * @returns {void}
+ */
+export function startNetwork (listener) {
+  this.log.debug('Starting to listen for network events');
+  this.addClientEventListener('NetworkEvent', listener);
+}
+
+/**
+ * @this {RemoteDebugger}
+ * @returns {void}
+ */
+export function stopNetwork () {
+  this.log.debug('Stopping to listen for network events');
+  this.removeClientEventListener('NetworkEvent');
+}
+
 export default events;
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasEventsRelatedProperties
+ * @property {import('@appium/types').StringRecord<import('../types').EventListener[]>} _clientEventListeners:
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasEventsRelatedProperties} RemoteDebugger
  */

package/lib/mixins/execute.js

@@ -36,8 +36,8 @@ export async function executeAtom (atom, args = [], frames = []) {
 export async function executeAtomAsync (atom, args = [], frames = []) {
   // helper to send directly to the web inspector
   const evaluate = async (method, opts) => await this.requireRpcClient(true).send(method, Object.assign({
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
     returnByValue: false,
   }, opts));
 
@@ -125,19 +125,19 @@ export async function executeAtomAsync (atom, args = [], frames = []) {
  */
 export async function execute (command, override) {
   // if the page is not loaded yet, wait for it
-  if (this.pageLoading && !override) {
+  if (this._pageLoading && !override) {
     this.log.debug('Trying to execute but page is not loaded.');
     await this.waitForDom();
   }
 
-  if (_.isNil(this.appIdKey)) {
+  if (_.isNil(this._appIdKey)) {
     throw new Error('Missing parameter: appIdKey. Is the target web application still alive?');
   }
-  if (_.isNil(this.pageIdKey)) {
+  if (_.isNil(this._pageIdKey)) {
     throw new Error('Missing parameter: pageIdKey. Is the target web page still alive?');
   }
 
-  if (this.garbageCollectOnExecute) {
+  if (this._garbageCollectOnExecute) {
     await this.garbageCollect();
   }
 
@@ -145,8 +145,8 @@ export async function execute (command, override) {
   const res = await this.requireRpcClient(true).send('Runtime.evaluate', {
     expression: command,
     returnByValue: true,
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
   });
   return convertResult(res);
 }
@@ -158,9 +158,9 @@ export async function execute (command, override) {
  * @param {any[]} [args]
  */
 export async function callFunction (objectId, fn, args) {
-  checkParams({appIdKey: this.appIdKey, pageIdKey: this.pageIdKey});
+  checkParams({appIdKey: this._appIdKey, pageIdKey: this._pageIdKey});
 
-  if (this.garbageCollectOnExecute) {
+  if (this._garbageCollectOnExecute) {
     await this.garbageCollect();
   }
 
@@ -170,13 +170,22 @@ export async function callFunction (objectId, fn, args) {
     functionDeclaration: fn,
     arguments: args,
     returnByValue: true,
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
   });
 
   return convertResult(res);
 }
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasExecutionRelatedProperties
+ * @property {string | null | undefined} _appIdKey
+ * @property {string | number | null | undefined} _pageIdKey
+ * @property {boolean} _pageLoading
+ * @property {boolean} _garbageCollectOnExecute
+ * @property {(this: RemoteDebugger, startPageLoadTimer?: timing.Timer | null | undefined) => Promise<void>} waitForDom:
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasExecutionRelatedProperties} RemoteDebugger
  */

package/lib/mixins/message-handlers.js

@@ -26,8 +26,8 @@ export async function onPageChange (err, appIdKey, pageDict) {
 
   const currentPages = pageArrayFromDict(pageDict);
   // save the page dict for this app
-  if (this.appDict[appIdKey]) {
-    const previousPages = this.appDict[appIdKey].pageArray;
+  if (this._appDict[appIdKey]) {
+    const previousPages = this._appDict[appIdKey].pageArray;
     // we have a pre-existing pageDict
     if (previousPages && _.isEqual(previousPages, currentPages)) {
       this.log.debug(
@@ -37,7 +37,7 @@ export async function onPageChange (err, appIdKey, pageDict) {
       return;
     }
     // keep track of the page dictionary
-    this.appDict[appIdKey].pageArray = currentPages;
+    this._appDict[appIdKey].pageArray = currentPages;
     this.log.debug(
       `Pages changed for ${appIdKey}: ${JSON.stringify(previousPages)} -> ${JSON.stringify(currentPages)}`
     );
@@ -76,22 +76,21 @@ export async function onAppConnect (err, dict) {
 export function onAppDisconnect (err, dict) {
   const appIdKey = dict.WIRApplicationIdentifierKey;
   this.log.debug(`Application '${appIdKey}' disconnected. Removing from app dictionary.`);
-  this.log.debug(`Current app is '${this.appIdKey}'`);
+  this.log.debug(`Current app is '${this._appIdKey}'`);
 
   // get rid of the entry in our app dictionary,
   // since it is no longer available
-  delete this.appDict[appIdKey];
+  delete this._appDict[appIdKey];
 
   // if the disconnected app is the one we are connected to, try to find another
-  if (this.appIdKey === appIdKey) {
+  if (this._appIdKey === appIdKey) {
     this.log.debug(`No longer have app id. Attempting to find new one.`);
-    this.appIdKey = getDebuggerAppKey.bind(this)(/** @type {string} */ (this.bundleId));
+    this._appIdKey = getDebuggerAppKey.bind(this)(/** @type {string} */ (this._bundleId));
   }
 
-  if (!this.appDict) {
+  if (!this._appDict) {
     // this means we no longer have any apps. what the what?
     this.log.debug('Main app disconnected. Disconnecting altogether.');
-    this.connected = false;
     this.emit(events.EVENT_DISCONNECT, true);
   }
 }
@@ -115,8 +114,8 @@ export async function onAppUpdate (err, dict) {
  * @returns {void}
  */
 export function onConnectedDriverList (err, drivers) {
-  this.connectedDrivers = drivers.WIRDriverDictionaryKey;
-  this.log.debug(`Received connected driver list: ${JSON.stringify(this.connectedDrivers)}`);
+  this._connectedDrivers = drivers.WIRDriverDictionaryKey;
+  this.log.debug(`Received connected driver list: ${JSON.stringify(this._connectedDrivers)}`);
 }
 
 /**
@@ -126,10 +125,10 @@ export function onConnectedDriverList (err, drivers) {
  * @returns {void}
  */
 export function onCurrentState (err, state) {
-  this.currentState = state.WIRAutomationAvailabilityKey;
+  this._currentState = state.WIRAutomationAvailabilityKey;
   // This state changes when 'Remote Automation' in 'Settings app' > 'Safari' > 'Advanced' > 'Remote Automation' changes
   // WIRAutomationAvailabilityAvailable or WIRAutomationAvailabilityNotAvailable
-  this.log.debug(`Received connected automation availability state: ${JSON.stringify(this.currentState)}`);
+  this.log.debug(`Received connected automation availability state: ${JSON.stringify(this._currentState)}`);
 }
 
 /**
@@ -147,13 +146,13 @@ export async function onConnectedApplicationList (err, apps) {
   let newDict = {};
   for (const dict of _.values(apps)) {
     const [id, entry] = appInfoFromDict(dict);
-    if (this.skippedApps.includes(entry.name)) {
+    if (this._skippedApps.includes(entry.name)) {
       continue;
     }
     newDict[id] = entry;
   }
   // update the object's list of apps
-  _.defaults(this.appDict, newDict);
+  _.defaults(this._appDict, newDict);
 }
 
 /**
@@ -165,17 +164,17 @@ export async function onConnectedApplicationList (err, apps) {
 function updateAppsWithDict (dict) {
   // get the dictionary entry into a nice form, and add it to the
   // application dictionary
-  this.appDict ??= {};
+  this._appDict ??= {};
   const [id, entry] = appInfoFromDict(dict);
-  if (this.appDict[id]) {
+  if (this._appDict[id]) {
     // preserve the page dictionary for this entry
-    entry.pageArray = this.appDict[id].pageArray;
+    entry.pageArray = this._appDict[id].pageArray;
   }
-  this.appDict[id] = entry;
+  this._appDict[id] = entry;
 
   // try to get the app id from our connected apps
-  if (!this.appIdKey) {
-    this.appIdKey = getDebuggerAppKey.bind(this)(/** @type {string} */ (this.bundleId));
+  if (!this._appIdKey) {
+    this._appIdKey = getDebuggerAppKey.bind(this)(/** @type {string} */ (this._bundleId));
   }
 }
 
@@ -189,7 +188,7 @@ function updateAppsWithDict (dict) {
  */
 export function getDebuggerAppKey (bundleId) {
   let appId;
-  for (const [key, data] of _.toPairs(this.appDict)) {
+  for (const [key, data] of _.toPairs(this._appDict)) {
     if (data.bundleId === bundleId) {
       appId = key;
       break;
@@ -199,7 +198,7 @@ export function getDebuggerAppKey (bundleId) {
   if (appId) {
     this.log.debug(`Found app id key '${appId}' for bundle '${bundleId}'`);
     let proxyAppId;
-    for (const [key, data] of _.toPairs(this.appDict)) {
+    for (const [key, data] of _.toPairs(this._appDict)) {
       if (data.isProxy && data.hostId === appId) {
         this.log.debug(`Found separate bundleId '${data.bundleId}' ` +
                   `acting as proxy for '${bundleId}', with app id '${key}'`);
@@ -217,5 +216,17 @@ export function getDebuggerAppKey (bundleId) {
 }
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasMessageHandlersRelatedProperties
+ * @property {string | null | undefined} _appIdKey
+ * @property {string | number | null | undefined} _pageIdKey
+ * @property {import('../types').AppDict} _appDict
+ * @property {boolean} _navigatingToPage
+ * @property {string | undefined} _currentState
+ * @property {string | undefined} _bundleId
+ * @property {string[] | undefined} _connectedDrivers
+ * @property {string[]} _skippedApps
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasMessageHandlersRelatedProperties} RemoteDebugger
  */

package/lib/mixins/misc.js

@@ -16,15 +16,15 @@ export async function launchSafari () {
 
 /**
  * @this {RemoteDebugger}
- * @param {(event: import('@appium/types').StringRecord) => any} fn
+ * @param {import('../types').EventListener} fn
  * @returns {Promise<any>}
  */
 export async function startTimeline (fn) {
   this.log.debug('Starting to record the timeline');
   this.requireRpcClient().on('Timeline.eventRecorded', fn);
   return await this.requireRpcClient().send('Timeline.start', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
   });
 }
 
@@ -35,51 +35,11 @@ export async function startTimeline (fn) {
 export async function stopTimeline () {
   this.log.debug('Stopping to record the timeline');
   await this.requireRpcClient().send('Timeline.stop', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
   });
 }
 
-/**
- * @this {RemoteDebugger}
- * @param {(event: import('@appium/types').StringRecord) => any} listener
- * @returns {void}
- */
-export function startConsole (listener) {
-  this.log.debug('Starting to listen for JavaScript console');
-  this.addClientEventListener('Console.messageAdded', listener);
-  this.addClientEventListener('Console.messageRepeatCountUpdated', listener);
-}
-
-/**
- * @this {RemoteDebugger}
- * @returns {void}
- */
-export function stopConsole () {
-  this.log.debug('Stopping to listen for JavaScript console');
-  this.removeClientEventListener('Console.messageAdded');
-  this.removeClientEventListener('Console.messageRepeatCountUpdated');
-}
-
-/**
- * @this {RemoteDebugger}
- * @param {(event: import('@appium/types').StringRecord) => any} listener
- * @returns {void}
- */
-export function startNetwork (listener) {
-  this.log.debug('Starting to listen for network events');
-  this.addClientEventListener('NetworkEvent', listener);
-}
-
-/**
- * @this {RemoteDebugger}
- * @returns {void}
- */
-export function stopNetwork () {
-  this.log.debug('Stopping to listen for network events');
-  this.removeClientEventListener('NetworkEvent');
-}
-
 // Potentially this does not work for mobile safari
 /**
  * @this {RemoteDebugger}
@@ -89,8 +49,8 @@ export function stopNetwork () {
 export async function overrideUserAgent (value) {
   this.log.debug('Setting overrideUserAgent');
   return await this.requireRpcClient().send('Page.overrideUserAgent', {
-    appIdKey: this.appIdKey,
-    pageIdKey: this.pageIdKey,
+    appIdKey: this._appIdKey,
+    pageIdKey: this._pageIdKey,
     value
   });
 }
@@ -104,7 +64,7 @@ export async function garbageCollect (timeoutMs = GARBAGE_COLLECT_TIMEOUT_MS) {
   this.log.debug(`Garbage collecting with ${timeoutMs}ms timeout`);
 
   try {
-    checkParams({appIdKey: this.appIdKey, pageIdKey: this.pageIdKey});
+    checkParams({appIdKey: this._appIdKey, pageIdKey: this._pageIdKey});
   } catch (err) {
     this.log.debug(`Unable to collect garbage at this time`);
     return;
@@ -113,8 +73,8 @@ export async function garbageCollect (timeoutMs = GARBAGE_COLLECT_TIMEOUT_MS) {
   try {
     await B.resolve(this.requireRpcClient().send(
       'Heap.gc', {
-        appIdKey: this.appIdKey,
-        pageIdKey: this.pageIdKey,
+        appIdKey: this._appIdKey,
+        pageIdKey: this._pageIdKey,
       })
     ).timeout(timeoutMs);
     this.log.debug(`Garbage collection successful`);
@@ -128,5 +88,11 @@ export async function garbageCollect (timeoutMs = GARBAGE_COLLECT_TIMEOUT_MS) {
 }
 
 /**
- * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
+ * @typedef {Object} HasMiscRelatedProperties
+ * @property {string | null | undefined} _appIdKey
+ * @property {string | number | null | undefined} _pageIdKey
+ */
+
+/**
+ * @typedef {import('../remote-debugger').RemoteDebugger & HasMiscRelatedProperties} RemoteDebugger
  */