bevy_event_bus 0.2.0

A Bevy plugin that connects Bevy's event system to external message brokers like Kafka
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
use bevy::prelude::*;

use crate::{
    backends::{EventBusBackend, EventBusBackendResource},
    decoder::DecoderRegistry,
    registration::EVENT_REGISTRY,
    resources::{
        ConsumerMetrics, DecodedEventBuffer, DrainMetricsEvent, DrainedTopicMetadata, EventBusConsumerConfig, EventMetadata,
        MessageQueue, ProcessedMessage, TopicDecodedEvents,
    },
    runtime::{block_on, ensure_runtime},
    writers::event_bus_writer::EventBusErrorQueue,
};

/// Pre-configured topics resource inserted at plugin construction.
#[derive(Resource, Debug, Clone)]
pub struct PreconfiguredTopics(pub Vec<String>);
impl PreconfiguredTopics {
    pub fn new<I: Into<String>, T: IntoIterator<Item = I>>(iter: T) -> Self {
        Self(iter.into_iter().map(Into::into).collect())
    }
}

/// Plugin for integrating with external event brokers
pub struct EventBusPlugin;

impl Plugin for EventBusPlugin {
    fn build(&self, app: &mut App) {
        // Register core error events
        app.add_event::<crate::EventBusDecodeError>();
        
        // Invoke registration callbacks (derive macro populated). We DO NOT drain so multiple Apps each see events.
        let guard = EVENT_REGISTRY.lock().unwrap();
        for cb in guard.iter() {
            cb(app);
        }
    }
}

/// Plugin bundle that configures everything needed for the event bus
pub struct EventBusPlugins<B: EventBusBackend>(pub B, pub PreconfiguredTopics);

// -----------------------------------------------------------------------------
// Backend lifecycle events
// -----------------------------------------------------------------------------
#[derive(Event, Debug, Clone)]
pub struct BackendReadyEvent {
    pub backend: String,
    pub topics: Vec<String>,
}

#[derive(Event, Debug, Clone)]
pub struct BackendDownEvent {
    pub backend: String,
    pub reason: String,
}

#[derive(Debug)]
enum LifecycleMessage {
    Ready {
        backend: String,
        topics: Vec<String>,
    },
}

#[derive(Resource)]
struct BackendLifecycleChannel(crossbeam_channel::Receiver<LifecycleMessage>);

// Resource tracking backend readiness state
#[derive(Resource, Debug, Clone, Copy)]
pub struct BackendStatus {
    pub ready: bool,
}

