Merge pull request #1890 from input-output-hk/dlachaume/1878/mithril-client-future-proof-options

Add support for custom HTTP Headers in Mithril client WASM library

Author: dlachaume

CHANGELOG.md

@@ -10,6 +10,7 @@ As a minor extension, we have adopted a slightly different versioning convention
 ## Mithril Distribution [XXXX] - UNRELEASED
 
 - Support for Mithril nodes footprint support in Prometheus monitoring in infrastructure
+- Add support for custom HTTP headers in Mithril client WASM library
 
 - **UNSTABLE** Cardano stake distribution certification:
 

Cargo.lock

@@ -146,6 +146,28 @@ console.log(
 );
 ```
 
+:::tip Adding Custom HTTP Headers
+
+You can customize the HTTP headers sent by the Mithril client. This is particularly useful in scenarios where the Mithril client is used with a proxy, as it allows you to include headers like **Authorization** or custom headers for specific use cases. Below is an example of how to set custom headers:
+
+```js
+let http_headers_map = new Map();
+http_headers_map.set("Authorization", "Bearer YourBearerToken");
+http_headers_map.set("X-Custom-Header", "YourCustomHeaderValue");
+
+let client_options = {
+  http_headers: http_headers_map,
+};
+
+let client = new MithrilClient(
+  aggregator_endpoint,
+  genesis_verification_key,
+  client_options,
+);
+```
+
+:::
+
 If the aggregator signs **CardanoTransactions**, you can add the code below to the previous example:
 
 :::tip

docs/website/root/manual/developer-docs/nodes/mithril-client-library-wasm.md

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client-wasm"
-version = "0.3.9"
+version = "0.3.10"
 description = "Mithril client WASM"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-client-wasm/Cargo.toml

@@ -6,7 +6,8 @@ use wasm_bindgen::prelude::*;
 use mithril_client::{
     common::Epoch,
     feedback::{FeedbackReceiver, MithrilEvent},
-    CardanoTransactionsProofs, Client, ClientBuilder, MessageBuilder, MithrilCertificate,
+    CardanoTransactionsProofs, Client, ClientBuilder, ClientOptions, MessageBuilder,
+    MithrilCertificate,
 };
 
 use crate::WasmResult;
@@ -71,10 +72,24 @@ pub struct MithrilUnstableClient {
 impl MithrilClient {
     /// Constructor for wasm client
     #[wasm_bindgen(constructor)]
-    pub fn new(aggregator_endpoint: &str, genesis_verification_key: &str) -> MithrilClient {
+    pub fn new(
+        aggregator_endpoint: &str,
+        genesis_verification_key: &str,
+        options: JsValue,
+    ) -> MithrilClient {
         let feedback_receiver = Arc::new(JSBroadcastChannelFeedbackReceiver::new("mithril-client"));
+
+        let client_options = if options.is_undefined() {
+            ClientOptions::default()
+        } else {
+            serde_wasm_bindgen::from_value(options)
+                .map_err(|err| format!("Failed to parse options: {err:?}"))
+                .unwrap()
+        };
+
         let client = ClientBuilder::aggregator(aggregator_endpoint, genesis_verification_key)
             .add_feedback_receiver(feedback_receiver)
+            .with_options(client_options)
             .build()
             .map_err(|err| format!("{err:?}"))
             .unwrap();
@@ -361,8 +376,7 @@ impl MithrilUnstableClient {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use crate::test_data;
+    use std::collections::HashMap;
     use wasm_bindgen_test::*;
 
     use mithril_client::{
@@ -371,6 +385,10 @@ mod tests {
         MithrilStakeDistributionListItem, Snapshot, SnapshotListItem,
     };
 
+    use crate::test_data;
+
+    use super::*;
+
     const GENESIS_VERIFICATION_KEY: &str = "5b33322c3235332c3138362c3230312c3137372c31312c3131372c3133352c3138372c3136372c3138312c3138382c32322c35392c3230362c3130352c3233312c3135302c3231352c33302c37382c3231322c37362c31362c3235322c3138302c37322c3133342c3133372c3234372c3136312c36385d";
     const FAKE_AGGREGATOR_IP: &str = "127.0.0.1";
     const FAKE_AGGREGATOR_PORT: &str = "8000";
@@ -382,10 +400,55 @@ mod tests {
                 FAKE_AGGREGATOR_IP, FAKE_AGGREGATOR_PORT
             ),
             GENESIS_VERIFICATION_KEY,
+            JsValue::undefined(),
         )
     }
 
     wasm_bindgen_test_configure!(run_in_browser);
+
+    #[wasm_bindgen_test]
+    fn build_mithril_client_with_custom_http_header() {
+        let mut http_headers = HashMap::new();
+        http_headers.insert("Authorization".to_string(), "Bearer token".to_string());
+        let options = ClientOptions::new(Some(http_headers));
+        let options_js_value = serde_wasm_bindgen::to_value(&options).unwrap();
+
+        MithrilClient::new(
+            &format!(
+                "http://{}:{}/aggregator",
+                FAKE_AGGREGATOR_IP, FAKE_AGGREGATOR_PORT
+            ),
+            GENESIS_VERIFICATION_KEY,
+            options_js_value,
+        );
+    }
+
+    #[wasm_bindgen_test]
+    fn build_mithril_client_with_undefined_options() {
+        MithrilClient::new(
+            &format!(
+                "http://{}:{}/aggregator",
+                FAKE_AGGREGATOR_IP, FAKE_AGGREGATOR_PORT
+            ),
+            GENESIS_VERIFICATION_KEY,
+            JsValue::undefined(),
+        );
+    }
+
+    #[wasm_bindgen_test]
+    #[should_panic(expected = "Failed to parse options")]
+    fn build_mithril_client_with_unparsable_options() {
+        let invalid_js_value = JsValue::from_str("invalid");
+        MithrilClient::new(
+            &format!(
+                "http://{}:{}/aggregator",
+                FAKE_AGGREGATOR_IP, FAKE_AGGREGATOR_PORT
+            ),
+            GENESIS_VERIFICATION_KEY,
+            invalid_js_value,
+        );
+    }
+
     #[wasm_bindgen_test]
     async fn list_snapshots_should_return_value_convertible_in_rust_type() {
         let snapshots_list_js_value = get_mithril_client()

mithril-client-wasm/src/client_wasm.rs

@@ -64,9 +64,21 @@ function format_tx_list(transactions_hashes) {
   return "<ul>" + transactions_hashes.map((tx) => "<li>" + tx + "</li>").join("") + "</ul>";
 }
 
+function client_options_with_custom_headers() {
+  // The following header is set as an example.
+  // It's used to demonstrate how to add headers.
+  let http_headers_map = new Map();
+  http_headers_map.set("Content-Type", "application/json");
+
+  return {
+    http_headers: http_headers_map,
+  };
+}
+
 await initMithrilClient();
 
-let client = new MithrilClient(aggregator_endpoint, genesis_verification_key);
+let client_options = client_options_with_custom_headers();
+let client = new MithrilClient(aggregator_endpoint, genesis_verification_key, client_options);
 
 displayStepInDOM(1, "Getting stake distributions list...");
 let mithril_stake_distributions_list = await client.list_mithril_stake_distributions();

mithril-client-wasm/www-test/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "www",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "private": true,
   "scripts": {
     "build": "webpack --config webpack.config.js",

mithril-client-wasm/www/index.js

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-client"
-version = "0.8.13"
+version = "0.8.14"
 description = "Mithril client library"
 authors = { workspace = true }
 edition = { workspace = true }