rig-agent 0.43.0

Rig's classic agent runtime.
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
830
831
832
833
834
835
836
//! The bus's wait/wake protocols under `loom`: every interleaving of a
//! small model, run with `RUSTFLAGS="--cfg rig_loom" cargo test -p rig-agent
//! --lib --release loom_`. A model that fails is a bug in the protocol.
//!
//! `Waker`s are `std`'s (loom does not intercept `wake()`), so the models
//! observe wakes through a recording `Wake` impl; the reply halves are
//! `futures` channels, treated as data. The first two models are the
//! regression proofs for the races `fix(core)` closed in #2443 (a send after
//! the close; a registration between the driver's two drains): each fails
//! against the pre-fix code.

#![allow(clippy::expect_used, clippy::unwrap_used, clippy::panic)]

use std::{
    sync::atomic::{AtomicBool, Ordering as StdOrdering},
    task::{Context, Wake, Waker},
};

use futures::channel::oneshot;
use loom::{sync::Arc, thread};

use rig_core::serve::{ErasedHandler, Serve};

use super::{
    Bus,
    dispatcher::{Command, Enqueue, Reply, Shared},
    registrar::{Mailbox, Registration},
};
use rig_core::effect::{EffectId, EffectKind, FamilyDescriptor, HandlerDescriptor, HandlerKey};

/// A waker that records that it was woken.
struct Recording(AtomicBool);

impl Wake for Recording {
    fn wake(self: std::sync::Arc<Self>) {
        self.0.store(true, StdOrdering::SeqCst);
    }
}

fn recording() -> (std::sync::Arc<Recording>, Waker) {
    let flag = std::sync::Arc::new(Recording(AtomicBool::new(false)));
    let waker = Waker::from(std::sync::Arc::clone(&flag));
    (flag, waker)
}

type Receiver = oneshot::Receiver<Result<rig_core::effect::Outcome, rig_core::error::ErrorReport>>;

fn command(id: u64) -> (Command, Receiver) {
    let (reply, receiver) = oneshot::channel();
    let (cancel_guard, cancel) = oneshot::channel();
    std::mem::forget(cancel_guard);
    (
        Command {
            lineage: super::dispatcher::Lineage::new(EffectId::from_raw(id), None),
            id: EffectId::from_raw(id),
            key: HandlerKey::from("k"),
            kind: EffectKind::Custom {
                kind: std::sync::Arc::from("m"),
                payload: serde_json::Value::Null,
            },
            parent: None,
            scope: None,
            context: None,
            adapter_context: None,
            published: None,
            reply: Reply::Unary(reply),
            span: tracing::Span::none(),
            cancel,
        },
        receiver,
    )
}

/// A sender racing the driver's drop: every command is either taken by the
/// driver or failed with `BusClosed` — never buffered forever.
#[test]
fn loom_close_fails_what_the_driver_never_took() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 4,
            ..rig_core::serve::ServingPolicy::default()
        }));
        let sender = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let (cmd, receiver) = command(1);
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                // `Pending::poll`'s send stage.
                if shared.is_closed() {
                    return (true, receiver);
                }
                let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
                match shared.enqueue(cmd, &parked, &cx) {
                    Enqueue::Sent => (false, receiver),
                    Enqueue::Closed => (true, receiver),
                    Enqueue::Parked(_) | Enqueue::Refused(_) | Enqueue::Cancelled(_) => {
                        panic!("neither")
                    }
                }
            })
        };
        let closer = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || shared.mark_closed())
        };
        let (saw_closed, mut receiver) = sender.join().unwrap();
        closer.join().unwrap();
        assert_eq!(
            shared.buffered(),
            0,
            "a command was buffered after the close"
        );
        if !saw_closed {
            match receiver.try_recv() {
                Ok(Some(Err(report))) => {
                    assert_eq!(report.kind, rig_core::error::ErrorKind::BusClosed);
                }
                other => panic!("the buffered command was not failed: {other:?}"),
            }
        }
    });
}

struct Nothing;

impl Serve for Nothing {
    type Family = rig_core::effect::family::Dynamic;

    fn descriptor(&self) -> HandlerDescriptor {
        HandlerDescriptor {
            key: HandlerKey::from("k"),
            family: FamilyDescriptor::Custom { kind: "m".into() },
            layers: Vec::new(),
        }
    }

