rama 0.3.0

modular service framework
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
use std::io::Write as _;

use rama::{
    Layer as _, Service,
    error::extra::OpaqueError,
    futures::StreamExt as _,
    http::{
        Body, BodyExtractExt, Method, Request, Response, StatusCode, Version,
        body::util::BodyExt,
        client::EasyHttpWebClient,
        header::{ACCEPT_ENCODING, CONTENT_ENCODING},
        headers::{ContentLength, HeaderMapExt, encoding::AcceptEncoding},
        layer::decompression::DecompressionLayer,
        service::client::{HttpClientExt, multipart},
    },
    rt::Executor,
    service::BoxService,
    tls::client::{ServerVerifyMode, TlsClientConfig},
    utils::octets::{kib, mib},
    utils::str::any_submatch_ignore_ascii_case,
};

use super::utils;
use flate2::{Compression, write::GzEncoder};

#[ignore]
#[tokio::test]
async fn test_http_tests() {
    utils::init_tracing();
    let _guard = utils::RamaService::serve_http_test(63133, false);
    run_http_tests("http://127.0.0.1:63133").await;
}

#[ignore]
#[tokio::test]
async fn test_http_tests_over_tls() {
    utils::init_tracing();
    let _guard = utils::RamaService::serve_http_test(63134, true);
    run_http_tests("https://127.0.0.1:63134").await;
}

