ContextQMD
Back to Puppeteer

WebDriver BiDi support

docs/webdriver-bidi.md

19.2.25.4 KB
Original Source

WebDriver BiDi support

WebDriver BiDi is a new cross-browser automation protocol currently under development, aiming to combine the best of both WebDriver “Classic” and CDP. WebDriver BiDi enables bi-directional communication, making it fast by default, and it comes packed with low-level control.

Automate with Chrome and Firefox

Puppeteer supports WebDriver BiDi automation with Chrome and Firefox. When launching Firefox with Puppeteer, the WebDriver BiDi Protocol is enabled by default. When launching Chrome, CDP is still used by default since not all CDP features are supported by WebDriver BiDi yet. If a certain Puppeteer feature is not supported over WebDriver BiDi yet, UnsupportedOperation error is thrown. Also see the lists below on what is supported with WebDriver BiDi.

Get started

Below is an example of launching Firefox or Chrome with WebDriver BiDi:

ts
import puppeteer from 'puppeteer';

const firefoxBrowser = await puppeteer.launch({
  browser: 'firefox', // WebDriver BiDi is used by default.
});
const page = await firefoxBrowser.newPage();
...
await firefoxBrowser.close();

const chromeBrowser = await puppeteer.launch({
  browser: 'chrome',
  protocol: 'webDriverBiDi', // CDP would be used by default for Chrome.
});
const page = await chromeBrowser.newPage();
...
await chromeBrowser.close();

Puppeteer features not supported over WebDriver BiDi

  • Various emulations

    • Page.emulate()
    • Page.emulateCPUThrottling()
    • Page.emulateIdleState()
    • Page.emulateMediaFeatures()
    • Page.emulateMediaType()
    • Page.emulateVisionDeficiency()
    • Page.setBypassCSP()

  • CDP-specific features

    • HTTPRequest.client()
    • HTTPRequest.resourceType()
    • Page.createCDPSession()

  • Accessibility

  • Coverage

  • Tracing

  • Other methods:

    • Frame.waitForDevicePrompt()
    • HTTPResponse.buffer()
    • HTTPResponse.content()
    • HTTPResponse.text()
    • HTTPResponse.fromServiceWorker()
    • HTTPResponse.securityDetails()
    • Input.drag()
    • Input.dragAndDrop()
    • Input.dragOver()
    • Input.drop()
    • Page.emulateNetworkConditions()
    • Page.isDragInterceptionEnabled()
    • Page.isServiceWorkerBypassed()
    • Page.metrics()
    • Page.queryObjects()
    • Page.screencast()
    • Page.setBypassServiceWorker()
    • Page.setDragInterception()
    • Page.setOfflineMode()
    • Page.waitForDevicePrompt()
    • PageEvent.popup

Puppeteer features fully supported over WebDriver BiDi

  • Browser automation

    • Browser.close()
    • Browser.userAgent()
    • Browser.version()
    • Puppeteer.launch()

  • Page automation

    • Frame.goto() (except referer and referrerPolicy)
    • Page 'popup' event
    • Page.bringToFront()
    • Page.cookies()
    • Page.deleteCookie()
    • Page.goBack()
    • Page.goForward()
    • Page.goto (except referer and referrerPolicy)
    • Page.reload (except for ignoreCache parameter)
    • Page.setCacheEnabled()
    • Page.setCookie()
    • Page.setExtraHTTPHeaders()
    • Page.setGeolocation()
    • Page.setViewport (width, height, deviceScaleFactor only)
    • Page.waitForFileChooser()
    • Page.workers()
    • PageEvent.WorkerCreated
    • PageEvent.WorkerDestroyed
    • Target.opener()

  • Script evaluation:

    • JSHandle.evaluate()
    • JSHandle.evaluateHandle()
    • Page.evaluate()
    • Page.evaluateOnNewDocument()
    • Page.exposeFunction()

  • Selectors and locators except for ARIA:

    • Page.$
    • Page.$$
    • Page.$$eval
    • Page.$eval
    • Page.waitForSelector
    • Page.locator() and all locator APIs

  • Input

    • ElementHandle.click
    • ElementHandle.uploadFile
    • 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 are 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)

  • Permissions

    • BrowserContext.clearPermissionOverrides()
    • BrowserContext.overridePermissions()

  • Various emulations

    • Page.emulateTimezone()
    • Page.isJavaScriptEnabled()
    • Page.setJavaScriptEnabled()

  • Request interception

    • HTTPRequest.abort() (no custom error support)
    • HTTPRequest.abortErrorReason()
    • HTTPRequest.continue()
    • HTTPRequest.continueRequestOverrides()
    • HTTPRequest.failure()
    • HTTPRequest.finalizeInterceptions()
    • HTTPRequest.interceptResolutionState()
    • HTTPRequest.isInterceptResolutionHandled()
    • HTTPRequest.respond()
    • HTTPRequest.responseForRequest()
    • Page.authenticate()
    • Page.setRequestInterception()
    • Page.setUserAgent()

See also