    async fn serve(
        &self,
        _kind: EffectKind,
        _dispatch: rig_core::serve::Dispatch,
    ) -> rig_core::serve::Reply {
        rig_core::serve::Reply::Outcome(Err(rig_core::error::ErrorReport::new(
            rig_core::error::ErrorKind::Internal,
            "the handler dropped its outcome sink without answering",
        )))
    }
}

struct Tagged(&'static str);

impl Serve for Tagged {
    type Family = rig_core::effect::family::Dynamic;

    fn descriptor(&self) -> HandlerDescriptor {
        HandlerDescriptor {
            key: HandlerKey::from("k"),
            family: FamilyDescriptor::Custom {
                kind: self.0.into(),
            },
            layers: Vec::new(),
        }
    }

    async fn serve(
        &self,
        _kind: EffectKind,
        _dispatch: rig_core::serve::Dispatch,
    ) -> rig_core::serve::Reply {
        return rig_core::serve::Reply::Outcome(Ok(rig_core::effect::Outcome::Custom {
            payload: serde_json::json!(self.0),
        }));
    }
}

#[test]
fn loom_concurrent_registrations_publish_and_serve_the_same_handler() {
    use futures::FutureExt;

    loom::model(|| {
        let (dispatcher, registrar, mut driver) = Bus::channel();
        let other = registrar.clone();
        let first = thread::spawn(move || registrar.register("k", Tagged("first")));
        let second = thread::spawn(move || other.register("k", Tagged("second")));
        first.join().unwrap().expect("registered first");
        second.join().unwrap().expect("registered second");

        let key = HandlerKey::from("k");
        let described = dispatcher.descriptor(&key).expect("published");
        let FamilyDescriptor::Custom { kind } = described.family else {
            panic!("custom handler");
        };
        let mut pending = dispatcher.dispatch(
            &key,
            EffectKind::Custom {
                kind: kind.clone().into(),
                payload: serde_json::Value::Null,
            },
        );
        let (_flag, waker) = recording();
        let mut cx = Context::from_waker(&waker);
        assert!(pending.poll_unpin(&mut cx).is_pending());
        let _ = driver.poll_unpin(&mut cx);
        let std::task::Poll::Ready(Ok(rig_core::effect::Outcome::Custom { payload })) =
            pending.poll_unpin(&mut cx)
        else {
            panic!("registered handler must answer");
        };
        assert_eq!(payload, serde_json::json!(kind));
    });
}

/// A registration posted before a dispatch (program order on the
/// registering thread) is installed before that dispatch is served: the
/// driver takes the queue first and the mailbox second.
#[test]
fn loom_a_registration_before_a_dispatch_is_installed_first() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 4,
            ..rig_core::serve::ServingPolicy::default()
        }));
        let mailbox = Arc::new(Mailbox::new());
        let poster = {
            let shared = Arc::clone(&shared);
            let mailbox = Arc::clone(&mailbox);
            thread::spawn(move || {
                mailbox
                    .register(&shared, HandlerKey::from("k"), ErasedHandler::new(Nothing))
                    .expect("register");
                let (cmd, receiver) = command(1);
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
                assert!(matches!(shared.enqueue(cmd, &parked, &cx), Enqueue::Sent));
                receiver
            })
        };
        let driver = {
            let shared = Arc::clone(&shared);
            let mailbox = Arc::clone(&mailbox);
            thread::spawn(move || {
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let mut installed = false;
                let mut served = 0;
                while served < 1 {
                    // The driver's poll: the queue, then the mailbox, then
                    // serving what was taken.
                    let commands = shared.drain(&cx);
                    for registration in mailbox.drain(&cx) {
                        if let Registration::Install { .. } = registration {
                            installed = true;
                        }
                    }
                    for _command in commands {
                        assert!(installed, "a dispatch was served before its registration");
                        served += 1;
                    }
                    if served < 1 {
                        thread::yield_now();
                    }
                }
            })
        };
        let _receiver = poster.join().unwrap();
        driver.join().unwrap();
    });
}

