Add addDataCollector, disownData, getData, removeDataCollector and setExtraHeaders network commands

Author: TahaHachana

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "webdriverbidi"
-version = "0.2.1"
+version = "0.2.2"
 edition = "2024"
 authors = ["Taha Hachana <tahahachana@gmail.com>"]
 description = "WebDriver BiDi client implementation in Rust."

Cargo.toml

@@ -23,7 +23,7 @@ Add the following to your `Cargo.toml` (the example below will also require toki
 
 ```toml
 [dependencies]
-webdriverbidi = "0.2.0"
+webdriverbidi = "0.2.2"
 ```
 
 ### Usage
@@ -188,8 +188,11 @@ async fn main() -> Result<()> {
 - [x] network.AuthCredentials
 - [x] network.BaseParameters
 - [x] network.BytesValue
+- [x] network.Collector
+- [x] network.CollectorType
 - [x] network.Cookie
 - [x] network.CookieHeader
+- [x] network.DataType
 - [x] network.FetchTimingInfo
 - [x] network.Header
 - [x] network.Initiator
@@ -202,14 +205,19 @@ async fn main() -> Result<()> {
 - [x] network.UrlPattern
 
 #### Commands
+- [x] network.addDataCollector
 - [x] network.addIntercept
 - [x] network.continueRequest
 - [x] network.continueResponse
 - [x] network.continueWithAuth
+- [x] The network.disownData
 - [x] network.failRequest
+- [x] network.getData
 - [x] network.provideResponse
+- [x] network.removeDataCollector
 - [x] network.removeIntercept
 - [x] network.setCacheBehavior
+- [x] network.setExtraHeaders
 
 #### Events
 - [x] network.authRequired

README.md

@@ -8,6 +8,15 @@ use crate::model::network::*;
 use crate::model::result::EmptyResult;
 use crate::session::WebDriverBiDiSession;
 
+// https://w3c.github.io/webdriver-bidi/#command-network-addDataCollector
+define_command!(
+    AddDataCollectorCommand,
+    AddDataCollector,
+    AddDataCollectorParameters,
+    add_data_collector,
+    AddDataCollectorResult
+);
+
 // https://w3c.github.io/webdriver-bidi/#command-network-addIntercept
 define_command!(
     AddInterceptCommand,
@@ -44,6 +53,15 @@ define_command!(
     EmptyResult
 );
 
+// https://w3c.github.io/webdriver-bidi/#command-network-disownData
+define_command!(
+    DisownDataCommand,
+    DisownData,
+    DisownDataParameters,
+    disown_data,
+    EmptyResult
+);
+
 // https://w3c.github.io/webdriver-bidi/#command-network-failRequest
 define_command!(
     FailRequestCommand,
@@ -53,6 +71,15 @@ define_command!(
     EmptyResult
 );
 
+// https://w3c.github.io/webdriver-bidi/#command-network-getData
+define_command!(
+    GetDataCommand,
+    GetData,
+    GetDataParameters,
+    get_data,
+    GetDataResult
+);
+
 // https://w3c.github.io/webdriver-bidi/#command-network-provideResponse
 define_command!(
     ProvideResponseCommand,
@@ -62,6 +89,15 @@ define_command!(
     EmptyResult
 );
 
+// https://w3c.github.io/webdriver-bidi/#command-network-removeDataCollector
+define_command!(
+    RemoveDataCollectorCommand,
+    RemoveDataCollector,
+    RemoveDataCollectorParameters,
+    remove_data_collector,
+    EmptyResult
+);
+
 // https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept
 define_command!(
     RemoveInterceptCommand,
@@ -79,3 +115,12 @@ define_command!(
     set_cache_behavior,
     EmptyResult
 );
+
+// https://w3c.github.io/webdriver-bidi/#command-network-setExtraHeaders
+define_command!(
+    SetExtraHeadersCommand,
+    SetExtraHeaders,
+    SetExtraHeadersParameters,
+    set_extra_headers,
+    EmptyResult
+);

src/commands/network.rs

@@ -351,6 +351,15 @@ pub struct AddDataCollector {
     pub params: AddDataCollectorParameters,
 }
 
+impl AddDataCollector {
+    pub fn new(params: AddDataCollectorParameters) -> Self {
+        Self {
+            method: "network.addDataCollector".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct AddDataCollectorParameters {
     #[serde(rename = "dataTypes")]
@@ -604,6 +613,15 @@ pub struct DisownData {
     pub params: DisownDataParameters,
 }
 
+impl DisownData {
+    pub fn new(params: DisownDataParameters) -> Self {
+        Self {
+            method: "network.disownData".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct DisownDataParameters {
     #[serde(rename = "dataType")]
@@ -644,6 +662,15 @@ pub struct GetData {
     pub params: GetDataParameters,
 }
 
+impl GetData {
+    pub fn new(params: GetDataParameters) -> Self {
+        Self {
+            method: "network.getData".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct GetDataParameters {
     #[serde(rename = "dataType")]
@@ -710,17 +737,21 @@ impl ProvideResponseParameters {
     }
 }
 
-// network.RemoveDataCollector = (
-//   method: "network.removeDataCollector",
-//   params: network.RemoveDataCollectorParameters
-// )
-
 #[derive(Debug, Serialize, Deserialize)]
 pub struct RemoveDataCollector {
     pub method: String,
     pub params: RemoveDataCollectorParameters,
 }
 
+impl RemoveDataCollector {
+    pub fn new(params: RemoveDataCollectorParameters) -> Self {
+        Self {
+            method: "network.removeDataCollector".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct RemoveDataCollectorParameters {
     pub collector: Collector,
@@ -856,3 +887,27 @@ pub struct ResponseStartedParameters {
     pub base: BaseParameters,
     pub response: ResponseData,
 }
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct SetExtraHeaders {
+    pub method: String,
+    pub params: SetExtraHeadersParameters,
+}
+
+impl SetExtraHeaders {
+    pub fn new(params: SetExtraHeadersParameters) -> Self {
+        Self {
+            method: "network.setExtraHeaders".to_string(),
+            params,
+        }
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct SetExtraHeadersParameters {
+    pub headers: Vec<Header>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub contexts: Option<Vec<BrowsingContext>>,
+    #[serde(rename = "userContexts", skip_serializing_if = "Option::is_none")]
+    pub user_contexts: Option<Vec<UserContext>>,
+}

src/model/network.rs

@@ -700,6 +700,24 @@ impl WebDriverBiDiSession {
 
 // Network commands
 impl WebDriverBiDiSession {
+    // https://w3c.github.io/webdriver-bidi/#command-network-addDataCollector
+
+    /// Add a data collector.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as an `AddDataCollectorParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `AddDataCollectorResult` or a `CommandError`.
+    pub async fn network_add_data_collector(
+        &mut self,
+        params: AddDataCollectorParameters,
+    ) -> Result<AddDataCollectorResult, CommandError> {
+        commands::network::add_data_collector(self, params).await
+    }
+
     // https://w3c.github.io/webdriver-bidi/#command-network-addIntercept
 
     /// Add a network intercept.
@@ -772,6 +790,24 @@ impl WebDriverBiDiSession {
         commands::network::continue_with_auth(self, params).await
     }
 
+    // https://w3c.github.io/webdriver-bidi/#command-network-disownData
+
+    /// Release a collected network data for a given collector.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `DisownDataParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn network_disown_data(
+        &mut self,
+        params: DisownDataParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::network::disown_data(self, params).await
+    }
+
     // https://w3c.github.io/webdriver-bidi/#command-network-failRequest
 
     /// Fail a fetch that’s blocked by a network intercept.
@@ -790,6 +826,24 @@ impl WebDriverBiDiSession {
         commands::network::fail_request(self, params).await
     }
 
+    // https://w3c.github.io/webdriver-bidi/#command-network-getData
+
+    /// Retrieve a network data if it is available.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `GetDataParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `GetDataResult` or a `CommandError`.
+    pub async fn network_get_data(
+        &mut self,
+        params: GetDataParameters,
+    ) -> Result<GetDataResult, CommandError> {
+        commands::network::get_data(self, params).await
+    }
+
     // https://w3c.github.io/webdriver-bidi/#command-network-provideResponse
 
     /// Continue a request that’s blocked by a network intercept, by providing a complete response.
@@ -808,6 +862,24 @@ impl WebDriverBiDiSession {
         commands::network::provide_response(self, params).await
     }
 
+    // https://w3c.github.io/webdriver-bidi/#command-network-removeDataCollector
+
+    /// Remove a data collector.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as an `RemoveDataCollectorParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn network_remove_data_collector(
+        &mut self,
+        params: RemoveDataCollectorParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::network::remove_data_collector(self, params).await
+    }
+
     // https://w3c.github.io/webdriver-bidi/#command-network-removeIntercept
 
     /// Remove a network intercept.
@@ -843,6 +915,24 @@ impl WebDriverBiDiSession {
     ) -> Result<EmptyResult, CommandError> {
         commands::network::set_cache_behavior(self, params).await
     }
+
+    // https://w3c.github.io/webdriver-bidi/#command-network-setExtraHeaders
+
+    /// Allow specifying headers that will extend, or overwrite, existing request headers.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `SetExtraHeadersParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn network_set_extra_headers(
+        &mut self,
+        params: SetExtraHeadersParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::network::set_extra_headers(self, params).await
+    }
 }
 
 // Script commands