penguin-mux 0.8.3

TCP/UDP multiplexing over HTTP WebSocket
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
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
//! Module tests.
//
// SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later

// These tests are not run under loom, as they
// use `tokio::spawn` and thus need an actual `tokio` runtime.

use super::*;
use crate::{
    frame,
    ws::{Message, WebSocket},
};
use std::future::poll_fn;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
#[cfg(feature = "tungstenite")]
use tokio_tungstenite::WebSocketStream;
use tracing::{debug, info};
use tracing_subscriber::{EnvFilter, layer::SubscriberExt, util::SubscriberInitExt};

/// Used to provide some compatibility for tests written against the
/// `futures_util::Sink` and `Stream` traits.
trait CompatSinkStreamWebSocket: WebSocket {
    async fn send(&mut self, item: Message) -> Result<()> {
        poll_fn(|cx| self.poll_ready_unpin(cx)).await?;
        self.start_send_unpin(item)?;
        poll_fn(|cx| self.poll_flush_unpin(cx)).await
    }

    async fn next(&mut self) -> Option<Result<Message>> {
        poll_fn(|cx| self.poll_next_unpin(cx)).await
    }
}
impl<T: WebSocket> CompatSinkStreamWebSocket for T {}

pub fn setup_logging() {
    tracing_subscriber::registry()
        .with(tracing_subscriber::fmt::layer())
        .with(EnvFilter::from_default_env())
        .try_init()
        .ok();
    #[cfg(feature = "deadlock-detection")]
    crate::deadlock_detection::try_spawn_deadlock_detection();
}

#[cfg(feature = "tungstenite")]
async fn get_pair(
    link_mss: Option<usize>,
) -> (
    WebSocketStream<tokio::io::DuplexStream>,
    WebSocketStream<tokio::io::DuplexStream>,
) {
    use tokio_tungstenite::{WebSocketStream, tungstenite::protocol::Role};
    let (client, server) = tokio::io::duplex(link_mss.unwrap_or(2048));
    let client = WebSocketStream::from_raw_socket(client, Role::Client, None).await;
    let server = WebSocketStream::from_raw_socket(server, Role::Server, None).await;
    (client, server)
}
#[cfg(not(feature = "tungstenite"))]
use mock::{MockWebSocketStream as WebSocketStream, get_pair};

mod mock {
    use crate::ws::{Message, WebSocket};
    use std::task::{Context, Poll};
    use tokio::sync::mpsc;

    pub struct MockWebSocketStream(
        Option<mpsc::UnboundedSender<Message>>,
        mpsc::UnboundedReceiver<Message>,
    );

    impl WebSocket for MockWebSocketStream {
        fn poll_ready_unpin(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), crate::Error>> {
            if self.0.is_none() {
                Poll::Ready(Err(crate::Error::Closed))
            } else {
                Poll::Ready(Ok(()))
            }
        }

        fn start_send_unpin(&mut self, item: Message) -> Result<(), crate::Error> {
            let Some(sender) = &self.0 else {
                return Err(crate::Error::Closed);
            };
            sender.send(item).or(Err(crate::Error::Closed))?;
            Ok(())
        }

        fn poll_flush_unpin(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), crate::Error>> {
            Poll::Ready(Ok(()))
        }

        fn poll_close_unpin(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), crate::Error>> {
            self.0.take();
            Poll::Ready(Ok(()))
        }

        fn poll_next_unpin(
            &mut self,
            cx: &mut Context<'_>,
        ) -> Poll<Option<Result<Message, crate::Error>>> {
            self.1.poll_recv(cx).map(|x| x.map(Ok))
        }
    }

    pub async fn get_pair(_link_mss: Option<usize>) -> (MockWebSocketStream, MockWebSocketStream) {
        let (tx1, rx1) = mpsc::unbounded_channel();
        let (tx2, rx2) = mpsc::unbounded_channel();
        let client = MockWebSocketStream(Some(tx1), rx2);
        let server = MockWebSocketStream(Some(tx2), rx1);
        (client, server)
    }
}

