issun 0.10.0

A mini game engine for logic-focused games - Build games in ISSUN (一寸) of time
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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
//! Type-erased, buffered event bus for decoupled communication between systems.
//!
//! Events are double buffered per type: events published during frame `N` are
//! consumed in frame `N + 1` after the runner calls [`EventBus::dispatch`].

use std::any::{Any, TypeId};
use std::collections::HashMap;

#[cfg(feature = "network")]
use crate::network::{NetworkMetadata, NetworkScope};

/// Marker trait for types that can flow through the [`EventBus`].
///
/// Events must be cloneable and thread-safe because they are buffered and may
/// be read from multiple systems during a frame.
pub trait Event: Clone + Send + Sync + 'static {
    /// Check if this event should be transmitted over network
    #[cfg(feature = "network")]
    fn is_networked() -> bool {
        false
    }

    /// Get the network scope for this event
    #[cfg(feature = "network")]
    fn network_scope() -> NetworkScope {
        NetworkScope::default()
    }
}

/// Event bus stored inside [`ResourceContext`](crate::context::ResourceContext).
///
/// Each event type has its own [`EventChannel`] that double-buffers events so
/// publishers and subscribers do not contend within the same frame.
pub struct EventBus {
    channels: HashMap<TypeId, Box<dyn EventChannelStorage>>,

    #[cfg(feature = "network")]
    network: Option<NetworkState>,

    // Optional tracer for debugging event chains
    tracer: Option<std::sync::Arc<std::sync::Mutex<crate::trace::EventChainTracer>>>,

    // Optional recorder for event replay
    recorder: Option<std::sync::Arc<std::sync::Mutex<crate::replay::EventRecorder>>>,

    current_frame: u64,
}

#[cfg(feature = "network")]
struct NetworkState {
    backend: std::sync::Arc<dyn crate::network::NetworkBackend>,
    tx: tokio::sync::mpsc::Sender<NetworkTask>,
    rx: std::sync::Arc<
        std::sync::Mutex<tokio::sync::mpsc::Receiver<crate::network::backend::RawNetworkEvent>>,
    >,
    sequence: std::sync::atomic::AtomicU64,
    current_metadata: Option<NetworkMetadata>,
    deserializers: HashMap<String, Box<dyn EventDeserializer>>,
}

#[cfg(feature = "network")]
#[allow(dead_code)]
enum NetworkTask {
    Send(Vec<u8>), // Serialized RawNetworkEvent
    Shutdown,
}

#[cfg(feature = "network")]
trait EventDeserializer: Send + Sync {
    fn deserialize_and_push(
        &self,
        payload: &[u8],
        channels: &mut HashMap<TypeId, Box<dyn EventChannelStorage>>,
    );
}

#[cfg(feature = "network")]
struct TypedEventDeserializer<E: Event + serde::de::DeserializeOwned> {
    _phantom: std::marker::PhantomData<E>,
}

#[cfg(feature = "network")]
impl<E: Event + serde::de::DeserializeOwned> TypedEventDeserializer<E> {
    fn new() -> Self {
        Self {
            _phantom: std::marker::PhantomData,
        }
    }
}

#[cfg(feature = "network")]
impl<E: Event + serde::de::DeserializeOwned> EventDeserializer for TypedEventDeserializer<E> {
    fn deserialize_and_push(
        &self,
        payload: &[u8],
        channels: &mut HashMap<TypeId, Box<dyn EventChannelStorage>>,
    ) {
        if let Ok(event) = bincode::deserialize::<E>(payload) {
            let entry = channels
                .entry(TypeId::of::<E>())
                .or_insert_with(|| Box::new(EventChannel::<E>::new()));

            if let Some(channel) = entry.as_any_mut().downcast_mut::<EventChannel<E>>() {
                channel.push(event);
            }
        }
    }
}

impl Default for EventBus {
    fn default() -> Self {
        Self::new()
    }
}

impl EventBus {
    /// Creates an empty event bus.
    pub fn new() -> Self {
        Self {
            channels: HashMap::new(),
            #[cfg(feature = "network")]
            network: None,
            tracer: None,
            recorder: None,
            current_frame: 0,
        }
    }

