appium-remote-debugger 12.2.9 → 13.0.0

package/lib/mixins/connect.js

@@ -18,6 +18,7 @@ import {
   getBundleId,
   getAdditionalBundleIds,
 } from './property-accessors';
+import { NEW_APP_CONNECTED_ERROR, EMPTY_PAGE_DICTIONARY_ERROR } from '../rpc/rpc-client';
 
 const APP_CONNECT_TIMEOUT_MS = 0;
 const APP_CONNECT_INTERVAL_MS = 100;
@@ -118,48 +119,41 @@ export async function disconnect () {
  */
 export async function selectApp (currentUrl = null, maxTries = SELECT_APP_RETRIES, ignoreAboutBlankUrl = false) {
   this.log.debug('Selecting application');
-  const rpcClient = this.requireRpcClient();
 
-  const shouldCheckForTarget = rpcClient.shouldCheckForTarget;
-  rpcClient.shouldCheckForTarget = false;
-  try {
-    const timer = new timing.Timer().start();
-    if (_.isEmpty(getAppDict(this))) {
-      this.log.debug('No applications currently connected.');
-      return [];
-    }
+  const timer = new timing.Timer().start();
+  if (_.isEmpty(getAppDict(this))) {
+    this.log.debug('No applications currently connected.');
+    return [];
+  }
 
-    const { appIdKey } = await searchForApp.bind(this)(currentUrl, maxTries, ignoreAboutBlankUrl);
-    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 ${getAppIdKey(this)}`);
+  const { appIdKey } = await searchForApp.bind(this)(currentUrl, maxTries, ignoreAboutBlankUrl);
+  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 ${getAppIdKey(this)}`);
 
-    /** @type {import('../types').Page[]} */
-    const fullPageArray = [];
-    for (const [app, info] of _.toPairs(getAppDict(this))) {
-      if (!_.isArray(info.pageArray) || !info.isActive) {
-        continue;
-      }
-      const id = app.replace('PID:', '');
-      for (const page of info.pageArray) {
-        if (!(ignoreAboutBlankUrl && page.url === BLANK_PAGE_URL)) {
-          const pageDict = _.clone(page);
-          pageDict.id = `${id}.${pageDict.id}`;
-          pageDict.bundleId = info.bundleId;
-          fullPageArray.push(pageDict);
-        }
+  /** @type {import('../types').Page[]} */
+  const fullPageArray = [];
+  for (const [app, info] of _.toPairs(getAppDict(this))) {
+    if (!_.isArray(info.pageArray) || !info.isActive) {
+      continue;
+    }
+    const id = app.replace('PID:', '');
+    for (const page of info.pageArray) {
+      if (!(ignoreAboutBlankUrl && page.url === BLANK_PAGE_URL)) {
+        const pageDict = _.clone(page);
+        pageDict.id = `${id}.${pageDict.id}`;
+        pageDict.bundleId = info.bundleId;
+        fullPageArray.push(pageDict);
       }
     }
-
-    this.log.debug(`Selected app after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
-    return fullPageArray;
-  } finally {
-    rpcClient.shouldCheckForTarget = shouldCheckForTarget;
   }
+
+  this.log.debug(`Selected app after ${timer.getDuration().asMilliSeconds.toFixed(0)}ms`);
+  return fullPageArray;
 }
 
 /**
@@ -243,8 +237,10 @@ async function searchForApp (currentUrl, maxTries, ignoreAboutBlankUrl) {
           this.log.debug('Received app, but no match was found. Trying again.');
         }
       } catch (err) {
-        this.log.debug(err.stack);
-        this.log.warn(`Error checking application ${attemptedAppIdKey}: '${err.message}'`);
+        if (![NEW_APP_CONNECTED_ERROR, EMPTY_PAGE_DICTIONARY_ERROR].some((msg) => msg === err.message)) {
+          this.log.debug(err.stack);
+        }
+        this.log.warn(`The application ${attemptedAppIdKey} is not connectable yet: ${err.message}`);
       }
     }
     retryCount++;

package/lib/mixins/execute.js

@@ -140,23 +140,26 @@ export async function execute (command, override) {
     await this.waitForDom();
   }
 
-  if (_.isNil(getAppIdKey(this))) {
-    throw new Error('Missing parameter: appIdKey. Is the target web application still alive?');
-  }
-  if (_.isNil(getPageIdKey(this))) {
-    throw new Error('Missing parameter: pageIdKey. Is the target web page still alive?');
-  }
+  const {appIdKey, pageIdKey} = checkParams({
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
+  });
 
   if (getGarbageCollectOnExecute(this)) {
     await this.garbageCollect();
   }
 
+  const rpcClient = this.requireRpcClient(true);
+  await rpcClient.waitForPageInitialization(
+    /** @type {import('../types').AppIdKey} */ (appIdKey),
+    /** @type {import('../types').PageIdKey} */ (pageIdKey)
+  );
   this.log.debug(`Sending javascript command: '${_.truncate(command, {length: 50})}'`);
-  const res = await this.requireRpcClient(true).send('Runtime.evaluate', {
+  const res = await rpcClient.send('Runtime.evaluate', {
     expression: command,
     returnByValue: true,
-    appIdKey: getAppIdKey(this),
-    pageIdKey: getPageIdKey(this),
+    appIdKey,
+    pageIdKey,
   });
   return convertResult(res);
 }
@@ -168,7 +171,7 @@ export async function execute (command, override) {
  * @param {any[]} [args]
  */
 export async function callFunction (objectId, fn, args) {
-  checkParams({
+  const {appIdKey, pageIdKey} = checkParams({
     appIdKey: getAppIdKey(this),
     pageIdKey: getPageIdKey(this),
   });
@@ -183,8 +186,8 @@ export async function callFunction (objectId, fn, args) {
     functionDeclaration: fn,
     arguments: args,
     returnByValue: true,
-    appIdKey: getAppIdKey(this),
-    pageIdKey: getPageIdKey(this),
+    appIdKey,
+    pageIdKey,
   });
 
   return convertResult(res);

package/lib/mixins/navigate.js

@@ -1,10 +1,8 @@
-import { checkParams, pageArrayFromDict } from '../utils';
+import { checkParams } from '../utils';
 import { events } from './events';
 import { timing, util } from '@appium/support';
 import _ from 'lodash';
 import B, { TimeoutError as BTimeoutError } from 'bluebird';
-import { errors } from '@appium/base-driver';
-import { rpcConstants } from '../rpc';
 import {
   getAppIdKey,
   setPageLoading,
@@ -18,8 +16,6 @@ import {
 
 export const DEFAULT_PAGE_READINESS_TIMEOUT_MS = 20 * 1000;
 const PAGE_READINESS_CHECK_INTERVAL_MS = 50;
-const PAGE_READINESS_JS_MIN_CHECK_INTERVAL_MS = 1000;
-const CONSOLE_ENABLEMENT_TIMEOUT_MS = 20 * 1000;
 
 /**
  * pageLoadStrategy in WebDriver definitions.
@@ -146,10 +142,6 @@ export async function waitForDom (startPageLoadTimer) {
  * @returns {Promise<boolean>}
  */
 export async function checkPageIsReady (timeoutMs) {
-  checkParams({
-    appIdKey: getAppIdKey(this),
-  });
-
   const readyCmd = 'document.readyState;';
   const actualTimeoutMs = timeoutMs ?? getPageReadyTimeout(this);
   try {
@@ -173,9 +165,10 @@ export async function checkPageIsReady (timeoutMs) {
  * @returns {Promise<void>}
  */
 export async function navToUrl (url) {
-  const appIdKey = getAppIdKey(this);
-  const pageIdKey = getPageIdKey(this);
-  checkParams({appIdKey, pageIdKey});
+  const {appIdKey, pageIdKey} = checkParams({
+    appIdKey: getAppIdKey(this),
+    pageIdKey: getPageIdKey(this),
+  });
   const rpcClient = this.requireRpcClient();
 
   try {
@@ -184,43 +177,25 @@ export async function navToUrl (url) {
     throw new TypeError(`'${url}' is not a valid URL`);
   }
 
-  setNavigatingToPage(this, true);
   this.log.debug(`Navigating to new URL: '${url}'`);
+  setNavigatingToPage(this, true);
+  await rpcClient.waitForPageInitialization(
+    /** @type {import('../types').AppIdKey} */ (appIdKey),
+    /** @type {import('../types').PageIdKey} */ (pageIdKey)
+  );
   const readinessTimeoutMs = this.pageLoadMs;
   /** @type {(() => void)|undefined} */
   let onPageLoaded;
-  /** @type {(() => void)|undefined} */
-  let onPageChanged;
-  /** @type {(() => void)|undefined} */
-  let onTargetProvisioned;
   /** @type {NodeJS.Timeout|undefined|null} */
   let onPageLoadedTimeout;
   setPageLoadDelay(this, util.cancellableDelay(readinessTimeoutMs));
   setPageLoading(this, true);
   let isPageLoading = true;
-  let didPageFinishLoad = false;
-  /** @type {Promise<void>|null} */
-  let pageReadinessCheckPromise = null;
+  // /** @type {Promise<void>|null} */
   const start = new timing.Timer().start();
 
   /** @type {B<void>} */
   const pageReadinessPromise = new B((resolve) => {
-    const performPageReadinessCheck = async () => {
-      while (isPageLoading) {
-        const pageReadyCheckStart = new timing.Timer().start();
-        try {
-          const isReady = await this.checkPageIsReady(PAGE_READINESS_JS_MIN_CHECK_INTERVAL_MS);
-          if (isReady && isPageLoading && onPageLoaded) {
-            return onPageLoaded();
-          }
-        } catch {}
-        const msLeft = PAGE_READINESS_JS_MIN_CHECK_INTERVAL_MS - pageReadyCheckStart.getDuration().asMilliSeconds;
-        if (msLeft > 0 && isPageLoading) {
-          await B.delay(msLeft);
-        }
-      }
-    };
-
     onPageLoadedTimeout = setTimeout(() => {
       if (isPageLoading) {
         isPageLoading = false;
@@ -241,53 +216,11 @@ export async function navToUrl (url) {
         clearTimeout(onPageLoadedTimeout);
         onPageLoadedTimeout = null;
       }
-      didPageFinishLoad = true;
       return resolve();
     };
 
-    // Sometimes it could be observed that we do not receive
-    // any events for target provisioning while navigating to a new page,
-    // but only events related to the page change.
-    // So lets just start the monitoring loop as soon as any of these events arrives
-    // for the target page.
-    onPageChanged = async (
-      /** @type {Error|null} */ err,
-      /** @type {string} */ _appIdKey,
-      /** @type {import("@appium/types").StringRecord} */ pageDict
-    ) => {
-      if (_appIdKey !== appIdKey) {
-        return;
-      }
-
-      /** @type {import('../types').Page|undefined} */
-      const targetPage = pageArrayFromDict(pageDict)
-        .find(({id}) => parseInt(`${id}`, 10) === parseInt(`${pageIdKey}`, 10));
-      if (targetPage?.url === url) {
-        this.log.debug(`The page ${targetPage.id} has the expected URL ${url}`);
-        if (pageReadinessCheckPromise) {
-          this.log.debug('Page readiness monitoring is already running');
-        } else {
-          this.log.debug('Monitoring page readiness');
-          pageReadinessCheckPromise = performPageReadinessCheck();
-          await pageReadinessCheckPromise;
-        }
-      }
-    };
-    rpcClient.on('_rpc_forwardGetListing:', onPageChanged);
-
     // https://chromedevtools.github.io/devtools-protocol/tot/Page/#event-loadEventFired
     rpcClient.once('Page.loadEventFired', onPageLoaded);
-    onTargetProvisioned = async () => {
-      this.log.debug('The page target has been provisioned');
-      if (pageReadinessCheckPromise) {
-        this.log.debug('Page readiness monitoring is already running');
-      } else {
-        this.log.debug('Monitoring page readiness');
-        pageReadinessCheckPromise = performPageReadinessCheck();
-        await pageReadinessCheckPromise;
-      }
-    };
-    rpcClient.targetSubscriptions.once(rpcConstants.ON_TARGET_PROVISIONED_EVENT, onTargetProvisioned);
 
     rpcClient.send('Page.navigate', {
       url,
@@ -313,30 +246,9 @@ export async function navToUrl (url) {
       clearTimeout(onPageLoadedTimeout);
       onPageLoadedTimeout = null;
     }
-    if (onTargetProvisioned) {
-      rpcClient.targetSubscriptions.off(rpcConstants.ON_TARGET_PROVISIONED_EVENT, onTargetProvisioned);
-    }
     if (onPageLoaded) {
       rpcClient.off('Page.loadEventFired', onPageLoaded);
     }
-    if (onPageChanged) {
-      rpcClient.off('_rpc_forwardGetListing:', onPageChanged);
-    }
-  }
-
-  // enable console logging, so we get the events (otherwise we only
-  // get notified when navigating to a local page
-  try {
-    await B.resolve(rpcClient.send('Console.enable', {
-      appIdKey: getAppIdKey(this),
-      pageIdKey: getPageIdKey(this),
-    }, didPageFinishLoad)).timeout(CONSOLE_ENABLEMENT_TIMEOUT_MS);
-  } catch (err) {
-    if (err instanceof BTimeoutError) {
-      throw new errors.TimeoutError(`Could not enable console events after the page load within ` +
-        `${CONSOLE_ENABLEMENT_TIMEOUT_MS}ms. The Web Inspector/Safari may need to be restarted.`);
-    }
-    throw err;
   }
 }
 

package/lib/protocol/index.js

@@ -175,6 +175,8 @@ const COMMANDS = /** @type {const} */ ({
   // https://github.com/WebKit/WebKit/blob/main/Source/JavaScriptCore/inspector/protocol/Target.json
   //#region TARGET DOMAIN
   'Target.exists': [], // removed since WebKit in 13.4
+  'Target.setPauseOnStart': ['pauseOnStart'],
+  'Target.resume': ['targetId'],
   //#endregion
 
   // https://github.com/WebKit/WebKit/blob/main/Source/JavaScriptCore/inspector/protocol/Timeline.json
@@ -196,36 +198,16 @@ const COMMANDS = /** @type {const} */ ({
   //#endregion
 });
 
-/**
- *
- * @param {string} id
- * @param {string} method
- * @param {import('@appium/types').StringRecord} params
- * @returns {import('../types').ProtocolCommandOpts}
- */
-function getCommand (id, method, params = {}) {
-  return {
-    id,
-    method,
-    params: Object.assign({
-      objectGroup: OBJECT_GROUP,
-      includeCommandLineAPI: true,
-      doNotPauseOnExceptionsAndMuteConsole: false,
-      emulateUserGesture: false,
-      generatePreview: false,
-      saveResult: false,
-    }, params),
-  };
-}
-
 /**
  *
  * @param {string} id
  * @param {string} method
  * @param {import('../types').RemoteCommandOpts} opts
+ * @param {boolean} [direct=false] - if set to false then the resulting command params
+ * will be patched with default values
  * @returns {import('../types').ProtocolCommandOpts}
  */
-export function getProtocolCommand (id, method, opts) {
+export function getProtocolCommand (id, method, opts, direct = false) {
   const paramNames = COMMANDS[method];
   if (!paramNames) {
     throw new Error(`Unknown command: '${method}'`);
@@ -235,7 +217,23 @@ export function getProtocolCommand (id, method, opts) {
     params[name] = opts[name];
     return params;
   }, {});
-  return getCommand(id, method, params);
+  const result = {
+    id,
+    method,
+    params,
+  };
+  if (!direct) {
+    result.params = {
+      objectGroup: OBJECT_GROUP,
+      includeCommandLineAPI: true,
+      doNotPauseOnExceptionsAndMuteConsole: false,
+      emulateUserGesture: false,
+      generatePreview: false,
+      saveResult: false,
+      ...result.params,
+    };
+  }
+  return result;
 }
 
 export default getProtocolCommand;

package/lib/rpc/index.js

@@ -1,6 +1,4 @@
 import { RpcClientSimulator } from './rpc-client-simulator';
 import { RpcClientRealDevice } from './rpc-client-real-device';
-import * as rpcConstants from './constants';
 
-
-export { RpcClientSimulator, RpcClientRealDevice, rpcConstants };
+export { RpcClientSimulator, RpcClientRealDevice };

package/lib/rpc/remote-messages.js

@@ -19,6 +19,8 @@ const COMMANDS = /** @type {const} */ ({
   'Runtime.evaluate': FULL_COMMAND,
 
   'Target.exists': DIRECT_COMMAND,
+  'Target.setPauseOnStart': DIRECT_COMMAND,
+  'Target.resume': DIRECT_COMMAND,
 
   'Timeline.start': FULL_COMMAND,
   'Timeline.stop': FULL_COMMAND,
@@ -49,7 +51,7 @@ export class RemoteMessages {
   /**
    *
    * @param {string} connId
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   setConnectionKey (connId) {
     return {
@@ -64,7 +66,7 @@ export class RemoteMessages {
    *
    * @param {string} connId
    * @param {import('../types').AppIdKey} appIdKey
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   connectToApp (connId, appIdKey) {
     return {
@@ -82,7 +84,7 @@ export class RemoteMessages {
    * @param {string} senderId
    * @param {import('../types').AppIdKey} appIdKey
    * @param {import('../types').PageIdKey} [pageIdKey]
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   setSenderKey (connId, senderId, appIdKey, pageIdKey) {
     return {
@@ -91,7 +93,7 @@ export class RemoteMessages {
         WIRConnectionIdentifierKey: connId,
         WIRSenderKey: senderId,
         WIRPageIdentifierKey: pageIdKey,
-        WIRAutomaticallyPause: false
+        WIRAutomaticallyPause: false,
       },
       __selector: '_rpc_forwardSocketSetup:'
     };
@@ -103,7 +105,7 @@ export class RemoteMessages {
    * @param {import('../types').AppIdKey} appIdKey
    * @param {import('../types').PageIdKey} [pageIdKey]
    * @param {boolean} [enabled]
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   indicateWebView (connId, appIdKey, pageIdKey, enabled) {
     return {
@@ -120,7 +122,7 @@ export class RemoteMessages {
   /**
    *
    * @param {string} bundleId
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   launchApplication (bundleId) {
     return {
@@ -134,7 +136,7 @@ export class RemoteMessages {
   /**
    *
    * @param {import('../types').RemoteCommandOpts & import('../types').ProtocolCommandOpts} opts
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   getFullCommand (opts) {
     const {
@@ -205,7 +207,7 @@ export class RemoteMessages {
   /**
    *
    * @param {import('../types').RemoteCommandOpts & import('../types').ProtocolCommandOpts} opts
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   getMinimalCommand (opts) {
     const {method, params, connId, senderId, appIdKey, pageIdKey, targetId, id} = opts;
@@ -244,7 +246,7 @@ export class RemoteMessages {
   /**
    *
    * @param {import('../types').RemoteCommandOpts & import('../types').ProtocolCommandOpts} opts
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   getDirectCommand (opts) {
     const {method, params, connId, senderId, appIdKey, pageIdKey, id} = opts;
@@ -271,7 +273,7 @@ export class RemoteMessages {
    *
    * @param {string} command
    * @param {import('../types').RemoteCommandOpts} opts
-   * @returns {import('../types').RemoteCommand}
+   * @returns {import('../types').RawRemoteCommand}
    */
   getRemoteCommand (command, opts) {
     const {
@@ -314,8 +316,14 @@ export class RemoteMessages {
 
     // deal with WebKit commands
     const builderFunction = COMMANDS[command] || MINIMAL_COMMAND;
+    const commonOpts = getProtocolCommand(
+      /** @type {string} */ (id),
+      command,
+      opts,
+      isDirectCommand(command),
+    );
     return this[builderFunction]({
-      ...getProtocolCommand(/** @type {string} */ (id), command, opts),
+      ...commonOpts,
       connId,
       appIdKey,
       senderId,
@@ -327,4 +335,13 @@ export class RemoteMessages {
   // #endregion
 }
 
+/**
+ *
+ * @param {string} command
+ * @returns {boolean}
+ */
+export function isDirectCommand (command) {
+  return COMMANDS[command] === DIRECT_COMMAND;
+}
+
 export default RemoteMessages;

package/lib/rpc/rpc-client-real-device.js

@@ -8,9 +8,7 @@ export class RpcClientRealDevice extends RpcClient {
    * @param {import('./rpc-client').RpcClientOptions} [opts={}]
    */
   constructor (opts = {}) {
-    super(Object.assign({
-      shouldCheckForTarget: false,
-    }, opts));
+    super(opts);
   }
 
   /**

package/lib/rpc/rpc-client-simulator.js

@@ -25,9 +25,7 @@ export class RpcClientSimulator extends RpcClient {
    * @param {import('./rpc-client').RpcClientOptions & RpcClientSimulatorOptions} [opts={}]
    */
   constructor (opts = {}) {
-    super(Object.assign({
-      shouldCheckForTarget: false,
-    }, opts));
+    super(opts);
 
     const {
       socketPath,