Add emulation setLocaleOverride, setScreenOrientationOverride and setTimezoneOverride commands

Author: TahaHachana

Cargo.lock

@@ -1,19 +1,19 @@
 [package]
 name = "webdriverbidi"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2024"
 authors = ["Taha Hachana <tahahachana@gmail.com>"]
 description = "WebDriver BiDi client implementation in Rust."
 license = "MIT"
 repository = "https://github.com/TahaHachana/webdriverbidi"
 
 [dependencies]
-tokio = { version = "1.44.2", features = ["full"] }
-tokio-tungstenite = "0.26.2"
+tokio = { version = "1.47.0", features = ["full"] }
+tokio-tungstenite = "0.27.0"
 serde = { version = "1.0.219", features = ["derive"] }
-serde_json = "1.0.140"
+serde_json = "1.0.141"
 futures = "0.3.31"
-reqwest = { version = "0.12.15", default-features = false, features = ["json"] }
+reqwest = { version = "0.12.22", default-features = false, features = ["json"] }
 thiserror = "2.0.12"
 log = "0.4.27"
 
@@ -22,9 +22,9 @@ simplelog = "0.12.2"
 time = "0.3.41"
 env_logger = "0.11.8"
 base64 = "0.22.1"
-ctor = "0.4.1"
+ctor = "0.4.3"
 anyhow = "1.0.98"
 url = "2.5.4"
-axum = "0.8.3"
+axum = "0.8.4"
 tower = { version = "0.5.2", features = ["util"] }
 tower-http = { version = "0.6.2", features = ["fs"] }

Cargo.toml

@@ -178,6 +178,9 @@ async fn main() -> Result<()> {
 ### emulation
 #### Commands
 - [x] emulation.setGeolocationOverride
+- [x] emulation.setLocaleOverride
+- [x] emulation.setScreenOrientationOverride
+- [x] emulation.setTimezoneOverride
 
 ### network
 #### Types

README.md

@@ -17,3 +17,30 @@ define_command!(
     set_geolocation_override,
     EmptyResult
 );
+
+// https://w3c.github.io/webdriver-bidi/#command-emulation-setLocaleOverride
+define_command!(
+    SetLocaleOverrideCommand,
+    SetLocaleOverride,
+    SetLocaleOverrideParameters,
+    set_locale_override,
+    EmptyResult
+);
+
+// https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenOrientationOverride
+define_command!(
+    SetScreenOrientationOverrideCommand,
+    SetScreenOrientationOverride,
+    SetScreenOrientationOverrideParameters,
+    set_screen_orientation_override,
+    EmptyResult
+);
+
+// https://w3c.github.io/webdriver-bidi/#command-emulation-setTimezoneOverride
+define_command!(
+    SetTimezoneOverrideCommand,
+    SetTimezoneOverride,
+    SetTimezoneOverrideParameters,
+    set_timezone_override,
+    EmptyResult
+);

src/commands/emulation.rs

@@ -1,7 +1,10 @@
 use serde::{Deserialize, Serialize};
 
-use crate::{commands::session, model::common::{EmptyParams, JsInt, JsUint}};
 use crate::model::session::{ProxyConfiguration, UserPromptHandler};
+use crate::{
+    commands::session,
+    model::common::{EmptyParams, JsInt, JsUint},
+};
 
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(untagged)]
@@ -106,11 +109,17 @@ impl CreateUserContext {
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct CreateUserContextParameters {
-    #[serde(rename = "acceptInsecureCerts", skip_serializing_if = "Option::is_none")]
+    #[serde(
+        rename = "acceptInsecureCerts",
+        skip_serializing_if = "Option::is_none"
+    )]
     pub accept_insecure_certs: Option<bool>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub proxy: Option<ProxyConfiguration>,
-    #[serde(rename = "unhandledPromptBehavior", skip_serializing_if = "Option::is_none")]
+    #[serde(
+        rename = "unhandledPromptBehavior",
+        skip_serializing_if = "Option::is_none"
+    )]
     pub unhandled_prompt_behavior: Option<UserPromptHandler>,
 }
 

src/model/browser.rs

@@ -27,7 +27,6 @@ impl SetGeolocationOverride {
     }
 }
 