#[tokio::test]
#[cfg(not(loom))]
async fn connect_succeeds() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        let stream = server_mux.accept_stream_channel().await.unwrap();
        info!(
            "flow_id = {:08x}, dest = {:?}:{}",
            stream.flow_id, stream.dest_host, stream.dest_port
        );
    });

    let stream = client_mux.new_stream_channel(&[], 0).await.unwrap();
    info!("flow_id = {:08x}", stream.flow_id);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn datagram_channel_passes_data_tiny_mtu() {
    setup_logging();
    // 8 bytes is the IPv4 minimum segment size. Let's try that
    let (client, server) = get_pair(Some(8)).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        for _ in 0..64 {
            let dgram = server_mux.get_datagram().await.unwrap();
            debug!("Server got datagram");
            server_mux.send_datagram(dgram).await.unwrap();
        }
    });

    for _ in 0..64 {
        let payload: Bytes = (0..32768).map(|_| rand::random::<u8>()).collect();
        debug!("Client sending datagram");
        client_mux
            .send_datagram(Datagram {
                flow_id: 1,
                target_host: Bytes::from_static(b"example.com"),
                target_port: 53,
                data: payload.clone(),
            })
            .await
            .unwrap();
        debug!("Client awaiting datagram");
        let recvd = client_mux.get_datagram().await.unwrap();
        assert_eq!(recvd.flow_id, 1);
        assert_eq!(*recvd.target_host, *b"example.com");
        assert_eq!(recvd.target_port, 53);
        assert_eq!(recvd.data, payload);
    }
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn datagram_channel_passes_data() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        for _ in 0..64 {
            let dgram = server_mux.get_datagram().await.unwrap();
            debug!("Server got datagram");
            server_mux.send_datagram(dgram).await.unwrap();
        }
    });

    for _ in 0..64 {
        let payload: Bytes = (0..32768).map(|_| rand::random::<u8>()).collect();
        debug!("Client sending datagram");
        client_mux
            .send_datagram(Datagram {
                flow_id: 1,
                target_host: Bytes::from_static(b"example.com"),
                target_port: 53,
                data: payload.clone(),
            })
            .await
            .unwrap();
        debug!("Client awaiting datagram");
        let recvd = client_mux.get_datagram().await.unwrap();
        assert_eq!(*recvd.target_host, *b"example.com");
        assert_eq!(recvd.target_port, 53);
        assert_eq!(recvd.flow_id, 1);
        assert_eq!(recvd.data, payload);
    }
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_datagram_reject_long_host() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);
    // Make it 256 bytes long
    let long_host = Bytes::from(b"example1".repeat(32));
    let data = Bytes::from_static(b"hello");
    client_mux
        .send_datagram(Datagram {
            flow_id: 1,
            target_host: long_host.clone(),
            target_port: 53,
            data: data.clone(),
        })
        .await
        .unwrap_err();
    // Try one fewer byte
    let long_host2 = long_host.slice(1..);
    client_mux
        .send_datagram(Datagram {
            flow_id: 1,
            target_host: long_host2.clone(),
            target_port: 53,
            data: data.clone(),
        })
        .await
        .unwrap();
    let result = server_mux.get_datagram().await.unwrap();
    assert_eq!(result.target_host, long_host2);
    assert_eq!(result.target_port, 53);
    assert_eq!(result.flow_id, 1);
    assert_eq!(result.data, data);
}

