topcoat-router 0.9.0

A modular, batteries-included Rust web framework for server-rendered apps.
Documentation 
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

use http::header::{CONTENT_TYPE, HeaderValue};
use topcoat_core::{context::Cx, error::Result};

use crate::{
    Body,
    error::bad_request,
    request::{FromRequest, OptionalFromRequest, content_type},
    response::{IntoResponse, Response},
};

/// HTML request extractor and response wrapper.
///
/// As a response, wrap any value convertible into a [`Body`] (such as a
/// `String`) to reply with `Content-Type: text/html`. Rendered pages are
/// wrapped in `Html` automatically; use it directly from a
/// [`route`](../topcoat_router_macro/attr.route.html) that returns markup by hand.
///
/// As a request extractor, `Html<String>` requires a `Content-Type: text/html`
/// header and yields the body as text.
#[derive(Debug, Clone, Copy, Default)]
#[must_use]
pub struct Html<T>(pub T);

impl<T> From<T> for Html<T> {
    fn from(value: T) -> Self {
        Self(value)
    }
}

impl FromRequest for Html<String> {
    async fn from_request(cx: &Cx, body: Body) -> Result<Self> {
        if !html_content_type(content_type(cx)) {
            return Err(bad_request("expected request with `Content-Type: text/html`").into());
        }

        Ok(Self(String::from_request(cx, body).await?))
    }
}

impl OptionalFromRequest for Html<String> {
    async fn from_request(cx: &Cx, body: Body) -> Result<Option<Self>> {
        if content_type(cx).is_some() {
            Ok(Some(<Self as FromRequest>::from_request(cx, body).await?))
        } else {
            Ok(None)
        }
    }
}

impl<T> IntoResponse for Html<T>
where
    T: Into<Body>,
{
    fn into_response(self, cx: &Cx) -> Result<Response> {
        (
            [(
                CONTENT_TYPE,
                HeaderValue::from_static("text/html; charset=utf-8"),
            )],
            self.0.into(),
        )
            .into_response(cx)
    }
}

fn html_content_type(content_type: Option<&str>) -> bool {
    let Some(content_type) = content_type else {
        return false;
    };

    content_type
        .split(';')
        .next()
        .unwrap_or_default()
        .trim()
        .eq_ignore_ascii_case("text/html")
}

#[cfg(test)]
mod tests {
    use http::{Request, header::CONTENT_TYPE};
    use topcoat_core::context::{Cx, CxTestBuilder};

    use super::*;
    use crate::{error::BadRequestError, to_bytes};

    /// Builds a `Cx` carrying request `Parts` with the given `Content-Type`
    /// header, or no header at all when `content_type` is [`None`].
    fn cx_with_content_type(content_type: Option<&str>) -> Cx {
        let mut builder = Request::builder();
        if let Some(content_type) = content_type {
            builder = builder.header(CONTENT_TYPE, content_type);
        }

        let (parts, ()) = builder.body(()).expect("request should build").into_parts();

        CxTestBuilder::new().request_context(parts).build()
    }

    #[tokio::test]
    async fn from_request_reads_html_body_as_text() {
        let cx = cx_with_content_type(Some("text/html; charset=utf-8"));
        let Html(text) =
            <Html<String> as FromRequest>::from_request(&cx, Body::from("<h1>hi</h1>"))
                .await
                .expect("a valid HTML body");

        assert_eq!(text, "<h1>hi</h1>");
    }

    #[tokio::test]
    async fn from_request_without_html_content_type_is_bad_request() {
        for content_type in [None, Some("application/json")] {
            let cx = cx_with_content_type(content_type);
            let error = <Html<String> as FromRequest>::from_request(&cx, Body::from("<p>x</p>"))
                .await
                .expect_err("a non-HTML content type is rejected");

            assert!(error.downcast_ref::<BadRequestError>().is_some());
        }
    }

    #[tokio::test]
    async fn from_request_rejects_non_utf8_body() {
        let cx = cx_with_content_type(Some("text/html"));
        let error = <Html<String> as FromRequest>::from_request(&cx, Body::from(vec![0xff, 0xfe]))
            .await
            .expect_err("an invalid UTF-8 body is rejected");

        assert!(error.downcast_ref::<BadRequestError>().is_some());
    }

    #[tokio::test]
    async fn optional_from_request_without_content_type_is_none() {
        let cx = cx_with_content_type(None);
        let html = <Html<String> as OptionalFromRequest>::from_request(&cx, Body::empty())
            .await
            .expect("an absent content type is not an error");

        assert!(html.is_none());
    }

    #[tokio::test]
    async fn optional_from_request_with_content_type_is_some() {
        let cx = cx_with_content_type(Some("text/html"));
        let html = <Html<String> as OptionalFromRequest>::from_request(&cx, Body::from("<p>x</p>"))
            .await
            .expect("a valid HTML body is not an error");

        assert_eq!(html.expect("an HTML payload is present").0, "<p>x</p>");
    }

    #[tokio::test]
    async fn into_response_sets_html_content_type() {
        let response = Html("<h1>hi</h1>")
            .into_response(&Cx::default())
            .expect("response builds");

        assert_eq!(
            response
                .headers()
                .get(CONTENT_TYPE)
                .map(http::HeaderValue::as_bytes),
            Some(b"text/html; charset=utf-8".as_slice())
        );

        let body = to_bytes(response.into_body(), usize::MAX)
            .await
            .expect("reading the response body");
        assert_eq!(&body[..], b"<h1>hi</h1>");
    }

    #[test]
    fn html_content_type_recognizes_html_media_types() {
        assert!(html_content_type(Some("text/html")));
        assert!(html_content_type(Some("text/html; charset=utf-8")));
        assert!(html_content_type(Some("TEXT/HTML")));

        assert!(!html_content_type(None));
        assert!(!html_content_type(Some("application/json")));
        assert!(!html_content_type(Some("text/plain")));
    }
}