base-http-server 0.1.0

Supervised native HTTP servers for Base scheduler capabilities
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

//! A deliberately small protocol-driver experiment, not a gateway policy API.
//! Upload and download futures remain separately owned and polled until joined.
mod support;
use support::*;

use base_http::{
    Fields, InterimHandler, InterimResponses, Request, RequestMetadata, Response, ResponseMetadata,
    Status, body::ReadableBody,
};
use base_http_server::Handler;
use base_http1::{Error, RequestReader, RequestWriter, ResponseReader, ResponseWriter};
use base_scheduler::{
    Cancellation, SocketAccept, SocketClose, SocketConnect, SocketOpen, SocketStreamReading,
    SocketStreamWriting, SocketType,
};
use base_scheduler_direct::{DirectScheduler, DirectSocket};
use futures_lite::future::{block_on, zip};
use std::{
    future::Future,
    io::{self, BufRead, BufReader, Read, Write},
    net::{Shutdown, SocketAddr, TcpListener, TcpStream},
    sync::{Arc, Mutex},
};

// This experiment forwards ordinary HTTP/1 messages only. Upgrade/CONNECT need
// a client-side switch coordinator before they can use this forwarding loop.
fn forward_fields(fields: &mut Fields) {
    let nominated: Vec<String> = fields
        .pairs()
        .iter()
        .filter(|f| f.name().eq_ignore_ascii_case("connection"))
        .flat_map(|f| std::str::from_utf8(f.value()).unwrap().split(','))
        .map(|name| name.trim().to_owned())
        .collect();
    for name in nominated.iter().map(String::as_str).chain([
        "connection",
        "keep-alive",
        "proxy-connection",
        "te",
        "transfer-encoding",
        "upgrade",
    ]) {
        fields.remove(name);
    }
}

async fn supervised<T>(
    future: impl Future<Output = Result<T, Error>>,
    cancellation: &Cancellation,
) -> Result<T, Error> {
    let result = future.await;
    if result.is_err() {
        cancellation.cancel();
    }
    result
}

struct ProxyResult {
    result: Result<u64, Error>,
    retired_lanes: usize,
}

async fn proxy_connection(
    scheduler: &DirectScheduler,
    downstream: DirectSocket,
    upstream_address: SocketAddr,
    cancellation: &Cancellation,
) -> ProxyResult {
    let upstream = scheduler
        .socket_open(
            upstream_address.into(),
            SocketType::Stream,
            None,
            cancellation,
        )
        .await
        .unwrap();
    scheduler
        .socket_connect(&upstream, upstream_address, cancellation)
        .await
        .unwrap();
    let options = base_http1::Options {
        read_size: 1024,
        ..Default::default()
    };
    let mut input = RequestReader::new(
        scheduler.socket_stream_reader(&downstream).unwrap(),
        options.clone(),
    )
    .unwrap();
    let mut output = ResponseWriter::new(scheduler.socket_stream_writer(&downstream).unwrap());
    let mut upload = RequestWriter::new(scheduler.socket_stream_writer(&upstream).unwrap());
    let mut download =
        ResponseReader::new(scheduler.socket_stream_reader(&upstream).unwrap(), options).unwrap();
    let result = async {
        let mut count = 0;
        loop {
            let Some((mut request, exchange)) = input.read_request(cancellation).await? else {
                return Ok(count);
            };
            forward_fields(&mut request.metadata.fields);
            request.metadata.fields.remove("host");
            request.metadata.authority = Some(upstream_address.to_string().into());
            let upstream_head = request.metadata.clone();
            let lanes = cancellation.child();
            let send = supervised(upload.write_request(&mut request, &lanes), &lanes);
            let receive = supervised(
                async {
                    let mut interim = InterimResponses::new(output.interim(exchange.version()));
                    let mut response = download
                        .read_response(&upstream_head, &mut interim, &lanes)
                        .await?;
                    forward_fields(&mut response.metadata.fields);
                    response.metadata.version = None;
                    output
                        .write_response(&exchange, &mut response, &lanes)
                        .await
                },
                &lanes,
            );
            // Neither successful completion cancels the other direction. An
            // error cancels its sibling, but both futures are still awaited.
            let (sent, received) = zip(send, receive).await;
            drop(request);
            let (sent, received) = match (sent, received) {
                (Ok(sent), Ok(received)) => (sent, received),
                (Err(Error::Cancelled), Err(error)) => return Err(error),
                (Err(error), _) | (_, Err(error)) => return Err(error),
            };
            count += 1;
            // All four lanes must be synchronized before another admission.
            if !sent || !received || !input.is_reusable() || !download.is_reusable() {
                return Ok(count);
            }
        }
    }
    .await;
    let ((a, b), (c, d)) = zip(
        zip(input.close(), output.close()),
        zip(upload.close(), download.close()),
    )
    .await;
    let retired_lanes = [a, b, c, d]
        .into_iter()
        .map(|result| {
            result.unwrap();
            1
        })
        .sum();
    drop((input, output, upload, download));
    let (a, b) = zip(
        scheduler.socket_close(downstream),
        scheduler.socket_close(upstream),
    )
    .await;
    a.unwrap();
    b.unwrap();
    ProxyResult {
        result,
        retired_lanes,
    }
}