#[tokio::test]
#[cfg(not(loom))]
async fn connected_stream_passes_data_tiny_mtu_rwndminusone() {
    setup_logging();
    let (client, server) = get_pair(Some(8)).await;

    let options = crate::config::Options::new()
        .rwnd(4)
        .default_rwnd_threshold(4 - 1);

    let client_mux = Multiplexor::new(client, Some(options), None);
    let server_mux = Multiplexor::new(server, Some(options), None);

    let input_bytes: Vec<u8> = (0..(1024 * 1024)).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        let mut i = 0;
        while i < input_bytes_clone.len() {
            conn.write_all(&input_bytes_clone[i..i + 1024])
                .await
                .unwrap();
            i += 1024;
        }
        info!("Done send");
        conn.shutdown().await.unwrap();
    });

    let mut output_bytes: Vec<u8> = vec![];

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    while output_bytes.len() < len {
        let mut buf = [0u8; 2048];
        let bytes = conn.read(&mut buf).await.unwrap();
        if bytes == 0 {
            break;
        }
        output_bytes.extend(&buf[..bytes]);
        debug!("Read {} bytes", output_bytes.len());
    }

    assert_eq!(input_bytes, output_bytes);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn connected_stream_passes_data_tiny_mtu_with_keepalive() {
    setup_logging();
    let (client, server) = get_pair(Some(1)).await;

    let client_option = crate::config::Options {
        keepalive_interval: crate::timing::OptionalDuration::from_secs(1),
        ..Default::default()
    };
    let client_mux = Multiplexor::new(client, Some(client_option), None);
    let server_mux = Multiplexor::new(server, None, None);

    let input_bytes: Vec<u8> = (0..1024 * 256).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let client_task = tokio::spawn(async move {
        let mut output_bytes: Vec<u8> = vec![];
        let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
        while output_bytes.len() < len {
            let mut buf = [0u8; 2048];
            let bytes = conn.read(&mut buf).await.unwrap();
            if bytes == 0 {
                break;
            }
            output_bytes.extend(&buf[..bytes]);
            info!("Read {} bytes", output_bytes.len());
        }
        assert_eq!(input_bytes, output_bytes);
    });
    let mut conn = server_mux.accept_stream_channel().await.unwrap();
    conn.write_all(&input_bytes_clone).await.unwrap();
    info!("Done send");
    conn.shutdown().await.unwrap();
    debug!("Waiting for client task to finish");
    client_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn connected_stream_passes_data_tiny_mtu() {
    setup_logging();
    let (client, server) = get_pair(Some(8)).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let input_bytes: Vec<u8> = (0..(1024 * 1024)).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        let mut i = 0;
        while i < input_bytes_clone.len() {
            conn.write_all(&input_bytes_clone[i..i + 1024])
                .await
                .unwrap();
            i += 1024;
        }
        info!("Done send");
        conn.shutdown().await.unwrap();
    });

    let mut output_bytes: Vec<u8> = vec![];

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    while output_bytes.len() < len {
        let mut buf = [0u8; 2048];
        let bytes = conn.read(&mut buf).await.unwrap();
        if bytes == 0 {
            break;
        }
        output_bytes.extend(&buf[..bytes]);
        debug!("Read {} bytes", output_bytes.len());
    }

    assert_eq!(input_bytes, output_bytes);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn connected_stream_passes_data() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let input_bytes: Vec<u8> = (0..(1024 * 1024)).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        let mut i = 0;
        while i < input_bytes_clone.len() {
            conn.write_all(&input_bytes_clone[i..i + 1024])
                .await
                .unwrap();
            i += 1024;
        }
        info!("Done send");
        conn.shutdown().await.unwrap();
    });

    let mut output_bytes: Vec<u8> = vec![];

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    while output_bytes.len() < len {
        let mut buf = [0u8; 2048];
        let bytes = conn.read(&mut buf).await.unwrap();
        if bytes == 0 {
            break;
        }
        output_bytes.extend(&buf[..bytes]);
        debug!("Read {} bytes", output_bytes.len());
    }

    assert_eq!(input_bytes, output_bytes);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn connected_stream_passes_data_one_sided_lots() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let input_bytes: Vec<u8> = (0..(32 * 0x20000)).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        let mut i = 0;
        while i < input_bytes_clone.len() {
            conn.write_all(&input_bytes_clone[i..i + 32]).await.unwrap();
            i += 32;
        }
        info!("Done send");
        conn.shutdown().await.unwrap();
    });

    let mut output_bytes: Vec<u8> = vec![];

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    conn.shutdown().await.unwrap();
    while output_bytes.len() < len {
        let mut buf = [0u8; 64];
        let bytes = conn.read(&mut buf).await.unwrap();
        if bytes == 0 {
            break;
        }
        output_bytes.extend(&buf[..bytes]);
        debug!("Read {} bytes", output_bytes.len());
    }

    assert_eq!(input_bytes, output_bytes);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_shutdown_has_effect() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        conn.shutdown().await.unwrap();
        conn.write_all(b"hello").await.unwrap_err();
    });

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    conn.shutdown().await.unwrap();
    conn.write_all(b"hello").await.unwrap_err();
    server_task.await.unwrap();
}