async fn run_http_tests(base_uri: &'static str) {
    let client = EasyHttpWebClient::connector_builder()
        .with_default_transport_connector()
        .with_default_dns_connector()
        .without_tls_proxy_support()
        .without_proxy_support()
        .with_tls_support_using_boringssl(
            TlsClientConfig::default_http().with_server_verify(ServerVerifyMode::Disable),
        )
        .with_default_http_connector(Executor::default())
        .build_client()
        .boxed();

    for http_version in [Version::HTTP_10, Version::HTTP_11, Version::HTTP_2] {
        run_http_test_endpoint_method(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_request_compression(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_response_compression(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_response_stream(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_response_stream_compression(client.clone(), base_uri, http_version)
            .await;
        run_http_test_endpoint_sse(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_octet_stream(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_multipart(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_bytes(client.clone(), base_uri, http_version).await;
        run_http_test_endpoint_sink(client.clone(), base_uri, http_version).await;
    }
}

async fn run_http_test_endpoint_method(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    for method in [
        Method::GET,
        Method::POST,
        Method::PUT,
        Method::TRACE,
        Method::DELETE,
        Method::PATCH,
        Method::QUERY,
        Method::from_bytes(b"COFFEE").unwrap(),
    ] {
        let resp = client
            .request(method.clone(), format!("{base_uri}/method"))
            .version(http_version)
            .send()
            .await
            .unwrap();
        assert_eq!(StatusCode::OK, resp.status());
        let ContentLength(content_length) = resp.headers().typed_get().unwrap();
        let expected_payload = method.to_string();
        assert_eq!(expected_payload.len(), content_length as usize);
        assert_eq!(expected_payload, resp.try_into_string().await.unwrap());
    }
    assert!(
        client
            .connect(format!("{base_uri}/method"))
            .version(http_version)
            .send()
            .await
            .unwrap()
            .status()
            .is_client_error()
    );
}

async fn run_http_test_endpoint_request_compression(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    for method in [Method::POST, Method::PUT, Method::PATCH] {
        let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
        encoder.write_all(b"Hello?").unwrap();
        let body = encoder.finish().unwrap();
        let req = Request::builder()
            .uri(format!("{base_uri}/request-compression"))
            .version(http_version)
            .method(method)
            .header(CONTENT_ENCODING, "gzip")
            .body(Body::from(body))
            .unwrap();

        let resp = client.serve(req).await.unwrap();

        assert_eq!(StatusCode::OK, resp.status());
        let ContentLength(content_length) = resp.headers().typed_get().unwrap();
        assert_eq!(6, content_length);
        assert_eq!("Hello?", resp.try_into_string().await.unwrap());
    }

    // Decompression bomb: a small gzip payload that inflates past the endpoint's
    // 8 MiB body limit must be rejected. The limit is applied *after*
    // decompression, so a tiny compressed body cannot smuggle a huge one through.
    let mut encoder = GzEncoder::new(Vec::new(), Compression::default());
    encoder.write_all(&vec![0u8; 9 * 1024 * 1024]).unwrap();
    let bomb = encoder.finish().unwrap();
    let req = Request::builder()
        .uri(format!("{base_uri}/request-compression"))
        .version(http_version)
        .method(Method::POST)
        .header(CONTENT_ENCODING, "gzip")
        .body(Body::from(bomb))
        .unwrap();
    let resp = client.serve(req).await.unwrap();
    assert!(
        resp.status().is_client_error(),
        "decompression bomb must be rejected, got status {}",
        resp.status(),
    );
}

async fn run_http_test_endpoint_response_compression(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let client = DecompressionLayer::new().into_layer(client);

    for maybe_accept_encoding in [
        None,
        Some(AcceptEncoding::new_deflate()),
        Some(AcceptEncoding::new_deflate().with_br(true)),
        Some(AcceptEncoding::new_gzip()),
        Some(AcceptEncoding::new_zstd()),
        Some(AcceptEncoding::new_zstd().with_gzip(true)),
        Some(AcceptEncoding::new_br()),
        Some(AcceptEncoding::default()),
    ] {
        let req = client
            .get(format!("{base_uri}/response-compression"))
            .version(http_version);

        let req = if let Some(accept_encoding) =
            maybe_accept_encoding.and_then(|ae| ae.maybe_to_header_value())
        {
            req.header(ACCEPT_ENCODING, accept_encoding)
        } else {
            req
        };

        let resp = req.send().await.unwrap();

        assert_eq!(StatusCode::OK, resp.status());

        let payload = resp.try_into_string().await.unwrap();
        assert!(payload.starts_with("# Ethical principles of hacking"));
        assert!(payload.contains("All information should be free"));
        assert!(payload.ends_with(
            "the Chaos Computer Club (CCC).
"
        ));
    }
}

async fn run_http_test_endpoint_response_stream(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let resp = client
        .get(format!("{base_uri}/response-stream"))
        .version(http_version)
        .send()
        .await
        .unwrap();

    assert_eq!(StatusCode::OK, resp.status());

    assert!(!resp.headers().contains_key("content-length"));

    let payload = resp.try_into_string().await.unwrap();
    assert!(payload.contains("<title>Chunked transfer encoding test</title>"));
    assert!(payload.contains("This is a chunked response after 100 ms"));
    assert!(payload.contains("all chunks are sent to a client.</h5></body></html>"));
}

async fn run_http_test_endpoint_response_stream_compression(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let client = DecompressionLayer::new().into_layer(client);

    for maybe_accept_encoding in [
        None,
        Some(AcceptEncoding::new_deflate()),
        Some(AcceptEncoding::new_deflate().with_br(true)),
        Some(AcceptEncoding::new_gzip()),
        Some(AcceptEncoding::new_zstd()),
        Some(AcceptEncoding::new_zstd().with_gzip(true)),
        Some(AcceptEncoding::new_br()),
        Some(AcceptEncoding::default()),
    ] {
        let req = client
            .get(format!("{base_uri}/response-stream-compression"))
            .version(http_version);

        let req = if let Some(accept_encoding) =
            maybe_accept_encoding.and_then(|ae| ae.maybe_to_header_value())
        {
            req.header(ACCEPT_ENCODING, accept_encoding)
        } else {
            req
        };

        let resp = req.send().await.unwrap();

        assert_eq!(StatusCode::OK, resp.status());

        assert!(!resp.headers().contains_key("content-length"));

        let payload = resp.try_into_string().await.unwrap_or_else(|err| {
            panic!("decompression faile for {maybe_accept_encoding:?}: {err}")
        });

        assert!(payload.contains("<title>Chunked transfer encoding test</title>"));
        assert!(payload.contains("This is a chunked response after 100 ms"));
        assert!(payload.contains("all chunks are sent to a client.</h5></body></html>"));
    }
}

async fn run_http_test_endpoint_sse(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let resp = client
        .get(format!("{base_uri}/sse"))
        .version(http_version)
        .send()
        .await
        .unwrap();

    assert_eq!(StatusCode::OK, resp.status());

    let mut stream = resp.into_body().into_string_data_event_stream();

    for expected_event in [
        "Wake up slowly, enjoy morning light",
        "Make loose plans, feel excited",
        "Do one thing, celebrate it",
        "Go to bed, feeling okay",
    ] {
        let event = stream.next().await.unwrap().unwrap();
        let data = event.into_data().unwrap();
        assert_eq!(expected_event, data);
    }

    assert!(stream.next().await.is_none());
}

async fn run_http_test_endpoint_octet_stream(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let payload: Vec<u8> = (0u8..=200).collect();
    let resp = client
        .post(format!("{base_uri}/octet-stream"))
        .version(http_version)
        .octet_stream(payload.clone())
        .send()
        .await
        .unwrap();

    assert_eq!(StatusCode::OK, resp.status());
    assert_eq!(
        Some("application/octet-stream"),
        resp.headers()
            .get(rama::http::header::CONTENT_TYPE)
            .and_then(|v| v.to_str().ok()),
    );
    let echoed = resp.into_body().collect().await.unwrap().to_bytes();
    assert_eq!(payload.as_slice(), echoed.as_ref());
}

async fn run_http_test_endpoint_multipart(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    let form = multipart::Form::new().text("username", "glen").part(
        "attachment",
        multipart::Part::bytes(b"hello rama".as_slice())
            .with_file_name("note.txt")
            .try_with_mime_str("text/plain")
            .unwrap(),
    );

    let resp = client
        .post(format!("{base_uri}/multipart"))
        .version(http_version)
        .multipart(form)
        .send()
        .await
        .unwrap();

    assert_eq!(StatusCode::OK, resp.status());

    let body: serde_json::Value = resp.try_into_json().await.unwrap();
    let parts = body.get("parts").and_then(|v| v.as_array()).unwrap();
    assert_eq!(parts.len(), 2);

    let username = &parts[0];
    assert_eq!(username["name"].as_str(), Some("username"));
    assert!(username["filename"].is_null());
    assert_eq!(username["size"].as_u64(), Some(4));
    assert_eq!(username["text"].as_str(), Some("glen"));

    let attachment = &parts[1];
    assert_eq!(attachment["name"].as_str(), Some("attachment"));
    assert_eq!(attachment["filename"].as_str(), Some("note.txt"));
    assert_eq!(attachment["content_type"].as_str(), Some("text/plain"));
    assert_eq!(attachment["size"].as_u64(), Some(10));
    assert_eq!(attachment["text"].as_str(), Some("hello rama"));

    // Per-field cap (256 KiB) — sending a single field larger than that
    // should produce 413 Payload Too Large.
    //
    // The server detects the overflow mid-stream, returns 413, and
    // closes the connection. Whether the client observes the 413 or a
    // transport error (BrokenPipe / ConnectionReset / connection
    // aborted) depends on whether it finishes writing the body before
    // the server's close reaches it — a fundamental HTTP race for
    // early-error responses. Either outcome proves the cap was
    // enforced; we accept both to keep the test stable across CI
    // load.
    let big = vec![b'x'; kib(300)];
    let oversized = multipart::Form::new().part("blob", multipart::Part::bytes(big));
    match client
        .post(format!("{base_uri}/multipart"))
        .version(http_version)
        .multipart(oversized)
        .send()
        .await
    {
        Ok(resp) => assert_eq!(StatusCode::PAYLOAD_TOO_LARGE, resp.status()),
        Err(err) => {
            let msg = format!("{err:#}");
            assert!(
                any_submatch_ignore_ascii_case(
                    &msg,
                    [
                        "broken pipe",
                        "connection reset",
                        "connection aborted",
                        "connection closed",
                    ],
                ),
                "expected 413 response or transport-close error, got: {msg}",
            );
        }
    }
}

async fn run_http_test_endpoint_bytes(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    // default size (1 KiB)
    let resp = client
        .get(format!("{base_uri}/bytes"))
        .version(http_version)
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    assert_eq!(1024, body.len());
    assert!(body.iter().all(|&b| b == 0));

    // explicit size, default chunk
    let resp = client
        .get(format!("{base_uri}/bytes?size=4096"))
        .version(http_version)
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    assert_eq!(4096, body.len());

    // small chunk so we exercise multi-chunk streaming without delay
    let resp = client
        .get(format!("{base_uri}/bytes?size=4096&chunk=512"))
        .version(http_version)
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    assert_eq!(4096, body.len());

    // size=0 is valid (empty body)
    let resp = client
        .get(format!("{base_uri}/bytes?size=0"))
        .version(http_version)
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body = resp.into_body().collect().await.unwrap().to_bytes();
    assert_eq!(0, body.len());

    // invalid parameters → 400
    for bad_url in [
        format!("{base_uri}/bytes?size=abc"),
        format!("{base_uri}/bytes?chunk=0"),
        format!("{base_uri}/bytes?delay_ms=99999999"),
    ] {
        let resp = client
            .get(bad_url)
            .version(http_version)
            .send()
            .await
            .unwrap();
        assert_eq!(StatusCode::BAD_REQUEST, resp.status());
    }
}

async fn run_http_test_endpoint_sink(
    client: BoxService<Request, Response, OpaqueError>,
    base_uri: &'static str,
    http_version: Version,
) {
    // empty body
    let resp = client
        .post(format!("{base_uri}/sink"))
        .version(http_version)
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body: serde_json::Value = resp.try_into_json().await.unwrap();
    assert_eq!(body["bytes"].as_u64(), Some(0));

    // small body
    let payload = b"hello rama sink";
    let resp = client
        .post(format!("{base_uri}/sink"))
        .version(http_version)
        .octet_stream(payload.as_slice())
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body: serde_json::Value = resp.try_into_json().await.unwrap();
    assert_eq!(body["bytes"].as_u64(), Some(payload.len() as u64));

    // larger body (1 MiB) — exercises multi-frame draining
    let big = vec![0u8; mib(1)];
    let resp = client
        .post(format!("{base_uri}/sink"))
        .version(http_version)
        .octet_stream(big.clone())
        .send()
        .await
        .unwrap();
    assert_eq!(StatusCode::OK, resp.status());
    let body: serde_json::Value = resp.try_into_json().await.unwrap();
    assert_eq!(body["bytes"].as_u64(), Some(big.len() as u64));
}