Skip to main content

class: Android

Added in: v1.9

Languages: JavaScript

copilotbrowser has experimental support for Android automation. This includes Chrome for Android and Android WebView.

Requirements

  • Android device or AVD Emulator.
  • ADB daemon running and authenticated with your device. Typically running adb devices is all you need to do.
  • Chrome 87 or newer installed on the device
  • "Enable command line on non-rooted devices" enabled in chrome://flags.

Known limitations

  • Raw USB operation is not yet supported, so you need ADB.
  • Device needs to be awake to produce screenshots. Enabling "Stay awake" developer mode will help.
  • We didn't run all the tests against the device, so not everything works.

How to run

An example of the Android automation script would be:

const { _android: android } = require('copilotbrowser');

(async () => {
  // Connect to the device.
  const [device] = await android.devices();
  console.log(`Model: ${device.model()}`);
  console.log(`Serial: ${device.serial()}`);
  // Take screenshot of the whole device.
  await device.screenshot({ path: 'device.png' });

  {
    // --------------------- WebView -----------------------

    // Launch an application with WebView.
    await device.shell('am force-stop org.chromium.webview_shell');
    await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');
    // Get the WebView.
    const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });

    // Fill the input box.
    await device.fill({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'github.com/dayour/copilotbrowser');
    await device.press({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'Enter');

    // Work with WebView's page as usual.
    const page = await webview.page();
    await page.waitForNavigation({ url: /.*microsoft\/copilotbrowser.*/ });
    console.log(await page.title());
  }

  {
    // --------------------- Browser -----------------------

    // Launch Chrome browser.
    await device.shell('am force-stop com.android.chrome');
    const context = await device.launchBrowser();

    // Use BrowserContext as usual.
    const page = await context.newPage();
    await page.goto('https://webkit.org/');
    console.log(await page.evaluate(() => window.location.href));
    await page.screenshot({ path: 'page.png' });

    await context.close();
  }

  // Close the device.
  await device.close();
})();

async method: Android.connect​

Added in: v1.28 Returns: AndroidDevice

This methods attaches copilotbrowser to an existing Android device. Use Android.launchServer() to launch a new Android server instance.

param: Android.connect.wsEndpoint​

Added in: v1.28

  • wsEndpoint <string>

A browser websocket endpoint to connect to.

option: Android.connect.headers​

Added in: v1.28

  • headers <Object<string, string>>

Additional HTTP headers to be sent with web socket connect request. Optional.

option: Android.connect.slowMo​

Added in: v1.28

  • slowMo <float>

Slows down copilotbrowser operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

option: Android.connect.timeout​

Added in: v1.28

  • timeout <float>

Maximum time in milliseconds to wait for the connection to be established. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

async method: Android.devices​

Added in: v1.9 Returns: Array<AndroidDevice>

Returns the list of detected Android devices.

option: Android.devices.host​

Added in: v1.22

  • host <string>

Optional host to establish ADB server connection. Default to 127.0.0.1.

option: Android.devices.port​

Added in: v1.20

  • port <int>

Optional port to establish ADB server connection. Default to 5037.

option: Android.devices.omitDriverInstall​

Added in: v1.21

  • omitDriverInstall <boolean>

Prevents automatic copilotbrowser driver installation on attach. Assumes that the drivers have been installed already.

async method: Android.launchServer​

Added in: v1.28

Languages: JavaScript Returns: BrowserServer

Launches copilotbrowser Android server that clients can connect to. See the following example:

Usage

Server Side:

const { _android } = require('copilotbrowser');

(async () => {
  const browserServer = await _android.launchServer({
    // If you have multiple devices connected and want to use a specific one.
    // deviceSerialNumber: '<deviceSerialNumber>',
  });
  const wsEndpoint = browserServer.wsEndpoint();
  console.log(wsEndpoint);
})();

Client Side:

const { _android } = require('copilotbrowser');

(async () => {
  const device = await _android.connect('<wsEndpoint>');

  console.log(device.model());
  console.log(device.serial());
  await device.shell('am force-stop com.android.chrome');
  const context = await device.launchBrowser();

  const page = await context.newPage();
  await page.goto('https://webkit.org/');
  console.log(await page.evaluate(() => window.location.href));
  await page.screenshot({ path: 'page-chrome-1.png' });

  await context.close();
})();

option: Android.launchServer.adbHost​

Added in: v1.28

  • adbHost <string>

Optional host to establish ADB server connection. Default to 127.0.0.1.

option: Android.launchServer.adbPort​

Added in: v1.28

  • adbPort <int>

Optional port to establish ADB server connection. Default to 5037.

option: Android.launchServer.omitDriverInstall​

Added in: v1.28

  • omitDriverInstall <boolean>

Prevents automatic copilotbrowser driver installation on attach. Assumes that the drivers have been installed already.

option: Android.launchServer.deviceSerialNumber​

Added in: v1.28

  • deviceSerialNumber <string>

Optional device serial number to launch the browser on. If not specified, it will throw if multiple devices are connected.

option: Android.launchServer.host​

Added in: v1.45

  • host <string>

Host to use for the web socket. It is optional and if it is omitted, the server will accept connections on the unspecified IPv6 address (::) when IPv6 is available, or the unspecified IPv4 address (0.0.0.0) otherwise. Consider hardening it with picking a specific interface.

option: Android.launchServer.port​

Added in: v1.28

  • port <int>

Port to use for the web socket. Defaults to 0 that picks any available port.

option: Android.launchServer.wsPath​

Added in: v1.28

  • wsPath <string>

Path at which to serve the Android Server. For security, this defaults to an unguessable string.

warning

Any process or web page (including those running in copilotbrowser) with knowledge of the wsPath can take control of the OS user. For this reason, you should use an unguessable token when using this option.

method: Android.setDefaultTimeout​

Added in: v1.9

This setting will change the default maximum time for all the methods accepting timeout option.

param: Android.setDefaultTimeout.timeout​

Added in: v1.9

  • timeout <float>

Maximum time in milliseconds