tokio-events 0.2.1

A modern, type-safe async event bus for Rust applications
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
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
//! Redb implementation of persistent event dispatcher and registry.

use crate::dispatcher::{DispatcherConfig, DispatcherStats, EventDispatcher};
use crate::event::EventEnvelope;
use crate::registry::{DashMapRegistry, EventRegistry, SubscriptionEntry};
use crate::subscription::SubscriptionManager;
use crate::{Error, Result};
use async_trait::async_trait;
use redb::{Database, ReadableDatabase, ReadableTable, TableDefinition};
use std::any::TypeId;
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::Arc;
use tokio::sync::mpsc;
use tokio::task::JoinHandle;
use tokio::time::Instant;
use tracing::{error, info, trace};
use uuid::Uuid;

/// A serialized representation of an event and its metadata for persistent storage
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct PersistedEnvelope {
    /// The stable string name of the event type
    pub type_name: String,
    /// The event metadata including IDs and tracing info
    pub metadata: crate::event::EventMetadata,
    /// The priority level of the event
    pub priority: crate::event::EventPriority,
    /// The serialized JSON payload of the event itself
    pub payload: Vec<u8>,
}

const EVENTS_TABLE: TableDefinition<'_, u128, &[u8]> = TableDefinition::new("events");
const REFCOUNT_TABLE: TableDefinition<'_, u128, u32> = TableDefinition::new("refcount");

/// A registry that wraps an in-memory registry and intercepts acks to update redb
#[derive(Debug)]
pub struct RedbRegistry {
    inner: Arc<DashMapRegistry>,
    ack_tx: tokio::sync::mpsc::UnboundedSender<Uuid>,
}

impl RedbRegistry {
    /// Create a new RedbRegistry
    pub fn new(db: Arc<Database>, inner: Arc<DashMapRegistry>) -> Self {
        let (ack_tx, mut ack_rx) = tokio::sync::mpsc::unbounded_channel::<Uuid>();
        let db_clone = db.clone();
        
        // Background worker to process DB acks without blocking the Tokio reactor
        tokio::spawn(async move {
            while let Some(event_id) = ack_rx.recv().await {
                let db_for_task = db_clone.clone();
                let res = tokio::task::spawn_blocking(move || {
                    let event_id_u128 = event_id.as_u128();
                    let write_txn = match db_for_task.begin_write() {
                        Ok(txn) => txn,
                        Err(e) => {
                            error!("Failed to begin write txn for ack: {}", e);
                            return;
                        }
                    };

                    {
                        let mut refcounts = match write_txn.open_table(REFCOUNT_TABLE) {
                            Ok(t) => t,
                            Err(e) => {
                                error!("Failed to open refcount table: {}", e);
                                return;
                            }
                        };
                        let mut events = match write_txn.open_table(EVENTS_TABLE) {
                            Ok(t) => t,
                            Err(e) => {
                                error!("Failed to open events table: {}", e);
                                return;
                            }
                        };

                        let current = if let Ok(Some(count_access)) = refcounts.get(event_id_u128) {
                            Some(count_access.value())
                        } else {
                            None
                        };

                        if let Some(current) = current {
                            if current <= 1 {
                                // Last subscriber processed it, delete the event
                                let _ = refcounts.remove(event_id_u128);
                                let _ = events.remove(event_id_u128);
                                trace!(event_id = %event_id, "Event completely processed and removed from DB");
                            } else {
                                // Decrement
                                let _ = refcounts.insert(event_id_u128, current - 1);
                                trace!(event_id = %event_id, remaining = current - 1, "Event acked");
                            }
                        }
                    }

                    let _ = write_txn.commit();
                }).await;
                
                if let Err(e) = res {
                    error!("Ack task panicked: {}", e);
                }
            }
        });

        Self { inner, ack_tx }
    }
}

impl EventRegistry for RedbRegistry {
    fn register(
        &self,
        event_type: TypeId,
        type_name: &str,
        subscription: SubscriptionEntry,
    ) -> Result<()> {
        self.inner.register(event_type, type_name, subscription)
    }

    fn unregister(&self, subscription_id: Uuid) -> Result<()> {
        self.inner.unregister(subscription_id)
    }

