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
//! This create wraps `hyper::server::Service` with a slightly more convenient interface.
//!
//! The request is wrapped with a new enum that helps provide additional information along with the
//! request and uses a more liberal error type to allow users to map their own error to an actual
//! http response.
extern crate futures;
extern crate hyper;
extern crate typemap;

use futures::future::{self, Future};
use hyper::{Body, StatusCode};
use hyper::server::{Request, Response, Service};
use typemap::TypeMap;

use std::marker::PhantomData;

// A convenience alias.
type ServiceFuture = Box<Future<Item = Response, Error = hyper::Error>>;

/// Wraps a `hyper::Request` so that luminal can add additional information alongside the request.
pub enum HttpRequest {
    Raw(Request),
    Context { request: Request, context: TypeMap },
}

/// Trait to implement on errors so that a caller's error type can be converted into a response.
pub trait IntoResponse {
    fn status(&self) -> StatusCode {
        StatusCode::InternalServerError
    }

    fn body(&self) -> Body;
}

/// Trait for handling a request, returning a response or an error that can be converted into a
/// `hyper::Response`.
pub trait Handler<E: IntoResponse> {
    fn handle(&self, req: HttpRequest) -> Result<Response, E>;
}

/// An impl of `hyper::Service` that consumes an impl of `Handler`.
pub struct HandlerService<H, E>
where
    E: IntoResponse,
    H: Handler<E>,
{
    handler: H,
    _phantom: PhantomData<E>,
}

impl<H, E> Service for HandlerService<H, E>
where
    E: IntoResponse,
    H: Handler<E>,
{
    type Request = Request;
    type Response = Response;
    type Error = hyper::Error;
    type Future = ServiceFuture;

    /// Dispatches to the owned `Handler`, marshalling success or error into the response.
    fn call(&self, request: Request) -> Self::Future {
        let http_request = HttpRequest::Raw(request);
        match self.handler.handle(http_request) {
            Ok(response) => Box::new(future::ok(response)),
            Err(error) => Box::new(future::ok(
                Response::new()
                    .with_status(error.status())
                    .with_body(error.body()),
            )),
        }
    }
}

/// Accepts a function or closure that takes an `HttpRequest` and returns a compatible `Result`.
pub fn handler_fn<F, E>(func: F) -> HandlerService<HandlerFn<F, E>, E>
where
    F: Fn(HttpRequest) -> Result<Response, E>,
    E: IntoResponse,
{
    HandlerService::new(HandlerFn { func })
}

/// Holds a function to dispatch to via its impl of `Handler<E>`.
pub struct HandlerFn<F, E>
where
    F: Fn(HttpRequest) -> Result<Response, E>,
    E: IntoResponse,
{
    func: F,
}

impl<F, E> Handler<E> for HandlerFn<F, E>
where
    F: Fn(HttpRequest) -> Result<Response, E>,
    E: IntoResponse,
{
    fn handle(&self, req: HttpRequest) -> Result<Response, E> {
        (self.func)(req)
    }
}

impl<H, E> HandlerService<H, E>
where
    E: IntoResponse,
    H: Handler<E>,
{
    pub fn new(handler: H) -> Self {
        HandlerService {
            handler,
            _phantom: PhantomData,
        }
    }
}

#[cfg(test)]
mod tests {
    extern crate luminal_router;
    extern crate tokio_core;

    use self::luminal_router::Router;
    use futures::Stream;
    use hyper::Method;

    use self::tokio_core::reactor::Core;

    use super::*;

    #[derive(Clone)]
    struct TestError {
        status: StatusCode,
        body: String,
    }

    impl IntoResponse for TestError {
        fn status(&self) -> StatusCode {
            self.status
        }

        fn body(&self) -> Body {
            self.body.clone().into()
        }
    }

    enum TestHandler {
        Success(String),
        Failure(TestError),
    }

    impl Handler<TestError> for TestHandler {
        fn handle(&self, _request: HttpRequest) -> Result<Response, TestError> {
            match *self {
                TestHandler::Success(ref body) => {
                    let body: String = body.clone();
                    Ok(Response::new().with_status(StatusCode::Ok).with_body(body))
                }
                TestHandler::Failure(ref error) => Err(error.clone()),
            }
        }
    }

    #[test]
    fn test_success() {
        let handler = TestHandler::Success(String::from("Success"));
        let service = HandlerService::new(handler);

        assert_call(&service, Method::Get, "/foo", (&StatusCode::Ok, "Success"));
    }

    #[test]
    fn test_failure() {
        let handler = TestHandler::Failure(TestError {
            status: StatusCode::InternalServerError,
            body: String::from("Error"),
        });
        let service = HandlerService::new(handler);

        assert_call(
            &service,
            Method::Get,
            "/foo",
            (&StatusCode::InternalServerError, "Error"),
        );
    }

    fn test_fn(_req: HttpRequest) -> Result<Response, TestError> {
        Ok(Response::new()
            .with_status(StatusCode::Ok)
            .with_body(String::from("test")))
    }

    #[test]
    fn test_fn_route() {
        let handler = TestHandler::Success(String::from("Success"));
        let service = HandlerService::new(handler);
        let router = Router::new();

        let router = router
            .get("/foo", service)
            .expect("Should have been able to add handler")
            .get("/bar", handler_fn(test_fn))
            .expect("Should have been able to add handler fn");

        assert_route(&router, Method::Get, "/foo", (&StatusCode::Ok, "Success"));
        assert_route(&router, Method::Get, "/bar", (&StatusCode::Ok, "test"));
    }

    fn assert_route(service: &Router, method: Method, uri: &str, expected: (&StatusCode, &str)) {
        let uri = uri.parse()
            .expect("Should have been able to convert to uri");
        let req: Request<Body> = Request::new(method, uri);

        let work = service.call(req);

        let mut core = Core::new().expect("Should have been able to create core");

        let response = core.run(work)
            .expect("Should have been able to run router call");

        assert_eq!(
            *expected.0,
            response.status(),
            "Should have received {} status.",
            expected.0
        );

        let body = core.run(response.body().concat2())
            .expect("Should have been able to resolve body concat");
        let body: &[u8] = &body.to_vec();

        assert_eq!(
            expected.1.as_bytes(),
            body,
            "Should have received correct body content"
        );
    }

    fn assert_call<H, E>(
        service: &HandlerService<H, E>,
        method: Method,
        uri: &str,
        expected: (&StatusCode, &str),
    ) where
        E: IntoResponse,
        H: Handler<E>,
    {
        let uri = uri.parse()
            .expect("Should have been able to convert to uri");
        let req: Request<Body> = Request::new(method, uri);

        let work = service.call(req);

        let mut core = Core::new().expect("Should have been able to create core");

        let response = core.run(work)
            .expect("Should have been able to run router call");

        assert_eq!(
            *expected.0,
            response.status(),
            "Should have received {} status.",
            expected.0
        );

        let body = core.run(response.body().concat2())
            .expect("Should have been able to resolve body concat");
        let body: &[u8] = &body.to_vec();

        assert_eq!(
            expected.1.as_bytes(),
            body,
            "Should have received correct body content"
        );
    }
}