kompact 0.12.0

Kompact is a Rust implementation of the Kompics component model combined with the Actor model.
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
use super::*;
#[cfg(feature = "distributed")]
use crate::messaging::MsgEnvelope;
use crate::{
    dispatch::lookup::{ActorLookup, ActorStore, LookupResult},
    messaging::{
        ActorRegistration,
        DispatchData,
        DispatchEnvelope,
        NetMessage,
        PathResolvable,
        PolicyRegistration,
        RegistrationEnvelope,
        RegistrationError,
        RegistrationEvent,
        RegistrationPromise,
    },
    runtime::DispatcherDefinitionCallback,
    timer::timer_manager::TimerRefFactory,
};
use futures::{FutureExt, future};
use std::sync::Arc;

async fn await_component_ended<CD>(component: &Component<CD>)
where
    CD: ComponentDefinition + 'static,
{
    while !component.is_faulty() && !component.is_destroyed() {
        async_std::task::yield_now().await;
    }
}

pub(crate) struct DefaultComponents {
    deadletter_box: Arc<Component<DeadletterBox>>,
    dispatcher: Arc<Component<LocalDispatcher>>,
}

impl DefaultComponents {
    pub(crate) fn new(
        system: &KompactSystem,
        dead_prom: KPromise<()>,
        disp_prom: KPromise<()>,
    ) -> DefaultComponents {
        let dbc = system.create_unsupervised(|| DeadletterBox::new(dead_prom));
        let ldc = system.create_unsupervised(|| LocalDispatcher::new(disp_prom));
        DefaultComponents {
            deadletter_box: dbc,
            dispatcher: ldc,
        }
    }
}

impl SystemComponents for DefaultComponents {
    fn deadletter_ref(&self) -> ActorRef<Never> {
        self.deadletter_box.actor_ref()
    }

    fn dispatcher_ref(&self) -> DispatcherRef {
        self.dispatcher
            .actor_ref()
            .hold()
            .expect("Dispatcher should not be deallocated!")
    }

    fn system_path(&self) -> SystemPath {
        self.dispatcher.on_definition(|cd| cd.system_path())
    }

    fn start(&self, system: &KompactSystem) -> () {
        system.start(&self.deadletter_box);
        system.start(&self.dispatcher);
    }

    fn stop(&self, system: &KompactSystem) -> () {
        system.kill(self.dispatcher.clone());
        system.kill(self.deadletter_box.clone());
        self.dispatcher.wait_ended();
        self.deadletter_box.wait_ended();
    }

    fn stop_notify<'a>(
        &'a self,
        system: &'a KompactSystem,
    ) -> futures::future::BoxFuture<'a, Result<(), SystemComponentsShutdownError>> {
        async move {
            system.kill(self.dispatcher.clone());
            system.kill(self.deadletter_box.clone());
            await_component_ended(&self.dispatcher).await;
            await_component_ended(&self.deadletter_box).await;
            Ok(())
        }
        .boxed()
    }

    fn kill(&self, system: &KompactSystem) -> () {
        // default_components has no graceful shutdown sequence to bypass
        self.stop(system);
    }

    fn with_dispatcher_definition_dyn<'a>(&self, f: DispatcherDefinitionCallback<'a>) -> () {
        self.dispatcher.on_definition(|dispatcher| f(dispatcher));
    }
}

pub(crate) struct DefaultTimer {
    inner: timer::TimerWithThread,
}

impl DefaultTimer {
    pub(crate) fn new() -> DefaultTimer {
        DefaultTimer {
            inner: timer::TimerWithThread::new().unwrap(),
        }
    }

    pub(crate) fn new_timer_component() -> Box<dyn TimerComponent> {
        let t = DefaultTimer::new();
        Box::new(t) as Box<dyn TimerComponent>
    }
}

impl TimerRefFactory for DefaultTimer {
    fn timer_ref(&self) -> timer::TimerRef {
        self.inner.timer_ref()
    }
}

impl TimerComponent for DefaultTimer {
    fn shutdown(&self) -> Result<(), TimerShutdownError> {
        self.inner
            .shutdown_async()
            .map_err(TimerShutdownError::from_debug)
    }

    fn shutdown_notify<'a>(
        &'a self,
    ) -> futures::future::BoxFuture<'a, Result<(), TimerShutdownError>> {
        future::ready(
            self.inner
                .shutdown_async()
                .map_err(TimerShutdownError::from_debug),
        )
        .boxed()
    }
}