    /// Set a tracer for debugging event chains
    pub fn set_tracer(
        &mut self,
        tracer: std::sync::Arc<std::sync::Mutex<crate::trace::EventChainTracer>>,
    ) {
        self.tracer = Some(tracer);
    }

    /// Clear the tracer
    pub fn clear_tracer(&mut self) {
        self.tracer = None;
    }

    /// Set a recorder for event replay
    pub fn set_recorder(
        &mut self,
        recorder: std::sync::Arc<std::sync::Mutex<crate::replay::EventRecorder>>,
    ) {
        self.recorder = Some(recorder);
    }

    /// Clear the recorder
    pub fn clear_recorder(&mut self) {
        self.recorder = None;
    }

    /// Set the current frame number for tracing and recording
    pub fn set_frame(&mut self, frame: u64) {
        self.current_frame = frame;

        // Update tracer
        if let Some(ref tracer) = self.tracer {
            if let Ok(mut t) = tracer.lock() {
                t.set_frame(frame);
            }
        }

        // Update recorder
        if let Some(ref recorder) = self.recorder {
            if let Ok(mut r) = recorder.lock() {
                r.set_frame(frame);
            }
        }
    }

    /// Get the current frame number
    pub fn current_frame(&self) -> u64 {
        self.current_frame
    }

    /// Publishes a new event.
    ///
    /// Events are queued for the next frame and become visible after
    /// [`EventBus::dispatch`] runs.
    ///
    /// If the event is marked as networked and network is enabled, the event
    /// will also be transmitted to remote nodes.
    pub fn publish<E>(&mut self, event: E)
    where
        E: Event + serde::Serialize,
    {
        // Trace event publication
        if let Some(ref tracer) = self.tracer {
            if let Ok(mut t) = tracer.lock() {
                t.record_simple(
                    crate::trace::TraceEntryType::EventPublished {
                        event_type: std::any::type_name::<E>().to_string(),
                        event_id: format!("{}@{}", std::any::type_name::<E>(), self.current_frame),
                    },
                    "EventBus",
                );
            }
        }

        // Record event for replay
        if let Some(ref recorder) = self.recorder {
            if let Ok(mut r) = recorder.lock() {
                r.record(&event);
            }
        }

        // Always perform local dispatch
        let channel = self.channel_mut::<E>();
        channel.push(event.clone());

        // If networked, send to network backend
        #[cfg(feature = "network")]
        if E::is_networked() {
            if let Some(ref mut net) = self.network {
                let sequence = net
                    .sequence
                    .fetch_add(1, std::sync::atomic::Ordering::SeqCst);

                let metadata = NetworkMetadata::new(net.backend.node_id(), sequence);
                let scope = E::network_scope();

                // Create RawNetworkEvent
                let raw_event = crate::network::backend::RawNetworkEvent {
                    metadata,
                    scope,
                    type_name: std::any::type_name::<E>().to_string(),
                    payload: bincode::serialize(&event).unwrap_or_default(),
                };

                // Queue for async send
                if let Ok(serialized) = bincode::serialize(&raw_event) {
                    let _ = net.tx.try_send(NetworkTask::Send(serialized));
                }
            }
        }
    }

    /// Returns a reader over events of type `E` from the previous frame.
    ///
    /// Readers borrow the bus immutably for the lifetime of the reader to
    /// prevent the channel from being mutated while iterating.
    pub fn reader<E>(&mut self) -> EventReader<'_, E>
    where
        E: Event,
    {
        let channel = self.channel_mut::<E>();
        EventReader {
            events: channel.read(),
            cursor: 0,
        }
    }

    /// Advances all event channels by swapping their buffers.
    ///
    /// This should be invoked once per frame (typically by the runner). After
    /// dispatching, events published this frame become visible in the next one.
    pub fn dispatch(&mut self) {
        for channel in self.channels.values_mut() {
            channel.swap_buffers();
        }
    }

