subc-client-rs 0.32.1

Shared serve + consume client for Rust subc modules.
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
use super::*;
use std::task::{Context, Poll};
use tokio::io::{DuplexStream, ReadBuf};
use tokio::sync::Notify;

struct Echo;
#[async_trait]
impl ModuleHandler for Echo {
    async fn handle(&self, _ctx: RequestCtx, body: Vec<u8>) -> HandlerOutcome {
        HandlerOutcome::Response(body)
    }
}

#[derive(Clone, Default)]
struct EndRecorder(Arc<Mutex<Vec<ConnectionEnd>>>);

#[async_trait]
impl ModuleHandler for EndRecorder {
    async fn handle(&self, _ctx: RequestCtx, body: Vec<u8>) -> HandlerOutcome {
        HandlerOutcome::Response(body)
    }

    async fn on_connection_end(&self, end: ConnectionEnd) {
        self.0.lock().unwrap().push(end);
    }
}

fn ack() -> ModuleHelloAckBody {
    ModuleHelloAckBody {
        negotiated_ver: PROTOCOL_VERSION,
        subc_ops: Vec::new(),
        subc_capabilities: Vec::new(),
        storage: None,
        machine_id: None,
    }
}

fn start<R, W, H>(
    reader: R,
    writer: W,
    handler: H,
    options: ServeOptions,
) -> (
    ModuleHandle,
    tokio::task::JoinHandle<Result<(), SubcModuleError>>,
)
where
    R: AsyncRead + Unpin + Send + 'static,
    W: AsyncWrite + Unpin + Send + 'static,
    H: ModuleHandler,
{
    let (tx, rx) = mpsc::channel(EGRESS_BUFFER);
    let handle = ModuleHandle::new(
        &ack(),
        tx.clone(),
        123,
        CancellationToken::new(),
        tokio::runtime::Handle::current(),
    );
    handle.install_route(handle.route_handle(1, 1)).unwrap();
    let future = connection_serve_future_with_options(
        reader,
        tx,
        Arc::new(handler),
        handle.clone(),
        tokio::spawn(drain_writer(writer, rx)),
        options,
    );
    (handle, tokio::spawn(future))
}

fn connected<H: ModuleHandler>(
    handler: H,
    options: ServeOptions,
) -> (
    DuplexStream,
    tokio::task::JoinHandle<Result<(), SubcModuleError>>,
) {
    let (module, daemon) = tokio::io::duplex(64 * 1024);
    let (reader, writer) = tokio::io::split(module);
    let (_, future) = start(reader, writer, handler, options);
    (daemon, future)
}

async fn request(daemon: &mut DuplexStream) {
    let frame = Frame::build(
        FrameType::Request,
        data_flags(),
        1,
        1,
        42,
        b"request".to_vec(),
    )
    .unwrap();
    write_frame(daemon, &frame).await.unwrap();
}

async fn receive(daemon: &mut DuplexStream) -> Frame {
    timeout(Duration::from_secs(3), read_frame(daemon))
        .await
        .unwrap()
        .unwrap()
        .unwrap()
}

async fn connector(host: &str, bind: &str) {
    let listener = tokio::net::TcpListener::bind((bind, 0)).await.unwrap();
    let port = listener.local_addr().unwrap().port();
    let stream = connect_endpoint(host, port).await.unwrap();
    let (accepted, _) = listener.accept().await.unwrap();
    assert_eq!(stream.peer_addr().unwrap(), accepted.local_addr().unwrap());
}

#[tokio::test]
async fn connector_unbracketed_ipv6() {
    connector("::1", "::1").await;
}
#[tokio::test]
async fn connector_bracketed_ipv6() {
    connector("[::1]", "::1").await;
}
#[tokio::test]
async fn connector_ipv4() {
    connector("127.0.0.1", "127.0.0.1").await;
}
#[tokio::test]
async fn connector_localhost() {
    connector("localhost", "127.0.0.1").await;
}