/// Two senders against one driver with `command_capacity: 1`: the buffer
/// never holds more than one command, every parked sender is woken before
/// the model ends, and both commands are drained exactly once.
#[test]
fn loom_bound_is_never_exceeded_and_no_sender_is_lost() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 1,
            ..rig_core::serve::ServingPolicy::default()
        }));
        let mut senders = Vec::new();
        for id in 1..=2u64 {
            let shared = Arc::clone(&shared);
            senders.push(thread::spawn(move || {
                let (mut cmd, _receiver) = command(id);
                let (flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let slot = std::sync::Arc::new(futures::task::AtomicWaker::new());
                let mut parked = false;
                loop {
                    match shared.enqueue(cmd, &slot, &cx) {
                        Enqueue::Sent => break,
                        Enqueue::Parked(kept) => {
                            parked = true;
                            cmd = kept;
                            thread::yield_now();
                        }
                        Enqueue::Refused(_) | Enqueue::Cancelled(_) | Enqueue::Closed => {
                            panic!("neither")
                        }
                    }
                }
                (parked, flag)
            }));
        }
        let drained = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let mut drained = 0;
                while drained < 2 {
                    let batch = shared.drain(&cx);
                    assert!(batch.len() <= 1, "the bound is bus-wide: {}", batch.len());
                    drained += batch.len();
                    if drained < 2 {
                        thread::yield_now();
                    }
                }
                drained
            })
        };
        let results: Vec<_> = senders.into_iter().map(|s| s.join().unwrap()).collect();
        assert_eq!(drained.join().unwrap(), 2);
        for (parked, flag) in results {
            if parked {
                assert!(
                    flag.0.load(StdOrdering::SeqCst),
                    "a parked sender was woken by a drain"
                );
            }
        }
        assert_eq!(shared.buffered(), 0);
    });
}

/// A registration posted after the driver dropped keeps nothing: the
/// descriptor is data and stays, the handler goes.
#[test]
fn loom_registrar_after_close_keeps_nothing() {
    loom::model(|| {
        let (_dispatcher, registrar, driver) = Bus::channel();
        let poster = thread::spawn(move || {
            registrar
                .register("late", Nothing)
                .expect("descriptor published");
            registrar
        });
        drop(driver);
        let registrar = poster.join().unwrap();
        assert!(registrar.is_closed());
    });
}

/// Counts polls of the handler and records opened by the driver: the two
/// must agree however a consumer's drop interleaves with the driver's poll.
#[derive(Clone)]
struct Counted {
    polled: std::sync::Arc<std::sync::atomic::AtomicUsize>,
}

impl Serve for Counted {
    type Family = rig_core::effect::family::Dynamic;

    fn descriptor(&self) -> HandlerDescriptor {
        HandlerDescriptor {
            key: HandlerKey::from("k"),
            family: FamilyDescriptor::Custom { kind: "m".into() },
            layers: Vec::new(),
        }
    }

    async fn serve(
        &self,
        _kind: EffectKind,
        _dispatch: rig_core::serve::Dispatch,
    ) -> rig_core::serve::Reply {
        self.polled.fetch_add(1, StdOrdering::SeqCst);
        // One yield before answering, the shape of any handler that does IO.
        let mut yielded = false;
        futures::future::poll_fn(|cx| {
            if yielded {
                std::task::Poll::Ready(())
            } else {
                yielded = true;
                cx.waker().wake_by_ref();
                std::task::Poll::Pending
            }
        })
        .await;
        return rig_core::serve::Reply::Outcome(Ok(rig_core::effect::Outcome::Custom {
            payload: serde_json::Value::Null,
        }));
    }
}

/// Records opened, and outcomes that were unexpected failures.
#[derive(Clone)]
struct Begun {
    begun: std::sync::Arc<std::sync::atomic::AtomicUsize>,
    failed: std::sync::Arc<std::sync::atomic::AtomicUsize>,
}

impl rig_core::serve::Recorder for Begun {
    fn tool_output(&self, _: EffectId, _: rig_core::tool::ToolResultContext) {}
    fn handlers(&self, _handlers: Vec<HandlerDescriptor>) {}
    fn begin(
        &self,
        _id: EffectId,
        _key: HandlerKey,
        _kind: EffectKind,
        _origin: rig_core::serve::Origin,
    ) {
        self.begun.fetch_add(1, StdOrdering::SeqCst);
    }
    fn discard(&self, _id: EffectId) {}
    fn patch(&self, _id: EffectId, _kind: EffectKind) {}
    fn keep_events(&self) -> bool {
        false
    }
    fn event(
        &self,
        _id: EffectId,
        _item: &rig_core::streaming::Item<rig_core::streaming::StreamEvent>,
    ) {
    }
    fn resolve(
        &self,
        _id: EffectId,
        outcome: Result<rig_core::effect::Outcome, rig_core::error::ErrorReport>,
    ) {
        if let Err(report) = outcome
            && report.kind != rig_core::error::ErrorKind::Cancelled
        {
            self.failed.fetch_add(1, StdOrdering::SeqCst);
        }
    }
}

