lsp-server-tokio 0.4.0

An async-first LSP server infrastructure crate using Tokio
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
//! Cloneable client communication handle with response routing.

use std::collections::HashMap;
use std::sync::atomic::{AtomicI64, Ordering};
use std::sync::Arc;
use std::time::Duration;

use parking_lot::Mutex;

use thiserror::Error;
use tokio::sync::{mpsc, oneshot};
use tokio_util::sync::CancellationToken;

use crate::{Message, Notification, ProtocolError, Request, RequestId, Response};

/// Shared map for routing responses to waiting callers.
#[derive(Debug, Clone, Default)]
pub(crate) struct ResponseMap {
    pending: Arc<Mutex<HashMap<RequestId, oneshot::Sender<Response>>>>,
}

impl ResponseMap {
    pub(crate) fn new() -> Self {
        Self::default()
    }

    #[cfg(test)]
    pub(crate) fn register(&self, id: RequestId) -> oneshot::Receiver<Response> {
        let (tx, rx) = oneshot::channel();
        self.pending.lock().insert(id, tx);
        rx
    }

    pub(crate) fn try_register(&self, id: RequestId) -> Option<oneshot::Receiver<Response>> {
        let (tx, rx) = oneshot::channel();
        let mut pending = self.pending.lock();
        if pending.contains_key(&id) {
            return None;
        }

        pending.insert(id, tx);
        Some(rx)
    }

    pub(crate) fn contains(&self, id: &RequestId) -> bool {
        self.pending.lock().contains_key(id)
    }

    pub(crate) fn deliver(&self, id: &RequestId, response: Response) -> bool {
        if let Some(tx) = self.pending.lock().remove(id) {
            let _ = tx.send(response);
            true
        } else {
            false
        }
    }

    pub(crate) fn cancel(&self, id: &RequestId) -> bool {
        self.pending.lock().remove(id).is_some()
    }
}

#[derive(Debug)]
struct PendingResponseGuard {
    response_map: ResponseMap,
    id: Option<RequestId>,
}

impl PendingResponseGuard {
    fn new(response_map: ResponseMap, id: RequestId) -> Self {
        Self {
            response_map,
            id: Some(id),
        }
    }

    fn disarm(&mut self) {
        self.id = None;
    }
}

impl Drop for PendingResponseGuard {
    fn drop(&mut self) {
        if let Some(id) = self.id.take() {
            let _ = self.response_map.cancel(&id);
        }
    }
}

/// Error returned when the connection is closed and messages can no longer be queued.
#[derive(Debug, Clone, Error)]
#[error("connection closed")]
pub struct SendError;

/// A cloneable, non-blocking handle for server→client communication.
#[derive(Debug, Clone)]
pub struct ClientSender {
    tx: mpsc::UnboundedSender<Message>,
    response_map: ResponseMap,
    id_counter: Arc<AtomicI64>,
    /// Token that is cancelled when the background drain task exits.
    /// Used to detect disconnection in `request()` instead of hanging forever.
    drain_alive: CancellationToken,
}

impl ClientSender {
    pub(crate) fn new(
        tx: mpsc::UnboundedSender<Message>,
        response_map: ResponseMap,
        drain_alive: CancellationToken,
    ) -> Self {
        Self {
            tx,
            response_map,
            id_counter: Arc::new(AtomicI64::new(1)),
            drain_alive,
        }
    }

    /// Queues a notification for delivery to the client.
    ///
    /// # Errors
    ///
    /// Returns [`SendError`] if the connection has been closed.
    pub fn notify(&self, method: &str, params: Option<serde_json::Value>) -> Result<(), SendError> {
        let notification = Notification::new(method, params);
        self.tx
            .send(Message::Notification(notification))
            .map_err(|_| SendError)
    }

    /// Queues a response for delivery to the client.
    ///
    /// # Errors
    ///
    /// Returns [`SendError`] if the connection has been closed.
    pub fn respond(&self, response: Response) -> Result<(), SendError> {
        self.tx
            .send(Message::Response(response))
            .map_err(|_| SendError)
    }

