speare 0.4.2

actor-like thin abstraction over tokio::task and flume channels
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
mod sync_vec;

use speare::{Actor, Ctx, Node, RegistryError};
use sync_vec::SyncVec;
use tokio::task;

struct Worker;

impl Actor for Worker {
    type Props = SyncVec<String>;
    type Msg = String;
    type Err = ();

    async fn init(_: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        Ok(Worker)
    }

    async fn handle(&mut self, msg: Self::Msg, ctx: &mut Ctx<Self>) -> Result<(), Self::Err> {
        ctx.props().push(msg).await;
        Ok(())
    }
}

struct LookupByType;

impl Actor for LookupByType {
    type Props = SyncVec<bool>;
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let found = ctx.get_handle_for::<Worker>().is_ok();
        ctx.props().push(found).await;
        Ok(LookupByType)
    }
}

struct LookupByName;

impl Actor for LookupByName {
    type Props = (String, SyncVec<bool>);
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let (name, recvd) = ctx.props();
        let found = ctx.get_handle::<String>(name).is_ok();
        recvd.push(found).await;
        Ok(LookupByName)
    }
}

// -- spawn_registered --------------------------------------------------------

#[tokio::test]
async fn spawn_registered_returns_handle() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();

    // Act
    let result = node.actor::<Worker>(recvd).spawn_registered();

    // Assert
    assert!(result.is_ok());
}

#[tokio::test]
async fn spawn_registered_returns_name_taken_on_duplicate() {
    // Arrange
    let mut node = Node::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_registered()
        .unwrap();

    // Act
    let result = node.actor::<Worker>(SyncVec::default()).spawn_registered();

    // Assert
    assert!(matches!(result, Err(RegistryError::NameTaken(_))));
}

#[tokio::test]
async fn spawn_registered_actor_is_functional() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();
    let handle = node
        .actor::<Worker>(recvd.clone())
        .spawn_registered()
        .unwrap();

    // Act
    handle.send("hello".to_string());
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec!["hello".to_string()]);
}

// -- spawn_named -------------------------------------------------------------

#[tokio::test]
async fn spawn_named_returns_handle() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();

    // Act
    let result = node.actor::<Worker>(recvd).spawn_named("my-worker");

    // Assert
    assert!(result.is_ok());
}

#[tokio::test]
async fn spawn_named_returns_name_taken_on_duplicate() {
    // Arrange
    let mut node = Node::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("my-worker")
        .unwrap();

    // Act
    let result = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("my-worker");

    // Assert
    assert!(matches!(result, Err(RegistryError::NameTaken(_))));
}

#[tokio::test]
async fn spawn_named_allows_different_names() {
    // Arrange
    let mut node = Node::default();

    // Act
    let first = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("worker-a");
    let second = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("worker-b");

    // Assert
    assert!(first.is_ok());
    assert!(second.is_ok());
}

#[tokio::test]
async fn spawn_named_actor_is_functional() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();
    let handle = node
        .actor::<Worker>(recvd.clone())
        .spawn_named("worker")
        .unwrap();

    // Act
    handle.send("world".to_string());
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec!["world".to_string()]);
}

// -- get_handle_for ----------------------------------------------------------

#[tokio::test]
async fn get_handle_for_returns_none_when_not_registered() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();

    // Act - LookupByType tries to find Worker, which was never registered
    node.actor::<LookupByType>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![false]);
}

#[tokio::test]
async fn get_handle_for_finds_registered_actor() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_registered()
        .unwrap();

    // Act - LookupByType tries to find Worker, which was registered above
    node.actor::<LookupByType>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

// -- get_handle (type mismatch) ----------------------------------------------

struct LookupByNameWrongType;

impl Actor for LookupByNameWrongType {
    type Props = (String, SyncVec<bool>);
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let (name, recvd) = ctx.props();
        let found = ctx.get_handle::<u32>(name).is_ok();
        recvd.push(found).await;
        Ok(LookupByNameWrongType)
    }
}

#[tokio::test]
async fn get_handle_returns_none_for_wrong_msg_type() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("my-worker")
        .unwrap();

    // Act - lookup with u32 instead of String (Worker::Msg = String)
    node.actor::<LookupByNameWrongType>(("my-worker".to_string(), recvd.clone()))
        .spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![false]);
}

// -- get_handle --------------------------------------------------------------

#[tokio::test]
async fn get_handle_returns_none_when_not_registered() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<LookupByName>(("nonexistent".to_string(), recvd.clone()))
        .spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![false]);
}

#[tokio::test]
async fn get_handle_finds_named_actor() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("my-worker")
        .unwrap();

    // Act
    node.actor::<LookupByName>(("my-worker".to_string(), recvd.clone()))
        .spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