#[tokio::test(flavor = "multi_thread")]
#[cfg(not(loom))]
async fn test_contention() {
    const NUM_CONCURRENT: usize = 16;
    const EACH_JOB_WRITES: usize = 16;
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let payload: Bytes = (0..(1024 * 1024)).map(|_| rand::random::<u8>()).collect();
    let len = payload.len();
    let s_payload = payload.dupe();

    let mut jobs = tokio::task::JoinSet::new();
    jobs.spawn(async move {
        let mut server_jobs = tokio::task::JoinSet::new();
        for _ in 0..NUM_CONCURRENT {
            let mut stream = server_mux.accept_stream_channel().await.unwrap();
            let s_payload = s_payload.dupe();
            server_jobs.spawn(async move {
                let mut buf = vec![0; len];
                for _ in 0..EACH_JOB_WRITES {
                    stream.write_all(&s_payload).await.unwrap();
                    stream.read_exact(&mut buf).await.unwrap();
                    // No check for correctness as this should be guaranteed by tests
                }
                stream.shutdown().await.unwrap();
            });
        }
        while let Some(res) = server_jobs.join_next().await {
            res.unwrap();
        }
    });
    for _ in 0..NUM_CONCURRENT {
        let mut stream = client_mux.new_stream_channel(&[], 0).await.unwrap();
        jobs.spawn(async move {
            let mut buf = vec![0; len];
            for _ in 0..EACH_JOB_WRITES {
                stream.read_exact(&mut buf).await.unwrap();
                stream.write_all(&buf).await.unwrap();
            }
            stream.shutdown().await.unwrap();
        });
    }
    while let Some(res) = jobs.join_next().await {
        res.unwrap();
    }
}

