spikard 0.3.6 → 0.5.0

data/vendor/crates/spikard-http/src/middleware/mod.rs

@@ -9,14 +9,20 @@ pub mod validation;
 
 use axum::{
     body::Body,
+    extract::State,
     extract::{FromRequest, Multipart, Request},
     http::StatusCode,
     middleware::Next,
     response::{IntoResponse, Response},
 };
 use serde_json::json;
-use std::collections::HashMap;
-use std::sync::Arc;
+use std::cell::RefCell;
+use std::num::NonZeroUsize;
+
+thread_local! {
+    static URLENCODED_JSON_CACHE: RefCell<lru::LruCache<bytes::Bytes, bytes::Bytes>> =
+        RefCell::new(lru::LruCache::new(NonZeroUsize::new(256).expect("non-zero cache size")));
+}
 
 /// Route information for middleware validation
 #[derive(Debug, Clone)]
@@ -25,8 +31,12 @@ pub struct RouteInfo {
     pub expects_json_body: bool,
 }
 
-/// Registry of route metadata indexed by (method, path)
-pub type RouteRegistry = Arc<HashMap<(String, String), RouteInfo>>;
+/// Request extension carrying the already-collected request body.
+///
+/// This avoids double-reading the body stream: middleware can read once for
+/// content-length / syntax checks, and request extraction can reuse the bytes.
+#[derive(Debug, Clone)]
+pub struct PreReadBody(pub bytes::Bytes);
 
 /// Middleware to validate Content-Type headers and related requirements
 ///
@@ -50,7 +60,7 @@ pub type RouteRegistry = Arc<HashMap<(String, String), RouteInfo>>;
 /// # Behavior
 ///
 /// For request methods POST, PUT, and PATCH:
-/// 1. Checks if the route expects a JSON body (via `RouteRegistry`)
+/// 1. Checks if the route expects a JSON body (via route state)
 /// 2. Validates Content-Type headers based on route configuration
 /// 3. Parses the request body according to Content-Type:
 ///    - `multipart/form-data` → JSON (form fields as object properties)
@@ -76,99 +86,107 @@ pub type RouteRegistry = Arc<HashMap<(String, String), RouteInfo>>;
 /// // This is typically used as middleware in an Axum router:
 /// // router.layer(axum::middleware::from_fn(validate_content_type_middleware))
 /// ```
