noxy 0.0.7

HTTP forward and reverse proxy with a pluggable tower middleware pipeline
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

mod common;

use std::time::{Duration, Instant};

use axum::Router;
use axum::routing::get;
use axum_server::tls_rustls::RustlsConfig;
use common::*;
use noxy::http::HttpService;
use noxy::middleware::{Conditional, ConditionalLayer, LatencyInjector, SetResponse};
use rcgen::{CertificateParams, KeyPair};
use tower::Layer;

#[tokio::test]
async fn conditional_mock_returns_canned_response() {
    let upstream_addr = start_upstream("real response").await;

    let proxy_addr = start_proxy(vec![Box::new(|inner: HttpService| {
        let cond = Conditional::new().when_path("/mocked", SetResponse::ok("fake response"));
        tower::util::BoxService::new(cond.layer(inner))
    })])
    .await;
    let client = http_client(proxy_addr);

    // Matched path returns canned response
    let resp = client
        .get(format!("https://localhost:{}/mocked", upstream_addr.port()))
        .send()
        .await
        .unwrap();
    assert_eq!(resp.text().await.unwrap(), "fake response");

    // Unmatched path forwards to upstream
    let resp = client
        .get(format!("https://localhost:{}/", upstream_addr.port()))
        .send()
        .await
        .unwrap();
    assert_eq!(resp.text().await.unwrap(), "real response");
}

#[tokio::test]
async fn conditional_applies_middleware_when_matched() {
    // Upstream that handles both / and /slow
    install_crypto_provider();
    let key_pair = KeyPair::generate().unwrap();
    let params = CertificateParams::new(vec!["localhost".to_string()]).unwrap();
    let cert = params.self_signed(&key_pair).unwrap();
    let cert_der = cert.der().to_vec();
    let key_der = key_pair.serialized_der().to_vec();

    let config = RustlsConfig::from_der(vec![cert_der], key_der)
        .await
        .unwrap();

    let app = Router::new()
        .route("/", get(|| async { "hello" }))
        .route("/slow", get(|| async { "slow hello" }));

    let handle = axum_server::Handle::new();
    let listener_handle = handle.clone();

    tokio::spawn(async move {
        axum_server::bind_rustls("127.0.0.1:0".parse().unwrap(), config)
            .handle(handle)
            .serve(app.into_make_service())
            .await
            .unwrap();
    });

    let upstream_addr = listener_handle.listening().await.unwrap();

    // Apply latency only to /slow path
    let delay = Duration::from_millis(200);
    let proxy_addr = start_proxy(vec![Box::new(move |inner: HttpService| {
        let layer = Conditional::new().when(
            |req| req.uri().path() == "/slow",
            LatencyInjector::fixed(delay),
        );
        tower::util::BoxService::new(layer.layer(inner))
    })])
    .await;
    let client = http_client(proxy_addr);

    // Matching path gets the delay
    let start = Instant::now();
    let resp = client
        .get(format!("https://localhost:{}/slow", upstream_addr.port()))
        .send()
        .await
        .unwrap();
    let slow_elapsed = start.elapsed();
    assert_eq!(resp.text().await.unwrap(), "slow hello");
    assert!(
        slow_elapsed >= delay,
        "/slow took {slow_elapsed:?}, expected at least {delay:?}"
    );

    // Non-matching path bypasses the delay
    let start = Instant::now();
    let resp = client
        .get(format!("https://localhost:{}/", upstream_addr.port()))
        .send()
        .await
        .unwrap();
    let fast_elapsed = start.elapsed();
    assert_eq!(resp.text().await.unwrap(), "hello");
    assert!(
        fast_elapsed < delay,
        "/ took {fast_elapsed:?}, expected less than {delay:?}"
    );
}

