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
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

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

//! Timeout bounds validation for clusters.

use super::MAX_TIMEOUT_MS;
use crate::{config::Cluster, errors::ProxyError};

// -----------------------------------------------------------------------------
// Timeout Validation
// -----------------------------------------------------------------------------

/// Validates timeout bounds and relational consistency.
pub(super) fn validate_timeouts(cluster: &Cluster) -> Result<(), ProxyError> {
    let name = &cluster.name;

    for (field, value) in [
        ("connection_timeout_ms", cluster.connection_timeout_ms),
        ("total_connection_timeout_ms", cluster.total_connection_timeout_ms),
        ("idle_timeout_ms", cluster.idle_timeout_ms),
        ("read_timeout_ms", cluster.read_timeout_ms),
        ("write_timeout_ms", cluster.write_timeout_ms),
    ] {
        if let Some(0) = value {
            return Err(ProxyError::Config(format!(
                "cluster '{name}': {field} is 0 (must be > 0)"
            )));
        }
        if let Some(v) = value
            && v > MAX_TIMEOUT_MS
        {
            return Err(ProxyError::Config(format!(
                "cluster '{name}': {field} ({v} ms) exceeds maximum ({MAX_TIMEOUT_MS} ms / 1 hour)"
            )));
        }
    }

    if let (Some(conn), Some(total)) = (cluster.connection_timeout_ms, cluster.total_connection_timeout_ms)
        && conn > total
    {
        return Err(ProxyError::Config(format!(
            "cluster '{name}': connection_timeout_ms ({conn}) exceeds \
             total_connection_timeout_ms ({total})"
        )));
    }

    Ok(())
}

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

#[cfg(test)]
mod tests {
    use crate::config::Config;

    #[test]
    fn reject_zero_timeout() {
        let yaml = r#"
listeners:
  - name: web
    address: "0.0.0.0:80"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
clusters:
  - name: "backend"
    endpoints: ["10.0.0.1:80"]
    connection_timeout_ms: 0
"#;
        let err = Config::from_yaml(yaml).unwrap_err();
        assert!(err.to_string().contains("connection_timeout_ms is 0"), "got: {err}");
    }

    #[test]
    fn reject_timeout_exceeding_maximum() {
        let yaml = r#"
listeners:
  - name: web
    address: "0.0.0.0:80"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
clusters:
  - name: "backend"
    endpoints: ["10.0.0.1:80"]
    idle_timeout_ms: 7200000
"#;
        let err = Config::from_yaml(yaml).unwrap_err();
        assert!(
            err.to_string().contains("exceeds maximum"),
            "should reject timeout > 1 hour, got: {err}"
        );
    }

    #[test]
    fn accept_timeout_at_maximum() {
        let yaml = r#"
listeners:
  - name: web
    address: "0.0.0.0:80"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
clusters:
  - name: "backend"
    endpoints: ["10.0.0.1:80"]
    connection_timeout_ms: 3600000
    total_connection_timeout_ms: 3600000
    idle_timeout_ms: 3600000
    read_timeout_ms: 3600000
    write_timeout_ms: 3600000
"#;
        Config::from_yaml(yaml).unwrap();
    }

    #[test]
    fn reject_connection_exceeds_total() {
        let yaml = r#"
listeners:
  - name: web
    address: "0.0.0.0:80"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
clusters:
  - name: "backend"
    endpoints: ["10.0.0.1:80"]
    connection_timeout_ms: 10000
    total_connection_timeout_ms: 5000
"#;
        let err = Config::from_yaml(yaml).unwrap_err();
        assert!(err.to_string().contains("exceeds"), "got: {err}");
    }

    #[test]
    fn accept_valid_timeouts() {
        let yaml = r#"
listeners:
  - name: web
    address: "0.0.0.0:80"
    filter_chains: [main]
filter_chains:
  - name: main
    filters:
      - filter: static_response
        status: 200
clusters:
  - name: "backend"
    endpoints: ["10.0.0.1:80"]
    connection_timeout_ms: 5000
    total_connection_timeout_ms: 10000
"#;
        Config::from_yaml(yaml).unwrap();
    }
}