Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: experimental WebDriver BiDi support with Firefox (#11412)
Co-authored-by: Jecelyn Yeen <5917927+jecfish@users.noreply.github.com>
- Loading branch information
Showing
23 changed files
with
269 additions
and
485 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,8 +32,6 @@ class Page { | |
|
|
||
| Promise<void> | ||
|
|
||
| ## Remarks | ||
|
|
||
| ## Example | ||
|
|
||
| ```ts | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| --- | ||
| sidebar_label: ProtocolType | ||
| --- | ||
|
|
||
| # ProtocolType type | ||
|
|
||
| #### Signature: | ||
|
|
||
| ```typescript | ||
| export type ProtocolType = 'cdp' | 'webDriverBiDi'; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| # Experimental WebDriver BiDi Support | ||
|
|
||
| [WebDriver BiDi](https://w3c.github.io/webdriver-bidi/) is a new cross-browser | ||
| automation protocol that adds browser-driven events to WebDriver. Here are the | ||
| resources if you want to learn more about WebDriver BiDi: | ||
|
|
||
| - [WebDriver BiDi - The future of cross-browser automation](https://developer.chrome.com/articles/webdriver-bidi/) | ||
| - [WebDriver BiDi: 2023 status update](https://developer.chrome.com/blog/webdriver-bidi-2023/) | ||
|
|
||
| ## Automate with Chrome and Firefox | ||
|
|
||
| Firefox support has almost reaching feature parity with the previous CDP-based | ||
| implementation. To see which features are fully supported with WebDriver BiDi we | ||
| used the [Puppeteer test suite](https://puppeteer.github.io/ispuppeteerwebdriverbidiready/). Currently, | ||
| we still have fewer than | ||
| [60](https://puppeteer.github.io/ispuppeteerwebdriverbidiready/firefox-delta.json) | ||
| tests that are failing with Firefox and WebDriver BiDi compared to the previous | ||
| CDP implementation in Firefox but we also have more than | ||
| [82](https://puppeteer.github.io/ispuppeteerwebdriverbidiready/firefox-delta.json) | ||
| new tests that work with WebDriver BiDi and that didn't work with CDP. | ||
|
|
||
| For Chrome, around 68% of the tests are currently passing with WebDriver BiDi so | ||
| the CDP-based implementation remains more powerful. Some of the Puppeteer | ||
| functionality is relying on CDP even with WebDriver BiDi enabled. Therefore, the | ||
| test pass rate is currently higher than that one of Firefox. | ||
|
|
||
| Example of launching Firefox with WebDriver BiDi: | ||
|
|
||
| ```ts | ||
| import puppeteer from 'puppeteer'; | ||
|
|
||
| const browser = await puppeteer.launch({ | ||
| product: 'firefox', | ||
| protocol: 'webDriverBiDi', | ||
| }); | ||
| const page = await browser.newPage(); | ||
| ... | ||
| await browser.close(); | ||
| ``` | ||
|
|
||
| Example of launching Chrome with WebDriver BiDi: | ||
|
|
||
| ```ts | ||
| import puppeteer from 'puppeteer'; | ||
|
|
||
| const browser = await puppeteer.launch({ | ||
| product: 'chrome', | ||
| protocol: 'webDriverBiDi', | ||
| }); | ||
| const page = await browser.newPage(); | ||
| ... | ||
| await browser.close(); | ||
| ``` | ||
|
|
||
| ## Puppeteer features supported over WebDriver BiDi | ||
|
|
||
| - Browser and page automation | ||
|
|
||
| - Browser.close | ||
| - Frame.goto() (except `referer` and `referrerPolicy`) | ||
| - Page.bringToFront | ||
| - Page.goto (except `referer` and `referrerPolicy`) | ||
| - Page.reload (except for `ignoreCache` parameter) | ||
| - Page.setViewport (`width`, `height`, `deviceScaleFactor` only) | ||
| - Puppeteer.launch | ||
|
|
||
| - [Script evaluation](https://pptr.dev/guides/evaluate-javascript): | ||
|
|
||
| - JSHandle.evaluate | ||
| - JSHandle.evaluateHandle | ||
| - Page.evaluate | ||
| - Page.exposeFunction | ||
|
|
||
| - [Selectors](https://pptr.dev/guides/query-selectors) and [locators](https://pptr.dev/guides/locators) except for ARIA: | ||
|
|
||
| - Page.$ (ARIA selectors supported in Chrome) | ||
| - Page.$$ (ARIA selectors supported in Chrome) | ||
| - Page.$$eval (ARIA selectors supported in Chrome) | ||
| - Page.$eval (ARIA selectors supported in Chrome) | ||
| - Page.waitForSelector (ARIA selectors supported in Chrome) | ||
|
|
||
| - Input | ||
|
|
||
| - ElementHandle.click | ||
| - Keyboard.down | ||
| - Keyboard.press | ||
| - Keyboard.sendCharacter | ||
| - Keyboard.type | ||
| - Keyboard.up | ||
| - Mouse events (except for dedicated drag'n'drop API methods) | ||
| - Page.tap | ||
| - TouchScreen.\* | ||
|
|
||
| - JavaScript dialog interception | ||
|
|
||
| - page.on('dialog') | ||
| - Dialog.\* | ||
|
|
||
| - Screenshots (not all parameters are supported) | ||
|
|
||
| - Page.screenshot (supported parameters `clip`, `encoding`, `fullPage`) | ||
|
|
||
| - PDF generation (not all parameters are supported) | ||
|
|
||
| - Page.pdf (only `format`, `height`, `landscape`, `margin`, `pageRanges`, `printBackground`, `scale`, `width` are supported) | ||
| - Page.createPDFStream (only `format`, `height`, `landscape`, `margin`, `pageRanges`, `printBackground`, `scale`, `width` are supported) | ||
|
|
||
| ## Puppeteer features not yet supported over WebDriver BiDi | ||
|
|
||
| - [Request interception](https://pptr.dev/guides/request-interception) | ||
|
|
||
| - HTTPRequest.abort() | ||
| - HTTPRequest.abortErrorReason() | ||
| - HTTPRequest.client() | ||
| - HTTPRequest.continue() | ||
| - HTTPRequest.continueRequestOverrides() | ||
| - HTTPRequest.failure() | ||
| - HTTPRequest.finalizeInterceptions() | ||
| - HTTPRequest.interceptResolutionState() | ||
| - HTTPRequest.isInterceptResolutionHandled() | ||
| - HTTPRequest.respond() | ||
| - HTTPRequest.responseForRequest() | ||
| - Page.setRequestInterception() | ||
|
|
||
| - Permissions | ||
|
|
||
| - BrowserContext.clearPermissionOverrides() | ||
| - BrowserContext.overridePermissions() | ||
|
|
||
| - Various emulations (most are supported with Chrome) | ||
|
|
||
| - Page.emulate() (supported only in Chrome) | ||
| - Page.emulateCPUThrottling() (supported only in Chrome) | ||
| - Page.emulateIdleState() (supported only in Chrome) | ||
| - Page.emulateMediaFeatures() (supported only in Chrome) | ||
| - Page.emulateMediaType() (supported only in Chrome) | ||
| - Page.emulateTimezone() (supported only in Chrome) | ||
| - Page.emulateVisionDeficiency() (supported only in Chrome) | ||
| - Page.setBypassCSP() (supported only in Chrome) | ||
| - Page.setCacheEnabled() (supported only in Chrome) | ||
| - Page.setGeolocation() (supported only in Chrome) | ||
| - Page.setJavaScriptEnabled() (supported only in Chrome) | ||
|
|
||
| - CDP-specific features | ||
|
|
||
| - Page.createCDPSession() (supported only in Chrome) | ||
|
|
||
| - Tracing (supported only in Chrome) | ||
| - Coverage (supported only in Chrome) | ||
| - Accessibility (supported only in Chrome) | ||
|
|
||
| - Other methods: | ||
|
|
||
| - Browser.userAgent() | ||
| - ElementHandle.uploadFile() | ||
| - Frame.isOOPFrame() | ||
| - Frame.waitForDevicePrompt() | ||
| - HTTPResponse.buffer() | ||
| - HTTPResponse.fromServiceWorker() | ||
| - HTTPResponse.securityDetails() | ||
| - Input.drag() | ||
| - Input.dragAndDrop() | ||
| - Input.dragOver() | ||
| - Input.drop() | ||
| - Page.authenticate() | ||
| - Page.cookies() | ||
| - Page.deleteCookie() | ||
| - Page.emulateNetworkConditions() | ||
| - Page.goBack() | ||
| - Page.goForward() | ||
| - Page.isDragInterceptionEnabled() | ||
| - Page.isJavaScriptEnabled() (supported only in Chrome) | ||
| - Page.isServiceWorkerBypassed() | ||
| - Page.metrics() | ||
| - Page.queryObjects() (supported only in Chrome) | ||
| - Page.screencast() (supported only in Chrome) | ||
| - Page.setBypassServiceWorker() | ||
| - Page.setCookie() | ||
| - Page.setDragInterception() | ||
| - Page.setExtraHTTPHeaders() | ||
| - Page.setOfflineMode() | ||
| - Page.setUserAgent() | ||
| - Page.waitForDevicePrompt() | ||
| - Page.waitForFileChooser() | ||
| - Page.workers() | ||
| - PageEvent.popup | ||
| - PageEvent.WorkerCreated | ||
| - PageEvent.WorkerDestroyed | ||
| - Target.opener() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.