modo-rs 0.8.0

Rust web framework for small monolithic apps
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

use std::pin::Pin;
use std::task::{Context, Poll};

use axum::body::Body;
use http::Request;
use tower::{Layer, Service};

use crate::ip::ClientIp;

use super::locator::GeoLocator;

/// Tower layer that performs geolocation lookup and inserts
/// [`Location`](super::Location) into request extensions.
///
/// Apply this layer after [`ClientIpLayer`](crate::ip::ClientIpLayer) so that
/// [`ClientIp`] is already present in extensions when `GeoLayer` runs.
/// If `ClientIp` is absent the request passes through without modification.
pub struct GeoLayer {
    locator: GeoLocator,
}

impl Clone for GeoLayer {
    fn clone(&self) -> Self {
        Self {
            locator: self.locator.clone(),
        }
    }
}

impl GeoLayer {
    /// Create a new `GeoLayer` backed by `locator`.
    pub fn new(locator: GeoLocator) -> Self {
        Self { locator }
    }
}

impl<S> Layer<S> for GeoLayer {
    type Service = GeoMiddleware<S>;

    fn layer(&self, inner: S) -> Self::Service {
        GeoMiddleware {
            inner,
            locator: self.locator.clone(),
        }
    }
}

/// Tower service produced by [`GeoLayer`].
pub struct GeoMiddleware<S> {
    inner: S,
    locator: GeoLocator,
}

impl<S: Clone> Clone for GeoMiddleware<S> {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
            locator: self.locator.clone(),
        }
    }
}

impl<S, ReqBody> Service<Request<ReqBody>> for GeoMiddleware<S>
where
    S: Service<Request<ReqBody>, Response = http::Response<Body>> + Clone + Send + 'static,
    S::Future: Send + 'static,
    S::Error: Into<Box<dyn std::error::Error + Send + Sync>> + Send + 'static,
    ReqBody: Send + 'static,
{
    type Response = http::Response<Body>;
    type Error = S::Error;
    type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.inner.poll_ready(cx)
    }

    fn call(&mut self, mut request: Request<ReqBody>) -> Self::Future {
        let locator = self.locator.clone();
        let mut inner = self.inner.clone();
        std::mem::swap(&mut self.inner, &mut inner);

        Box::pin(async move {
            if let Some(client_ip) = request.extensions().get::<ClientIp>().copied() {
                match locator.lookup(client_ip.0) {
                    Ok(location) => {
                        request.extensions_mut().insert(location);
                    }
                    Err(e) => {
                        tracing::warn!(
                            ip = %client_ip.0,
                            error = %e,
                            "geolocation lookup failed"
                        );
                    }
                }
            }

            inner.call(request).await
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::geolocation::{GeolocationConfig, Location};
    use axum::body::Body;
    use http::{Request, Response, StatusCode};
    use std::convert::Infallible;
    use tower::ServiceExt;

    fn test_locator() -> GeoLocator {
        GeoLocator::from_config(&GeolocationConfig {
            mmdb_path: "tests/fixtures/GeoIP2-City-Test.mmdb".to_string(),
        })
        .unwrap()
    }

    async fn check_location(req: Request<Body>) -> Result<Response<Body>, Infallible> {
        let has_location = req.extensions().get::<Location>().is_some();
        let body = if has_location {
            "has-location"
        } else {
            "no-location"
        };
        Ok(Response::new(Body::from(body)))
    }

    #[tokio::test]
    async fn inserts_location_when_client_ip_present() {
        let layer = GeoLayer::new(test_locator());
        let svc = layer.layer(tower::service_fn(check_location));

        let ip: std::net::IpAddr = "81.2.69.142".parse().unwrap();
        let mut req = Request::builder().body(Body::empty()).unwrap();
        req.extensions_mut().insert(ClientIp(ip));

        let resp = svc.oneshot(req).await.unwrap();
        let body = axum::body::to_bytes(resp.into_body(), usize::MAX)
            .await
            .unwrap();
        assert_eq!(body.as_ref(), b"has-location");
    }

    #[tokio::test]
    async fn passes_through_when_no_client_ip() {
        let layer = GeoLayer::new(test_locator());
        let svc = layer.layer(tower::service_fn(check_location));

        let req = Request::builder().body(Body::empty()).unwrap();
        let resp = svc.oneshot(req).await.unwrap();
        assert_eq!(resp.status(), StatusCode::OK);

        let body = axum::body::to_bytes(resp.into_body(), usize::MAX)
            .await
            .unwrap();
        assert_eq!(body.as_ref(), b"no-location");
    }

    #[tokio::test]
    async fn private_ip_inserts_default_location() {
        let layer = GeoLayer::new(test_locator());
        let svc = layer.layer(tower::service_fn(|req: Request<Body>| async move {
            let loc = req.extensions().get::<Location>().cloned().unwrap();
            let has_data = loc.country_code.is_some();
            let body = if has_data { "has-data" } else { "empty" };
            Ok::<_, Infallible>(Response::new(Body::from(body)))
        }));

        let ip: std::net::IpAddr = "10.0.0.1".parse().unwrap();
        let mut req = Request::builder().body(Body::empty()).unwrap();
        req.extensions_mut().insert(ClientIp(ip));

        let resp = svc.oneshot(req).await.unwrap();
        let body = axum::body::to_bytes(resp.into_body(), usize::MAX)
            .await
            .unwrap();
        assert_eq!(body.as_ref(), b"empty");
    }
}