Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/webdriverio-community/node-edgedriver

Microsofts' EdgeDriver for Node.js
https://github.com/webdriverio-community/node-edgedriver

edge microsoft-edge webdriver webdriverio

Last synced: 5 days ago
JSON representation

Microsofts' EdgeDriver for Node.js

Host: GitHub
URL: https://github.com/webdriverio-community/node-edgedriver
Owner: webdriverio-community
License: mit
Created: 2016-03-17T17:22:29.000Z (almost 9 years ago)
Default Branch: main
Last Pushed: 2024-12-16T19:32:03.000Z (7 days ago)
Last Synced: 2024-12-16T20:34:08.525Z (7 days ago)
Topics: edge, microsoft-edge, webdriver, webdriverio
Language: TypeScript
Homepage: https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/
Size: 1.26 MB
Stars: 5
Watchers: 10
Forks: 9
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        EdgeDriver [![CI](https://github.com/webdriverio-community/node-edgedriver/actions/workflows/ci.yml/badge.svg)](https://github.com/webdriverio-community/node-edgedriver/actions/workflows/ci.yml) [![Audit](https://github.com/webdriverio-community/node-edgedriver/actions/workflows/audit.yml/badge.svg)](https://github.com/webdriverio-community/node-edgedriver/actions/workflows/audit.yml)

==========

An NPM wrapper for Microsofts' [EdgeDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/). It manages to download various (or the latest) Edgedriver versions and provides a programmatic interface to start and stop it within Node.js. __Note:__ this is a wrapper module. If you discover any bugs with EdgeDriver, please report them in the [official repository](https://github.com/MicrosoftEdge/EdgeWebDriver).

# Installing

You can install this package via:

```sh

npm install edgedriver

```

Once installed you can start Edgedriver via:

```sh

npx edgedriver --port=4444

```

By default, this package downloads Edgedriver when used for the first time through the CLI or the programmatical interface. If you like to download it as part of the NPM install process, set the `EDGEDRIVER_AUTO_INSTALL` environment flag, e.g.:

```sh

EDGEDRIVER_AUTO_INSTALL=1 npm i

```

To get a list of available CLI options run `npx edgedriver --help`. By default this package tries to find the Mircosoft Edge version installed on a given system. If you prefer to have it install a custom EdgeDriver version you can define the environment variable `EDGEDRIVER_VERSION` when running in CLI, e.g.:

```sh

$ npm i edgedriver

$ EDGEDRIVER_VERSION=105.0.1343.33 npx edgedriver --version

Microsoft Edge WebDriver 105.0.1343.33 (4122bb4646b33f33bca5d269490b9caadfc452b2)

```

# Setting a PROXY URL

Use `HTTPS_PROXY` or `HTTP_PROXY` to set your proxy URL.

# Programmatic Interface

You can import this package with Node.js and start the driver as part of your script and use it e.g. with [WebdriverIO](https://webdriver.io).

## Exported Methods

The package exports a `start`, `findEdgePath` and `download` method.

### `start`

Starts an EdgeDriver instance and returns a [`ChildProcess`](https://nodejs.org/api/child_process.html#class-childprocess). If EdgeDriver is not downloaded it will download it for you.

__Params:__ `EdgedriverParameters` - options to pass into EdgeDriver (see below)

__Example:__

```js

import { start } from 'edgedriver';

import { remote } from 'webdriverio';

import waitPort from 'wait-port';

/**

 * first start EdgeDriver

 */

const cp = await start({ port: 4444 });

/**

 * wait for EdgeDriver to be up

 */

await waitPort({ port: 4444 });

/**

 * then start WebdriverIO session

 */

const browser = await remote({ capabilities: { browserName: 'msedge' } });

await browser.url('https://webdriver.io');

console.log(await browser.getTitle()); // prints "WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO"

/**

 * kill Edgedriver process

 */

cp.kill();

```

__Note:__ as you can see in the example above this package does not wait for the driver to be up, you have to manage this yourself through packages like [`wait-on`](https://github.com/jeffbski/wait-on).

### `download`

Method to download an EdgeDriver with a particular version. If version parameter is omitted it tries to detect the version based on the Edge browser installed on the system.

__Params:__ `string` - version of Edgedriver to download (optional)

__Returns:__ `string` - path to Edgedriver binary

### `findEdgePath`

The `findEdgePath` is a helper method to find the Microsoft Egde binary on given system. If there is a `EDGE_BINARY_PATH` environment set, it will return that value.

__Returns:__ `string` - path to Microsoft Edge binary

## CJS Support

In case your module uses CJS you can use this package as follows:

```js

const { start } = require('edgedriver')

// see example above

```

## Custom CDN URL

This allows you to use your own endpoints for downloading Edgedriver binaries. It is useful in air gapped scenarios or if you have download restrictions, such as firewalls. You can either set an environment variable:

```sh

$ npm i edgedriver

$ EDGEDRIVER_CDNURL=https://msedgedriver.azureedge.net npx edgedriver --version

```

or create a [`.npmrc`](https://docs.npmjs.com/cli/configuring-npm/npmrc) with the following content:

```toml

edgedriver_cdnurl=https://msedgedriver.azureedge.net

```

## Options

The `start` method offers the following options to be passed on to the actual Edgedriver CLI.

### edgeDriverVersion

The version of EdgeDriver to start. See [Egdedriver directory list](https://msedgewebdriverstorage.z22.web.core.windows.net/) for all available versions, platforms and architecture.

Type: `number`


Default: `latest`

### port

The port on which the driver should run.

Example: `9515`


Type: `number`

### adbPort

The port on which the ADB driver should run.

Example: `9515`


Type: `number`

### baseUrl

Base URL path prefix for commands, e.g. `wd/url`.

Example: `/`

Type: `string`

### logPath

Write server log to file instead of stderr, increases log level to `INFO`

Type: `string`

### logLevel

Set log level. Possible options `ALL`, `DEBUG`, `INFO`, `WARNING`, `SEVERE`, `OFF`.

Type: `string`

### verbose

Log verbosely (equivalent to `--log-level=ALL`)

Type: `boolean`

### silent

Log nothing (equivalent to `--log-level=OFF`)

Type: `boolean`

### appendLog

Append log file instead of rewriting.

Type: `boolean`

### replayable

Log verbosely and don't truncate long strings so that the log can be replayed (experimental).

Type: `boolean`

### readableTimestamp

Add readable timestamps to log.

Type: `boolean`

### enableChromeLogs

Show logs from the browser (overrides other logging options).

Type: `boolean`

### bidiMapperPath

Custom bidi mapper path.

Type: `string`

### allowedIps

Comma-separated allowlist of remote IP addresses which are allowed to connect to EdgeDriver.

Type: `string[]`


Default: `['']`

### allowedOrigins

Comma-separated allowlist of request origins which are allowed to connect to EdgeDriver. Using `*` to allow any host origin is dangerous!

Type: `string[]`


Default: `['*']`

### cacheDir

The path to the root of the cache directory.

Type: `string`


Default: `process.env.EDGEDRIVER_CACHE_DIR || os.tmpdir()`

### customEdgeDriverPath

Don't download EdgeDriver, instead use a custom path to it, e.g. a cached binary.

Type: `string`


Default: `process.env.EDGEDRIVER_PATH`

---

For more information on WebdriverIO see the [homepage](https://webdriver.io).