    fn get_subscriptions(&self, event_type: TypeId) -> Vec<SubscriptionEntry> {
        self.inner.get_subscriptions(event_type)
    }

    fn get_subscription(&self, subscription_id: Uuid) -> Option<SubscriptionEntry> {
        self.inner.get_subscription(subscription_id)
    }

    fn increment_processed(&self, subscription_id: Uuid) {
        self.inner.increment_processed(subscription_id)
    }

    fn deactivate(&self, subscription_id: Uuid) -> Result<()> {
        self.inner.deactivate(subscription_id)
    }

    fn total_subscriptions(&self) -> usize {
        self.inner.total_subscriptions()
    }

    fn subscription_count(&self, event_type: TypeId) -> usize {
        self.inner.subscription_count(event_type)
    }

    fn event_types(&self) -> Vec<TypeId> {
        self.inner.event_types()
    }

    fn clear(&self) {
        self.inner.clear()
    }

    fn get_type_id(&self, type_name: &str) -> Option<TypeId> {
        self.inner.get_type_id(type_name)
    }

    fn ack_event(&self, _subscription_id: Uuid, event_id: Uuid) {
        let _ = self.ack_tx.send(event_id);
    }
}

/// A dispatcher that writes events to redb before passing them to the subscription manager
#[allow(missing_debug_implementations)]
pub struct RedbDispatcher {
    db: Arc<Database>,
    config: DispatcherConfig,
    sender: Option<mpsc::Sender<Arc<EventEnvelope>>>,
    receiver: Option<mpsc::Receiver<Arc<EventEnvelope>>>,
    subscription_manager: Arc<SubscriptionManager>,
    worker_handle: Option<JoinHandle<()>>,
    is_running: Arc<AtomicBool>,
    events_dispatched: Arc<AtomicU64>,
    dispatch_errors: Arc<AtomicU64>,
    total_dispatch_time_us: Arc<AtomicU64>,
    max_queue_size: Arc<AtomicU64>,
}

impl RedbDispatcher {
    /// Create a new RedbDispatcher
    pub fn new(
        db: Arc<Database>,
        config: DispatcherConfig,
        subscription_manager: Arc<SubscriptionManager>,
    ) -> Self {
        let (sender, receiver) = mpsc::channel(config.max_queue_size);

        Self {
            db,
            config,
            sender: Some(sender),
            receiver: Some(receiver),
            subscription_manager,
            worker_handle: None,
            is_running: Arc::new(AtomicBool::new(false)),
            events_dispatched: Arc::new(AtomicU64::new(0)),
            dispatch_errors: Arc::new(AtomicU64::new(0)),
            total_dispatch_time_us: Arc::new(AtomicU64::new(0)),
            max_queue_size: Arc::new(AtomicU64::new(0)),
        }
    }