    /// Sends a request with an auto-generated ID and waits for the response.
    ///
    /// # Errors
    ///
    /// Returns [`ProtocolError::Disconnected`] if the connection is closed before
    /// a response arrives.
    pub async fn request(
        &self,
        method: &str,
        params: Option<serde_json::Value>,
    ) -> Result<Response, ProtocolError> {
        let (id, rx) = self.reserve_request_slot().map_err(ProtocolError::Io)?;
        self.send_registered_request(id, method, params, rx).await
    }

    /// Sends a request and returns a timeout error if no response arrives in time.
    ///
    /// # Errors
    ///
    /// Returns [`ProtocolError::RequestTimeout`] if the timeout elapses, or
    /// [`ProtocolError::Disconnected`] if the connection is closed.
    pub async fn request_timeout(
        &self,
        method: &str,
        params: Option<serde_json::Value>,
        timeout: Duration,
    ) -> Result<Response, ProtocolError> {
        tokio::time::timeout(timeout, self.request(method, params))
            .await
            .map_err(|_| ProtocolError::RequestTimeout)?
    }

    /// Generates the next unique request ID.
    ///
    /// IDs start at 1 (skipping 0 to avoid ambiguity with some clients that
    /// treat 0 as "no ID") and wrap back to 1 after reaching `i32::MAX`.
    ///
    /// # Errors
    ///
    /// Returns an error if the atomic counter update fails or the generated
    /// value is out of `i32` range (both conditions are theoretically
    /// unreachable with the current wrapping logic).
    fn next_id(&self) -> std::io::Result<RequestId> {
        let id = self
            .id_counter
            .fetch_update(Ordering::Relaxed, Ordering::Relaxed, |current| {
                Some(if current >= i64::from(i32::MAX) {
                    1
                } else {
                    current + 1
                })
            })
            .map_err(|current| {
                std::io::Error::other(format!(
                    "request id counter update failed unexpectedly (current value: {current})"
                ))
            })?;

        let id = i32::try_from(id).map_err(|e| {
            std::io::Error::other(format!("generated request id out of i32 range: {e}"))
        })?;

        Ok(RequestId::Integer(id))
    }

    fn reserve_request_slot(&self) -> std::io::Result<(RequestId, oneshot::Receiver<Response>)> {
        const MAX_RETRIES: usize = 1000;
        for _ in 0..MAX_RETRIES {
            let id = self.next_id()?;
            if let Some(rx) = self.response_map.try_register(id.clone()) {
                return Ok((id, rx));
            }
        }
        Err(std::io::Error::other(
            "failed to reserve a request slot after 1000 attempts",
        ))
    }

    #[cfg(test)]
    async fn send_request_with_id(
        &self,
        id: RequestId,
        method: &str,
        params: Option<serde_json::Value>,
    ) -> Result<Response, ProtocolError> {
        let rx = self.response_map.register(id.clone());
        self.send_registered_request(id, method, params, rx).await
    }

