vantus 0.3.0

Macro-first async Rust backend framework with explicit composition, typed extraction, and hardened HTTP defaults.
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
use std::sync::{Arc, Mutex};
use std::time::{SystemTime, UNIX_EPOCH};

use async_trait::async_trait;
use vantus::{
    AtomicIdGenerator, FrameworkError, HostBuilder, HostContext, LogLevel, LogSink, Request,
    RequestLogEvent, RequestState, Response, TextBody, module,
};
use vantus_observability::{
    ObservabilityModule, ReadinessCheck, ReadinessContributor, ReadinessRegistry, RequestId,
};

fn write_ephemeral_config(name: &str) -> std::path::PathBuf {
    let unique = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap()
        .as_nanos();
    let path =
        std::env::temp_dir().join(format!("vantus-observability-{name}-{unique}.properties"));
    std::fs::write(
        &path,
        "server.bind-port=0\nserver.protocol=auto\nserver.read-timeout-seconds=3\nserver.handler-timeout-seconds=3\n",
    )
    .unwrap();
    path
}

struct HealthyDatabase;

#[async_trait]
impl ReadinessContributor for HealthyDatabase {
    async fn check(&self) -> ReadinessCheck {
        ReadinessCheck::healthy("database", "connected")
    }
}

#[derive(Clone, Default)]
struct ProbeModule {
    readiness: Arc<ReadinessRegistry>,
}

#[module]
impl ProbeModule {
    #[vantus::get("/request-id")]
    fn request_id(&self, request_id: RequestState<RequestId>) -> Response {
        Response::text(request_id.as_ref().as_str().to_string())
    }

    #[vantus::post("/echo")]
    fn echo(&self, body: TextBody) -> Response {
        Response::text(body.as_str().to_string())
    }

    async fn on_start(&self, host: &HostContext) -> Result<(), FrameworkError> {
        self.readiness.register(Arc::new(HealthyDatabase)).await;
        host.log_sink().log_text(
            vantus::LogLevel::Info,
            "tests.observability",
            "probe module started",
        );
        Ok(())
    }
}

#[derive(Clone, Default)]
struct CapturedLogSink {
    request_events: Arc<Mutex<Vec<(String, RequestLogEvent)>>>,
    text_events: Arc<Mutex<Vec<(LogLevel, String, String)>>>,
}

impl LogSink for CapturedLogSink {
    fn log_text(&self, level: LogLevel, target: &str, message: &str) {
        self.text_events
            .lock()
            .unwrap()
            .push((level, target.to_string(), message.to_string()));
    }

    fn log_request(&self, target: &str, event: &RequestLogEvent) {
        self.request_events
            .lock()
            .unwrap()
            .push((target.to_string(), event.clone()));
    }
}

#[derive(Clone, Default)]
struct OrderModule;

#[module]
impl OrderModule {
    #[vantus::get("/orders/{id}")]
    fn show(&self) -> Response {
        Response::text("ok")
    }
}

