-
Notifications
You must be signed in to change notification settings - Fork 34
/
router.rs
173 lines (156 loc) · 6.38 KB
/
router.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
use crate::http_server::routes::{
certificate_routes, epoch_routes, signatures_routes, signer_routes, snapshot_routes,
};
use crate::http_server::SERVER_BASE_PATH;
use crate::DependencyManager;
use mithril_common::api::APIVersionProvider;
use mithril_common::MITHRIL_API_VERSION_HEADER;
use reqwest::StatusCode;
use slog_scope::warn;
use std::sync::Arc;
use warp::http::Method;
use warp::reject::Reject;
use warp::{Filter, Rejection, Reply};
#[derive(Debug)]
pub struct VersionMismatchError;
impl Reject for VersionMismatchError {}
#[derive(Debug)]
pub struct VersionParseError;
impl Reject for VersionParseError {}
/// Routes
pub fn routes(
dependency_manager: Arc<DependencyManager>,
) -> impl Filter<Extract = (impl warp::Reply,), Error = warp::Rejection> + Clone {
let cors = warp::cors()
.allow_any_origin()
.allow_headers(vec!["content-type"])
.allow_methods(vec![Method::GET, Method::POST, Method::OPTIONS]);
warp::any()
.and(header_must_be(
dependency_manager.clone().api_version_provider.clone(),
))
.and(warp::path(SERVER_BASE_PATH))
.and(
certificate_routes::routes(dependency_manager.clone())
.or(snapshot_routes::routes(dependency_manager.clone()))
.or(signer_routes::routes(dependency_manager.clone()))
.or(signatures_routes::routes(dependency_manager.clone()))
.or(epoch_routes::routes(dependency_manager.clone()))
.with(cors),
)
.recover(handle_custom)
.and(warp::any().map(move || dependency_manager.clone().api_version_provider.clone()))
.map(|reply, api_version_provider: Arc<APIVersionProvider>| {
warp::reply::with_header(
reply,
MITHRIL_API_VERSION_HEADER,
&api_version_provider
.compute_current_version()
.unwrap()
.to_string(),
)
})
}
/// API Version verification
fn header_must_be(
api_version_provider: Arc<APIVersionProvider>,
) -> impl Filter<Extract = (), Error = Rejection> + Clone {
warp::header::optional(MITHRIL_API_VERSION_HEADER)
.and(warp::any().map(move || api_version_provider.clone()))
.and_then(
move |maybe_header: Option<String>, api_version_provider: Arc<APIVersionProvider>| async move {
match maybe_header {
None => Ok(()),
Some(version) => match semver::Version::parse(&version) {
Ok(version)
if (api_version_provider
.compute_current_version_requirement().unwrap()
.matches(&version))
.to_owned() =>
{
Ok(())
}
Ok(_version) => Err(warp::reject::custom(VersionMismatchError)),
Err(err) => {
warn!("⇄ HTTP SERVER::api_version_check::parse_error"; "error" => ?err);
Err(warp::reject::custom(VersionParseError))
}
},
}
},
)
.untuple_one()
}
pub async fn handle_custom(reject: Rejection) -> Result<impl Reply, Rejection> {
if reject.find::<VersionMismatchError>().is_some() {
Ok(StatusCode::PRECONDITION_FAILED)
} else {
Err(reject)
}
}
#[cfg(test)]
mod tests {
use std::collections::HashMap;
use mithril_common::{
entities::Epoch,
era::{EraChecker, SupportedEra},
};
use super::*;
#[tokio::test]
async fn test_no_version() {
let era_checker = EraChecker::new(SupportedEra::dummy(), Epoch(1));
let api_version_provider = Arc::new(APIVersionProvider::new(Arc::new(era_checker)));
let filters = header_must_be(api_version_provider);
warp::test::request()
.path("/aggregator/whatever")
.filter(&filters)
.await
.expect("request without a version in headers should not be rejected");
}
#[tokio::test]
async fn test_parse_version_error() {
let era_checker = EraChecker::new(SupportedEra::dummy(), Epoch(1));
let api_version_provider = Arc::new(APIVersionProvider::new(Arc::new(era_checker)));
let filters = header_must_be(api_version_provider);
warp::test::request()
.header(MITHRIL_API_VERSION_HEADER, "not_a_version")
.path("/aggregator/whatever")
.filter(&filters)
.await
.expect_err(
r#"request with an unparsable version should be rejected with a version parse error"#,
);
}
#[tokio::test]
async fn test_bad_version() {
let era_checker = EraChecker::new(SupportedEra::dummy(), Epoch(1));
let mut version_provider = APIVersionProvider::new(Arc::new(era_checker));
let mut open_api_versions = HashMap::new();
open_api_versions.insert("openapi.yaml".to_string(), "1.0.0".to_string());
version_provider.update_open_api_versions(open_api_versions);
let api_version_provider = Arc::new(version_provider);
let filters = header_must_be(api_version_provider);
warp::test::request()
.header(MITHRIL_API_VERSION_HEADER, "0.0.999")
.path("/aggregator/whatever")
.filter(&filters)
.await
.expect_err(r#"request with bad version "0.0.999" should be rejected with a version mismatch error"#);
}
#[tokio::test]
async fn test_good_version() {
let era_checker = EraChecker::new(SupportedEra::dummy(), Epoch(1));
let mut version_provider = APIVersionProvider::new(Arc::new(era_checker));
let mut open_api_versions = HashMap::new();
open_api_versions.insert("openapi.yaml".to_string(), "0.1.0".to_string());
version_provider.update_open_api_versions(open_api_versions);
let api_version_provider = Arc::new(version_provider);
let filters = header_must_be(api_version_provider);
warp::test::request()
.header(MITHRIL_API_VERSION_HEADER, "0.1.2")
.path("/aggregator/whatever")
.filter(&filters)
.await
.expect(r#"request with the good version "0.1.2" should not be rejected"#);
}
}