struct ManualTimerComponent {
    inner: timer::ManualTimer,
}

impl ManualTimerComponent {
    fn new(inner: timer::ManualTimer) -> Self {
        Self { inner }
    }
}

impl TimerRefFactory for ManualTimerComponent {
    fn timer_ref(&self) -> timer::TimerRef {
        self.inner.timer_ref()
    }
}

impl TimerComponent for ManualTimerComponent {
    fn shutdown(&self) -> Result<(), TimerShutdownError> {
        self.inner.stop();
        Ok(())
    }

    fn shutdown_notify<'a>(
        &'a self,
    ) -> futures::future::BoxFuture<'a, Result<(), TimerShutdownError>> {
        // This actually locks a Mutex, so there's a small deadlock risk here.
        self.inner.stop();
        future::ready(Ok(())).boxed()
    }
}

/// Replaces the default threaded timer with a manually-driven timer and
/// returns the control handle for tests.
///
/// The returned timer can be advanced deterministically with
/// [`timer::ManualTimer::advance_by`] or [`timer::ManualTimer::advance_to_next`].
pub fn install_manual_timer(config: &mut KompactConfig) -> timer::ManualTimer {
    let timer = timer::ManualTimer::new();
    let builder_timer = timer.clone();
    config.timer::<ManualTimerComponent, _>(move || {
        Box::new(ManualTimerComponent::new(builder_timer.clone()))
    });
    timer
}

/// A wrapper for custom system components
///
/// This struct already has [SystemComponents][SystemComponents] implemented for it,
/// saving you the work.
pub struct CustomComponents<B, C>
where
    B: ComponentDefinition + ActorRaw<Message = Never> + Sized + 'static,
    C: ComponentDefinition + ActorRaw<Message = DispatchEnvelope> + Sized + 'static + Dispatcher,
{
    pub(crate) deadletter_box: Arc<Component<B>>,
    pub(crate) dispatcher: Arc<Component<C>>,
}

impl<B, C> SystemComponents for CustomComponents<B, C>
where
    B: ComponentDefinition + ActorRaw<Message = Never> + Sized + 'static,
    C: ComponentDefinition + ActorRaw<Message = DispatchEnvelope> + Sized + 'static + Dispatcher,
{
    fn deadletter_ref(&self) -> ActorRef<Never> {
        self.deadletter_box.actor_ref()
    }

    fn dispatcher_ref(&self) -> DispatcherRef {
        self.dispatcher
            .actor_ref()
            .hold()
            .expect("Dispatcher should not be deallocated!")
    }

    fn system_path(&self) -> SystemPath {
        self.dispatcher.on_definition(|cd| cd.system_path())
    }

    fn start(&self, system: &KompactSystem) -> () {
        system.start(&self.deadletter_box);
        system.start(&self.dispatcher);
    }

    fn stop(&self, system: &KompactSystem) -> () {
        // Gracefully stop the dispatcher/Network layer.
        system.stop(&self.dispatcher.clone());
        self.kill(system);
    }

    fn stop_notify<'a>(
        &'a self,
        system: &'a KompactSystem,
    ) -> futures::future::BoxFuture<'a, Result<(), SystemComponentsShutdownError>> {
        async move {
            // Gracefully stop the dispatcher/Network layer.
            system.stop(&self.dispatcher.clone());
            system.kill(self.dispatcher.clone());
            system.kill(self.deadletter_box.clone());
            await_component_ended(&self.dispatcher).await;
            await_component_ended(&self.deadletter_box).await;
            Ok(())
        }
        .boxed()
    }

    fn kill(&self, system: &KompactSystem) -> () {
        system.kill(self.dispatcher.clone());
        system.kill(self.deadletter_box.clone());
        self.dispatcher.wait_ended();
        self.deadletter_box.wait_ended();
    }

    fn with_dispatcher_definition_dyn<'a>(&self, f: DispatcherDefinitionCallback<'a>) -> () {
        self.dispatcher.on_definition(|dispatcher| f(dispatcher));
    }
}

/// The default deadletter box
///
/// Simply logs every received message at the `info` level
/// and then discards it.
#[derive(ComponentDefinition)]
pub struct DeadletterBox {
    ctx: ComponentContext<DeadletterBox>,
    notify_ready: Option<KPromise<()>>,
}

