rig-memory 0.47.0

Conversations over time for the Rig agent framework: recent messages, compaction, and saving and resuming sessions.
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
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
use std::sync::Arc;

use rig_core::completion::Message;
use rig_core::conversation::{Aside, Author, Change, Conversation, Entry, Halt};
use rig_core::message::{ImageMediaType, UserContent};
use serde_json::json;

use super::{LogRecord, SavedAgent, Session, as_of, history, load, save};
use crate::{Files, LogWriteError, MemoryStore, Repair, SessionError, Store, Writer};

/// Appends `bytes` to the log `log` of `store`, wherever it ends now.
fn append(store: &dyn Store, log: &str, bytes: &[u8]) -> Result<(), LogWriteError> {
    let len = store.read_log(log).map_or(0, |bytes| bytes.len() as u64);
    store.append_log(log, len, bytes)
}

/// The file a torn tail `tail` of the log `log` is set aside in.
fn part(log: &str, tail: &[u8]) -> String {
    format!(
        "recovered/{log}-{}.part",
        rig_core::tool::content_hash(tail).0
    )
}

/// A conversation with an image, an authored entry, a splice that keeps an
/// id, a stopped request, and a saved and an unsaved aside.
fn edited() -> Conversation {
    let mut conversation = Conversation::new();
    edit(&mut conversation);
    conversation
}

/// Makes those edits to `conversation`.
fn edit(conversation: &mut Conversation) {
    conversation.push(Message::User {
        content: vec![
            UserContent::text("look"),
            UserContent::image_base64("cG5n", Some(ImageMediaType::PNG), None),
        ],
    });
    conversation.push(Message::assistant("a cat"));
    conversation.push(Entry::new(Message::user("report")).by(Author::plugin("ci")));
    let mut first = conversation.entry(0).expect("an entry");
    first.message = Message::user("look again").into();
    conversation.splice(0..1, [first], Author::plugin("editor"));
    conversation.halt(Halt::Stopped);
    conversation.push(Message::user("go on"));
    let note = Aside::new("note", Author::plugin("btw"), json!({ "text": "hi" }));
    conversation.add_aside(note.clone());
    conversation.add_aside(note.unsaved());
}