#[test]
fn connector_uses_host_port_pair_without_string_formatting() {
    struct ConnectCalls(Vec<bool>);
    impl<'ast> syn::visit::Visit<'ast> for ConnectCalls {
        fn visit_expr_call(&mut self, call: &'ast syn::ExprCall) {
            if let syn::Expr::Path(path) = call.func.as_ref() {
                let segments = path
                    .path
                    .segments
                    .iter()
                    .map(|part| part.ident.to_string())
                    .collect::<Vec<_>>();
                if segments == ["TcpStream", "connect"] {
                    self.0.push(matches!(call.args.first(), Some(syn::Expr::Tuple(tuple)) if tuple.elems.len() == 2));
                }
            }
            syn::visit::visit_expr_call(self, call);
        }
    }
    let syntax = syn::parse_file(include_str!("lib.rs")).unwrap();
    let connector = syntax
        .items
        .iter()
        .find_map(|item| match item {
            syn::Item::Fn(function) if function.sig.ident == "connect_endpoint" => Some(function),
            _ => None,
        })
        .expect("connector exists");
    let mut calls = ConnectCalls(Vec::new());
    syn::visit::Visit::visit_item_fn(&mut calls, connector);
    assert_eq!(
        calls.0,
        [true],
        "the connector must pass one host/port tuple, not a formatted string"
    );
}

struct Panics;
#[async_trait]
impl ModuleHandler for Panics {
    async fn handle(&self, _ctx: RequestCtx, _body: Vec<u8>) -> HandlerOutcome {
        tokio::task::yield_now().await;
        panic!("private request data");
    }
}

#[tokio::test]
async fn handler_panic_sends_redacted_correlated_error_and_fails_serve() {
    let (mut daemon, serve) = connected(Panics, ServeOptions::default());
    request(&mut daemon).await;
    let frame = receive(&mut daemon).await;
    assert_eq!(
        (
            frame.header.ty,
            frame.header.channel,
            frame.header.epoch,
            frame.header.corr
        ),
        (FrameType::Error, 1, 1, 42)
    );
    let error: ErrorBody = serde_json::from_slice(&frame.body).unwrap();
    assert_eq!(error.code, "internal");
    assert_eq!(error.message, "module handler panicked");
    assert!(!String::from_utf8_lossy(&frame.body).contains("private request data"));
    assert!(matches!(
        timeout(Duration::from_secs(3), serve)
            .await
            .unwrap()
            .unwrap(),
        Err(SubcModuleError::HandlerPanic)
    ));
    assert!(read_frame(&mut daemon).await.unwrap().is_none());
}

#[tokio::test]
async fn terminal_send_failure_is_reported_to_dispatcher() {
    let dispatcher = RequestDispatcher::new();
    let (tx, rx) = mpsc::channel(1);
    drop(rx);
    let handle = ModuleHandle::new(
        &ack(),
        tx.clone(),
        124,
        CancellationToken::new(),
        tokio::runtime::Handle::current(),
    );
    handle.install_route(handle.route_handle(1, 1)).unwrap();
    let frame = Frame::build(FrameType::Request, data_flags(), 1, 1, 42, Vec::new()).unwrap();
    spawn_data_request(frame, tx, Arc::new(Echo), dispatcher.clone(), handle).unwrap();
    timeout(Duration::from_secs(1), dispatcher.failed.cancelled())
        .await
        .unwrap();
    assert!(matches!(
        dispatcher.take_failure(),
        Some(SubcModuleError::WriterClosed)
    ));
}

struct Reply(HandlerOutcome);
#[async_trait]
impl ModuleHandler for Reply {
    async fn handle(&self, _ctx: RequestCtx, _body: Vec<u8>) -> HandlerOutcome {
        self.0.clone()
    }
}

