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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/*!


        an Async implementation of the  [`event-emitter-rs`](https://crates.io/crates/event-emitter-rs) crate

        Allows you to subscribe to events with callbacks and also fire those events.
        Events are in the form of (strings, value) and callbacks are in the form of closures that take in a value parameter;


        ## Differences between this crate and [`event-emitter-rs`](https://crates.io/crates/event-emitter-rs)
        - Emitted values should implement an extra trait (Debug) in addition to Serde's Serialize and Deserialize.
        - This is an async implementation, currently limited to tokio, but  async-std will be added soon under a feature flag.
        - The listener methods ***(on and once)*** take a callback that returns a future instead of a merely a closure.
        - The emit methods executes each callback on each event by spawning a tokio task instead of a std::thread


        ## Getting Started

        ```
        use async_event_emitter::AsyncEventEmitter;

        #[tokio::main]
        async fn main() {
        let mut event_emitter = AsyncEventEmitter::new();
        // This will print <"Hello world!"> whenever the <"Say Hello"> event is emitted
        event_emitter.on("Say Hello", |_:()|  async move { println!("Hello world!")});
        event_emitter.emit("Say Hello", ()).await;
        // >> "Hello world!"

        }
        ```

        ## Basic Usage

        We can emit and listen to values of any type so long as they implement  the Debug trait and serde's Serialize and Deserialize traits.
        A single EventEmitter instance can have listeners to values of multiple types.

        ```
        use async_event_emitter::AsyncEventEmitter as EventEmitter;
        use serde::{Deserialize, Serialize};
        #[tokio::main]
        async fn main () {
        let mut event_emitter = EventEmitter::new();
        event_emitter.on("Add three", |number: f32| async move  {println!("{}", number + 3.0)});
        event_emitter.emit("Add three", 5.0 as f32).await;
        event_emitter.emit("Add three", 4.0 as f32).await;

        // >> "8.0"
        // >> "7.0"

        // Using a more advanced value type such as a struct by implementing the serde traits
        #[derive(Serialize, Deserialize,Debug)]
        struct Date {
            month: String,
            day: String,
        }

        event_emitter.on("LOG_DATE", |date: Date|  async move {
            println!("Month: {} - Day: {}", date.month, date.day)
        });
        event_emitter.emit("LOG_DATE", Date {
            month: "January".to_string(),
            day: "Tuesday".to_string()
        }).await;
        // >> "Month: January - Day: Tuesday"
        }
        ```

        Removing listeners is also easy

        ```
        use async_event_emitter::AsyncEventEmitter as EventEmitter;
        let mut event_emitter = EventEmitter::new();

        let listener_id = event_emitter.on("Hello", |_: ()|  async {println!("Hello World")});
        match event_emitter.remove_listener(&listener_id) {
            Some(listener_id) => print!("Removed event listener!"),
            None => print!("No event listener of that id exists")
        }
        ```
        ## Creating a Global EventEmitter

        It's likely that you'll want to have a single EventEmitter instance that can be shared across files;

        After all, one of the main points of using an EventEmitter is to avoid passing down a value through several nested functions/types and having a global subscription service.

        ```
        // global_event_emitter.rs
        use lazy_static::lazy_static;
        use futures::lock::Mutex;
        use async_event_emitter::AsyncEventEmitter;

        // Use lazy_static! because the size of EventEmitter is not known at compile time
        lazy_static! {
            // Export the emitter with `pub` keyword
            pub static ref EVENT_EMITTER: Mutex<AsyncEventEmitter> = Mutex::new(AsyncEventEmitter::new());
        }

        #[tokio::main]
        async fn main() {
            // We need to maintain a lock through the mutex so we can avoid data races
            EVENT_EMITTER.lock().await.on("Hello", |_:()|  async {println!("hello there!")});
            EVENT_EMITTER.lock().await.emit("Hello", ()).await;
        }

        async fn random_function() {
            // When the <"Hello"> event is emitted in main.rs then print <"Random stuff!">
            EVENT_EMITTER.lock().await.on("Hello", |_: ()| async { println!("Random stuff!")});
        }

        ```

        License: MIT
*/