#[tokio::test]
async fn conditional_glob_matches_path_pattern() {
    install_crypto_provider();
    let key_pair = KeyPair::generate().unwrap();
    let params = CertificateParams::new(vec!["localhost".to_string()]).unwrap();
    let cert = params.self_signed(&key_pair).unwrap();
    let cert_der = cert.der().to_vec();
    let key_der = key_pair.serialized_der().to_vec();

    let config = RustlsConfig::from_der(vec![cert_der], key_der)
        .await
        .unwrap();

    let app = Router::new()
        .route("/api/users", get(|| async { "users" }))
        .route("/api/users/1", get(|| async { "user 1" }))
        .route("/other", get(|| async { "other" }));

    let handle = axum_server::Handle::new();
    let listener_handle = handle.clone();

    tokio::spawn(async move {
        axum_server::bind_rustls("127.0.0.1:0".parse().unwrap(), config)
            .handle(handle)
            .serve(app.into_make_service())
            .await
            .unwrap();
    });

    let upstream_addr = listener_handle.listening().await.unwrap();

    let proxy_addr = start_proxy(vec![Box::new(|inner: HttpService| {
        let cond = Conditional::new()
            .when_path_glob("/api/*", SetResponse::ok("mocked"))
            .unwrap();
        tower::util::BoxService::new(cond.layer(inner))
    })])
    .await;
    let client = http_client(proxy_addr);

    let base = format!("https://localhost:{}", upstream_addr.port());

    // /api/users matches /api/*
    let resp = client
        .get(format!("{base}/api/users"))
        .send()
        .await
        .unwrap();
    assert_eq!(resp.text().await.unwrap(), "mocked");

    // /api/users/1 does NOT match /api/* (single * doesn't cross /)
    let resp = client
        .get(format!("{base}/api/users/1"))
        .send()
        .await
        .unwrap();
    assert_eq!(resp.text().await.unwrap(), "user 1");

    // /other does not match
    let resp = client.get(format!("{base}/other")).send().await.unwrap();
    assert_eq!(resp.text().await.unwrap(), "other");
}

#[tokio::test]
async fn conditional_layer_extension_trait() {
    install_crypto_provider();
    let key_pair = KeyPair::generate().unwrap();
    let params = CertificateParams::new(vec!["localhost".to_string()]).unwrap();
    let cert = params.self_signed(&key_pair).unwrap();
    let cert_der = cert.der().to_vec();
    let key_der = key_pair.serialized_der().to_vec();

    let config = RustlsConfig::from_der(vec![cert_der], key_der)
        .await
        .unwrap();

    let app = Router::new()
        .route("/", get(|| async { "hello" }))
        .route("/slow", get(|| async { "slow hello" }));

    let handle = axum_server::Handle::new();
    let listener_handle = handle.clone();

    tokio::spawn(async move {
        axum_server::bind_rustls("127.0.0.1:0".parse().unwrap(), config)
            .handle(handle)
            .serve(app.into_make_service())
            .await
            .unwrap();
    });

    let upstream_addr = listener_handle.listening().await.unwrap();

    let delay = Duration::from_millis(200);
    let proxy_addr = start_proxy(vec![Box::new(move |inner: HttpService| {
        let layer = LatencyInjector::fixed(delay).when_path("/slow");
        tower::util::BoxService::new(layer.layer(inner))
    })])
    .await;
    let client = http_client(proxy_addr);

    let base = format!("https://localhost:{}", upstream_addr.port());

    // /slow gets the delay
    let start = Instant::now();
    let resp = client.get(format!("{base}/slow")).send().await.unwrap();
    let slow_elapsed = start.elapsed();
    assert_eq!(resp.text().await.unwrap(), "slow hello");
    assert!(
        slow_elapsed >= delay,
        "/slow took {slow_elapsed:?}, expected >= {delay:?}"
    );

    // / bypasses the delay
    let start = Instant::now();
    let resp = client.get(format!("{base}/")).send().await.unwrap();
    let fast_elapsed = start.elapsed();
    assert_eq!(resp.text().await.unwrap(), "hello");
    assert!(
        fast_elapsed < delay,
        "/ took {fast_elapsed:?}, expected < {delay:?}"
    );
}