a3s-effect 0.2.1

Effect-style actor runtime for projecting an A3S Code harness from an immutable event log
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
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::Duration;

use a3s_effect::{ActorError, Effect, Exit, Schedule};

#[tokio::test]
async fn constructing_an_effect_does_not_run_it() {
    let calls = Arc::new(AtomicUsize::new(0));
    let seen = Arc::clone(&calls);
    let effect = Effect::<usize, ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            seen.fetch_add(1, Ordering::SeqCst);
            Ok(7)
        }
    });
    assert_eq!(calls.load(Ordering::SeqCst), 0);
    let (result, _) = effect.run(Arc::new(())).await;
    assert_eq!(result.unwrap(), 7);
    assert_eq!(calls.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn catch_fail_handles_expected_errors_and_lets_defects_through() {
    let failed = Effect::<usize, ActorError, ()>::fail(ActorError::Config("missing".into()));
    let recovered = failed.catch_fail(|error| Effect::succeed(error.to_string().len()));
    let (result, _) = recovered.run(Arc::new(())).await;
    assert!(result.unwrap() > 0);

    let defect = Effect::<usize, ActorError, ()>::die("boom");
    let untouched = defect.catch_fail(|_| Effect::succeed(1));
    let (result, _) = untouched.run(Arc::new(())).await;
    assert!(matches!(result, Err(Exit::Die(message)) if message == "boom"));
}

#[tokio::test]
async fn retry_repeats_expected_failures_and_stops_on_defects() {
    let attempts = Arc::new(AtomicUsize::new(0));
    let seen = Arc::clone(&attempts);
    let flaky = Effect::<&'static str, ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            let n = seen.fetch_add(1, Ordering::SeqCst);
            if n == 0 {
                Err(Exit::Fail(ActorError::Config("once".into())))
            } else {
                Ok("ok")
            }
        }
    });
    let (result, trace) = flaky
        .retry(Schedule {
            remaining: 1,
            delay: Duration::ZERO,
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(result.unwrap(), "ok");
    assert_eq!(attempts.load(Ordering::SeqCst), 2);
    assert!(trace
        .iter()
        .any(|event| event.name == "retry" && event.outcome == "fail"));

    let defects = Arc::new(AtomicUsize::new(0));
    let seen = Arc::clone(&defects);
    let die = Effect::<(), ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Die("no".into()))
        }
    });
    let (result, _) = die
        .retry(Schedule {
            remaining: 3,
            delay: Duration::ZERO,
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Die(_))));
    assert_eq!(defects.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn bracket_releases_on_success_failure_and_cancellation() {
    let released = Arc::new(AtomicUsize::new(0));

    let acquire = {
        let released = Arc::clone(&released);
        Effect::<Arc<AtomicUsize>, ActorError, ()>::from_async(move |_services, _cancel| {
            let released = Arc::clone(&released);
            async move { Ok(released) }
        })
    };
    let release_count = Arc::clone(&released);
    let success = acquire.bracket(
        move |_| {
            release_count.fetch_add(1, Ordering::SeqCst);
        },
        |_resource| Effect::succeed("done"),
    );
    let (result, _) = success.run(Arc::new(())).await;
    assert_eq!(result.unwrap(), "done");
    assert_eq!(released.load(Ordering::SeqCst), 1);

    let released = Arc::new(AtomicUsize::new(0));
    let acquire = {
        let released = Arc::clone(&released);
        Effect::<Arc<AtomicUsize>, ActorError, ()>::from_async(move |_services, _cancel| {
            let released = Arc::clone(&released);
            async move { Ok(released) }
        })
    };
    let release_count = Arc::clone(&released);
    let failed = acquire.bracket(
        move |_| {
            release_count.fetch_add(1, Ordering::SeqCst);
        },
        |_resource| Effect::<(), ActorError, ()>::fail(ActorError::Config("use".into())),
    );
    let (result, _) = failed.run(Arc::new(())).await;
    assert!(matches!(result, Err(Exit::Fail(_))));
    assert_eq!(released.load(Ordering::SeqCst), 1);

    let released = Arc::new(AtomicUsize::new(0));
    let acquire = {
        let released = Arc::clone(&released);
        Effect::<Arc<AtomicUsize>, ActorError, ()>::from_async(move |_services, _cancel| {
            let released = Arc::clone(&released);
            async move { Ok(released) }
        })
    };
    let release_count = Arc::clone(&released);
    let hanging = acquire.bracket(
        move |_| {
            release_count.fetch_add(1, Ordering::SeqCst);
        },
        |_resource| {
            Effect::<(), ActorError, ()>::from_async(|_services, _cancel| async {
                std::future::pending::<()>().await;
                Ok(())
            })
        },
    );
    let (result, _) = hanging
        .timeout(Duration::from_millis(20))
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Interrupt)));
    assert_eq!(released.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn run_with_cancel_lets_the_waiting_future_observe_the_token() {
    let started = Arc::new(tokio::sync::Notify::new());
    let seen = Arc::new(AtomicUsize::new(0));
    let started_run = Arc::clone(&started);
    let seen_run = Arc::clone(&seen);
    let effect = Effect::<(), ActorError, ()>::from_async(move |_services, cancel| {
        let started_run = Arc::clone(&started_run);
        let seen_run = Arc::clone(&seen_run);
        async move {
            started_run.notify_one();
            cancel.cancelled().await;
            seen_run.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Interrupt)
        }
    });
    let cancel = tokio_util::sync::CancellationToken::new();
    let cancel_run = cancel.clone();
    let task = tokio::spawn(async move { effect.run_with_cancel(Arc::new(()), cancel_run).await });
    tokio::time::timeout(Duration::from_secs(1), started.notified())
        .await
        .expect("effect did not start");
    cancel.cancel();
    let (result, _) = tokio::time::timeout(Duration::from_secs(1), task)
        .await
        .expect("cancel did not finish the effect")
        .expect("effect task panicked");
    assert!(matches!(result, Err(Exit::Interrupt)));
    assert_eq!(seen.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn zip_par_cancels_the_sibling_after_a_failure() {
    let cancelled = Arc::new(AtomicUsize::new(0));
    let seen = Arc::clone(&cancelled);
    let slow = Effect::<(), ActorError, ()>::from_async(move |_services, cancel| {
        let seen = Arc::clone(&seen);
        async move {
            cancel.cancelled().await;
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Interrupt)
        }
    });
    let fast = Effect::<(), ActorError, ()>::fail(ActorError::Config("left".into()));
    let (result, _) = fast.zip_par(&slow).run(Arc::new(())).await;
    assert!(matches!(result, Err(Exit::Fail(ActorError::Config(message))) if message == "left"));
    assert_eq!(cancelled.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn provide_swaps_the_service_environment() {
    #[derive(Clone)]
    struct ModelId(u8);

    let effect = Effect::<u8, ActorError, ModelId>::from_async(|services, _cancel| {
        let id = services.0;
        async move { Ok(id) }
    });
    let provided = effect.provide(ModelId(4));
    let (result, trace) = provided.with_span("model").run(Arc::new(())).await;
    assert_eq!(result.unwrap(), 4);
    assert!(trace
        .iter()
        .any(|event| event.name == "model" && event.outcome == "ok"));
}

#[tokio::test]
async fn config_is_rejected_before_an_actor_exists() {
    let error = a3s_effect::HarnessConfig::new(1, 10, 0, 1, Vec::new(), Vec::new()).unwrap_err();
    assert!(matches!(error, ActorError::Config(_)));
}

fn count() -> (Arc<AtomicUsize>, Arc<AtomicUsize>) {
    let calls = Arc::new(AtomicUsize::new(0));
    (Arc::clone(&calls), calls)
}

fn interrupt_effect() -> Effect<i32, ActorError, ()> {
    Effect::from_async(|_services, _cancel| async { Err(Exit::Interrupt) })
}

#[tokio::test]
async fn map_and_and_then_transform_success_and_skip_other_exits() {
    let (seen, calls) = count();
    let (mapped, _) = Effect::<i32, ActorError, ()>::succeed(2)
        .map(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            n + 3
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(mapped.unwrap(), 5);
    assert_eq!(calls.load(Ordering::SeqCst), 1);

    let (seen, calls) = count();
    let (bound, _) = Effect::<i32, ActorError, ()>::succeed(2)
        .and_then(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            Effect::succeed(n + 3)
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(bound.unwrap(), 5);
    assert_eq!(calls.load(Ordering::SeqCst), 1);

    let failed = Effect::<i32, ActorError, ()>::fail(ActorError::Config("x".into()));
    let (seen, calls) = count();
    let (mapped, _) = failed
        .map(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            n + 1
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(mapped, Err(Exit::Fail(ActorError::Config("x".into()))));
    assert_eq!(calls.load(Ordering::SeqCst), 0);

    let (seen, calls) = count();
    let (bound, _) = failed
        .and_then(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            Effect::succeed(n + 1)
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(bound, Err(Exit::Fail(ActorError::Config("x".into()))));
    assert_eq!(calls.load(Ordering::SeqCst), 0);

    let died = Effect::<i32, ActorError, ()>::die("d");
    let (seen, calls) = count();
    let (mapped, _) = died
        .map(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            n + 1
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(mapped, Err(Exit::Die(message)) if message == "d"));
    assert_eq!(calls.load(Ordering::SeqCst), 0);

    let (seen, calls) = count();
    let (bound, _) = died
        .and_then(move |_n| {
            seen.fetch_add(1, Ordering::SeqCst);
            Effect::succeed(1)
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(bound, Err(Exit::Die(message)) if message == "d"));
    assert_eq!(calls.load(Ordering::SeqCst), 0);

    let (seen, calls) = count();
    let (mapped, _) = interrupt_effect()
        .map(move |n| {
            seen.fetch_add(1, Ordering::SeqCst);
            n + 1
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(mapped, Err(Exit::Interrupt)));
    assert_eq!(calls.load(Ordering::SeqCst), 0);

    let (seen, calls) = count();
    let (bound, _) = interrupt_effect()
        .and_then(move |_n| {
            seen.fetch_add(1, Ordering::SeqCst);
            Effect::succeed(1)
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(bound, Err(Exit::Interrupt)));
    assert_eq!(calls.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn race_returns_the_first_result_and_awaits_the_loser() {
    let (seen, calls) = count();
    let left = Effect::<&'static str, ActorError, ()>::from_async(|_services, _cancel| async {
        Ok("left")
    });
    let right = Effect::<&'static str, ActorError, ()>::from_async(move |_services, cancel| {
        let seen = Arc::clone(&seen);
        async move {
            cancel.cancelled().await;
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Interrupt)
        }
    });
    let (result, _) = left.race(&right).run(Arc::new(())).await;
    assert_eq!(result.unwrap(), "left");
    assert_eq!(calls.load(Ordering::SeqCst), 1);
}

#[tokio::test]
async fn timeout_returns_interrupt_without_running_the_child_continuation() {
    let (seen, calls) = count();
    let child = Effect::<(), ActorError, ()>::from_async(move |_services, cancel| {
        let seen = Arc::clone(&seen);
        async move {
            cancel.cancelled().await;
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Interrupt)
        }
    });
    let (result, _) = child
        .timeout(Duration::from_millis(20))
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Interrupt)));
    // `timeout` drops the child inside `tokio::time::timeout` before `cancel`,
    // and it does not await that child.
    assert_eq!(calls.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn with_span_records_fail_die_and_interrupt() {
    let (failed, trace) = Effect::<(), ActorError, ()>::fail(ActorError::Config("x".into()))
        .with_span("mark")
        .run(Arc::new(()))
        .await;
    assert!(matches!(failed, Err(Exit::Fail(_))));
    assert!(trace
        .iter()
        .any(|event| event.name == "mark" && event.outcome == "fail"));

    let (died, trace) = Effect::<(), ActorError, ()>::die("d")
        .with_span("mark")
        .run(Arc::new(()))
        .await;
    assert!(matches!(died, Err(Exit::Die(message)) if message == "d"));
    assert!(trace
        .iter()
        .any(|event| event.name == "mark" && event.outcome == "die"));

    let (interrupted, trace) = interrupt_effect().with_span("mark").run(Arc::new(())).await;
    assert!(matches!(interrupted, Err(Exit::Interrupt)));
    assert!(trace
        .iter()
        .any(|event| event.name == "mark" && event.outcome == "interrupt"));
}

#[tokio::test]
async fn retry_with_no_remaining_runs_once_and_leaves_interrupt() {
    let (seen, calls) = count();
    let failing = Effect::<(), ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Fail(ActorError::Config("once".into())))
        }
    });
    let (result, _) = failing
        .retry(Schedule {
            remaining: 0,
            delay: Duration::ZERO,
        })
        .run(Arc::new(()))
        .await;
    assert_eq!(result, Err(Exit::Fail(ActorError::Config("once".into()))));
    assert_eq!(calls.load(Ordering::SeqCst), 1);

    let (seen, calls) = count();
    let interrupting = Effect::<(), ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Interrupt)
        }
    });
    let (result, trace) = interrupting
        .retry(Schedule {
            remaining: 2,
            delay: Duration::ZERO,
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Interrupt)));
    assert_eq!(calls.load(Ordering::SeqCst), 1);
    assert!(trace.iter().all(|event| event.name != "retry"));
}

#[tokio::test]
async fn catch_fail_leaves_interrupt_unchanged() {
    let (seen, calls) = count();
    let (result, _) = interrupt_effect()
        .catch_fail(move |_| {
            seen.fetch_add(1, Ordering::SeqCst);
            Effect::succeed(1)
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Interrupt)));
    assert_eq!(calls.load(Ordering::SeqCst), 0);
}

#[tokio::test]
async fn infer_schedule_runs_a_defect_once() {
    let model_attempts = 3_u32;
    let (seen, calls) = count();
    let effect = Effect::<(), ActorError, ()>::from_async(move |_services, _cancel| {
        let seen = Arc::clone(&seen);
        async move {
            seen.fetch_add(1, Ordering::SeqCst);
            Err(Exit::Die("m".into()))
        }
    });
    let (result, _) = effect
        .retry(Schedule {
            remaining: model_attempts.saturating_sub(1),
            delay: Duration::ZERO,
        })
        .run(Arc::new(()))
        .await;
    assert!(matches!(result, Err(Exit::Die(message)) if message == "m"));
    assert_eq!(calls.load(Ordering::SeqCst), 1);
}