Adding OHTTP to viaduct (#6935)

* New viaduct backend

Added a new viaduct backend trait.  The new backend is UniFFI and
async-based and handles settings slightly differently.  See the
`new_backend` module for the transition plan.

Added the `hyper` backend to `viaduct` directly.  I don't think we
really need to have different crates for each backend, we can use
feature flags instead.  This replaces `viaduct-dev` which I did that for
all the CLI crates and the plan is to move iOS from `viaduct-reqwest` to
the hyper backend.

Made some tweaks to `Error` so that it's UniFFI compatible.  Also,
renamed it to `ViaductError` to avoid name conflicts on Swift.

* Bug 1987449: Adding OHTTP to viaduct

* Bug 1987449: Adding OHTTP to viaduct

- Additional, adding libclang-dev to Dockerfile for ohttp crate to be built

Author: gruberb

Cargo.lock

@@ -459,6 +459,7 @@ The following text applies to code linked from these dependencies:
 [askama](https://github.com/askama-rs/askama),
 [askama_derive](https://github.com/askama-rs/askama),
 [askama_parser](https://github.com/askama-rs/askama),
+[async-lock](https://github.com/smol-rs/async-lock),
 [async-trait](https://github.com/dtolnay/async-trait),
 [autocfg](https://github.com/cuviper/autocfg),
 [base64](https://github.com/marshallpierce/rust-base64),
@@ -473,9 +474,11 @@ The following text applies to code linked from these dependencies:
 [cfg-if](https://github.com/alexcrichton/cfg-if),
 [chrono](https://github.com/chronotope/chrono),
 [clang-sys](https://github.com/KyleMayes/clang-sys),
+[concurrent-queue](https://github.com/smol-rs/concurrent-queue),
 [core-foundation-sys](https://github.com/servo/core-foundation-rs),
 [core-foundation](https://github.com/servo/core-foundation-rs),
 [cpufeatures](https://github.com/RustCrypto/utils),
+[crossbeam-utils](https://github.com/crossbeam-rs/crossbeam),
 [crypto-common](https://github.com/RustCrypto/traits),
 [digest](https://github.com/RustCrypto/traits),
 [displaydoc](https://github.com/yaahc/displaydoc),
@@ -484,6 +487,8 @@ The following text applies to code linked from these dependencies:
 [env_logger](https://github.com/rust-cli/env_logger),
 [equivalent](https://github.com/cuviper/equivalent),
 [errno](https://github.com/lambda-fairy/rust-errno),
+[event-listener-strategy](https://github.com/smol-rs/event-listener-strategy),
+[event-listener](https://github.com/smol-rs/event-listener),
 [fallible-iterator](https://github.com/sfackler/rust-fallible-iterator),
 [fallible-streaming-iterator](https://github.com/sfackler/fallible-streaming-iterator),
 [fastrand](https://github.com/smol-rs/fastrand),
@@ -537,6 +542,7 @@ The following text applies to code linked from these dependencies:
 [openssl-probe](https://github.com/alexcrichton/openssl-probe),
 [openssl-src](https://github.com/alexcrichton/openssl-src-rs),
 [openssl](https://github.com/sfackler/rust-openssl),
+[parking](https://github.com/smol-rs/parking),
 [parking_lot](https://github.com/Amanieu/parking_lot),
 [parking_lot_core](https://github.com/Amanieu/parking_lot),
 [paste](https://github.com/dtolnay/paste),
@@ -570,6 +576,7 @@ The following text applies to code linked from these dependencies:
 [serde_derive](https://github.com/serde-rs/serde),
 [serde_json](https://github.com/serde-rs/json),
 [serde_path_to_error](https://github.com/dtolnay/path-to-error),
+[serde_spanned](https://github.com/toml-rs/toml),
 [serde_urlencoded](https://github.com/nox/serde_urlencoded),
 [sha2](https://github.com/RustCrypto/hashes),
 [shlex](https://github.com/comex/rust-shlex),
@@ -587,6 +594,10 @@ The following text applies to code linked from these dependencies:
 [tinyvec](https://github.com/Lokathor/tinyvec),
 [tinyvec_macros](https://github.com/Soveu/tinyvec_macros),
 [toml](https://github.com/alexcrichton/toml-rs),
+[toml](https://github.com/toml-rs/toml),
+[toml_datetime](https://github.com/toml-rs/toml),
+[toml_parser](https://github.com/toml-rs/toml),
+[toml_writer](https://github.com/toml-rs/toml),
 [typenum](https://github.com/paholg/typenum),
 [unicase](https://github.com/seanmonstar/unicase),
 [unicode-normalization](https://github.com/unicode-rs/unicode-normalization),

DEPENDENCIES.md

@@ -7,8 +7,11 @@ license = "MPL-2.0"
 exclude = ["/android"]
 
 [features]
+default = []
 keydb = ["nss/keydb"]
+ohttp = ["viaduct/ohttp"]
 
 [dependencies]
 uniffi = { version = "0.29.0" }
 nss = { path = "../support/rc_crypto/nss" }
+viaduct = { path = "../viaduct", optional = true }

components/init_rust_components/Cargo.toml

@@ -7,7 +7,8 @@
 use nss::ensure_initialized as ensure_nss_initialized;
 #[cfg(feature = "keydb")]
 use nss::ensure_initialized_with_profile_dir as ensure_nss_initialized_with_profile_dir;
-
+#[cfg(feature = "ohttp")]
+use viaduct::ohttp::configure_default_ohttp_channels;
 uniffi::setup_scaffolding!();
 
 /// Global initialization routines for Rust components. Must be called before any other calls to
@@ -20,6 +21,12 @@ uniffi::setup_scaffolding!();
 #[uniffi::export]
 pub fn initialize() {
     ensure_nss_initialized();
+
+    #[cfg(feature = "ohttp")]
+    {
+        configure_default_ohttp_channels()
+            .expect("We pass down hard coded Strings for the relays, if this fails, we have a typo in the config we pass down.");
+    }
 }
 
 /// Global initialization routines for Rust components, when `logins/keydb` feature is activated. Must be
@@ -34,4 +41,10 @@ pub fn initialize() {
 #[uniffi::export]
 pub fn initialize(profile_path: String) {
     ensure_nss_initialized_with_profile_dir(profile_path);
+
+    #[cfg(feature = "ohttp")]
+    {
+        configure_default_ohttp_channels()
+            .expect("We pass down hard coded Strings for the relays, if this fails, we have a typo in the config we pass down.");
+    }
 }

components/init_rust_components/src/lib.rs

@@ -49,7 +49,11 @@ pub fn init_backend_dev() {
 
 #[async_trait::async_trait]
 impl Backend for HyperBackend {
-    async fn send_request(&self, request: Request, settings: ClientSettings) -> Result<Response> {
+    async fn send_request(
+        &self,
+        request: Request,
+        settings: ClientSettings,
+    ) -> Result<Response, ViaductError> {
         let handle = self.runtime.handle().clone();
         let client = self.client.clone();
         match handle

components/support/viaduct-dev/src/lib.rs

@@ -11,6 +11,7 @@ crate-type = ["lib"]
 
 [dependencies]
 async-trait = "0.1"
+async-lock = "3.3"
 error-support = { path = "../support/error" }
 url = "2"
 serde = "1"
@@ -22,3 +23,12 @@ prost = "0.12"
 ffi-support = "0.4"
 thiserror = "2"
 uniffi = { version = "0.29.0" }
+tokio = { version = "1", features = ["rt-multi-thread"], optional = true }
+hyper = { version = "0.14", features = ["client", "http1", "http2", "tcp"], optional = true }
+bhttp = { git = "https://github.com/martinthomson/ohttp.git", rev = "c6131ace4e4e82a4269afac3cb0524541d2cd315", optional = true }
+ohttp = { git = "https://github.com/martinthomson/ohttp.git", rev = "c6131ace4e4e82a4269afac3cb0524541d2cd315", features = ["client", "server", "app-svc", "external-sqlite"], default-features = false, optional = true }
+
+[features]
+default = ["ohttp"]
+backend-dev = ["dep:tokio", "dep:hyper"]
+ohttp = ["dep:bhttp", "dep:ohttp"]

components/viaduct/Cargo.toml

@@ -18,8 +18,40 @@ impl Client {
         Self { settings }
     }
 
+    /// Create a client that uses OHTTP with the specified channel for all requests
+    #[cfg(feature = "ohttp")]
+    pub fn with_ohttp_channel(
+        channel: &str,
+        settings: ClientSettings,
+    ) -> Result<Self, crate::ViaductError> {
+        if !crate::ohttp::is_ohttp_channel_configured(channel) {
+            return Err(crate::ViaductError::OhttpChannelNotConfigured(
+                channel.to_string(),
+            ));
+        }
+        let mut client_settings = settings;
+        client_settings.ohttp_channel = Some(channel.to_string());
+        Ok(Self {
+            settings: client_settings,
+        })
+    }
+
     pub async fn send(&self, request: Request) -> Result<Response> {
         validate_request(&request)?;
+
+        // Check if this client should use OHTTP for all requests
+        #[cfg(feature = "ohttp")]
+        if let Some(channel) = &self.settings.ohttp_channel {
+            crate::debug!(
+                "Client configured for OHTTP channel '{}', processing request via OHTTP",
+                channel
+            );
+            return crate::ohttp::process_ohttp_request(request, channel, self.settings.clone())
+                .await;
+        }
+
+        // For non-OHTTP requests, use the normal backend
+        crate::debug!("Processing request via standard backend");
         get_backend()?
             .send_request(request, self.settings.clone())
             .await
@@ -39,6 +71,9 @@ pub struct ClientSettings {
     // Maximum amount of redirects to follow (0 means redirects are not allowed)
     #[uniffi(default = 10)]
     pub redirect_limit: u32,
+    // OHTTP channel to use for all requests (if any)
+    #[cfg(feature = "ohttp")]
+    pub ohttp_channel: Option<String>,
 }
 
 impl Default for ClientSettings {
@@ -49,6 +84,8 @@ impl Default for ClientSettings {
             #[cfg(not(target_os = "ios"))]
             timeout: 10000,
             redirect_limit: 10,
+            #[cfg(feature = "ohttp")]
+            ohttp_channel: None,
         }
     }
 }

components/viaduct/src/client.rs

@@ -31,6 +31,21 @@ pub enum ViaductError {
 
     #[error("[no-sentry] Validation error: URL does not use TLS protocol.")]
     NonTlsUrl,
+
+    #[error("OHTTP channel '{0}' is not configured")]
+    OhttpChannelNotConfigured(String),
+
+    #[error("Failed to fetch OHTTP config: {0}")]
+    OhttpConfigFetchFailed(String),
+
+    #[error("OHTTP request error: {0}")]
+    OhttpRequestError(String),
+
+    #[error("OHTTP response error: {0}")]
+    OhttpResponseError(String),
+
+    #[error("OHTTP support is not enabled in this build")]
+    OhttpNotSupported,
 }
 
 impl ViaductError {

components/viaduct/src/error.rs

@@ -115,6 +115,18 @@ impl Headers {
         Default::default()
     }
 
+    /// Create headers from a HashMap of name-value pairs
+    ///
+    /// # Errors
+    /// Returns an error if any header name or value is invalid
+    pub fn try_from_hashmap(map: HashMap<String, String>) -> Result<Self, crate::ViaductError> {
+        let mut headers = Headers::new();
+        for (name, value) in map {
+            headers.insert(name, value)?;
+        }
+        Ok(headers)
+    }
+
     /// Initialize an empty list of headers backed by a vector with the provided
     /// capacity.
     pub fn with_capacity(c: usize) -> Self {

components/viaduct/src/headers.rs

@@ -13,6 +13,10 @@ mod backend;
 mod client;
 pub mod error;
 mod new_backend;
+#[cfg(feature = "ohttp")]
+pub mod ohttp;
+#[cfg(feature = "ohttp")]
+mod ohttp_client;
 pub mod settings;
 pub use error::*;
 // reexport logging helpers.
@@ -22,6 +26,8 @@ pub use backend::{note_backend, set_backend, Backend as OldBackend};
 pub use client::{Client, ClientSettings};
 pub use headers::{consts as header_names, Header, HeaderName, Headers, InvalidHeaderName};
 pub use new_backend::{init_backend, Backend};
+#[cfg(feature = "ohttp")]
+pub use ohttp::{clear_ohttp_channels, configure_ohttp_channel, list_ohttp_channels, OhttpConfig};
 pub use settings::{allow_android_emulator_loopback, GLOBAL_SETTINGS};
 
 #[allow(clippy::derive_partial_eq_without_eq)]