salvo_extra 0.94.0

Salvo is a powerful web framework that can make your work easier.
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

//! Middleware for limiting request size.
//!
//! # Example
//!
//! ```no_run
//! use std::fs::create_dir_all;
//! use std::path::Path;
//!
//! use salvo_core::prelude::*;
//! use salvo_extra::size_limiter::max_size;
//!
//! #[handler]
//! async fn index(res: &mut Response) {
//!     res.render(Text::Html(INDEX_HTML));
//! }
//! #[handler]
//! async fn upload(req: &mut Request, res: &mut Response) {
//!     let file = req.file("file").await;
//!     if let Some(file) = file {
//!         let dest = format!("temp/{}", file.name().unwrap_or("file"));
//!         tracing::debug!(dest, "upload file");
//!         if let Err(e) = std::fs::copy(file.path(), Path::new(&dest)) {
//!             res.status_code(StatusCode::INTERNAL_SERVER_ERROR);
//!             res.render(Text::Plain(format!("file not found in request: {e}")));
//!         } else {
//!             res.render(Text::Plain(format!("File uploaded to {dest}")));
//!         }
//!     } else {
//!         res.status_code(StatusCode::BAD_REQUEST);
//!         res.render(Text::Plain("file not found in request"));
//!     }
//! }
//!
//! #[tokio::main]
//! async fn main() {
//!     create_dir_all("temp").unwrap();
//!     let router = Router::new()
//!         .get(index)
//!         .push(
//!             Router::new()
//!                 .hoop(max_size(1024 * 1024 * 10))
//!                 .path("limited")
//!                 .post(upload),
//!         )
//!         .push(Router::with_path("unlimit").post(upload));
//!
//!     let acceptor = TcpListener::new("0.0.0.0:8698").bind().await;
//!     Server::new(acceptor).serve(router).await;
//! }
//!
//! static INDEX_HTML: &str = r#"<!DOCTYPE html>
//! <html>
//!     <head>
//!         <title>Upload file</title>
//!     </head>
//!     <body>
//!         <h1>Upload file</h1>
//!         <form action="/unlimit" method="post" enctype="multipart/form-data">
//!             <h3>Unlimit</h3>
//!             <input type="file" name="file" />
//!             <input type="submit" value="upload" />
//!         </form>
//!         <form action="/limited" method="post" enctype="multipart/form-data">
//!             <h3>Limited 10MiB</h3>
//!             <input type="file" name="file" />
//!             <input type="submit" value="upload" />
//!         </form>
//!     </body>
//! </html>
//! "#;
//! ```
use salvo_core::http::{Body, Request, Response, StatusError};
use salvo_core::{Depot, FlowCtrl, Handler, async_trait};

/// MaxSize limit for request size.
#[derive(Debug)]
pub struct MaxSize(pub u64);
#[async_trait]
impl Handler for MaxSize {
    async fn handle(
        &self,
        req: &mut Request,
        depot: &mut Depot,
        res: &mut Response,
        ctrl: &mut FlowCtrl,
    ) {
        if let Some(upper) = req.body().size_hint().upper()
            && upper > self.0
        {
            res.render(StatusError::payload_too_large());
            ctrl.skip_rest();
            return;
        }

        let max_size = request_limit(self.0);
        req.limit_body(max_size);
        ctrl.call_next(req, depot, res).await;
    }
}

#[inline]
fn request_limit(max_size: u64) -> usize {
    max_size.min(usize::MAX as u64) as usize
}

/// Create a new `MaxSize`.
#[inline]
#[must_use]
pub fn max_size(size: u64) -> MaxSize {
    MaxSize(size)
}

#[cfg(test)]
mod tests {
    use std::pin::Pin;
    use std::task::{Context, Poll};

    use salvo_core::BoxedError;
    use salvo_core::http::ParseError;
    use salvo_core::http::body::{Frame, ReqBody, SizeHint};
    use salvo_core::prelude::*;
    use salvo_core::test::{ResponseExt, TestClient};

    use super::*;

    #[handler]
    async fn hello() -> &'static str {
        "hello"
    }

    struct UnknownSizeBody {
        frame: Option<Frame<salvo_core::hyper::body::Bytes>>,
    }

    impl UnknownSizeBody {
        fn new(bytes: &'static [u8]) -> Self {
            Self {
                frame: Some(Frame::data(salvo_core::hyper::body::Bytes::from_static(
                    bytes,
                ))),
            }
        }
    }

    impl Body for UnknownSizeBody {
        type Data = salvo_core::hyper::body::Bytes;
        type Error = BoxedError;

        fn poll_frame(
            mut self: Pin<&mut Self>,
            _cx: &mut Context<'_>,
        ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>> {
            Poll::Ready(self.frame.take().map(Ok))
        }

        fn size_hint(&self) -> SizeHint {
            SizeHint::new()
        }
    }

    #[handler]
    async fn read_payload(req: &mut Request, res: &mut Response) {
        match req.payload().await {
            Ok(_) => res.render("ok"),
            Err(ParseError::PayloadTooLarge) => res.render(StatusError::payload_too_large()),
            Err(error) => res.render(StatusError::bad_request().brief(error.to_string())),
        }
    }

    #[tokio::test]
    async fn test_size_limiter() {
        let limit_handler = MaxSize(32);
        let router = Router::new()
            .hoop(limit_handler)
            .push(Router::with_path("hello").post(hello));
        let service = Service::new(router);

        let content = TestClient::post("http://127.0.0.1:5801/hello")
            .text("abc")
            .send(&service)
            .await
            .take_string()
            .await
            .unwrap();
        assert_eq!(content, "hello");

        let res = TestClient::post("http://127.0.0.1:5801/hello")
            .text("abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz")
            .send(&service)
            .await;
        assert_eq!(res.status_code.unwrap(), StatusCode::PAYLOAD_TOO_LARGE);
    }

    #[tokio::test]
    async fn test_size_limiter_limits_unknown_length_streaming_body() {
        let limit_handler = MaxSize(4);
        let router = Router::new()
            .hoop(limit_handler)
            .push(Router::with_path("upload").post(read_payload));
        let service = Service::new(router);
        let body = ReqBody::Boxed {
            inner: Box::pin(UnknownSizeBody::new(b"too large")),
            fuse_config: None,
        };

        let res = TestClient::post("http://127.0.0.1:5801/upload")
            .body(body)
            .send(&service)
            .await;

        assert_eq!(res.status_code.unwrap(), StatusCode::PAYLOAD_TOO_LARGE);
    }

    #[test]
    fn test_request_limit_clamps_to_platform_usize() {
        assert_eq!(request_limit(4), 4);
        assert_eq!(request_limit(u64::MAX), usize::MAX);
    }
}