impl DeadletterBox {
    /// Creates a new deadletter box
    ///
    /// The `notify_ready` promise will be fulfilled, when the component
    /// received a `Start` event.
    pub fn new(notify_ready: KPromise<()>) -> DeadletterBox {
        DeadletterBox {
            ctx: ComponentContext::uninitialised(),
            notify_ready: Some(notify_ready),
        }
    }
}

impl Actor for DeadletterBox {
    type Message = Never;

    /// Handles local messages.
    fn receive_local(&mut self, _msg: Self::Message) -> HandlerResult {
        unimplemented!(); // this can't actually happen
    }

    #[cfg(feature = "distributed")]
    /// Handles (serialised or reflected) messages from the network.
    fn receive_network(&mut self, msg: NetMessage) -> HandlerResult {
        info!(
            self.ctx.log(),
            "DeadletterBox received network message {:?}", msg,
        );
        Handled::OK
    }
}

impl ComponentLifecycle for DeadletterBox {
    fn on_start(&mut self) -> HandlerResult {
        debug!(self.ctx.log(), "Starting DeadletterBox");
        if let Some(promise) = self.notify_ready.take() {
            promise.complete().unwrap_or(())
        }
        Handled::OK
    }
}

/// The default non-networked dispatcher
///
/// Logs network messages at the `info` level and local messages at the `warn` level,
/// then discards either.
#[derive(ComponentDefinition)]
pub struct LocalDispatcher {
    ctx: ComponentContext<LocalDispatcher>,
    notify_ready: Option<KPromise<()>>,
    lookup: ActorStore,
    system_path: SystemPath,
}

impl LocalDispatcher {
    /// Creates a new local dispatcher
    ///
    /// The `notify_ready` promise will be fulfilled, when the component
    /// received a `Start` event.
    pub fn new(notify_ready: KPromise<()>) -> LocalDispatcher {
        LocalDispatcher {
            ctx: ComponentContext::uninitialised(),
            notify_ready: Some(notify_ready),
            lookup: ActorStore::new(),
            system_path: SystemPath::new(Transport::Local, "127.0.0.1".parse().unwrap(), 0),
        }
    }

    fn deadletter_path(&self) -> ActorPath {
        ActorPath::Named(NamedPath::with_system(self.system_path.clone(), Vec::new()))
    }

    fn resolve_path(&self, resolvable: &PathResolvable) -> Result<ActorPath, PathParseError> {
        match resolvable {
            PathResolvable::Path(actor_path) => Ok(actor_path.clone()),
            PathResolvable::Alias(alias) => self
                .system_path
                .clone()
                .into_named_with_string(alias)
                .map(|p| p.into()),
            PathResolvable::Segments(segments) => self
                .system_path
                .clone()
                .into_named_with_vec(segments.to_vec())
                .map(|p| p.into()),
            PathResolvable::ActorId(id) => Ok(self.system_path.clone().into_unique(*id).into()),
            PathResolvable::System => Ok(self.deadletter_path()),
        }
    }

    #[cfg(feature = "distributed")]
    fn deadletter_network_msg(&self, netmsg: NetMessage) {
        self.ctx.deadletter_ref().enqueue(MsgEnvelope::Net(netmsg));
    }

    #[cfg(not(feature = "distributed"))]
    fn deadletter_network_msg(&self, netmsg: NetMessage) {
        warn!(
            self.ctx.log(),
            "Dropping network message {:?} without the `distributed` feature", netmsg.receiver,
        );
    }

    fn route_local(&mut self, dst: ActorPath, msg: DispatchData) -> () {
        let lookup_result = self.lookup.get_by_actor_path(&dst);
        match msg.into_local() {
            Ok(netmsg) => match lookup_result {
                LookupResult::Ref(actor) => actor.tell(netmsg),
                LookupResult::Group(group) => group.route(netmsg, self.log()),
                LookupResult::None => {
                    warn!(
                        self.ctx.log(),
                        "No local actor found at {:?}. Forwarding to DeadletterBox",
                        netmsg.receiver,
                    );
                    self.deadletter_network_msg(netmsg);
                }
                LookupResult::Err(e) => {
                    error!(
                        self.ctx.log(),
                        "Local lookup failed at {:?}. Forwarding to DeadletterBox. Error was: {}",
                        netmsg.receiver,
                        e
                    );
                    self.deadletter_network_msg(netmsg);
                }
            },
            Err(e) => error!(self.log(), "Could not serialise msg: {:?}. Dropping...", e),
        }
    }