async fn reply(outcome: HandlerOutcome) -> Frame {
    let stop = ModuleStopHandle::new();
    let (mut daemon, serve) = connected(
        Reply(outcome),
        ServeOptions::default().with_stop_handle(stop.clone()),
    );
    request(&mut daemon).await;
    let response = receive(&mut daemon).await;
    stop.stop();
    assert_eq!(receive(&mut daemon).await.header.ty, FrameType::Goodbye);
    serve.await.unwrap().unwrap();
    response
}

fn assert_oversized(frame: Frame, size: usize) {
    assert_eq!(
        (
            frame.header.ty,
            frame.header.channel,
            frame.header.epoch,
            frame.header.corr
        ),
        (FrameType::Error, 1, 1, 42)
    );
    assert!(!frame.header.flags.is_binary());
    let error: ErrorBody = serde_json::from_slice(&frame.body).unwrap();
    assert_eq!(error.code, "frame_too_large");
    assert_eq!(
        error.detail,
        Some(serde_json::json!({"size": size, "limit": subc_protocol::MAX_DELIVERED_FRAME_LEN}))
    );
}

#[tokio::test]
async fn response_at_limit_is_sent_and_one_byte_over_gets_fallback() {
    let len = subc_protocol::MAX_DELIVERED_FRAME_LEN - subc_protocol::HEADER_LEN;
    let frame = reply(HandlerOutcome::Response(vec![b'x'; len])).await;
    assert_eq!(frame.header.ty, FrameType::Response);
    assert_eq!(frame.body, vec![b'x'; len]);
    assert_oversized(
        reply(HandlerOutcome::Response(vec![b'x'; len + 1])).await,
        subc_protocol::MAX_DELIVERED_FRAME_LEN + 1,
    );
}

#[tokio::test]
async fn error_at_limit_is_sent_and_one_byte_over_gets_fallback() {
    let overhead = serde_json::to_vec(&ErrorBody::new("test", ""))
        .unwrap()
        .len();
    let len = subc_protocol::MAX_DELIVERED_FRAME_LEN - subc_protocol::HEADER_LEN - overhead;
    let frame = reply(HandlerOutcome::Error {
        code: "test".into(),
        message: "x".repeat(len),
    })
    .await;
    assert_eq!(frame.header.ty, FrameType::Error);
    assert_eq!(
        frame.body.len() + subc_protocol::HEADER_LEN,
        subc_protocol::MAX_DELIVERED_FRAME_LEN
    );
    assert_eq!(
        serde_json::from_slice::<ErrorBody>(&frame.body)
            .unwrap()
            .message,
        "x".repeat(len)
    );
    assert_oversized(
        reply(HandlerOutcome::Error {
            code: "test".into(),
            message: "x".repeat(len + 1),
        })
        .await,
        subc_protocol::MAX_DELIVERED_FRAME_LEN + 1,
    );
}

#[tokio::test]
async fn detailed_error_over_limit_gets_fallback() {
    let outcome = HandlerOutcome::ErrorWithDetail {
        code: "test".into(),
        message: "error".into(),
        detail: serde_json::json!({"data": "x".repeat(subc_protocol::MAX_DELIVERED_FRAME_LEN)}),
    };
    let size = if let HandlerOutcome::ErrorWithDetail {
        code,
        message,
        detail,
    } = &outcome
    {
        subc_protocol::HEADER_LEN
            + serde_json::to_vec(&ErrorBody::new(code, message).with_detail(detail.clone()))
                .unwrap()
                .len()
    } else {
        unreachable!()
    };
    assert_oversized(reply(outcome).await, size);
}

struct Held {
    entered: Arc<Notify>,
    release: Arc<Notify>,
}
#[async_trait]
impl ModuleHandler for Held {
    async fn handle(&self, ctx: RequestCtx, _body: Vec<u8>) -> HandlerOutcome {
        self.entered.notify_one();
        tokio::select! {
            () = ctx.cancelled() => return HandlerOutcome::Response(b"cancelled".to_vec()),
            () = self.release.notified() => {},
        }
        HandlerOutcome::Response(b"finished".to_vec())
    }
}

