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
use failure::Error;
use futures::{future, Future, Poll};
use tgbot::types::Update;

/// Result of a middleware
#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
pub enum MiddlewareResult {
    /// Continue propagation
    ///
    /// Next middleware and all handlers (if exists) will run after current has finished
    Continue,
    /// Stop propagation
    ///
    /// Next middleware and all handlers (if exists) will not run after current has finished
    Stop,
}

/// A middleware future
#[must_use = "futures do nothing unless polled"]
pub struct MiddlewareFuture {
    inner: Box<Future<Item = MiddlewareResult, Error = Error> + Send>,
}

impl MiddlewareFuture {
    /// Creates a new middleware future
    pub fn new<F>(f: F) -> MiddlewareFuture
    where
        F: Future<Item = MiddlewareResult, Error = Error> + Send + 'static,
    {
        MiddlewareFuture { inner: Box::new(f) }
    }
}

impl<E> From<Result<MiddlewareResult, E>> for MiddlewareFuture
where
    E: Into<Error>,
{
    fn from(result: Result<MiddlewareResult, E>) -> Self {
        MiddlewareFuture::new(future::result(result.map_err(Into::into)))
    }
}

impl From<MiddlewareResult> for MiddlewareFuture {
    fn from(result: MiddlewareResult) -> MiddlewareFuture {
        MiddlewareFuture::new(future::ok(result))
    }
}

impl Future for MiddlewareFuture {
    type Item = MiddlewareResult;
    type Error = Error;

    fn poll(&mut self) -> Poll<Self::Item, Self::Error> {
        self.inner.poll()
    }
}

/// Middleware handler
pub trait Middleware<C> {
    /// Called before all handlers
    fn before(&mut self, _context: &mut C, _update: &Update) -> MiddlewareFuture {
        MiddlewareResult::Continue.into()
    }

    /// Called after all handlers
    fn after(&mut self, _context: &mut C, _update: &Update) -> MiddlewareFuture {
        MiddlewareResult::Continue.into()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::{
        dispatcher::{Dispatcher, ErrorStrategy},
        handler::{Handler, HandlerFuture},
    };
    use std::sync::{
        atomic::{AtomicUsize, Ordering},
        Arc,
    };
    use tgbot::types::Message;

    struct Counter {
        calls: Arc<AtomicUsize>,
    }

    impl Counter {
        fn new() -> Self {
            Self {
                calls: Arc::new(AtomicUsize::new(0)),
            }
        }

        fn inc_calls(&self) {
            self.calls.fetch_add(1, Ordering::SeqCst);
        }

        fn get_calls(&self) -> usize {
            self.calls.load(Ordering::SeqCst)
        }
    }

    fn parse_update(data: &str) -> Update {
        serde_json::from_str(data).unwrap()
    }

    struct MockMiddleware {
        before_result: MiddlewareResult,
        after_result: MiddlewareResult,
    }

    impl Middleware<Counter> for MockMiddleware {
        fn before(&mut self, context: &mut Counter, _update: &Update) -> MiddlewareFuture {
            context.inc_calls();
            self.before_result.into()
        }

        fn after(&mut self, context: &mut Counter, _update: &Update) -> MiddlewareFuture {
            context.inc_calls();
            self.after_result.into()
        }
    }

    fn handle_message(context: &mut Counter, _message: &Message) -> HandlerFuture {
        context.inc_calls();
        ().into()
    }

    #[test]
    fn test_middleware() {
        let update = parse_update(
            r#"{
            "update_id": 1,
            "message": {
                "message_id": 1111,
                "date": 0,
                "from": {"id": 1, "is_bot": false, "first_name": "test"},
                "chat": {"id": 1, "type": "private", "first_name": "test"},
                "text": "test"
            }
        }"#,
        );

        let mut dispatcher = Dispatcher::new(
            vec![
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Continue,
                    after_result: MiddlewareResult::Continue,
                }),
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Stop,
                    after_result: MiddlewareResult::Continue,
                }),
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Continue,
                    after_result: MiddlewareResult::Stop,
                }),
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Continue,
                    after_result: MiddlewareResult::Continue,
                }),
            ],
            vec![Handler::message(handle_message)],
            Counter::new(),
            ErrorStrategy::Abort,
            ErrorStrategy::Abort,
        );
        dispatcher.dispatch(update.clone()).wait().unwrap();
        assert_eq!(dispatcher.context.lock().unwrap().get_calls(), 5);

        let mut dispatcher = Dispatcher::new(
            vec![
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Continue,
                    after_result: MiddlewareResult::Stop,
                }),
                Box::new(MockMiddleware {
                    before_result: MiddlewareResult::Continue,
                    after_result: MiddlewareResult::Continue,
                }),
            ],
            vec![Handler::message(handle_message)],
            Counter::new(),
            ErrorStrategy::Abort,
            ErrorStrategy::Abort,
        );
        dispatcher.dispatch(update).wait().unwrap();
        assert_eq!(dispatcher.context.lock().unwrap().get_calls(), 4);
    }
}