-
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum SetGeolocationOverrideParameters {
@@ -132,6 +131,14 @@ pub struct SetLocaleOverride {
     pub params: SetLocaleOverrideParameters,
 }
 
+impl SetLocaleOverride {
+    pub fn new(params: SetLocaleOverrideParameters) -> Self {
+        Self {
+            method: "emulation.setLocaleOverride".to_string(),
+            params,
+        }
+    }
+}
 #[derive(Debug, Serialize, Deserialize)]
 pub struct SetLocaleOverrideParameters {
     pub locale: Option<String>,
@@ -147,12 +154,21 @@ pub struct SetScreenOrientationOverride {
     pub params: SetScreenOrientationOverrideParameters,
 }
 
+impl SetScreenOrientationOverride {
+    pub fn new(params: SetScreenOrientationOverrideParameters) -> Self {
+        Self {
+            method: "emulation.setScreenOrientationOverride".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "lowercase", untagged)]
 pub enum ScreenOrientationNatural {
     Portrait,
     Landscape,
-} 
+}
 
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "kebab-case", untagged)]
@@ -186,6 +202,15 @@ pub struct SetTimezoneOverride {
     pub params: SetTimezoneOverrideParameters,
 }
 
+impl SetTimezoneOverride {
+    pub fn new(params: SetTimezoneOverrideParameters) -> Self {
+        Self {
+            method: "emulation.setTimezoneOverride".to_string(),
+            params,
+        }
+    }
+}
+
 #[derive(Debug, Serialize, Deserialize)]
 pub struct SetTimezoneOverrideParameters {
     pub timezone: Option<String>,

src/model/emulation.rs

@@ -1,7 +1,7 @@
 use serde::{Deserialize, Serialize};
 
-use crate::model::browsing_context::{BrowsingContext, Navigation};
 use crate::model::browser::UserContext;
+use crate::model::browsing_context::{BrowsingContext, Navigation};
 use crate::model::common::{Extensible, JsInt, JsUint};
 use crate::model::script::StackTrace;
 
@@ -357,7 +357,11 @@ pub struct AddDataCollectorParameters {
     pub data_types: Vec<DataType>,
     #[serde(rename = "maxEncodedDataSize")]
     pub max_encoded_data_size: JsUint,
-    #[serde(rename = "collectorType", default, skip_serializing_if = "Option::is_none")]
+    #[serde(
+        rename = "collectorType",
+        default,
+        skip_serializing_if = "Option::is_none"
+    )]
     pub collector_type: Option<CollectorType>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub contexts: Option<Vec<BrowsingContext>>,
@@ -370,8 +374,6 @@ pub struct AddDataCollectorResult {
     pub collector: Collector,
 }
 
-
-
 #[derive(Debug, Serialize, Deserialize)]
 pub struct AddIntercept {
     pub method: String,

src/model/network.rs

@@ -642,6 +642,60 @@ impl WebDriverBiDiSession {
     ) -> Result<EmptyResult, CommandError> {
         commands::emulation::set_geolocation_override(self, params).await
     }
+
+    // https://w3c.github.io/webdriver-bidi/#command-emulation-setLocaleOverride
+
+    /// Modifies locale on the given top-level traversables or user contexts.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `SetLocaleOverrideParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn set_locale_override(
+        &mut self,
+        params: SetLocaleOverrideParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::emulation::set_locale_override(self, params).await
+    }
+
+    // https://w3c.github.io/webdriver-bidi/#command-emulation-setScreenOrientationOverride
+
+    /// Emulates screen orientation of the given top-level traversables or user contexts.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `SetScreenOrientationOverrideParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn set_screen_orientation_override(
+        &mut self,
+        params: SetScreenOrientationOverrideParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::emulation::set_screen_orientation_override(self, params).await
+    }
+
+    // https://w3c.github.io/webdriver-bidi/#command-emulation-setTimezoneOverride
+
+    /// Modifies timezone on the given top-level traversables or user contexts.
+    ///
+    /// # Arguments
+    ///
+    /// * `params` - The parameters as a `SetTimezoneOverrideParameters` instance.
+    ///
+    /// # Returns
+    ///
+    /// A result containing the `EmptyResult` or a `CommandError`.
+    pub async fn set_timezone_override(
+        &mut self,
+        params: SetTimezoneOverrideParameters,
+    ) -> Result<EmptyResult, CommandError> {
+        commands::emulation::set_timezone_override(self, params).await
+    }
 }
 
 // Network commands