#[tokio::test]
async fn external_stop_finishes_inflight_handler_then_sends_goodbye() {
    let stop = ModuleStopHandle::new();
    let entered = Arc::new(Notify::new());
    let release = Arc::new(Notify::new());
    let (mut daemon, serve) = connected(
        Held {
            entered: entered.clone(),
            release: release.clone(),
        },
        ServeOptions::default().with_stop_handle(stop.clone()),
    );
    request(&mut daemon).await;
    entered.notified().await;
    stop.stop();
    tokio::task::yield_now().await;
    assert!(!serve.is_finished());
    release.notify_one();
    assert_eq!(receive(&mut daemon).await.body, b"finished");
    assert_eq!(receive(&mut daemon).await.header.ty, FrameType::Goodbye);
    serve.await.unwrap().unwrap();
    assert!(read_frame(&mut daemon).await.unwrap().is_none());
}

#[tokio::test]
async fn late_reply_after_route_goodbye_does_not_fail_the_connection() {
    let entered = Arc::new(Notify::new());
    let (mut daemon, serve) = connected(
        Held {
            entered: entered.clone(),
            release: Arc::new(Notify::new()),
        },
        ServeOptions::default(),
    );
    request(&mut daemon).await;
    entered.notified().await;
    let goodbye = Frame::build(FrameType::Goodbye, data_flags(), 1, 1, 0, Vec::new()).unwrap();
    write_frame(&mut daemon, &goodbye).await.unwrap();
    tokio::task::yield_now().await;
    let ping = Frame::build(FrameType::Ping, control_flags(), 0, 0, 99, Vec::new()).unwrap();
    write_frame(&mut daemon, &ping).await.unwrap();
    let pong = receive(&mut daemon).await;
    assert_eq!((pong.header.ty, pong.header.corr), (FrameType::Pong, 99));
    let goodbye = Frame::build(FrameType::Goodbye, control_flags(), 0, 0, 0, Vec::new()).unwrap();
    write_frame(&mut daemon, &goodbye).await.unwrap();
    serve.await.unwrap().unwrap();
}

#[tokio::test]
async fn external_stop_during_handshake_sends_goodbye_and_tears_down() {
    let manifest = ModuleManifest::builder("test", "0.1.0").build();
    let stop = ModuleStopHandle::new();
    let (module, mut daemon) = tokio::io::duplex(64 * 1024);
    let task = tokio::spawn(register_connection(
        module,
        manifest,
        Echo,
        ServeOptions::default().with_stop_handle(stop.clone()),
    ));
    assert_eq!(receive(&mut daemon).await.header.ty, FrameType::Hello);
    stop.stop();
    assert_eq!(receive(&mut daemon).await.header.ty, FrameType::Goodbye);
    assert!(task.await.unwrap().unwrap().is_none());
    assert!(read_frame(&mut daemon).await.unwrap().is_none());
}

#[tokio::test]
async fn already_stopped_does_not_read_connection_file() {
    let stop = ModuleStopHandle::new();
    stop.stop();
    let manifest = ModuleManifest::builder("test", "0.1.0").build();
    ServeOptions::default()
        .with_stop_handle(stop)
        .serve_with(Path::new("nonexistent-connection-file"), manifest, Echo)
        .await
        .unwrap();
}

struct NeverFinishes {
    entered: Arc<Notify>,
    dropped: Arc<AtomicBool>,
}

#[async_trait]
impl ModuleHandler for NeverFinishes {
    async fn handle(&self, _ctx: RequestCtx, _body: Vec<u8>) -> HandlerOutcome {
        struct OnDrop(Arc<AtomicBool>);
        impl Drop for OnDrop {
            fn drop(&mut self) {
                self.0.store(true, Ordering::SeqCst);
            }
        }
        let _guard = OnDrop(self.dropped.clone());
        self.entered.notify_one();
        std::future::pending().await
    }
}