    /// Process events from the channel
    #[allow(clippy::too_many_arguments)]
    async fn process_events(
        db: Arc<Database>,
        mut receiver: mpsc::Receiver<Arc<EventEnvelope>>,
        subscription_manager: Arc<SubscriptionManager>,
        is_running: Arc<AtomicBool>,
        events_dispatched: Arc<AtomicU64>,
        dispatch_errors: Arc<AtomicU64>,
        total_dispatch_time_us: Arc<AtomicU64>,
        config: DispatcherConfig,
    ) {
        info!("Redb dispatcher worker started");

        while let Some(event) = receiver.recv().await {
            if !is_running.load(Ordering::SeqCst) {
                break;
            }

            let start = Instant::now();
            let event_id = event.event_id();
            let event_id_u128 = event_id.as_u128();

            // Check how many subscribers need this event
            let type_id = event.type_id();
            let sub_count = subscription_manager.registry().subscription_count(type_id) as u32;

            if sub_count > 0 {
                // Construct PersistedEnvelope
                let persisted_result = event.into_bytes().map(|payload| PersistedEnvelope {
                    type_name: event.event_type().to_string(),
                    metadata: event.metadata.clone(),
                    priority: event.priority,
                    payload,
                });

                // Serialize and write to redb
                match persisted_result.and_then(|pe| {
                    serde_json::to_vec(&pe)
                        .map_err(|e| crate::Error::SerializationError(e.to_string()))
                }) {
                    Ok(bytes) => {
                        let write_txn_res = tokio::task::spawn_blocking({
                            let db = db.clone();
                            move || -> std::result::Result<(), String> {
                                let write_txn = db.begin_write().map_err(|e| e.to_string())?;
                                {
                                    let mut events = write_txn
                                        .open_table(EVENTS_TABLE)
                                        .map_err(|e| e.to_string())?;
                                    let mut refcounts = write_txn
                                        .open_table(REFCOUNT_TABLE)
                                        .map_err(|e| e.to_string())?;
                                    events
                                        .insert(event_id_u128, bytes.as_slice())
                                        .map_err(|e| e.to_string())?;
                                    refcounts
                                        .insert(event_id_u128, sub_count)
                                        .map_err(|e| e.to_string())?;
                                }
                                write_txn.commit().map_err(|e| e.to_string())
                            }
                        })
                        .await;

                        if let Err(e) = write_txn_res {
                            error!("Failed to persist event to redb: {}", e);
                            dispatch_errors.fetch_add(1, Ordering::Relaxed);
                            continue;
                        }
                    }
                    Err(e) => {
                        error!("Failed to serialize event for persistence: {}", e);
                        dispatch_errors.fetch_add(1, Ordering::Relaxed);
                        continue;
                    }
                }
            }

            // Dispatch to memory channels
            let dispatch_result = if config.processing_timeout_ms > 0 {
                tokio::time::timeout(
                    tokio::time::Duration::from_millis(config.processing_timeout_ms),
                    subscription_manager.dispatch(event.clone()),
                )
                .await
                .unwrap_or_else(|_| {
                    error!("Event dispatch timed out");
                    Err(Error::internal("Dispatch timeout"))
                })
            } else {
                subscription_manager.dispatch(event.clone()).await
            };

            let elapsed_us = start.elapsed().as_micros() as u64;

            match dispatch_result {
                Ok(()) => {
                    events_dispatched.fetch_add(1, Ordering::Relaxed);
                    total_dispatch_time_us.fetch_add(elapsed_us, Ordering::Relaxed);
                }
                Err(e) => {
                    dispatch_errors.fetch_add(1, Ordering::Relaxed);
                    error!(event_id = %event_id, error = %e, "Failed to dispatch event");
                }
            }
        }

        info!("Redb dispatcher worker stopped");
    }
}

#[async_trait]
impl EventDispatcher for RedbDispatcher {
    async fn start(&mut self) -> Result<()> {
        if self.is_running.load(Ordering::SeqCst) {
            return Ok(());
        }

        self.is_running.store(true, Ordering::SeqCst);

        if let Some(receiver) = self.receiver.take() {
            let db = self.db.clone();
            let subscription_manager = self.subscription_manager.clone();
            let is_running = self.is_running.clone();
            let events_dispatched = self.events_dispatched.clone();
            let dispatch_errors = self.dispatch_errors.clone();
            let total_dispatch_time_us = self.total_dispatch_time_us.clone();
            let config = self.config.clone();

            self.worker_handle = Some(tokio::spawn(async move {
                Self::process_events(
                    db,
                    receiver,
                    subscription_manager,
                    is_running,
                    events_dispatched,
                    dispatch_errors,
                    total_dispatch_time_us,
                    config,
                )
                .await;
            }));
        }

        Ok(())
    }

    async fn stop(&mut self) -> Result<()> {
        self.is_running.store(false, Ordering::SeqCst);
        self.sender.take(); // Close channel

        if let Some(handle) = self.worker_handle.take() {
            let _ = tokio::time::timeout(tokio::time::Duration::from_secs(5), handle).await;
        }

        Ok(())
    }

    async fn shutdown_gracefully(&mut self) -> Result<()> {
        info!("Shutting down Redb dispatcher gracefully");

        self.sender.take(); // Close channel so recv() returns None

        if let Some(handle) = self.worker_handle.take() {
            let _ = handle.await.map_err(|e| Error::internal(format!("Worker panicked: {}", e)));
        }

        self.is_running.store(false, Ordering::SeqCst);
        info!("Redb dispatcher graceful shutdown complete");
        Ok(())
    }

