vaegram 0.2.0

Telegram MTProto client library for users and bots
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
use std::collections::HashMap;
use std::io;
use std::pin::Pin;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, MutexGuard, OnceLock, PoisonError, mpsc as std_mpsc};
use std::time::Duration;

use tokio::sync::{Notify, mpsc, oneshot};

use super::{PeerRecord, SessionData, Storage, StoredState, UpdateState};
use crate::enums::ClientEvent;
use crate::session::{Events, Salt};

const FLUSH_EVERY: Duration = Duration::from_secs(5);
const FLUSH_AT: usize = 512;
const DROP_WAIT: Duration = Duration::from_secs(10);
/// The newest peers loaded into memory at startup; older ones come from the engine when asked for.
pub(crate) const WARM_PEERS: usize = 4096;

type Job = Box<dyn FnOnce(Arc<dyn Storage>) -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>;

enum Message {
    Run(Job),
    Flush(oneshot::Sender<()>),
    Finish(std_mpsc::Sender<()>),
}

/// Writes waiting for the next flush: peers coalesced by id, the newest state, and a salt to save under the
/// state already saved when there is no state to queue.
#[derive(Default)]
struct Queued {
    peers: HashMap<i64, PeerRecord>,
    state: Option<StoredState>,
    salt: Option<(i64, Salt)>,
    // Set by log_out: nothing queued or still to come may write the old account back.
    dead: bool,
}

#[derive(Default)]
struct Pending {
    queued: Mutex<Queued>,
    full: Notify,
}

impl Pending {
    fn lock(&self) -> MutexGuard<'_, Queued> {
        self.queued.lock().unwrap_or_else(PoisonError::into_inner)
    }
}

/// A client's storage engine, run on a thread of its own with its own runtime, so engines may block or await as
/// they like, the caller's runtime is never blocked on, and dropping the client can still save on any runtime.
pub(crate) struct Store {
    engine: Arc<dyn Storage>,
    pending: Arc<Pending>,
    // Where the thread reports what it can't write; the engine's failures never stop the client.
    events: Arc<Events>,
    worker: OnceLock<io::Result<mpsc::UnboundedSender<Message>>>,
    // Set by the first `finish`; the engine is closed for good after it.
    finished: AtomicBool,
}

impl Store {
    pub(crate) fn new(engine: Arc<dyn Storage>, events: Arc<Events>) -> Store {
        Store { engine, pending: Arc::default(), events, worker: OnceLock::new(), finished: AtomicBool::new(false) }
    }

    fn worker(&self) -> io::Result<&mpsc::UnboundedSender<Message>> {
        // Also when `finish` came before the thread ever started: a closed store never starts one.
        if self.finished.load(Ordering::Acquire) {
            return Err(stopped());
        }
        self.start()
    }

    /// Starts the store thread if it isn't running yet, finished or not.
    fn start(&self) -> io::Result<&mpsc::UnboundedSender<Message>> {
        let worker = self.worker.get_or_init(|| {
            let (tx, rx) = mpsc::unbounded_channel();
            let (engine, pending, events) = (self.engine.clone(), self.pending.clone(), self.events.clone());
            let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build()?;
            std::thread::Builder::new()
                .name("vaegram-store".into())
                .spawn(move || runtime.block_on(work(engine, pending, events, rx)))?;
            Ok(tx)
        });
        worker.as_ref().map_err(|e| io::Error::new(e.kind(), format!("couldn't start the store thread: {e}")))
    }

    fn started(&self) -> bool {
        self.worker.get().is_some()
    }

    #[cfg(test)]
    pub(crate) fn pending_is_empty(&self) -> bool {
        let queued = self.pending.lock();
        queued.peers.is_empty() && queued.state.is_none() && queued.salt.is_none()
    }