#[tokio::test(start_paused = true)]
async fn external_stop_aborts_over_budget_handler_and_tears_down() {
    let entered = Arc::new(Notify::new());
    let dropped = Arc::new(AtomicBool::new(false));
    let stop = ModuleStopHandle::new();
    let budget = Duration::from_millis(50);
    let (mut daemon, serve) = connected(
        NeverFinishes {
            entered: entered.clone(),
            dropped: dropped.clone(),
        },
        ServeOptions::default()
            .with_stop_handle(stop.clone())
            .with_writer_drain_timeout(budget),
    );
    request(&mut daemon).await;
    entered.notified().await;
    let started = Instant::now();
    stop.stop();
    assert_eq!(receive(&mut daemon).await.header.ty, FrameType::Goodbye);
    serve.await.unwrap().unwrap();
    assert_eq!(started.elapsed(), budget);
    assert!(dropped.load(Ordering::SeqCst));
    assert!(read_frame(&mut daemon).await.unwrap().is_none());
}

struct PanickingHealth;
#[async_trait]
impl ModuleHandler for PanickingHealth {
    async fn handle(&self, _ctx: RequestCtx, body: Vec<u8>) -> HandlerOutcome {
        HandlerOutcome::Response(body)
    }
    async fn health(&self) -> HealthReport {
        panic!("private health data");
    }
}

#[tokio::test]
async fn health_panic_sends_redacted_error_and_fails_serve() {
    let (mut daemon, serve) = connected(PanickingHealth, ServeOptions::default());
    let frame = Frame::build(
        FrameType::Request,
        control_flags(),
        0,
        0,
        43,
        serde_json::to_vec(&ModuleControlRequest::HealthCheck {}).unwrap(),
    )
    .unwrap();
    write_frame(&mut daemon, &frame).await.unwrap();
    let frame = receive(&mut daemon).await;
    assert_eq!(
        (frame.header.ty, frame.header.channel, frame.header.corr),
        (FrameType::Error, 0, 43)
    );
    let error: ErrorBody = serde_json::from_slice(&frame.body).unwrap();
    assert_eq!(error.code, "internal");
    assert_eq!(error.message, "module handler panicked");
    assert!(matches!(
        serve.await.unwrap(),
        Err(SubcModuleError::HandlerPanic)
    ));
}

struct ReadError(io::ErrorKind);
impl AsyncRead for ReadError {
    fn poll_read(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        _buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        Poll::Ready(Err(io::Error::from(self.0)))
    }
}

struct FlushError(io::ErrorKind);
impl AsyncWrite for FlushError {
    fn poll_write(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        Poll::Ready(Ok(buf.len()))
    }
    fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Ready(Err(io::Error::from(self.0)))
    }
    fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Ready(Ok(()))
    }
}

#[tokio::test]
async fn idle_eof_is_ok() {
    let (handle, serve) = start(
        tokio::io::empty(),
        tokio::io::sink(),
        Echo,
        ServeOptions::default(),
    );
    serve.await.unwrap().unwrap();
    assert!(handle.is_closed());
}

#[tokio::test]
async fn read_reset_and_abort_end_the_connection_as_reset() {
    for kind in [
        io::ErrorKind::ConnectionReset,
        io::ErrorKind::ConnectionAborted,
    ] {
        let recorder = EndRecorder::default();
        let (handle, serve) = start(
            ReadError(kind),
            tokio::io::sink(),
            recorder.clone(),
            ServeOptions::default(),
        );
        serve.await.unwrap().unwrap();
        assert_eq!(*recorder.0.lock().unwrap(), [ConnectionEnd::Reset]);
        assert!(handle.is_closed());
    }
}