#[test]
fn a_saved_conversation_folds_back_to_itself() {
    let store = MemoryStore::default();
    let mut conversation = load(&store, "agent").expect("an empty log");
    conversation.push(Message::user("first"));
    save(&store, "agent", &mut conversation).expect("saved");
    edit(&mut conversation);
    conversation.splice(0..1, [], Author::plugin("editor"));
    conversation.halt(Halt::Kept);
    save(&store, "agent", &mut conversation).expect("saved again");
    assert!(conversation.unsaved().is_empty());
    let loaded = load(&store, "agent").expect("loaded");
    assert_eq!(loaded, conversation);
    assert_eq!(loaded.revision(), conversation.revision());
    assert_eq!(
        crate::blobs::blob_names(&store).expect("blobs").len(),
        1,
        "the image is a blob"
    );
    let log = String::from_utf8(store.read_log("agent").expect("a log")).expect("text");
    assert!(log.starts_with(r#"{"seq":0,"n":0,"#), "{log}");
    assert!(log.contains(r#""format":"rig-session/4""#), "{log}");
    assert!(!log.contains("cG5n"), "the image data is not in the log");

    // A running writer's log folds back the same, with saved values.
    let store = Arc::new(MemoryStore::default());
    let (writer, session) = Writer::open(store.clone()).expect("an empty session");
    assert_eq!(session, Session::default());
    writer.start();
    let mut live = edited();
    let saved = writer.save("main", &mut live);
    assert!(saved.iter().all(|change| change.at.is_some()));
    writer.save_value("main", "mode", Some(json!("plan")), false);
    writer.save_value(crate::SESSION, "theme", Some(json!("dark")), false);
    writer.flush().expect("flushed");
    let session = Session::read(&*store).expect("read");
    let main = session.agent("main").expect("the agent");
    assert_eq!(main.conversation, live);
    assert_eq!(main.saved, [("mode".to_owned(), json!("plan"))].into());
    assert_eq!(session.saved, [("theme".to_owned(), json!("dark"))].into());
    assert!(main.rewrites.is_empty());
}

#[test]
fn saving_refuses_a_log_that_moved_on() {
    let store = MemoryStore::default();
    let mut first = load(&store, "agent").expect("loaded");
    let mut second = load(&store, "agent").expect("loaded");
    first.push(Message::user("one"));
    save(&store, "agent", &mut first).expect("saved");
    let before = store.read_log("agent").expect("a log");
    second.push(Message::user("two"));
    let refused = save(&store, "agent", &mut second);
    assert!(matches!(refused, Err(SessionError::Changed { log }) if log == "agent"));
    assert_eq!(store.read_log("agent").expect("a log"), before);
}

#[test]
fn a_writer_saves_a_replaced_conversation_as_one_reset() {
    let store = Arc::new(MemoryStore::default());
    let (writer, _) = Writer::open(store.clone()).expect("opened");
    writer.start();
    let mut conversation = edited();
    writer.save("main", &mut conversation);
    let mut replaced = Conversation::from_messages([Message::user("elsewhere")]);
    let saved = writer.save("main", &mut replaced);
    assert!(matches!(saved.as_slice(), [only] if matches!(only.change, Change::Reset { .. })));
    // It goes on from there.
    replaced.push(Message::assistant("ok"));
    writer.save("main", &mut replaced);
    writer.flush().expect("flushed");
    let session = Session::read(&*store).expect("read");
    assert_eq!(session.agent("main").expect("agent").conversation, replaced);
}

/// A reset whose last entry names a blob reads with the image put back
/// and keeps its halt.
#[test]
fn a_halted_reset_naming_a_blob_reads_halted() -> Result<(), Box<dyn std::error::Error>> {
    let store = Arc::new(MemoryStore::default());
    let image = Message::User {
        content: vec![UserContent::image_base64(
            "cG5n",
            Some(ImageMediaType::PNG),
            None,
        )],
    };
    let put = &mut |name: String, bytes: Vec<u8>| crate::blobs::put_blob(&*store, &name, &bytes);
    let stored = crate::blobs::store_images_with(&image, put)?.into_owned();
    if stored == image {
        return Err("the image was not stored as a blob".into());
    }
    let (writer, _) = Writer::open(store.clone())?;
    writer.start();
    let mut first = Conversation::from_messages([Message::user("before")]);
    writer.save("main", &mut first);
    let mut replaced = Conversation::from_messages([stored]);
    if !replaced.halt(Halt::Stopped) {
        return Err("the conversation did not halt".into());
    }
    let saved = writer.save("main", &mut replaced);
    if !matches!(saved.as_slice(), [only] if matches!(only.change, Change::Reset { .. })) {
        return Err(format!("saved {saved:?}, not one reset").into());
    }
    writer.flush()?;
    let session = Session::read(&*store)?;
    if !session.repairs.is_empty() {
        return Err(format!("repaired: {:?}", session.repairs).into());
    }
    let agent = session.agent("main").ok_or("no agent `main`")?;
    let conversation = &agent.conversation;
    let messages: Vec<&Message> = conversation.messages().iter().map(|m| &**m).collect();
    if conversation.halted() != Some(Halt::Stopped) || messages != [&image] {
        return Err(format!("read {messages:?}, halted {:?}", conversation.halted()).into());
    }
    Ok(())
}

/// Only the conversation a log holds continues it, even when another has
/// made as many changes: one saved to another log, one read back from its
/// serde form. Saving
/// another refuses, writing nothing, unless the log is empty.
#[test]
fn only_the_conversation_a_log_holds_continues_it() {
    let store = MemoryStore::default();
    let mut a = load(&store, "a").expect("an empty log");
    a.push(Message::user("for a"));
    save(&store, "a", &mut a).expect("saved");
    let mut b = load(&store, "b").expect("an empty log");
    b.push(Message::user("for b"));
    save(&store, "b", &mut b).expect("saved");
    let before = store.read_log("a").expect("a log");
    b.push(Message::assistant("moved"));
    let refused = save(&store, "a", &mut b);
    assert!(
        matches!(&refused, Err(SessionError::Changed { log }) if log == "a"),
        "{refused:?}"
    );
    assert_eq!(store.read_log("a").expect("a log"), before);

    // Read back from its serde form, it is saved whole onto an empty log.
    let json = serde_json::to_string(&a).expect("serialized");
    let mut copy: Conversation = serde_json::from_str(&json).expect("deserialized");
    copy.push(Message::assistant("copied"));
    save(&store, "c", &mut copy).expect("an empty log takes any conversation");
    assert_eq!(load(&store, "c").expect("loaded"), copy);
    assert!(matches!(
        save(&store, "a", &mut copy),
        Err(SessionError::Changed { .. })
    ));
}

/// A running writer writes a conversation that does not continue a log
/// as one reset, whatever its number of changes, so the log folds back to
/// it: one moved from another agent's log, one read back from its serde
/// form.
#[test]
fn a_writer_resets_a_log_to_a_conversation_it_does_not_hold() {
    let store = Arc::new(MemoryStore::default());
    let (writer, _) = Writer::open(store.clone()).expect("opened");
    writer.start();
    let mut a = Conversation::from_messages([Message::user("for a")]);
    writer.save("a", &mut a);
    let mut b = Conversation::from_messages([Message::user("for b")]);
    writer.save("b", &mut b);
    let saved = writer.save("a", &mut b);
    assert!(matches!(saved.as_slice(), [only] if matches!(only.change, Change::Reset { .. })));
    b.push(Message::assistant("moved"));
    writer.save("a", &mut b);

    let json = serde_json::to_string(&a).expect("serialized");
    let mut copy: Conversation = serde_json::from_str(&json).expect("deserialized");
    copy.push(Message::assistant("copied"));
    writer.save("c", &mut copy);
    writer.flush().expect("flushed");
    let session = Session::read(&*store).expect("read");
    assert_eq!(
        session.agent("a").map(|agent| &agent.conversation),
        Some(&b)
    );
    assert_eq!(
        session.agent("c").map(|agent| &agent.conversation),
        Some(&copy)
    );
}

#[test]
fn a_torn_tail_is_reported_then_set_aside() {
    let store = Arc::new(MemoryStore::default());
    let mut conversation = Conversation::from_messages([Message::user("hello")]);
    save(&*store, "main", &mut conversation).expect("saved");
    let whole = store.read_log("main").expect("a log");
    append(&*store, "main", br#"{"seq":2,"n":"#).expect("torn");

    // Reading reports it and changes nothing.
    let session = Session::read(&*store).expect("read");
    let torn = Repair::TornTail {
        log: "main".to_owned(),
        kept: whole.len() as u64,
        cut: 13,
        set_aside: None,
    };
    assert_eq!(session.repairs, [torn]);
    assert_eq!(
        session.agent("main").expect("agent").conversation,
        conversation
    );
    assert!(store.files().expect("files").is_empty());

    // Opening it to write sets the tail aside and cuts it off.
    let (writer, session) = Writer::open(store.clone()).expect("opened");
    let part = part("main", br#"{"seq":2,"n":"#);
    assert!(matches!(
        session.repairs.as_slice(),
        [Repair::TornTail { set_aside: Some(file), cut: 13, .. }] if *file == part
    ));
    assert_eq!(
        store.read_file(&part).expect("set aside"),
        br#"{"seq":2,"n":"#
    );
    assert_eq!(store.read_log("main").expect("a log"), whole);
    writer.start();
    let mut conversation = session
        .agents
        .into_iter()
        .next()
        .expect("agent")
        .conversation;
    conversation.push(Message::assistant("hi"));
    writer.save("main", &mut conversation);
    writer.flush().expect("flushed");
    assert_eq!(load(&*store, "main").expect("loaded"), conversation);
}

/// A log whose first write was cut short holds no record yet: reading
/// reports it torn whole, and opening it to write sets it aside, so the
/// header written next starts a line and the session still reads.
#[test]
fn a_log_holding_only_a_torn_first_line_is_set_aside_before_it_is_written() {
    let store = Arc::new(MemoryStore::default());
    store
        .append_log("main", 0, br#"{"seq":0,"n":0,"t":1,"ty"#)
        .expect("torn");
    let session = Session::read(&*store).expect("read");
    assert!(session.agent("main").is_none());
    let torn = Repair::TornTail {
        log: "main".to_owned(),
        kept: 0,
        cut: 24,
        set_aside: None,
    };
    assert_eq!(session.repairs, [torn]);

    let (writer, session) = Writer::open(store.clone()).expect("opened");
    assert!(matches!(
        session.repairs.as_slice(),
        [Repair::TornTail {
            kept: 0,
            set_aside: Some(_),
            ..
        }]
    ));
    assert_eq!(
        store
            .read_file(&part("main", br#"{"seq":0,"n":0,"t":1,"ty"#))
            .expect("set aside"),
        br#"{"seq":0,"n":0,"t":1,"ty"#
    );
    writer.start();
    let mut conversation = Conversation::from_messages([Message::user("hello")]);
    writer.save("main", &mut conversation);
    writer.flush().expect("flushed");
    assert_eq!(load(&*store, "main").expect("loaded"), conversation);
}

/// The library saves set a torn last line aside before they append, as
/// [`Writer::open`] does, so the next record starts a line of its own.
#[test]
fn the_library_saves_set_a_torn_tail_aside_before_they_append() {
    let tear = br#"{"seq":2,"n":"#;

    // `save` onto a log whose last record was cut short.
    let store = MemoryStore::default();
    let mut conversation = Conversation::from_messages([Message::user("hello")]);
    save(&store, "main", &mut conversation).expect("saved");
    append(&store, "main", tear).expect("torn");
    conversation.push(Message::assistant("hi"));
    save(&store, "main", &mut conversation).expect("saved after the tear");
    assert_eq!(load(&store, "main").expect("loaded"), conversation);
    assert_eq!(
        store.read_file(&part("main", tear)).expect("set aside"),
        tear
    );

    // `save` onto a log whose first write was cut short.
    let store = MemoryStore::default();
    append(&store, "main", tear).expect("torn");
    save(&store, "main", &mut conversation).expect("saved after the tear");
    assert_eq!(load(&store, "main").expect("loaded"), conversation);
    assert_eq!(
        store.read_file(&part("main", tear)).expect("set aside"),
        tear
    );

    // `Session::save` onto a log whose last record was cut short.
    append(&store, "main", tear).expect("torn");
    let mut session = Session::read(&store).expect("read");
    if let Some(agent) = session.agent_mut("main") {
        agent.conversation.push(Message::user("again"));
    }
    session.save(&store).expect("saved after the tear");
    let read = Session::read(&store).expect("read again");
    assert_eq!(read.repairs, []);
    assert_eq!(read.agent("main"), session.agent("main"));
    assert_eq!(
        store.read_file(&part("main", tear)).expect("set aside"),
        tear
    );
}

#[test]
fn a_session_it_cannot_read_whole_is_refused_unless_read_leniently() {
    let store = MemoryStore::default();
    let mut conversation = Conversation::from_messages([Message::user("a"), Message::user("b")]);
    save(&store, "main", &mut conversation).expect("saved");
    append(
        &store,
        "main",
        b"{\"seq\":2,\"n\":2,\"t\":0,\"type\":\"mystery\"}\n",
    )
    .expect("written");
    append(
        &store,
        "main",
        b"{\"seq\":3,\"n\":3,\"t\":0,\"type\":\"halt\",\"halt\":\"kept\"}\n",
    )
    .expect("written");
    let mut other = Conversation::from_messages([Message::user("c")]);
    save(&store, "other", &mut other).expect("saved");
    let refused = Session::read(&store);
    assert!(
        matches!(&refused, Err(SessionError::Record { log, line: 3, .. }) if log == "main"),
        "{refused:?}"
    );
    // Read leniently, the log that reads is kept and the other named.
    let (session, unreadable) = Session::read_lenient(&store).expect("listed");
    let read: Vec<&str> = session
        .agents
        .iter()
        .map(|agent| agent.id.as_str())
        .collect();
    assert_eq!(read, ["other"]);
    let names: Vec<&str> = unreadable.iter().map(|log| log.log.as_str()).collect();
    assert_eq!(names, ["main"]);
    // A log from before this format names none.
    let old = MemoryStore::default();
    old.append_log(
        "old",
        0,
        b"{\"seq\":0,\"n\":0,\"t\":0,\"type\":\"header\",\"agent\":\"old\"}\n",
    )
    .expect("written");
    let refused = load(&old, "old");
    assert!(
        matches!(refused, Err(SessionError::Format { found: None, .. })),
        "{refused:?}"
    );
}

#[test]
fn history_and_as_of_cut_by_the_record_that_made_a_message() {
    let store = MemoryStore::default();
    store
        .write_file("plugins/notes.json", b"{}")
        .expect("written");
    store.write_file("meta.json", b"{}").expect("written");
    let mut session = Session::default();
    session.agents.push(SavedAgent {
        id: "main".to_owned(),
        conversation: Conversation::from_messages([
            Message::user("one"),
            Message::assistant("two"),
        ]),
        ..SavedAgent::default()
    });
    session.save(&store).expect("saved");
    let main = session.agent_mut("main").expect("main");
    let three = main.conversation.push(Message::user("three"));
    session.agents.push(SavedAgent {
        id: "sub".to_owned(),
        parent: Some("main".to_owned()),
        conversation: Conversation::from_messages([Message::user("work")]),
        ..SavedAgent::default()
    });
    session.save(&store).expect("saved again");

    let records = history(&store, "main").expect("history");
    let made = records.iter().find_map(|(stamp, record)| match record {
        LogRecord::Change(recorded) => match &recorded.change {
            Change::Push { entries } if entries.iter().any(|entry| entry.id == Some(three)) => {
                Some(stamp.n)
            }
            _ => None,
        },
        _ => None,
    });
    let made = made.expect("the record that made it");
    let before = as_of(&store, "main", made).expect("as of");
    assert_eq!(
        before.messages(),
        [Message::user("one"), Message::assistant("two")].map(std::sync::Arc::new)
    );
}

/// A store reached asynchronously, over a [`MemoryStore`]: every call waits
/// one poll, as one behind a network does, appends wait for good while
/// `held`, and the next append fails after `fail_once` is set.
#[derive(Default)]
struct Remote {
    store: MemoryStore,
    held: std::sync::atomic::AtomicBool,
    /// The next append fails.
    fail_once: std::sync::atomic::AtomicBool,
}

impl Remote {
    async fn call<T>(&self, call: impl FnOnce(&MemoryStore) -> T) -> T {
        let mut waited = false;
        std::future::poll_fn(|cx| {
            if std::mem::replace(&mut waited, true) {
                return std::task::Poll::Ready(());
            }
            cx.waker().wake_by_ref();
            std::task::Poll::Pending
        })
        .await;
        call(&self.store)
    }
}

impl crate::AsyncStore for Remote {
    async fn read_log_async(&self, name: &str) -> std::io::Result<Vec<u8>> {
        self.call(|store| store.read_log(name)).await
    }

    async fn append_log_async(
        &self,
        name: &str,
        len: u64,
        bytes: &[u8],
    ) -> Result<(), LogWriteError> {
        if self.held.load(std::sync::atomic::Ordering::SeqCst) {
            std::future::pending::<()>().await;
        }
        if self
            .fail_once
            .swap(false, std::sync::atomic::Ordering::SeqCst)
        {
            return Err(std::io::Error::other("the database is full").into());
        }
        self.call(|store| store.append_log(name, len, bytes)).await
    }

    async fn replace_log_async(
        &self,
        name: &str,
        len: u64,
        bytes: &[u8],
    ) -> Result<(), LogWriteError> {
        self.call(|store| store.replace_log(name, len, bytes)).await
    }

    async fn read_file_async(&self, name: &str) -> std::io::Result<Vec<u8>> {
        self.call(|store| store.read_file(name)).await
    }

    async fn write_file_async(&self, name: &str, bytes: &[u8]) -> std::io::Result<()> {
        self.call(|store| store.write_file(name, bytes)).await
    }
}

/// Polls `work` up to `polls` times; its output if it finished.
fn poll<T>(work: impl Future<Output = T>, polls: usize) -> Option<T> {
    let mut work = std::pin::pin!(work);
    let mut cx = std::task::Context::from_waker(std::task::Waker::noop());
    (0..polls).find_map(|_| match work.as_mut().poll(&mut cx) {
        std::task::Poll::Ready(output) => Some(output),
        std::task::Poll::Pending => None,
    })
}

#[test]
fn an_async_store_keeps_a_conversation_as_a_local_one_does() {
    let remote = Remote::default();
    let mut conversation = edited();
    poll(super::save_async(&remote, "agent", &mut conversation), 100)
        .expect("finished")
        .expect("saved");
    let loaded = poll(super::load_async(&remote, "agent"), 100)
        .expect("finished")
        .expect("loaded");
    assert_eq!(loaded, conversation);
    assert_eq!(load(&remote.store, "agent").expect("read locally"), loaded);
    assert_eq!(
        crate::blobs::blob_names(&remote.store)
            .expect("blobs")
            .len(),
        1
    );
}

#[test]
fn a_save_cut_short_appends_nothing() {
    let remote = Remote::default();
    let mut conversation = Conversation::new();
    conversation.push(Message::user("first"));
    poll(super::save_async(&remote, "agent", &mut conversation), 100)
        .expect("finished")
        .expect("saved");
    let before = remote.store.read_log("agent").expect("a log");

    remote.held.store(true, std::sync::atomic::Ordering::SeqCst);
    let mut cut = conversation.clone();
    cut.extend([Message::assistant("a turn"), Message::user("cut short")]);
    assert!(poll(super::save_async(&remote, "agent", &mut cut), 100).is_none());
    assert_eq!(remote.store.read_log("agent").expect("a log"), before);

    remote
        .held
        .store(false, std::sync::atomic::Ordering::SeqCst);
    conversation.push(Message::assistant("the next turn"));
    poll(super::save_async(&remote, "agent", &mut conversation), 100)
        .expect("finished")
        .expect("saved after");
    let loaded = poll(super::load_async(&remote, "agent"), 100).expect("finished");
    assert_eq!(loaded.expect("loaded"), conversation);
}

/// A local store over a [`MemoryStore`] whose log reads wait for each other
/// in pairs once `armed`, whose blob reads fail while `unreadable` and
/// writes while `unwritable`, and whose next append to the log `refused`
/// fails.
#[derive(Default)]
struct Gate {
    store: MemoryStore,
    armed: std::sync::atomic::AtomicBool,
    paired: Option<std::sync::Barrier>,
    unreadable: std::sync::atomic::AtomicBool,
    unwritable: std::sync::atomic::AtomicBool,
    refused: std::sync::Mutex<Option<String>>,
}

impl Files for Gate {
    fn write_file(&self, name: &str, bytes: &[u8]) -> std::io::Result<()> {
        if self.unwritable.load(std::sync::atomic::Ordering::SeqCst) {
            return Err(std::io::Error::other("the disk is full"));
        }
        self.store.write_file(name, bytes)
    }

    fn append_file(&self, name: &str, bytes: &[u8]) -> std::io::Result<()> {
        self.store.append_file(name, bytes)
    }

    fn read_file(&self, name: &str) -> std::io::Result<Vec<u8>> {
        if self.unreadable.load(std::sync::atomic::Ordering::SeqCst) {
            return Err(std::io::Error::other("the disk is unplugged"));
        }
        self.store.read_file(name)
    }

    fn remove_file(&self, name: &str) -> std::io::Result<()> {
        self.store.remove_file(name)
    }

    fn files(&self) -> std::io::Result<Vec<String>> {
        self.store.files()
    }
}

impl Store for Gate {
    fn logs(&self) -> std::io::Result<Vec<String>> {
        self.store.logs()
    }

    fn read_log(&self, name: &str) -> std::io::Result<Vec<u8>> {
        if self.armed.load(std::sync::atomic::Ordering::SeqCst)
            && let Some(paired) = &self.paired
        {
            paired.wait();
        }
        self.store.read_log(name)
    }

    fn append_log(&self, name: &str, len: u64, bytes: &[u8]) -> Result<(), LogWriteError> {
        let mut refused = self.refused.lock().expect("the refused log");
        if refused.as_deref() == Some(name) {
            *refused = None;
            return Err(std::io::Error::other("the database is full").into());
        }
        self.store.append_log(name, len, bytes)
    }

    fn replace_log(&self, name: &str, len: u64, bytes: &[u8]) -> Result<(), LogWriteError> {
        self.store.replace_log(name, len, bytes)
    }

    fn destroy(&self) -> std::io::Result<()> {
        self.store.destroy()
    }
}

/// Two saves that read the log at the same moment: the store appends the
/// first and refuses the second, whose conversation keeps its change.
#[test]
fn overlapping_saves_store_one_and_refuse_the_other() {
    let gate = Arc::new(Gate {
        paired: Some(std::sync::Barrier::new(2)),
        ..Gate::default()
    });
    let mut base = load(&*gate, "user-1").expect("an empty log");
    base.push(Message::user("base"));
    save(&*gate, "user-1", &mut base).expect("saved");
    gate.armed.store(true, std::sync::atomic::Ordering::SeqCst);
    let saves: Vec<_> = ["one", "two"]
        .map(|text| {
            let (gate, mut conversation) = (gate.clone(), base.clone());
            std::thread::spawn(move || {
                conversation.push(Message::user(text));
                let saved = save(&*gate, "user-1", &mut conversation);
                (text, saved, conversation)
            })
        })
        .into_iter()
        .map(|save| save.join().expect("a save"))
        .collect();
    gate.armed.store(false, std::sync::atomic::Ordering::SeqCst);
    let won: Vec<_> = saves.iter().filter(|(_, saved, _)| saved.is_ok()).collect();
    let lost: Vec<_> = saves
        .iter()
        .filter(|(_, saved, _)| saved.is_err())
        .collect();
    let ([(winner, ..)], [(_, refused, loser)]) = (won.as_slice(), lost.as_slice()) else {
        panic!("one save stored and one refused: {saves:?}");
    };
    assert!(
        matches!(refused, Err(SessionError::Changed { log }) if log == "user-1"),
        "{refused:?}"
    );
    assert_eq!(
        load(&*gate, "user-1").expect("the log reads").messages(),
        [Message::user("base"), Message::user(*winner)].map(Arc::new)
    );
    assert_eq!(loser.unsaved().len(), 1, "the refused change is kept");
}

/// A save reads its own log only, so another log that does not read does
/// not stop it.
#[test]
fn a_save_reads_only_its_log() {
    let store = MemoryStore::default();
    store
        .append_log("other", 0, b"{\"not\":\"a log\"}\n")
        .expect("written");
    let mut conversation = load(&store, "user-1").expect("an empty log");
    conversation.push(Message::user("hello"));
    let saved = save(&store, "user-1", &mut conversation);
    assert!(saved.is_ok(), "{saved:?}");
    assert_eq!(load(&store, "user-1").expect("loaded"), conversation);
}

/// A save whose append failed leaves the conversation unsaved, so the
/// same save tried again stores it.
#[test]
fn a_failed_save_can_be_retried() {
    let remote = Remote::default();
    let mut conversation = Conversation::from_messages([Message::user("hello")]);
    poll(super::save_async(&remote, "agent", &mut conversation), 100)
        .expect("finished")
        .expect("saved");
    conversation.push(Message::assistant("hi"));
    remote
        .fail_once
        .store(true, std::sync::atomic::Ordering::SeqCst);
    let failed = poll(super::save_async(&remote, "agent", &mut conversation), 100);
    assert!(
        matches!(failed, Some(Err(SessionError::Io(_)))),
        "{failed:?}"
    );
    let retried = poll(super::save_async(&remote, "agent", &mut conversation), 100);
    assert!(matches!(retried, Some(Ok(()))), "{retried:?}");
    assert_eq!(load(&remote.store, "agent").expect("loaded"), conversation);
}

/// An image whose blob cannot be read for any reason but its absence fails
/// the load, synchronous or not, and the read of that agent's conversation
/// however it is chosen; a blob that is gone loads as a placeholder.
#[test]
fn a_failed_image_read_fails_the_load() {
    let gate = Gate::default();
    let mut conversation = edited();
    save(&gate, "agent", &mut conversation).expect("saved");
    gate.unreadable
        .store(true, std::sync::atomic::Ordering::SeqCst);
    assert!(matches!(load(&gate, "agent"), Err(SessionError::Io(_))));
    let loaded = poll(super::load_async(&gate, "agent"), 1).expect("finished");
    assert!(matches!(loaded, Err(SessionError::Io(_))), "{loaded:?}");
    for agent in [Some("agent"), None] {
        let read = crate::read_conversation(&gate, agent);
        assert!(matches!(read, Err(SessionError::Io(_))), "{read:?}");
    }

    gate.unreadable
        .store(false, std::sync::atomic::Ordering::SeqCst);
    for blob in crate::blobs::blob_names(&gate.store).expect("blobs") {
        gate.store
            .remove_file(&format!("{}{blob}", crate::BLOBS))
            .expect("removed");
    }
    let loaded = load(&gate, "agent").expect("a missing blob is a placeholder");
    assert_eq!(loaded.messages().len(), conversation.messages().len());
}

/// A missing blob does not hide a later image's failed read: the load
/// fails, as it does when that read comes first.
#[test]
fn a_missing_blob_does_not_hide_a_failed_read() {
    let mut message = Message::User {
        content: vec![
            UserContent::image_url("blob:gone.png", Some(ImageMediaType::PNG), None),
            UserContent::image_url("blob:unread.png", Some(ImageMediaType::PNG), None),
        ],
    };
    let failed = crate::blobs::load_images_with(&mut message, &|name| {
        Err(match name {
            "gone.png" => std::io::ErrorKind::NotFound.into(),
            _ => std::io::Error::other("the disk is unplugged"),
        })
    });
    let kind = failed.map_err(|failure| failure.kind());
    assert_eq!(kind, Err(std::io::ErrorKind::Other));
}

/// A session save that fails keeps the unsaved changes of every agent
/// whose log was not written, and only those, so the same save tried
/// again stores each change once: after a blob write fails, after an
/// append is refused, and after a subagent's log was written and its
/// parent's append is refused.
#[test]
fn a_failed_session_save_can_be_retried() {
    let gate = Gate::default();
    let mut session = Session::default();
    for (id, parent) in [("main", None), ("child", Some("main"))] {
        session.agents.push(SavedAgent {
            id: id.into(),
            parent: parent.map(str::to_owned),
            conversation: Conversation::from_messages([Message::user("hello")]),
            ..SavedAgent::default()
        });
    }
    session.save(&gate).expect("saved");
    let push = |session: &mut Session, id: &str, message: Message| {
        let agent = session.agent_mut(id).expect("an agent");
        agent.conversation.push(message);
    };
    let stored = |session: &Session| {
        for agent in &session.agents {
            assert_eq!(load(&gate, &agent.id).expect("loaded"), agent.conversation);
        }
    };
    let image = Message::User {
        content: vec![UserContent::image_base64(
            "cG5n",
            Some(ImageMediaType::PNG),
            None,
        )],
    };

    push(&mut session, "main", image);
    gate.unwritable
        .store(true, std::sync::atomic::Ordering::SeqCst);
    assert!(session.save(&gate).is_err());
    gate.unwritable
        .store(false, std::sync::atomic::Ordering::SeqCst);
    session
        .save(&gate)
        .expect("saved after a failed blob write");
    stored(&session);

    push(&mut session, "main", Message::assistant("a cat"));
    *gate.refused.lock().expect("the refused log") = Some("main".into());
    assert!(session.save(&gate).is_err());
    session.save(&gate).expect("saved after a refused append");
    stored(&session);

    push(&mut session, "child", Message::assistant("done"));
    push(&mut session, "main", Message::user("go on"));
    *gate.refused.lock().expect("the refused log") = Some("main".into());
    assert!(session.save(&gate).is_err());
    session
        .save(&gate)
        .expect("saved after the parent's refused append");
    stored(&session);
}

/// Every log of `store`, by name, as stored.
fn logs_of(store: &dyn Store) -> Vec<(String, Vec<u8>)> {
    let names = store.logs().expect("the logs").into_iter();
    names
        .map(|name| (store.read_log(&name).expect("a log"), name))
        .map(|(bytes, name)| (name, bytes))
        .collect()
}

/// A session read before another save, or before a rewrite, is refused
/// whole and writes nothing, not even a new agent's log: saving it would
/// put back what the newer save or the rewrite took out. A session read
/// after them, and one that saved, save again.
#[test]
fn a_stale_session_is_refused_before_it_writes() {
    let redact = crate::Strings(|text: &mut String| {
        let found = text.contains("secret");
        *text = text.replace("secret", "[gone]");
        found
    });
    let newer: [&dyn Fn(&mut Session, &dyn Store); 4] = [
        &|session, _| {
            session.saved.insert("added".into(), json!(1));
        },
        &|session, _| {
            let agent = session.agent_mut("main").expect("main");
            agent.saved.insert("key".into(), json!("newer"));
        },
        &|session, _| session.agent_mut("main").expect("main").retired = true,
        &|session, store| {
            crate::rewrite(store, Author::plugin("redact"), &redact).expect("rewritten");
            *session = Session::read(store).expect("read");
        },
    ];
    for change in newer {
        let store = MemoryStore::default();
        let mut first = Session::default();
        first.agents.push(SavedAgent {
            id: "main".into(),
            saved: [("key".into(), json!("older"))].into(),
            ..SavedAgent::default()
        });
        first.saved.insert("token".into(), json!("secret"));
        first.save(&store).expect("saved");
        let mut stale = Session::read(&store).expect("read");
        let mut other = Session::read(&store).expect("read");
        change(&mut other, &store);
        other.save(&store).expect("the newer save");
        stale.agents.push(SavedAgent {
            id: "unsaved".into(),
            conversation: Conversation::from_messages([Message::user("unsaved")]),
            ..SavedAgent::default()
        });
        let before = logs_of(&store);

        assert!(matches!(
            stale.save(&store),
            Err(SessionError::Changed { .. })
        ));
        assert_eq!(logs_of(&store), before);
        other.saved.insert("again".into(), json!(true));
        other
            .save(&store)
            .expect("a session that saved saves again");
        let mut fresh = Session::read(&store).expect("read");
        fresh.save(&store).expect("a fresh session saves");
        assert_eq!(fresh.saved.get("again"), Some(&json!(true)));
    }
}

/// A session a writer opened saves, though it leaves a retired agent out.
#[test]
fn a_session_a_writer_opened_saves() {
    let store: Arc<dyn Store> = Arc::new(MemoryStore::default());
    let mut first = Session::default();
    for id in ["main", "old"] {
        first.agents.push(SavedAgent {
            id: id.into(),
            conversation: Conversation::from_messages([Message::user(id)]),
            retired: id == "old",
            ..SavedAgent::default()
        });
    }
    first.saved.insert("token".into(), json!("secret"));
    first.save(&*store).expect("saved");
    let (_writer, mut opened) = Writer::open(store.clone()).expect("opened");
    assert!(opened.agent("old").is_none());
    opened.saved.insert("more".into(), json!(1));
    opened.save(&*store).expect("an opened session saves");
}

/// Saving refuses a log with a second header, as loading does, rather than
/// appending to it.
#[test]
fn saving_refuses_a_log_with_a_second_header() {
    let store = MemoryStore::default();
    let mut conversation = load(&store, "agent").expect("an empty log");
    conversation.push(Message::user("first"));
    save(&store, "agent", &mut conversation).expect("saved");
    let log = store.read_log("agent").expect("a log");
    let end = log.iter().position(|byte| *byte == b'\n').expect("a line") + 1;
    let header = log.get(..end).expect("a header").to_vec();
    append(&store, "agent", &header).expect("a second header appended");
    let refused = load(&store, "agent").expect_err("loading refuses it");
    assert!(refused.to_string().contains("a second header"), "{refused}");
    conversation.push(Message::user("second"));
    let saved = save(&store, "agent", &mut conversation);
    assert!(saved.is_err(), "save appended to a log that load refuses");
}