Learn about event-driven testing with Selenium BiDi
Learn how to optimize your test scripts to use Selenium 4 event-driven testing with BrowserStack Automate.
Initially, CDP was a temporary solution for advanced browser automation until browser vendors could develop a more comprehensive cross-browser protocol.
CDP supports only Chromium-based browsers. Its implementation in Firefox has been incomplete and is expected to be deprecated. This limitation highlighted the need for a standardized protocol to enhance automation across different browsers.
Enter the WebDriver BiDi Protocol, a next-generation protocol developed under the W3C. Designed for enhanced browser automation, the WebDriver BiDi Protocol is set to become the standard for automated testing across various browsers.
Selenium now supports the W3C WebDriver BiDi Protocol.
Key Features of WebDriver BiDi Protocol
Selenium BiDi offers the following benefits:
Cross-Browser Compatibility: Unlike CDP, which is limited to Chromium-based browsers, the WebDriver BiDi Protocol is designed to work seamlessly across different browsers, including Firefox.
Event-Driven Automation: Enables testing scripts to react to browser events as they happen, improving the efficiency and effectiveness of test automation.
Standardization: As a W3C standard, the WebDriver BiDi Protocol ensures consistency and interoperability across various browser implementations.
Future-Proofing: Major browser vendors are committed to supporting the WebDriver BiDi Protocol, which represents the future of browser automation testing.
You can start your event-driven testing journey with the following features available in Selenium’s BiDi:
To perform event-driven tests, use the seleniumBidi capability in your test script to perform event-driven tests.
Capability
Description
Expected values
seleniumBidi
Enables the Selenium’s BiDi features in a test script.
Boolean. Set to true if you plan to use BiDi features. Accepted values are true and false. Default is false. This sets webSocketUrl to true for the browser, so that the user does not have to set it explicitly as required by Selenium.
Currently, all the feature implementation sample code snippets are available only in Java and Javascript in Selenium. We plan to add code snippets for other languages soon.
There are certain features of BiDi that are not supported by the browsers yet. This may result in an error when running your builds. The following table highlights a few examples of features that the browsers do not support:
Console logs are generally used to uncover the cause of a bug in the code execution.
Use this API to listen to the console.log events and register callbacks to process the event for displaying the logs.
The following test script navigates to a web page and clicks a button that generates console logs. This triggers an event with all the log details.
```java
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.bidi.module.LogInspector;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
public class ListenToConsoleLogs {
public static String REMOTE_URL = "";
static Boolean success = false;
public static void main(String[] args) throws MalformedURLException {
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("browserName", "chrome");
HashMap<String, Object> browserstackOptions = new HashMap<>();
browserstackOptions.put("os", "OS X");
browserstackOptions.put("osVersion", "Big Sur");
browserstackOptions.put("sessionName", "Console Logs");
browserstackOptions.put("seleniumVersion", "4.20.0");
// This can be replaced with the appropriate flag
browserstackOptions.put("seleniumBidi", true);
capabilities.setCapability("bstack:options", browserstackOptions);
WebDriver driver = new RemoteWebDriver(new URL(REMOTE_URL), capabilities);
try {
Augmenter augmenter = new Augmenter();
driver = augmenter.augment(driver);
try (LogInspector logInspector = new LogInspector(driver)) {
logInspector.onConsoleEntry(consoleLogEntry -> {
System.out.println("text: " + consoleLogEntry.getText());
System.out.println("level: " + consoleLogEntry.getLevel());
success = true;
});
String page = "https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html";
driver.get(page);
driver.findElement(By.id("consoleLog")).click();
if (success) {
markTestStatus("passed", "Console logs streaming", driver);
} else {
markTestStatus("failed", "Console logs did not stream", driver);
}
driver.quit();
}
} catch (Exception e) {
markTestStatus("failed", "Exception!", driver);
e.printStackTrace();
driver.quit();
}
}
public static void markTestStatus(String status, String reason, WebDriver driver) {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
}
}
```
Exception, as commonly known, is an unusual event that breaks the normal execution flow of a program.
Use this API to listen to the JavaScript exceptions and register callbacks to process the exception details. These exception details can assist in further inspecting the cause and aiding the debugging process.
The following test script navigates to a web page and clicks a button that throws an error. This fires an event with all the error details.
```java
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.bidi.module.LogInspector;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
public class ListenToJavaScriptExceptions {
public static String REMOTE_URL = "";
static Boolean success = false;
public static void main(String[] args) throws MalformedURLException {
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("browserName", "chrome");
HashMap<String, Object> browserstackOptions = new HashMap<>();
browserstackOptions.put("os", "OS X");
browserstackOptions.put("osVersion", "Big Sur");
browserstackOptions.put("sessionName", "Console Logs");
browserstackOptions.put("seleniumVersion", "4.20.0");
// This can be replaced with the appropriate flag
browserstackOptions.put("seleniumBidi", true);
capabilities.setCapability("bstack:options", browserstackOptions);
WebDriver driver = new RemoteWebDriver(new URL(REMOTE_URL), capabilities);
try {
Augmenter augmenter = new Augmenter();
driver = augmenter.augment(driver);
try (LogInspector logInspector = new LogInspector(driver)) {
logInspector.onJavaScriptException(logEntry -> {
System.out.println("text: " + logEntry.getText());
System.out.println("level: " + logEntry.getLevel());
success = true;
});
String page = "https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html";
driver.get(page);
driver.findElement(By.id("jsException")).click();
Thread.sleep(1000);
if (success) {
markTestStatus("passed", "Js exception caught", driver);
} else {
markTestStatus("failed", "Js exception was not caught", driver);
}
driver.quit();
}
} catch (Exception e) {
markTestStatus("failed", "Exception!", driver);
e.printStackTrace();
driver.quit();
}
}
public static void markTestStatus(String status, String reason, WebDriver driver) {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
}
}
```
Intercepting network requests allows for inspection and modification of the outgoing requests. This can be used to monitor network traffic or mock outgoing requests by modifying the headers, body, cookies, method, and/or URL.
```java
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.bidi.module.Network;
import org.openqa.selenium.bidi.network.AddInterceptParameters;
import org.openqa.selenium.bidi.network.ContinueRequestParameters;
import org.openqa.selenium.bidi.network.InterceptPhase;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
public class InterceptNetworkRequest {
public static String REMOTE_URL = "";
static Boolean success = false;
public static void main(String[] args) throws MalformedURLException {
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("browserName", "chrome");
HashMap<String, Object> browserstackOptions = new HashMap<>();
browserstackOptions.put("os", "OS X");
browserstackOptions.put("osVersion", "Big Sur");
browserstackOptions.put("sessionName", "Console Logs");
browserstackOptions.put("seleniumVersion", "4.20.0");
// This can be replaced with the appropriate flag
browserstackOptions.put("seleniumBidi", true);
capabilities.setCapability("bstack:options", browserstackOptions);
WebDriver driver = new RemoteWebDriver(new URL(REMOTE_URL), capabilities);
try {
Augmenter augmenter = new Augmenter();
driver = augmenter.augment(driver);
try (Network network = new Network(driver)) {
network.addIntercept(new AddInterceptParameters(InterceptPhase.BEFORE_REQUEST_SENT));
CountDownLatch latch = new CountDownLatch(1);
network.onBeforeRequestSent(
beforeRequestSent -> {
System.out.println("Request sent to url ->" + beforeRequestSent.getRequest().getUrl());
network.continueRequest(
// More parameters are available to mock the outgoing request.
// Ensure it is supported by the browser under test.
new ContinueRequestParameters(beforeRequestSent.getRequest().getRequestId()));
latch.countDown();
});
driver.get("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html");
boolean countdown = latch.await(5, TimeUnit.SECONDS);
if (countdown) {
markTestStatus("passed", "Network request intercepted", driver);
} else {
markTestStatus("failed", "Network request not intercepted", driver);
}
driver.quit();
}
} catch (Exception e) {
markTestStatus("failed", "Exception!", driver);
e.printStackTrace();
driver.quit();
}
}
public static void markTestStatus(String status, String reason, WebDriver driver) {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
}
}
```
Intercepting network responses allows for inspection and modification of the incoming responses. This can be used to monitor network traffic or mock responses by modifying the headers, cookies, credentials, reason phrases, and/or status codes.
```java
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.bidi.module.Network;
import org.openqa.selenium.bidi.network.AddInterceptParameters;
import org.openqa.selenium.bidi.network.ContinueResponseParameters;
import org.openqa.selenium.bidi.network.InterceptPhase;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
public class InterceptNetworkResponse {
public static String REMOTE_URL = "";
static Boolean success = false;
public static void main(String[] args) throws MalformedURLException {
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("browserName", "chrome");
HashMap<String, Object> browserstackOptions = new HashMap<>();
browserstackOptions.put("os", "OS X");
browserstackOptions.put("osVersion", "Big Sur");
browserstackOptions.put("sessionName", "Console Logs");
browserstackOptions.put("seleniumVersion", "4.20.0");
// This can be replaced with the appropriate flag
browserstackOptions.put("seleniumBidi", true);
capabilities.setCapability("bstack:options", browserstackOptions);
WebDriver driver = new RemoteWebDriver(new URL(REMOTE_URL), capabilities);
try {
Augmenter augmenter = new Augmenter();
driver = augmenter.augment(driver);
try (Network network = new Network(driver)) {
network.addIntercept(new AddInterceptParameters(InterceptPhase.RESPONSE_STARTED));
CountDownLatch latch = new CountDownLatch(1);
network.onResponseStarted(
responseDetails -> {
network.continueResponse(
new ContinueResponseParameters(responseDetails.getRequest().getRequestId()));
latch.countDown();
});
network.onResponseStarted(
responseDetails -> {
System.out.println("Request response received for url ->" + responseDetails.getRequest().getUrl());
// More parameters are available to modify the incoming response.
// Ensure it is supported by the browser under test.
network.continueResponse(
new ContinueResponseParameters(responseDetails.getRequest().getRequestId()));
latch.countDown();
});
driver.get("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html");
boolean countdown = latch.await(5, TimeUnit.SECONDS);
if (countdown) {
markTestStatus("passed", "Network response intercepted", driver);
} else {
markTestStatus("failed", "Network response not intercepted", driver);
}
driver.quit();
}
} catch (Exception e) {
markTestStatus("failed", "Exception!", driver);
e.printStackTrace();
driver.quit();
}
}
public static void markTestStatus(String status, String reason, WebDriver driver) {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
}
}
```
Some websites use the browser authentication method to secure web pages. Using Selenium, you can write an automated test script that enters your credentials in the basic auth popup window whenever it appears.
The following test script opens a website and enters sample credentials in the basic auth popup window:
```java
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.MutableCapabilities;
import org.openqa.selenium.UsernameAndPassword;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.bidi.module.Network;
import org.openqa.selenium.bidi.network.AddInterceptParameters;
import org.openqa.selenium.bidi.network.InterceptPhase;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.RemoteWebDriver;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
public class BasicAuth {
public static String REMOTE_URL = "";
public static void main(String[] args) throws MalformedURLException {
MutableCapabilities capabilities = new MutableCapabilities();
capabilities.setCapability("browserName", "chrome");
HashMap<String, Object> browserstackOptions = new HashMap<>();
browserstackOptions.put("os", "OS X");
browserstackOptions.put("osVersion", "Big Sur");
browserstackOptions.put("sessionName", "Console Logs");
browserstackOptions.put("seleniumVersion", "4.20.0");
// This can be replaced with the appropriate flag
browserstackOptions.put("seleniumBidi", true);
capabilities.setCapability("bstack:options", browserstackOptions);
WebDriver driver = new RemoteWebDriver(new URL(REMOTE_URL), capabilities);
try {
Augmenter augmenter = new Augmenter();
driver = augmenter.augment(driver);
try (Network network = new Network(driver)) {
network.addIntercept(new AddInterceptParameters(InterceptPhase.AUTH_REQUIRED));
network.onAuthRequired(
responseDetails ->
network.continueWithAuth(
responseDetails.getRequest().getRequestId(),
new UsernameAndPassword("foo", "bar")));
driver.get("http://httpbin.org/basic-auth/foo/bar");
String text = driver.findElement(By.tagName("body")).getText();
System.out.println(text);
if (text.contains("authenticated")) {
markTestStatus("passed", "Authenticated", driver);
} else {
markTestStatus("failed", "Authentication failed", driver);
}
driver.quit();
}
} catch (Exception e) {
markTestStatus("failed", "Exception!", driver);
e.printStackTrace();
driver.quit();
}
}
public static void markTestStatus(String status, String reason, WebDriver driver) {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript("browserstack_executor: {\"action\": \"setSessionStatus\", \"arguments\": {\"status\": \"" + status + "\", \"reason\": \"" + reason + "\"}}");
}
}
```
The W3C BiDi protocol is currently under development and being implemented by browser vendors. Selenium is keeping pace and aims to fully implement the BiDi protocol, providing user-friendly APIs for common use cases in future versions.
Currently, the Java and JavaScript BiDi APIs align with the W3C BiDi specification, even if some features are only available in beta versions of browsers.
For browser status updates, check here. Find more examples and version support in Selenium here.
Did this page help you?
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!
By clicking 'Accept All', you agree to the use of all types of cookies to enhance site navigation. For more information, please visit our Cookie Policy.
Yes
