footing 0.6.6

Feature-gated foundations for Rust backend services
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
use axum::{
    http::{
        HeaderMap, HeaderValue, StatusCode,
        header::{ACCEPT, CACHE_CONTROL, CONTENT_TYPE, VARY, X_CONTENT_TYPE_OPTIONS},
    },
    response::{IntoResponse, Response},
};

use crate::http::{header_list_items, parse_quality};
use crate::observability::{MetricsSnapshot, encode_openmetrics, encode_prometheus};

/// OpenMetrics 1.0 exposition content type.
pub const OPENMETRICS_CONTENT_TYPE: &str =
    "application/openmetrics-text; version=1.0.0; charset=utf-8";
/// Prometheus text 0.0.4, also suitable for browser previews.
pub const PROMETHEUS_CONTENT_TYPE: &str = "text/plain; version=0.0.4; charset=utf-8";

/// A metrics snapshot response. Direct conversion preserves OpenMetrics output.
/// Use [`Self::negotiate`] in handlers to select a format from the request headers.
/// All outputs, including negotiation failures, send `Cache-Control: no-store`
/// so intermediaries do not reuse stale snapshots. Applications can override
/// this header on the resulting response.
///
/// ```
/// use std::sync::Arc;
/// use axum::{extract::State, http::{HeaderMap, StatusCode}, response::Response};
/// use footing::{http::MetricsResponse, observability::MetricRegistry};
///
/// async fn metrics(
///     State(registry): State<Arc<MetricRegistry>>,
///     headers: HeaderMap,
/// ) -> Result<Response, StatusCode> {
///     let snapshot = registry.snapshot().map_err(|_| StatusCode::SERVICE_UNAVAILABLE)?;
///     Ok(MetricsResponse(snapshot).negotiate(&headers))
/// }
/// ```
pub struct MetricsResponse(pub MetricsSnapshot);

impl MetricsResponse {
    /// Returns Prometheus text 0.0.4 with a browser-readable text/plain MIME type.
    /// This uses its own encoding rules, not an OpenMetrics body with a new header.
    pub fn plain_text(self) -> Response {
        response(encode_prometheus(&self.0), PROMETHEUS_CONTENT_TYPE)
    }

    /// Negotiates OpenMetrics 1.0 or Prometheus text 0.0.4 using Accept.
    ///
    /// Honors quality, specificity, versions, UTF-8 charset and repeated headers.
    /// No Accept header or equal wildcard preferences select browser-readable text.
    /// Unsupported or explicitly excluded representations produce 406; malformed
    /// media ranges are ignored, and invalid quality values are treated as zero.
    /// Every negotiated response carries Vary: Accept.
    /// Names already use the legacy character set; `underscores` and `allow-utf-8`
    /// escaping are supported, while `dots` and `values` are not advertised.
    pub fn negotiate(self, headers: &HeaderMap) -> Response {
        let mut response = if !headers.contains_key(ACCEPT) {
            self.plain_text()
        } else {
            match select_content_type(headers) {
                Some(PROMETHEUS_CONTENT_TYPE) => self.plain_text(),
                Some(content_type) => response(encode_openmetrics(&self.0), content_type),
                None => (StatusCode::NOT_ACCEPTABLE, [(CACHE_CONTROL, "no-store")]).into_response(),
            }
        };
        response
            .headers_mut()
            .insert(VARY, HeaderValue::from_static("Accept"));
        response
    }
}

impl IntoResponse for MetricsResponse {
    fn into_response(self) -> Response {
        response(encode_openmetrics(&self.0), OPENMETRICS_CONTENT_TYPE)
    }
}

fn response(body: String, content_type: &'static str) -> Response {
    let mut response = body.into_response();
    response
        .headers_mut()
        .insert(CONTENT_TYPE, HeaderValue::from_static(content_type));
    response
        .headers_mut()
        .insert(X_CONTENT_TYPE_OPTIONS, HeaderValue::from_static("nosniff"));
    response
        .headers_mut()
        .insert(CACHE_CONTROL, HeaderValue::from_static("no-store"));
    response
}