    /// Runs `f` on the store thread and returns what it gives.
    pub(crate) async fn call<T, F>(&self, f: impl FnOnce(Arc<dyn Storage>) -> F + Send + 'static) -> io::Result<T>
    where
        T: Send + 'static,
        F: Future<Output = io::Result<T>> + Send + 'static,
    {
        let (tx, rx) = oneshot::channel();
        let job: Job = Box::new(move |engine: Arc<dyn Storage>| -> Pin<Box<dyn Future<Output = ()> + Send>> {
            Box::pin(async move {
                let _ = tx.send(f(engine).await);
            })
        });
        self.worker()?.send(Message::Run(job)).map_err(|_| stopped())?;
        rx.await.map_err(|_| io::Error::other("the storage engine call didn't finish"))?
    }

    pub(crate) async fn open(&self) -> io::Result<()> {
        // Before it opens, so what the engine finds while opening is reported too.
        let events = self.events.clone();
        self.engine
            .set_reporter(Arc::new(move |error| events.warn(ClientEvent::StorageFailed { error: Arc::new(error) })));
        self.call(|e| async move { e.open().await }).await
    }

    pub(crate) async fn load_session(&self) -> io::Result<Option<SessionData>> {
        self.call(|e| async move { e.load_session().await }).await
    }

    /// The update state and salt saved for `user_id`. Another account's state, and every peer it saved, is
    /// dropped.
    pub(crate) async fn load_state(&self, user_id: i64) -> io::Result<(Option<UpdateState>, Salt)> {
        self.call(move |e| async move {
            match e.load_state().await? {
                Some(s) if s.owner == user_id => Ok((s.update, s.salt)),
                Some(_) => {
                    e.clear_peers().await?;
                    Ok(Default::default())
                }
                None => Ok(Default::default()),
            }
        })
        .await
    }

    pub(crate) async fn warm(&self) -> io::Result<Vec<PeerRecord>> {
        self.call(|e| async move { e.export_peers(Some(WARM_PEERS)).await }).await
    }

    // Each lookup checks the peers queued for the next flush first: the peer cache can let go of one the engine
    // doesn't have yet. A flush runs on the store thread like the lookup, so a peer is always in one or the other.
    pub(crate) async fn get_peer(&self, id: i64) -> io::Result<Option<PeerRecord>> {
        if let Some(queued) = self.pending.lock().peers.get(&id) {
            return Ok(Some(queued.clone()));
        }
        self.call(move |e| async move { e.get_peer_by_id(id).await }).await
    }

    pub(crate) async fn get_peer_by_username(&self, username: String) -> io::Result<Option<PeerRecord>> {
        if let Some(queued) = self.queued(|p| p.usernames.iter().any(|u| u.eq_ignore_ascii_case(&username))) {
            return Ok(Some(queued));
        }
        self.call(move |e| async move { e.get_peer_by_username(&username).await }).await
    }

    pub(crate) async fn get_peer_by_phone_number(&self, phone_number: String) -> io::Result<Option<PeerRecord>> {
        if let Some(queued) = self.queued(|p| p.phone_number.as_ref() == Some(&phone_number)) {
            return Ok(Some(queued));
        }
        self.call(move |e| async move { e.get_peer_by_phone_number(&phone_number).await }).await
    }

    /// The newest queued peer `found` picks, as the engine would pick among its own.
    fn queued(&self, found: impl Fn(&PeerRecord) -> bool) -> Option<PeerRecord> {
        self.pending.lock().peers.values().filter(|p| found(p)).max_by_key(|p| (p.updated, p.id)).cloned()
    }

    pub(crate) async fn save_session(&self, session: SessionData) -> io::Result<()> {
        let pending = self.pending.clone();
        self.call(move |e| async move {
            // Checked on the store thread, after every job queued before log_out ran.
            if pending.lock().dead {
                return Ok(());
            }
            e.save_session(&session).await
        })
        .await
    }

    /// Queues peers for the next flush; a peer queued twice is written once, as last queued.
    pub(crate) fn queue_peers(&self, peers: impl IntoIterator<Item = PeerRecord>) {
        let full = {
            let mut queued = self.pending.lock();
            if queued.dead {
                return;
            }
            queued.peers.extend(peers.into_iter().map(|p| (p.id, p)));
            queued.peers.len() >= FLUSH_AT
        };
        self.start_flushing();
        if full {
            self.pending.full.notify_one();
        }
    }

    pub(crate) fn queue_state(&self, state: StoredState) {
        {
            let mut queued = self.pending.lock();
            if queued.dead {
                return;
            }
            queued.salt = None;
            queued.state = Some(state);
        }
        self.start_flushing();
    }

    /// Queues `owner`'s salt alone, keeping the update state saved for them.
    pub(crate) fn queue_salt(&self, owner: i64, salt: Salt) {
        {
            let mut queued = self.pending.lock();
            if queued.dead {
                return;
            }
            match &mut queued.state {
                Some(state) if state.owner == owner => state.salt = salt,
                _ => queued.salt = Some((owner, salt)),
            }
        }
        self.start_flushing();
    }

    fn start_flushing(&self) {
        // A finished store writes nothing more; what is queued after it stays in memory.
        if self.finished.load(Ordering::Acquire) {
            return;
        }
        if let Err(e) = self.worker() {
            self.events.storage_failed(e.kind(), format_args!("{e}; saves wait until it starts"));
        }
    }

    /// Returns once everything queued so far is written, or has failed and been queued again.
    pub(crate) async fn flush(&self) {
        if !self.started() {
            return;
        }
        let (tx, rx) = oneshot::channel();
        if self.worker().and_then(|w| w.send(Message::Flush(tx)).map_err(|_| stopped())).is_ok() {
            let _ = rx.await;
        }
    }

    /// Forgets the session, the state and every peer, and stops any write queued or still to come.
    pub(crate) async fn delete(&self) -> io::Result<()> {
        {
            let mut queued = self.pending.lock();
            queued.dead = true;
            queued.peers.clear();
            queued.state = None;
            queued.salt = None;
        }
        self.call(|e| async move { e.delete().await }).await
    }

    /// Queues `state`, writes what is queued and closes the engine, waiting at most `DROP_WAIT`. Called when the
    /// client is disconnected or dropped, from whatever thread does it. Only the first call does anything: the store
    /// thread ends with it, so later calls to the engine fail and later writes are dropped.
    pub(crate) fn finish(&self, state: Option<StoredState>) {
        if self.finished.swap(true, Ordering::AcqRel) {
            return;
        }
        let worker = match state {
            Some(state) => {
                self.queue_state(state);
                // The last state is saved even when nothing started the thread before.
                match self.start() {
                    Ok(worker) => worker,
                    Err(e) => {
                        self.events.storage_failed(e.kind(), format_args!("{e}; the last update state isn't saved"));
                        return;
                    }
                }
            }
            None => match self.worker.get() {
                Some(Ok(worker)) => worker,
                _ => return,
            },
        };
        let (tx, rx) = std_mpsc::channel();
        if worker.send(Message::Finish(tx)).is_ok() && rx.recv_timeout(DROP_WAIT).is_err() {
            self.events.storage_failed(
                io::ErrorKind::TimedOut,
                format_args!("the storage engine didn't finish saving within {DROP_WAIT:?}; giving up on it"),
            );
        }
    }
}

fn stopped() -> io::Error {
    io::Error::other("the store thread stopped")
}

async fn work(
    engine: Arc<dyn Storage>,
    pending: Arc<Pending>,
    events: Arc<Events>,
    mut rx: mpsc::UnboundedReceiver<Message>,
) {
    let mut tick = tokio::time::interval(FLUSH_EVERY);
    tick.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
    tick.tick().await;
    let save = || isolated(&events, flush(engine.clone(), pending.clone(), events.clone()), "while saving");
    loop {
        tokio::select! {
            message = rx.recv() => match message {
                Some(Message::Run(job)) => isolated(&events, job(engine.clone()), "in a call").await,
                Some(Message::Flush(done)) => {
                    save().await;
                    let _ = done.send(());
                }
                Some(Message::Finish(done)) => {
                    save().await;
                    isolated(&events, close(engine.clone(), events.clone()), "while closing").await;
                    let _ = done.send(());
                    return;
                }
                None => {
                    save().await;
                    return isolated(&events, close(engine.clone(), events.clone()), "while closing").await;
                }
            },
            _ = tick.tick() => save().await,
            _ = pending.full.notified() => save().await,
        }
    }
}

/// Runs `task` as a task of its own, so an engine that panics fails that one job, not the store thread.
async fn isolated(events: &Events, task: impl Future<Output = ()> + Send + 'static, what: &str) {
    if let Err(e) = tokio::spawn(task).await {
        let why = format!("the storage engine panicked {what}: {e}; the store keeps going");
        events.storage_failed(io::ErrorKind::Other, why);
    }
}

async fn close(engine: Arc<dyn Storage>, events: Arc<Events>) {
    if let Err(e) = engine.close().await {
        events.storage_failed(e.kind(), format_args!("failed to close the storage engine: {e}"));
    }
}

async fn flush(engine: Arc<dyn Storage>, pending: Arc<Pending>, events: Arc<Events>) {
    let peers: Vec<PeerRecord> = std::mem::take(&mut pending.lock().peers).into_values().collect();
    if !peers.is_empty() && !pending.lock().dead {
        if let Err(e) = engine.update_peers(&peers).await {
            events.storage_failed(e.kind(), format_args!("failed to save {} known chats: {e}", peers.len()));
            // Back in the queue, unless a newer record of the same peer arrived meanwhile.
            let mut queued = pending.lock();
            for p in peers {
                queued.peers.entry(p.id).or_insert(p);
            }
        }
    }
    let state = pending.lock().state.take();
    if let Some(state) = state.filter(|_| !pending.lock().dead) {
        if let Err(e) = engine.save_state(&state).await {
            events.storage_failed(e.kind(), format_args!("failed to save the update state: {e}"));
            pending.lock().state.get_or_insert(state);
        }
    }
    let salt = pending.lock().salt.take();
    if let Some((owner, salt)) = salt.filter(|_| !pending.lock().dead) {
        if let Err(e) = save_salt(&*engine, owner, salt).await {
            events.storage_failed(e.kind(), format_args!("failed to save the server salt: {e}"));
            let mut queued = pending.lock();
            if queued.state.is_none() {
                queued.salt.get_or_insert((owner, salt));
            }
        }
    }
}

async fn save_salt(engine: &dyn Storage, owner: i64, salt: Salt) -> io::Result<()> {
    let update = engine.load_state().await?.filter(|s| s.owner == owner).and_then(|s| s.update);
    engine.save_state(&StoredState::new(owner, salt, update)).await
}

/// An engine over memory that records every call and can be told to fail them all.
#[cfg(test)]
#[derive(Default)]
pub(crate) struct Recording {
    calls: Mutex<Vec<&'static str>>,
    inner: super::MemoryStorage,
    fail: bool,
    // Reports "the engine warns" when it opens, as an engine that finds something wrong with its data would.
    warns: bool,
    reports: super::Reports,
}

#[cfg(test)]
impl Recording {
    pub(crate) fn failing() -> Recording {
        Recording { fail: true, ..Recording::default() }
    }