#[tokio::test]
async fn write_disconnect_while_read_side_open_ends_the_connection_as_reset() {
    for kind in [
        io::ErrorKind::BrokenPipe,
        io::ErrorKind::ConnectionReset,
        io::ErrorKind::ConnectionAborted,
    ] {
        let (module, mut daemon) = tokio::io::duplex(1024);
        let recorder = EndRecorder::default();
        let (handle, serve) = start(
            module,
            FlushError(kind),
            recorder.clone(),
            ServeOptions::default(),
        );
        request(&mut daemon).await;
        timeout(Duration::from_secs(3), serve)
            .await
            .unwrap()
            .unwrap()
            .unwrap();
        assert_eq!(*recorder.0.lock().unwrap(), [ConnectionEnd::Reset]);
        assert!(handle.is_closed());
    }
}

#[tokio::test]
async fn non_disconnect_transport_failures_remain_errors() {
    let kind = io::ErrorKind::PermissionDenied;
    let recorder = EndRecorder::default();
    let (_, serve) = start(
        ReadError(kind),
        tokio::io::sink(),
        recorder.clone(),
        ServeOptions::default(),
    );
    assert!(
        matches!(serve.await.unwrap(), Err(SubcModuleError::FrameIo(FrameIoError::Io(error))) if error.kind() == kind)
    );
    assert!(recorder.0.lock().unwrap().is_empty());

    let (module, mut daemon) = tokio::io::duplex(1024);
    let (_, serve) = start(
        module,
        FlushError(kind),
        recorder.clone(),
        ServeOptions::default(),
    );
    request(&mut daemon).await;
    assert!(
        matches!(timeout(Duration::from_secs(3), serve).await.unwrap().unwrap(), Err(SubcModuleError::FrameIo(FrameIoError::Io(error))) if error.kind() == kind)
    );
    assert!(recorder.0.lock().unwrap().is_empty());
}

struct HandshakeDisconnect {
    read_error: Option<io::ErrorKind>,
    write_error: Option<io::ErrorKind>,
}

impl AsyncRead for HandshakeDisconnect {
    fn poll_read(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        _buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        match self.read_error {
            Some(kind) => Poll::Ready(Err(io::Error::from(kind))),
            None => Poll::Pending,
        }
    }
}

impl AsyncWrite for HandshakeDisconnect {
    fn poll_write(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        Poll::Ready(Ok(buf.len()))
    }
    fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Ready(
            self.write_error
                .map_or(Ok(()), |kind| Err(io::Error::from(kind))),
        )
    }
    fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Ready(Ok(()))
    }
}

#[tokio::test]
async fn disconnect_before_hello_ack_remains_an_error_without_an_end_hook() {
    for (read_error, write_error) in [
        (Some(io::ErrorKind::ConnectionReset), None),
        (Some(io::ErrorKind::ConnectionAborted), None),
        (None, Some(io::ErrorKind::BrokenPipe)),
        (None, Some(io::ErrorKind::ConnectionReset)),
        (None, Some(io::ErrorKind::ConnectionAborted)),
    ] {
        let recorder = EndRecorder::default();
        let result = register_connection(
            HandshakeDisconnect {
                read_error,
                write_error,
            },
            ModuleManifest::builder("test", "0.1.0").build(),
            recorder.clone(),
            ServeOptions::default(),
        )
        .await;
        assert!(
            matches!(result, Err(SubcModuleError::FrameIo(FrameIoError::Io(error))) if Some(error.kind()) == read_error.or(write_error))
        );
        assert!(recorder.0.lock().unwrap().is_empty());
    }
}

#[tokio::test]
async fn orderly_eof_and_goodbye_allow_late_flush_disconnects() {
    for kind in [
        io::ErrorKind::BrokenPipe,
        io::ErrorKind::ConnectionReset,
        io::ErrorKind::ConnectionAborted,
    ] {
        let (_, serve) = start(
            tokio::io::empty(),
            FlushError(kind),
            Echo,
            ServeOptions::default(),
        );
        serve.await.unwrap().unwrap();
        let goodbye =
            Frame::build(FrameType::Goodbye, control_flags(), 0, 0, 0, Vec::new()).unwrap();
        let mut bytes = Vec::new();
        write_frame(&mut bytes, &goodbye).await.unwrap();
        let (_, serve) = start(
            std::io::Cursor::new(bytes),
            FlushError(kind),
            Echo,
            ServeOptions::default(),
        );
        serve.await.unwrap().unwrap();
    }
}