/// A consumer dropping its dispatch racing the driver's poll: whichever
/// order the model picks, a record is opened only for a dispatch whose
/// handler was polled, no record ever resolves as the "handler dropped its
/// sink" failure (before the fix, a cancel that landed before the driver's
/// poll opened a record and then failed it that way), and the driver ends
/// with nothing in flight. A handler already polled when cancellation arrives
/// records `Cancelled`; that is a truthful terminal outcome, not a handler defect.
#[test]
fn loom_cancel_before_serve_never_polls_the_handler() {
    use futures::FutureExt;
    loom::model(|| {
        let (dispatcher, _registrar, mut driver) = Bus::channel();
        let polled = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        driver
            .register(
                "k",
                Counted {
                    polled: polled.clone(),
                },
            )
            .expect("register");
        let begun = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let failed = std::sync::Arc::new(std::sync::atomic::AtomicUsize::new(0));
        driver.record_to(Begun {
            begun: begun.clone(),
            failed: failed.clone(),
        });
        let mut pending = dispatcher.dispatch(
            &HandlerKey::from("k"),
            EffectKind::Custom {
                kind: std::sync::Arc::from("m"),
                payload: serde_json::Value::Null,
            },
        );
        {
            let (_flag, waker) = recording();
            let mut cx = Context::from_waker(&waker);
            assert!(pending.poll_unpin(&mut cx).is_pending(), "sent");
        }
        let consumer = thread::spawn(move || drop(pending));
        let driving = thread::spawn(move || {
            let (_flag, waker) = recording();
            let mut cx = Context::from_waker(&waker);
            for _ in 0..3 {
                let _ = driver.poll_unpin(&mut cx);
                thread::yield_now();
            }
            driver
        });
        consumer.join().unwrap();
        let mut driver = driving.join().unwrap();
        let (_flag, waker) = recording();
        let mut cx = Context::from_waker(&waker);
        let _ = driver.poll_unpin(&mut cx);
        assert_eq!(
            polled.load(StdOrdering::SeqCst),
            begun.load(StdOrdering::SeqCst),
            "a record without a handler poll, or a poll without a record"
        );
        assert!(polled.load(StdOrdering::SeqCst) <= 1);
        assert_eq!(
            failed.load(StdOrdering::SeqCst),
            0,
            "a cancelled dispatch was served and recorded as a handler failure"
        );
        assert_eq!(driver.in_flight(), 0);
        assert_eq!(dispatcher.buffered(), 0);
    });
}

/// The close for commands races a late enqueue from a `Pending` that
/// outlived its dispatcher: every interleaving ends with the command
/// either buffered on a bus still open for commands (the driver's next
/// poll takes it) or refused as `BusClosed` — never buffered on a bus
/// closed for commands, which nothing would ever take. The decision and
/// the store are one critical section with the enqueue's check.
#[test]
fn loom_close_for_commands_never_strands_a_late_enqueue() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 4,
            ..rig_core::serve::ServingPolicy::default()
        }));
        // No dispatcher is open: the sender is a `Pending` that outlived its.
        let sender = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let (cmd, _receiver) = command(1);
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
                match shared.enqueue(cmd, &parked, &cx) {
                    Enqueue::Sent => false,
                    Enqueue::Closed => true,
                    Enqueue::Parked(_) | Enqueue::Refused(_) | Enqueue::Cancelled(_) => {
                        panic!("neither")
                    }
                }
            })
        };
        let closer = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || shared.try_close_commands())
        };
        let refused = sender.join().unwrap();
        let closed = closer.join().unwrap();
        assert!(
            !(shared.commands_closed() && shared.buffered() > 0),
            "a command is buffered on a bus closed for commands (refused: {refused}, closed: {closed})"
        );
        if closed {
            assert!(
                refused,
                "the close saw an empty buffer, so the send came after it"
            );
        }
    });
}