use serde::{Deserialize, Serialize};
use std::{collections::HashMap, sync::Arc};
use tokio::task::{self};

use futures::future::{BoxFuture, Future, FutureExt};
use uuid::Uuid;

pub type AsyncCB = dyn Fn(Vec<u8>) -> BoxFuture<'static, ()> + Send + Sync + 'static;

#[derive(Clone)]
pub struct AsyncListener {
    pub callback: Arc<AsyncCB>,
    pub limit: Option<u64>,
    pub id: String,
}

#[derive(Default, Clone)]
pub struct AsyncEventEmitter {
    pub listeners: HashMap<String, Vec<AsyncListener>>,
}

impl AsyncEventEmitter {
    pub fn new() -> Self {
        Self::default()
    }

    /// Emits an event of the given parameters and executes each callback that is listening to that event asynchronously by spawning a task for each callback.
    ///
    /// # Example
    ///
    /// ```
    /// use async_event_emitter::AsyncEventEmitter;
    /// let mut event_emitter = AsyncEventEmitter::new();
    ///
    /// // Emits the <"Some event"> event and a value <"Hello programmer">
    /// // The value can be of any type as long as it implements the serde Serialize trait
    ///   tokio_test::block_on(async {
    ///    event_emitter.emit("Some event", "Hello programmer!").await;
    ///     
    ///   
    ///     })
    ///   
    /// ```
    ///
    ///

    pub async fn emit<'a, T>(&mut self, event: &str, value: T) -> anyhow::Result<()>
    where
        T: Serialize + Deserialize<'a> + Send + Sync + 'a + std::fmt::Debug,
    {
        let mut callback_handlers: Vec<_> = Vec::new();

        if let Some(listeners) = self.listeners.get_mut(event) {
            let mut listeners_to_remove: Vec<usize> = Vec::new();
            for (index, listener) in listeners.iter_mut().enumerate() {
                let bytes: Vec<u8> = bincode::serialize(&value)?;

                let callback = Arc::clone(&listener.callback);

                match listener.limit {
                    None => {
                        callback_handlers.push(task::spawn(async move {
                            callback(bytes).await;
                        }));
                    }
                    Some(limit) => {
                        if limit != 0 {
                            callback_handlers
                                .push(task::spawn(async move { callback(bytes).await }));
                            listener.limit = Some(limit - 1);
                        } else {
                            listeners_to_remove.push(index);
                        }
                    }
                }
            }

            // Reverse here so we don't mess up the ordering of the vector
            for index in listeners_to_remove.into_iter().rev() {
                listeners.remove(index);
            }
        }

        for handles in callback_handlers {
            handles.await?;
        }

        Ok(())
    }

    /// Removes an event listener with the given id
    ///
    /// # Example
    ///
    /// ```
    ///use async_event_emitter::AsyncEventEmitter;
    /// let mut event_emitter = AsyncEventEmitter::new();
    /// let listener_id = event_emitter.on("Some event", |value: ()|  async {println!("Hello world!")});
    /// println!("{:?}", event_emitter.listeners);
    ///
    /// // Removes the listener that we just added
    /// event_emitter.remove_listener(&listener_id);
    ///
    /// ```
    ///
    ///

    pub fn remove_listener(&mut self, id_to_delete: &str) -> Option<String> {
        for (_, event_listeners) in self.listeners.iter_mut() {
            if let Some(index) = event_listeners
                .iter()
                .position(|listener| listener.id == id_to_delete)
            {
                event_listeners.remove(index);
                return Some(id_to_delete.to_string());
            }
        }

        None
    }

