https://github.com/tahahachana/webdriverbidi
WebDriver BiDi client implementation in Rust.
https://github.com/tahahachana/webdriverbidi
browser-automation rust tokio webdriver webdriver-bidi websocket
Last synced: 3 months ago
JSON representation
WebDriver BiDi client implementation in Rust.
- Host: GitHub
- URL: https://github.com/tahahachana/webdriverbidi
- Owner: TahaHachana
- License: mit
- Created: 2024-12-24T05:58:45.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T18:01:49.000Z (3 months ago)
- Last Synced: 2025-02-15T19:18:45.147Z (3 months ago)
- Topics: browser-automation, rust, tokio, webdriver, webdriver-bidi, websocket
- Language: Rust
- Homepage: https://crates.io/crates/webdriverbidi
- Size: 1.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webdriverbidi
## Overview
The webdriverbidi library provides an interface for interacting with web browsers through the WebDriver BiDi (Bidirectional) protocol. This library allows you to create and manage WebDriver sessions, send commands, and handle responses asynchronously through WebSockets.
## Features
- Create and manage WebDriver BiDi sessions
- Send commands
- Handle events asynchronously
## Getting Started
### Prerequisites
- Rust and Cargo installed
- A WebDriver server that supports the BiDi protocol
### Installation
Add the following to your `Cargo.toml` (the example below will also require tokio with full features):
```toml
[dependencies]
webdriverbidi = "0.1.16"
```
### Usage
Start a WebDriver BiDi compliant server
```bash
$ geckodriver --host=localhost --port=4444
# chromedriver --host=localhost --port=4444
# ./msedgedriver --host=localhost --port=4444
```
Create a new Rust project and add the following code to `src/main.rs`:
```rust
use anyhow::Result;
use tokio::time;
// --------------------------------------------------
use webdriverbidi::remote::browsing_context::{
GetTreeParameters, NavigateParameters, ReadinessState,
};
use webdriverbidi::session::WebDriverBiDiSession;
use webdriverbidi::webdriver::capabilities::CapabilitiesRequest;
// --------------------------------------------------
const HOST: &str = "localhost";
const PORT: u16 = 4444;
// --------------------------------------------------
async fn sleep_for_secs(secs: u64) {
time::sleep(time::Duration::from_secs(secs)).await
}
/// Initializes a new WebDriver BiDi session.
pub async fn init_session() -> Result {
let capabilities = CapabilitiesRequest::default();
let mut session = WebDriverBiDiSession::new(HOST.into(), PORT, capabilities);
session.start().await?;
Ok(session)
}
/// Retrieves the browsing context at the specified index.
pub async fn get_context(session: &mut WebDriverBiDiSession, idx: usize) -> Result {
let get_tree_params = GetTreeParameters::new(None, None);
let get_tree_rslt = session.browsing_context_get_tree(get_tree_params).await?;
if let Some(context_entry) = get_tree_rslt.contexts.get(idx) {
Ok(context_entry.context.clone())
} else {
anyhow::bail!("No browsing context found at index {idx}");
}
}
/// Navigates to the specified URL and waits for the document to completely load.
pub async fn navigate(session: &mut WebDriverBiDiSession, ctx: String, url: String) -> Result<()> {
let navigate_params = NavigateParameters::new(ctx, url, Some(ReadinessState::Complete));
session.browsing_context_navigate(navigate_params).await?;
Ok(())
}
#[tokio::main]
async fn main() -> Result<()> {
let mut session = init_session().await?;
let ctx = get_context(&mut session, 0).await?;
let url = String::from("https://www.rust-lang.org/");
navigate(&mut session, ctx, url).await?;
sleep_for_secs(1).await;
session.close().await?;
Ok(())
}
```
## Module Coverage
### session
#### Types
- [x] session.CapabilitiesRequest
- [x] session.CapabilityRequest
- [x] session.ProxyConfiguration
- [x] session.UserPromptHandler
- [x] session.UserPromptHandlerType
- [x] session.Subscription
- [x] session.SubscriptionRequest
- [x] session.UnsubscribeByIDRequest
- [x] session.UnsubscribeByAttributesRequest
#### Commands
- [x] session.status
- [x] session.new
- [x] session.end
- [x] session.subscribe
- [x] session.unsubscribe
### browser
#### Types
- [x] browser.ClientWindow
- [x] browser.ClientWindowInfo
- [x] browser.UserContext
- [x] browser.UserContextInfo
#### Commands
- [x] browser.close
- [x] browser.createUserContext
- [x] browser.getClientWindows
- [x] browser.getUserContexts
- [x] browser.removeUserContext
- [x] browser.setClientWindowState
### browsingContext
#### Types
- [x] browsingContext.BrowsingContext
- [x] browsingContext.Info
- [x] browsingContext.Locator
- [x] browsingContext.Navigation
- [x] browsingContext.NavigationInfo
- [x] browsingContext.ReadinessState
- [x] browsingContext.UserPromptType
#### Commands
- [x] browsingContext.activate
- [x] browsingContext.captureScreenshot
- [x] browsingContext.close
- [x] browsingContext.create
- [x] browsingContext.getTree
- [x] browsingContext.handleUserPrompt
- [x] browsingContext.locateNodes
- [x] browsingContext.navigate
- [x] browsingContext.print
- [x] browsingContext.reload
- [x] browsingContext.setViewport
- [x] browsingContext.traverseHistory
#### Events
- [x] browsingContext.contextCreated
- [x] browsingContext.contextDestroyed
- [x] browsingContext.navigationStarted
- [x] browsingContext.fragmentNavigated
- [x] browsingContext.historyUpdated
- [x] browsingContext.domContentLoaded
- [x] browsingContext.load
- [x] browsingContext.downloadWillBegin
- [x] browsingContext.navigationAborted
- [x] browsingContext.navigationCommitted
- [x] browsingContext.navigationFailed
- [x] browsingContext.userPromptClosed
- [x] browsingContext.userPromptOpened
### network
#### Types
- [x] network.AuthChallenge
- [x] network.AuthCredentials
- [x] network.BaseParameters
- [x] network.BytesValue
- [x] network.Cookie
- [x] network.CookieHeader
- [x] network.FetchTimingInfo
- [x] network.Header
- [x] network.Initiator
- [x] network.Intercept
- [x] network.Request
- [x] network.RequestData
- [x] network.ResponseContent
- [x] network.ResponseData
- [x] network.SetCookieHeader
- [x] network.UrlPattern
#### Commands
- [x] network.addIntercept
- [x] network.continueRequest
- [x] network.continueResponse
- [x] network.continueWithAuth
- [x] network.failRequest
- [x] network.provideResponse
- [x] network.removeIntercept
- [x] network.setCacheBehavior
#### Events
- [x] network.authRequired
- [x] network.beforeRequestSent
- [x] network.fetchError
- [x] network.responseCompleted
- [x] network.responseStarted
### script
#### Types
- [x] script.Channel
- [x] script.ChannelValue
- [x] script.EvaluateResult
- [x] script.ExceptionDetails
- [x] script.Handle
- [x] script.InternalId
- [x] script.LocalValue
- [x] script.PreloadScript
- [x] script.Realm
- [x] script.PrimitiveProtocolValue
- [x] script.RealmInfo
- [x] script.RealmType
- [x] script.RemoteReference
- [x] script.RemoteValue
- [x] script.ResultOwnership
- [x] script.SerializationOptions
- [x] script.SharedId
- [x] script.StackFrame
- [x] script.StackTrace
- [x] script.Source
- [x] script.Target
#### Commands
- [x] script.addPreloadScript
- [x] script.disown
- [x] script.callFunction
- [x] script.evaluate
- [x] script.getRealms
- [x] script.removePreloadScript
#### Events
- [x] script.message
- [x] script.realmCreated
- [x] script.realmDestroyed
### storage
#### Types
- [x] storage.PartitionKey
#### Commands
- [x] storage.getCookies
- [x] storage.setCookie
- [x] storage.deleteCookies
### log
#### Types
- [x] log.LogEntry
#### Events
- [x] log.entryAdded
### input
#### Types
- [x] input.ElementOrigin
#### Commands
- [x] input.performActions
- [x] input.releaseActions
- [x] input.setFiles
### webExtension
#### Types
- [x] webExtension.Extension
#### Commands
- [x] webExtension.install
- [x] webExtension.uninstall
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for details.