#[tokio::test]
async fn get_handle_returns_none_for_wrong_name() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("my-worker")
        .unwrap();

    // Act
    node.actor::<LookupByName>(("wrong-name".to_string(), recvd.clone()))
        .spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![false]);
}

// -- send (by type) ----------------------------------------------------------

struct SendByType;

impl Actor for SendByType {
    type Props = ();
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let _ = ctx.send::<Worker>("via-send".to_string());
        Ok(SendByType)
    }
}

#[tokio::test]
async fn send_delivers_msg_to_registered_actor() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();
    let _ = node
        .actor::<Worker>(recvd.clone())
        .spawn_registered()
        .unwrap();

    // Act
    node.actor::<SendByType>(()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec!["via-send".to_string()]);
}

struct SendByTypeNotFound;

impl Actor for SendByTypeNotFound {
    type Props = SyncVec<bool>;
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let result = ctx.send::<Worker>("msg".to_string());
        ctx.props()
            .push(matches!(result, Err(RegistryError::NotFound(_))))
            .await;

        Ok(SendByTypeNotFound)
    }
}

#[tokio::test]
async fn send_returns_not_found_when_not_registered() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<SendByTypeNotFound>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

// -- send_to (by name) -------------------------------------------------------

struct SendByName;

impl Actor for SendByName {
    type Props = String;
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let name = ctx.props().clone();
        let _ = ctx.send_to::<<Worker as Actor>::Msg>(&name, "via-send-to".to_string());

        Ok(SendByName)
    }
}

#[tokio::test]
async fn send_to_delivers_msg_to_named_actor() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<String>::default();
    let _ = node
        .actor::<Worker>(recvd.clone())
        .spawn_named("target")
        .unwrap();

    // Act
    node.actor::<SendByName>("target".to_string()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec!["via-send-to".to_string()]);
}

struct SendByNameNotFound;

impl Actor for SendByNameNotFound {
    type Props = SyncVec<bool>;
    type Msg = ();
    type Err = ();

    async fn init(ctx: &mut Ctx<Self>) -> Result<Self, Self::Err> {
        let result = ctx.send_to::<<Worker as Actor>::Msg>("nope", "msg".to_string());
        ctx.props()
            .push(matches!(result, Err(RegistryError::NotFound(_))))
            .await;

        Ok(SendByNameNotFound)
    }
}

#[tokio::test]
async fn send_to_returns_not_found_when_not_registered() {
    // Arrange
    let mut node = Node::default();
    let recvd = SyncVec::<bool>::default();

    // Act
    node.actor::<SendByNameNotFound>(recvd.clone()).spawn();
    task::yield_now().await;

    // Assert
    assert_eq!(recvd.clone_vec().await, vec![true]);
}

// -- deregistration -----------------------------------------------------------

#[tokio::test]
async fn named_actor_deregisters_on_stop() {
    // Arrange
    let mut node = Node::default();
    let handle = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("worker")
        .unwrap();

    // Act
    handle.stop();
    task::yield_now().await;

    // Assert - name should be available again
    let result = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("worker");
    assert!(result.is_ok());
}

#[tokio::test]
async fn registered_actor_deregisters_on_stop() {
    // Arrange
    let mut node = Node::default();
    let handle = node
        .actor::<Worker>(SyncVec::default())
        .spawn_registered()
        .unwrap();

    // Act
    handle.stop();
    task::yield_now().await;

    // Assert - type name should be available again
    let result = node.actor::<Worker>(SyncVec::default()).spawn_registered();
    assert!(result.is_ok());
}

// -- spawn_registered / spawn_named collision ---------------------------------

#[tokio::test]
async fn spawn_named_with_type_name_collides_with_spawn_registered() {
    // Arrange
    let mut node = Node::default();
    let type_name = std::any::type_name::<Worker>();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named(type_name)
        .unwrap();

    // Act
    let result = node.actor::<Worker>(SyncVec::default()).spawn_registered();

    // Assert
    assert!(matches!(result, Err(RegistryError::NameTaken(_))));
}

#[tokio::test]
async fn spawn_registered_collides_with_spawn_named_using_type_name() {
    // Arrange
    let mut node = Node::default();
    let _ = node
        .actor::<Worker>(SyncVec::default())
        .spawn_registered()
        .unwrap();

    // Act
    let type_name = std::any::type_name::<Worker>();
    let result = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named(type_name);

    // Assert
    assert!(matches!(result, Err(RegistryError::NameTaken(_))));
}

#[tokio::test]
async fn spawn_registered_and_spawn_named_coexist_with_different_keys() {
    // Arrange & Act
    let mut node = Node::default();
    let first = node.actor::<Worker>(SyncVec::default()).spawn_registered();

    let second = node
        .actor::<Worker>(SyncVec::default())
        .spawn_named("custom-worker");

    // Assert
    assert!(first.is_ok());
    assert!(second.is_ok());
}