Skip to main content

reifydb_core/event/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// Copyright (c) 2026 ReifyDB
3
4use std::{
5	any::{Any, TypeId, type_name},
6	collections::HashMap,
7	sync,
8	sync::Arc,
9};
10
11use reifydb_runtime::actor::{
12	context::Context,
13	mailbox::ActorRef,
14	system::ActorSpawner,
15	traits::{Actor, Directive},
16};
17use sync::mpsc::Sender;
18
19pub mod lifecycle;
20pub mod operator;
21#[macro_use]
22pub mod r#macro;
23pub mod metric;
24pub mod procedure;
25pub mod row;
26pub mod store;
27pub mod transaction;
28
29type EventListenerInstaller = Box<dyn FnOnce(&mut HashMap<TypeId, Box<dyn EventListenerList>>) + Send>;
30
31pub trait Event: Any + Send + Sync + Clone + 'static {
32	fn as_any(&self) -> &dyn Any;
33	fn into_any(self) -> Box<dyn Any + Send>;
34}
35
36pub trait EventListener<E>: Send + Sync + 'static
37where
38	E: Event,
39{
40	fn on(&self, event: &E);
41}
42
43trait EventListenerList: Any + Send + Sync {
44	fn on_any(&self, event: Box<dyn Any + Send>);
45	fn as_any_mut(&mut self) -> &mut dyn Any;
46}
47
48struct EventListenerListImpl<E> {
49	listeners: Vec<Arc<dyn EventListener<E>>>,
50}
51
52impl<E> EventListenerListImpl<E>
53where
54	E: Event,
55{
56	fn new() -> Self {
57		Self {
58			listeners: Vec::new(),
59		}
60	}
61
62	fn add(&mut self, listener: Arc<dyn EventListener<E>>) {
63		self.listeners.push(listener);
64	}
65}
66
67impl<E> EventListenerList for EventListenerListImpl<E>
68where
69	E: Event,
70{
71	fn on_any(&self, event: Box<dyn Any + Send>) {
72		if let Ok(event) = event.downcast::<E>() {
73			for listener in &self.listeners {
74				listener.on(&*event);
75			}
76		}
77	}
78
79	fn as_any_mut(&mut self) -> &mut dyn Any {
80		self
81	}
82}
83
84struct EventEnvelope {
85	type_id: TypeId,
86	event: Box<dyn Any + Send>,
87}
88
89enum EventBusMessage {
90	Emit(EventEnvelope),
91	Register {
92		installer: EventListenerInstaller,
93	},
94	WaitForCompletion(Sender<()>),
95}
96
97struct EventBusActor;
98
99impl Actor for EventBusActor {
100	type State = HashMap<TypeId, Box<dyn EventListenerList>>;
101	type Message = EventBusMessage;
102
103	fn init(&self, _ctx: &Context<Self::Message>) -> Self::State {
104		HashMap::new()
105	}
106
107	fn handle(&self, state: &mut Self::State, msg: Self::Message, _ctx: &Context<Self::Message>) -> Directive {
108		match msg {
109			EventBusMessage::Emit(envelope) => {
110				if let Some(list) = state.get(&envelope.type_id) {
111					list.on_any(envelope.event);
112				}
113			}
114			EventBusMessage::Register {
115				installer,
116			} => {
117				installer(state);
118			}
119			EventBusMessage::WaitForCompletion(tx) => {
120				let _ = tx.send(());
121			}
122		}
123		Directive::Continue
124	}
125}
126
127#[derive(Clone)]
128pub struct EventBus {
129	actor_ref: ActorRef<EventBusMessage>,
130	spawner: ActorSpawner,
131}
132
133impl EventBus {
134	pub fn new(spawner: &ActorSpawner) -> Self {
135		let handle = spawner.spawn_coordination("event-bus", EventBusActor);
136		Self {
137			actor_ref: handle.actor_ref().clone(),
138			spawner: spawner.clone(),
139		}
140	}
141
142	pub fn register<E, L>(&self, listener: L)
143	where
144		E: Event,
145		L: EventListener<E>,
146	{
147		let type_id = TypeId::of::<E>();
148		let listener = Arc::new(listener);
149
150		let installer: EventListenerInstaller = Box::new(move |map| {
151			let list = map.entry(type_id).or_insert_with(|| Box::new(EventListenerListImpl::<E>::new()));
152			list.as_any_mut().downcast_mut::<EventListenerListImpl<E>>().unwrap().add(listener);
153		});
154
155		if self.actor_ref
156			.send(EventBusMessage::Register {
157				installer,
158			})
159			.is_err()
160		{
161			let shutting_down = self.spawner.cancellation_token().is_none_or(|token| token.is_cancelled());
162			assert!(
163				shutting_down,
164				"the event bus rejected a listener for {} while the system was running; the \
165				 listener would never install and every later event of this type is lost silently",
166				type_name::<E>()
167			);
168		}
169	}
170
171	pub fn emit<E>(&self, event: E)
172	where
173		E: Event,
174	{
175		let type_id = TypeId::of::<E>();
176		if self.actor_ref
177			.send(EventBusMessage::Emit(EventEnvelope {
178				type_id,
179				event: event.into_any(),
180			}))
181			.is_err()
182		{
183			let shutting_down = self.spawner.cancellation_token().is_none_or(|token| token.is_cancelled());
184			assert!(
185				shutting_down,
186				"the event bus rejected a {} while the system was running; dropping it silently \
187				 loses a post-commit update no subscriber will ever see",
188				type_name::<E>()
189			);
190		}
191	}
192
193	pub fn wait_for_completion(&self) {
194		let (tx, rx) = sync::mpsc::channel();
195		let _ = self.actor_ref.send(EventBusMessage::WaitForCompletion(tx));
196		let _ = rx.recv();
197	}
198}
199
200#[cfg(test)]
201pub mod tests {
202	use std::{
203		sync::{Arc, Mutex},
204		thread,
205	};
206
207	use reifydb_runtime::{
208		actor::system::ActorSystem,
209		context::clock::Clock,
210		pool::{PoolConfig, Pools},
211	};
212
213	use crate::event::{Event, EventBus, EventListener};
214
215	fn test_actor_system() -> ActorSystem {
216		let pools = Pools::new(PoolConfig::default());
217		ActorSystem::new(pools, Clock::Real)
218	}
219
220	define_event! {
221		pub struct TestEvent{}
222	}
223
224	define_event! {
225		pub struct AnotherEvent{}
226	}
227
228	#[derive(Default, Debug, Clone)]
229	pub struct TestEventListener(Arc<TestHandlerInner>);
230
231	#[derive(Default, Debug)]
232	pub struct TestHandlerInner {
233		pub counter: Arc<Mutex<i32>>,
234	}
235
236	impl EventListener<TestEvent> for TestEventListener {
237		fn on(&self, _event: &TestEvent) {
238			let mut x = self.0.counter.lock().unwrap();
239			*x += 1;
240		}
241	}
242
243	impl EventListener<AnotherEvent> for TestEventListener {
244		fn on(&self, _event: &AnotherEvent) {
245			let mut x = self.0.counter.lock().unwrap();
246			*x *= 2;
247		}
248	}
249
250	#[test]
251	fn test_event_bus_new() {
252		let actor_system = test_actor_system();
253		let event_bus = EventBus::new(&actor_system.spawner());
254		event_bus.emit(TestEvent::new());
255		event_bus.wait_for_completion();
256	}
257
258	#[test]
259	fn test_register_single_listener() {
260		let actor_system = test_actor_system();
261		let event_bus = EventBus::new(&actor_system.spawner());
262		let listener = TestEventListener::default();
263
264		event_bus.register::<TestEvent, TestEventListener>(listener.clone());
265		event_bus.emit(TestEvent::new());
266		event_bus.wait_for_completion();
267		assert_eq!(*listener.0.counter.lock().unwrap(), 1);
268	}
269
270	#[test]
271	fn test_emit_unregistered_event() {
272		let actor_system = test_actor_system();
273		let event_bus = EventBus::new(&actor_system.spawner());
274		event_bus.emit(TestEvent::new());
275		event_bus.wait_for_completion();
276	}
277
278	#[test]
279	fn test_multiple_listeners_same_event() {
280		let actor_system = test_actor_system();
281		let event_bus = EventBus::new(&actor_system.spawner());
282		let listener1 = TestEventListener::default();
283		let listener2 = TestEventListener::default();
284
285		event_bus.register::<TestEvent, TestEventListener>(listener1.clone());
286		event_bus.register::<TestEvent, TestEventListener>(listener2.clone());
287
288		event_bus.emit(TestEvent::new());
289		event_bus.wait_for_completion();
290		assert_eq!(*listener1.0.counter.lock().unwrap(), 1);
291		assert_eq!(*listener2.0.counter.lock().unwrap(), 1);
292	}
293
294	#[test]
295	fn test_event_bus_clone() {
296		let actor_system = test_actor_system();
297		let event_bus1 = EventBus::new(&actor_system.spawner());
298		let listener = TestEventListener::default();
299		event_bus1.register::<TestEvent, TestEventListener>(listener.clone());
300
301		let event_bus2 = event_bus1.clone();
302		event_bus2.emit(TestEvent::new());
303		event_bus2.wait_for_completion();
304		assert_eq!(*listener.0.counter.lock().unwrap(), 1);
305	}
306
307	#[test]
308	fn test_concurrent_registration() {
309		let actor_system = test_actor_system();
310		let event_bus = Arc::new(EventBus::new(&actor_system.spawner()));
311		let mut handles = Vec::new();
312
313		for _ in 0..10 {
314			let event_bus = event_bus.clone();
315			handles.push(thread::spawn(move || {
316				let listener = TestEventListener::default();
317				event_bus.register::<TestEvent, TestEventListener>(listener);
318			}));
319		}
320
321		for handle in handles {
322			handle.join().unwrap();
323		}
324
325		event_bus.emit(TestEvent::new());
326		event_bus.wait_for_completion();
327	}
328
329	#[test]
330	fn test_concurrent_emitting() {
331		let actor_system = test_actor_system();
332		let event_bus = Arc::new(EventBus::new(&actor_system.spawner()));
333		let listener = TestEventListener::default();
334		event_bus.register::<TestEvent, TestEventListener>(listener.clone());
335		event_bus.wait_for_completion();
336
337		let mut handles = Vec::new();
338
339		for _ in 0..10 {
340			let event_bus = event_bus.clone();
341			handles.push(thread::spawn(move || {
342				event_bus.emit(TestEvent::new());
343			}));
344		}
345
346		for handle in handles {
347			handle.join().unwrap();
348		}
349
350		event_bus.wait_for_completion();
351		assert_eq!(*listener.0.counter.lock().unwrap(), 10);
352	}
353
354	define_event! {
355		pub struct MacroTestEvent {
356			pub value: i32,
357		}
358	}
359
360	#[test]
361	fn testine_event_macro() {
362		let event = MacroTestEvent::new(42);
363		let any_ref = event.as_any();
364		assert!(any_ref.downcast_ref::<MacroTestEvent>().is_some());
365		assert_eq!(any_ref.downcast_ref::<MacroTestEvent>().unwrap().value(), &42);
366	}
367
368	#[test]
369	fn test_multi_event_listener() {
370		let actor_system = test_actor_system();
371		let event_bus = EventBus::new(&actor_system.spawner());
372		let listener = TestEventListener::default();
373
374		event_bus.register::<TestEvent, TestEventListener>(listener.clone());
375		event_bus.register::<AnotherEvent, TestEventListener>(listener.clone());
376
377		// Each event type triggers only its own listeners
378		event_bus.emit(TestEvent::new());
379		event_bus.wait_for_completion();
380		assert_eq!(*listener.0.counter.lock().unwrap(), 1);
381
382		event_bus.emit(TestEvent::new());
383		event_bus.wait_for_completion();
384		assert_eq!(*listener.0.counter.lock().unwrap(), 2);
385
386		event_bus.emit(AnotherEvent::new());
387		event_bus.wait_for_completion();
388		assert_eq!(*listener.0.counter.lock().unwrap(), 4); // 2 * 2
389	}
390}