    /// Adds an event listener that will only execute the listener x amount of times - Then the listener will be deleted.
    /// Returns the id of the newly added listener.
    ///
    /// # Example
    ///
    /// ```
    /// use async_event_emitter::AsyncEventEmitter;
    /// let mut event_emitter = AsyncEventEmitter::new();
    ///
    /// // Listener will be executed 3 times. After the third time, the listener will be deleted.
    ///
    /// event_emitter.on_limited("Some event", Some(3), |value: ()| async{ println!("Hello world!")});
    /// tokio_test::block_on( async{
    /// event_emitter.emit("Some event", ()).await; // 1 >> "Hello world!"
    /// event_emitter.emit("Some event", ()).await; // 2 >> "Hello world!"
    /// event_emitter.emit("Some event", ()).await; // 3 >> "Hello world!"
    /// event_emitter.emit("Some event", ()).await; // 4 >> <Nothing happens here because listener was deleted after the 3rd call>
    ///
    /// });
    /// ```

    pub fn on_limited<F, T, C>(&mut self, event: &str, limit: Option<u64>, callback: C) -> String
    where
        for<'de> T: Deserialize<'de> + std::fmt::Debug,
        C: Fn(T) -> F + Send + Sync + 'static,
        F: Future<Output = ()> + Send + Sync + 'static,
    {
        let id = Uuid::new_v4().to_string();
        let parsed_callback = move |bytes: Vec<u8>| {
            let value: T = bincode::deserialize(&bytes).unwrap_or_else(|_| {
                panic!(
                    " value can't be deserialized into type {}",
                    std::any::type_name::<T>()
                )
            });

            callback(value).boxed()
        };

        let listener = AsyncListener {
            id: id.clone(),
            limit,
            callback: Arc::new(parsed_callback),
        };

        match self.listeners.get_mut(event) {
            Some(callbacks) => {
                callbacks.push(listener);
            }
            None => {
                self.listeners.insert(event.to_string(), vec![listener]);
            }
        }

        id
    }

    /// Adds an event listener that will only execute the callback once - Then the listener will be deleted.
    /// Returns the id of the newly added listener.
    ///
    /// # Example
    ///
    /// ```
    /// use async_event_emitter::AsyncEventEmitter;
    /// let mut event_emitter = AsyncEventEmitter::new();
    ///
    /// event_emitter.once("Some event", |value: ()| async {println!("Hello world!")});
    /// event_emitter.emit("Some event", ()); // First event is emitted and the listener's callback is called once
    /// // >> "Hello world!"
    ///
    /// event_emitter.emit("Some event", ());
    /// // >> <Nothing happens here since listener was deleted>
    /// ```
    ///
    pub fn once<F, T, C>(&mut self, event: &str, callback: C) -> String
    where
        for<'de> T: Deserialize<'de> + std::fmt::Debug,
        C: Fn(T) -> F + Send + Sync + 'static,
        F: Future<Output = ()> + Send + Sync + 'static,
    {
        self.on_limited(event, Some(1), callback)
    }

    /// Adds an event listener with a callback that will get called whenever the given event is emitted.
    /// Returns the id of the newly added listener.
    ///
    /// # Example
    ///
    /// ```
    /// use async_event_emitter::AsyncEventEmitter;
    /// let mut event_emitter = AsyncEventEmitter::new();
    ///
    /// // This will print <"Hello world!"> whenever the <"Some event"> event is emitted
    /// // The type of the `value` parameter for the closure MUST be specified and, if you plan to use the `value`, the `value` type
    /// // MUST also match the type that is being emitted (here we just use a throwaway `()` type since we don't care about using the `value`)
    /// event_emitter.on("Some event", |value: ()| async { println!("Hello world!")});
    ///
    /// ```
    pub fn on<F, T, C>(&mut self, event: &str, callback: C) -> String
    where
        for<'de> T: Deserialize<'de> + std::fmt::Debug,
        C: Fn(T) -> F + Send + Sync + 'static,
        F: Future<Output = ()> + Send + Sync + 'static,
    {
        self.on_limited(event, None, callback)
    }
}

// test the AsyncEventEmitter
// implement fmt::Debug for AsyncEventListener
use std::fmt;
impl fmt::Debug for AsyncListener {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("AsyncListener")
            .field("id", &self.id)
            .field("limit", &self.limit)
            .finish()
    }
}

// implement fmt::Debug   for AsyncEventEmitter
impl fmt::Debug for AsyncEventEmitter {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("AsyncEventEmitter")
            .field("listeners", &self.listeners)
            .finish()
    }
}