fn with_scheduler<T>(run: impl FnOnce(&DirectScheduler) -> T) -> T {
    let scheduler = scheduler();
    let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| run(&scheduler)));
    block_on(scheduler.shutdown());
    result.unwrap_or_else(|panic| std::panic::resume_unwind(panic))
}

fn checked_thread<T: Send + 'static>(
    cancellation: &Cancellation,
    run: impl FnOnce() -> T + Send + 'static,
) -> std::thread::JoinHandle<std::thread::Result<T>> {
    let cancellation = cancellation.clone();
    std::thread::spawn(move || {
        let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(run));
        if result.is_err() {
            cancellation.cancel();
        }
        result
    })
}

fn joined<T>(thread: std::thread::JoinHandle<std::thread::Result<T>>) -> T {
    thread
        .join()
        .unwrap()
        .unwrap_or_else(|panic| std::panic::resume_unwind(panic))
}

fn raw_upstream(
    upstream: impl FnOnce(BufReader<TcpStream>) + Send + 'static,
    peer: impl FnOnce(BufReader<TcpStream>, Cancellation) + Send + 'static,
) -> ProxyResult {
    with_scheduler(|scheduler| {
        block_on(async {
            let (listener, address) = listener(scheduler).await;
            let upstream_listener = TcpListener::bind("127.0.0.1:0").unwrap();
            let upstream_address = upstream_listener.local_addr().unwrap();
            let cancellation = Cancellation::new();
            let server = checked_thread(&cancellation, move || {
                let (socket, _) = upstream_listener.accept().unwrap();
                socket
                    .set_read_timeout(Some(std::time::Duration::from_secs(5)))
                    .unwrap();
                socket
                    .set_write_timeout(Some(std::time::Duration::from_secs(5)))
                    .unwrap();
                upstream(BufReader::new(socket));
            });
            let peer_cancel = cancellation.clone();
            let client = checked_thread(&cancellation, move || peer(connect(address), peer_cancel));
            let (socket, _) = scheduler
                .socket_accept(&listener, &cancellation)
                .await
                .unwrap();
            scheduler.socket_close(listener).await.unwrap();
            let result = proxy_connection(scheduler, socket, upstream_address, &cancellation).await;
            joined(server);
            joined(client);
            result
        })
    })
}

fn request_head(peer: &mut impl BufRead) -> (String, Head) {
    let mut line = String::new();
    peer.read_line(&mut line).unwrap();
    assert!(line.ends_with("HTTP/1.1\r\n"), "{line:?}");
    let start = line.clone();
    let mut fields = Vec::new();
    loop {
        line.clear();
        peer.read_line(&mut line).unwrap();
        if line == "\r\n" {
            break;
        }
        assert!(line.ends_with("\r\n"));
        let (name, value) = line[..line.len() - 2].split_once(':').unwrap();
        fields.push((name.to_owned(), value.trim().to_owned()));
    }
    (start, Head { status: 0, fields })
}

struct Echo {
    seen: Arc<Mutex<Vec<RequestMetadata>>>,
}
impl Handler for Echo {
    type Error = io::Error;
    type Body<B: ReadableBody> = B;
    async fn call<B: ReadableBody, I: InterimHandler>(
        &self,
        request: Request<B>,
        interim: &mut InterimResponses<I>,
        cancellation: &Cancellation,
    ) -> Result<Response<B>, io::Error> {
        self.seen.lock().unwrap().push(request.metadata.clone());
        if request.fields.contains("expect") {
            for status in [Status::CONTINUE, Status::EARLY_HINTS] {
                interim
                    .send_interim_response(ResponseMetadata::new(status), cancellation)
                    .await
                    .map_err(io::Error::other)?;
            }
        }
        let mut response = Response::new(Status::OK, request.body);
        response.fields.add("Connection", "x-private").unwrap();
        response.fields.add("x-private", "remove-me").unwrap();
        Ok(response)
    }
}

