saphir 2.0.0-alpha

Fully async-await http server framework
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

use crate::{
    controller::{Controller, DynControllerHandler},
    error::SaphirError,
    handler::DynHandler,
    request::Request,
    responder::{DynResponder, Responder},
    response::Response,
    utils::{EndpointResolver, EndpointResolverResult},
};
use futures::future::BoxFuture;
use http::Method;
use hyper::Body;
use std::{collections::HashMap, sync::Arc};

/// Builder type for the router
pub struct Builder<Chain: RouterChain + Send + Unpin + 'static + Sync> {
    resolver: HashMap<String, EndpointResolver>,
    chain: Chain,
}

impl Default for Builder<RouterChainEnd> {
    fn default() -> Self {
        Self {
            resolver: Default::default(),
            chain: RouterChainEnd {
                handlers: Default::default(),
            },
        }
    }
}

impl<Controllers: 'static + RouterChain + Unpin + Send + Sync> Builder<Controllers> {
    /// Add a simple request handle to a given path
    ///
    /// ```rust
    ///# use saphir::router::Builder as RBuilder;
    ///# use saphir::prelude::*;
    ///#
    ///# let builder = RBuilder::default();
    /// // Simply declare a handler fn
    /// async fn simple_handler(req: Request<Body>) -> impl Responder {200}
    ///
    /// // Then while building your server
    /// // ...
    /// builder.route("/simple", Method::GET, simple_handler);
    /// // ...
    /// ```
    pub fn route<H: 'static + DynHandler<Body> + Send + Sync>(
        mut self,
        route: &str,
        method: Method,
        handler: H,
    ) -> Self {
        let endpoint_id = if let Some(er) = self.resolver.get_mut(route) {
            er.add_method(method.clone());
            er.id()
        } else {
            let er = EndpointResolver::new(route, method.clone()).expect("Unable to construct endpoint resolver");
            let er_id = er.id();
            self.resolver.insert(route.to_string(), er);
            er_id
        };

        self.chain.add_handler(endpoint_id, method, Box::new(handler));

        self
    }

    /// Add a simple request handle to a given path
    ///
    /// ```rust
    ///# use saphir::router::Builder as RBuilder;
    ///# use saphir::prelude::*;
    ///#
    ///# let builder = RBuilder::default();
    /// // Implement controller for your struct
    /// struct SimpleController;
    ///# impl Controller for SimpleController {
    ///#    const BASE_PATH: &'static str = "/basic";
    ///#    fn handlers(&self) -> Vec<ControllerEndpoint<Self>> where Self: Sized {EndpointsBuilder::new().build()}
    ///# }
    /// // Then while building your server
    /// // ...
    /// builder.controller(SimpleController);
    /// // ...
    /// ```
    pub fn controller<C: Controller + Send + Unpin + Sync>(
        mut self,
        controller: C,
    ) -> Builder<RouterChainLink<C, Controllers>> {
        let mut handlers = HashMap::new();
        for (method, subroute, handler) in controller.handlers() {
            let route = format!("{}{}", C::BASE_PATH, subroute);
            let endpoint_id = if let Some(er) = self.resolver.get_mut(&route) {
                er.add_method(method.clone());
                er.id()
            } else {
                let er = EndpointResolver::new(&route, method.clone()).expect("Unable to construct endpoint resolver");
                let er_id = er.id();
                self.resolver.insert(route, er);
                er_id
            };

            handlers.insert((endpoint_id, method), handler);
        }

        Builder {
            resolver: self.resolver,
            chain: RouterChainLink {
                controller,
                handlers,
                rest: self.chain,
            },
        }
    }

    pub(crate) fn build(self) -> Router {
        let Builder {
            resolver,
            chain: controllers,
        } = self;

        Router {
            inner: Arc::new(RouterInner {
                resolvers: resolver.into_iter().map(|(_, e)| e).collect(),
                chain: Box::new(controllers),
            }),
        }
    }
}

struct RouterInner {
    resolvers: Vec<EndpointResolver>,
    chain: Box<dyn RouterChain + Send + Unpin + Sync>,
}

#[doc(hidden)]
#[derive(Clone)]
pub struct Router {
    inner: Arc<RouterInner>,
}

impl Router {
    pub fn builder() -> Builder<RouterChainEnd> {
        Builder::default()
    }

    pub fn resolve(&self, req: &mut Request<Body>) -> Result<u64, u16> {
        let mut method_not_allowed = false;
        for endpoint_resolver in &self.inner.resolvers {
            match endpoint_resolver.resolve(req) {
                EndpointResolverResult::InvalidPath => continue,
                EndpointResolverResult::MethodNotAllowed => method_not_allowed = true,
                EndpointResolverResult::Match => return Ok(endpoint_resolver.id()),
            }
        }

        if method_not_allowed {
            Err(405)
        } else {
            Err(404)
        }
    }

    pub async fn handle(self, mut req: Request<Body>) -> Result<Response<Body>, SaphirError> {
        match self.resolve(&mut req) {
            Ok(id) => self.dispatch(id, req).await,
            Err(status) => status.respond(),
        }
    }

    pub async fn dispatch(&self, resolver_id: u64, req: Request<Body>) -> Result<Response<Body>, SaphirError> {
        if let Some(responder) = self.inner.chain.dispatch(resolver_id, req) {
            responder.await.dyn_respond()
        } else {
            404.respond()
        }
    }
}

#[doc(hidden)]
pub trait RouterChain {
    fn dispatch(&self, resolver_id: u64, req: Request<Body>) -> Option<BoxFuture<'static, Box<dyn DynResponder>>>;
    fn add_handler(&mut self, endpoint_id: u64, method: Method, handler: Box<dyn DynHandler<Body> + Send + Sync>);
}

#[doc(hidden)]
pub struct RouterChainEnd {
    handlers: HashMap<(u64, Method), Box<dyn DynHandler<Body> + Send + Sync>>,
}

impl RouterChain for RouterChainEnd {
    #[doc(hidden)]
    #[inline]
    fn dispatch(&self, resolver_id: u64, req: Request<Body>) -> Option<BoxFuture<'static, Box<dyn DynResponder>>> {
        if let Some(handler) = self.handlers.get(&(resolver_id, req.method().clone())) {
            Some(handler.dyn_handle(req))
        } else {
            None
        }
    }

    #[doc(hidden)]
    #[inline]
    fn add_handler(&mut self, endpoint_id: u64, method: Method, handler: Box<dyn DynHandler<Body> + Send + Sync>) {
        self.handlers.insert((endpoint_id, method), handler);
    }
}

#[doc(hidden)]
pub struct RouterChainLink<C, Rest: RouterChain> {
    controller: C,
    handlers: HashMap<(u64, Method), Box<dyn DynControllerHandler<C, Body> + Send + Sync>>,
    rest: Rest,
}

impl<C, Rest: RouterChain> RouterChain for RouterChainLink<C, Rest> {
    #[doc(hidden)]
    #[inline]
    fn dispatch(&self, resolver_id: u64, req: Request<Body>) -> Option<BoxFuture<'static, Box<dyn DynResponder>>> {
        if let Some(handler) = self.handlers.get(&(resolver_id, req.method().clone())) {
            Some(handler.dyn_handle(&self.controller, req))
        } else {
            self.rest.dispatch(resolver_id, req)
        }
    }

    #[doc(hidden)]
    #[inline]
    fn add_handler(&mut self, endpoint_id: u64, method: Method, handler: Box<dyn DynHandler<Body> + Send + Sync>) {
        self.rest.add_handler(endpoint_id, method, handler);
    }
}