    fn register_actor(
        &mut self,
        registration: ActorRegistration,
        update: bool,
        promise: RegistrationPromise,
    ) {
        let ActorRegistration { actor, path } = registration;
        let res = self
            .resolve_path(&path)
            .map_err(RegistrationError::InvalidPath)
            .and_then(|ap| {
                if self.lookup.contains(&path) && !update {
                    Err(RegistrationError::DuplicateEntry)
                } else {
                    self.lookup
                        .insert(path.clone(), actor)
                        .map(|_| ap)
                        .map_err(RegistrationError::InvalidPath)
                }
            });
        match promise {
            RegistrationPromise::Fulfil(promise) => {
                promise.fulfil(res).unwrap_or_else(|e| {
                    error!(self.ctx.log(), "Could not notify listeners: {:?}", e)
                });
            }
            RegistrationPromise::None => {
                trace!(
                    self.ctx.log(),
                    "Actor registration completed without listeners"
                );
            }
        }
    }

    fn register_policy(
        &mut self,
        registration: PolicyRegistration,
        update: bool,
        promise: RegistrationPromise,
    ) {
        let PolicyRegistration { policy, path } = registration;
        let path_res = PathResolvable::Segments(path.clone());
        let res = self
            .resolve_path(&path_res)
            .map_err(RegistrationError::InvalidPath)
            .and_then(|ap| {
                if self.lookup.contains(&path_res) && !update {
                    Err(RegistrationError::DuplicateEntry)
                } else {
                    self.lookup
                        .set_routing_policy(&path, policy)
                        .map(|_| ap)
                        .map_err(RegistrationError::InvalidPath)
                }
            });
        match promise {
            RegistrationPromise::Fulfil(promise) => {
                promise.fulfil(res).unwrap_or_else(|e| {
                    error!(self.ctx.log(), "Could not notify listeners: {:?}", e)
                });
            }
            RegistrationPromise::None => {
                trace!(
                    self.ctx.log(),
                    "Routing policy registration completed without listeners"
                );
            }
        }
    }
}

impl Actor for LocalDispatcher {
    type Message = DispatchEnvelope;

    fn receive_local(&mut self, msg: Self::Message) -> HandlerResult {
        match msg {
            DispatchEnvelope::Msg { dst, msg, .. } => {
                if dst.system() == &self.system_path || dst.protocol() == Transport::Local {
                    self.route_local(dst, msg);
                } else {
                    match msg.into_local() {
                        Ok(netmsg) => {
                            warn!(
                                self.ctx.log(),
                                "Forwarding unresolved remote dispatch to DeadletterBox: {:?}", dst,
                            );
                            self.deadletter_network_msg(netmsg);
                        }
                        Err(e) => {
                            error!(
                                self.ctx.log(),
                                "Could not serialise remote dispatch to {:?} for deadletters: {:?}",
                                dst,
                                e,
                            );
                        }
                    }
                }
            }
            DispatchEnvelope::ForwardedMsg { msg } => {
                if msg.receiver.system() == &self.system_path
                    || msg.receiver.protocol() == Transport::Local
                {
                    self.route_local(msg.receiver.clone(), DispatchData::NetMessage(msg));
                } else {
                    warn!(
                        self.ctx.log(),
                        "Forwarding unresolved remote dispatch to DeadletterBox: {:?}",
                        msg.receiver,
                    );
                    self.deadletter_network_msg(msg);
                }
            }
            DispatchEnvelope::Registration(reg) => {
                let RegistrationEnvelope {
                    event,
                    update,
                    promise,
                } = reg;
                match event {
                    RegistrationEvent::Actor(registration) => {
                        self.register_actor(registration, update, promise)
                    }
                    RegistrationEvent::Policy(registration) => {
                        self.register_policy(registration, update, promise)
                    }
                }
            }
            DispatchEnvelope::Event(ev) => {
                warn!(
                    self.ctx.log(),
                    "Ignoring dispatcher event {:?} in LocalDispatcher", ev
                );
            }
            DispatchEnvelope::LockedChunk(_trash) => {
                // Dropping the chunk is sufficient in the local-only dispatcher.
            }
        }
        Handled::OK
    }