#[derive(Clone, Default)]
struct LogCapture(Arc<Mutex<Vec<String>>>);

impl tracing::Subscriber for LogCapture {
    fn enabled(&self, _metadata: &tracing::Metadata<'_>) -> bool {
        true
    }
    fn new_span(&self, _span: &tracing::span::Attributes<'_>) -> tracing::span::Id {
        tracing::span::Id::from_u64(1)
    }
    fn record(&self, _span: &tracing::span::Id, _values: &tracing::span::Record<'_>) {}
    fn record_follows_from(&self, _span: &tracing::span::Id, _follows: &tracing::span::Id) {}
    fn enter(&self, _span: &tracing::span::Id) {}
    fn exit(&self, _span: &tracing::span::Id) {}
    fn event(&self, event: &tracing::Event<'_>) {
        struct Fields(String);
        impl tracing::field::Visit for Fields {
            fn record_debug(&mut self, field: &tracing::field::Field, value: &dyn fmt::Debug) {
                use std::fmt::Write;
                write!(&mut self.0, "{}={value:?} ", field.name()).unwrap();
            }
        }
        let mut fields = Fields(String::new());
        event.record(&mut fields);
        self.0.lock().unwrap().push(fields.0);
    }
}

#[tokio::test]
async fn eof_with_inflight_reply_and_broken_pipe_is_ok_and_logs_count_only() {
    let capture = LogCapture::default();
    let dispatch = tracing::Dispatch::new(capture.clone());
    let _guard = tracing::dispatcher::set_default(&dispatch);
    let entered = Arc::new(Notify::new());
    let (module, mut daemon) = tokio::io::duplex(1024);
    let (_, serve) = start(
        module,
        FlushError(io::ErrorKind::BrokenPipe),
        Held {
            entered: entered.clone(),
            release: Arc::new(Notify::new()),
        },
        ServeOptions::default(),
    );
    request(&mut daemon).await;
    entered.notified().await;
    daemon.shutdown().await.unwrap();
    serve.await.unwrap().unwrap();
    let logs = capture.0.lock().unwrap();
    assert_eq!(logs.len(), 1, "{logs:?}");
    assert!(
        logs[0].contains("daemon EOF: replies could not be delivered during drain"),
        "{logs:?}"
    );
    assert!(logs[0].contains("undelivered_replies=1"), "{logs:?}");
    assert!(!logs[0].contains("cancelled"));
}

struct StuckWriter(Arc<AtomicBool>);
impl Drop for StuckWriter {
    fn drop(&mut self) {
        self.0.store(true, Ordering::SeqCst);
    }
}
impl AsyncWrite for StuckWriter {
    fn poll_write(
        self: Pin<&mut Self>,
        _cx: &mut Context<'_>,
        _buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        Poll::Pending
    }
    fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Pending
    }
    fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Poll::Pending
    }
}

#[tokio::test(start_paused = true)]
async fn configured_writer_drain_budget_is_honored_and_writer_is_aborted() {
    let dropped = Arc::new(AtomicBool::new(false));
    let budget = Duration::from_millis(37);
    let started = Instant::now();
    let (_, serve) = start(
        tokio::io::empty(),
        StuckWriter(dropped.clone()),
        Echo,
        ServeOptions::default().with_writer_drain_timeout(budget),
    );
    serve.await.unwrap().unwrap();
    assert_eq!(started.elapsed(), budget);
    assert!(dropped.load(Ordering::SeqCst));
    assert_eq!(
        ServeOptions::default().writer_drain_timeout,
        Duration::from_secs(2)
    );
}