eggserve-core 0.1.0

Security policy, path confinement, and static-serving primitives for eggserve
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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
use std::{fs::File, path::PathBuf};

use eggserve_core::config::{ServeConfig, ServeState};
use eggserve_core::primitives::body::BodySource;
use eggserve_core::primitives::canonical::{
    normalize_response, NormalizeRequest, Response, ResponseBody, StatusCode,
};
use eggserve_core::primitives::request::Request;
use eggserve_core::server::config::RuntimeConfig;
use eggserve_core::server::connection::serve_connection_with_runtime_state;
use eggserve_core::server::{service_fn, RuntimeState, Server};
use hyper_util::rt::TokioIo;
use tempfile::TempDir;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpListener;
use tokio::sync::broadcast;

fn build_state(tmp: &TempDir) -> Arc<ServeState> {
    let config = Arc::new(ServeConfig {
        root: tmp.path().to_path_buf(),
        ..ServeConfig::default()
    });
    Arc::new(ServeState::new(config).unwrap())
}

#[test]
fn static_root_is_validated_during_build() {
    let missing =
        std::env::temp_dir().join(format!("eggserve-plan109-missing-{}", std::process::id()));
    let result = Server::builder()
        .runtime(RuntimeConfig::default())
        .serve_config(Arc::new(ServeConfig {
            root: missing,
            ..ServeConfig::default()
        }))
        .build();
    assert!(
        result.is_err(),
        "invalid static root must fail during build"
    );
}

