nidus-http 1.0.2

Axum and Tower HTTP integration, controllers, middleware, health, metrics, and server defaults for Nidus.
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

use std::{
    convert::Infallible,
    sync::{Arc, Mutex},
    time::Duration,
};

use axum::{Router, body::Body, routing::get};
use http::{Method, Request, Response, StatusCode};
use nidus_http::middleware::{
    HttpMetricsHook, RouteMakeSpan, route_metrics_layer, route_trace_layer,
};
use tower::{ServiceBuilder, ServiceExt, service_fn};
use tower_http::trace::MakeSpan;

#[derive(Clone, Default)]
struct RecordingMetrics {
    events: Arc<Mutex<Vec<String>>>,
}

impl RecordingMetrics {
    fn events(&self) -> Vec<String> {
        self.events.lock().unwrap().clone()
    }
}

impl HttpMetricsHook for RecordingMetrics {
    fn on_request(&self, method: &Method, route: Option<&str>) {
        self.events
            .lock()
            .unwrap()
            .push(format!("request {method} {}", route.unwrap_or("<unknown>")));
    }

    fn on_response(
        &self,
        method: &Method,
        route: Option<&str>,
        status: StatusCode,
        _latency: Duration,
    ) {
        self.events.lock().unwrap().push(format!(
            "response {method} {} {status}",
            route.unwrap_or("<unknown>")
        ));
    }

    fn on_error(&self, method: &Method, route: Option<&str>, _latency: Duration) {
        self.events
            .lock()
            .unwrap()
            .push(format!("error {method} {}", route.unwrap_or("<unknown>")));
    }
}

#[tokio::test]
async fn route_metrics_layer_records_request_and_response() {
    let metrics = RecordingMetrics::default();
    let service = ServiceBuilder::new()
        .layer(route_metrics_layer("/users/{id}", metrics.clone()))
        .service(service_fn(|_request: Request<()>| async {
            Ok::<_, Infallible>(
                Response::builder()
                    .status(StatusCode::CREATED)
                    .body(())
                    .unwrap(),
            )
        }));

    let response = service
        .oneshot(
            Request::builder()
                .method(Method::POST)
                .uri("/users/42")
                .body(())
                .unwrap(),
        )
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::CREATED);
    assert_eq!(
        metrics.events(),
        [
            "request POST /users/{id}",
            "response POST /users/{id} 201 Created"
        ]
    );
}

#[tokio::test]
async fn route_metrics_layer_records_inner_service_errors() {
    let metrics = RecordingMetrics::default();
    let service = ServiceBuilder::new()
        .layer(route_metrics_layer("/users/{id}", metrics.clone()))
        .service(service_fn(|_request: Request<()>| async {
            Err::<Response<()>, _>("database unavailable")
        }));

    let error = service
        .oneshot(
            Request::builder()
                .method(Method::GET)
                .uri("/users/42")
                .body(())
                .unwrap(),
        )
        .await
        .unwrap_err();

    assert_eq!(error, "database unavailable");
    assert_eq!(
        metrics.events(),
        ["request GET /users/{id}", "error GET /users/{id}"]
    );
}

#[test]
fn route_make_span_records_route_label_field() {
    let mut make_span = RouteMakeSpan::new("/users/{id}");
    let request = Request::builder()
        .method(Method::GET)
        .uri("/users/42")
        .body(())
        .unwrap();

    let span = make_span.make_span(&request);
    let metadata = span.metadata().unwrap();

    assert_eq!(metadata.name(), "request");
    assert!(metadata.fields().field("method").is_some());
    assert!(metadata.fields().field("uri").is_some());
    assert!(metadata.fields().field("route").is_some());
}

#[tokio::test]
async fn route_trace_layer_preserves_http_responses() {
    let app = Router::new()
        .route("/users/42", get(|| async { "ok" }))
        .layer(route_trace_layer("/users/{id}"));

    let response = app
        .oneshot(
            Request::builder()
                .method(Method::GET)
                .uri("/users/42")
                .body(Body::empty())
                .unwrap(),
        )
        .await
        .unwrap();

    assert_eq!(response.status(), StatusCode::OK);
}