skyzen 0.2.1

A fast, ergonomic HTTP framework that works everywhere
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use crate::{extract::Extractor, Request, StatusCode};

use core::future::{ready, Future};
use serde::de::DeserializeOwned;
use serde_html_form::from_str;

/// Parse query from Uri.
///
/// Repeated keys collect into a sequence, so `?tags=a&tags=b` deserializes into a
/// `tags: Vec<String>` field.
#[derive(Debug, Clone)]
pub struct Query<T>(pub T);

impl_deref!(Query);

/// An error occurred while parsing the query string.
///
/// Carries the deserializer's own message so the 4xx response tells the caller which parameter
/// was wrong, rather than only saying that something was.
#[skyzen::error(
    message = "Failed to parse query string: {0}",
    status = StatusCode::BAD_REQUEST
)]
pub struct QueryError(String);

impl<T: Send + Sync + DeserializeOwned + crate::ToSchema + 'static> Extractor for Query<T> {
    type Error = QueryError;
    // The query string is already on the request, so the future is ready on creation rather than
    // an `async` block with nothing to await.
    fn extract(request: &mut Request) -> impl Future<Output = Result<Self, Self::Error>> + Send {
        let data = request.uri().query().unwrap_or_default();
        ready(from_str(data).map(Self).map_err(|error| {
            tracing::debug!(%error, "failed to parse query string");
            QueryError(error.to_string())
        }))
    }

    #[cfg(feature = "openapi")]
    fn openapi() -> Option<crate::openapi::ExtractorSchema> {
        Some(crate::openapi::ExtractorSchema {
            location: crate::openapi::ParameterLocation::Query,
            content_type: None,
            schema: crate::openapi::schema_of::<T>(),
        })
    }

    #[cfg(feature = "openapi")]
    fn register_openapi_schemas(
        defs: &mut std::collections::BTreeMap<String, crate::openapi::SchemaRef>,
    ) {
        crate::openapi::register_schema_for::<T>(defs);
    }
}

#[cfg(test)]
mod tests {
    use super::Query;
    use crate::{Body, Method, StatusCode};
    use http_kit::HttpError;
    use serde::Deserialize;
    use skyzen_core::Extractor;

    #[derive(Debug, Deserialize, PartialEq, crate::ToSchema)]
    struct Search {
        q: String,
        page: u8,
    }

    #[derive(Debug, Deserialize, PartialEq, crate::ToSchema)]
    struct Filter {
        tags: Option<Vec<String>>,
    }

    #[tokio::test]
    async fn collects_repeated_keys_into_a_sequence() {
        let mut request = request("http://localhost/search?tags=a&tags=b");
        let Query(filter) = Query::<Filter>::extract(&mut request).await.unwrap();
        assert_eq!(
            filter.tags.as_deref(),
            Some(["a".to_owned(), "b".to_owned()].as_slice())
        );
    }

    #[tokio::test]
    async fn an_absent_sequence_stays_none() {
        let mut request = request("http://localhost/search");
        let Query(filter) = Query::<Filter>::extract(&mut request).await.unwrap();
        assert_eq!(filter.tags, None);
    }

    #[tokio::test]
    async fn parses_struct_from_query_string() {
        let mut request = request("http://localhost/search?q=rust&page=2");
        let Query(search) = Query::<Search>::extract(&mut request).await.unwrap();
        assert_eq!(
            search,
            Search {
                q: "rust".into(),
                page: 2
            }
        );
    }

    #[tokio::test]
    async fn surfaces_bad_request_for_invalid_payload() {
        let mut request = request("http://localhost/search?q=rust&page=two");
        let error = Query::<Search>::extract(&mut request).await.unwrap_err();
        assert_eq!(error.status(), StatusCode::BAD_REQUEST);
        let message = error.to_string();
        assert!(
            message.starts_with("Failed to parse query string: "),
            "rejection should keep its prefix, got {message}"
        );
        assert!(
            message.contains("invalid digit"),
            "rejection should carry the deserializer detail, got {message}"
        );
    }
    fn request(uri: &str) -> http_kit::Request {
        let mut request = http_kit::Request::new(Body::empty());
        *request.uri_mut() = uri.parse().expect("invalid uri");
        *request.method_mut() = Method::GET;
        request
    }
}