volga 0.9.1

Easy & Fast Web Framework for Rust
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

//! Represents tools for "local" middleware

use crate::http::endpoints::handlers::RouteHandler;
use crate::{HttpResult, status};

#[cfg(feature = "middleware")]
use crate::middleware::{HttpContext, MiddlewareFn, Middlewares, NextFn, from_handler};

#[cfg(not(feature = "middleware"))]
use crate::http::request::HttpRequest;

/// A layer of middleware or a route handler
#[derive(Clone)]
pub(crate) enum Layer {
    Handler(RouteHandler),
    #[cfg(feature = "middleware")]
    Middleware(MiddlewareFn),
}

impl From<RouteHandler> for Layer {
    #[inline]
    fn from(handler: RouteHandler) -> Self {
        Self::Handler(handler)
    }
}

#[cfg(feature = "middleware")]
impl From<MiddlewareFn> for Layer {
    #[inline]
    fn from(mw: MiddlewareFn) -> Self {
        Self::Middleware(mw)
    }
}

impl From<Layer> for RouteHandler {
    #[inline]
    fn from(layer: Layer) -> Self {
        match layer {
            Layer::Handler(handler) => handler,
            #[cfg(feature = "middleware")]
            Layer::Middleware(_) => unreachable!(),
        }
    }
}

#[cfg(feature = "middleware")]
impl From<Layer> for MiddlewareFn {
    #[inline]
    fn from(layer: Layer) -> Self {
        match layer {
            Layer::Middleware(mw) => mw,
            Layer::Handler(handler) => from_handler(handler),
        }
    }
}

/// Route's middleware pipeline
#[derive(Clone)]
pub(crate) enum RoutePipeline {
    #[cfg(feature = "middleware")]
    Builder(Middlewares),
    #[cfg(feature = "middleware")]
    Middleware(Option<NextFn>),
    #[cfg(not(feature = "middleware"))]
    Handler(Option<RouteHandler>),
}

impl From<Layer> for RoutePipeline {
    fn from(handler: Layer) -> Self {
        #[cfg(feature = "middleware")]
        let pipeline = Self::Builder(Middlewares::from(MiddlewareFn::from(handler)));
        #[cfg(not(feature = "middleware"))]
        let pipeline = Self::Handler(Some(RouteHandler::from(handler)));
        pipeline
    }
}

impl RoutePipeline {
    /// Creates s new middleware pipeline
    pub(super) fn new() -> Self {
        #[cfg(feature = "middleware")]
        let pipeline = Self::Builder(Middlewares::new());
        #[cfg(not(feature = "middleware"))]
        let pipeline = Self::Handler(None);
        pipeline
    }

    /// Inserts a layer into the pipeline
    pub(super) fn insert(&mut self, layer: Layer) {
        match self {
            #[cfg(feature = "middleware")]
            Self::Builder(mx) => mx.add(layer.into()),
            #[cfg(feature = "middleware")]
            Self::Middleware(_) => (),
            #[cfg(not(feature = "middleware"))]
            Self::Handler(route_handler) => *route_handler = Some(layer.into()),
        }
    }

    /// Calls the pipeline chain
    #[cfg(feature = "middleware")]
    pub(crate) async fn call(self, ctx: HttpContext) -> HttpResult {
        match self {
            Self::Middleware(Some(next)) => {
                let next = next.clone();
                next(ctx).await
            }
            _ => status!(405),
        }
    }

    /// Calls the request handler
    #[cfg(not(feature = "middleware"))]
    pub(crate) async fn call(self, req: HttpRequest) -> HttpResult {
        match self {
            Self::Handler(Some(handler)) => handler.call(req).await,
            _ => status!(405),
        }
    }

    /// Builds a middleware pipeline
    #[cfg(feature = "middleware")]
    pub(super) fn compose(&mut self) {
        let next = match self {
            Self::Middleware(_) => return,
            Self::Builder(mx) => {
                // Unlike global, in route middlewares the route handler
                // initially locates at the beginning of the pipeline,
                // so we need to take it to the end
                mx.pipeline.rotate_left(1);
                mx.compose()
            }
        };
        *self = Self::Middleware(next)
    }
}

#[cfg(all(test, not(feature = "middleware")))]
mod tests {
    use super::{Layer, RoutePipeline};
    use crate::http::endpoints::handlers::{Handler, RouteHandler};
    use crate::{HttpRequest, HttpResult, status};
    use futures_util::future::BoxFuture;
    use std::sync::Arc;

    struct NoopHandler;

    impl Handler for NoopHandler {
        fn call(&self, _req: HttpRequest) -> BoxFuture<'_, HttpResult> {
            Box::pin(async { status!(204) })
        }
    }

    #[test]
    fn pipeline_from_layer_contains_handler() {
        let handler: RouteHandler = Arc::new(NoopHandler);
        let pipeline = RoutePipeline::from(Layer::from(handler.clone()));

        match pipeline {
            RoutePipeline::Handler(Some(inner)) => {
                assert!(Arc::ptr_eq(&inner, &handler));
            }
            _ => panic!("expected handler pipeline"),
        }
    }

    #[test]
    fn insert_sets_handler_in_pipeline() {
        let handler: RouteHandler = Arc::new(NoopHandler);
        let mut pipeline = RoutePipeline::new();
        pipeline.insert(Layer::from(handler.clone()));

        match pipeline {
            RoutePipeline::Handler(Some(inner)) => {
                assert!(Arc::ptr_eq(&inner, &handler));
            }
            _ => panic!("expected handler pipeline"),
        }
    }
}