    async fn send_registered_request(
        &self,
        id: RequestId,
        method: &str,
        params: Option<serde_json::Value>,
        rx: oneshot::Receiver<Response>,
    ) -> Result<Response, ProtocolError> {
        let mut cleanup = PendingResponseGuard::new(self.response_map.clone(), id.clone());
        let request = Request::new(id.clone(), method, params);

        if self.tx.send(Message::Request(request)).is_err() {
            return Err(ProtocolError::Disconnected);
        }

        tokio::select! {
            result = rx => {
                match result {
                    Ok(response) => {
                        cleanup.disarm();
                        Ok(response)
                    }
                    Err(_) => Err(ProtocolError::Disconnected),
                }
            }
            () = self.drain_alive.cancelled() => {
                Err(ProtocolError::Disconnected)
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use futures::future::join_all;
    use futures::StreamExt;
    use serde_json::json;

    use crate::{Connection, IncomingMessage};

    fn assert_clone_send_sync<T: Clone + Send + Sync>() {}

    #[test]
    fn client_sender_is_clone_send_sync() {
        assert_clone_send_sync::<ClientSender>();
    }

    #[tokio::test]
    async fn client_sender_notify_sends_notification() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        sender
            .notify("window/logMessage", Some(json!({"type": 4})))
            .unwrap();

        match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Notification(notification) => {
                assert_eq!(notification.method, "window/logMessage");
                assert_eq!(notification.params, Some(json!({"type": 4})));
            }
            other => panic!("expected notification, got {other:?}"),
        }
    }

    #[tokio::test]
    async fn client_sender_respond_sends_response() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        sender.respond(Response::ok(7, json!("ok"))).unwrap();

        match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Response(response) => {
                assert_eq!(response.id, Some(7.into()));
                assert_eq!(response.result().cloned(), Some(json!("ok")));
            }
            other => panic!("expected response, got {other:?}"),
        }
    }

    #[tokio::test]
    async fn client_sender_request_auto_id() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let first_sender = sender.clone();
        let first_task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move {
                first_sender
                    .request("first", None::<serde_json::Value>)
                    .await
            });

        let first_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => {
                assert_eq!(request.method, "first");
                request.id
            }
            other => panic!("expected request, got {other:?}"),
        };
        assert_eq!(first_id, RequestId::Integer(1));

        let second_sender = sender.clone();
        let second_task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move {
                second_sender
                    .request("second", None::<serde_json::Value>)
                    .await
            });

        let second_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => {
                assert_eq!(request.method, "second");
                request.id
            }
            other => panic!("expected request, got {other:?}"),
        };
        assert_eq!(second_id, RequestId::Integer(2));

        assert!(matches!(
            server.route(Message::Response(Response::ok(
                first_id.clone(),
                json!("first")
            ))),
            IncomingMessage::ResponseRouted
        ));
        assert!(matches!(
            server.route(Message::Response(Response::ok(
                second_id.clone(),
                json!("second")
            ))),
            IncomingMessage::ResponseRouted
        ));

        assert_eq!(first_task.await.unwrap().unwrap().id, Some(first_id));
        assert_eq!(second_task.await.unwrap().unwrap().id, Some(second_id));
    }

    #[tokio::test]
    async fn client_sender_request_gets_response() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move {
                sender
                    .request("workspace/configuration", Some(json!({"items": []})))
                    .await
            });

        let id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => {
                assert_eq!(request.method, "workspace/configuration");
                request.id
            }
            other => panic!("expected request, got {other:?}"),
        };

        let routed = server.route(Message::Response(Response::ok(
            id.clone(),
            json!({"settings": []}),
        )));
        assert!(matches!(routed, IncomingMessage::ResponseRouted));

        let response = task.await.unwrap().unwrap();
        assert_eq!(response.id, Some(id));
        assert_eq!(response.result().cloned(), Some(json!({"settings": []})));
    }

    #[tokio::test]
    async fn client_sender_concurrent_requests() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let methods = ["first", "second", "third"];
        let tasks = methods.into_iter().map(|method| {
            let sender = sender.clone();
            let method = method.to_string();
            tokio::spawn(async move {
                let response = sender
                    .request(&method, None::<serde_json::Value>)
                    .await
                    .unwrap();
                (method, response)
            })
        });
        let tasks = join_all(tasks);

        let mut requests = Vec::new();
        for _ in 0..3 {
            match client.receiver_mut().next().await.unwrap().unwrap() {
                Message::Request(request) => requests.push(request),
                other => panic!("expected request, got {other:?}"),
            }
        }

        for request in [
            requests[2].clone(),
            requests[0].clone(),
            requests[1].clone(),
        ] {
            assert!(matches!(
                server.route(Message::Response(Response::ok(
                    request.id.clone(),
                    json!(request.method.clone()),
                ))),
                IncomingMessage::ResponseRouted
            ));
        }

        let results = tasks.await;
        for result in results {
            let (method, response) = result.unwrap();
            assert_eq!(response.result().cloned(), Some(json!(method)));
        }
    }

    #[tokio::test(start_paused = true)]
    async fn client_sender_request_timeout() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let _client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move {
                sender
                    .request_timeout(
                        "workspace/configuration",
                        None::<serde_json::Value>,
                        Duration::from_secs(5),
                    )
                    .await
            });

        tokio::task::yield_now().await;
        tokio::time::advance(Duration::from_secs(5)).await;

        let result = task.await.unwrap();
        assert!(matches!(result, Err(ProtocolError::RequestTimeout)));
    }

    #[tokio::test]
    async fn client_sender_request_disconnected() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        drop(client);
        // Give the runtime a chance to process the duplex close.
        // The client's drain task needs to observe the channel close and exit.
        tokio::task::yield_now().await;

        let result = tokio::time::timeout(
            Duration::from_secs(1),
            sender.request("test", None::<serde_json::Value>),
        )
        .await
        .unwrap();
        assert!(matches!(result, Err(ProtocolError::Disconnected)));
    }

    #[tokio::test]
    async fn client_sender_notify_after_close() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        drop(client);
        let _ = sender.notify("window/logMessage", None);

        tokio::time::timeout(Duration::from_secs(1), async {
            loop {
                if sender.notify("window/logMessage", None).is_err() {
                    break;
                }
                tokio::task::yield_now().await;
            }
        })
        .await
        .unwrap();
    }

    #[tokio::test]
    async fn client_sender_multiple_clones_share_state() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();
        let sender_clone = sender.clone();

        let first_task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move { sender.request("first", None::<serde_json::Value>).await });
        let second_task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move {
                sender_clone
                    .request("second", None::<serde_json::Value>)
                    .await
            });

        let first_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };
        let second_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };

        assert_eq!(first_request.id, RequestId::Integer(1));
        assert_eq!(second_request.id, RequestId::Integer(2));

        assert!(matches!(
            server.route(Message::Response(Response::ok(
                first_request.id.clone(),
                json!(first_request.method.clone()),
            ))),
            IncomingMessage::ResponseRouted
        ));
        assert!(matches!(
            server.route(Message::Response(Response::ok(
                second_request.id.clone(),
                json!(second_request.method.clone()),
            ))),
            IncomingMessage::ResponseRouted
        ));

        assert_eq!(
            first_task.await.unwrap().unwrap().into_result(),
            Some(json!("first"))
        );
        assert_eq!(
            second_task.await.unwrap().unwrap().into_result(),
            Some(json!("second"))
        );
    }

    #[tokio::test]
    async fn route_delivers_to_response_map() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move { sender.request("test", None::<serde_json::Value>).await });

        let request_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request.id,
            other => panic!("expected request, got {other:?}"),
        };

        let routed = server.route(Message::Response(Response::ok(
            request_id.clone(),
            json!(true),
        )));
        assert!(matches!(routed, IncomingMessage::ResponseRouted));

        let response = task.await.unwrap().unwrap();
        assert_eq!(response.id, Some(request_id));
    }

    #[tokio::test]
    async fn route_response_map_takes_priority() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task: tokio::task::JoinHandle<Result<Response, ProtocolError>> =
            tokio::spawn(async move { sender.request("test", None::<serde_json::Value>).await });

        let request_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request.id,
            other => panic!("expected request, got {other:?}"),
        };
        let _outgoing_rx = server.request_queue.outgoing.register(request_id.clone());

        let routed = server.route(Message::Response(Response::ok(
            request_id.clone(),
            json!("response-map"),
        )));
        assert!(matches!(routed, IncomingMessage::ResponseRouted));
        assert!(server.request_queue.outgoing.is_pending(&request_id));

        let response = task.await.unwrap().unwrap();
        assert_eq!(response.result().cloned(), Some(json!("response-map")));
    }

    #[tokio::test]
    async fn client_sender_request_timeout_does_not_swallow_late_response() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task = tokio::spawn(async move {
            sender
                .request_timeout(
                    "late-response",
                    None::<serde_json::Value>,
                    Duration::from_millis(10),
                )
                .await
        });

        let request_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request.id,
            other => panic!("expected request, got {other:?}"),
        };

        let result = task.await.unwrap();
        assert!(matches!(result, Err(ProtocolError::RequestTimeout)));

        let routed = server.route(Message::Response(Response::ok(
            request_id.clone(),
            json!(true),
        )));
        match routed {
            IncomingMessage::ResponseUnknown(response) => {
                assert_eq!(response.id, Some(request_id));
            }
            other => panic!("late response should not be swallowed after timeout, got {other:?}"),
        }
    }

    #[tokio::test]
    async fn client_sender_aborted_request_does_not_swallow_late_response() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let task =
            tokio::spawn(async move { sender.request("aborted", None::<serde_json::Value>).await });

        let request_id = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request.id,
            other => panic!("expected request, got {other:?}"),
        };

        task.abort();
        let _ = task.await;

        let routed = server.route(Message::Response(Response::ok(
            request_id.clone(),
            json!(true),
        )));
        match routed {
            IncomingMessage::ResponseUnknown(response) => {
                assert_eq!(response.id, Some(request_id));
            }
            other => panic!("late response should not be swallowed after abort, got {other:?}"),
        }
    }

    #[tokio::test]
    async fn client_sender_wraparound_does_not_reuse_pending_id() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let first_sender = sender.clone();
        let first_task = tokio::spawn(async move {
            first_sender
                .send_request_with_id(RequestId::Integer(1), "first", None::<serde_json::Value>)
                .await
        });

        let first_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };
        assert_eq!(first_request.id, RequestId::Integer(1));

        sender
            .id_counter
            .store(i64::from(i32::MAX), Ordering::Relaxed);

        let max_sender = sender.clone();
        let max_task =
            tokio::spawn(async move { max_sender.request("max", None::<serde_json::Value>).await });
        let wrapped_sender = sender.clone();
        let wrapped_task = tokio::spawn(async move {
            wrapped_sender
                .request("wrapped", None::<serde_json::Value>)
                .await
        });

        let second_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };
        let third_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };

        assert_ne!(second_request.id, first_request.id);
        assert_ne!(
            third_request.id, first_request.id,
            "wrapped request reused an active pending id"
        );
        assert_ne!(second_request.id, third_request.id);

        assert!(matches!(
            server.route(Message::Response(Response::ok(
                first_request.id.clone(),
                json!("first")
            ))),
            IncomingMessage::ResponseRouted
        ));
        assert!(matches!(
            server.route(Message::Response(Response::ok(
                second_request.id.clone(),
                json!("second")
            ))),
            IncomingMessage::ResponseRouted
        ));
        assert!(matches!(
            server.route(Message::Response(Response::ok(
                third_request.id.clone(),
                json!("third")
            ))),
            IncomingMessage::ResponseRouted
        ));

        assert_eq!(
            first_task.await.unwrap().unwrap().into_result(),
            Some(json!("first"))
        );
        assert_eq!(
            max_task.await.unwrap().unwrap().into_result(),
            Some(json!("second"))
        );
        assert_eq!(
            wrapped_task.await.unwrap().unwrap().into_result(),
            Some(json!("third"))
        );
    }

    #[tokio::test]
    async fn client_sender_timeout_preserves_other_pending_requests() {
        let (client_stream, server_stream) = tokio::io::duplex(4096);
        let mut server: Connection<_, ()> = Connection::new(server_stream);
        let mut client: Connection<_, ()> = Connection::new(client_stream);
        let sender = server.client_sender();

        let timeout_sender = sender.clone();
        let timeout_task = tokio::spawn(async move {
            timeout_sender
                .request_timeout(
                    "timeout",
                    None::<serde_json::Value>,
                    Duration::from_millis(10),
                )
                .await
        });
        let ok_sender = sender.clone();
        let ok_task =
            tokio::spawn(async move { ok_sender.request("ok", None::<serde_json::Value>).await });

        let first_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };
        let second_request = match client.receiver_mut().next().await.unwrap().unwrap() {
            Message::Request(request) => request,
            other => panic!("expected request, got {other:?}"),
        };

        let (timed_out, live_request) = if first_request.method == "timeout" {
            (first_request, second_request)
        } else {
            (second_request, first_request)
        };

        let result = timeout_task.await.unwrap();
        assert!(matches!(result, Err(ProtocolError::RequestTimeout)));

        assert!(matches!(
            server.route(Message::Response(Response::ok(
                live_request.id.clone(),
                json!("ok")
            ))),
            IncomingMessage::ResponseRouted
        ));
        assert_eq!(
            ok_task.await.unwrap().unwrap().result().cloned(),
            Some(json!("ok"))
        );

        let routed = server.route(Message::Response(Response::ok(
            timed_out.id.clone(),
            json!("late"),
        )));
        assert!(matches!(routed, IncomingMessage::ResponseUnknown(_)));
    }

    #[tokio::test]
    async fn response_map_cancel_ignores_unknown_id() {
        let response_map = ResponseMap::new();

        assert!(!response_map.cancel(&RequestId::Integer(404)));
        assert!(!response_map.deliver(&RequestId::Integer(404), Response::ok(404, json!(null))));
    }
}