/// Causality: a nested dispatch under serial serving is refused by its
/// chain, whichever thread enqueues it. A dispatch is in flight on `k`; a
/// command made from it, to `k`, is enqueued from a spawned thread while
/// another thread begins and ends an unrelated dispatch. Every interleaving
/// refuses the nested command — the old thread-id rule accepted it (and
/// hung) whenever the enqueuing thread was not the polling one.
#[test]
fn loom_a_nested_serial_dispatch_is_refused_from_any_thread() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 4,
            serial_per_handler: true,
            ..rig_core::serve::ServingPolicy::default()
        }));
        shared.dispatcher_opened();
        let _outer = shared
            .begin_in_flight(EffectId::from_raw(1), HandlerKey::from("k"), None)
            .ok()
            .expect("nothing cancelled");
        let nested = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let (mut cmd, _receiver) = command(2);
                cmd.parent = Some(EffectId::from_raw(1));
                cmd.lineage = super::dispatcher::Lineage::new(
                    cmd.id,
                    Some(shared.retained_lineage(EffectId::from_raw(1))),
                );
                let (_flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
                matches!(shared.enqueue(cmd, &parked, &cx), Enqueue::Refused(_))
            })
        };
        let sibling = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let _flag = shared
                    .begin_in_flight(EffectId::from_raw(3), HandlerKey::from("j"), None)
                    .ok()
                    .expect("nothing cancelled");
                shared.end_in_flight(EffectId::from_raw(3));
            })
        };
        let refused = nested.join().unwrap();
        sibling.join().unwrap();
        assert!(refused, "the nested dispatch queued behind its ancestor");
        assert_eq!(shared.buffered(), 0);
    });
}

/// Causality: a parent's cancel reaches a child that begins concurrently.
/// One thread cancels the descendants of dispatch 1; another begins
/// dispatch 2 as 1's child. Whichever order the model picks, the child is
/// either refused at `begin_in_flight` (the cancel came first) or flagged
/// (it was in flight when the cancel scanned) — never in flight unflagged,
/// which is what a separate check-then-insert would allow.
#[test]
fn loom_a_parent_cancel_reaches_a_child_that_begins_meanwhile() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy::default()));
        let _parent = shared
            .begin_in_flight(EffectId::from_raw(1), HandlerKey::from("k"), None)
            .ok()
            .expect("nothing cancelled");
        let cancelling = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || shared.cancel_descendants(EffectId::from_raw(1)))
        };
        let beginning = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                shared
                    .begin_in_flight(
                        EffectId::from_raw(2),
                        HandlerKey::from("j"),
                        Some(EffectId::from_raw(1)),
                    )
                    .ok()
            })
        };
        cancelling.join().unwrap();
        let child = beginning.join().unwrap();
        match child {
            None => {}
            Some(flag) => assert!(
                flag.is_set(),
                "a child in flight escaped its parent's cancel"
            ),
        }
    });
}

#[test]
fn loom_cancel_crosses_a_completed_middle_while_grandchild_starts() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy::default()));
        shared
            .begin_in_flight(EffectId::from_raw(1), HandlerKey::from("root"), None)
            .ok()
            .unwrap();
        shared
            .begin_in_flight(
                EffectId::from_raw(2),
                HandlerKey::from("middle"),
                Some(EffectId::from_raw(1)),
            )
            .ok()
            .unwrap();
        let middle = shared.retained_lineage(EffectId::from_raw(2));
        shared.end_in_flight(EffectId::from_raw(2));
        let cancelling = {
            let shared = shared.clone();
            thread::spawn(move || shared.cancel_descendants(EffectId::from_raw(1)))
        };
        let starting = {
            let shared = shared.clone();
            thread::spawn(move || {
                shared
                    .begin_lineage(
                        super::dispatcher::Lineage::new(EffectId::from_raw(3), Some(middle)),
                        HandlerKey::from("child"),
                    )
                    .ok()
            })
        };
        cancelling.join().unwrap();
        if let Some(flag) = starting.join().unwrap() {
            assert!(flag.is_set());
        }
    });
}