    #[cfg(feature = "distributed")]
    fn receive_network(&mut self, msg: NetMessage) -> HandlerResult {
        info!(
            self.ctx.log(),
            "LocalDispatcher received network message {:?}", msg,
        );
        Handled::OK
    }
}

impl Dispatcher for LocalDispatcher {
    fn system_path(&mut self) -> SystemPath {
        self.system_path.clone()
    }
}

impl ComponentLifecycle for LocalDispatcher {
    fn on_start(&mut self) -> HandlerResult {
        debug!(self.ctx.log(), "Starting LocalDispatcher");
        #[cfg(feature = "distributed")]
        self.lookup
            .insert(PathResolvable::System, self.ctx.deadletter_ref().dyn_ref())
            .expect("deadletter path should always be insertable");
        if let Some(promise) = self.notify_ready.take() {
            promise.complete().unwrap_or(())
        }
        Handled::OK
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[cfg(feature = "distributed")]
    use crate::routing::groups::BroadcastRouting;
    use crate::timer::timer_manager::Timer;
    #[cfg(feature = "distributed")]
    use bytes::{Buf, BufMut};
    #[cfg(feature = "distributed")]
    use std::any::Any;
    use std::{sync::mpsc, time::Duration};

    #[derive(ComponentDefinition)]
    struct TimerProbe {
        ctx: ComponentContext<Self>,
        fired: mpsc::Sender<()>,
    }

    impl TimerProbe {
        fn new(fired: mpsc::Sender<()>) -> Self {
            Self {
                ctx: ComponentContext::uninitialised(),
                fired,
            }
        }
    }

    #[cfg(feature = "distributed")]
    #[derive(Debug, Clone, Copy)]
    struct Ping;

    #[cfg(feature = "distributed")]
    impl Serialisable for Ping {
        fn ser_id(&self) -> SerId {
            Self::SER_ID
        }

        fn size_hint(&self) -> Option<usize> {
            Some(0)
        }

        fn serialise(&self, _buf: &mut dyn BufMut) -> Result<(), SerError> {
            Ok(())
        }

        fn local(self: Box<Self>) -> Result<Box<dyn Any + Send>, Box<dyn Serialisable>> {
            Ok(self)
        }

        fn cloned(&self) -> Option<Box<dyn Serialisable>> {
            Some(Box::new(*self))
        }
    }

    #[cfg(feature = "distributed")]
    impl Deserialiser<Ping> for Ping {
        const SER_ID: SerId = 42;

        fn deserialise(_buf: &mut dyn Buf) -> Result<Ping, SerError> {
            Ok(Ping)
        }
    }

    #[cfg(feature = "distributed")]
    #[derive(ComponentDefinition)]
    struct PathProbe {
        ctx: ComponentContext<Self>,
        received: usize,
        delivered: mpsc::Sender<()>,
    }

    #[cfg(feature = "distributed")]
    impl PathProbe {
        fn new(delivered: mpsc::Sender<()>) -> Self {
            Self {
                ctx: ComponentContext::uninitialised(),
                received: 0,
                delivered,
            }
        }
    }

    #[cfg(feature = "distributed")]
    ignore_lifecycle!(PathProbe);

    #[cfg(feature = "distributed")]
    impl NetworkActor for PathProbe {
        type Deserialiser = Ping;
        type Message = Ping;

        fn receive(&mut self, _sender: Option<ActorPath>, _msg: Self::Message) -> HandlerResult {
            self.received += 1;
            self.delivered
                .send(())
                .expect("probe receiver must stay live");
            Handled::OK
        }
    }

    #[cfg(feature = "distributed")]
    fn expect_delivery(rx: &mpsc::Receiver<()>) {
        rx.recv_timeout(Duration::from_secs(1))
            .expect("path message should be delivered");
    }

    impl ComponentLifecycle for TimerProbe {
        fn on_start(&mut self) -> HandlerResult {
            let fired = self.fired.clone();
            self.schedule_once(Duration::from_millis(10), move |_component, _timer| {
                fired.send(()).expect("probe receiver must stay live");
                Handled::OK
            });
            Handled::OK
        }
    }

    impl Actor for TimerProbe {
        type Message = Never;

        fn receive_local(&mut self, _msg: Self::Message) -> HandlerResult {
            unreachable!("Never type is empty")
        }

        #[cfg(feature = "distributed")]
        fn receive_network(&mut self, _msg: NetMessage) -> HandlerResult {
            unimplemented!("TimerProbe does not use network actor messages")
        }
    }

    #[test]
    fn installed_manual_timer_requires_explicit_advance() {
        let mut config = KompactConfig::default();
        let timer = install_manual_timer(&mut config);
        let system = config.build().wait().expect("build KompactSystem");
        let (tx, rx) = mpsc::channel();
        let component = system.create(|| TimerProbe::new(tx));

        system
            .start_notify(&component)
            .wait_timeout(Duration::from_secs(1))
            .expect("TimerProbe should start");

        assert!(
            rx.recv_timeout(Duration::from_millis(50)).is_err(),
            "manual timer should not fire before explicit advance"
        );

        timer.advance_by(Duration::from_millis(10));
        rx.recv_timeout(Duration::from_secs(1))
            .expect("manual timer should fire after explicit advance");

        system.shutdown().wait().expect("shutdown KompactSystem");
    }

    #[cfg(feature = "distributed")]
    #[test]
    fn local_dispatcher_routes_unique_path_messages() {
        let system = KompactConfig::default()
            .build()
            .wait()
            .expect("build KompactSystem");
        let (tx, rx) = mpsc::channel();
        let probe = system.create(|| PathProbe::new(tx));

        system
            .start_notify(&probe)
            .wait_timeout(Duration::from_secs(1))
            .expect("PathProbe should start");

        let path = system
            .register(&probe)
            .wait_expect(Duration::from_secs(1), "unique registration should succeed");
        path.tell(Ping, &system);

        expect_delivery(&rx);
        probe.on_definition(|cd| assert_eq!(cd.received, 1));
        system.shutdown().wait().expect("shutdown KompactSystem");
    }

    #[cfg(feature = "distributed")]
    #[test]
    fn local_dispatcher_routes_alias_messages() {
        let system = KompactConfig::default()
            .build()
            .wait()
            .expect("build KompactSystem");
        let (tx, rx) = mpsc::channel();
        let probe = system.create(|| PathProbe::new(tx));

        system
            .start_notify(&probe)
            .wait_timeout(Duration::from_secs(1))
            .expect("PathProbe should start");

        let path = system
            .register_by_alias(&probe, "tests/path-probe")
            .wait_expect(Duration::from_secs(1), "alias registration should succeed");
        path.tell(Ping, &system);

        expect_delivery(&rx);
        probe.on_definition(|cd| assert_eq!(cd.received, 1));
        system.shutdown().wait().expect("shutdown KompactSystem");
    }

    #[cfg(feature = "distributed")]
    #[test]
    fn local_dispatcher_routes_broadcast_groups() {
        let system = KompactConfig::default()
            .build()
            .wait()
            .expect("build KompactSystem");
        let (tx1, rx1) = mpsc::channel();
        let (tx2, rx2) = mpsc::channel();
        let probe1 = system.create(|| PathProbe::new(tx1));
        let probe2 = system.create(|| PathProbe::new(tx2));

        system
            .start_notify(&probe1)
            .wait_timeout(Duration::from_secs(1))
            .expect("first PathProbe should start");
        system
            .start_notify(&probe2)
            .wait_timeout(Duration::from_secs(1))
            .expect("second PathProbe should start");

        let group = system
            .set_routing_policy(BroadcastRouting, "tests/group", false)
            .wait_expect(
                Duration::from_secs(1),
                "routing policy registration should succeed",
            );
        system
            .register_by_alias(&probe1, "tests/group/one")
            .wait_expect(
                Duration::from_secs(1),
                "first alias registration should succeed",
            );
        system
            .register_by_alias(&probe2, "tests/group/two")
            .wait_expect(
                Duration::from_secs(1),
                "second alias registration should succeed",
            );

        group.tell(Ping, &system);

        expect_delivery(&rx1);
        expect_delivery(&rx2);
        probe1.on_definition(|cd| assert_eq!(cd.received, 1));
        probe2.on_definition(|cd| assert_eq!(cd.received, 1));
        system.shutdown().wait().expect("shutdown KompactSystem");
    }
}