fn select_content_type(headers: &HeaderMap) -> Option<&'static str> {
    let ranges: Vec<mime::Mime> = headers
        .get_all(ACCEPT)
        .iter()
        .flat_map(|value| header_list_items(value.as_bytes()))
        .filter_map(|range| std::str::from_utf8(range).ok())
        .filter_map(|range| range.trim().parse().ok())
        .collect();
    // Text wins otherwise equal preferences, including typical browser wildcards.
    let candidates = [
        PROMETHEUS_CONTENT_TYPE,
        OPENMETRICS_CONTENT_TYPE,
        "application/openmetrics-text; version=1.0.0; charset=utf-8; escaping=underscores",
        "application/openmetrics-text; version=1.0.0; charset=utf-8; escaping=allow-utf-8",
    ];
    let mut selected = None;
    let mut best = (0, 0, 0);
    for content_type in candidates {
        #[expect(
            clippy::expect_used,
            reason = "only built-in content-type constants are parsed"
        )]
        let candidate = content_type
            .parse::<mime::Mime>()
            .expect("built-in metrics content types are valid MIME values");
        // More specific ranges determine quality, even when that quality is zero.
        let preference = ranges
            .iter()
            .filter_map(|range| preference(range, &candidate))
            .max_by_key(|&(specificity, parameters, quality)| (specificity, parameters, quality));
        if let Some((specificity, parameters, quality)) = preference {
            let score = (quality, specificity, parameters);
            if quality > 0 && score > best {
                selected = Some(content_type);
                best = score;
            }
        }
    }
    selected
}

