appium-remote-debugger 12.0.0 → 12.0.1

package/lib/mixins/connect.js

@@ -7,6 +7,17 @@ import events from './events';
 import { timing, util } from '@appium/support';
 import { retryInterval, waitForCondition } from 'asyncbox';
 import _ from 'lodash';
+import {
+  setAppIdKey,
+  getAppDict,
+  getAppIdKey,
+  setPageIdKey,
+  getRcpClient,
+  getIsSafari,
+  getIncludeSafari,
+  getBundleId,
+  getAdditionalBundleIds,
+} from './property-accessors';
 
 const APP_CONNECT_TIMEOUT_MS = 0;
 const APP_CONNECT_INTERVAL_MS = 100;
@@ -36,7 +47,7 @@ export async function setConnectionKey () {
  *
  * @this {RemoteDebugger}
  * @param {number} [timeout=APP_CONNECT_TIMEOUT_MS]
- * @returns {Promise<import('@appium/types').StringRecord>}
+ * @returns {Promise<import('../types').AppDict>}
  */
 export async function connect (timeout = APP_CONNECT_TIMEOUT_MS) {
   this.setup();
@@ -66,19 +77,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(getAppDict(this)), {
           waitMs: timeout,
           intervalMs: APP_CONNECT_INTERVAL_MS,
         });
         this.log.debug(
-          `Retrieved ${util.pluralize('application', _.size(this._appDict), true)} ` +
+          `Retrieved ${util.pluralize('application', _.size(getAppDict(this)), 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 _.cloneDeep(getAppDict(this));
   } catch (err) {
     this.log.error(`Error setting connection key: ${err.message}`);
     await this.disconnect();
@@ -92,9 +103,7 @@ export async function connect (timeout = APP_CONNECT_TIMEOUT_MS) {
  * @returns {Promise<void>}
  */
 export async function disconnect () {
-  if (this._rpcClient) {
-    await this._rpcClient.disconnect();
-  }
+  await getRcpClient(this)?.disconnect();
   this.emit(events.EVENT_DISCONNECT, true);
   this.teardown();
 }
@@ -115,23 +124,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 (_.isEmpty(getAppDict(this))) {
       this.log.debug('No applications currently connected.');
       return [];
     }
 
     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;
+    if (getAppIdKey(this) !== appIdKey) {
+      this.log.debug(`Received altered app id, updating from '${getAppIdKey(this)}' to '${appIdKey}'`);
+      setAppIdKey(this, 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 ${getAppIdKey(this)}`);
 
     /** @type {import('../types').Page[]} */
     const fullPageArray = [];
-    for (const [app, info] of _.toPairs(this._appDict)) {
+    for (const [app, info] of _.toPairs(getAppDict(this))) {
       if (!_.isArray(info.pageArray) || !info.isActive) {
         continue;
       }
@@ -162,14 +171,15 @@ export async function selectApp (currentUrl = null, maxTries = SELECT_APP_RETRIE
  * @returns {Promise<void>}
  */
 export async function selectPage (appIdKey, pageIdKey, skipReadyCheck = false) {
-  this._appIdKey = _.startsWith(`${appIdKey}`, 'PID:') ? `${appIdKey}` : `PID:${appIdKey}`;
-  this._pageIdKey = pageIdKey;
+  const fullAppIdKey = _.startsWith(`${appIdKey}`, 'PID:') ? `${appIdKey}` : `PID:${appIdKey}`;
+  setAppIdKey(this, fullAppIdKey);
+  setPageIdKey(this, pageIdKey);
 
-  this.log.debug(`Selecting page '${pageIdKey}' on app '${this._appIdKey}' and forwarding socket setup`);
+  this.log.debug(`Selecting page '${pageIdKey}' on app '${fullAppIdKey}' and forwarding socket setup`);
 
   const timer = new timing.Timer().start();
 
-  await this.requireRpcClient().selectPage(this._appIdKey, pageIdKey);
+  await this.requireRpcClient().selectPage(fullAppIdKey, pageIdKey);
 
   if (!skipReadyCheck && !await this.checkPageIsReady()) {
     await this.waitForDom();
@@ -178,7 +188,6 @@ export async function selectPage (appIdKey, pageIdKey, skipReadyCheck = false) {
   this.log.debug(`Selected page after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
 }
 
-
 /**
  *
  * @this {RemoteDebugger}
@@ -188,9 +197,14 @@ export async function selectPage (appIdKey, pageIdKey, skipReadyCheck = false) {
  * @returns {Promise<import('../types').AppPage>}
  */
 async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
-  const bundleIds = this._includeSafari && !this._isSafari
-    ? [this._bundleId, ...this._additionalBundleIds, SAFARI_BUNDLE_ID]
-    : [this._bundleId, ...this._additionalBundleIds];
+  /** @type {string[]} */
+  const bundleIds = _.compact(
+    [
+      getBundleId(this),
+      ...(getAdditionalBundleIds(this) ?? []),
+      ...(getIncludeSafari(this) && !getIsSafari(this) ? [SAFARI_BUNDLE_ID] : []),
+    ]
+  );
   let retryCount = 0;
   return /** @type {import('../types').AppPage} */ (await retryInterval(maxTries, SELECT_APP_RETRY_SLEEP_MS, async () => {
     logApplicationDictionary.bind(this)();
@@ -198,7 +212,7 @@ 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 (!getAppDict(this)[attemptedAppIdKey].isActive) {
           this.log.debug(`Skipping app '${attemptedAppIdKey}' because it is not active`);
           continue;
         }
@@ -216,12 +230,12 @@ async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
         }
 
         // save the page array for this app
-        this._appDict[appIdKey].pageArray = pageArrayFromDict(pageDict);
+        getAppDict(this)[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 = searchForPage.bind(this)(this._appDict, currentUrl, ignoreAboutBlankUrl);
+        const result = searchForPage.bind(this)(getAppDict(this), currentUrl, ignoreAboutBlankUrl);
         if (result) {
           return result;
         }
@@ -276,7 +290,7 @@ function searchForPage (appsDict, currentUrl = null, ignoreAboutBlankUrl = false
  */
 function logApplicationDictionary () {
   this.log.debug('Current applications available:');
-  for (const [app, info] of _.toPairs(this._appDict)) {
+  for (const [app, info] of _.toPairs(getAppDict(this))) {
     this.log.debug(`    Application: "${app}"`);
     for (const [key, value] of _.toPairs(info)) {
       if (key === 'pageArray' && Array.isArray(value) && value.length) {
@@ -307,7 +321,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(getAppDict(this)));
   }
 
   // go through the possible bundle identifiers
@@ -324,10 +338,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, getAppDict(this))) {
       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(getAppDict(this))) {
         if (data.isProxy && data.hostId === appId) {
           this.log.debug(
             `Found separate bundleId '${data.bundleId}' ` +
@@ -343,19 +357,5 @@ export function getPossibleDebuggerAppKeys(bundleIds) {
 }
 
 /**
- * @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
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */

package/lib/mixins/cookies.js

@@ -1,3 +1,7 @@
+import {
+  getAppIdKey,
+  getPageIdKey,
+} from './property-accessors';
 
 /**
  *
@@ -7,8 +11,8 @@
 export async function getCookies () {
   this.log.debug('Getting cookies');
   return await this.requireRpcClient().send('Page.getCookies', {
-    appIdKey: this._appIdKey,
-    pageIdKey: this._pageIdKey
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
   });
 }
 
@@ -21,9 +25,9 @@ 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,
-    cookie
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
+    cookie,
   });
 }
 
@@ -37,19 +41,13 @@ 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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
     cookieName,
     url,
   });
 }
 
 /**
- * @typedef {Object} HasCookiesRelatedProperties
- * @property {string | null | undefined} _appIdKey
- * @property {string | number | null | undefined} _pageIdKey
- */
-
-/**
- * @typedef {import('../remote-debugger').RemoteDebugger & HasCookiesRelatedProperties} RemoteDebugger
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */

package/lib/mixins/events.js

@@ -1,9 +1,13 @@
+import {
+  getClientEventListeners,
+} from './property-accessors';
+
 // event emitted publically
-export const events = {
+export const events = /** @type {const} */ ({
   EVENT_PAGE_CHANGE: 'remote_debugger_page_change',
   EVENT_FRAMES_DETACHED: 'remote_debugger_frames_detached',
   EVENT_DISCONNECT: 'remote_debugger_disconnect',
-};
+});
 
 /**
  * Keep track of the client event listeners so they can be removed
@@ -14,8 +18,8 @@ export const events = {
  * @returns {void}
  */
 export function addClientEventListener (eventName, listener) {
-  this._clientEventListeners[eventName] ??= [];
-  this._clientEventListeners[eventName].push(listener);
+  getClientEventListeners(this)[eventName] ??= [];
+  getClientEventListeners(this)[eventName].push(listener);
   this.requireRpcClient().on(eventName, listener);
 }
 
@@ -25,7 +29,7 @@ export function addClientEventListener (eventName, listener) {
  * @returns {void}
  */
 export function removeClientEventListener (eventName) {
-  for (const listener of (this._clientEventListeners[eventName] || [])) {
+  for (const listener of (getClientEventListeners(this)[eventName] || [])) {
     this.requireRpcClient().off(eventName, listener);
   }
 }
@@ -73,10 +77,5 @@ export function stopNetwork () {
 export default events;
 
 /**
- * @typedef {Object} HasEventsRelatedProperties
- * @property {import('@appium/types').StringRecord<import('../types').EventListener[]>} _clientEventListeners:
- */
-
-/**
- * @typedef {import('../remote-debugger').RemoteDebugger & HasEventsRelatedProperties} RemoteDebugger
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */

package/lib/mixins/execute.js

@@ -1,10 +1,20 @@
 import { errors } from '@appium/base-driver';
-import { checkParams, simpleStringify, convertResult, RESPONSE_LOG_LENGTH } from '../utils';
+import {
+  checkParams,
+  simpleStringify,
+  convertResult,
+  RESPONSE_LOG_LENGTH,
+} from '../utils';
 import { getScriptForAtom } from '../atoms';
 import { util, timing } from '@appium/support';
 import { retryInterval } from 'asyncbox';
 import _ from 'lodash';
-
+import {
+  getAppIdKey,
+  getPageIdKey,
+  getPageLoading,
+  getGarbageCollectOnExecute,
+} from './property-accessors';
 
 /* How many milliseconds to wait for webkit to return a response before timing out */
 const RPC_RESPONSE_TIMEOUT_MS = 5000;
@@ -36,8 +46,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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
     returnByValue: false,
   }, opts));
 
@@ -125,19 +135,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 (getPageLoading(this) && !override) {
     this.log.debug('Trying to execute but page is not loaded.');
     await this.waitForDom();
   }
 
-  if (_.isNil(this._appIdKey)) {
+  if (_.isNil(getAppIdKey(this))) {
     throw new Error('Missing parameter: appIdKey. Is the target web application still alive?');
   }
-  if (_.isNil(this._pageIdKey)) {
+  if (_.isNil(getPageIdKey(this))) {
     throw new Error('Missing parameter: pageIdKey. Is the target web page still alive?');
   }
 
-  if (this._garbageCollectOnExecute) {
+  if (getGarbageCollectOnExecute(this)) {
     await this.garbageCollect();
   }
 
@@ -145,8 +155,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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
   });
   return convertResult(res);
 }
@@ -158,9 +168,12 @@ 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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
+  });
 
-  if (this._garbageCollectOnExecute) {
+  if (getGarbageCollectOnExecute(this)) {
     await this.garbageCollect();
   }
 
@@ -170,22 +183,13 @@ export async function callFunction (objectId, fn, args) {
     functionDeclaration: fn,
     arguments: args,
     returnByValue: true,
-    appIdKey: this._appIdKey,
-    pageIdKey: this._pageIdKey,
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
   });
 
   return convertResult(res);
 }
 
 /**
- * @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
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */

package/lib/mixins/message-handlers.js

@@ -4,7 +4,16 @@ import {
   appInfoFromDict,
 } from '../utils';
 import _ from 'lodash';
-
+import {
+  setAppIdKey,
+  getAppDict,
+  getAppIdKey,
+  getBundleId,
+  getNavigatingToPage,
+  setCurrentState,
+  setConnectedDrivers,
+  getSkippedApps,
+} from './property-accessors';
 
 /*
  * Generic callbacks used throughout the lifecycle of the Remote Debugger.
@@ -26,8 +35,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 (getAppDict(this)[appIdKey]) {
+    const previousPages = getAppDict(this)[appIdKey].pageArray;
     // we have a pre-existing pageDict
     if (previousPages && _.isEqual(previousPages, currentPages)) {
       this.log.debug(
@@ -37,13 +46,13 @@ export async function onPageChange (err, appIdKey, pageDict) {
       return;
     }
     // keep track of the page dictionary
-    this._appDict[appIdKey].pageArray = currentPages;
+    getAppDict(this)[appIdKey].pageArray = currentPages;
     this.log.debug(
       `Pages changed for ${appIdKey}: ${JSON.stringify(previousPages)} -> ${JSON.stringify(currentPages)}`
     );
   }
 
-  if (this._navigatingToPage) {
+  if (getNavigatingToPage(this)) {
     // in the middle of navigating, so reporting a page change will cause problems
     return;
   }
@@ -76,19 +85,19 @@ 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 '${getAppIdKey(this)}'`);
 
   // get rid of the entry in our app dictionary,
   // since it is no longer available
-  delete this._appDict[appIdKey];
+  delete getAppDict(this)[appIdKey];
 
   // if the disconnected app is the one we are connected to, try to find another
-  if (this._appIdKey === appIdKey) {
+  if (getAppIdKey(this) === appIdKey) {
     this.log.debug(`No longer have app id. Attempting to find new one.`);
-    this._appIdKey = getDebuggerAppKey.bind(this)(/** @type {string} */ (this._bundleId));
+    setAppIdKey(this, getDebuggerAppKey.bind(this)(/** @type {string} */ (getBundleId(this))));
   }
 
-  if (!this._appDict) {
+  if (_.isEmpty(getAppDict(this))) {
     // this means we no longer have any apps. what the what?
     this.log.debug('Main app disconnected. Disconnecting altogether.');
     this.emit(events.EVENT_DISCONNECT, true);
@@ -114,8 +123,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)}`);
+  setConnectedDrivers(this, drivers.WIRDriverDictionaryKey);
+  this.log.debug(`Received connected driver list: ${JSON.stringify(this.connectedDrivers)}`);
 }
 
 /**
@@ -125,10 +134,10 @@ export function onConnectedDriverList (err, drivers) {
  * @returns {void}
  */
 export function onCurrentState (err, state) {
-  this._currentState = state.WIRAutomationAvailabilityKey;
+  setCurrentState(this, 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)}`);
 }
 
 /**
@@ -146,13 +155,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 (getSkippedApps(this).includes(entry.name)) {
       continue;
     }
     newDict[id] = entry;
   }
   // update the object's list of apps
-  _.defaults(this._appDict, newDict);
+  _.defaults(getAppDict(this), newDict);
 }
 
 /**
@@ -164,17 +173,16 @@ 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 ??= {};
   const [id, entry] = appInfoFromDict(dict);
-  if (this._appDict[id]) {
+  if (getAppDict(this)[id]) {
     // preserve the page dictionary for this entry
-    entry.pageArray = this._appDict[id].pageArray;
+    entry.pageArray = getAppDict(this)[id].pageArray;
   }
-  this._appDict[id] = entry;
+  getAppDict(this)[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 (!getAppIdKey(this)) {
+    setAppIdKey(this, getDebuggerAppKey.bind(this)(/** @type {string} */ (getBundleId(this))));
   }
 }
 
@@ -188,7 +196,7 @@ function updateAppsWithDict (dict) {
  */
 export function getDebuggerAppKey (bundleId) {
   let appId;
-  for (const [key, data] of _.toPairs(this._appDict)) {
+  for (const [key, data] of _.toPairs(getAppDict(this))) {
     if (data.bundleId === bundleId) {
       appId = key;
       break;
@@ -198,7 +206,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(getAppDict(this))) {
       if (data.isProxy && data.hostId === appId) {
         this.log.debug(`Found separate bundleId '${data.bundleId}' ` +
                   `acting as proxy for '${bundleId}', with app id '${key}'`);
@@ -216,17 +224,5 @@ export function getDebuggerAppKey (bundleId) {
 }
 
 /**
- * @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
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */

package/lib/mixins/misc.js

@@ -1,5 +1,9 @@
 import { checkParams } from '../utils';
 import B from 'bluebird';
+import {
+  getAppIdKey,
+  getPageIdKey,
+} from './property-accessors';
 
 const SAFARI_BUNDLE_ID = 'com.apple.mobilesafari';
 const GARBAGE_COLLECT_TIMEOUT_MS = 5000;
@@ -23,8 +27,8 @@ 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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
   });
 }
 
@@ -35,8 +39,8 @@ 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: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
   });
 }
 
@@ -49,9 +53,9 @@ export async function stopTimeline () {
 export async function overrideUserAgent (value) {
   this.log.debug('Setting overrideUserAgent');
   return await this.requireRpcClient().send('Page.overrideUserAgent', {
-    appIdKey: this._appIdKey,
-    pageIdKey: this._pageIdKey,
-    value
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
+    value,
   });
 }
 
@@ -64,7 +68,10 @@ 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: getAppIdKey(this),
+      pageIdKey: getPageIdKey(this),
+    });
   } catch (err) {
     this.log.debug(`Unable to collect garbage at this time`);
     return;
@@ -73,8 +80,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: getAppIdKey(this),
+        pageIdKey: getPageIdKey(this),
       })
     ).timeout(timeoutMs);
     this.log.debug(`Garbage collection successful`);
@@ -88,11 +95,5 @@ export async function garbageCollect (timeoutMs = GARBAGE_COLLECT_TIMEOUT_MS) {
 }
 
 /**
- * @typedef {Object} HasMiscRelatedProperties
- * @property {string | null | undefined} _appIdKey
- * @property {string | number | null | undefined} _pageIdKey
- */
-
-/**
- * @typedef {import('../remote-debugger').RemoteDebugger & HasMiscRelatedProperties} RemoteDebugger
+ * @typedef {import('../remote-debugger').RemoteDebugger} RemoteDebugger
  */