    async fn dispatch(&self, envelope: EventEnvelope) -> Result<()> {
        if !self.is_running.load(Ordering::SeqCst) {
            return Err(Error::internal("Dispatcher is not running"));
        }

        let sender = self.sender.as_ref().ok_or_else(|| Error::internal("Dispatcher not initialized"))?;
        let current_size = sender.max_capacity().saturating_sub(sender.capacity());
        let max_size = self.max_queue_size.load(Ordering::Relaxed);
        if current_size as u64 > max_size {
            self.max_queue_size.store(current_size as u64, Ordering::Relaxed);
        }

        if self.config.drop_on_full {
            sender.try_send(Arc::new(envelope)).map_err(|_| Error::internal("Channel full"))
        } else {
            sender.send(Arc::new(envelope)).await.map_err(|_| Error::internal("Channel closed"))
        }
    }

    async fn replay_pending(&self) -> Result<()> {
        let db = self.db.clone();
        let sender = self.sender.clone().ok_or_else(|| Error::internal("Dispatcher not initialized"))?;
        let registry = self.subscription_manager.registry();

        let replay_res =
            tokio::task::spawn_blocking(move || -> std::result::Result<u64, String> {
                let read_txn = db.begin_read().map_err(|e| e.to_string())?;
                let events = match read_txn.open_table(EVENTS_TABLE) {
                    Ok(t) => t,
                    Err(redb::TableError::TableDoesNotExist(_)) => return Ok(0),
                    Err(e) => return Err(e.to_string()),
                };
                let refcounts = match read_txn.open_table(REFCOUNT_TABLE) {
                    Ok(t) => t,
                    Err(redb::TableError::TableDoesNotExist(_)) => return Ok(0),
                    Err(e) => return Err(e.to_string()),
                };

                let mut count = 0;
                for event_entry in events.iter().map_err(|e| e.to_string())? {
                    let (event_id_access, payload_access) =
                        event_entry.map_err(|e| e.to_string())?;
                    let event_id_u128 = event_id_access.value();

                    // Check if it has a positive refcount
                    if let Ok(Some(refcount)) = refcounts.get(event_id_u128) {
                        if refcount.value() > 0 {
                            // Deserialize PersistedEnvelope
                            let bytes = payload_access.value();
                            if let Ok(persisted) =
                                serde_json::from_slice::<PersistedEnvelope>(bytes)
                            {
                                // Find the TypeId
                                if let Some(type_id) = registry.get_type_id(&persisted.type_name) {
                                    // Reconstruct the EventEnvelope
                                    let envelope = EventEnvelope::from_serialized(
                                        type_id,
                                        persisted.type_name,
                                        persisted.metadata,
                                        persisted.priority,
                                        persisted.payload,
                                    );

                                    // Inject it directly into the memory channel
                                    if sender.blocking_send(Arc::new(envelope)).is_ok() {
                                        count += 1;
                                    }
                                }
                            }
                        }
                    }
                }
                Ok(count)
            })
            .await;

        match replay_res {
            Ok(Ok(count)) => {
                if count > 0 {
                    info!("Replayed {} pending events from redb", count);
                }
                Ok(())
            }
            Ok(Err(e)) => {
                error!("Failed to replay events: {}", e);
                Err(Error::internal(format!("Failed to replay events: {}", e)))
            }
            Err(_) => Err(Error::internal("Replay task panicked")),
        }
    }

    fn is_running(&self) -> bool {
        self.is_running.load(Ordering::SeqCst)
    }

    fn stats(&self) -> DispatcherStats {
        let events = self.events_dispatched.load(Ordering::Relaxed);
        let time = self.total_dispatch_time_us.load(Ordering::Relaxed);
        let avg_time = time.checked_div(events).unwrap_or(0);
        let current_queue = self.sender.as_ref().map(|s| s.max_capacity() - s.capacity()).unwrap_or(0);

        DispatcherStats {
            events_dispatched: events,
            queue_size: current_queue,
            dispatch_errors: self.dispatch_errors.load(Ordering::Relaxed),
            avg_dispatch_time_us: avg_time,
            max_queue_size: self.max_queue_size.load(Ordering::Relaxed) as usize,
        }
    }
}