nbreq 0.2.2

Runtime-independent cancellable HTTP client
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
use super::super::*;
use crate::Method;
use std::io::{Read, Write};
use std::net::TcpListener;

const LARGE_BODY: usize = 2 * 1024 * 1024;

fn backend(tls: bool) -> NativeHttpBackend {
    let config = EngineConfig::manual();
    let configs = tls.then(|| {
        let key = rcgen::KeyPair::generate().expect("key");
        let cert = rcgen::CertificateParams::new(vec!["ownership.test".into()])
            .expect("certificate parameters")
            .self_signed(&key)
            .expect("certificate");
        NativeTlsConfigs::with_test_root(cert.der().clone()).expect("TLS configs")
    });
    NativeHttpBackend::new(
        HttpLimits::from_config(&config),
        None,
        configs,
        ConnectionLimits::from_config(&config),
    )
    .expect("backend")
}

fn pending(backend: &NativeHttpBackend, tls: bool) -> (PendingResolve, *const u8) {
    let mut bytes = Vec::with_capacity(LARGE_BODY + 37);
    bytes.resize(LARGE_BODY, 0xa5);
    let pointer = bytes.as_ptr();
    let request = Request::post(format!(
        "{}://ownership.test/upload",
        if tls { "https" } else { "http" }
    ))
    .body(bytes)
    .build()
    .expect("request");
    let pending = backend
        .make_pending(
            RequestId {
                engine: 1,
                sequence: 1,
            },
            request,
            PendingDeadlines {
                connect: None,
                total: None,
                inactivity: None,
            },
            0,
            ErrorKind::InvalidRequest,
            PendingResponse::Buffered,
        )
        .unwrap_or_else(|(error, _)| panic!("pending request: {error}"));
    (pending, pointer)
}

fn connecting(tls: bool) -> (NativeHttpBackend, SlotId, TcpListener, *const u8) {
    let listener = TcpListener::bind("127.0.0.1:0").expect("listener");
    let mut backend = backend(tls);
    let (pending, pointer) = pending(&backend, tls);
    let id = pending.request_id;
    assert!(backend.reserve_connection(&pending.key));
    assert!(
        backend
            .begin_connection(
                VecDeque::from([listener.local_addr().expect("address")]),
                pending
            )
            .is_none()
    );
    let slot = backend.request_to_slot[&id];
    (backend, slot, listener, pointer)
}

#[test]
fn m23_pending_request_keeps_body_out_of_serialized_storage() {
    for tls in [false, true] {
        let backend = backend(tls);
        let (pending, pointer) = pending(&backend, tls);
        assert_eq!(pending.request.body().as_ptr(), pointer);
        assert_eq!(pending.request.body().len(), LARGE_BODY);
        assert!(
            pending.serialized.bytes.capacity() < 1024,
            "DNS/connect preparation duplicated a whole body: {} bytes",
            pending.serialized.bytes.capacity()
        );
        assert!(pending.serialized.bytes.ends_with(b"\r\n\r\n"));
        assert!(
            pending
                .serialized
                .bytes
                .windows(b"Content-Length: 2097152".len())
                .any(|value| value == b"Content-Length: 2097152")
        );
    }
}

#[test]
fn m23_connection_waiter_keeps_only_original_body_storage() {
    let mut backend = backend(false);
    backend.connection_limits.global = 1;
    let (pending, pointer) = pending(&backend, false);
    let key = pending.key.clone();
    let id = pending.request_id;
    assert!(backend.reserve_connection(&key));
    assert!(backend.start_pending(pending).is_none());
    assert_eq!(backend.waiting.len(), 1);
    let waiting = &backend.waiting[0];
    assert_eq!(waiting.request.body().as_ptr(), pointer);
    assert!(
        waiting.serialized.bytes.capacity() < 1024,
        "connection admission retained a second full request body"
    );
    backend.cancel(id);
    assert!(backend.waiting.is_empty());
    backend.release_connection(&key);
    backend.shutdown().expect("shutdown");
}

#[test]
fn m23_cleartext_connecting_state_does_not_duplicate_the_body() {
    let (mut backend, slot, _listener, pointer) = connecting(false);
    let transfer = &backend.transfers[&slot];
    assert_eq!(transfer.request.body().as_ptr(), pointer);
    let head = transfer
        .connecting
        .as_ref()
        .expect("connecting")
        .cleartext_request
        .as_ref()
        .expect("cleartext head");
    assert!(
        head.capacity() < 1024,
        "TCP connect state retained a whole serialized body: {} bytes",
        head.capacity()
    );
    assert!(backend.reactor.outbound_is_empty(slot).expect("outbound"));
    backend.shutdown().expect("shutdown");
}

