parse header

This commit is contained in:
Brandon Thomas committed 2025-09-24 19:56:41 -04:00
1 parent 33f659a1ff
commit c59e4bcbd4
9 files changed
+138 -17

No files matched your search

Generated
+1
View File
@@ -366,6 +366,7 @@ dependencies = [
"cidr-utils",
"errors",
"futures-util",
"log",
"num-traits",
"serde",
"serde_json",
@@ -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,
+10 -7
View File
@@ -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
@@ -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<Option<&str>, 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"));
}
}
@@ -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
@@ -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<LogAppActiveUserRequest>,
request: Query<LogAppActiveUserRequest>,
server_state: web::Data<Arc<ServerState>>,
) -> Result<Json<LogAppActiveUserResponse>, 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?;
@@ -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<T, B> (app: App<T>) -> App<T>
@@ -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/...
@@ -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<T, B> (app: App<T>) -> App<T>
where
B: MessageBody,
T: ServiceFactory<
ServiceRequest,
Config = (),
Response = ServiceResponse<B>,
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()))
)
)
}
@@ -16,4 +16,5 @@ mod voice_conversion_routes;
mod webhook_routes;
mod weights_routes;
pub (super) mod add_application_routes;
mod prompts_routes;
mod prompts_routes;
mod analytics_routes;