    fn channel_mut<E>(&mut self) -> &mut EventChannel<E>
    where
        E: Event,
    {
        let entry = self
            .channels
            .entry(TypeId::of::<E>())
            .or_insert_with(|| Box::new(EventChannel::<E>::new()));

        entry
            .as_any_mut()
            .downcast_mut::<EventChannel<E>>()
            .expect("Stored channel type mismatch")
    }

    /// Enable network support (network feature only)
    #[cfg(feature = "network")]
    pub fn with_network(mut self, backend: impl crate::network::NetworkBackend) -> Self {
        use std::sync::{Arc, Mutex};
        use tokio::sync::mpsc;

        let backend = Arc::new(backend);
        let (tx, send_rx) = mpsc::channel(1000);

        // Get receive stream from backend
        let recv_rx = backend.receive_stream();
        let recv_rx = Arc::new(Mutex::new(recv_rx));

        // Spawn background worker for sending events
        let backend_clone = backend.clone();
        tokio::spawn(async move {
            network_send_worker(send_rx, backend_clone).await;
        });

        self.network = Some(NetworkState {
            backend,
            tx,
            rx: recv_rx,
            sequence: std::sync::atomic::AtomicU64::new(0),
            current_metadata: None,
            deserializers: HashMap::new(),
        });

        self
    }

    /// Get metadata of the currently processing networked event
    #[cfg(feature = "network")]
    pub fn current_metadata(&self) -> Option<&NetworkMetadata> {
        self.network
            .as_ref()
            .and_then(|n| n.current_metadata.as_ref())
    }

    /// Check if network is enabled
    #[cfg(feature = "network")]
    pub fn is_networked(&self) -> bool {
        self.network.is_some()
    }

    /// Register an event type for network deserialization
    #[cfg(feature = "network")]
    pub fn register_networked_event<E>(&mut self)
    where
        E: Event + serde::de::DeserializeOwned + 'static,
    {
        if let Some(ref mut net) = self.network {
            let type_name = std::any::type_name::<E>().to_string();
            net.deserializers
                .insert(type_name, Box::new(TypedEventDeserializer::<E>::new()));
        }
    }

    /// Poll and process incoming network events
    #[cfg(feature = "network")]
    pub fn poll_network(&mut self) {
        use crate::network::backend::RawNetworkEvent;

        // Collect events first to avoid holding mutable borrows
        let events: Vec<RawNetworkEvent> = if let Some(ref net) = self.network {
            let rx = net.rx.clone();
            let result = if let Ok(mut rx_guard) = rx.try_lock() {
                let mut collected = Vec::new();
                while let Ok(raw_event) = rx_guard.try_recv() {
                    collected.push(raw_event);
                }
                collected
            } else {
                Vec::new()
            };
            result
        } else {
            Vec::new()
        };

        // Process collected events
        for raw_event in events {
            if let Some(ref mut net) = self.network {
                // Store metadata for access during event processing
                net.current_metadata = Some(raw_event.metadata.clone());

                // Get type name and payload
                let type_name = &raw_event.type_name;

                // Deserialize and inject into appropriate channel
                if let Some(deserializer) = net.deserializers.get(type_name) {
                    deserializer.deserialize_and_push(&raw_event.payload, &mut self.channels);
                }

                // Clear metadata after processing
                net.current_metadata = None;
            }
        }
    }
}

/// Background worker for sending network events
#[cfg(feature = "network")]
async fn network_send_worker(
    mut rx: tokio::sync::mpsc::Receiver<NetworkTask>,
    backend: std::sync::Arc<dyn crate::network::NetworkBackend>,
) {
    use crate::network::backend::RawNetworkEvent;

    while let Some(task) = rx.recv().await {
        match task {
            NetworkTask::Send(data) => {
                // Deserialize and send
                if let Ok(event) = bincode::deserialize::<RawNetworkEvent>(&data) {
                    if let Err(e) = backend.send(event).await {
                        eprintln!("Failed to send network event: {:?}", e);
                    }
                }
            }
            NetworkTask::Shutdown => break,
        }
    }
}

