Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(devtools): #12072

Merged
3 changes: 3 additions & 0 deletions packages/devtools/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
> [!WARNING]
> ***WebdriverIO is deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead, you can use the [`getPuppeteer`](/docs/api/browser/getPuppeteer) command to get ahold of a Puppeteer instance for Chrome Devtools introspection and automation.***

DevTools
========

Expand Down
2 changes: 2 additions & 0 deletions packages/wdio-types/src/Options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,8 @@ export interface WebdriverIO extends Omit<WebDriver, 'capabilities'>, Pick<Hooks
* Currently only [`webdriver`](https://www.npmjs.com/package/webdriver) and
* [`devtools`](https://www.npmjs.com/package/devtools) are supported,
* as these are the main browser automation technologies available.
*
* @deprecated this option will be removed in future versions of WebdriverIO. We recommend to use WebDriver for browser or mobile automation.
*/
automationProtocol?: SupportedProtocols
/**
Expand Down
8 changes: 8 additions & 0 deletions website/docs/AutomationProtocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ There are also plenty of services that allow you to run your automation test in

## DevTools Protocol

:::warning Deprecation

WebdriverIO is deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead, you can use the [`getPuppeteer`](/docs/api/browser/getPuppeteer) command to get ahold of a Puppeteer instance for Chrome Devtools introspection and automation.

:::


christian-bromann marked this conversation as resolved.
Show resolved Hide resolved

The DevTools interface is a native browser interface that is usually being used to debug the browser from a remote application (e.g., [Chrome DevTools](https://developers.google.com/web/tools/chrome-devtools/)). Next to its capabilities to inspect the browser in nearly all possible forms, it can also be used to control it.

While every browser used to have its own internal DevTools interface that was not really exposed to the user, more and more browsers are now adopting the [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). It is used to either debug a web application using Chrome DevTools or control Chrome using tools like [Puppeteer](https://pptr.dev).
Expand Down
6 changes: 6 additions & 0 deletions website/docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@ The following options (including the ones listed above) can be used with Webdriv

### automationProtocol

:::warning Deprecation

WebdriverIO is deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead, you should use [`webdriver`](https://www.npmjs.com/package/webdriver) .

:::

Define the protocol you want to use for your browser automation. Currently only [`webdriver`](https://www.npmjs.com/package/webdriver) and [`devtools`](https://www.npmjs.com/package/devtools) are supported, as these are the main browser automation technologies available.

If you want to automate the browser using `devtools`, make sure you have the NPM package installed (`$ npm install --save-dev devtools`).
Expand Down