rocket 0.5.2

Web framework with a focus on usability, security, extensibility, and speed.
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

#[macro_use] extern crate rocket;

use std::io::{self, Cursor, SeekFrom};
use std::pin::Pin;
use std::task::{Context, Poll};
use std::time::Duration;

use http_body_util::{BodyExt, Empty};
use hyper::body::{Bytes, Incoming};
use hyper_util::rt::{TokioExecutor, TokioIo};

use rocket::fairing::AdHoc;
use rocket::http::Status;
use rocket::response::{Response, Responder};
use rocket::tokio::io::{AsyncRead, AsyncSeek, ReadBuf};
use rocket::tokio::{net::TcpStream, sync::oneshot, time::timeout};

struct RawResponse(Response<'static>);

impl<'r> Responder<'r, 'static> for RawResponse {
    fn respond_to(self, _: &'r rocket::Request<'_>) -> rocket::response::Result<'static> {
        Ok(self.0)
    }
}

struct FailedSeek;

impl AsyncRead for FailedSeek {
    fn poll_read(
        self: Pin<&mut Self>,
        _: &mut Context<'_>,
        _: &mut ReadBuf<'_>
    ) -> Poll<io::Result<()>> {
        panic!("a stripped body must not be read")
    }
}

impl AsyncSeek for FailedSeek {
    fn start_seek(self: Pin<&mut Self>, _: SeekFrom) -> io::Result<()> {
        Err(io::Error::other("cannot seek"))
    }