#[tokio::test]
async fn observability_module_exposes_request_id_and_diag_routes() {
    let config_path = write_ephemeral_config("diag");
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    let request_id_response = host
        .handle(Request::from_bytes(b"GET /request-id HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    assert_eq!(request_id_response.status_code, 200);
    assert!(
        request_id_response
            .headers
            .iter()
            .any(|(key, _)| key == "X-Request-Id")
    );

    let server = host.serve().await.unwrap();
    let diag = host_request(server.local_addr(), "/diag").await;
    assert!(diag.contains("\"runtime\""), "{diag}");
    assert!(diag.contains("\"limiter_saturated_total\""), "{diag}");

    let ready = host_request(server.local_addr(), "/ready").await;
    assert!(ready.contains("\"database\""), "{ready}");

    server.shutdown();
    server.wait().await.unwrap();
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn request_state_uses_typed_context_state_api() {
    let config_path = write_ephemeral_config("request-state");
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    let response = host
        .handle(Request::from_bytes(b"GET /request-id HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;

    assert_eq!(response.status_code, 200);
    assert!(!String::from_utf8(response.body).unwrap().is_empty());
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn observability_module_uses_shared_id_generator_service() {
    let config_path = write_ephemeral_config("custom-request-id");
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.id_generator(AtomicIdGenerator::with_prefix("req"));
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    let response = host
        .handle(Request::from_bytes(b"GET /request-id HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let body = String::from_utf8(response.body).unwrap();

    assert!(body.starts_with("req-"), "{body}");
    assert!(
        response
            .headers
            .iter()
            .any(|(key, value)| key == "X-Request-Id" && value.starts_with("req-"))
    );
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn metrics_endpoint_reports_runtime_and_route_counters() {
    let config_path = write_ephemeral_config("metrics");
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();
    let server = host.serve().await.unwrap();

    let ok = raw_request(
        server.local_addr(),
        b"GET /request-id HTTP/1.1\r\nHost: local\r\nConnection: close\r\n\r\n",
    )
    .await;
    assert!(ok.starts_with("HTTP/1.1 200"), "{ok}");

    let wrong_method = raw_request(
        server.local_addr(),
        b"POST /request-id HTTP/1.1\r\nHost: local\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
    )
    .await;
    assert!(wrong_method.starts_with("HTTP/1.1 405"), "{wrong_method}");

    let wrong_media = raw_request(
        server.local_addr(),
        b"POST /echo HTTP/1.1\r\nHost: local\r\nContent-Type: application/json\r\nContent-Length: 5\r\nConnection: close\r\n\r\nhello",
    )
    .await;
    assert!(wrong_media.starts_with("HTTP/1.1 415"), "{wrong_media}");

    let metrics = host_request(server.local_addr(), "/metrics").await;
    assert!(metrics.contains("vantus_requests_total"), "{metrics}");
    assert!(
        metrics.contains("vantus_route_requests_total{"),
        "{metrics}"
    );
    assert!(
        metrics.contains("vantus_runtime_total_requests"),
        "{metrics}"
    );
    assert!(
        metrics.contains("vantus_runtime_method_not_allowed_total 1"),
        "{metrics}"
    );
    assert!(
        metrics.contains("vantus_runtime_content_type_rejections_total 1"),
        "{metrics}"
    );

    server.shutdown();
    server.wait().await.unwrap();
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn liveness_and_readiness_toggle_with_host_lifecycle() {
    let config_path = write_ephemeral_config("lifecycle-toggle");
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    let pre_live = host
        .handle(Request::from_bytes(b"GET /live HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let pre_ready = host
        .handle(Request::from_bytes(b"GET /ready HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    assert_eq!(
        String::from_utf8(pre_live.body).unwrap(),
        "{\"status\":\"stopped\"}"
    );
    assert_eq!(pre_ready.status_code, 503);

    let server = host.serve().await.unwrap();
    let live = host_request(server.local_addr(), "/live").await;
    let ready = host_request(server.local_addr(), "/ready").await;
    assert!(live.contains("\"status\":\"ok\""), "{live}");
    assert!(ready.contains("\"status\":\"ok\""), "{ready}");

    server.shutdown();
    server.wait().await.unwrap();

    let mut post_builder = HostBuilder::new();
    post_builder.module(observability.clone());
    let post_host = post_builder.build();
    let post_live = post_host
        .handle(Request::from_bytes(b"GET /live HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let post_ready = post_host
        .handle(Request::from_bytes(b"GET /ready HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    assert_eq!(
        String::from_utf8(post_live.body).unwrap(),
        "{\"status\":\"stopped\"}"
    );
    assert_eq!(post_ready.status_code, 503);
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn request_id_is_propagated_to_state_header_and_structured_logs() {
    let logs = CapturedLogSink::default();
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.log_sink(logs.clone());
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    let response = host
        .handle(Request::from_bytes(b"GET /request-id HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let body = String::from_utf8(response.body).unwrap();
    let header = response
        .headers
        .iter()
        .find(|(key, _)| key == "X-Request-Id")
        .map(|(_, value)| value.clone())
        .expect("request id header");
    let request_events = logs.request_events.lock().unwrap().clone();
    let (_, event) = request_events.last().expect("structured request log");

    assert_eq!(body, header);
    assert_eq!(event.request_id.as_deref(), Some(body.as_str()));
    assert_eq!(event.status_code, 200);
    assert_eq!(event.path, "/request-id");
}

#[tokio::test]
async fn prometheus_metrics_increment_with_request_volume() {
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.module(observability.clone());
    builder.module(ProbeModule {
        readiness: observability.readiness_registry(),
    });
    let host = builder.build();

    for _ in 0..2 {
        let response = host
            .handle(
                Request::from_bytes(b"GET /request-id HTTP/1.1\r\nHost: local\r\n\r\n").unwrap(),
            )
            .await;
        assert_eq!(response.status_code, 200);
    }

    let metrics = host
        .handle(Request::from_bytes(b"GET /metrics HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let body = String::from_utf8(metrics.body).unwrap();

    assert!(body.contains("vantus_requests_total 2"), "{body}");
    assert!(
        body.contains(
            "vantus_route_requests_total{method=\"GET\",route=\"/request-id\",status=\"200\"} 2"
        ),
        "{body}"
    );
}

#[tokio::test]
async fn structured_logging_includes_request_context_and_sanitized_paths() {
    let config_path = write_ephemeral_config("structured-log-context");
    std::fs::write(
        &config_path,
        "server.bind-port=0\nserver.protocol=auto\nserver.trusted-proxies=127.0.0.1\n",
    )
    .unwrap();
    let logs = CapturedLogSink::default();
    let observability = ObservabilityModule::default();
    let mut builder = HostBuilder::new();
    builder.config_file(&config_path);
    builder.log_sink(logs.clone());
    builder.module(observability);
    builder.module(OrderModule);
    let host = builder.build();
    let server = host.serve().await.unwrap();

    let response = raw_request(
        server.local_addr(),
        b"GET /orders/1234567890 HTTP/1.1\r\nHost: local\r\nX-Forwarded-For: 203.0.113.10\r\nConnection: close\r\n\r\n",
    )
    .await;
    assert!(response.starts_with("HTTP/1.1 200"), "{response}");

    server.shutdown();
    server.wait().await.unwrap();

    let request_events = logs.request_events.lock().unwrap().clone();
    let (_, event) = request_events.last().expect("structured request log");
    assert_eq!(event.path, "/orders/:redacted");
    assert_eq!(event.client_ip.as_deref(), Some("203.0.113.10"));
    assert_eq!(event.status_code, 200);
    assert!(event.request_id.is_some());
    assert!(event.headers.is_empty());
    let _ = std::fs::remove_file(config_path);
}

#[tokio::test]
async fn diagnostic_endpoints_are_not_exposed_without_observability_module() {
    let mut builder = HostBuilder::new();
    builder.module(ProbeModule::default());
    let host = builder.build();

    let diag = host
        .handle(Request::from_bytes(b"GET /diag HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;
    let metrics = host
        .handle(Request::from_bytes(b"GET /metrics HTTP/1.1\r\nHost: local\r\n\r\n").unwrap())
        .await;

    assert_eq!(diag.status_code, 404);
    assert_eq!(metrics.status_code, 404);
}

async fn host_request(addr: std::net::SocketAddr, path: &str) -> String {
    use tokio::io::{AsyncReadExt, AsyncWriteExt};
    use tokio::net::TcpStream;

    let mut stream = TcpStream::connect(addr).await.unwrap();
    let request = format!("GET {path} HTTP/1.1\r\nHost: local\r\nConnection: close\r\n\r\n");
    stream.write_all(request.as_bytes()).await.unwrap();
    let mut response = Vec::new();
    stream.read_to_end(&mut response).await.unwrap();
    String::from_utf8_lossy(&response).into_owned()
}

async fn raw_request(addr: std::net::SocketAddr, raw: &[u8]) -> String {
    use tokio::io::{AsyncReadExt, AsyncWriteExt};
    use tokio::net::TcpStream;

    let mut stream = TcpStream::connect(addr).await.unwrap();
    stream.write_all(raw).await.unwrap();
    let mut response = Vec::new();
    stream.read_to_end(&mut response).await.unwrap();
    String::from_utf8_lossy(&response).into_owned()
}