Node.js wrapper around Chromedriver

Issues for this repo are disabled. Log any issues at the main Appium repo's issue tracker.

Because of the oddities of npm's lifecycle hooks, installing locally the first time will fail, saying Project does not appear to built yet. Please run gulp transpile first.. This is because we transpile in the prepublish phase, but run the install script in the install phase. Any other way would make development dependencies necessary on user's machines, or make the binary not install, unfortunately.

The solution, however, is simple. Simple run gulp transpile and then npm install. The former will build the project and the latter will simply install the binary.

If, for some reason, you want to install without installing the Chromedriver binary, either set the APPIUM_SKIP_CHROMEDRIVER_INSTALL environment variable, or pass the --chromedriver-skip-install flag while running npm install.

import Chromedriver from 'appium-chromedriver';

// 'sync'-like await/Promise usage
async function runSession() {
    let driver = new Chromedriver();
    const desiredCaps = {browserName: 'chrome'};
    await driver.start(desiredCaps);
    let status = await driver.sendCommand('/status', 'GET');
    await driver.stop();
}

// EventEmitter usage
function runSession2() {
    let driver = new Chromedriver();
    const desiredCaps = {browserName: 'chrome'};
    driver.start(desiredCaps);
    driver.on(Chromedriver.EVENT_CHANGED, function (msg) {
        if (msg.state === Chromedriver.STATE_ONLINE) {
            driver.sendCommand('/status', 'GET').then(function (status) {
                driver.stop();
            });
        }
    });
    driver.on(Chromedriver.EVENT_ERROR, function (err) {
        // :-(
    });
}

Here's what the Chromedriver state machine looks like:

Here are the events you can listen for:

• Chromedriver.EVENT_ERROR: gives you an error object
• Chromedriver.EVENT_CHANGED: gives you a state change object, with a state property that can be one of:
  • Chromedriver.STATE_STOPPED
  • Chromedriver.STATE_STARTING
  • Chromedriver.STATE_ONLINE
  • Chromedriver.STATE_STOPPING
  • Chromedriver.STATE_RESTARTING

To use a version of Chromedriver not set in the code, use npm config property chromedriver_version.

npm install appium-chromedriver --chromedriver_version="2.16"

Or add the property into your .npmrc file.

chromedriver_version=2.16

To use a mirror of the ChromeDriver binaries use npm config property chromedriver_cdnurl. Default is http://chromedriver.storage.googleapis.com.

npm install appium-chromedriver --chromedriver_cdnurl=http://npm.taobao.org/mirrors/chromedriver

Or add the property into your .npmrc file.

chromedriver_cdnurl=http://npm.taobao.org/mirrors/chromedriver

Another option is to use PATH variable CHROMEDRIVER_CDNURL.

CHROMEDRIVER_CDNURL=http://npm.taobao.org/mirrors/chromedriver npm install appium-chromedriver

We use Gulp for building/transpiling.

npm run watch

npm test

When a new Chromedriver version is released, the details will be here. Which Chromedriver this package selects is based on the CHROMEDRIVER_CHROME_MAPPING in lib/chromedriver.

To add a new entry, you must know the Chromedriver version and the minimum version of Chrome which it is capable of automating. Starting with Chromedriver 2.46 the executable has a command line flag --minimum-chrome-version to get the latter. So, you just need to download the Chromedriver version, and then run it

path/to/chromedriver[.exe] --minimum-chrome-version

The output will be something like minimum supported Chrome version: 71.0.3578.0.

Add a new entry to the top of CHROMEDRIVER_CHROME_MAPPING in lib/chromedriver, consisting of the version of Chromedriver and the first three parts of the minimum Chrome version.

If the command line flag is not available, the minimum Chrome version can be obtained by attempting to run a session against a low version of Chrome. In one shell run Chromedriver

path/to/chromedriver[.exe] --verbose

And in another shell, create a session by running the curl command

curl \
  -d '{"desiredCapabilities":{"chromeOptions":{"androidPackage":"com.android.chrome","androidDeviceSerial":"emulator-5554"}}}' \
  -H "Content-Type: application/json" \
  -XPOST http://localhost:9515/session

This will fail, but in the error message will be the actual minimum Chrome version for this version of Chromedriver:

{
  "sessionId": "55dcde971731f3d1ce04b54d7664069c",
  "status": 33,
  "value": {
    "message": "session not created: Chrome version must be >= 68.0.3440.0\n  (Driver info: chromedriver=2.42.591059 (a3d9684d10d61aa0c45f6723b327283be1ebaad8),platform=Mac OS X 10.13.6 x86_64)"
  }
}

Take the number (e.g., here, 68.0.3440.0) and put the first three parts (68.0.3440) into the CHROMEDRIVER_CHROME_MAPPING along with the version of Chromedriver being added.

Commit, push, and pull request!