#[test]
fn loom_cancel_wakes_a_sender_parking_below_a_completed_middle() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 1,
            ..rig_core::serve::ServingPolicy::default()
        }));
        shared.dispatcher_opened();
        shared
            .begin_in_flight(EffectId::from_raw(1), HandlerKey::from("root"), None)
            .ok()
            .unwrap();
        shared
            .begin_in_flight(
                EffectId::from_raw(2),
                HandlerKey::from("middle"),
                Some(EffectId::from_raw(1)),
            )
            .ok()
            .unwrap();
        let middle = shared.retained_lineage(EffectId::from_raw(2));
        shared.end_in_flight(EffectId::from_raw(2));
        let (_, filler_waker) = recording();
        let (filler, _receiver) = command(10);
        let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
        assert!(matches!(
            shared.enqueue(filler, &parked, &Context::from_waker(&filler_waker)),
            Enqueue::Sent
        ));
        let sending = {
            let shared = shared.clone();
            thread::spawn(move || {
                let (mut child, _receiver) = command(3);
                child.parent = Some(EffectId::from_raw(2));
                child.lineage = super::dispatcher::Lineage::new(child.id, Some(middle));
                let (flag, waker) = recording();
                let parked = std::sync::Arc::new(futures::task::AtomicWaker::new());
                let result = shared.enqueue(child, &parked, &Context::from_waker(&waker));
                (result, flag, parked)
            })
        };
        let cancelling = {
            let shared = shared.clone();
            thread::spawn(move || shared.cancel_descendants(EffectId::from_raw(1)))
        };
        cancelling.join().unwrap();
        let (result, flag, parked) = sending.join().unwrap();
        match result {
            Enqueue::Cancelled(_) => {}
            Enqueue::Parked(child) => {
                assert!(
                    flag.0.load(StdOrdering::SeqCst),
                    "cancel must wake parked descendant"
                );
                let (_, waker) = recording();
                assert!(matches!(
                    shared.enqueue(child, &parked, &Context::from_waker(&waker)),
                    Enqueue::Cancelled(_)
                ));
            }
            _ => panic!("full buffer only parks or refuses cancellation"),
        }
    });
}

/// Capacity freed without a drain: a sender is parked on a full buffer whose
/// one command is a descendant of a dispatch that is then cancelled. The
/// driver's release drops that orphan from the buffer and drains. Whichever
/// way the sender's parks interleave with the cancel's wake and the release,
/// the model ends with the sender either sent or woken after its last park —
/// never parked on a buffer with room, which nothing would ever wake. Fails
/// against a drain that wakes parked senders only when it took a command.
#[test]
fn loom_capacity_freed_by_orphan_removal_wakes_a_parked_sender() {
    loom::model(|| {
        let shared = Arc::new(Shared::new(rig_core::serve::ServingPolicy {
            command_capacity: 1,
            ..rig_core::serve::ServingPolicy::default()
        }));
        shared.dispatcher_opened();
        let _root = shared
            .begin_in_flight(EffectId::from_raw(1), HandlerKey::from("root"), None)
            .ok()
            .expect("nothing cancelled");
        let root = shared.retained_lineage(EffectId::from_raw(1));
        let (mut child, _child_receiver) = command(2);
        child.parent = Some(EffectId::from_raw(1));
        child.lineage = super::dispatcher::Lineage::new(child.id, Some(root));
        let (_, waker) = recording();
        let slot = std::sync::Arc::new(futures::task::AtomicWaker::new());
        assert!(matches!(
            shared.enqueue(child, &slot, &Context::from_waker(&waker)),
            Enqueue::Sent
        ));
        let sender = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                let (mut cmd, _receiver) = command(3);
                let (flag, waker) = recording();
                let cx = Context::from_waker(&waker);
                let slot = std::sync::Arc::new(futures::task::AtomicWaker::new());
                loop {
                    // The send stage of a `Pending`: park, and poll again
                    // only when woken.
                    flag.0.store(false, StdOrdering::SeqCst);
                    match shared.enqueue(cmd, &slot, &cx) {
                        Enqueue::Sent => return None,
                        Enqueue::Parked(kept) => {
                            cmd = kept;
                            thread::yield_now();
                            if !flag.0.load(StdOrdering::SeqCst) {
                                // Still parked: the value (and its slot)
                                // lives on, waiting for a wake.
                                return Some((flag, slot));
                            }
                        }
                        Enqueue::Refused(_) | Enqueue::Cancelled(_) | Enqueue::Closed => {
                            panic!("an unrelated sender is parked or sent")
                        }
                    }
                }
            })
        };
        let driver = {
            let shared = Arc::clone(&shared);
            thread::spawn(move || {
                // The root's task observes its cancel, then the driver
                // releases it: the orphaned child leaves the buffer, and the
                // poll loop drains again.
                shared.cancel_descendants(EffectId::from_raw(1));
                assert!(shared.end_in_flight(EffectId::from_raw(1)));
                shared.fail_cancelled_buffered();
                let (_, waker) = recording();
                shared.drain(&Context::from_waker(&waker));
            })
        };
        driver.join().unwrap();
        if let Some((flag, _slot)) = sender.join().unwrap() {
            assert!(
                flag.0.load(StdOrdering::SeqCst),
                "a sender parked on capacity the driver freed was never woken"
            );
        }
    });
}