    pub(crate) fn warning() -> Recording {
        Recording { warns: true, ..Recording::default() }
    }

    pub(crate) fn calls(&self) -> Vec<&'static str> {
        self.calls.lock().unwrap().clone()
    }

    fn call(&self, name: &'static str) -> io::Result<()> {
        self.calls.lock().unwrap().push(name);
        if self.fail { Err(io::Error::other("store is down")) } else { Ok(()) }
    }
}

#[cfg(test)]
impl Storage for Recording {
    fn set_reporter(&self, reporter: super::StorageReporter) {
        self.reports.set(reporter);
    }

    fn open(&self) -> super::StorageFuture<'_, ()> {
        Box::pin(async move {
            if self.warns {
                self.reports.report(io::Error::other("the engine warns"));
            }
            self.call("open")
        })
    }

    fn close(&self) -> super::StorageFuture<'_, ()> {
        Box::pin(async move { self.call("close") })
    }

    fn delete(&self) -> super::StorageFuture<'_, ()> {
        Box::pin(async move {
            self.call("delete")?;
            self.inner.delete().await
        })
    }

    fn load_session(&self) -> super::StorageFuture<'_, Option<SessionData>> {
        Box::pin(async move {
            self.call("load_session")?;
            self.inner.load_session().await
        })
    }

    fn save_session<'a>(&'a self, session: &'a SessionData) -> super::StorageFuture<'a, ()> {
        Box::pin(async move {
            self.call("save_session")?;
            self.inner.save_session(session).await
        })
    }

    fn load_state(&self) -> super::StorageFuture<'_, Option<StoredState>> {
        Box::pin(async move {
            self.call("load_state")?;
            self.inner.load_state().await
        })
    }

    fn save_state<'a>(&'a self, state: &'a StoredState) -> super::StorageFuture<'a, ()> {
        Box::pin(async move {
            self.call("save_state")?;
            self.inner.save_state(state).await
        })
    }

    fn update_peers<'a>(&'a self, peers: &'a [PeerRecord]) -> super::StorageFuture<'a, ()> {
        Box::pin(async move {
            self.call("update_peers")?;
            self.inner.update_peers(peers).await
        })
    }

    fn get_peer_by_username<'a>(&'a self, username: &'a str) -> super::StorageFuture<'a, Option<PeerRecord>> {
        Box::pin(async move {
            self.call("get_peer_by_username")?;
            self.inner.get_peer_by_username(username).await
        })
    }

    fn get_peer_by_phone_number<'a>(&'a self, phone_number: &'a str) -> super::StorageFuture<'a, Option<PeerRecord>> {
        Box::pin(async move {
            self.call("get_peer_by_phone_number")?;
            self.inner.get_peer_by_phone_number(phone_number).await
        })
    }

    fn get_peer_by_id(&self, id: i64) -> super::StorageFuture<'_, Option<PeerRecord>> {
        Box::pin(async move {
            self.call("get_peer_by_id")?;
            self.inner.get_peer_by_id(id).await
        })
    }

    fn export_peers(&self, limit: Option<usize>) -> super::StorageFuture<'_, Vec<PeerRecord>> {
        Box::pin(async move {
            self.call("export_peers")?;
            self.inner.export_peers(limit).await
        })
    }

    fn clear_peers(&self) -> super::StorageFuture<'_, ()> {
        Box::pin(async move {
            self.call("clear_peers")?;
            self.inner.clear_peers().await
        })
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicBool, Ordering};
    use std::time::Duration;

    use super::{Recording, Store};
    use crate::enums::ClientEvent;
    use crate::session::{Events, Salt};
    use crate::storage::{MemoryStorage, PeerRecord, Storage, StorageFuture, StoredState, UpdateState};

    fn state(pts: i32) -> StoredState {
        StoredState::new(7, Salt::default(), Some(UpdateState { pts, date: 1, ..UpdateState::default() }))
    }

    #[tokio::test]
    async fn jobs_run_on_the_store_thread() {
        let store = Store::new(Arc::new(MemoryStorage::new()), Arc::default());
        let name = store.call(|_| async { Ok(std::thread::current().name().map(str::to_owned)) }).await.unwrap();
        assert_eq!(name.as_deref(), Some("vaegram-store"));
        assert_ne!(std::thread::current().name(), Some("vaegram-store"));
    }

    #[tokio::test]
    async fn peers_are_coalesced_by_id() {
        let engine = Arc::new(Recording::default());
        let store = Store::new(engine.clone(), Arc::default());
        let mut newer = PeerRecord::new(1, 2);
        newer.updated = 5;
        store.queue_peers([PeerRecord::new(1, 1), PeerRecord::new(2, 1)]);
        store.queue_peers([newer.clone()]);
        store.flush().await;
        assert_eq!(engine.calls(), ["update_peers"], "one write for the batch");
        let saved = engine.export_peers(None).await.unwrap();
        assert_eq!(saved, [newer, PeerRecord::new(2, 1)]);
    }

    #[tokio::test]
    async fn a_failed_flush_keeps_the_writes_queued() {
        let store = Store::new(Arc::new(Recording::failing()), Arc::default());
        store.queue_peers([PeerRecord::new(1, 1)]);
        store.queue_state(state(3));
        store.flush().await;
        let queued = store.pending.lock();
        assert_eq!(
            (queued.peers.len(), queued.state.as_ref().and_then(|s| s.update.as_ref()).map(|u| u.pts)),
            (1, Some(3))
        );
    }

    #[tokio::test]
    async fn a_failed_save_reaches_the_event_listener() {
        let events = Arc::new(Events::default());
        let got = events.record();
        let store = Store::new(Arc::new(Recording::failing()), events);
        store.queue_state(state(3));
        store.flush().await;
        let got: Vec<ClientEvent> = got.try_iter().collect();
        let [ClientEvent::StorageFailed { error }] = &got[..] else { panic!("{got:?}") };
        assert_eq!(error.to_string(), "failed to save the update state: store is down");
    }

    #[tokio::test]
    async fn what_an_engine_reports_reaches_the_event_listener() {
        let events = Arc::new(Events::default());
        let got = events.record();
        let store = Store::new(Arc::new(Recording::warning()), events);
        store.open().await.unwrap();
        let got: Vec<ClientEvent> = got.try_iter().collect();
        let [ClientEvent::StorageFailed { error }] = &got[..] else { panic!("{got:?}") };
        assert_eq!(error.to_string(), "the engine warns");
    }

    #[tokio::test]
    async fn drop_flushes_the_last_state() {
        let engine = Arc::new(MemoryStorage::new());
        let store = Store::new(engine.clone(), Arc::default());
        store.queue_peers([PeerRecord::new(1, 1)]);
        let saved = tokio::task::spawn_blocking(move || store.finish(Some(state(9)))).await;
        saved.unwrap();
        assert_eq!(engine.load_state().await.unwrap(), Some(state(9)));
        assert_eq!(engine.export_peers(None).await.unwrap().len(), 1);
    }

    #[tokio::test]
    async fn a_store_finished_before_it_started_never_touches_the_engine() {
        let engine = Arc::new(Recording::default());
        let store = Store::new(engine.clone(), Arc::default());
        store.finish(None);
        store.queue_peers([PeerRecord::new(1, 1)]);
        let loaded = store.get_peer(2).await;
        store.flush().await;
        assert!(loaded.is_err(), "{loaded:?}");
        assert!(!store.started(), "a thread started after finish");
        assert!(engine.calls().is_empty(), "{:?}", engine.calls());
    }

    #[tokio::test]
    async fn a_store_that_never_worked_starts_no_thread_on_drop() {
        let store = Store::new(Arc::new(MemoryStorage::new()), Arc::default());
        store.finish(None);
        assert!(!store.started());
    }

    // An offline client, or one given its store with `set_store`, may never have started the thread.
    #[tokio::test]
    async fn finish_saves_the_last_state_of_a_store_that_never_started() {
        let engine = Arc::new(MemoryStorage::new());
        let store = Store::new(engine.clone(), Arc::default());
        tokio::task::spawn_blocking(move || store.finish(Some(state(9)))).await.unwrap();
        assert_eq!(engine.load_state().await.unwrap(), Some(state(9)));
    }

    /// Never finishes a state save.
    struct Stuck(MemoryStorage);

    impl Storage for Stuck {
        fn delete(&self) -> StorageFuture<'_, ()> {
            self.0.delete()
        }
        fn load_session(&self) -> StorageFuture<'_, Option<crate::storage::SessionData>> {
            self.0.load_session()
        }
        fn save_session<'a>(&'a self, s: &'a crate::storage::SessionData) -> StorageFuture<'a, ()> {
            self.0.save_session(s)
        }
        fn load_state(&self) -> StorageFuture<'_, Option<StoredState>> {
            self.0.load_state()
        }
        fn save_state<'a>(&'a self, _: &'a StoredState) -> StorageFuture<'a, ()> {
            Box::pin(std::future::pending())
        }
        fn update_peers<'a>(&'a self, p: &'a [PeerRecord]) -> StorageFuture<'a, ()> {
            self.0.update_peers(p)
        }
        fn get_peer_by_id(&self, id: i64) -> StorageFuture<'_, Option<PeerRecord>> {
            self.0.get_peer_by_id(id)
        }
        fn clear_peers(&self) -> StorageFuture<'_, ()> {
            self.0.clear_peers()
        }
    }

    #[tokio::test]
    async fn drop_gives_up_after_the_timeout() {
        let store = Store::new(Arc::new(Stuck(MemoryStorage::new())), Arc::default());
        store.queue_peers([PeerRecord::new(1, 1)]);
        let started = std::time::Instant::now();
        tokio::task::spawn_blocking(move || store.finish(Some(state(1)))).await.unwrap();
        let waited = started.elapsed();
        assert!(waited >= super::DROP_WAIT && waited < super::DROP_WAIT + Duration::from_secs(5), "{waited:?}");
    }

    #[tokio::test]
    async fn log_out_stops_queued_writes() {
        let engine = Arc::new(Recording::default());
        let store = Store::new(engine.clone(), Arc::default());
        store.queue_peers([PeerRecord::new(1, 1)]);
        store.queue_state(state(2));
        store.delete().await.unwrap();
        store.queue_peers([PeerRecord::new(2, 1)]);
        store.queue_state(state(3));
        let mut session = crate::storage::SessionData::new(2, [1; 256]);
        session.user_id = 7;
        store.save_session(session).await.unwrap();
        store.flush().await;
        assert_eq!(engine.calls(), ["delete"]);
    }

    #[tokio::test]
    async fn state_of_another_account_clears_peers() {
        let engine = Arc::new(MemoryStorage::new());
        engine.save_state(&state(4)).await.unwrap();
        engine.update_peers(&[PeerRecord::new(1, 1)]).await.unwrap();
        let store = Store::new(engine.clone(), Arc::default());
        let mine = store.load_state(7).await.unwrap();
        let other = store.load_state(8).await.unwrap();
        assert_eq!(mine.0.map(|u| u.pts), Some(4));
        assert_eq!(other, (None, Salt::default()));
        assert!(engine.export_peers(None).await.unwrap().is_empty());
    }

    #[tokio::test]
    async fn a_salt_alone_keeps_the_saved_update() {
        let engine = Arc::new(MemoryStorage::new());
        engine.save_state(&state(4)).await.unwrap();
        let store = Store::new(engine.clone(), Arc::default());
        let salt = Salt { value: 9, time_offset: 2 };
        store.queue_salt(7, salt);
        store.flush().await;
        assert_eq!(engine.load_state().await.unwrap(), Some(StoredState { salt, ..state(4) }));

        store.queue_salt(8, salt);
        store.flush().await;
        assert_eq!(engine.load_state().await.unwrap(), Some(StoredState::new(8, salt, None)));
        assert!(store.pending_is_empty());
    }

    #[tokio::test]
    async fn a_queued_state_takes_a_later_salt() {
        let engine = Arc::new(MemoryStorage::new());
        let store = Store::new(engine.clone(), Arc::default());
        let salt = Salt { value: 9, time_offset: 2 };
        store.queue_state(state(5));
        store.queue_salt(7, salt);
        store.flush().await;
        assert_eq!(engine.load_state().await.unwrap(), Some(StoredState { salt, ..state(5) }));
    }

    /// Panics on the first peer lookup and on the first peer write.
    #[derive(Default)]
    struct Panicky {
        inner: MemoryStorage,
        looked_up: AtomicBool,
        wrote: AtomicBool,
    }

    impl Storage for Panicky {
        fn delete(&self) -> StorageFuture<'_, ()> {
            self.inner.delete()
        }
        fn load_session(&self) -> StorageFuture<'_, Option<crate::storage::SessionData>> {
            self.inner.load_session()
        }
        fn save_session<'a>(&'a self, s: &'a crate::storage::SessionData) -> StorageFuture<'a, ()> {
            self.inner.save_session(s)
        }
        fn load_state(&self) -> StorageFuture<'_, Option<StoredState>> {
            self.inner.load_state()
        }
        fn save_state<'a>(&'a self, s: &'a StoredState) -> StorageFuture<'a, ()> {
            self.inner.save_state(s)
        }
        fn update_peers<'a>(&'a self, p: &'a [PeerRecord]) -> StorageFuture<'a, ()> {
            assert!(self.wrote.swap(true, Ordering::SeqCst), "engine bug");
            self.inner.update_peers(p)
        }
        fn get_peer_by_id(&self, id: i64) -> StorageFuture<'_, Option<PeerRecord>> {
            assert!(self.looked_up.swap(true, Ordering::SeqCst), "engine bug");
            self.inner.get_peer_by_id(id)
        }
        fn clear_peers(&self) -> StorageFuture<'_, ()> {
            self.inner.clear_peers()
        }
    }

    #[tokio::test]
    async fn a_panicking_engine_fails_one_job_and_the_store_keeps_going() {
        let engine = Arc::new(Panicky::default());
        let store = Store::new(engine.clone(), Arc::default());
        assert!(store.get_peer(1).await.is_err());
        assert_eq!(store.get_peer(1).await.unwrap(), None);

        store.queue_peers([PeerRecord::new(1, 1)]);
        store.flush().await;
        store.queue_peers([PeerRecord::new(2, 1)]);
        store.flush().await;
        assert_eq!(engine.inner.export_peers(None).await.unwrap(), [PeerRecord::new(2, 1)]);
    }
}