fn preference(range: &mime::Mime, candidate: &mime::Mime) -> Option<(u8, usize, u16)> {
    let specificity = match range.essence_str() {
        "*/*" => 0,
        _ if range.type_() == candidate.type_()
            && range.subtype() == mime::STAR
            && range.suffix().is_none() =>
        {
            1
        }
        _ if range.essence_str() == candidate.essence_str() => 2,
        _ => return None,
    };
    let mut quality = 1000;
    let mut parameters = 0;
    let mut seen = Vec::new();
    let mut after_quality = false;
    for (name, value) in range.params() {
        if seen.contains(&name) {
            return None;
        }
        seen.push(name);
        if name == "q" {
            quality = parse_quality(value.as_str()).unwrap_or(0);
            after_quality = true;
        } else if !after_quality {
            if candidate.get_param(name) != Some(value) {
                return None;
            }
            parameters += 1;
        }
    }
    Some((specificity, parameters, quality))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::observability::MetricSample;
    use axum::{
        Router,
        body::{Body, to_bytes},
        http::{Method, Request},
        routing::get,
    };
    use tower::ServiceExt;

    fn snapshot() -> MetricsSnapshot {
        MetricsSnapshot::new(vec![MetricSample::counter("jobs_total", 2).unwrap()]).unwrap()
    }

    #[tokio::test]
    async fn negotiate_handles_browser_and_scraper_preferences() {
        let app = Router::new().route(
            "/metrics",
            get(
                |headers: HeaderMap| async move { MetricsResponse(snapshot()).negotiate(&headers) },
            ),
        );
        for (accept, expected) in [
            (vec![], Some(PROMETHEUS_CONTENT_TYPE)),
            (vec!["*/*"], Some(PROMETHEUS_CONTENT_TYPE)),
            (
                vec!["text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,*/*;q=0.8"],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["application/openmetrics-text"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec![
                    "application/openmetrics-text;version=1.0.0;q=0.9,text/plain;version=0.0.4;q=0.8",
                ],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec![
                    "application/vnd.google.protobuf;proto=io.prometheus.client.MetricFamily;q=1,application/openmetrics-text;version=1.0.0;q=0.8,text/plain;q=0.5",
                ],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec!["application/openmetrics-text;q=0.3", "text/plain;q=0.9"],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["text/*;q=0.9,application/*;q=0.2"],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=0.1,*/*;q=0.8"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec!["application/openmetrics-text;q=0,*/*;q=1"],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=0,*/*;q=1"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec!["TEXT/PLAIN;version=\"0.0.4\";charset=\"UTF-8\""],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec![
                    "text/plain;version=0.0.4;q=0.1,text/plain;q=0.9,application/openmetrics-text;q=0.5",
                ],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec![
                    "text/plain;version=1.0.0,application/openmetrics-text;version=0.0.1,*/*;q=0.1",
                ],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=0.8;note=\"a,b\",application/openmetrics-text;q=0.5"],
                Some(PROMETHEUS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=1.001,application/openmetrics-text;q=0.5"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=NaN,application/openmetrics-text;q=0.5"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (
                vec!["text/plain;q=0.1234,application/openmetrics-text;q=0.5"],
                Some(OPENMETRICS_CONTENT_TYPE),
            ),
            (vec!["application/json"], None),
            (vec!["application/*+json"], None),
            (vec!["*/*;q=0"], None),
            (
                vec!["application/openmetrics-text;q=0,text/plain;q=0,*/*;q=1"],
                None,
            ),
            (vec!["application/openmetrics-text;version=0.0.1"], None),
            (vec!["text/plain;version=1.0.0"], None),
            (vec!["text/plain;charset=iso-8859-1"], None),
            (vec!["application/openmetrics-text;escaping=dots"], None),
            (vec!["application/openmetrics-text;escaping=values"], None),
            (vec!["text/plain;version=0.0.4;version=1.0.0"], None),
            (vec!["text/plain;q=0;q=1"], None),
            (
                vec!["text/plain;note=\"a,application/openmetrics-text\""],
                None,
            ),
            (vec![""], None),
        ] {
            for method in [Method::GET, Method::HEAD] {
                let mut request = Request::builder().method(method.clone()).uri("/metrics");
                for header in &accept {
                    request = request.header(ACCEPT, *header);
                }
                let response = app
                    .clone()
                    .oneshot(request.body(Body::empty()).unwrap())
                    .await
                    .unwrap();
                assert_eq!(response.headers()[VARY], "Accept");
                assert_eq!(response.headers()[CACHE_CONTROL], "no-store");
                assert_eq!(
                    response.status(),
                    if expected.is_some() {
                        StatusCode::OK
                    } else {
                        StatusCode::NOT_ACCEPTABLE
                    },
                    "{accept:?}"
                );
                if let Some(expected) = expected {
                    assert_eq!(response.headers()[CONTENT_TYPE], expected, "{accept:?}");
                    assert_eq!(response.headers()[X_CONTENT_TYPE_OPTIONS], "nosniff");
                    let bytes = to_bytes(response.into_body(), 1024).await.unwrap();
                    if method == Method::HEAD {
                        assert!(bytes.is_empty());
                    } else if expected == PROMETHEUS_CONTENT_TYPE {
                        assert_eq!(bytes, "# TYPE jobs_total counter\njobs_total 2\n");
                    } else {
                        assert_eq!(bytes, "# TYPE jobs counter\njobs_total 2\n# EOF\n");
                    }
                } else {
                    assert!(
                        to_bytes(response.into_body(), 1024)
                            .await
                            .unwrap()
                            .is_empty()
                    );
                }
            }
        }
    }

    #[tokio::test]
    async fn explicit_formats_disable_caching_for_get_and_head() {
        let app = Router::new()
            .route(
                "/openmetrics",
                get(|| async { MetricsResponse(snapshot()) }),
            )
            .route(
                "/prometheus",
                get(|| async { MetricsResponse(snapshot()).plain_text() }),
            );
        for (uri, content_type) in [
            ("/openmetrics", OPENMETRICS_CONTENT_TYPE),
            ("/prometheus", PROMETHEUS_CONTENT_TYPE),
        ] {
            for method in [Method::GET, Method::HEAD] {
                let response = app
                    .clone()
                    .oneshot(
                        Request::builder()
                            .method(method.clone())
                            .uri(uri)
                            .body(Body::empty())
                            .unwrap(),
                    )
                    .await
                    .unwrap();
                assert_eq!(response.status(), StatusCode::OK);
                assert_eq!(response.headers()[CACHE_CONTROL], "no-store");
                assert_eq!(response.headers()[CONTENT_TYPE], content_type);
                assert!(!response.headers().contains_key(VARY));
                let body = to_bytes(response.into_body(), 1024).await.unwrap();
                assert_eq!(body.is_empty(), method == Method::HEAD);
            }
        }
    }

    #[tokio::test]
    async fn negotiated_escaping_matches_the_advertised_encoding() {
        for escaping in ["underscores", "allow-utf-8"] {
            let mut headers = HeaderMap::new();
            headers.insert(
                ACCEPT,
                format!("application/openmetrics-text;version=1.0.0;escaping={escaping}")
                    .parse()
                    .unwrap(),
            );
            let response = MetricsResponse(snapshot()).negotiate(&headers);
            assert_eq!(response.status(), StatusCode::OK);
            assert!(
                response.headers()[CONTENT_TYPE]
                    .to_str()
                    .unwrap()
                    .ends_with(&format!("escaping={escaping}"))
            );
            assert_eq!(
                to_bytes(response.into_body(), 1024).await.unwrap(),
                "# TYPE jobs counter\njobs_total 2\n# EOF\n"
            );
        }
    }

    #[tokio::test]
    async fn explicit_preview_is_text_without_html_interpolation() {
        let sample = MetricSample::gauge("resource_info", 1.0)
            .unwrap()
            .with_label("name", "<script>alert(1)</script>\\\"")
            .unwrap();
        let response = MetricsResponse(MetricsSnapshot::new(vec![sample]).unwrap()).plain_text();
        assert_eq!(response.headers()[CONTENT_TYPE], PROMETHEUS_CONTENT_TYPE);
        assert_eq!(response.headers()[X_CONTENT_TYPE_OPTIONS], "nosniff");
        assert!(!response.headers().contains_key(VARY));
        assert_eq!(
            to_bytes(response.into_body(), 1024).await.unwrap(),
            "# TYPE resource_info gauge\nresource_info{name=\"<script>alert(1)</script>\\\\\\\"\"} 1\n"
        );
    }
}