    fn poll_complete(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<io::Result<u64>> {
        Poll::Ready(Err(io::Error::other("cannot seek")))
    }
}

#[get("/<status>/<kind>?<length>&<chunked>")]
fn response(status: u16, kind: &str, length: Option<usize>, chunked: bool) -> RawResponse {
    let mut response = Response::new();
    response.set_status(Status::new(status));
    match kind {
        "none" => {},
        "empty" => { response.set_sized_body(0, Cursor::new("")); },
        "sized" => { response.set_sized_body(5, Cursor::new("hello")); },
        "seek" => { response.set_sized_body(None, Cursor::new("hello")); },
        "stream" => { response.set_streamed_body(Cursor::new("hello")); },
        "failed-seek" => { response.set_sized_body(None, FailedSeek); },
        _ => panic!("unknown body"),
    }

    if let Some(length) = length {
        response.set_raw_header("Content-Length", length.to_string());
    }

    if chunked {
        response.set_raw_header("Transfer-Encoding", "chunked");
    }

    RawResponse(response)
}

#[rocket::async_test]
async fn local_representation_length() {
    let client = rocket::local::asynchronous::Client::debug_with(routes![response]).await.unwrap();
    for (path, length) in [("/304/none?length=123", Some("123")), ("/304/stream", None)] {
        let response = client.get(path).dispatch().await;
        assert_eq!(response.headers().get_one("Content-Length"), length);
        assert_eq!(response.body().preset_size(), None);
        assert!(response.into_bytes().await.unwrap_or_default().is_empty());
    }
}

enum Client {
    Http1(hyper::client::conn::http1::SendRequest<Empty<Bytes>>),
    Http2(hyper::client::conn::http2::SendRequest<Empty<Bytes>>),
}

impl Client {
    async fn request(&mut self, method: &str, path: &str) -> hyper::Response<Incoming> {
        let request = hyper::Request::builder()
            .method(method).uri(format!("http://localhost{path}"))
            .body(Empty::new()).unwrap();

        match self {
            Client::Http1(client) => {
                client.ready().await.unwrap();
                client.send_request(request).await.unwrap()
            },
            Client::Http2(client) => {
                client.ready().await.unwrap();
                client.send_request(request).await.unwrap()
            },
        }
    }
}

async fn check_framing(http2: bool) {
    let (tx, rx) = oneshot::channel();
    let mut config = rocket::Config { port: 0, ..rocket::Config::debug_default() };
    config.shutdown.ctrlc = false;
    let rocket = rocket::custom(config).mount("/", routes![response])
        .attach(AdHoc::on_liftoff("Send Port and Shutdown", |rocket| Box::pin(async move {
            tx.send((rocket.config().port, rocket.shutdown())).unwrap();
        })));

    let server = rocket::tokio::spawn(rocket.launch());
    let (port, shutdown) = rx.await.unwrap();
    let tcp = TcpStream::connect(("127.0.0.1", port)).await.unwrap();
    let io = TokioIo::new(tcp);
    let (mut client, connection) = if http2 {
        let (client, connection) = hyper::client::conn::http2::handshake(TokioExecutor::new(), io)
            .await.unwrap();
        (Client::Http2(client), rocket::tokio::spawn(connection))
    } else {
        let (client, connection) = hyper::client::conn::http1::handshake(io).await.unwrap();
        (Client::Http1(client), rocket::tokio::spawn(connection))
    };

    // HEAD and 304 omit the body but preserve its length when it is known.
    for (method, status) in [("HEAD", 200), ("GET", 304)] {
        for (body, length) in [
            ("sized", Some("5")),
            ("seek", Some("5")),
            ("empty", Some("0")),
            ("none", None),
            ("stream", None),
            ("failed-seek", None),
            ("none?length=123", Some("123")),
            ("stream?length=123", Some("123")),
            ("sized?length=123&chunked=true", None),
            ("stream?length=123&chunked=true", None),
        ] {
            let path = format!("/{status}/{body}");
            let response = client.request(method, &path).await;
            assert_eq!(response.status(), status, "{method} {path}");
            let actual = response.headers().get("Content-Length")
                .map(|value| value.to_str().unwrap());
            assert_eq!(actual, length, "{method} {path}");
            assert!(response.collect().await.unwrap().to_bytes().is_empty());

            let response = client.request("GET", "/200/sized").await;
            assert_eq!(response.collect().await.unwrap().to_bytes(), "hello");
        }
    }

    // A 204 has neither a body nor framing headers, including for HEAD.
    for method in ["GET", "HEAD"] {
        let response = client.request(method, "/204/sized?length=123&chunked=true").await;
        assert_eq!(response.status(), 204);
        assert!(!response.headers().contains_key("Content-Length"));
        assert!(!response.headers().contains_key("Transfer-Encoding"));
        assert!(response.collect().await.unwrap().to_bytes().is_empty());

        let response = client.request("GET", "/200/sized").await;
        assert_eq!(response.collect().await.unwrap().to_bytes(), "hello");
    }

    // A known body size replaces an explicit length instead of adding another.
    for (body, length, bytes) in [
        ("none", "0", ""),
        ("empty", "0", ""),
        ("sized", "5", "hello"),
    ] {
        let path = format!("/200/{body}?length=123");
        let response = client.request("GET", &path).await;
        assert_eq!(response.headers().get("Content-Length").unwrap(), length);
        assert_eq!(response.headers().get_all("Content-Length").iter().count(), 1);
        assert_eq!(response.collect().await.unwrap().to_bytes(), bytes);
    }

    // Transfer-Encoding and Content-Length must not be sent together.
    let response = client.request("GET", "/200/stream?length=123&chunked=true").await;
    assert!(!response.headers().contains_key("Content-Length"));
    assert_eq!(response.collect().await.unwrap().to_bytes(), "hello");

    drop(client);
    shutdown.notify();
    server.await.unwrap().unwrap();
    connection.await.unwrap().unwrap();
}

#[rocket::async_test]
async fn http1_framing() {
    timeout(Duration::from_secs(10), check_framing(false)).await.unwrap();
}

#[cfg(feature = "http2")]
#[rocket::async_test]
async fn http2_framing() {
    timeout(Duration::from_secs(10), check_framing(true)).await.unwrap();
}