impl<B: EventBusBackend> Plugin for EventBusPlugins<B> {
    fn build(&self, app: &mut App) {
        // Add the core plugin and ensure runtime exists
        app.add_plugins(EventBusPlugin);
        ensure_runtime(app);

        // Create and add the backend as a resource
        let boxed = self.0.clone_box();
        app.insert_resource(EventBusBackendResource::from_box(boxed));
        app.insert_resource(self.1.clone());
        app.insert_resource(EventBusErrorQueue::default());
        // Pre-create topics and subscribe BEFORE connecting so background consumer starts with full assignment.
        if let Some(pre) = app.world().get_resource::<PreconfiguredTopics>().cloned() {
            if let Some(backend_res) = app
                .world()
                .get_resource::<EventBusBackendResource>()
                .cloned()
            {
                let mut guard = backend_res.write();
                if let Some(kafka) = guard
                    .as_any_mut()
                    .downcast_mut::<crate::backends::kafka_backend::KafkaEventBusBackend>(
                ) {
                    use rdkafka::admin::{AdminClient, AdminOptions, NewTopic, TopicReplication};
                    use rdkafka::client::DefaultClientContext;
                    use rdkafka::config::ClientConfig;
                    let mut cfg = ClientConfig::new();
                    cfg.set("bootstrap.servers", kafka.bootstrap_servers());
                    if let Ok(admin) = cfg.create::<AdminClient<DefaultClientContext>>() {
                        let opts = AdminOptions::new();
                        let topics: Vec<NewTopic> = pre
                            .0
                            .iter()
                            .map(|t| NewTopic::new(t, 1, TopicReplication::Fixed(1)))
                            .collect();
                        if let Err(e) =
                            block_on(admin.create_topics(topics.iter().collect::<Vec<_>>(), &opts))
                        {
                            let msg = e.to_string();
                            if !msg.contains("TopicAlreadyExists") {
                                tracing::warn!(error=%msg, "Topic creation batch failed");
                            }
                        }
                    }
                }
                for topic in pre.0.iter() {
                    if !block_on(guard.subscribe(topic)) {
                        tracing::warn!(topic = %topic, "Failed to pre-subscribe to topic");
                    }
                }
            }
        }
        // Now connect (spawns background task with existing subscriptions) and capture receiver.
        if let Some(backend_res) = app
            .world()
            .get_resource::<EventBusBackendResource>()
            .cloned()
        {
            let mut guard = backend_res.write();
            let _ = block_on(guard.connect());
            
            if let Some(kafka) = guard
                .as_any_mut()
                .downcast_mut::<crate::backends::kafka_backend::KafkaEventBusBackend>(
            ) {
                if let Some(rx) = kafka.take_receiver() {
                    app.world_mut()
                        .insert_resource(MessageQueue { receiver: rx });
                }
                
                // Inject lifecycle sender into kafka backend by wrapping its background task via a helper channel
                // (Since backend code owns spawning, we detect readiness here: receiver presence == ready)
                let (tx, rx_life) = crossbeam_channel::unbounded::<LifecycleMessage>();
                // Send Ready event now with current subscriptions
                let subs = kafka.current_subscriptions();
                let _ = tx.send(LifecycleMessage::Ready {
                    backend: "kafka".into(),
                    topics: subs,
                });
                app.world_mut()
                    .insert_resource(BackendLifecycleChannel(rx_life));
                app.world_mut()
                    .insert_resource(BackendStatus { ready: false });
                // We cannot directly hook errors here; leave placeholder (Down events emitted by future backend error hook TBD)
            }
        }

        // Initialize background consumer related resources if not present
        app.init_resource::<DrainedTopicMetadata>();
        app.init_resource::<DecodedEventBuffer>();
        app.init_resource::<DecoderRegistry>();
        app.init_resource::<ConsumerMetrics>();
        app.init_resource::<EventBusConsumerConfig>();
        app.add_event::<DrainMetricsEvent>();
        app.add_event::<BackendReadyEvent>();
        // MessageQueue will be inserted lazily once backend spawns sender & channel

        // Drain system with multi-decoder pipeline
        fn drain_system(
            mut commands: Commands,
            backend: Option<Res<EventBusBackendResource>>,
            mut metadata_buffers: ResMut<DrainedTopicMetadata>,
            mut decoded_buffer: ResMut<DecodedEventBuffer>,
            mut decoder_registry: ResMut<DecoderRegistry>,
            mut metrics: ResMut<ConsumerMetrics>,
            config: Res<EventBusConsumerConfig>,
            maybe_queue: Option<Res<MessageQueue>>,
            mut drain_events: EventWriter<DrainMetricsEvent>,
        ) {
            let frame_start = std::time::Instant::now();
            metrics.drained_last_frame = 0;
            // Default queue length metrics when no queue
            metrics.queue_len_start = 0;
            metrics.queue_len_end = 0;
            
            if let Some(queue) = maybe_queue {
                metrics.queue_len_start = queue.receiver.len();
                let limit = config.max_events_per_frame;
                let time_budget = config
                    .max_drain_millis
                    .map(std::time::Duration::from_millis);
                
                // Drain loop with multi-decoder pipeline
                while limit
                    .map(|l| metrics.drained_last_frame < l)
                    .unwrap_or(true)
                {
                    if let Some(budget) = time_budget {
                        if frame_start.elapsed() >= budget {
                            break;
                        }
                        // For extremely tiny budgets (<1ms) avoid looping excessively once something drained.
                        if budget <= std::time::Duration::from_millis(1)
                            && metrics.drained_last_frame > 0
                        {
                            break;
                        }
                    }
                    
                    match queue.receiver.try_recv() {
                        Ok(msg) => {
                            let topic_name = msg.topic.clone();
                            tracing::debug!(topic=%topic_name, "Processing message with multi-decoder pipeline");
                            
                            // Create metadata for this message
                            let metadata = EventMetadata {
                                topic: msg.topic.clone(),
                                partition: msg.partition,
                                offset: msg.offset,
                                timestamp: msg.timestamp,
                                headers: msg.headers.clone(),
                                key: msg.key.clone(),
                            };
                            
                            // Attempt multi-decode using registered decoders
                            let decoded_events = decoder_registry.decode_all(&topic_name, &msg.payload);
                            
                            // Get or create topic buffer
                            let topic_buffer = decoded_buffer.topics.entry(topic_name.clone()).or_insert_with(TopicDecodedEvents::new);
                            topic_buffer.total_processed += 1;
                            
                            if decoded_events.is_empty() {
                                // No decoder succeeded - fire decode error event
                                topic_buffer.decode_failures += 1;
                                tracing::debug!(
                                    topic = %topic_name,
                                    decoders_tried = decoder_registry.decoder_count(&topic_name),
                                    "No decoder succeeded for message"
                                );
                                
                                // Generate decode error event
                                let decode_error = crate::EventBusDecodeError::new(
                                    topic_name.clone(),
                                    format!("No decoder succeeded. Tried {} decoders", decoder_registry.decoder_count(&topic_name)),
                                    msg.payload.clone(),
                                    format!("tried_{}_decoders", decoder_registry.decoder_count(&topic_name)),
                                    Some(metadata.partition),
                                    Some(metadata.offset),
                                );
                                
                                // Store decode error for event dispatch 
                                metadata_buffers
                                    .decode_errors
                                    .push(decode_error);
                            } else {
                                // At least one decoder succeeded
                                for decoded_event in decoded_events {
                                    tracing::trace!(
                                        topic = %topic_name,
                                        decoder = %decoded_event.decoder_name,
                                        "Successfully decoded event"
                                    );
                                    
                                    // Store the decoded event in the type-erased buffer
                                    // The event Box contains the actual event, we need to store it properly
                                    let type_erased = crate::resources::TypeErasedEvent {
                                        event: decoded_event.event,
                                        metadata: metadata.clone(),
                                        decoder_name: decoded_event.decoder_name,
                                    };
                                    
                                    topic_buffer.events_by_type
                                        .entry(decoded_event.type_id)
                                        .or_insert_with(Vec::new)
                                        .push(type_erased);
                                }
                                
                                // Also add the original message to DrainedTopicMetadata for EventBusReader compatibility
                                // This allows existing EventBusReader<T> to find the events by deserializing the original payload
                                let processed_msg = ProcessedMessage {
                                    payload: msg.payload.clone(),
                                    metadata: metadata.clone(),
                                };
                                
                                metadata_buffers
                                    .topics
                                    .entry(topic_name.clone())
                                    .or_insert_with(Vec::new)
                                    .push(processed_msg);
                            }
                            
                            metrics.drained_last_frame += 1;
                        }
                        Err(crossbeam_channel::TryRecvError::Empty) => break,
                        Err(crossbeam_channel::TryRecvError::Disconnected) => break,
                    }
                }
                
                metrics.remaining_channel_after_drain = queue.receiver.len();
                metrics.queue_len_end = metrics.remaining_channel_after_drain;
                metrics.total_drained += metrics.drained_last_frame;
            } else if let Some(backend_res) = backend {
                let mut guard = backend_res.write();
                if let Some(kafka) = guard
                    .as_any_mut()
                    .downcast_mut::<crate::backends::kafka_backend::KafkaEventBusBackend>(
                ) {
                    let dropped = kafka.dropped_count();
                    metrics.dropped_messages = dropped;
                    if let Some(rx) = kafka.take_receiver() {
                        // Insert queue so next frame we can drain
                        commands.insert_resource(MessageQueue { receiver: rx });
                    }
                }
            }
            
            // Count idle frame if nothing drained
            if metrics.drained_last_frame == 0 {
                metrics.idle_frames += 1;
            }
            
            // Periodic cleanup of empty topic buffers
            if metrics.idle_frames % 30 == 0 && metrics.idle_frames > 0 {
                let before_count = metadata_buffers.topics.len();
                metadata_buffers.topics.retain(|_topic, buffer| !buffer.is_empty());
                let after_count = metadata_buffers.topics.len();
                
                if before_count > after_count {
                    tracing::debug!(
                        cleaned_topics = before_count - after_count,
                        remaining_topics = after_count,
                        "Cleaned up empty topic metadata buffers"
                    );
                }
                
                // Also clean up decoded event buffers
                let before_decoded = decoded_buffer.topics.len();
                decoded_buffer.topics.retain(|_topic, buffer| buffer.total_events() > 0);
                let after_decoded = decoded_buffer.topics.len();
                
                if before_decoded > after_decoded {
                    tracing::debug!(
                        cleaned_decoded_topics = before_decoded - after_decoded,
                        remaining_decoded_topics = after_decoded,
                        "Cleaned up empty decoded event buffers"
                    );
                }
            }
            
            metrics.drain_duration_us = frame_start.elapsed().as_micros();
            if metrics.drain_duration_us == 0
                && (metrics.drained_last_frame > 0 || metrics.queue_len_start > 0)
            {
                metrics.drain_duration_us = 1; // avoid zero-duration flake
            }
            
            // Emit metrics snapshot every frame for observability
            drain_events.write(DrainMetricsEvent {
                drained: metrics.drained_last_frame,
                remaining: metrics.remaining_channel_after_drain,
                total_drained: metrics.total_drained,
                dropped: metrics.dropped_messages,
                drain_duration_us: metrics.drain_duration_us,
            });
        }
        app.add_systems(PreUpdate, drain_system);
        app.add_systems(PreUpdate, decode_error_dispatch_system.after(drain_system));

        // Error queue flush system - runs in PostUpdate to ensure all EventBusWriter operations complete first
        fn error_queue_flush_system(world: &mut World) {
            // Extract the pending errors first
            let pending_errors = {
                let error_queue = world.resource::<EventBusErrorQueue>();
                error_queue.drain_pending()
            };
            
            // Then flush them
            for error_fn in pending_errors {
                error_fn(world);
            }
        }
        app.add_systems(PostUpdate, error_queue_flush_system);

        // Producer progress now handled entirely by backend background task; sender_system removed since sends are now direct.

        // Lifecycle drain system converts internal channel messages to Bevy events
        fn lifecycle_system(
            maybe_channel: Option<Res<BackendLifecycleChannel>>,
            mut ready_writer: EventWriter<BackendReadyEvent>,
        ) {
            if let Some(ch) = maybe_channel {
                while let Ok(msg) = ch.0.try_recv() {
                    match msg {
                        LifecycleMessage::Ready { backend, topics } => {
                            ready_writer.write(BackendReadyEvent {
                                backend: backend.clone(),
                                topics: topics.clone(),
                            });
                        }
                    }
                }
            }
        }
        app.add_systems(PreUpdate, lifecycle_system);

        // System to update BackendStatus from events
        fn backend_status_update(
            status: Option<ResMut<BackendStatus>>,
            mut ready_events: EventReader<BackendReadyEvent>,
        ) {
            if let Some(mut s) = status {
                for _ev in ready_events.read() {
                    s.ready = true;
                }
            }
        }
        app.add_systems(PreUpdate, backend_status_update);

        // Decode error dispatch system - sends EventBusDecodeError events
        fn decode_error_dispatch_system(
            mut drained_metadata: ResMut<DrainedTopicMetadata>,
            mut decode_error_writer: EventWriter<crate::EventBusDecodeError>,
        ) {
            // Dispatch all accumulated decode errors as events
            for decode_error in drained_metadata.decode_errors.drain(..) {
                decode_error_writer.write(decode_error);
            }
        }
    }
}