forked from umccr/htsget-rs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
data_server.rs
431 lines (367 loc) · 11.5 KB
/
data_server.rs
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
//! The following module provides an implementation of [UrlFormatter] for https, and the server
//! code which responds to formatted urls.
//!
//! This is the code that replies to the url tickets generated by [HtsGet], in the case of [LocalStorage].
//!
use std::net::{AddrParseError, SocketAddr};
use std::path::Path;
use std::pin::Pin;
use std::sync::Arc;
use axum::Router;
use futures_util::future::poll_fn;
use hyper::server::accept::Accept;
use hyper::server::conn::{AddrIncoming, Http};
use tokio::net::TcpListener;
use tokio_rustls::TlsAcceptor;
use tower::MakeService;
use tower_http::services::ServeDir;
use tower_http::trace::TraceLayer;
use tracing::instrument;
use tracing::{info, trace};
use htsget_config::config::cors::CorsConfig;
use htsget_config::config::DataServerConfig;
use htsget_config::tls::TlsServerConfig;
use htsget_config::types::Scheme;
use crate::storage::configure_cors;
use crate::storage::StorageError::{IoError, ServerError};
use super::{Result, StorageError};
/// The maximum amount of time a CORS request can be cached for.
pub const CORS_MAX_AGE: u64 = 86400;
/// Ticket server url formatter.
#[derive(Debug, Clone)]
pub struct BindDataServer {
addr: SocketAddr,
cert_key_pair: Option<TlsServerConfig>,
scheme: Scheme,
cors: CorsConfig,
serve_at: String,
}
impl BindDataServer {
pub fn new(addr: SocketAddr, cors: CorsConfig, serve_at: String) -> Self {
Self {
addr,
cert_key_pair: None,
scheme: Scheme::Http,
cors,
serve_at,
}
}
pub fn new_with_tls(
addr: SocketAddr,
cors: CorsConfig,
tls: TlsServerConfig,
serve_at: String,
) -> Self {
Self {
addr,
cert_key_pair: Some(tls),
scheme: Scheme::Https,
cors,
serve_at,
}
}
/// Get the scheme this formatter is using - either HTTP or HTTPS.
pub fn get_scheme(&self) -> &Scheme {
&self.scheme
}
/// Eagerly bind the address by returning a `DataServer`. This function also updates the
/// address to the actual bound address, and replaces the cert_key_pair with None.
pub async fn bind_data_server(&mut self) -> Result<DataServer> {
let server = DataServer::bind_addr(
self.addr,
&self.serve_at,
self.cert_key_pair.take(),
self.cors.clone(),
)
.await?;
self.addr = server.local_addr();
Ok(server)
}
/// Get the [SocketAddr] of this formatter.
pub fn get_addr(&self) -> SocketAddr {
self.addr
}
}
impl From<DataServerConfig> for BindDataServer {
/// Returns a ticket server with TLS enabled if the tls config is not None or without TLS enabled
/// if it is None.
fn from(config: DataServerConfig) -> Self {
let addr = config.addr();
let cors = config.cors().clone();
let serve_at = config.serve_at().to_string();
match config.into_tls() {
None => Self::new(addr, cors, serve_at),
Some(tls) => Self::new_with_tls(addr, cors, tls, serve_at),
}
}
}
impl From<AddrParseError> for StorageError {
fn from(err: AddrParseError) -> Self {
StorageError::InvalidAddress(err)
}
}
/// The local storage static http server.
#[derive(Debug)]
pub struct DataServer {
listener: AddrIncoming,
serve_at: String,
cert_key_pair: Option<TlsServerConfig>,
cors: CorsConfig,
}
impl DataServer {
/// Eagerly bind the the address for use with the server, returning any errors.
#[instrument(skip(serve_at, cert_key_pair))]
pub async fn bind_addr(
addr: SocketAddr,
serve_at: impl Into<String>,
cert_key_pair: Option<TlsServerConfig>,
cors: CorsConfig,
) -> Result<DataServer> {
let listener = TcpListener::bind(addr)
.await
.map_err(|err| IoError("binding data server addr".to_string(), err))?;
let listener = AddrIncoming::from_listener(listener)?;
info!(address = ?listener.local_addr(), "data server address bound to");
Ok(Self {
listener,
serve_at: serve_at.into(),
cert_key_pair,
cors,
})
}
/// Run the actual server, using the provided path, key and certificate.
#[instrument(level = "trace", skip_all)]
pub async fn serve<P: AsRef<Path>>(mut self, path: P) -> Result<()> {
let mut app = Router::new()
.nest_service(&self.serve_at, ServeDir::new(path))
.layer(configure_cors(self.cors)?)
.layer(TraceLayer::new_for_http())
.into_make_service_with_connect_info::<SocketAddr>();
// TODO write using new axum functions.
match self.cert_key_pair {
None => axum::Server::builder(self.listener)
.serve(app)
.await
.map_err(|err| ServerError(err.to_string())),
Some(tls) => {
let acceptor = TlsAcceptor::from(Arc::new(tls.into_inner()));
loop {
let stream = poll_fn(|cx| Pin::new(&mut self.listener).poll_accept(cx))
.await
.ok_or_else(|| ServerError("poll accept failed".to_string()))?
.map_err(|err| ServerError(err.to_string()))?;
let acceptor = acceptor.clone();
let app = app
.make_service(&stream)
.await
.map_err(|err| ServerError(err.to_string()))?;
trace!(stream = ?stream, "accepting stream");
tokio::spawn(async move {
if let Ok(stream) = acceptor.accept(stream).await {
let _ = Http::new().serve_connection(stream, app).await;
}
});
}
}
}
}
/// Get the local address the server has bound to.
pub fn local_addr(&self) -> SocketAddr {
self.listener.local_addr()
}
}
impl From<hyper::Error> for StorageError {
fn from(error: hyper::Error) -> Self {
ServerError(error.to_string())
}
}
#[cfg(test)]
mod tests {
use std::str::FromStr;
use async_trait::async_trait;
use http::header::HeaderName;
use http::{HeaderMap, HeaderValue, Method};
use reqwest::{Client, ClientBuilder, RequestBuilder};
use tempfile::tempdir;
use htsget_test::http::cors::{test_cors_preflight_request_uri, test_cors_simple_request_uri};
use htsget_test::http::{
config_with_tls, default_cors_config, default_test_config, Header, Response as TestResponse,
TestRequest, TestServer,
};
use crate::storage::local::tests::create_local_test_files;
use crate::Config;
use super::*;
struct DataTestServer {
config: Config,
}
struct DataTestRequest {
client: Client,
headers: HeaderMap,
payload: String,
method: Method,
uri: String,
}
impl TestRequest for DataTestRequest {
fn insert_header(mut self, header: Header<impl Into<String>>) -> Self {
self.headers.insert(
HeaderName::from_str(&header.name.into()).unwrap(),
HeaderValue::from_str(&header.value.into()).unwrap(),
);
self
}
fn set_payload(mut self, payload: impl Into<String>) -> Self {
self.payload = payload.into();
self
}
fn uri(mut self, uri: impl Into<String>) -> Self {
self.uri = uri.into().parse().unwrap();
self
}
fn method(mut self, method: impl Into<String>) -> Self {
self.method = method.into().parse().unwrap();
self
}
}
impl DataTestRequest {
fn build(self) -> RequestBuilder {
self
.client
.request(self.method, self.uri)
.headers(self.headers)
.body(self.payload)
}
}
impl Default for DataTestRequest {
fn default() -> Self {
Self {
client: ClientBuilder::new()
.danger_accept_invalid_certs(true)
.use_rustls_tls()
.build()
.unwrap(),
headers: HeaderMap::default(),
payload: "".to_string(),
method: Method::GET,
uri: "".to_string(),
}
}
}
impl Default for DataTestServer {
fn default() -> Self {
Self {
config: default_test_config(),
}
}
}
#[async_trait(?Send)]
impl TestServer<DataTestRequest> for DataTestServer {
async fn get_expected_path(&self) -> String {
"".to_string()
}
fn get_config(&self) -> &Config {
&self.config
}
fn get_request(&self) -> DataTestRequest {
DataTestRequest::default()
}
async fn test_server(&self, request: DataTestRequest, expected_path: String) -> TestResponse {
let response = request.build().send().await.unwrap();
let status: u16 = response.status().into();
let headers = response.headers().clone();
let bytes = response.bytes().await.unwrap().to_vec();
TestResponse::new(status, headers, bytes, expected_path)
}
}
#[tokio::test]
async fn test_http_server() {
let (_, base_path) = create_local_test_files().await;
test_server("http", None, base_path.path().to_path_buf()).await;
}
#[tokio::test]
async fn test_tls_server() {
let (_, base_path) = create_local_test_files().await;
let config = config_with_tls(base_path.path()).data_server().clone();
let server_config = config.into_tls().unwrap();
test_server("https", Some(server_config), base_path.path().to_path_buf()).await;
}
#[test]
fn http_scheme() {
let formatter = BindDataServer::new(
"127.0.0.1:8080".parse().unwrap(),
CorsConfig::default(),
"/data".to_string(),
);
assert_eq!(formatter.get_scheme(), &Scheme::Http);
}
#[test]
fn https_scheme() {
assert_eq!(tls_formatter().get_scheme(), &Scheme::Https);
}
#[tokio::test]
async fn get_addr_local_addr() {
let mut formatter = BindDataServer::new(
"127.0.0.1:0".parse().unwrap(),
CorsConfig::default(),
"/data".to_string(),
);
let server = formatter.bind_data_server().await.unwrap();
assert_eq!(formatter.get_addr(), server.local_addr());
}
#[tokio::test]
async fn cors_simple_response() {
let (_, base_path) = create_local_test_files().await;
let port = start_server(None, base_path.path().to_path_buf()).await;
test_cors_simple_request_uri(
&DataTestServer::default(),
&format!("http://localhost:{port}/data/key1"),
)
.await;
}
#[tokio::test]
async fn cors_options_response() {
let (_, base_path) = create_local_test_files().await;
let port = start_server(None, base_path.path().to_path_buf()).await;
test_cors_preflight_request_uri(
&DataTestServer::default(),
&format!("http://localhost:{port}/data/key1"),
)
.await;
}
fn tls_formatter() -> BindDataServer {
let tmp_dir = tempdir().unwrap();
let config = config_with_tls(tmp_dir.path()).data_server().clone();
let server_config = config.into_tls().unwrap();
BindDataServer::new_with_tls(
"127.0.0.1:8080".parse().unwrap(),
CorsConfig::default(),
server_config,
"/data".to_string(),
)
}
async fn start_server<P>(cert_key_pair: Option<TlsServerConfig>, path: P) -> u16
where
P: AsRef<Path> + Send + 'static,
{
let addr = SocketAddr::from_str(&format!("{}:{}", "127.0.0.1", "0")).unwrap();
let server = DataServer::bind_addr(addr, "/data", cert_key_pair, default_cors_config())
.await
.unwrap();
let port = server.local_addr().port();
tokio::spawn(async move { server.serve(path).await.unwrap() });
port
}
async fn test_server<P>(scheme: &str, cert_key_pair: Option<TlsServerConfig>, path: P)
where
P: AsRef<Path> + Send + 'static,
{
let port = start_server(cert_key_pair, path).await;
let test_server = DataTestServer::default();
let request = test_server
.get_request()
.method(Method::GET.to_string())
.uri(format!("{scheme}://localhost:{port}/data/key1"));
let response = test_server.test_server(request, "".to_string()).await;
assert!(response.is_success());
assert_eq!(response.body, b"value1");
}
}