router-service 0.2.0

A simple HTTP router to be used as a tower service
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
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

//! An unsynchronized router that can be used as a [`Service`](tower::Service).
use std::future::Future;
use std::sync::RwLock;
use std::{collections::HashMap, sync::Arc};

use http::{Method, Request, Response};
use matchit::Router as MatchRouter;

use crate::handler::*;

pub use crate::service::ResponseFuture;

mod service;

#[derive(Default)]
struct Route<Body, Data, Error> {
    handlers: HashMap<Method, AsyncUnsyncHandler<Body, Data, Error>>,
    catchall: Option<AsyncUnsyncHandler<Body, Data, Error>>,
}

/// A router that can be used as a [`Service`](tower::Service).
///
/// # Example
/// ```
/// # futures::executor::block_on(async move {
/// use std::convert::Infallible;
///
/// use http::{Request, Response, StatusCode};
/// use tower::Service;
/// use router_service::unsync::Router;
///
/// let mut router = Router::new()
///     .get("/", |_, _| async move {
///         Response::builder().body(())
///     });
///
/// let req = Request::get("/").body(()).unwrap();
/// let resp = router.call(req).await.unwrap();
/// assert_eq!(resp.status(), 200);
/// # });
/// ```
#[derive(Default)]
pub struct Router<Body, Data: Clone, Error> {
    inner: Arc<RwLock<MatchRouter<Route<Body, Data, Error>>>>,
    data: Data,
}

impl<Body, Error> Router<Body, (), Error> {
    /// Create a new router that doesn't require any data to be passed to handlers.
    pub fn new() -> Self {
        Self {
            inner: Default::default(),
            data: (),
        }
    }
}

impl<Body, Data, Error> Router<Body, Data, Error>
where
    Body: 'static,
    Data: Clone + 'static,
    Error: 'static,
{
    /// Create a new router that requires data to be passed to handlers.
    ///
    /// # Example
    /// ```
    /// # futures::executor::block_on(async move {
    /// use std::convert::Infallible;
    ///
    /// use http::{Request, Response, StatusCode};
    /// use tower::Service;
    /// use router_service::unsync::Router;
    ///
    /// let mut router = Router::with_data(42)
    ///     .get("/", |_, data| async move {
    ///         println!("Got data! {}", data.data);
    ///         Response::builder().body(())
    ///     });
    ///
    /// let req = Request::get("/").body(()).unwrap();
    /// let resp = router.call(req).await.unwrap();
    /// assert_eq!(resp.status(), 200);
    /// # });
    /// ```
    pub fn with_data(data: Data) -> Self {
        Self {
            inner: Default::default(),
            data,
        }
    }

    /// Registers a route requiring the `GET` method.
    pub fn get<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::GET, handler)
    }

    /// Registers a route requiring the `POST` method.
    pub fn post<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::POST, handler)
    }

    /// Registers a route requiring the `PUT` method.
    pub fn put<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::PUT, handler)
    }

    /// Registers a route requiring the `DELETE` method.
    pub fn delete<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::DELETE, handler)
    }

    /// Registers a route requiring the `HEAD` method.
    pub fn head<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::HEAD, handler)
    }

    /// Registers a route requiring the `OPTIONS` method.
    pub fn options<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::DELETE, handler)
    }

    /// Registers a route requiring the `PATCH` method.
    pub fn patch<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        self.insert_handler(path, Method::PATCH, handler)
    }

    /// Registers a route matching any method.
    pub fn any<HandlerFn, Fut>(self, path: impl AsRef<str>, handler: HandlerFn) -> Self
    where
        HandlerFn: Fn(Request<Body>, RouteContext<Data>) -> Fut,
        HandlerFn: 'static,
        Fut: Future<Output = Result<Response<Body>, Error>> + 'static,
    {
        let mut inner = self.inner.write().unwrap();

        if let Ok(existing) = inner.at_mut(path.as_ref()) {
            existing.value.catchall = Some(handler.into());
        } else {
            inner
                .insert(
                    path.as_ref(),
                    Route {
                        handlers: HashMap::new(),
                        catchall: Some(handler.into()),
                    },
                )
                .expect("unable to add route to router");
        }

        drop(inner);

        self
    }

    fn insert_handler<H>(self, path: impl AsRef<str>, method: Method, handler: H) -> Self
    where
        H: Into<AsyncUnsyncHandler<Body, Data, Error>>,
    {
        let mut inner = self.inner.write().unwrap();
        if let Ok(existing) = inner.at_mut(path.as_ref()) {
            existing.value.handlers.insert(method, handler.into());
        } else {
            let mut handlers: HashMap<Method, AsyncUnsyncHandler<Body, Data, Error>> =
                HashMap::new();
            handlers.insert(method, handler.into());

            inner
                .insert(
                    path.as_ref(),
                    Route {
                        handlers,
                        catchall: None,
                    },
                )
                .expect("unable to add route to router");
        }

        drop(inner);

        self
    }
}

impl<Body, Data, Error> Clone for Router<Body, Data, Error>
where
    Data: Clone,
{
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
            data: self.data.clone(),
        }
    }
}

/// The context of a matched route.
#[derive(Debug)]
pub struct RouteContext<T> {
    /// Arbitrary data associated with the router that is available to all handlers.
    pub data: T,
    params: HashMap<String, String>,
}

impl<T> RouteContext<T> {
    /// Returns a parameter value from the path by name.
    pub fn param(&self, name: impl AsRef<str>) -> Option<&str> {
        self.params.get(name.as_ref()).map(|s| s.as_str())
    }
}

#[cfg(test)]
mod tests {
    use std::{
        convert::Infallible,
        sync::{
            atomic::{AtomicBool, Ordering},
            Arc,
        },
    };

    use http::{Method, Request, Response};
    use tower::Service;

    use crate::unsync::Router;

    #[test]
    fn not_found() {
        futures::executor::block_on(async move {
            let mut router: Router<(), (), Infallible> = Router::new();
            let req = Request::builder()
                .uri("/not-found")
                .method(Method::GET)
                .body(())
                .unwrap();

            let resp = router.call(req).await;
            let resp = resp.unwrap();

            assert_eq!(resp.status(), 404);
        });
    }

    #[test]
    fn receives_data() {
        futures::executor::block_on(async move {
            let data = Arc::new(AtomicBool::new(false));
            let mut router: Router<(), Arc<AtomicBool>, Infallible> =
                Router::with_data(data.clone()).get("/example", |_req, ctx| async move {
                    ctx.data.store(true, Ordering::SeqCst);
                    Ok(Response::builder().body(()).unwrap())
                });

            let req = Request::builder()
                .uri("/example")
                .method(Method::GET)
                .body(())
                .unwrap();

            let resp = router.call(req).await.unwrap();
            assert_eq!(resp.status(), 200);
            assert!(data.load(Ordering::SeqCst));
        });
    }

    #[test]
    fn receives_data_async() {
        futures::executor::block_on(async move {
            let data = Arc::new(AtomicBool::new(false));
            let mut router: Router<_, _, Infallible> =
                Router::with_data(data.clone()).get("/example", |_req, ctx| async move {
                    ctx.data.store(true, Ordering::SeqCst);
                    Ok(Response::builder().body(()).unwrap())
                });

            let req = Request::builder()
                .uri("/example")
                .method(Method::GET)
                .body(())
                .unwrap();

            let resp = router.call(req).await.unwrap();
            assert_eq!(resp.status(), 200);
            assert!(data.load(Ordering::SeqCst));
        });
    }
}