Merge pull request #105 from kurrent-io/user-agent

Add user agent string so that backend can identity

Author: bshelton

Justfile

@@ -13,11 +13,11 @@ clean:
 
 # builds esc
 build:
-    cargo build --locked
+    ESC_CLIENT_VERSION={{`cargo metadata --no-deps --format-version 1 | jq -r '.packages[] | select(.name == "esc") | .version'` }} cargo build --locked
 
 # builds in release mode
 build-release:
-    cargo build --locked --release
+    ESC_CLIENT_VERSION={{`cargo metadata --no-deps --format-version 1 | jq -r '.packages[] | select(.name == "esc") | .version'` }} cargo build --locked --release
 
 # Formats the code base
 fmt:

base/src/client/builder.rs

@@ -1,8 +1,6 @@
-use crate::identity::Token;
-use crate::sender::RequestSender;
-use super::client::Client;
-use super::authorization::StaticTokenAuthorizer;
-
-fn static_token_client(token: Token) -> Client {
-    let authorizer = StaticTokenAut
-}
+pub fn build_http_client() -> reqwest::Client {
+    reqwest::Client::builder()
+        .user_agent(crate::version::user_agent())
+        .build()
+        .expect("Failed to build HTTP client")
+}

base/src/client/mod.rs

@@ -1,7 +1,9 @@
 #![allow(clippy::module_inception)]
 mod authorization;
+mod builder;
 mod client;
 
 pub use authorization::Authorization;
 pub use authorization::StaticTokenAuthorizer;
+pub use builder::build_http_client;
 pub use client::Client;

base/src/lib.rs

@@ -8,7 +8,9 @@ pub mod errors;
 pub mod identity;
 pub mod requests;
 pub mod utils;
+pub mod version;
 
+pub use client::build_http_client;
 pub use client::Authorization;
 pub use client::Client;
 pub use errors::EscError as Error;
@@ -17,3 +19,4 @@ pub use identity::tokens::Token;
 pub use requests::RequestObserver;
 pub use requests::RequestSender;
 pub use utils::urlencode;
+pub use version::user_agent;

base/src/requests/sender.rs

@@ -44,7 +44,8 @@ impl Sender {
             .request(method.clone(), url.as_str())
             .header("Authorization", authorization_header)
             .header("Content-Type", "application/json")
-            .header("Accept", "application/json");
+            .header("Accept", "application/json")
+            .header("User-Agent", &crate::version::user_agent());
         let req = match body {
             Some(b) => req.json(b),
             None => req,

base/src/sender.rs

@@ -51,7 +51,8 @@ impl RequestSender {
                 format!("{} {}", token.token_type, token.access_token),
             )
             .header("Content-Type", "application/json")
-            .header("Accept", "application/json");
+            .header("Accept", "application/json")
+            .header("User-Agent", &crate::version::user_agent());
         let req = match body {
             Some(b) => req.json(b),
             None => req,

base/src/version.rs

@@ -0,0 +1,29 @@
+/// The version of the ESC client, set at build time
+pub const CLIENT_VERSION: &str = match option_env!("ESC_CLIENT_VERSION") {
+    Some(v) => v,
+    None => env!("CARGO_PKG_VERSION"), // fallback to base crate version
+};
+
+/// Creates the user agent string for HTTP requests
+pub fn user_agent() -> String {
+    format!("esc-client/{}", CLIENT_VERSION)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_user_agent_format() {
+        let ua = user_agent();
+        assert!(ua.starts_with("esc-client/"));
+        // Should contain either the environment variable version or fallback version
+        assert!(ua.len() > "esc-client/".len());
+    }
+
+    #[test]
+    fn test_client_version_has_valid_format() {
+        // CLIENT_VERSION should contain version-like content (digits and dots)
+        assert!(CLIENT_VERSION.chars().any(|c| c.is_ascii_digit()));
+    }
+}

cli/src/main.rs

@@ -14,6 +14,7 @@ mod v1;
 
 use cidr::Cidr;
 use esc_api::resources::MfaStatus;
+use esc_client_base::build_http_client;
 
 use esc_api::{GroupId, MemberId, OrgId};
 use output::OutputFormat;
@@ -1902,7 +1903,7 @@ async fn get_token(
     refresh_token: Option<String>,
     noninteractive: bool,
 ) -> Result<esc_api::Token, Box<dyn std::error::Error>> {
-    let client = reqwest::Client::new();
+    let client = build_http_client();
     match refresh_token {
         Some(refresh_token) => {
             let otp_prompt: Option<esc_client_base::identity::operations::OtpPrompt> =
@@ -1966,7 +1967,7 @@ impl ClientBuilder {
             authorization_header: token.authorization_header(),
         };
         let sender = esc_api::RequestSender {
-            client: reqwest::Client::new(),
+            client: build_http_client(),
             observer: self.observer,
         };
         let client = esc_api::Client {
@@ -2166,7 +2167,7 @@ async fn call_api<'a, 'b>(
 
             AccessCommand::Tokens(tokens) => match tokens.tokens_command {
                 TokensCommand::Create(params) => {
-                    let client = reqwest::Client::new();
+                    let client = build_http_client();
                     let mut store = esc_client_store::token_store(token_config).await?;
 
                     match client_builder.noninteractive {