appium-remote-debugger 15.0.1 → 15.0.2

package/lib/mixins/execute.js

@@ -144,7 +144,7 @@ export async function execute (command, override) {
   }
 
   const rpcClient = this.requireRpcClient(true);
-  await rpcClient.waitForPageInitialization(
+  await rpcClient.waitForPage(
     /** @type {import('../types').AppIdKey} */ (appIdKey),
     /** @type {import('../types').PageIdKey} */ (pageIdKey)
   );

package/lib/mixins/navigate.js

@@ -182,7 +182,7 @@ export async function navToUrl (url) {
 
   this.log.debug(`Navigating to new URL: '${url}'`);
   setNavigatingToPage(this, true);
-  await rpcClient.waitForPageInitialization(
+  await rpcClient.waitForPage(
     /** @type {import('../types').AppIdKey} */ (appIdKey),
     /** @type {import('../types').PageIdKey} */ (pageIdKey)
   );

package/lib/remote-debugger.ts

@@ -49,7 +49,6 @@ export class RemoteDebugger extends EventEmitter {
   protected readonly _platformVersion?: string;
   protected readonly _isSafari: boolean;
   protected readonly _includeSafari: boolean;
-  protected readonly _useNewSafari: boolean;
   protected readonly _garbageCollectOnExecute: boolean;
   protected readonly _host?: string;
   protected readonly _port?: number;
@@ -120,7 +119,6 @@ export class RemoteDebugger extends EventEmitter {
       platformVersion,
       isSafari = true,
       includeSafari = false,
-      useNewSafari = false,
       pageLoadMs,
       host,
       port = REMOTE_DEBUGGER_PORT,
@@ -142,10 +140,8 @@ export class RemoteDebugger extends EventEmitter {
     this._platformVersion = platformVersion;
     this._isSafari = isSafari;
     this._includeSafari = includeSafari;
-    this._useNewSafari = useNewSafari;
     this._pageLoadMs = pageLoadMs;
     this._allowNavigationWithoutReload = false;
-    this.log.debug(`useNewSafari --> ${this._useNewSafari}`);
 
     this._garbageCollectOnExecute = garbageCollectOnExecute;
 

package/lib/rpc/rpc-client.js

@@ -24,6 +24,7 @@ const NO_TARGET_PRESENT_YET_ERRORS = [
 ];
 export const NEW_APP_CONNECTED_ERROR = 'New application has connected';
 export const EMPTY_PAGE_DICTIONARY_ERROR = 'Empty page dictionary received';
+const ON_PAGE_INITIALIZED_EVENT = 'onPageInitialized';
 
 
 export class RpcClient {
@@ -129,6 +130,8 @@ export class RpcClient {
     this._targets = {};
     this._targetSubscriptions = new EventEmitter();
     this._provisionedPages = new Set();
+    this._pageSelectionLock = new AsyncLock();
+    this._pageSelectionMonitor = new EventEmitter();
 
     this.remoteMessages = new RemoteMessages();
 
@@ -568,6 +571,11 @@ export class RpcClient {
       });
     } catch (e) {
       log.warn(e.message);
+    } finally {
+      // Target creation is happening after provisioning,
+      // which means the above lock would be already released
+      // after provisioning is completed.
+      this._pageSelectionMonitor.emit(ON_PAGE_INITIALIZED_EVENT, appIdKey, pageIdKey);
     }
   }
 
@@ -668,29 +676,69 @@ export class RpcClient {
    * @returns {Promise<void>}
    */
   async selectPage (appIdKey, pageIdKey, pageReadinessDetector) {
-    this._pendingTargetNotification = [appIdKey, pageIdKey, pageReadinessDetector];
-    this._provisionedPages.clear();
+    await this._pageSelectionLock.acquire(toPageSelectionKey(appIdKey, pageIdKey), async () => {
+      this._pendingTargetNotification = [appIdKey, pageIdKey, pageReadinessDetector];
+      this._provisionedPages.clear();
 
-    // go through the steps that the Desktop Safari system
-    // goes through to initialize the Web Inspector session
+      // go through the steps that the Desktop Safari system
+      // goes through to initialize the Web Inspector session
 
-    const sendOpts = {
-      appIdKey,
-      pageIdKey,
-    };
+      const sendOpts = {
+        appIdKey,
+        pageIdKey,
+      };
 
-    // highlight and then un-highlight the webview
-    for (const enabled of [true, false]) {
-      await this.send('indicateWebView', Object.assign({
-        enabled,
-      }, sendOpts), false);
-    }
+      const timeoutMs = Math.trunc(Math.max(this.pageLoadTimeoutMs ?? 0, PAGE_INIT_TIMEOUT_MS) * 1.2);
+      const timer = new timing.Timer().start();
+
+      const setupWebview = async () => {
+        // highlight and then un-highlight the webview
+        for (const enabled of [true, false]) {
+          await this.send('indicateWebView', Object.assign({
+            enabled,
+          }, sendOpts), false);
+        }
+        await this.send('setSenderKey', sendOpts);
+      };
+      await B.resolve(setupWebview())
+        .timeout(timeoutMs, `Cannot set up page '${pageIdKey}' for app '${appIdKey}' within ${timeoutMs}ms`);
 
-    await this.send('setSenderKey', sendOpts);
-    log.debug('Sender key set');
+      const msLeft = Math.max(timeoutMs - Math.trunc(timer.getDuration().asMilliSeconds), 1000);
+      log.debug(
+        `Waiting up to ${msLeft}ms for page '${pageIdKey}' of app '${appIdKey}' to be selected`
+      );
+      await new Promise((resolve) => {
+        const onPageInitialized = (
+          /** @type {import("../types").AppIdKey} */ notifiedAppIdKey,
+          /** @type {import("../types").PageIdKey} */ notifiedPageIdKey
+        ) => {
+          const timeoutHandler = setTimeout(() => {
+            this._pageSelectionMonitor.off(ON_PAGE_INITIALIZED_EVENT, onPageInitialized);
+            log.warn(
+              `Page '${pageIdKey}' for app '${appIdKey}' has not been selected ` +
+              `within ${timer.getDuration().asMilliSeconds}ms. Continuing anyway`
+            );
+            resolve(false);
+          }, msLeft);
+
+          if (notifiedAppIdKey === appIdKey && notifiedPageIdKey === pageIdKey) {
+            clearTimeout(timeoutHandler);
+            this._pageSelectionMonitor.off(ON_PAGE_INITIALIZED_EVENT, onPageInitialized);
+            log.debug(
+              `Selected the page ${pageIdKey}@${appIdKey} after ${timer.getDuration().asMilliSeconds}ms`
+            );
+            resolve(true);
+          } else {
+            log.debug(
+              `Got notified that page ${notifiedPageIdKey}@${notifiedAppIdKey} is initialized, ` +
+              `but we are waiting for ${pageIdKey}@${appIdKey}. Continuing to wait`
+            );
+          }
+        };
 
-    await this.waitForTarget(appIdKey, pageIdKey);
-    await this.waitForPageInitialization(appIdKey, pageIdKey);
+        this._pageSelectionMonitor.on(ON_PAGE_INITIALIZED_EVENT, onPageInitialized);
+      });
+    });
   }
 
   /**
@@ -986,15 +1034,19 @@ export class RpcClient {
    *
    * @param {import('../types').AppIdKey} appIdKey
    * @param {import('../types').PageIdKey} pageIdKey
+   * @returns {Promise<void>}
    */
-  async waitForPageInitialization (appIdKey, pageIdKey) {
+  async waitForPage (appIdKey, pageIdKey) {
     const appTargetsMap = this.targets[appIdKey];
     if (!appTargetsMap) {
       throw new Error(`No targets found for app '${appIdKey}'`);
     }
     const lock = appTargetsMap.lock;
     const timer = new timing.Timer().start();
-    await lock.acquire(pageIdKey, async () => await B.delay(0));
+    await Promise.all([
+      lock.acquire(pageIdKey, async () => await B.delay(0)),
+      this._pageSelectionLock.acquire(toPageSelectionKey(appIdKey, pageIdKey), async () => await B.delay(0))
+    ]);
     const durationMs = timer.getDuration().asMilliSeconds;
     if (durationMs > 10) {
       log.debug(`Waited ${durationMs}ms until the page ${pageIdKey}@${appIdKey} is initialized`);
@@ -1002,6 +1054,16 @@ export class RpcClient {
   }
 }
 
+/**
+ *
+ * @param {import('../types').AppIdKey} appIdKey
+ * @param {import('../types').PageIdKey} pageIdKey
+ * @returns {string}
+ */
+function toPageSelectionKey(appIdKey, pageIdKey) {
+  return `${appIdKey}:${pageIdKey}`;
+}
+
 export default RpcClient;
 
 /**

package/lib/types.ts

@@ -49,7 +49,7 @@ export interface RemoteDebuggerOptions {
   platformVersion?: string;
   isSafari?: boolean;
   includeSafari?: boolean;
-  /** for web inspector, whether this is a new Safari instance */
+  /** @deprecated - deprecated for removal, not used anywhere */
   useNewSafari?: boolean;
   /** the time, in ms, that should be waited for page loading */
   pageLoadMs?: number;

package/package.json

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