appium-cdp-driver 1.0.6 → 1.0.8

package/src/adb.js

@@ -1,4 +1,4 @@
-import { ADB, getSdkRootFromEnv } from 'appium-adb';
+import { ADB, DEFAULT_ADB_PORT, getSdkRootFromEnv } from 'appium-adb';
 import { fs } from '@appium/support';
 import getPort from 'get-port';
 import log from './logger';
@@ -16,14 +16,28 @@ const DEVTOOLS_SOCKET_MAP = {
   terrance: 'com.sec.android.app.sbrowser_devtools_remote',
 };
 
-export async function getAdb() {
+/**
+ * Resolve the adb server port: explicit value wins, then CDP_ADB_PORT (used by
+ * the skip-welcome scripts, which run as separate processes and receive no
+ * capabilities), then adb's default.
+ */
+export function resolveAdbPort(adbPort) {
+  const candidate = adbPort ?? process.env.CDP_ADB_PORT;
+  const port = parseInt(candidate, 10);
+  return Number.isInteger(port) && port > 0 ? port : DEFAULT_ADB_PORT;
+}
+
+export async function getAdb(adbPort) {
   try {
     if (!adb) {
-      adb = await ADB.createADB();
+      const port = resolveAdbPort(adbPort);
+      log.info(`Using adb server port ${port}`);
+      adb = await ADB.createADB({ adbPort: port });
     }
   } catch (e) {
     console.log(e);
   }
+  return adb;
 }
 
 export async function requireSdkRoot() {
@@ -76,7 +90,10 @@ async function getDuckDuckGoPid(browser = 'duckduckgo') {
   const packageName = 'com.duckduckgo.mobile.android';
   try {
     const output = await adb.adbExec(['shell', 'pidof', packageName]);
-    const pid = output.trim();
+    // pidof lists every process of the package; the socket belongs to the first
+    // (browser) process, and passing the whole list builds an unusable socket
+    // name like webview_devtools_remote_1234 5678
+    const pid = String(output).trim().split(/\s+/)[0];
     return pid || null;
   } catch (err) {
     console.error(`Unable to get PID for ${browser}:`, err.message);
@@ -84,66 +101,47 @@ async function getDuckDuckGoPid(browser = 'duckduckgo') {
   }
 }
 
-export async function startApplication(browser = 'chrome') {
-  const common = {
-    waitDuration: START_APP_WAIT_DURATION,
-    optionalIntentArguments: '-d www.appium.io',
-  };
-  const chrome = {
-    pkg: 'com.android.chrome',
-    activity: 'com.google.android.apps.chrome.Main',
-  };
-
-  const terrance = {
-    pkg: 'com.sec.android.app.sbrowser',
-    activity: 'com.sec.android.app.sbrowser.SBrowserMainActivity',
-  };
-
-  const brave = {
-    pkg: 'com.brave.browser',
-    activity: 'com.google.android.apps.chrome.Main',
-  };
-
-  const opera = {
-    pkg: 'com.opera.browser',
-    activity: 'com.opera.android.BrowserActivity',
-  };
-
-  const duckduckgo = {
-    pkg: 'com.duckduckgo.mobile.android',
-    activity: 'com.duckduckgo.app.browser.BrowserActivity',
-  };
+const BROWSERS = {
+  chrome: { pkg: 'com.android.chrome', activity: 'com.google.android.apps.chrome.Main' },
+  brave: { pkg: 'com.brave.browser', activity: 'com.google.android.apps.chrome.Main' },
+  opera: { pkg: 'com.opera.browser', activity: 'com.opera.android.BrowserActivity' },
+  duckduckgo: { pkg: 'com.duckduckgo.mobile.android', activity: 'com.duckduckgo.app.browser.BrowserActivity' },
+  samsung: { pkg: 'com.sec.android.app.sbrowser', activity: 'com.sec.android.app.sbrowser.SBrowserMainActivity' },
+  terrance: { pkg: 'com.sec.android.app.sbrowser', activity: 'com.sec.android.app.sbrowser.SBrowserMainActivity' },
+  edge: { pkg: 'com.microsoft.emmx', activity: 'com.microsoft.ruby.Main' },
+};
 
-  const samsung = {
-    pkg: 'com.sec.android.app.sbrowser',
-    activity: 'com.sec.android.app.sbrowser.SBrowserMainActivity',
-  };
-  
-  const edge = {
-    pkg: 'com.microsoft.emmx',
-    activity: 'com.microsoft.ruby.Main',
-  };
+/**
+ * Open the start URL in an already-running browser.
+ *
+ * Deliberately a plain VIEW intent rather than startApplication: the latter
+ * passes -S, which force-stops the process. That changes the pid, and for
+ * WebView-based browsers the devtools socket name carries the pid, so an
+ * existing port forward is left pointing at a socket that no longer exists.
+ */
+export async function openStartUrl(browser, url = 'https://www.appium.io') {
+  const pkg = BROWSERS[browser]?.pkg;
+  if (!pkg) {
+    return;
+  }
+  // -n <component>: a bare trailing package is not honoured by am, so the intent
+  // would go to whichever browser handles VIEW by default rather than this one
+  await adb.adbExec([
+    'shell', 'am', 'start', '-a', 'android.intent.action.VIEW', '-d', url,
+    '-n', `${pkg}/${BROWSERS[browser].activity}`,
+  ]);
+}
 
-  if (browser === 'chrome') {
-    log.info(`Starting Chrome`);
-    await adb.startApp(Object.assign({}, chrome, common));
-  } else if (browser === 'terrance') {
-    log.info(`Starting Terrance`);
-    await adb.startApp(Object.assign({}, terrance, common));
-  } else if (browser === 'brave') {
-    log.info(`Starting Brave`);
-    await adb.startApp(Object.assign({}, brave, common));
-  } else if (browser === 'opera') {
-    log.info(`Starting Opera`);
-    await adb.startApp(Object.assign({}, opera, common));
-  } else if (browser === 'duckduckgo') {
-    log.info(`Starting DuckDuckGo`);
-    await adb.startApp(Object.assign({}, duckduckgo, common));
-  } else if (browser === 'samsung') {
-    log.info(`Starting Samsung Browser`);
-    await adb.startApp(Object.assign({}, samsung, common));
-  } else if (browser === 'edge') {
-    log.info(`Starting MS Edge`);
-    await adb.startApp(Object.assign({}, edge, common));
+export async function startApplication(browser = 'chrome') {
+  const target = BROWSERS[browser];
+  if (!target) {
+    return;
   }
-}
+  log.info(`Starting ${browser}`);
+  await adb.startApp({
+    pkg: target.pkg,
+    activity: target.activity,
+    waitDuration: START_APP_WAIT_DURATION,
+    optionalIntentArguments: '-d www.appium.io',
+  });
+}

package/src/driver.js

@@ -1,5 +1,5 @@
 import { BaseDriver, errors } from '@appium/base-driver';
-import { getAdb, adbExec, startApplication } from './adb';
+import { getAdb, adbExec, startApplication, openStartUrl } from './adb';
 import { openBrowser, getConfig, goto } from 'taiko';
 import commands from './commands';
 import log from './logger';
@@ -19,6 +19,10 @@ class AppiumCDPDriver extends BaseDriver {
         presence: true,
         isString: true,
       },
+      adbPort: {
+        isNumber: false,
+        presence: false,
+      },
     };
   }
 
@@ -26,7 +30,7 @@ class AppiumCDPDriver extends BaseDriver {
     console.log(await getConfig('local'));
     const res = await super.createSession(w3cCaps);
     const browser = w3cCaps.alwaysMatch['browserName'];
-    await getAdb();
+    await getAdb(w3cCaps.alwaysMatch['appium:adbPort']);
     let port;
     if (browser === 'duckduckgo') {
       await startApplication(browser);
@@ -55,6 +59,15 @@ class AppiumCDPDriver extends BaseDriver {
           log.info(`CDP response: ${JSON.stringify(data)}`);
 
           if (!Array.isArray(data) || data.length === 0) {
+            // The socket is up but the browser holds no debuggable page — common
+            // for WebView-based browsers just after launch. Retrying the fetch
+            // alone changes nothing, so nudge the browser into opening one.
+            log.info('Debug list is empty, opening the start URL to create a page');
+            try {
+              await openStartUrl(browser);
+            } catch (launchError) {
+              log.info(`Could not open the start URL: ${launchError.message}`);
+            }
             throw new Error('Debug list is empty or invalid');
           }
 
@@ -71,9 +84,21 @@ class AppiumCDPDriver extends BaseDriver {
         maxTimeout: 10000,
       }
     );
-    const target = data.find((target) => {
-      return target.url.includes('appium.io');
-    });
+    // Prefer the page we launched, but do not require it: after a redirect, a
+    // new tab, or an onboarding page the list holds other targets, and reading
+    // webSocketDebuggerUrl off undefined fails the session with an opaque error.
+    let target = data.find((t) => t.url && t.url.includes('appium.io'));
+    if (!target) {
+      target =
+        data.find((t) => t.type === 'page' && t.webSocketDebuggerUrl) ||
+        data.find((t) => t.webSocketDebuggerUrl);
+      log.info(`No appium.io target; falling back to ${target ? target.url || target.type : 'none'}`);
+    }
+    if (!target) {
+      throw new Error(
+        `No CDP target with a webSocketDebuggerUrl in ${JSON.stringify(data)}`
+      );
+    }
     log.info(`Target found: ${target.webSocketDebuggerUrl}`);
     await openBrowser({
       port: port,