rama 0.3.0

modular service framework
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

use rama::{
    Layer, Service,
    graceful::Shutdown,
    http::{
        Body, HeaderValue, Request, Response, Version, client::EasyHttpWebClient, header,
        header::HOST, server::HttpServer,
    },
    net::test_utils::client::MockConnectorService,
    rt::Executor,
    service::service_fn,
    tls::boring::server::TlsAcceptorLayer,
    tls::client::TlsClientConfig,
    tls::server::{SelfSignedData, TlsServerConfig},
};
use rama_tls::client::ServerVerifyMode;
use tokio::time::sleep;
use tokio_util::sync::CancellationToken;

use std::{convert::Infallible, time::Duration};

#[tokio::test]
async fn h2_with_connection_pooling() {
    let http_server =
        HttpServer::new_h2(Executor::default()).service(service_fn(async |req: Request| {
            // We are actually quite forgiving when we receive a http1 request instead of H2,
            // if we see a Host header here it means we received http1, something we don't expect.
            assert_eq!(req.headers().get(HOST), None);
            Ok::<_, Infallible>(Response::new(Body::empty()))
        }));

    let tls_service_data = TlsServerConfig::new()
        .try_with_self_signed(SelfSignedData {
            organisation_name: Some("Example Server Acceptor".to_owned()),
            ..Default::default()
        })
        .expect("self-signed")
        .with_alpn_http_2();
    let server = TlsAcceptorLayer::new(tls_service_data).into_layer(http_server);
    let direct_connection = MockConnectorService::new(move || server.clone());

    let tls_config = TlsClientConfig::default_http().with_server_verify(ServerVerifyMode::Disable);

    let client = EasyHttpWebClient::connector_builder()
        .with_custom_transport_connector(direct_connection)
        .without_dns_connector()
        .without_tls_proxy_support()
        .without_proxy_support()
        .with_tls_support_using_boringssl(tls_config)
        .with_default_http_connector(Executor::default())
        .try_with_default_connection_pool()
        .unwrap()
        .build_client();

    let create_req = || {
        Request::builder()
            .uri("https://localhost/test")
            .body(Body::empty())
            .unwrap()
    };

    let _resp = client.serve(create_req()).await.unwrap();
    let _resp = client.serve(create_req()).await.unwrap();
}

#[tokio::test]
async fn h1_with_connection_pooling_detects_closed_connections() {
    let http_server =
        HttpServer::new_http1(Executor::default()).service(service_fn(async |_req: Request| {
            let mut resp = Response::new(Body::empty());
            resp.headers_mut()
                .insert(header::CONNECTION, HeaderValue::from_static("close"));
            Ok::<_, Infallible>(resp)
        }));

    let tls_service_data = TlsServerConfig::new()
        .try_with_self_signed(SelfSignedData {
            organisation_name: Some("Example Server Acceptor".to_owned()),
            ..Default::default()
        })
        .expect("self-signed")
        .with_alpn_http_1();
    let server = TlsAcceptorLayer::new(tls_service_data).into_layer(http_server);
    let direct_connection = MockConnectorService::new(move || server.clone());

    let tls_config = TlsClientConfig::default_http()
        .with_server_verify(rama_tls::client::ServerVerifyMode::Disable);

    let client = EasyHttpWebClient::connector_builder()
        .with_custom_transport_connector(direct_connection)
        .without_dns_connector()
        .without_tls_proxy_support()
        .without_proxy_support()
        .with_tls_support_using_boringssl(tls_config)
        .with_default_http_connector(Executor::default())
        .try_with_default_connection_pool()
        .unwrap()
        .build_client();

    let create_req = || {
        Request::builder()
            .uri("https://localhost/test")
            .body(Body::empty())
            .unwrap()
    };

    let _resp = client.serve(create_req()).await.unwrap();
    let _resp = client.serve(create_req()).await.unwrap();
}

async fn connection_pooling_detects_closed_connections(version: Version, delay: Option<Duration>) {
    let direct_connection = MockConnectorService::new(move || {
        let token = CancellationToken::new();
        let shutdown = Shutdown::new(token.clone().cancelled_owned());

        let executor = Executor::graceful(shutdown.guard());
        let http_server = HttpServer::auto(executor).service(service_fn(move |_req: Request| {
            // Trigger graceful shutdown after single response
            let token = token.clone();
            tokio::spawn(async move {
                if let Some(delay) = delay {
                    sleep(delay).await;
                }
                token.cancel();
            });

            async move {
                let resp = Response::new(Body::empty());
                Ok::<_, Infallible>(resp)
            }
        }));

        let tls_service_data = {
            let tls = TlsServerConfig::new()
                .try_with_self_signed(SelfSignedData {
                    organisation_name: Some("Example Server Acceptor".to_owned()),
                    ..Default::default()
                })
                .expect("self-signed");
            match version {
                Version::HTTP_11 => tls.with_alpn_http_1(),
                Version::HTTP_2 => tls.with_alpn_http_2(),
                _ => panic!("not supported by this test"),
            }
        };

        TlsAcceptorLayer::new(tls_service_data).into_layer(http_server)
    });

    let tls_config = TlsClientConfig::default_http()
        .with_server_verify(rama_tls::client::ServerVerifyMode::Disable);

    let client = EasyHttpWebClient::connector_builder()
        .with_custom_transport_connector(direct_connection)
        .without_dns_connector()
        .without_tls_proxy_support()
        .without_proxy_support()
        .with_tls_support_using_boringssl(tls_config)
        .with_default_http_connector(Executor::default())
        .try_with_default_connection_pool()
        .unwrap()
        .build_client();

    let create_req = || {
        Request::builder()
            .uri("https://localhost/test")
            .body(Body::empty())
            .unwrap()
    };

    let _resp = client.serve(create_req()).await.unwrap();

    // Make sure we are slower then breaking the connection and give internal state machine some
    // time to handle this.
    sleep(Duration::from_millis(100)).await;
    if let Some(delay) = delay {
        sleep(delay).await;
    }

    let _resp = client.serve(create_req()).await.unwrap();
}

#[tokio::test]
async fn h1_with_connection_pooling_detects_instant_close() {
    // Here we break the connection immediately which should get picked up before is is even
    // returned to the pool, or after it is returned. Either way the pool should filter this connection.
    connection_pooling_detects_closed_connections(Version::HTTP_11, None).await;
}

#[tokio::test]
async fn h1_with_connection_pooling_detects_late_close() {
    // Here we break the connection after some time. By now the connection is definitely in the pool
    // again. But our logic should also pick this up and filter this connection
    connection_pooling_detects_closed_connections(
        Version::HTTP_11,
        Some(Duration::from_millis(50)),
    )
    .await;
}

#[tokio::test]
async fn h2_with_connection_pooling_detects_instant_goaway() {
    // Here we break the connection immediately which should get picked up before is is even
    // returned to the pool, or after it is returned. Either way the pool should filter this connection.
    connection_pooling_detects_closed_connections(Version::HTTP_2, None).await;
}

#[tokio::test]
async fn h2_with_connection_pooling_detects_late_goaway() {
    // Here we break the connection after some time. By now the connection is definitely in the pool
    // again. But our logic should also pick this up and filter this connection
    connection_pooling_detects_closed_connections(Version::HTTP_2, Some(Duration::from_millis(50)))
        .await;
}

// TODO more test for things like resets, hard crashes...