WebDriver
=========

> A lightweight, non-opinionated implementation of the WebDriver and WebDriver BiDi specification including mobile commands supported by Appium

There are tons of Selenium and WebDriver binding implementations in the Node.js world. Every one of them has an opinionated API and recommended way to use it. This binding is the most non-opinionated you will find as it just represents the WebDriver specification and doesn't come with any extra or higher-level abstraction. It is lightweight and comes with support for the WebDriver specification and Appium's Mobile JSONWire Protocol.

The package supports the following protocols:

- WebDriver
- WebDriver Bidi
- Appium
- Chromium (additional Chromedriver specific commands)
- Selenium (additional Selenium WebDriver specific commands)
- Sauce Labs (Sauce Labs specific WebDriver extensions)
- JSONWireProtocol (deprecated)
- Mobile JSONWireProtocol (deprecated)

Commands are added to the client's protocol based on assumptions of provided capabilities. You can find more details about the commands by checking out the @testplane/wdio-protocols package. All commands come with TypeScript support.

Install

To install this package from NPM run:

``sh
npm i webdriver
`

WebDriver Example

The following example demonstrates a simple Google Search scenario:

`js
import WebDriver from '@testplane/webdriver';

const client = await WebDriver.newSession({
path: '/',
capabilities: { browserName: 'firefox' }
})

await client.navigateTo('https://www.google.com/ncr')

const searchInput = await client.findElement('css selector', '#lst-ib')
await client.elementSendKeys(searchInput['element-6066-11e4-a52e-4f735466cecf'], 'WebDriver')

const searchBtn = await client.findElement('css selector', 'input[value="Google Search"]')
await client.elementClick(searchBtn['element-6066-11e4-a52e-4f735466cecf'])

console.log(await client.getTitle()) // outputs "WebDriver - Google Search"

await client.deleteSession()
`

WebDriver Bidi Example

To connect to the WebDriver Bidi protocol you have to send along a webSocketUrl flag to tell the browser driver to opt-in to the protocol:

`js
import WebDriver from '@testplane/webdriver'

const browser = await WebDriver.newSession({
capabilities: {
webSocketUrl: true,
browserName: 'firefox'
}
})

await browser.sessionSubscribe({ events: ['log.entryAdded'] })

/**
* returns: {"type":"console","method":"log","realm":null,"args":[{"type":"string","value":"Hello Bidi"}],"level":"info","text":"Hello Bidi","timestamp":1657282076037}
*/
browser.on('log.entryAdded', (entryAdded) => console.log('received %s', entryAdded))

await browser.executeScript('console.log("Hello Bidi")', [])
await browser.deleteSession()
`

Configuration

To create a WebDriver session call the newSession method on the WebDriver class and pass in your configurations:

`js
import WebDriver from '@testplane/webdriver'
const client = await WebDriver.newSession(options)
`

The following options are available:

$3


Defines the capabilities you want to run in your WebDriver session. Note: by default, it will automatically set the webSocketUrl to establish a WebDriver Bidi session, if you don't want this, make sure to set 'wdio:enforceWebDriverClassic': true in your capabilities.

Type: Object

Required: true

$3

Level of logging verbosity.

Type: String

Default: info

Options: trace | debug | info | warn | error | silent

$3

Protocol to use when communicating with the Selenium standalone server (or driver).

Type: String

Default: http
Options: http | https

$3

Host of your WebDriver server.

Type: String

Default: localhost

$3

Port your WebDriver server is on.

Type: Number

Default: undefined

$3

Path to WebDriver endpoint or grid server.

Type: String

Default: /

$3

Query parameters that are propagated to the driver server.

Type: Object
Default: undefined

$3

Timeout for any WebDriver request to a driver or grid.

Type: Number

Default: 120000

$3

Count of request retries to the Selenium server.

Type: Number

Default: 3

$3

Allows you to use a custom http/https/http2 agent to make requests.

Type: Object

Default:

`js
{
http: new http.Agent({ keepAlive: true }),
https: new https.Agent({ keepAlive: true })
}
`

$3

Function intercepting HTTP request options before a WebDriver request is made to a driver.

Type: (RequestOptions) => RequestOptions

Default: none

$3

Function intercepting HTTP response objects after a WebDriver response has arrived.

Type: (Response, RequestOptions) => Response`

Default: none