pavex 0.1.29

A framework for building API services and web applications in Rust.
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
220
221
222
223
224
225
226
227
228
229
230

use std::net::SocketAddr;
use std::time::Duration;

use http::Request;
use hyper::body::Incoming;

use pavex::connection::ConnectionInfo;
use pavex::response::Response;
use pavex::server::{IncomingStream, Server, ServerConfiguration, ShutdownMode};

// A dummy handler for our server tests.
async fn test_handler(
    _request: Request<Incoming>,
    _connection_info: Option<ConnectionInfo>,
    _state: (),
) -> Response {
    Response::ok()
}

fn test_server_config() -> ServerConfiguration {
    ServerConfiguration::new().set_n_workers(1)
}

async fn test_incoming() -> (IncomingStream, SocketAddr) {
    let i = IncomingStream::bind("127.0.0.1:0".parse().unwrap())
        .await
        .unwrap();
    let addr = i.local_addr().unwrap();
    (i, addr)
}

#[tokio::test]
async fn listen() {
    let (incoming, addr) = test_incoming().await;
    Server::new()
        .set_config(test_server_config())
        .listen(incoming)
        .serve(test_handler, ());

    // Check that we can connect successfully
    std::net::TcpStream::connect(addr).unwrap();
}

#[tokio::test]
async fn bind() {
    let (_, addr) = test_incoming().await;
    Server::new()
        .set_config(test_server_config())
        .bind(addr)
        .await
        .unwrap()
        .serve(test_handler, ());

    // Check that we can connect successfully
    std::net::TcpStream::connect(addr).unwrap();
}

#[tokio::test]
async fn multi_bind() {
    let (_, addr1) = test_incoming().await;
    let (_, addr2) = test_incoming().await;
    let (incoming3, addr3) = test_incoming().await;
    Server::new()
        .set_config(test_server_config())
        .bind(addr1)
        .await
        .unwrap()
        .bind(addr2)
        .await
        .unwrap()
        .listen(incoming3)
        .serve(test_handler, ());

    // Check that we can connect successfully
    // to all addresses.
    std::net::TcpStream::connect(addr1).unwrap();
    std::net::TcpStream::connect(addr2).unwrap();
    std::net::TcpStream::connect(addr3).unwrap();
}

#[tokio::test]
async fn serve() {
    let (incoming, addr) = test_incoming().await;
    Server::new()
        .set_config(test_server_config())
        .listen(incoming)
        .serve(test_handler, ());

    // Check that we can connect successfully
    let url = format!("http://localhost:{}", addr.port());
    reqwest::get(url).await.unwrap().error_for_status().unwrap();
}

async fn slow_handler(
    _req: Request<Incoming>,
    _connection_info: Option<ConnectionInfo>,
    state: SlowHandlerState,
) -> Response {
    // Signal that the connection has been established before starting to
    // sleep.
    state.started.send(()).await.unwrap();
    tokio::time::sleep(state.sleep).await;
    Response::ok()
}

#[derive(Clone)]
struct SlowHandlerState {
    sleep: Duration,
    started: tokio::sync::mpsc::Sender<()>,
}

impl SlowHandlerState {
    fn new(delay: Duration) -> (tokio::sync::mpsc::Receiver<()>, Self) {
        let (started_tx, started_rx) = tokio::sync::mpsc::channel(1);
        let state = SlowHandlerState {
            sleep: delay,
            started: started_tx,
        };
        (started_rx, state)
    }
}

#[tokio::test]
#[cfg_attr(target_os = "windows", ignore = "Flaky on Windows")]
async fn graceful() {
    let (incoming, addr) = test_incoming().await;
    let delay = Duration::from_millis(100);
    let (mut has_started, state) = SlowHandlerState::new(delay);

    let server_handle = Server::new()
        .set_config(test_server_config())
        .listen(incoming)
        .serve(slow_handler, state);

    let get_response = async move {
        let url = format!("http://localhost:{}", addr.port());
        reqwest::get(url).await.unwrap().error_for_status().unwrap();
    };
    let get_response = tokio::task::spawn(get_response);

    // Wait for the connection to be established.
    has_started.recv().await.unwrap();

    // Then start a graceful shutdown.
    let shutdown_future =
        tokio::task::spawn(server_handle.shutdown(ShutdownMode::Graceful { timeout: delay * 5 }));

    tokio::select! {
        v1 = get_response => {
            // The request must succeed!
            v1.unwrap();
        },
        _ = shutdown_future => {
            panic!("The server shutdown without waiting for an ongoing connection to complete within the allocated timeout")
        }
    }
}

#[tokio::test]
async fn forced() {
    let (incoming, addr) = test_incoming().await;
    let delay = Duration::from_millis(100);
    let (mut has_started, state) = SlowHandlerState::new(delay);

    let server_handle = Server::new()
        .set_config(test_server_config())
        .listen(incoming)
        .serve(slow_handler, state);

    let get_response = async move {
        let url = format!("http://localhost:{}", addr.port());
        reqwest::get(url).await.unwrap().error_for_status().unwrap();
    };
    let get_response = tokio::task::spawn(get_response);

    // Wait for the connection to be established.
    has_started.recv().await.unwrap();

    // Then start a forced shutdown.
    let shutdown_future = tokio::task::spawn(server_handle.shutdown(ShutdownMode::Forced));

    tokio::select! {
        outcome = get_response => {
            // This future might resolve first and report a broken connection, which would be fine.
            // We don't want to see it succeed!
            if outcome.is_ok() {
                panic!("The server was supposed to shutdown forcefully, but it waited for the ongoing request")
            }
        },
        _ = shutdown_future => {}
    }
}

#[tokio::test]
#[cfg_attr(target_os = "windows", ignore = "Flaky on Windows")]
async fn graceful_but_too_fast() {
    let (incoming, addr) = test_incoming().await;
    let delay = Duration::from_millis(200);
    let (mut has_started, state) = SlowHandlerState::new(delay);

    let server_handle = Server::new()
        .set_config(test_server_config())
        .listen(incoming)
        .serve(slow_handler, state);

    let get_response = async move {
        let url = format!("http://localhost:{}", addr.port());
        reqwest::get(url).await.unwrap().error_for_status().unwrap();
    };
    let get_response = tokio::task::spawn(get_response);

    // Wait for the connection to be established.
    has_started.recv().await.unwrap();

    // Then start a graceful shutdown with a timeout that will **not** allow the request
    // handling to complete in time.
    let shutdown_future =
        tokio::task::spawn(server_handle.shutdown(ShutdownMode::Graceful { timeout: delay / 5 }));

    tokio::select! {
        outcome = get_response => {
            // This future might resolve first and report a broken connection, which would be fine.
            // We don't want to see it succeed!
            if outcome.is_ok() {
                panic!("The server was supposed to shutdown forcefully the slow request, but it waited instead")
            }
        },
        _ = shutdown_future => {}
    }
}