#[test]
fn native_proxy_streams_both_directions_with_interims_trailers_and_connection_reuse() {
    let seen = Arc::new(Mutex::new(Vec::new()));
    let capture = seen.clone();
    let (proxy, served, upstream_address) = with_scheduler(|scheduler| {
        block_on(async {
            let (listener, address) = listener(scheduler).await;
            let (upstream_listener, upstream_address) = support::listener(scheduler).await;
            let cancellation = Cancellation::new();
            let client = checked_thread(&cancellation, move || {
                let mut peer = connect(address);
                peer.get_mut().write_all(b"POST /echo HTTP/1.1\r\nHost: original\r\nConnection: x-secret\r\nx-secret: remove-me\r\nExpect: 100-continue\r\nTransfer-Encoding: chunked\r\nTrailer: x-result\r\n\r\n").unwrap();
                assert_eq!(head(&mut peer).status, 100);
                assert_eq!(head(&mut peer).status, 103);
                let response = head(&mut peer);
                assert_eq!(response.status, 200);
                assert!(response.get("connection").is_none());
                assert!(response.get("x-private").is_none());
                peer.get_mut().write_all(b"3\r\none\r\n").unwrap();
                // Wait for response data before producing the rest of the request.
                assert_eq!(chunked_prefix(&mut peer, 3), b"one");
                peer.get_mut()
                    .write_all(b"3\r\ntwo\r\n0\r\nx-result: complete\r\n\r\n")
                    .unwrap();
                let (data, trailers) = body(&mut peer, &response);
                assert_eq!(data, b"two");
                assert_eq!(trailers, ["x-result: complete"]);
                peer.get_mut()
                    .write_all(
                        b"GET /again HTTP/1.1\r\nHost: original\r\nConnection: close\r\n\r\n",
                    )
                    .unwrap();
                let response = head(&mut peer);
                assert_eq!(response.status, 200);
                assert_eq!(response.get("connection"), Some("close"));
                assert!(body(&mut peer, &response).0.is_empty());
                assert_eq!(peer.read(&mut [0]).unwrap(), 0);
            });
            let handler = Echo { seen: capture };
            let server = async {
                let (socket, _) = scheduler
                    .socket_accept(&upstream_listener, &cancellation)
                    .await
                    .unwrap();
                scheduler.socket_close(upstream_listener).await.unwrap();
                base_http_server::serve_connection(
                    scheduler,
                    socket,
                    &handler,
                    &Default::default(),
                    &cancellation,
                )
                .await
            };
            let proxy = async {
                let (socket, _) = scheduler
                    .socket_accept(&listener, &cancellation)
                    .await
                    .unwrap();
                scheduler.socket_close(listener).await.unwrap();
                proxy_connection(scheduler, socket, upstream_address, &cancellation).await
            };
            let (served, proxy) = zip(server, proxy).await;
            joined(client);
            (proxy, served, upstream_address)
        })
    });
    assert_eq!(proxy.result.unwrap(), 2);
    assert_eq!(proxy.retired_lanes, 4);
    assert_eq!(served.unwrap(), 2);
    let seen = seen.lock().unwrap();
    assert_eq!(seen.len(), 2);
    for request in seen.iter() {
        assert_eq!(
            request.authority.as_deref(),
            Some(upstream_address.to_string().as_str())
        );
        assert!(!request.fields.contains("x-secret"));
    }
}