#[cfg(feature = "tungstenite")]
#[tokio::test(flavor = "multi_thread")]
#[cfg(not(loom))]
async fn test_with_tcpsocket() {
    setup_logging();
    for _ in 0..16 {
        test_with_tcpsocket_inner().await;
    }
}
#[cfg(feature = "tungstenite")]
#[cfg(not(loom))]
async fn test_with_tcpsocket_inner() {
    use tokio_tungstenite::tungstenite::protocol::Role;
    const SINGLE_WRITE_LEN: usize = 4096;
    const ITERATIONS: usize = 256;
    let s_socket = tokio::net::TcpListener::bind(("::1", 0)).await.unwrap();
    let s_addr = s_socket.local_addr().unwrap();
    let all_payload: Bytes = (0..SINGLE_WRITE_LEN * ITERATIONS)
        .map(|_| rand::random::<u8>())
        .collect();
    let mut s_payload = all_payload.dupe();
    tokio::spawn(async move {
        let tcpstream = s_socket.accept().await.unwrap().0;
        let server = WebSocketStream::from_raw_socket(tcpstream, Role::Server, None).await;
        let mux = Multiplexor::new(server, None, None);
        let mut stream = mux.accept_stream_channel().await.unwrap();
        for _ in 0..ITERATIONS {
            let payload = s_payload.split_to(SINGLE_WRITE_LEN);
            stream.write_all(&payload).await.unwrap();
        }
        stream.shutdown().await.unwrap();
    });
    let tcpstream = tokio::net::TcpStream::connect(s_addr).await.unwrap();
    let client = WebSocketStream::from_raw_socket(tcpstream, Role::Client, None).await;
    let mux = Multiplexor::new(client, None, None);
    let mut stream = mux.new_stream_channel(&[], 0).await.unwrap();
    stream.shutdown().await.unwrap();
    // Make sure any mishandling of half-close pop up in the test
    tokio::time::sleep(std::time::Duration::from_millis(rand::random_range(0..500))).await;
    for i in 0..ITERATIONS {
        let mut buf = vec![0; SINGLE_WRITE_LEN];
        stream.read_exact(&mut buf).await.unwrap();
        assert_eq!(
            all_payload[i * SINGLE_WRITE_LEN..(i + 1) * SINGLE_WRITE_LEN],
            buf
        );
    }
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_early_eof_detected() {
    setup_logging();
    for _ in 0..64 {
        test_early_eof_detected_inner().await;
    }
}

#[cfg(not(loom))]
async fn test_early_eof_detected_inner() {
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let input_bytes: Vec<u8> = (0..1024).map(|_| rand::random::<u8>()).collect();
    let len = input_bytes.len();
    let input_bytes_clone = input_bytes.clone();

    let server_task = tokio::spawn(async move {
        let mut conn = server_mux.accept_stream_channel().await.unwrap();
        conn.write_all(&input_bytes_clone).await.unwrap();
        info!("Done send");
    });

    let mut output_bytes: Vec<u8> = vec![];

    let mut conn = client_mux.new_stream_channel(&[], 0).await.unwrap();
    while output_bytes.len() < len + 2 {
        let mut buf = [0u8; 2048];
        let bytes = conn.read(&mut buf).await.unwrap();
        if bytes == 0 {
            break;
        }
        output_bytes.extend(&buf[..bytes]);
        debug!("Read {} bytes", output_bytes.len());
    }

    assert_eq!(input_bytes, output_bytes);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_close_port_behaviour() {
    setup_logging();
    let (mut client, server) = get_pair(None).await;
    // Let's handle the client side of the handshake by hand
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        // In conn1 we shut down the write side properly and check for `Finish`
        // We deliberately `accept` in the "client" side to demonstrate
        // that the multiplexor is fully symmetric
        let mut conn1 = server_mux.new_stream_channel(&[], 0).await.unwrap();
        conn1.shutdown().await.unwrap();
        drop(conn1);
        // In conn2 we just drop the connection and check for `Reset`
        // This time we  `accept` in the "server" side, just for fun
        let conn2 = server_mux.accept_stream_channel().await.unwrap();
        drop(conn2);
    });
    let Message::Binary(payload) = client.next().await.unwrap().unwrap() else {
        panic!("Expected a binary message");
    };
    let frame = frame::Frame::try_from(payload).unwrap();
    let Frame {
        payload: frame::Payload::Connect(_),
        id: flow_id,
    } = frame
    else {
        panic!("Expected a Connect frame");
    };
    client
        .send(Message::Binary(
            frame::Frame::new_acknowledge(flow_id, 10).finalize().into(),
        ))
        .await
        .unwrap();
    // Expecting a `Finish` frame
    let Message::Binary(payload) = client.next().await.unwrap().unwrap() else {
        panic!("Expected a binary message");
    };
    let frame = frame::Frame::try_from(payload).unwrap();
    let Frame {
        payload: frame::Payload::Finish,
        id: flow_id2,
    } = frame
    else {
        panic!("Expected a Finish frame");
    };
    assert_eq!(flow_id, flow_id2);
    // Send a `Connect` frame to conn2
    client
        .send(Message::Binary(
            frame::Frame::new_connect(&[], 0, 41352u32, 20)
                .finalize()
                .into(),
        ))
        .await
        .unwrap();
    // Expecting a `Acknowledge` frame
    let Message::Binary(payload) = client.next().await.unwrap().unwrap() else {
        panic!("Expected a binary message");
    };
    let frame = frame::Frame::try_from(payload).unwrap();
    let Frame {
        payload: frame::Payload::Acknowledge(_),
        id: flow_id,
    } = frame
    else {
        panic!("Expected a Acknowledge frame");
    };
    assert_eq!(flow_id, 41352);
    // Expecting a `Reset` frame
    let Message::Binary(payload) = client.next().await.unwrap().unwrap() else {
        panic!("Expected a binary message");
    };
    let frame = frame::Frame::try_from(payload).unwrap();
    let Frame {
        payload: frame::Payload::Reset,
        id: flow_id,
    } = frame
    else {
        panic!("Expected a Reset frame");
    };
    assert_eq!(flow_id, 41352);
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_several_channels() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        let mut conn1 = server_mux.accept_stream_channel().await.unwrap();
        info!("server conn1 = {:?}", conn1);
        let mut conn2 = server_mux.accept_stream_channel().await.unwrap();
        info!("server conn2 = {:?}", conn2);
        let mut conn3 = server_mux.accept_stream_channel().await.unwrap();
        info!("server conn3 = {:?}", conn3);
        let mut buf = [0u8; 32];
        let bytes = conn3.read(&mut buf).await.unwrap();
        assert_eq!(buf[..bytes], b"!"[..]);
        info!("server conn3 read = {:?}", bytes);
        let bytes = conn2.read(&mut buf).await.unwrap();
        assert_eq!(buf[..bytes], b"world"[..]);
        info!("server conn2 read = {:?}", bytes);
        let bytes = conn1.read(&mut buf).await.unwrap();
        assert_eq!(buf[..bytes], b"hello"[..]);
        info!("server conn1 read = {:?}", bytes);
    });
    let mut conn1 = client_mux.new_stream_channel(&[], 0).await.unwrap();
    info!("client conn1 = {:?}", conn1);
    let mut conn2 = client_mux.new_stream_channel(&[], 0).await.unwrap();
    info!("client conn2 = {:?}", conn2);
    let mut conn3 = client_mux.new_stream_channel(&[], 0).await.unwrap();
    info!("client conn3 = {:?}", conn3);
    conn1.write_all(b"hello").await.unwrap();
    conn1.shutdown().await.unwrap();
    info!("client conn1 wrote");
    conn2.write_all(b"world").await.unwrap();
    conn2.shutdown().await.unwrap();
    info!("client conn2 wrote");
    conn3.write_all(b"!").await.unwrap();
    conn3.shutdown().await.unwrap();
    info!("client conn3 wrote");

    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_flow_id_contention_will_give_up() {
    setup_logging();
    let (client, mut server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);

    let server_task = tokio::spawn(async move {
        // This side receives frames `Connect` and simply `Reset`s them
        while let Some(message) = server.next().await {
            let message = message.unwrap();
            let Message::Binary(payload) = message else {
                continue;
            };
            let frame = frame::Frame::try_from(payload).unwrap();
            if matches!(frame.payload, crate::frame::Payload::Connect(_)) {
                debug!("Server received Connect frame, sending Reset");
                let reset_frame = frame::Frame::new_reset(frame.id);
                server
                    .send(Message::Binary((&reset_frame).into()))
                    .await
                    .unwrap();
            }
        }
    });
    let stream1 = client_mux.new_stream_channel(&[], 0).await;
    assert!(matches!(stream1.unwrap_err(), Error::FlowIdRejected));
    drop(client_mux);
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_flow_id_contention_can_succeed() {
    setup_logging();
    let (client, mut server) = get_pair(None).await;

    let client_mux = Multiplexor::new(client, None, None);

    let (serverside_received_ports_tx, serverside_received_ports_rx) = oneshot::channel();

    let server_task = tokio::spawn(async move {
        // This side receives frames `Connect` and `Reset`s the first one
        let mut rx_flow_ids = (0, 0);
        let message = server.next().await.unwrap().unwrap();
        let Message::Binary(payload) = message else {
            return;
        };
        let frame = frame::Frame::try_from(payload).unwrap();
        rx_flow_ids.0 = frame.id;
        if matches!(frame.payload, crate::frame::Payload::Connect(_)) {
            debug!("Server received the first Connect frame, sending Reset");
            let reset_frame = frame::Frame::new_reset(frame.id);
            server
                .send(Message::Binary((&reset_frame).into()))
                .await
                .unwrap();
        }

        let message = server.next().await.unwrap().unwrap();
        let Message::Binary(payload) = message else {
            return;
        };
        let frame = frame::Frame::try_from(payload).unwrap();
        rx_flow_ids.1 = frame.id;
        if matches!(frame.payload, crate::frame::Payload::Connect(_)) {
            debug!("Server received the second Connect frame, sending Acknowledge");
            let reset_frame = frame::Frame::new_acknowledge(frame.id, 10);
            server
                .send(Message::Binary((&reset_frame).into()))
                .await
                .unwrap();
        }
        serverside_received_ports_tx.send(rx_flow_ids).unwrap();
    });
    let stream1 = client_mux.new_stream_channel(&[], 0).await.unwrap();
    drop(client_mux);
    let (_, server_flow_id2) = serverside_received_ports_rx.await.unwrap();
    assert_eq!(stream1.flow_id, server_flow_id2);
    assert_eq!(
        stream1
            .psh_send_remaining
            .load(std::sync::atomic::Ordering::Relaxed),
        10
    );
    debug!("Waiting for server task to finish");
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_bind_request() {
    setup_logging();
    let (client, server) = get_pair(None).await;

    let allow_bind_config = crate::config::Options {
        bind_buffer_size: 16,
        ..Default::default()
    };

    let client_mux = Multiplexor::new(client, Some(allow_bind_config), None);
    let server_mux = Multiplexor::new(server, None, None);

    let server_task = tokio::spawn(async move {
        let request = server_mux
            .request_bind(b"testbind", 0, BindType::Datagram)
            .await
            .unwrap();
        assert!(request);
        let request = server_mux
            .request_bind(b"testbind2", 40, BindType::Stream)
            .await
            .unwrap();
        assert!(!request);
        // server is configured to refuse bind requests
        let result = server_mux.next_bind_request().await.unwrap_err();
        assert!(matches!(result, Error::UnsupportedOperation));
        let request = server_mux
            .request_bind(b"testbind3", 8011, BindType::Stream)
            .await
            .unwrap();
        assert!(!request);
    });
    let request = client_mux.next_bind_request().await.unwrap();
    assert_eq!(request.bind_type(), BindType::Datagram);
    assert_ne!(request.flow_id(), 0);
    assert_eq!(request.host(), b"testbind");
    assert_eq!(request.port(), 0);
    request.reply(true).unwrap();
    let request = client_mux.next_bind_request().await.unwrap();
    assert_eq!(request.bind_type(), BindType::Stream);
    assert_ne!(request.flow_id(), 0);
    assert_eq!(request.host(), b"testbind2");
    assert_eq!(request.port(), 40);
    drop(request);
    let request = client_mux
        .request_bind(b"testbindc", 80, BindType::Stream)
        .await
        .unwrap();
    assert!(!request);
    let request = client_mux.next_bind_request().await.unwrap();
    assert_eq!(request.bind_type(), BindType::Stream);
    assert_ne!(request.flow_id(), 0);
    assert_eq!(request.host(), b"testbind3");
    assert_eq!(request.port(), 8011);
    request.reply(false).unwrap();
    server_task.await.unwrap();
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_timeout_if_no_pong_1() {
    setup_logging();
    // use the mock websocket for this test because tungstenite always auto-Pongs for us
    let (client, server) = mock::get_pair(None).await;
    let keepalive_config = crate::config::Options {
        keepalive_interval: crate::timing::OptionalDuration::from_secs(1),
        keepalive_timeout: crate::timing::OptionalDuration::from_secs(2),
        ..Default::default()
    };
    let client_mux = Multiplexor::new(client, Some(keepalive_config), None);
    let _server_mux = Multiplexor::new(server, None, None);
    let r = tokio::time::timeout(std::time::Duration::from_secs(3), client_mux.get_datagram())
        .await
        .expect("Expected the timeout to produce `Ok`");
    // Expect an error instead of elapsed timeout
    let res = r.expect_err("Expected `get_datagram` to error out due to no Pong");
    assert!(matches!(res, Error::Closed));
    // There is no way to check what reason the task exited as of now, except for reading the logs
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_timeout_if_no_pong_2() {
    setup_logging();
    // use the mock websocket for this test because tungstenite always auto-Pongs for us
    let (client, server) = mock::get_pair(None).await;
    let keepalive_config = crate::config::Options {
        keepalive_interval: crate::timing::OptionalDuration::from_secs(1),
        keepalive_timeout: crate::timing::OptionalDuration::from_secs(3),
        ..Default::default()
    };
    let client_mux = Multiplexor::new(client, Some(keepalive_config), None);
    let _server_mux = Multiplexor::new(server, None, None);
    let r = tokio::time::timeout(
        std::time::Duration::from_secs(4),
        client_mux.accept_stream_channel(),
    )
    .await
    .expect("Expected the timeout to produce `Ok`");
    // Expect an error instead of elapsed timeout
    let res = r.expect_err("Expected `accept_stream_channel` to error out due to no Pong");
    assert!(matches!(res, Error::Closed));
    // There is no way to check what reason the task exited as of now, except for reading the logs
}

#[tokio::test]
#[cfg(not(loom))]
async fn test_no_timeout_if_no_keepalive() {
    // Make sure that if keepalive is disabled, no Pong timeout occurs
    setup_logging();
    let (client, server) = mock::get_pair(None).await;
    let client_mux = Multiplexor::new(client, None, None);
    let _server_mux = Multiplexor::new(server, None, None);
    // Default is no keepalive
    let r = tokio::time::timeout(std::time::Duration::from_secs(5), client_mux.get_datagram())
        .await
        .expect_err("Expected the timeout to timeout");
    assert!(matches!(r, tokio::time::error::Elapsed { .. }));
}