#[tokio::test]
async fn panic_in_service_returns_500() {
    let tmp = TempDir::new().unwrap();
    let _state = build_state(&tmp);
    let config = RuntimeConfig::default();
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);

    let server = tokio::spawn(async move {
        let (stream, _) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let svc = service_fn(|_req: Request| async {
            panic!("intentional panic");
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            Arc::new(RuntimeState::new_for_testing(config.max_file_streams)),
            &mut shutdown_rx,
            1,
            addr,
            addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut buf = Vec::new();
    let _ = client.read_to_end(&mut buf).await;
    let _ = server.await;

    // When a service panics, the connection task panics and the TCP
    // connection is dropped. The client sees a connection reset with no
    // complete HTTP response.
    let response = String::from_utf8_lossy(&buf);
    assert!(
        !response.starts_with("HTTP/1.1 200"),
        "service panic should not produce 200: {}",
        response
    );
}

#[tokio::test]
async fn slow_handler_returns_504() {
    let tmp = TempDir::new().unwrap();
    let _state = build_state(&tmp);
    let config = RuntimeConfig::builder()
        .handler_timeout(Duration::from_millis(50))
        .build()
        .unwrap();
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);

    let server = tokio::spawn(async move {
        let (stream, _) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let svc = service_fn(|_req: Request| async {
            tokio::time::sleep(Duration::from_secs(60)).await;
            Ok(Response::builder()
                .status(StatusCode::OK)
                .body(ResponseBody::Empty)
                .unwrap())
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            Arc::new(RuntimeState::new_for_testing(config.max_file_streams)),
            &mut shutdown_rx,
            1,
            addr,
            addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut buf = Vec::new();
    client.read_to_end(&mut buf).await.unwrap();
    let _ = server.await;

    let response = String::from_utf8_lossy(&buf);
    assert!(
        response.starts_with("HTTP/1.1 504"),
        "expected 504, got: {}",
        response
    );
}

#[tokio::test]
async fn malformed_request_rejected_before_service() {
    let tmp = TempDir::new().unwrap();
    let _state = build_state(&tmp);
    let config = RuntimeConfig::default();
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);

    let called = Arc::new(AtomicBool::new(false));
    let called_clone = called.clone();

    let server = tokio::spawn(async move {
        let (stream, _) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let svc = service_fn(move |_req: Request| {
            let called = called_clone.clone();
            async move {
                called.store(true, Ordering::SeqCst);
                Ok(Response::builder()
                    .status(StatusCode::OK)
                    .body(ResponseBody::Empty)
                    .unwrap())
            }
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            Arc::new(RuntimeState::new_for_testing(config.max_file_streams)),
            &mut shutdown_rx,
            1,
            addr,
            addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"NOT A VALID HTTP REQUEST\r\n\r\n")
        .await
        .unwrap();
    let mut buf = Vec::new();
    let _ = client.read_to_end(&mut buf).await;
    let _ = server.await;

    assert!(
        !called.load(Ordering::SeqCst),
        "service should not be called for malformed requests"
    );
}

#[tokio::test]
async fn custom_service_bytes_through_pipeline() {
    let tmp = TempDir::new().unwrap();
    let _state = build_state(&tmp);
    let config = RuntimeConfig::default();
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);

    let server = tokio::spawn(async move {
        let (stream, _) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let svc = service_fn(|_req: Request| async {
            Ok(Response::builder()
                .status(StatusCode::OK)
                .body(ResponseBody::Bytes(b"hello".to_vec()))
                .unwrap())
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            Arc::new(RuntimeState::new_for_testing(config.max_file_streams)),
            &mut shutdown_rx,
            1,
            addr,
            addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut buf = Vec::new();
    client.read_to_end(&mut buf).await.unwrap();
    let _ = server.await;

    let response = String::from_utf8_lossy(&buf);
    assert!(
        response.starts_with("HTTP/1.1 200"),
        "expected 200, got: {}",
        response
    );
    assert!(
        response.contains("hello"),
        "response body should contain 'hello': {}",
        response
    );
}

async fn request_custom_file(runtime_state: Arc<RuntimeState>, path: PathBuf) -> Vec<u8> {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);
    let config = RuntimeConfig::default();

    let server = tokio::spawn(async move {
        let (stream, peer_addr) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let path = path.clone();
        let svc = service_fn(move |_req: Request| {
            let path = path.clone();
            async move {
                let file = File::open(&path).unwrap();
                let len = file.metadata().unwrap().len();
                let body = BodySource::FileFull {
                    file,
                    len,
                    mime: "application/octet-stream",
                };
                Ok(Response::builder()
                    .status(StatusCode::OK)
                    .body(ResponseBody::File(body))
                    .unwrap())
            }
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            runtime_state,
            &mut shutdown_rx,
            1,
            addr,
            peer_addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"GET /file HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut response = Vec::new();
    client.read_to_end(&mut response).await.unwrap();
    server.await.unwrap();
    response
}

#[tokio::test]
async fn custom_service_file_stream_saturation_maps_503_and_recovers() {
    let tmp = TempDir::new().unwrap();
    let path = tmp.path().join("custom.bin");
    std::fs::write(&path, b"custom file").unwrap();
    let runtime_state = Arc::new(RuntimeState::new_for_testing(1));
    let held = runtime_state
        .file_stream_semaphore()
        .clone()
        .try_acquire_owned()
        .unwrap();

    let saturated = request_custom_file(runtime_state.clone(), path.clone()).await;
    assert!(saturated.starts_with(b"HTTP/1.1 503"), "{saturated:?}");

    drop(held);
    let recovered = request_custom_file(runtime_state, path).await;
    assert!(recovered.starts_with(b"HTTP/1.1 200"), "{recovered:?}");
    assert!(
        recovered
            .windows(b"custom file".len())
            .any(|window| window == b"custom file"),
        "{recovered:?}"
    );
}

#[tokio::test]
async fn connection_permits_released() {
    let tmp = TempDir::new().unwrap();
    let config = RuntimeConfig::builder()
        .max_connections(1)
        .handler_timeout(Duration::from_secs(10))
        .build()
        .unwrap();

    let server = Server::builder()
        .runtime(config)
        .serve_config(Arc::new(ServeConfig {
            root: tmp.path().to_path_buf(),
            ..ServeConfig::default()
        }))
        .build()
        .unwrap();

    let handle = server
        .start_with_service(service_fn(|_req: Request| async {
            tokio::time::sleep(Duration::from_millis(200)).await;
            Ok(Response::builder()
                .status(StatusCode::OK)
                .body(ResponseBody::Bytes(b"done".to_vec()))
                .unwrap())
        }))
        .await
        .unwrap();

    let addr = handle.local_addr();

    // First connection holds the single permit.
    let mut conn1 = tokio::net::TcpStream::connect(addr).await.unwrap();
    conn1
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();

    // Give the server time to accept the first connection and acquire the permit.
    tokio::time::sleep(Duration::from_millis(50)).await;

    // Second connection should be dropped by the accept loop (permit exhausted).
    let _result = tokio::time::timeout(Duration::from_millis(500), async {
        let mut conn = tokio::net::TcpStream::connect(addr).await.unwrap();
        let mut buf = Vec::new();
        conn.read_to_end(&mut buf).await.unwrap();
        buf
    })
    .await;

    // Read the first connection's response.
    let mut buf1 = Vec::new();
    let _ = conn1.read_to_end(&mut buf1).await;

    // Wait for the first connection to complete and release the permit.
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Now a new connection should succeed.
    let mut conn2 = tokio::net::TcpStream::connect(addr).await.unwrap();
    conn2
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut buf2 = Vec::new();
    conn2.read_to_end(&mut buf2).await.unwrap();
    let response2 = String::from_utf8_lossy(&buf2);
    assert!(
        response2.starts_with("HTTP/1.1 200"),
        "second connection after permit release should succeed: {}",
        response2
    );

    handle.shutdown();
}

#[tokio::test]
async fn hop_by_hop_headers_stripped() {
    let response = Response::builder()
        .status(StatusCode::OK)
        .header("connection", "close")
        .unwrap()
        .header("upgrade", "websocket")
        .unwrap()
        .header("x-custom", "preserved")
        .unwrap()
        .body(ResponseBody::Bytes(b"test".to_vec()))
        .unwrap();

    let req = NormalizeRequest::new(false);
    let normalized = normalize_response(response, &req).unwrap();

    let headers = normalized.headers();
    let header_names: Vec<&str> = headers.iter().map(|f| f.name.as_str()).collect();

    assert!(
        !header_names
            .iter()
            .any(|n| n.eq_ignore_ascii_case("connection")),
        "hop-by-hop header 'Connection' should be stripped"
    );
    assert!(
        !header_names
            .iter()
            .any(|n| n.eq_ignore_ascii_case("upgrade")),
        "hop-by-hop header 'Upgrade' should be stripped"
    );
    assert!(
        header_names
            .iter()
            .any(|n| n.eq_ignore_ascii_case("x-custom")),
        "non-hop-by-hop header 'X-Custom' should be preserved"
    );
}

/// Connection metadata: verify real socket addresses are propagated to the
/// custom service through the Request envelope.
#[tokio::test]
async fn connection_metadata_propagated_to_service() {
    use eggserve_core::primitives::connection_info::Scheme;
    use std::sync::atomic::{AtomicBool, Ordering};

    static METADATA_SEEN: AtomicBool = AtomicBool::new(false);

    let tmp = TempDir::new().unwrap();
    let _state = build_state(&tmp);
    let config = RuntimeConfig::default();
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    let (tx, _rx) = broadcast::channel::<()>(1);

    let server = tokio::spawn(async move {
        let (stream, peer_addr) = listener.accept().await.unwrap();
        let io = TokioIo::new(stream);
        let mut shutdown_rx = tx.subscribe();
        let svc = service_fn(move |req: Request| {
            let peer_addr = peer_addr;
            async move {
                let conn = req.connection();
                // Verify real addresses are present (not placeholder 127.0.0.1:0).
                assert_ne!(
                    conn.remote_addr.port(),
                    0,
                    "remote port should be a real ephemeral port"
                );
                assert_eq!(conn.remote_addr, peer_addr);
                assert_eq!(conn.local_addr, addr);
                assert_eq!(conn.scheme, Scheme::Http);
                assert!(conn.tls.is_none());
                METADATA_SEEN.store(true, Ordering::SeqCst);
                Ok(Response::builder()
                    .status(StatusCode::OK)
                    .body(ResponseBody::Bytes(b"ok".to_vec()))
                    .unwrap())
            }
        });
        serve_connection_with_runtime_state(
            io,
            svc,
            &config,
            Arc::new(RuntimeState::new_for_testing(config.max_file_streams)),
            &mut shutdown_rx,
            1,
            addr,
            peer_addr,
            false,
            None,
        )
        .await;
    });

    let mut client = tokio::net::TcpStream::connect(addr).await.unwrap();
    client
        .write_all(b"GET /test HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut buf = Vec::new();
    let _ = client.read_to_end(&mut buf).await;
    let _ = server.await;

    assert!(
        METADATA_SEEN.load(Ordering::SeqCst),
        "connection metadata should be visible to the service"
    );
}

#[tokio::test]
async fn client_disconnect_releases_file_stream_permits() {
    let tmp = TempDir::new().unwrap();
    let path = tmp.path().join("large.bin");
    std::fs::write(&path, vec![b'x'; 16 * 1024 * 1024]).unwrap();
    let config = RuntimeConfig::builder()
        .bind("127.0.0.1:0".parse().unwrap())
        .max_file_streams(1)
        .build()
        .unwrap();
    let server = Server::builder().runtime(config).build().unwrap();
    let service = service_fn(move |_request: Request| {
        let path = path.clone();
        async move {
            let file = File::open(&path).unwrap();
            let len = file.metadata().unwrap().len();
            Ok(Response::builder()
                .status(StatusCode::OK)
                .body(ResponseBody::File(BodySource::FileFull {
                    file,
                    len,
                    mime: "application/octet-stream",
                }))
                .unwrap())
        }
    });
    let handle = server.start_with_service(service).await.unwrap();
    let addr = handle.local_addr();

    // Client A connects and starts streaming a large file response.
    let mut first = tokio::net::TcpStream::connect(addr).await.unwrap();
    first
        .write_all(b"GET /first HTTP/1.1\r\nHost: localhost\r\n\r\n")
        .await
        .unwrap();
    // Read only the response headers to confirm streaming started.
    let mut first_headers = Vec::new();
    loop {
        let mut byte = [0u8; 1];
        first.read_exact(&mut byte).await.unwrap();
        first_headers.push(byte[0]);
        if first_headers.ends_with(b"\r\n\r\n") {
            break;
        }
    }
    assert!(String::from_utf8_lossy(&first_headers).starts_with("HTTP/1.1 200"));

    // Client C should get503 while client A holds the only permit.
    let mut second = tokio::net::TcpStream::connect(addr).await.unwrap();
    second
        .write_all(b"GET /second HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut second_response = Vec::new();
    second.read_to_end(&mut second_response).await.unwrap();
    assert!(
        String::from_utf8_lossy(&second_response).starts_with("HTTP/1.1 503"),
        "expected shared file admission to reject second stream: {:?}",
        String::from_utf8_lossy(&second_response)
    );

    // Drop client A — the server's body stream and permit are released.
    drop(first);
    // Allow the server to process the disconnect and release the permit.
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Client C retries and should succeed with200 now that the permit is free.
    let mut third = tokio::net::TcpStream::connect(addr).await.unwrap();
    third
        .write_all(b"GET /third HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut third_response = Vec::new();
    third.read_to_end(&mut third_response).await.unwrap();
    let third_str = String::from_utf8_lossy(&third_response);
    assert!(
        third_str.starts_with("HTTP/1.1 200"),
        "expected200 after disconnect release: {}",
        third_str
    );

    handle.shutdown();
}

#[tokio::test]
async fn runtime_file_admission_is_shared_across_connections() {
    let tmp = TempDir::new().unwrap();
    let path = tmp.path().join("shared.bin");
    std::fs::write(&path, vec![b'x'; 16 * 1024 * 1024]).unwrap();
    let config = RuntimeConfig::builder()
        .bind("127.0.0.1:0".parse().unwrap())
        .max_file_streams(1)
        .build()
        .unwrap();
    let server = Server::builder().runtime(config).build().unwrap();
    let service = service_fn(move |_request: Request| {
        let path = path.clone();
        async move {
            let file = File::open(&path).unwrap();
            let len = file.metadata().unwrap().len();
            Ok(Response::builder()
                .status(StatusCode::OK)
                .body(ResponseBody::File(BodySource::FileFull {
                    file,
                    len,
                    mime: "application/octet-stream",
                }))
                .unwrap())
        }
    });
    let handle = server.start_with_service(service).await.unwrap();
    let addr = handle.local_addr();

    let mut first = tokio::net::TcpStream::connect(addr).await.unwrap();
    first
        .write_all(b"GET /first HTTP/1.1\r\nHost: localhost\r\n\r\n")
        .await
        .unwrap();
    let mut first_headers = Vec::new();
    loop {
        let mut byte = [0u8; 1];
        first.read_exact(&mut byte).await.unwrap();
        first_headers.push(byte[0]);
        if first_headers.ends_with(b"\r\n\r\n") {
            break;
        }
    }
    assert!(String::from_utf8_lossy(&first_headers).starts_with("HTTP/1.1 200"));

    let mut second = tokio::net::TcpStream::connect(addr).await.unwrap();
    second
        .write_all(b"GET /second HTTP/1.1\r\nHost: localhost\r\nConnection: close\r\n\r\n")
        .await
        .unwrap();
    let mut second_response = Vec::new();
    second.read_to_end(&mut second_response).await.unwrap();
    assert!(
        String::from_utf8_lossy(&second_response).starts_with("HTTP/1.1 503"),
        "expected shared file admission to reject second stream: {:?}",
        String::from_utf8_lossy(&second_response)
    );

    drop(first);
    handle.shutdown();
}