#[test]
fn complete_early_response_does_not_stop_upload_or_prevent_reuse() {
    const LENGTH: usize = 2 * 1024 * 1024;
    let result = raw_upstream(
        |mut peer| {
            let (start, request) = request_head(&mut peer);
            assert!(start.starts_with("POST /early "));
            assert_eq!(
                request.get("content-length"),
                Some(LENGTH.to_string().as_str())
            );
            peer.get_mut()
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nearly")
                .unwrap();
            let (data, _) = body(&mut peer, &request);
            assert_eq!(data, vec![b'u'; LENGTH]);
            let (start, _) = request_head(&mut peer);
            assert!(start.starts_with("GET /again "));
            peer.get_mut()
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 4\r\n\r\ndone")
                .unwrap();
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
        |mut peer, _| {
            write!(
                peer.get_mut(),
                "POST /early HTTP/1.1\r\nHost: original\r\nContent-Length: {LENGTH}\r\n\r\n"
            )
            .unwrap();
            let response = head(&mut peer);
            assert_eq!(response.status, 200);
            assert!(response.get("connection").is_none());
            assert_eq!(body(&mut peer, &response).0, b"early");
            // No upload byte is produced until the final response is complete.
            peer.get_mut().write_all(&vec![b'u'; LENGTH]).unwrap();
            peer.get_mut()
                .write_all(b"GET /again HTTP/1.1\r\nHost: original\r\nConnection: close\r\n\r\n")
                .unwrap();
            let response = head(&mut peer);
            assert_eq!(body(&mut peer, &response).0, b"done");
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
    );
    assert_eq!(result.result.unwrap(), 2);
    assert_eq!(result.retired_lanes, 4);
}

#[test]
fn downstream_response_backpressure_does_not_stop_independent_upload_progress() {
    const LENGTH: usize = 8 * 1024 * 1024;
    let result = raw_upstream(
        |mut peer| {
            let (_, request) = request_head(&mut peer);
            // Independent upstream directions: write a response larger than socket
            // buffers while also consuming the upload. A body-driven upload pump
            // would stall once the proxy's downstream response write blocks.
            let mut writer = peer.get_ref().try_clone().unwrap();
            let response = std::thread::spawn(move || {
                write!(
                    writer,
                    "HTTP/1.1 200 OK\r\nContent-Length: {LENGTH}\r\n\r\n"
                )
                .unwrap();
                writer.write_all(&vec![b'r'; LENGTH]).unwrap();
            });
            assert_eq!(body(&mut peer, &request).0, vec![b'u'; LENGTH]);
            response.join().unwrap();
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
        |mut peer, _| {
            write!(peer.get_mut(), "POST /pressure HTTP/1.1\r\nHost: original\r\nConnection: close\r\nContent-Length: {LENGTH}\r\n\r\n").unwrap();
            peer.get_mut().write_all(&vec![b'u'; LENGTH]).unwrap();
            // Delay all response consumption until the upload has been produced.
            let response = head(&mut peer);
            assert_eq!(body(&mut peer, &response).0, vec![b'r'; LENGTH]);
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
    );
    assert_eq!(result.result.unwrap(), 1);
    assert_eq!(result.retired_lanes, 4);
}

#[test]
fn truncated_upstream_response_cancels_pending_upload_and_joins_all_lanes() {
    let result = raw_upstream(
        |mut peer| {
            request_head(&mut peer);
            peer.get_mut()
                .write_all(b"HTTP/1.1 200 OK\r\nContent-Length: 5\r\n\r\nx")
                .unwrap();
            peer.get_ref().shutdown(Shutdown::Write).unwrap();
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
        |mut peer, _| {
            peer.get_mut()
                .write_all(b"POST / HTTP/1.1\r\nHost: original\r\nContent-Length: 100\r\n\r\n")
                .unwrap();
            assert_eq!(head(&mut peer).status, 200);
            let mut data = Vec::new();
            peer.read_to_end(&mut data).unwrap();
            assert_eq!(data, b"x");
        },
    );
    // The response writer wraps upstream body errors with their causal chain.
    assert!(
        matches!(result.result, Err(Error::Body(_))),
        "{:?}",
        result.result
    );
    assert_eq!(result.retired_lanes, 4);
}

#[test]
fn cancellation_with_both_proxy_directions_pending_joins_all_lanes() {
    let result = raw_upstream(
        |mut peer| {
            request_head(&mut peer);
            peer.get_mut()
                .write_all(b"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\n\r\n")
                .unwrap();
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
        |mut peer, cancellation| {
            peer.get_mut()
                .write_all(b"POST / HTTP/1.1\r\nHost: original\r\nContent-Length: 100\r\n\r\n")
                .unwrap();
            assert_eq!(head(&mut peer).status, 200);
            cancellation.cancel();
            assert_eq!(peer.read(&mut [0]).unwrap(), 0);
        },
    );
    assert!(
        matches!(result.result, Err(Error::Cancelled)),
        "{:?}",
        result.result
    );
    assert_eq!(result.retired_lanes, 4);
}