/// Event reader that iterates over events published in the previous frame.
pub struct EventReader<'a, E>
where
    E: Event,
{
    events: &'a [E],
    cursor: usize,
}

impl<'a, E> EventReader<'a, E>
where
    E: Event,
{
    /// Returns an iterator over the unread events.
    pub fn iter(&self) -> impl Iterator<Item = &E> {
        self.events[self.cursor..].iter()
    }

    /// Number of unread events.
    pub fn len(&self) -> usize {
        self.events.len().saturating_sub(self.cursor)
    }

    /// Returns true if there are no unread events.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }
}

/// Internal event channel for a specific event type `E`.
///
/// `a` is the write buffer; `b` is the read buffer.
struct EventChannel<E>
where
    E: Event,
{
    a: Vec<E>,
    b: Vec<E>,
}

impl<E> EventChannel<E>
where
    E: Event,
{
    fn new() -> Self {
        Self {
            a: Vec::new(),
            b: Vec::new(),
        }
    }

    fn push(&mut self, event: E) {
        self.a.push(event);
    }

    fn read(&self) -> &[E] {
        &self.b
    }

    fn swap_buffers(&mut self) {
        std::mem::swap(&mut self.a, &mut self.b);
        self.a.clear();
    }
}

trait EventChannelStorage: Any + Send + Sync {
    fn swap_buffers(&mut self);
    fn as_any_mut(&mut self) -> &mut dyn Any;
}

impl<E> EventChannelStorage for EventChannel<E>
where
    E: Event,
{
    fn swap_buffers(&mut self) {
        EventChannel::swap_buffers(self);
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }
}

/// Convenience macro for collecting events from an EventBus into a Vec.
///
/// # Examples
///
/// ```ignore
/// use issun::event::{EventBus, collect_events};
///
/// let mut bus = EventBus::new();
/// let events = collect_events!(bus, MyEvent);
/// ```
#[macro_export]
macro_rules! collect_events {
    ($bus:expr, $event_type:ty) => {{
        $bus.reader::<$event_type>()
            .iter()
            .cloned()
            .collect::<Vec<$event_type>>()
    }};
}

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

    #[derive(Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize)]
    struct Damage(u32);

    impl Event for Damage {}

    #[test]
    fn publish_requires_dispatch() {
        let mut bus = EventBus::new();
        bus.publish(Damage(10));

        // Events are not visible until dispatch happens.
        let reader = bus.reader::<Damage>();
        assert!(reader.is_empty());

        bus.dispatch();
        let reader = bus.reader::<Damage>();
        assert_eq!(reader.len(), 1);
        assert_eq!(reader.iter().next(), Some(&Damage(10)));
    }

    #[test]
    fn multiple_dispatch_cycles() {
        let mut bus = EventBus::new();

        // Frame 0 publish
        bus.publish(Damage(1));
        bus.dispatch();
        let reader = bus.reader::<Damage>();
        assert_eq!(reader.iter().map(|d| d.0).collect::<Vec<_>>(), vec![1]);

        // Frame 1 publish multiple
        bus.publish(Damage(2));
        bus.publish(Damage(3));
        bus.dispatch();
        let reader = bus.reader::<Damage>();
        assert_eq!(reader.iter().map(|d| d.0).collect::<Vec<_>>(), vec![2, 3]);

        // Ensure old events cleared
        bus.dispatch();
        let reader = bus.reader::<Damage>();
        assert!(reader.is_empty());
    }

    #[cfg(feature = "network")]
    #[tokio::test]
    async fn network_event_registration_and_polling() {
        use crate::network::backend::LocalOnlyBackend;

        let backend = LocalOnlyBackend::new();
        let mut bus = EventBus::new().with_network(backend);

        // Register the event type for deserialization
        bus.register_networked_event::<Damage>();

        // Verify network is enabled
        assert!(bus.is_networked());

        // Poll network (should be empty)
        bus.poll_network();
        bus.dispatch();
        let reader = bus.reader::<Damage>();
        assert!(reader.is_empty());
    }
}