praxis-proxy-core 0.1.0

Configuration, error types, and server factory for Praxis
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

// SPDX-License-Identifier: LGPL-3.0-only
// Copyright (c) 2024 Shane Utt

//! Body size limit configuration.

use serde::Deserialize;

// -----------------------------------------------------------------------------
// BodyLimitsConfig
// -----------------------------------------------------------------------------

/// Global hard ceilings on request and response body size.
///
/// ```
/// use praxis_core::config::BodyLimitsConfig;
///
/// let limits: BodyLimitsConfig = serde_yaml::from_str(
///     r#"
/// max_request_bytes: 10485760
/// max_response_bytes: 5242880
/// "#,
/// )
/// .unwrap();
/// assert_eq!(limits.max_request_bytes, Some(10_485_760));
/// assert_eq!(limits.max_response_bytes, Some(5_242_880));
/// ```
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(default)]
pub struct BodyLimitsConfig {
    /// Maximum request body size in bytes.
    pub max_request_bytes: Option<usize>,

    /// Maximum response body size in bytes.
    pub max_response_bytes: Option<usize>,
}

// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn defaults_are_none() {
        let limits = BodyLimitsConfig::default();
        assert!(
            limits.max_request_bytes.is_none(),
            "max_request_bytes should default to None"
        );
        assert!(
            limits.max_response_bytes.is_none(),
            "max_response_bytes should default to None"
        );
    }

    #[test]
    fn parse_full_config() {
        let limits: BodyLimitsConfig = serde_yaml::from_str(
            r#"
max_request_bytes: 1048576
max_response_bytes: 524288
"#,
        )
        .unwrap();
        assert_eq!(
            limits.max_request_bytes,
            Some(1_048_576),
            "max_request_bytes should be parsed"
        );
        assert_eq!(
            limits.max_response_bytes,
            Some(524_288),
            "max_response_bytes should be parsed"
        );
    }

    #[test]
    fn parse_empty_yields_defaults() {
        let limits: BodyLimitsConfig = serde_yaml::from_str("{}").unwrap();
        assert!(
            limits.max_request_bytes.is_none(),
            "max_request_bytes should default to None"
        );
        assert!(
            limits.max_response_bytes.is_none(),
            "max_response_bytes should default to None"
        );
    }
}