proksi 0.10.0

A batteries-included reverse proxy with automatic HTTPS using Cloudflare Pingora and Let's Encrypt.
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

use std::time::Duration;

use pingora::lb::health_check::TcpHealthCheck;

use crate::{
    blocks::Blocks,
    config::host::{Location, PathRewrite},
    metrics::LocationMetrics,
    stores::routes::RouteStoreContainer,
};

use super::load_balancer::load_balancer;

/// Builds a location's container: load balancer (with health checks) and building blocks
pub(super) fn build_location_container(
    host: &str,
    location: &Location,
) -> Option<RouteStoreContainer> {
    let mut load_balancer = load_balancer(&location.upstreams);

    // TODO: support defining health checks in the configuration file
    load_balancer.set_health_check(TcpHealthCheck::new());
    load_balancer.health_check_frequency = Some(Duration::from_secs(15));

    let mut container = RouteStoreContainer::new(load_balancer);
    container.path.clone_from(&location.path);
    container.set_upstreams(location.upstreams.clone());
    container.cache.clone_from(&location.cache);
    container.timeouts = location.timeouts;
    container.rewrite = match location
        .rewrite
        .as_ref()
        .map(PathRewrite::compile)
        .transpose()
    {
        Ok(rewrite) => rewrite,
        Err(err) => {
            tracing::warn!("invalid location {} of host {host}: {err}", location.path);
            return None;
        }
    };
    let upstreams = location
        .upstreams
        .iter()
        .map(|upstream| format!("{}:{}", upstream.ip, upstream.port))
        .collect::<Vec<_>>();

    container.blocks = match Blocks::build(location) {
        Ok(blocks) => blocks,
        Err(err) => {
            tracing::warn!("invalid location {} of host {host}: {err}", location.path);
            return None;
        }
    };
    container.metrics = crate::metrics::enabled().then(|| {
        LocationMetrics::with_blocks(
            host,
            &location.path,
            &upstreams,
            &container.blocks.answering(),
        )
    });

    Some(container)
}

#[cfg(test)]
mod tests {
    use crate::{blocks::Kind, config::host::Location};

    use super::build_location_container;

    fn location() -> Location {
        serde_json::from_value(serde_json::json!({
            "path": "/api",
            "upstreams": [{ "ip": "10.0.0.1", "port": 3000 }, { "ip": "10.0.0.2", "port": 3000 }],
            "headers": {
                "add": [{ "name": "x-added", "value": "yes" }],
                "remove": [{ "name": "server" }],
            },
            "plugins": [{ "name": "request_id" }, { "name": "unknown" }],
        }))
        .unwrap()
    }

    #[test]
    fn test_build_location_container() {
        let container = build_location_container("example.com", &location()).unwrap();

        assert_eq!(container.load_balancer.backends().get_backend().len(), 2);
        assert_eq!(container.upstreams.len(), 2);
        // The unknown plugin is ignored
        assert_eq!(
            container.blocks.iter().map(|b| b.kind).collect::<Vec<_>>(),
            vec![Kind::RequestId, Kind::Headers]
        );
    }

    #[test]
    fn test_upstreams_are_chosen_by_weight() {
        let mut location = location();
        location.upstreams[0].weight = Some(3);
        let container = build_location_container("example.com", &location).unwrap();

        let chosen = (0..400)
            .filter_map(|_| container.load_balancer.select(b"", 32))
            .filter(|backend| backend.addr.to_string() == "10.0.0.1:3000")
            .count();

        // 3 of every 4 requests
        assert_eq!(chosen, 300);
    }

    #[test]
    fn test_build_location_container_without_upstreams() {
        let mut location = location();
        location.upstreams.clear();

        let container = build_location_container("example.com", &location).unwrap();

        assert!(container.upstreams.is_empty());
        assert!(container.load_balancer.select(b"", 32).is_none());
    }
}