From c59e4bcbd47ce69866a247e523c1e601e32a16ab Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Wed, 24 Sep 2025 19:56:41 -0400 Subject: [PATCH] parse header --- Cargo.lock | 1 + .../up.sql | 2 +- crates/lib/actix_helpers/Cargo.toml | 17 +++-- .../src/extractors/get_request_user_agent.rs | 69 +++++++++++++++++++ .../lib/actix_helpers/src/extractors/mod.rs | 1 + .../analytics/log_app_active_user_handler.rs | 30 ++++++-- .../add_application_routes.rs | 6 +- .../application_routes/analytics_routes.rs | 26 +++++++ .../routes/application_routes/mod.rs | 3 +- 9 files changed, 138 insertions(+), 17 deletions(-) create mode 100644 crates/lib/actix_helpers/src/extractors/get_request_user_agent.rs create mode 100644 crates/service/web/storyteller_web/src/http_server/routes/application_routes/analytics_routes.rs diff --git a/Cargo.lock b/Cargo.lock index 7ba6cd13fb..7b7056fa6a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -366,6 +366,7 @@ dependencies = [ "cidr-utils", "errors", "futures-util", + "log", "num-traits", "serde", "serde_json", diff --git a/_sql/migrations/2025-09-24-055943_analytics_app_active_users/up.sql b/_sql/migrations/2025-09-24-055943_analytics_app_active_users/up.sql index 40ac46e7ba..6c20f9e9a1 100644 --- a/_sql/migrations/2025-09-24-055943_analytics_app_active_users/up.sql +++ b/_sql/migrations/2025-09-24-055943_analytics_app_active_users/up.sql @@ -14,7 +14,7 @@ CREATE TABLE analytics_app_active_users ( user_token VARCHAR(32) NOT NULL, -- App version is updated on every write. - app_version VARCHAR(32) NOT NULL, + app_version VARCHAR(255) NOT NULL, -- IP address is updated on every write. ip_address VARCHAR(40) NOT NULL, diff --git a/crates/lib/actix_helpers/Cargo.toml b/crates/lib/actix_helpers/Cargo.toml index 5d3d0a26b2..9537348a01 100644 --- a/crates/lib/actix_helpers/Cargo.toml +++ b/crates/lib/actix_helpers/Cargo.toml @@ -18,15 +18,18 @@ normal = ["workspace-build-acceleration"] [dependencies] # Workspace hack (faster compile times) -workspace-build-acceleration = { workspace = true } +workspace-build-acceleration.workspace = true # Internal -errors = { workspace = true } +errors.workspace = true + +# External +log.workspace = true # Actix -actix-http = { workspace = true } -actix-service = { workspace = true } -actix-web = { workspace = true } +actix-http.workspace = true +actix-service.workspace = true +actix-web.workspace = true # IPv4 and v6 CIDRs (crate has few dependencies) cidr-utils = "0.5.11" @@ -36,8 +39,8 @@ num-traits = "0.2.17" # for cidr-utils futures-util = "0.3.29" # Serialization -serde = { workspace = true } -serde_json = { workspace = true } +serde.workspace = true +serde_json.workspace = true [dev-dependencies] # None yet diff --git a/crates/lib/actix_helpers/src/extractors/get_request_user_agent.rs b/crates/lib/actix_helpers/src/extractors/get_request_user_agent.rs new file mode 100644 index 0000000000..9abfc467d5 --- /dev/null +++ b/crates/lib/actix_helpers/src/extractors/get_request_user_agent.rs @@ -0,0 +1,69 @@ +use actix_web::http::header::{ToStrError, USER_AGENT}; +use actix_web::HttpRequest; +use log::warn; + +pub fn get_request_user_agent(request: &HttpRequest) -> Option<&str> { + let result = try_get_request_user_agent(request); + result.unwrap_or_else(|err| { + warn!("Error parsing User-Agent header: {}", err); + None + }) +} + +fn try_get_request_user_agent(request: &HttpRequest) -> Result, ToStrError> { + Ok(request.headers() + .get(USER_AGENT) + .map(|value| value.to_str()) + .transpose()? + .filter(|value| !value.is_empty())) +} + +#[cfg(test)] +mod tests { + use actix_web::test::TestRequest; + + use crate::extractors::get_request_user_agent::get_request_user_agent; + + #[test] + fn missing_user_agent() { + let request = TestRequest::default() + .to_http_request(); + + let origin = get_request_user_agent(&request); + + assert_eq!(origin, None); + } + + #[test] + fn empty_string_user_agent() { + let request = TestRequest::default() + .insert_header(("User-Agent", "")) + .to_http_request(); + + let origin = get_request_user_agent(&request); + + assert_eq!(origin, None); + } + + #[test] + fn user_agent() { + let request = TestRequest::default() + .insert_header(("User-Agent", "Blah Blah")) + .to_http_request(); + + let origin = get_request_user_agent(&request); + + assert_eq!(origin, Some("Blah Blah")); + } + + #[test] + fn user_agent_lower_case() { + let request = TestRequest::default() + .insert_header(("user-agent", "foo/1.0")) + .to_http_request(); + + let origin = get_request_user_agent(&request); + + assert_eq!(origin, Some("foo/1.0")); + } +} diff --git a/crates/lib/actix_helpers/src/extractors/mod.rs b/crates/lib/actix_helpers/src/extractors/mod.rs index 85db420fae..a0820b3c58 100644 --- a/crates/lib/actix_helpers/src/extractors/mod.rs +++ b/crates/lib/actix_helpers/src/extractors/mod.rs @@ -1,5 +1,6 @@ pub mod get_request_host; pub mod get_request_origin_uri; +pub mod get_request_user_agent; pub mod get_service_request_ip_address; // Utility diff --git a/crates/service/web/storyteller_web/src/http_server/endpoints/analytics/log_app_active_user_handler.rs b/crates/service/web/storyteller_web/src/http_server/endpoints/analytics/log_app_active_user_handler.rs index 39a4a87601..0ca1f2cfbb 100644 --- a/crates/service/web/storyteller_web/src/http_server/endpoints/analytics/log_app_active_user_handler.rs +++ b/crates/service/web/storyteller_web/src/http_server/endpoints/analytics/log_app_active_user_handler.rs @@ -2,12 +2,13 @@ use std::sync::Arc; use crate::http_server::common_responses::common_web_error::CommonWebError; use crate::state::server_state::ServerState; -use actix_web::web::Json; +use actix_web::web::{Json, Query}; use actix_web::{web, HttpRequest}; use enums::common::payments_namespace::PaymentsNamespace; use http_server_common::request::get_request_ip::get_request_ip; use mysql_queries::queries::analytics_active_users::upsert_analytics_app_active_user::UpsertAnalyticsAppActiveUser; use utoipa::ToSchema; +use actix_helpers::extractors::get_request_user_agent::get_request_user_agent; #[derive(Deserialize, ToSchema)] pub struct LogAppActiveUserRequest { @@ -32,9 +33,9 @@ pub struct LogAppActiveUserResponse { ("request" = LogAppActiveUserRequest, description = "Payload for Request"), ) )] -pub async fn log_browser_session_handler( +pub async fn log_app_active_user_handler( http_request: HttpRequest, - request: Json, + request: Query, server_state: web::Data>, ) -> Result, CommonWebError> { @@ -53,15 +54,30 @@ pub async fn log_browser_session_handler( let ip_address = get_request_ip(&http_request); - let app_version = request.maybe_app_version - .as_deref() - .unwrap_or("unknown"); + let app_version = { + let user_agent = get_request_user_agent(&http_request); + + let mut maybe_version = None; + + if let Some(user_agent) = user_agent { + maybe_version = Some(user_agent.to_string()); + }; + + if let Some(version) = request.maybe_app_version.as_deref() { + let version = version.trim().to_string(); + if !version.is_empty() { + maybe_version = Some(version); + } + } + + maybe_version.unwrap_or_else(|| "unknown".to_string()) + }; let upsert = UpsertAnalyticsAppActiveUser { namespace: PaymentsNamespace::Artcraft, user_token: &user_token, ip_address: &ip_address, - app_version, + app_version: &app_version, }; upsert.upsert_with_connection(&mut mysql_connection).await?; diff --git a/crates/service/web/storyteller_web/src/http_server/routes/application_routes/add_application_routes.rs b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/add_application_routes.rs index 9c2d1e9659..5a4493b4ed 100644 --- a/crates/service/web/storyteller_web/src/http_server/routes/application_routes/add_application_routes.rs +++ b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/add_application_routes.rs @@ -1,3 +1,4 @@ +use crate::http_server::routes::application_routes::analytics_routes::add_analytics_routes; use crate::http_server::routes::application_routes::comments_routes::add_comments_routes; use crate::http_server::routes::application_routes::credits_routes::add_credits_routes; use crate::http_server::routes::application_routes::featured_item_routes::add_featured_item_routes; @@ -5,6 +6,7 @@ use crate::http_server::routes::application_routes::generate_routes::add_generat use crate::http_server::routes::application_routes::job_routes::add_job_routes; use crate::http_server::routes::application_routes::media_files_routes::add_media_file_routes; use crate::http_server::routes::application_routes::moderation_routes::add_moderator_routes; +use crate::http_server::routes::application_routes::prompts_routes::add_prompts_routes; use crate::http_server::routes::application_routes::stripe_artcraft_routes::add_stripe_artcraft_routes; use crate::http_server::routes::application_routes::subscription_routes::add_subscription_routes; use crate::http_server::routes::application_routes::tag_routes::add_tag_routes; @@ -20,7 +22,6 @@ use actix_service::ServiceFactory; use actix_web::dev::{ServiceRequest, ServiceResponse}; use actix_web::{App, Error}; use billing_component::default_routes::add_suggested_stripe_billing_routes; -use crate::http_server::routes::application_routes::prompts_routes::add_prompts_routes; /// Add the core application routes. pub fn add_application_routes (app: App) -> App @@ -55,6 +56,9 @@ where // Job system app = add_job_routes(app); + // Other useful tools + app = add_analytics_routes(app); // /v1/analytics/... + // User and user-adjacent routes app = add_comments_routes(app); // /v1/comments/... app = add_user_bookmarks_routes(app); // /v1/user_bookmarks/... diff --git a/crates/service/web/storyteller_web/src/http_server/routes/application_routes/analytics_routes.rs b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/analytics_routes.rs new file mode 100644 index 0000000000..32df226c52 --- /dev/null +++ b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/analytics_routes.rs @@ -0,0 +1,26 @@ +use crate::http_server::endpoints::analytics::log_app_active_user_handler::log_app_active_user_handler; +use actix_http::body::MessageBody; +use actix_service::ServiceFactory; +use actix_web::dev::{ServiceRequest, ServiceResponse}; +use actix_web::error::Error; +use actix_web::{web, App, HttpResponse}; + + +pub fn add_analytics_routes (app: App) -> App +where + B: MessageBody, + T: ServiceFactory< + ServiceRequest, + Config = (), + Response = ServiceResponse, + Error = Error, + InitError = (), + >, +{ + app.service(web::scope("/v1/analytics") + .service(web::resource("/active_user") + .route(web::get().to(log_app_active_user_handler)) + .route(web::head().to(|| HttpResponse::Ok())) + ) + ) +} diff --git a/crates/service/web/storyteller_web/src/http_server/routes/application_routes/mod.rs b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/mod.rs index 2580a281b3..621722a439 100644 --- a/crates/service/web/storyteller_web/src/http_server/routes/application_routes/mod.rs +++ b/crates/service/web/storyteller_web/src/http_server/routes/application_routes/mod.rs @@ -16,4 +16,5 @@ mod voice_conversion_routes; mod webhook_routes; mod weights_routes; pub (super) mod add_application_routes; -mod prompts_routes; \ No newline at end of file +mod prompts_routes; +mod analytics_routes; \ No newline at end of file