#[test]
fn m23_tls_handshake_does_not_duplicate_the_body() {
    let (mut backend, slot, _listener, pointer) = connecting(true);
    let transfer = &mut backend.transfers.get_mut(&slot).expect("transfer");
    assert_eq!(transfer.request.body().as_ptr(), pointer);
    let tls = transfer.tls.as_mut().expect("TLS");
    assert!(
        tls.request_plaintext_capacity() < 1024,
        "TLS retained a second whole request body before handshake"
    );
    let session = tls.take_handshake().expect("handshake session");
    assert!(tls.handshake_in_worker());
    assert!(tls.request_plaintext_capacity() < 1024);
    tls.restore_handshake(session);
    assert_eq!(transfer.request.body().as_ptr(), pointer);
    backend.shutdown().expect("shutdown");
}

#[test]
fn m23_cleartext_send_queue_has_a_body_independent_bound() {
    let (mut backend, slot, _listener, _) = connecting(false);
    let capacity = backend.reactor.outbound_capacity(slot).expect("capacity");
    assert!(
        capacity <= 65 * 1024,
        "large buffered bodies must use a bounded send window, got {capacity}"
    );
    backend.shutdown().expect("shutdown");
}

#[test]
fn m23_redirect_moves_the_original_body_allocation() {
    let mut bytes = Vec::with_capacity(LARGE_BODY + 37);
    bytes.resize(LARGE_BODY, 0x5a);
    let pointer = bytes.as_ptr();
    let request = Request::post("https://ownership.test/start")
        .header("Authorization", "secret")
        .header("Content-Length", LARGE_BODY.to_string())
        .body(bytes)
        .build()
        .expect("request");
    let redirected =
        request.redirected("https://other.test/finish".into(), Method::Post, true, true);
    assert_eq!(redirected.body().len(), LARGE_BODY);
    assert_eq!(
        redirected.body().as_ptr(),
        pointer,
        "body-preserving redirect copied the payload"
    );
    assert!(
        !redirected
            .headers()
            .iter()
            .any(|header| header.name().eq_ignore_ascii_case("authorization"))
    );
    assert!(
        redirected
            .headers()
            .iter()
            .any(|header| header.name().eq_ignore_ascii_case("content-length"))
    );
}

fn accept_bounded(listener: &TcpListener) -> std::net::TcpStream {
    listener.set_nonblocking(true).expect("bounded accept");
    let deadline = Instant::now() + Duration::from_secs(8);
    loop {
        match listener.accept() {
            Ok((socket, _)) => {
                socket.set_nonblocking(false).expect("blocking fixture I/O");
                socket
                    .set_read_timeout(Some(Duration::from_secs(8)))
                    .expect("read timeout");
                socket
                    .set_write_timeout(Some(Duration::from_secs(8)))
                    .expect("write timeout");
                return socket;
            }
            Err(error) if error.kind() == std::io::ErrorKind::WouldBlock => {
                assert!(Instant::now() < deadline, "fixture was not connected");
                std::thread::sleep(Duration::from_millis(1));
            }
            Err(error) => panic!("fixture accept: {error}"),
        }
    }
}

#[test]
fn m23_partial_buffered_send_cancel_discards_unsent_bytes() {
    let (mut backend, slot, listener, pointer) = connecting(false);
    let mut peer = accept_bounded(&listener);
    let deadline = Instant::now() + Duration::from_secs(5);
    while backend.transfers[&slot].request_body_offset == 0 {
        assert!(Instant::now() < deadline, "send never started");
        assert!(
            backend
                .poll(Instant::now() + Duration::from_millis(1))
                .expect("poll")
                .is_empty()
        );
    }
    let transfer = &backend.transfers[&slot];
    let id = transfer.request_id;
    assert_eq!(transfer.request.body().as_ptr(), pointer);
    assert!(transfer.request_body_offset < LARGE_BODY);
    assert!(!NativeHttpBackend::request_output_complete(transfer));
    assert!(!transfer.request_write_drained);
    backend.cancel(id);
    assert!(
        backend
            .process_events(vec![NativeEvent::WriteDrained(slot)])
            .expect("late event")
            .is_empty()
    );
    assert_eq!(backend.reactor.active_count(), 0);
    assert_eq!(backend.connection_count, 0);
    assert!(backend.transfers.is_empty());
    backend.shutdown().expect("shutdown");
    super::drain_until_socket_closed(&mut peer, "cancelled partial body");
}