-pub async fn validate_content_type_middleware(request: Request, next: Next) -> Result<Response, Response> {
+///
+/// Coverage: Tested via integration tests (multipart and form parsing tested end-to-end)
+#[cfg(not(tarpaulin_include))]
+pub async fn validate_content_type_middleware(
+    State(route_info): State<RouteInfo>,
+    request: Request,
+    next: Next,
+) -> Result<Response, Response> {
     use axum::body::to_bytes;
     use axum::http::Request as HttpRequest;
 
-    let (parts, body) = request.into_parts();
+    let (mut parts, body) = request.into_parts();
     let headers = &parts.headers;
 
-    let route_info = parts.extensions.get::<RouteRegistry>().and_then(|registry| {
-        let method = parts.method.as_str();
-        let path = parts.uri.path();
-        registry.get(&(method.to_string(), path.to_string())).cloned()
-    });
-
     let method = &parts.method;
     if method == axum::http::Method::POST || method == axum::http::Method::PUT || method == axum::http::Method::PATCH {
-        if let Some(info) = &route_info
-            && info.expects_json_body
-        {
+        if route_info.expects_json_body {
             validation::validate_json_content_type(headers)?;
         }
 
         validation::validate_content_type_headers(headers, 0)?;
 
-        let (final_parts, final_body) = if let Some(content_type) = headers.get(axum::http::header::CONTENT_TYPE) {
-            if let Ok(content_type_str) = content_type.to_str() {
-                let parsed_mime = content_type_str.parse::<mime::Mime>().ok();
+        let out_bytes: bytes::Bytes = if let Some(content_type) = headers.get(axum::http::header::CONTENT_TYPE) {
+            // `validate_content_type_headers()` already enforced basic Content-Type validity for us.
+            let is_multipart = validation::is_multipart_form_data(content_type);
+            let is_form_urlencoded = validation::is_form_urlencoded(content_type);
 
-                let is_multipart = parsed_mime
-                    .as_ref()
-                    .map(|mime| mime.type_() == mime::MULTIPART && mime.subtype() == "form-data")
-                    .unwrap_or(false);
-
-                let is_form_urlencoded = parsed_mime
-                    .as_ref()
-                    .map(|mime| mime.type_() == mime::APPLICATION && mime.subtype() == "x-www-form-urlencoded")
-                    .unwrap_or(false);
-
-                if is_multipart {
-                    let mut response_headers = parts.headers.clone();
+            if is_multipart {
+                let body_bytes = match to_bytes(body, usize::MAX).await {
+                    Ok(bytes) => bytes,
+                    Err(_) => {
+                        let error_body = json!({
+                            "error": "Failed to read request body"
+                        });
+                        return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
+                    }
+                };
 
-                    let request = HttpRequest::from_parts(parts, body);
-                    let multipart = match Multipart::from_request(request, &()).await {
-                        Ok(mp) => mp,
-                        Err(e) => {
-                            let error_body = json!({
-                                "error": format!("Failed to parse multipart data: {}", e)
-                            });
-                            return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
-                        }
-                    };
+                validation::validate_content_length(headers, body_bytes.len())?;
 
-                    let json_body = match multipart::parse_multipart_to_json(multipart).await {
-                        Ok(json) => json,
-                        Err(e) => {
-                            let error_body = json!({
-                                "error": format!("Failed to process multipart data: {}", e)
-                            });
-                            return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
-                        }
-                    };
+                let mut parse_request = HttpRequest::new(Body::from(body_bytes));
+                *parse_request.headers_mut() = parts.headers.clone();
 
-                    let json_bytes = match serde_json::to_vec(&json_body) {
-                        Ok(bytes) => bytes,
-                        Err(e) => {
-                            let error_body = json!({
-                                "error": format!("Failed to serialize multipart data to JSON: {}", e)
-                            });
-                            return Err((StatusCode::INTERNAL_SERVER_ERROR, axum::Json(error_body)).into_response());
-                        }
-                    };
+                let multipart = match Multipart::from_request(parse_request, &()).await {
+                    Ok(mp) => mp,
+                    Err(e) => {
+                        let error_body = json!({
+                            "error": format!("Failed to parse multipart data: {}", e)
+                        });
+                        return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
+                    }
+                };
 
-                    response_headers.insert(
-                        axum::http::header::CONTENT_TYPE,
-                        axum::http::HeaderValue::from_static("application/json"),
-                    );
+                let json_body = match multipart::parse_multipart_to_json(multipart).await {
+                    Ok(json) => json,
+                    Err(e) => {
+                        let error_body = json!({
+                            "error": format!("Failed to process multipart data: {}", e)
+                        });
+                        return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
+                    }
+                };
 
-                    let mut new_request = axum::http::Request::new(Body::from(json_bytes));
-                    *new_request.headers_mut() = response_headers;
+                let json_bytes = match serde_json::to_vec(&json_body) {
+                    Ok(bytes) => bytes,
+                    Err(e) => {
+                        let error_body = json!({
+                            "error": format!("Failed to serialize multipart data to JSON: {}", e)
+                        });
+                        return Err((StatusCode::INTERNAL_SERVER_ERROR, axum::Json(error_body)).into_response());
+                    }
+                };
 
-                    return Ok(next.run(new_request).await);
-                } else if is_form_urlencoded {
-                    let body_bytes = match to_bytes(body, usize::MAX).await {
-                        Ok(bytes) => bytes,
-                        Err(_) => {
-                            let error_body = json!({
-                                "error": "Failed to read request body"
-                            });
-                            return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
-                        }
-                    };
+                parts.headers.insert(
+                    axum::http::header::CONTENT_TYPE,
+                    axum::http::HeaderValue::from_static("application/json"),
+                );
+                if let Ok(value) = axum::http::HeaderValue::from_str(&json_bytes.len().to_string()) {
+                    parts.headers.insert(axum::http::header::CONTENT_LENGTH, value);
+                }
+                bytes::Bytes::from(json_bytes)
+            } else if is_form_urlencoded {
+                let body_bytes = match to_bytes(body, usize::MAX).await {
+                    Ok(bytes) => bytes,
+                    Err(_) => {
+                        let error_body = json!({
+                            "error": "Failed to read request body"
+                        });
+                        return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
+                    }
+                };
 
-                    validation::validate_content_length(headers, body_bytes.len())?;
+                validation::validate_content_length(headers, body_bytes.len())?;
 
+                parts.headers.insert(
+                    axum::http::header::CONTENT_TYPE,
+                    axum::http::HeaderValue::from_static("application/json"),
+                );
+                if let Some(cached) = URLENCODED_JSON_CACHE.with(|cache| cache.borrow_mut().get(&body_bytes).cloned()) {
+                    cached
+                } else {
                     let json_body = if body_bytes.is_empty() {
                         serde_json::json!({})
                     } else {
@@ -193,42 +211,11 @@ pub async fn validate_content_type_middleware(request: Request, next: Next) -> R
                         }
                     };
 
-                    let mut new_parts = parts;
-                    new_parts.headers.insert(
-                        axum::http::header::CONTENT_TYPE,
-                        axum::http::HeaderValue::from_static("application/json"),
-                    );
-
-                    (new_parts, Body::from(json_bytes))
-                } else {
-                    let body_bytes = match to_bytes(body, usize::MAX).await {
-                        Ok(bytes) => bytes,
-                        Err(_) => {
-                            let error_body = json!({
-                                "error": "Failed to read request body"
-                            });
-                            return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
-                        }
-                    };
-
-                    validation::validate_content_length(headers, body_bytes.len())?;
-
-                    let is_json = parsed_mime
-                        .as_ref()
-                        .map(validation::is_json_content_type)
-                        .unwrap_or(false);
-
-                    if is_json
-                        && !body_bytes.is_empty()
-                        && serde_json::from_slice::<serde_json::Value>(&body_bytes).is_err()
-                    {
-                        let error_body = json!({
-                            "detail": "Invalid request format"
-                        });
-                        return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
-                    }
-
-                    (parts, Body::from(body_bytes))
+                    let json_bytes = bytes::Bytes::from(json_bytes);
+                    URLENCODED_JSON_CACHE.with(|cache| {
+                        cache.borrow_mut().put(body_bytes.clone(), json_bytes.clone());
+                    });
+                    json_bytes
                 }
             } else {
                 let body_bytes = match to_bytes(body, usize::MAX).await {
@@ -243,7 +230,18 @@ pub async fn validate_content_type_middleware(request: Request, next: Next) -> R
 
                 validation::validate_content_length(headers, body_bytes.len())?;
 
-                (parts, Body::from(body_bytes))
+                let should_validate_json = route_info.expects_json_body && validation::is_json_like(content_type);
+                if should_validate_json
+                    && !body_bytes.is_empty()
+                    && serde_json::from_slice::<serde_json::Value>(&body_bytes).is_err()
+                {
+                    let error_body = json!({
+                        "detail": "Invalid request format"
+                    });
+                    return Err((StatusCode::BAD_REQUEST, axum::Json(error_body)).into_response());
+                }
+
+                body_bytes
             }
         } else {
             let body_bytes = match to_bytes(body, usize::MAX).await {
@@ -257,11 +255,12 @@ pub async fn validate_content_type_middleware(request: Request, next: Next) -> R
             };
 
             validation::validate_content_length(headers, body_bytes.len())?;
-
-            (parts, Body::from(body_bytes))
+            body_bytes
         };
 
-        let request = HttpRequest::from_parts(final_parts, final_body);
+        parts.extensions.insert(PreReadBody(out_bytes));
+
+        let request = HttpRequest::from_parts(parts, Body::empty());
         Ok(next.run(request).await)
     } else {
         validation::validate_content_type_headers(headers, 0)?;
@@ -274,6 +273,8 @@ pub async fn validate_content_type_middleware(request: Request, next: Next) -> R
 #[cfg(test)]
 mod tests {
     use super::*;
+    use axum::body::Body;
+    use axum::http::Request;
 
     #[test]
     fn test_route_info_creation() {
@@ -282,4 +283,258 @@ mod tests {
         };
         assert!(info.expects_json_body);
     }
+
+    #[test]
+    fn test_route_info_expects_json_body_true() {
+        let info = RouteInfo {
+            expects_json_body: true,
+        };
+        assert_eq!(info.expects_json_body, true);
+    }
+
+    #[test]
+    fn test_route_info_expects_json_body_false() {
+        let info = RouteInfo {
+            expects_json_body: false,
+        };
+        assert_eq!(info.expects_json_body, false);
+    }
+
+    #[test]
+    fn test_request_with_zero_content_length() {
+        let headers = axum::http::HeaderMap::new();
+        assert!(headers.get(axum::http::header::CONTENT_LENGTH).is_none());
+    }
+
+    #[test]
+    fn test_request_with_very_large_content_length() {
+        let mut headers = axum::http::HeaderMap::new();
+        let large_size = usize::MAX - 1;
+        headers.insert(
+            axum::http::header::CONTENT_LENGTH,
+            axum::http::HeaderValue::from_str(&large_size.to_string()).unwrap(),
+        );
+        assert!(headers.get(axum::http::header::CONTENT_LENGTH).is_some());
+    }
+
+    #[test]
+    fn test_request_body_smaller_than_declared_length() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_LENGTH,
+            axum::http::HeaderValue::from_static("1000"),
+        );
+        let result = super::validation::validate_content_length(&headers, 500);
+        assert!(
+            result.is_err(),
+            "Should reject when actual body is smaller than declared"
+        );
+    }
+
+    #[test]
+    fn test_request_body_larger_than_declared_length() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_LENGTH,
+            axum::http::HeaderValue::from_static("500"),
+        );
+        let result = super::validation::validate_content_length(&headers, 1000);
+        assert!(
+            result.is_err(),
+            "Should reject when actual body is larger than declared"
+        );
+    }
+
+    #[test]
+    fn test_get_request_no_body_validation() {
+        let request = Request::builder()
+            .method(axum::http::Method::GET)
+            .uri("/api/users")
+            .body(Body::empty())
+            .unwrap();
+
+        let (parts, _body) = request.into_parts();
+        assert_eq!(parts.method, axum::http::Method::GET);
+    }
+
+    #[test]
+    fn test_delete_request_no_body_validation() {
+        let request = Request::builder()
+            .method(axum::http::Method::DELETE)
+            .uri("/api/users/1")
+            .body(Body::empty())
+            .unwrap();
+
+        let (parts, _body) = request.into_parts();
+        assert_eq!(parts.method, axum::http::Method::DELETE);
+    }
+
+    #[test]
+    fn test_post_request_requires_validation() {
+        let request = Request::builder()
+            .method(axum::http::Method::POST)
+            .uri("/api/users")
+            .body(Body::empty())
+            .unwrap();
+
+        let (parts, _body) = request.into_parts();
+        assert_eq!(parts.method, axum::http::Method::POST);
+    }
+
+    #[test]
+    fn test_put_request_requires_validation() {
+        let request = Request::builder()
+            .method(axum::http::Method::PUT)
+            .uri("/api/users/1")
+            .body(Body::empty())
+            .unwrap();
+
+        let (parts, _body) = request.into_parts();
+        assert_eq!(parts.method, axum::http::Method::PUT);
+    }
+
+    #[test]
+    fn test_patch_request_requires_validation() {
+        let request = Request::builder()
+            .method(axum::http::Method::PATCH)
+            .uri("/api/users/1")
+            .body(Body::empty())
+            .unwrap();
+
+        let (parts, _body) = request.into_parts();
+        assert_eq!(parts.method, axum::http::Method::PATCH);
+    }
+
+    #[test]
+    fn test_content_type_header_case_insensitive() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_TYPE,
+            axum::http::HeaderValue::from_static("application/json"),
+        );
+
+        assert!(headers.get(axum::http::header::CONTENT_TYPE).is_some());
+    }
+
+    #[test]
+    fn test_content_length_header_case_insensitive() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_LENGTH,
+            axum::http::HeaderValue::from_static("100"),
+        );
+
+        assert!(headers.get(axum::http::header::CONTENT_LENGTH).is_some());
+    }
+
+    #[test]
+    fn test_custom_headers_case_preserved() {
+        let mut headers = axum::http::HeaderMap::new();
+        let custom_header: axum::http::HeaderName = "X-Custom-Header".parse().unwrap();
+        headers.insert(custom_header.clone(), axum::http::HeaderValue::from_static("value"));
+
+        assert!(headers.get(&custom_header).is_some());
+    }
+
+    #[test]
+    fn test_multipart_boundary_minimal() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_TYPE,
+            axum::http::HeaderValue::from_static("multipart/form-data; boundary=x"),
+        );
+
+        let result = super::validation::validate_content_type_headers(&headers, 0);
+        assert!(result.is_ok(), "Minimal boundary should be accepted");
+    }
+
+    #[test]
+    fn test_multipart_boundary_with_numbers() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_TYPE,
+            axum::http::HeaderValue::from_static("multipart/form-data; boundary=boundary123456"),
+        );
+
+        let result = super::validation::validate_content_type_headers(&headers, 0);
+        assert!(result.is_ok());
+    }
+
+    #[test]
+    fn test_multipart_boundary_with_special_chars() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_TYPE,
+            axum::http::HeaderValue::from_static("multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"),
+        );
+
+        let result = super::validation::validate_content_type_headers(&headers, 0);
+        assert!(result.is_ok(), "Boundary with dashes should be accepted");
+    }
+
+    #[test]
+    fn test_multipart_empty_boundary() {
+        let mut headers = axum::http::HeaderMap::new();
+        headers.insert(
+            axum::http::header::CONTENT_TYPE,
+            axum::http::HeaderValue::from_static("multipart/form-data; boundary="),
+        );
+
+        let _result = super::validation::validate_content_type_headers(&headers, 0);
+        assert!(headers.get(axum::http::header::CONTENT_TYPE).is_some());
+    }
+
+    #[test]
+    fn test_invalid_json_body_detection() {
+        let invalid_json = r#"{"invalid": json without quotes}"#;
+        let _mime = "application/json".parse::<mime::Mime>().unwrap();
+
+        let result = serde_json::from_str::<serde_json::Value>(invalid_json);
+        assert!(result.is_err(), "Invalid JSON should fail parsing");
+    }
+
+    #[test]
+    fn test_valid_json_parsing() {
+        let valid_json = r#"{"key": "value"}"#;
+        let result = serde_json::from_str::<serde_json::Value>(valid_json);
+        assert!(result.is_ok(), "Valid JSON should parse successfully");
+    }
+
+    #[test]
+    fn test_empty_json_object() {
+        let empty_json = "{}";
+        let result = serde_json::from_str::<serde_json::Value>(empty_json);
+        assert!(result.is_ok());
+        let value = result.unwrap();
+        assert!(value.is_object());
+        assert_eq!(value.as_object().unwrap().len(), 0);
+    }
+
+    #[test]
+    fn test_form_data_mime_type() {
+        let mime = "multipart/form-data; boundary=xyz".parse::<mime::Mime>().unwrap();
+        assert_eq!(mime.type_(), mime::MULTIPART);
+        assert_eq!(mime.subtype(), "form-data");
+    }
+
+    #[test]
+    fn test_form_urlencoded_mime_type() {
+        let mime = "application/x-www-form-urlencoded".parse::<mime::Mime>().unwrap();
+        assert_eq!(mime.type_(), mime::APPLICATION);
+        assert_eq!(mime.subtype(), "x-www-form-urlencoded");
+    }
+
+    #[test]
+    fn test_json_mime_type() {
+        let mime = "application/json".parse::<mime::Mime>().unwrap();
+        assert_eq!(mime.type_(), mime::APPLICATION);
+        assert_eq!(mime.subtype(), mime::JSON);
+    }
+
+    #[test]
+    fn test_text_plain_mime_type() {
+        let mime = "text/plain".parse::<mime::Mime>().unwrap();
+        assert_eq!(mime.type_(), mime::TEXT);
+        assert_eq!(mime.subtype(), "plain");
+    }
 }