fn serve_early_redirects(stream: &mut (impl Read + Write)) {
    for hop in 0..4 {
        // Read exactly the head: the redirect is deliberately returned before consuming the
        // body. Its response body waits for the upload, forcing the client to keep transmitting.
        let mut head = Vec::new();
        while !head.ends_with(b"\r\n\r\n") {
            let mut byte = [0];
            stream.read_exact(&mut byte).expect("request head");
            head.push(byte[0]);
            assert!(head.len() < 1024);
        }
        let head = String::from_utf8(head).expect("ASCII request head");
        let size = if hop == 3 { 50 * 1024 } else { LARGE_BODY };
        assert!(
            head.starts_with(&format!("POST /hop{hop} HTTP/1.1\r\n")),
            "{head}"
        );
        assert!(
            head.contains(&format!("Content-Length: {size}\r\n")),
            "{head}"
        );
        if hop < 2 {
            write!(
                stream,
                "HTTP/1.1 {} Redirect\r\nLocation: /hop{}\r\nContent-Length: 4\r\n\r\n",
                307 + hop,
                hop + 1
            )
            .expect("early redirect head");
            stream.flush().expect("early redirect flush");
        }
        let mut received = 0;
        let mut chunk = [0; 997];
        while received < size {
            let count = (size - received).min(chunk.len());
            stream
                .read_exact(&mut chunk[..count])
                .expect("complete upload body");
            for (index, byte) in chunk[..count].iter().enumerate() {
                assert_eq!(
                    *byte,
                    ((received + index) % 251) as u8,
                    "upload byte {} at hop {hop}",
                    received + index
                );
            }
            received += count;
        }
        match hop {
            0 | 1 => stream.write_all(b"skip").expect("redirect body"),
            2 => stream
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok")
                .expect("final response"),
            _ => stream
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 2\r\nConnection: close\r\n\r\nok")
                .expect("small response"),
        }
        stream.flush().expect("response flush");
    }
}

#[test]
fn m23_large_bodies_survive_early_307_308_and_reuse_for_buffered_and_stream_readers() {
    for tls in [false, true] {
        for streaming in [false, true] {
            let listener = TcpListener::bind("127.0.0.1:0").expect("listener");
            let address = listener.local_addr().expect("address");
            let config = EngineConfig::spawned().with_max_stream_queue_bytes_per_request(1);
            let mut factory = NativeHttpFactory::new(&config);
            let server_config = tls.then(|| {
                let key = rcgen::KeyPair::generate().expect("key");
                let cert = rcgen::CertificateParams::new(vec!["127.0.0.1".into()])
                    .expect("certificate parameters")
                    .self_signed(&key)
                    .expect("certificate");
                factory.tls =
                    Some(NativeTlsConfigs::with_test_root(cert.der().clone()).expect("client TLS"));
                let mut server = rustls::ServerConfig::builder_with_provider(Arc::new(
                    rustls::crypto::ring::default_provider(),
                ))
                .with_safe_default_protocol_versions()
                .expect("TLS versions")
                .with_no_client_auth()
                .with_single_cert(
                    vec![cert.der().clone()],
                    rustls::pki_types::PrivatePkcs8KeyDer::from(key.serialize_der()).into(),
                )
                .expect("server TLS");
                server.alpn_protocols = vec![b"http/1.1".to_vec()];
                Arc::new(server)
            });
            let server = std::thread::spawn(move || {
                let mut socket = accept_bounded(&listener);
                if let Some(config) = server_config {
                    let mut stream = rustls::StreamOwned::new(
                        rustls::ServerConnection::new(config).expect("TLS session"),
                        socket,
                    );
                    serve_early_redirects(&mut stream);
                    stream.conn.send_close_notify();
                    // The final Connection: close response is already flushed. The client may
                    // close first after receiving it; this best-effort TLS farewell is cleanup.
                    let _ = stream.flush();
                } else {
                    serve_early_redirects(&mut socket);
                }
            });
            let engine =
                crate::Engine::with_spawned_factory(config, Box::new(factory)).expect("Engine");
            let make_request = |hop, size| {
                Request::post(format!(
                    "{}://{address}/hop{hop}",
                    if tls { "https" } else { "http" }
                ))
                .body(
                    (0..size)
                        .map(|index| (index % 251) as u8)
                        .collect::<Vec<_>>(),
                )
                .redirect_limit(3)
                .total_timeout(Duration::from_secs(15))
                .build()
                .expect("request")
            };
            let request = make_request(0, LARGE_BODY);
            let first = if streaming {
                engine
                    .client()
                    .submit_stream(request.into())
                    .map_err(|error| error.to_string())
                    .and_then(|reader| reader.collect().map_err(|error| error.to_string()))
            } else {
                engine
                    .client()
                    .execute(request)
                    .map_err(|error| error.to_string())
            };
            let second = first
                .as_ref()
                .ok()
                .map(|_| engine.client().execute(make_request(3, 50 * 1024)));
            engine.shutdown().expect("joined shutdown");
            let served = server.join();
            assert_eq!(
                first.expect("redirected request").body(),
                b"ok",
                "tls={tls}, streaming={streaming}"
            );
            assert_eq!(
                second
                    .expect("small request issued")
                    .expect("small request succeeds")
                    .body(),
                b"ok"
            );
            served.expect("one-connection fixture must join");
        }
    }
}