1use super::{
2 Connection,
3 message_stream::{Message, MessageStream},
4 proto::{
5 self, AnyTypedEnvelope, EnvelopedMessage, PeerId, Receipt, RequestMessage, TypedEnvelope,
6 },
7};
8use anyhow::{Context as _, Result, anyhow};
9use collections::HashMap;
10use futures::{
11 FutureExt, SinkExt, Stream, StreamExt, TryFutureExt,
12 channel::{mpsc, oneshot},
13 stream::BoxStream,
14};
15use parking_lot::{Mutex, RwLock};
16use proto::{ErrorCode, ErrorCodeExt, ErrorExt, RpcError};
17use serde::{Serialize, ser::SerializeStruct};
18use std::{
19 fmt, future,
20 future::Future,
21 sync::atomic::Ordering::SeqCst,
22 sync::{
23 Arc,
24 atomic::{self, AtomicU32},
25 },
26 time::Duration,
27 time::Instant,
28};
29use tracing::instrument;
30
31#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Serialize)]
32pub struct ConnectionId {
33 pub owner_id: u32,
34 pub id: u32,
35}
36
37impl From<ConnectionId> for PeerId {
38 fn from(id: ConnectionId) -> Self {
39 PeerId {
40 owner_id: id.owner_id,
41 id: id.id,
42 }
43 }
44}
45
46impl From<PeerId> for ConnectionId {
47 fn from(peer_id: PeerId) -> Self {
48 Self {
49 owner_id: peer_id.owner_id,
50 id: peer_id.id,
51 }
52 }
53}
54
55impl fmt::Display for ConnectionId {
56 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
57 write!(f, "{}/{}", self.owner_id, self.id)
58 }
59}
60
61pub struct Peer {
62 epoch: AtomicU32,
63 pub connections: RwLock<HashMap<ConnectionId, ConnectionState>>,
64 next_connection_id: AtomicU32,
65}
66
67#[derive(Clone, Serialize)]
68pub struct ConnectionState {
69 #[serde(skip)]
70 outgoing_tx: mpsc::UnboundedSender<Message>,
71 next_message_id: Arc<AtomicU32>,
72 #[allow(clippy::type_complexity)]
73 #[serde(skip)]
74 response_channels: Arc<
75 Mutex<
76 Option<
77 HashMap<
78 u32,
79 oneshot::Sender<(proto::Envelope, std::time::Instant, oneshot::Sender<()>)>,
80 >,
81 >,
82 >,
83 >,
84 #[allow(clippy::type_complexity)]
85 #[serde(skip)]
86 stream_response_channels: Arc<
87 Mutex<
88 Option<
89 HashMap<u32, mpsc::UnboundedSender<(Result<proto::Envelope>, oneshot::Sender<()>)>>,
90 >,
91 >,
92 >,
93}
94
95const KEEPALIVE_INTERVAL: Duration = Duration::from_secs(1);
96const WRITE_TIMEOUT: Duration = Duration::from_secs(2);
97pub const RECEIVE_TIMEOUT: Duration = Duration::from_secs(10);
98
99impl Peer {
100 pub fn new(epoch: u32) -> Arc<Self> {
101 Arc::new(Self {
102 epoch: AtomicU32::new(epoch),
103 connections: Default::default(),
104 next_connection_id: Default::default(),
105 })
106 }
107
108 pub fn epoch(&self) -> u32 {
109 self.epoch.load(SeqCst)
110 }
111
112 #[instrument(skip_all)]
113 pub fn add_connection<F, Fut, Out>(
114 self: &Arc<Self>,
115 connection: Connection,
116 create_timer: F,
117 ) -> (
118 ConnectionId,
119 impl Future<Output = anyhow::Result<()>> + Send + use<F, Fut, Out>,
120 BoxStream<'static, Box<dyn AnyTypedEnvelope>>,
121 )
122 where
123 F: Send + Fn(Duration) -> Fut,
124 Fut: Send + Future<Output = Out>,
125 Out: Send,
126 {
127 // For outgoing messages, use an unbounded channel so that application code
128 // can always send messages without yielding. For incoming messages, use a
129 // bounded channel so that other peers will receive backpressure if they send
130 // messages faster than this peer can process them.
131 #[cfg(any(test, feature = "test-support"))]
132 const INCOMING_BUFFER_SIZE: usize = 1;
133 #[cfg(not(any(test, feature = "test-support")))]
134 const INCOMING_BUFFER_SIZE: usize = 256;
135 let (mut incoming_tx, incoming_rx) = mpsc::channel(INCOMING_BUFFER_SIZE);
136 let (outgoing_tx, mut outgoing_rx) = mpsc::unbounded();
137
138 let connection_id = ConnectionId {
139 owner_id: self.epoch.load(SeqCst),
140 id: self.next_connection_id.fetch_add(1, SeqCst),
141 };
142 let connection_state = ConnectionState {
143 outgoing_tx,
144 next_message_id: Default::default(),
145 response_channels: Arc::new(Mutex::new(Some(Default::default()))),
146 stream_response_channels: Arc::new(Mutex::new(Some(Default::default()))),
147 };
148 let mut writer = MessageStream::new(connection.tx);
149 let mut reader = MessageStream::new(connection.rx);
150
151 let this = self.clone();
152 let response_channels = connection_state.response_channels.clone();
153 let stream_response_channels = connection_state.stream_response_channels.clone();
154
155 let handle_io = async move {
156 tracing::trace!(%connection_id, "handle io future: start");
157
158 let _end_connection = util::defer(|| {
159 response_channels.lock().take();
160 if let Some(channels) = stream_response_channels.lock().take() {
161 for channel in channels.values() {
162 let _ = channel.unbounded_send((
163 Err(anyhow!("connection closed")),
164 oneshot::channel().0,
165 ));
166 }
167 }
168 this.connections.write().remove(&connection_id);
169 tracing::trace!(%connection_id, "handle io future: end");
170 });
171
172 // Send messages on this frequency so the connection isn't closed.
173 let keepalive_timer = create_timer(KEEPALIVE_INTERVAL).fuse();
174 futures::pin_mut!(keepalive_timer);
175
176 // Disconnect if we don't receive messages at least this frequently.
177 let receive_timeout = create_timer(RECEIVE_TIMEOUT).fuse();
178 futures::pin_mut!(receive_timeout);
179
180 loop {
181 tracing::trace!(%connection_id, "outer loop iteration start");
182 let read_message = reader.read().fuse();
183 futures::pin_mut!(read_message);
184
185 loop {
186 tracing::trace!(%connection_id, "inner loop iteration start");
187 futures::select_biased! {
188 outgoing = outgoing_rx.next().fuse() => match outgoing {
189 Some(outgoing) => {
190 tracing::trace!(%connection_id, "outgoing rpc message: writing");
191 futures::select_biased! {
192 result = writer.write(outgoing).fuse() => {
193 tracing::trace!(%connection_id, "outgoing rpc message: done writing");
194 result.context("failed to write RPC message")?;
195 tracing::trace!(%connection_id, "keepalive interval: resetting after sending message");
196 keepalive_timer.set(create_timer(KEEPALIVE_INTERVAL).fuse());
197 }
198 _ = create_timer(WRITE_TIMEOUT).fuse() => {
199 tracing::trace!(%connection_id, "outgoing rpc message: writing timed out");
200 Err(anyhow!("timed out writing message"))?;
201 }
202 }
203 }
204 None => {
205 tracing::trace!(%connection_id, "outgoing rpc message: channel closed");
206 return Ok(())
207 },
208 },
209 _ = keepalive_timer => {
210 tracing::trace!(%connection_id, "keepalive interval: pinging");
211 futures::select_biased! {
212 result = writer.write(Message::Ping).fuse() => {
213 tracing::trace!(%connection_id, "keepalive interval: done pinging");
214 result.context("failed to send keepalive")?;
215 tracing::trace!(%connection_id, "keepalive interval: resetting after pinging");
216 keepalive_timer.set(create_timer(KEEPALIVE_INTERVAL).fuse());
217 }
218 _ = create_timer(WRITE_TIMEOUT).fuse() => {
219 tracing::trace!(%connection_id, "keepalive interval: pinging timed out");
220 Err(anyhow!("timed out sending keepalive"))?;
221 }
222 }
223 }
224 incoming = read_message => {
225 let incoming = incoming.context("error reading rpc message from socket")?;
226 tracing::trace!(%connection_id, "incoming rpc message: received");
227 tracing::trace!(%connection_id, "receive timeout: resetting");
228 receive_timeout.set(create_timer(RECEIVE_TIMEOUT).fuse());
229 if let (Message::Envelope(incoming), received_at) = incoming {
230 tracing::trace!(%connection_id, "incoming rpc message: processing");
231 futures::select_biased! {
232 result = incoming_tx.send((incoming, received_at)).fuse() => match result {
233 Ok(_) => {
234 tracing::trace!(%connection_id, "incoming rpc message: processed");
235 }
236 Err(_) => {
237 tracing::trace!(%connection_id, "incoming rpc message: channel closed");
238 return Ok(())
239 }
240 },
241 _ = create_timer(WRITE_TIMEOUT).fuse() => {
242 tracing::trace!(%connection_id, "incoming rpc message: processing timed out");
243 Err(anyhow!("timed out processing incoming message"))?
244 }
245 }
246 }
247 break;
248 },
249 _ = receive_timeout => {
250 tracing::trace!(%connection_id, "receive timeout: delay between messages too long");
251 Err(anyhow!("delay between messages too long"))?
252 }
253 }
254 }
255 }
256 };
257
258 let response_channels = connection_state.response_channels.clone();
259 let stream_response_channels = connection_state.stream_response_channels.clone();
260 self.connections
261 .write()
262 .insert(connection_id, connection_state);
263
264 let incoming_rx = incoming_rx.filter_map(move |(incoming, received_at)| {
265 let response_channels = response_channels.clone();
266 let stream_response_channels = stream_response_channels.clone();
267 async move {
268 let message_id = incoming.id;
269 tracing::trace!(?incoming, "incoming message future: start");
270 let _end = util::defer(move || {
271 tracing::trace!(%connection_id, message_id, "incoming message future: end");
272 });
273
274 if let Some(responding_to) = incoming.responding_to {
275 tracing::trace!(
276 %connection_id,
277 message_id,
278 responding_to,
279 "incoming response: received"
280 );
281 let response_channel =
282 response_channels.lock().as_mut()?.remove(&responding_to);
283 let stream_response_channel = stream_response_channels
284 .lock()
285 .as_ref()?
286 .get(&responding_to)
287 .cloned();
288
289 if let Some(tx) = response_channel {
290 let requester_resumed = oneshot::channel();
291 if let Err(error) = tx.send((incoming, received_at, requester_resumed.0)) {
292 tracing::trace!(
293 %connection_id,
294 message_id,
295 responding_to = responding_to,
296 ?error,
297 "incoming response: request future dropped",
298 );
299 }
300
301 tracing::trace!(
302 %connection_id,
303 message_id,
304 responding_to,
305 "incoming response: waiting to resume requester"
306 );
307 let _ = requester_resumed.1.await;
308 tracing::trace!(
309 %connection_id,
310 message_id,
311 responding_to,
312 "incoming response: requester resumed"
313 );
314 } else if let Some(tx) = stream_response_channel {
315 let requester_resumed = oneshot::channel();
316 if let Err(error) = tx.unbounded_send((Ok(incoming), requester_resumed.0)) {
317 tracing::debug!(
318 %connection_id,
319 message_id,
320 responding_to = responding_to,
321 ?error,
322 "incoming stream response: request future dropped",
323 );
324 }
325
326 tracing::debug!(
327 %connection_id,
328 message_id,
329 responding_to,
330 "incoming stream response: waiting to resume requester"
331 );
332 let _ = requester_resumed.1.await;
333 tracing::debug!(
334 %connection_id,
335 message_id,
336 responding_to,
337 "incoming stream response: requester resumed"
338 );
339 } else {
340 let message_type = proto::build_typed_envelope(
341 connection_id.into(),
342 received_at,
343 incoming,
344 )
345 .map(|p| p.payload_type_name());
346 tracing::warn!(
347 %connection_id,
348 message_id,
349 responding_to,
350 message_type,
351 "incoming response: unknown request"
352 );
353 }
354
355 None
356 } else {
357 tracing::trace!(%connection_id, message_id, "incoming message: received");
358 proto::build_typed_envelope(connection_id.into(), received_at, incoming)
359 .or_else(|| {
360 tracing::error!(
361 %connection_id,
362 message_id,
363 "unable to construct a typed envelope"
364 );
365 None
366 })
367 }
368 }
369 });
370 (connection_id, handle_io, incoming_rx.boxed())
371 }
372
373 #[cfg(any(test, feature = "test-support"))]
374 pub fn add_test_connection(
375 self: &Arc<Self>,
376 connection: Connection,
377 executor: gpui::BackgroundExecutor,
378 ) -> (
379 ConnectionId,
380 impl Future<Output = anyhow::Result<()>> + Send + use<>,
381 BoxStream<'static, Box<dyn AnyTypedEnvelope>>,
382 ) {
383 let executor = executor.clone();
384 self.add_connection(connection, move |duration| executor.timer(duration))
385 }
386
387 pub fn disconnect(&self, connection_id: ConnectionId) {
388 self.connections.write().remove(&connection_id);
389 }
390
391 #[cfg(any(test, feature = "test-support"))]
392 pub fn reset(&self, epoch: u32) {
393 self.next_connection_id.store(0, SeqCst);
394 self.epoch.store(epoch, SeqCst);
395 }
396
397 pub fn teardown(&self) {
398 self.connections.write().clear();
399 }
400
401 /// Make a request and wait for a response.
402 pub fn request<T: RequestMessage>(
403 &self,
404 receiver_id: ConnectionId,
405 request: T,
406 ) -> impl Future<Output = Result<T::Response>> + use<T> {
407 self.request_internal(None, receiver_id, request)
408 .map_ok(|envelope| envelope.payload)
409 }
410
411 pub fn request_envelope<T: RequestMessage>(
412 &self,
413 receiver_id: ConnectionId,
414 request: T,
415 ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> + use<T> {
416 self.request_internal(None, receiver_id, request)
417 }
418
419 pub fn forward_request<T: RequestMessage>(
420 &self,
421 sender_id: ConnectionId,
422 receiver_id: ConnectionId,
423 request: T,
424 ) -> impl Future<Output = Result<T::Response>> {
425 self.request_internal(Some(sender_id), receiver_id, request)
426 .map_ok(|envelope| envelope.payload)
427 }
428
429 fn request_internal<T: RequestMessage>(
430 &self,
431 original_sender_id: Option<ConnectionId>,
432 receiver_id: ConnectionId,
433 request: T,
434 ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> + use<T> {
435 let envelope = request.into_envelope(0, None, original_sender_id.map(Into::into));
436 let response = self.request_dynamic(receiver_id, envelope, T::NAME);
437 async move {
438 let (response, received_at) = response.await?;
439 Ok(TypedEnvelope {
440 message_id: response.id,
441 sender_id: receiver_id.into(),
442 original_sender_id: response.original_sender_id,
443 payload: T::Response::from_envelope(response)
444 .ok_or_else(|| anyhow!("received response of the wrong type"))?,
445 received_at,
446 })
447 }
448 }
449
450 /// Make a request and wait for a response.
451 ///
452 /// The caller must make sure to deserialize the response into the request's
453 /// response type. This interface is only useful in trait objects, where
454 /// generics can't be used. If you have a concrete type, use `request`.
455 pub fn request_dynamic(
456 &self,
457 receiver_id: ConnectionId,
458 mut envelope: proto::Envelope,
459 type_name: &'static str,
460 ) -> impl Future<Output = Result<(proto::Envelope, Instant)>> + use<> {
461 let (tx, rx) = oneshot::channel();
462 let send = self.connection_state(receiver_id).and_then(|connection| {
463 envelope.id = connection.next_message_id.fetch_add(1, SeqCst);
464 connection
465 .response_channels
466 .lock()
467 .as_mut()
468 .ok_or_else(|| anyhow!("connection was closed"))?
469 .insert(envelope.id, tx);
470 connection
471 .outgoing_tx
472 .unbounded_send(Message::Envelope(envelope))
473 .map_err(|_| anyhow!("connection was closed"))?;
474 Ok(())
475 });
476 async move {
477 send?;
478 let (response, received_at, _barrier) =
479 rx.await.map_err(|_| anyhow!("connection was closed"))?;
480 if let Some(proto::envelope::Payload::Error(error)) = &response.payload {
481 return Err(RpcError::from_proto(error, type_name));
482 }
483 Ok((response, received_at))
484 }
485 }
486
487 pub fn request_stream<T: RequestMessage>(
488 &self,
489 receiver_id: ConnectionId,
490 request: T,
491 ) -> impl Future<Output = Result<impl Unpin + Stream<Item = Result<T::Response>>>> {
492 let (tx, rx) = mpsc::unbounded();
493 let send = self.connection_state(receiver_id).and_then(|connection| {
494 let message_id = connection.next_message_id.fetch_add(1, SeqCst);
495 let stream_response_channels = connection.stream_response_channels.clone();
496 stream_response_channels
497 .lock()
498 .as_mut()
499 .ok_or_else(|| anyhow!("connection was closed"))?
500 .insert(message_id, tx);
501 connection
502 .outgoing_tx
503 .unbounded_send(Message::Envelope(
504 request.into_envelope(message_id, None, None),
505 ))
506 .map_err(|_| anyhow!("connection was closed"))?;
507 Ok((message_id, stream_response_channels))
508 });
509
510 async move {
511 let (message_id, stream_response_channels) = send?;
512 let stream_response_channels = Arc::downgrade(&stream_response_channels);
513
514 Ok(rx.filter_map(move |(response, _barrier)| {
515 let stream_response_channels = stream_response_channels.clone();
516 future::ready(match response {
517 Ok(response) => {
518 if let Some(proto::envelope::Payload::Error(error)) = &response.payload {
519 Some(Err(RpcError::from_proto(error, T::NAME)))
520 } else if let Some(proto::envelope::Payload::EndStream(_)) =
521 &response.payload
522 {
523 // Remove the transmitting end of the response channel to end the stream.
524 if let Some(channels) = stream_response_channels.upgrade() {
525 if let Some(channels) = channels.lock().as_mut() {
526 channels.remove(&message_id);
527 }
528 }
529 None
530 } else {
531 Some(
532 T::Response::from_envelope(response)
533 .ok_or_else(|| anyhow!("received response of the wrong type")),
534 )
535 }
536 }
537 Err(error) => Some(Err(error)),
538 })
539 }))
540 }
541 }
542
543 pub fn send<T: EnvelopedMessage>(&self, receiver_id: ConnectionId, message: T) -> Result<()> {
544 let connection = self.connection_state(receiver_id)?;
545 let message_id = connection
546 .next_message_id
547 .fetch_add(1, atomic::Ordering::SeqCst);
548 connection.outgoing_tx.unbounded_send(Message::Envelope(
549 message.into_envelope(message_id, None, None),
550 ))?;
551 Ok(())
552 }
553
554 pub fn send_dynamic(&self, receiver_id: ConnectionId, message: proto::Envelope) -> Result<()> {
555 let connection = self.connection_state(receiver_id)?;
556 connection
557 .outgoing_tx
558 .unbounded_send(Message::Envelope(message))?;
559 Ok(())
560 }
561
562 pub fn forward_send<T: EnvelopedMessage>(
563 &self,
564 sender_id: ConnectionId,
565 receiver_id: ConnectionId,
566 message: T,
567 ) -> Result<()> {
568 let connection = self.connection_state(receiver_id)?;
569 let message_id = connection
570 .next_message_id
571 .fetch_add(1, atomic::Ordering::SeqCst);
572 connection
573 .outgoing_tx
574 .unbounded_send(Message::Envelope(message.into_envelope(
575 message_id,
576 None,
577 Some(sender_id.into()),
578 )))?;
579 Ok(())
580 }
581
582 pub fn respond<T: RequestMessage>(
583 &self,
584 receipt: Receipt<T>,
585 response: T::Response,
586 ) -> Result<()> {
587 let connection = self.connection_state(receipt.sender_id.into())?;
588 let message_id = connection
589 .next_message_id
590 .fetch_add(1, atomic::Ordering::SeqCst);
591 connection
592 .outgoing_tx
593 .unbounded_send(Message::Envelope(response.into_envelope(
594 message_id,
595 Some(receipt.message_id),
596 None,
597 )))?;
598 Ok(())
599 }
600
601 pub fn end_stream<T: RequestMessage>(&self, receipt: Receipt<T>) -> Result<()> {
602 let connection = self.connection_state(receipt.sender_id.into())?;
603 let message_id = connection
604 .next_message_id
605 .fetch_add(1, atomic::Ordering::SeqCst);
606
607 let message = proto::EndStream {};
608
609 connection
610 .outgoing_tx
611 .unbounded_send(Message::Envelope(message.into_envelope(
612 message_id,
613 Some(receipt.message_id),
614 None,
615 )))?;
616 Ok(())
617 }
618
619 pub fn respond_with_error<T: RequestMessage>(
620 &self,
621 receipt: Receipt<T>,
622 response: proto::Error,
623 ) -> Result<()> {
624 let connection = self.connection_state(receipt.sender_id.into())?;
625 let message_id = connection
626 .next_message_id
627 .fetch_add(1, atomic::Ordering::SeqCst);
628 connection
629 .outgoing_tx
630 .unbounded_send(Message::Envelope(response.into_envelope(
631 message_id,
632 Some(receipt.message_id),
633 None,
634 )))?;
635 Ok(())
636 }
637
638 pub fn respond_with_unhandled_message(
639 &self,
640 sender_id: ConnectionId,
641 request_message_id: u32,
642 message_type_name: &'static str,
643 ) -> Result<()> {
644 let connection = self.connection_state(sender_id)?;
645 let response = ErrorCode::Internal
646 .message(format!("message {} was not handled", message_type_name))
647 .to_proto();
648 let message_id = connection
649 .next_message_id
650 .fetch_add(1, atomic::Ordering::SeqCst);
651 connection
652 .outgoing_tx
653 .unbounded_send(Message::Envelope(response.into_envelope(
654 message_id,
655 Some(request_message_id),
656 None,
657 )))?;
658 Ok(())
659 }
660
661 fn connection_state(&self, connection_id: ConnectionId) -> Result<ConnectionState> {
662 let connections = self.connections.read();
663 let connection = connections
664 .get(&connection_id)
665 .ok_or_else(|| anyhow!("no such connection: {}", connection_id))?;
666 Ok(connection.clone())
667 }
668}
669
670impl Serialize for Peer {
671 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
672 where
673 S: serde::Serializer,
674 {
675 let mut state = serializer.serialize_struct("Peer", 2)?;
676 state.serialize_field("connections", &*self.connections.read())?;
677 state.end()
678 }
679}
680
681#[cfg(test)]
682mod tests {
683 use super::*;
684 use async_tungstenite::tungstenite::Message as WebSocketMessage;
685 use gpui::TestAppContext;
686
687 fn init_logger() {
688 if std::env::var("RUST_LOG").is_ok() {
689 env_logger::init();
690 }
691 }
692
693 #[gpui::test(iterations = 50)]
694 async fn test_request_response(cx: &mut TestAppContext) {
695 init_logger();
696
697 let executor = cx.executor();
698
699 // create 2 clients connected to 1 server
700 let server = Peer::new(0);
701 let client1 = Peer::new(0);
702 let client2 = Peer::new(0);
703
704 let (client1_to_server_conn, server_to_client_1_conn, _kill) =
705 Connection::in_memory(cx.executor());
706 let (client1_conn_id, io_task1, client1_incoming) =
707 client1.add_test_connection(client1_to_server_conn, cx.executor());
708 let (_, io_task2, server_incoming1) =
709 server.add_test_connection(server_to_client_1_conn, cx.executor());
710
711 let (client2_to_server_conn, server_to_client_2_conn, _kill) =
712 Connection::in_memory(cx.executor());
713 let (client2_conn_id, io_task3, client2_incoming) =
714 client2.add_test_connection(client2_to_server_conn, cx.executor());
715 let (_, io_task4, server_incoming2) =
716 server.add_test_connection(server_to_client_2_conn, cx.executor());
717
718 executor.spawn(io_task1).detach();
719 executor.spawn(io_task2).detach();
720 executor.spawn(io_task3).detach();
721 executor.spawn(io_task4).detach();
722 executor
723 .spawn(handle_messages(server_incoming1, server.clone()))
724 .detach();
725 executor
726 .spawn(handle_messages(client1_incoming, client1.clone()))
727 .detach();
728 executor
729 .spawn(handle_messages(server_incoming2, server.clone()))
730 .detach();
731 executor
732 .spawn(handle_messages(client2_incoming, client2.clone()))
733 .detach();
734
735 assert_eq!(
736 client1
737 .request(client1_conn_id, proto::Ping {},)
738 .await
739 .unwrap(),
740 proto::Ack {}
741 );
742
743 assert_eq!(
744 client2
745 .request(client2_conn_id, proto::Ping {},)
746 .await
747 .unwrap(),
748 proto::Ack {}
749 );
750
751 assert_eq!(
752 client1
753 .request(client1_conn_id, proto::Test { id: 1 },)
754 .await
755 .unwrap(),
756 proto::Test { id: 1 }
757 );
758
759 assert_eq!(
760 client2
761 .request(client2_conn_id, proto::Test { id: 2 })
762 .await
763 .unwrap(),
764 proto::Test { id: 2 }
765 );
766
767 client1.disconnect(client1_conn_id);
768 client2.disconnect(client1_conn_id);
769
770 async fn handle_messages(
771 mut messages: BoxStream<'static, Box<dyn AnyTypedEnvelope>>,
772 peer: Arc<Peer>,
773 ) -> Result<()> {
774 while let Some(envelope) = messages.next().await {
775 let envelope = envelope.into_any();
776 if let Some(envelope) = envelope.downcast_ref::<TypedEnvelope<proto::Ping>>() {
777 let receipt = envelope.receipt();
778 peer.respond(receipt, proto::Ack {})?
779 } else if let Some(envelope) = envelope.downcast_ref::<TypedEnvelope<proto::Test>>()
780 {
781 peer.respond(envelope.receipt(), envelope.payload.clone())?
782 } else {
783 panic!("unknown message type");
784 }
785 }
786
787 Ok(())
788 }
789 }
790
791 #[gpui::test(iterations = 50)]
792 async fn test_order_of_response_and_incoming(cx: &mut TestAppContext) {
793 let executor = cx.executor();
794 let server = Peer::new(0);
795 let client = Peer::new(0);
796
797 let (client_to_server_conn, server_to_client_conn, _kill) =
798 Connection::in_memory(executor.clone());
799 let (client_to_server_conn_id, io_task1, mut client_incoming) =
800 client.add_test_connection(client_to_server_conn, executor.clone());
801
802 let (server_to_client_conn_id, io_task2, mut server_incoming) =
803 server.add_test_connection(server_to_client_conn, executor.clone());
804
805 executor.spawn(io_task1).detach();
806 executor.spawn(io_task2).detach();
807
808 executor
809 .spawn(async move {
810 let future = server_incoming.next().await;
811 let request = future
812 .unwrap()
813 .into_any()
814 .downcast::<TypedEnvelope<proto::Ping>>()
815 .unwrap();
816
817 server
818 .send(
819 server_to_client_conn_id,
820 ErrorCode::Internal
821 .message("message 1".to_string())
822 .to_proto(),
823 )
824 .unwrap();
825 server
826 .send(
827 server_to_client_conn_id,
828 ErrorCode::Internal
829 .message("message 2".to_string())
830 .to_proto(),
831 )
832 .unwrap();
833 server.respond(request.receipt(), proto::Ack {}).unwrap();
834
835 // Prevent the connection from being dropped
836 server_incoming.next().await;
837 })
838 .detach();
839
840 let events = Arc::new(Mutex::new(Vec::new()));
841
842 let response = client.request(client_to_server_conn_id, proto::Ping {});
843 let response_task = executor.spawn({
844 let events = events.clone();
845 async move {
846 response.await.unwrap();
847 events.lock().push("response".to_string());
848 }
849 });
850
851 executor
852 .spawn({
853 let events = events.clone();
854 async move {
855 let incoming1 = client_incoming
856 .next()
857 .await
858 .unwrap()
859 .into_any()
860 .downcast::<TypedEnvelope<proto::Error>>()
861 .unwrap();
862 events.lock().push(incoming1.payload.message);
863 let incoming2 = client_incoming
864 .next()
865 .await
866 .unwrap()
867 .into_any()
868 .downcast::<TypedEnvelope<proto::Error>>()
869 .unwrap();
870 events.lock().push(incoming2.payload.message);
871
872 // Prevent the connection from being dropped
873 client_incoming.next().await;
874 }
875 })
876 .detach();
877
878 response_task.await;
879 assert_eq!(
880 &*events.lock(),
881 &[
882 "message 1".to_string(),
883 "message 2".to_string(),
884 "response".to_string()
885 ]
886 );
887 }
888
889 #[gpui::test(iterations = 50)]
890 async fn test_dropping_request_before_completion(cx: &mut TestAppContext) {
891 let executor = cx.executor();
892 let server = Peer::new(0);
893 let client = Peer::new(0);
894
895 let (client_to_server_conn, server_to_client_conn, _kill) =
896 Connection::in_memory(cx.executor());
897 let (client_to_server_conn_id, io_task1, mut client_incoming) =
898 client.add_test_connection(client_to_server_conn, cx.executor());
899 let (server_to_client_conn_id, io_task2, mut server_incoming) =
900 server.add_test_connection(server_to_client_conn, cx.executor());
901
902 executor.spawn(io_task1).detach();
903 executor.spawn(io_task2).detach();
904
905 executor
906 .spawn(async move {
907 let request1 = server_incoming
908 .next()
909 .await
910 .unwrap()
911 .into_any()
912 .downcast::<TypedEnvelope<proto::Ping>>()
913 .unwrap();
914 let request2 = server_incoming
915 .next()
916 .await
917 .unwrap()
918 .into_any()
919 .downcast::<TypedEnvelope<proto::Ping>>()
920 .unwrap();
921
922 server
923 .send(
924 server_to_client_conn_id,
925 ErrorCode::Internal
926 .message("message 1".to_string())
927 .to_proto(),
928 )
929 .unwrap();
930 server
931 .send(
932 server_to_client_conn_id,
933 ErrorCode::Internal
934 .message("message 2".to_string())
935 .to_proto(),
936 )
937 .unwrap();
938 server.respond(request1.receipt(), proto::Ack {}).unwrap();
939 server.respond(request2.receipt(), proto::Ack {}).unwrap();
940
941 // Prevent the connection from being dropped
942 server_incoming.next().await;
943 })
944 .detach();
945
946 let events = Arc::new(Mutex::new(Vec::new()));
947
948 let request1 = client.request(client_to_server_conn_id, proto::Ping {});
949 let request1_task = executor.spawn(request1);
950 let request2 = client.request(client_to_server_conn_id, proto::Ping {});
951 let request2_task = executor.spawn({
952 let events = events.clone();
953 async move {
954 request2.await.unwrap();
955 events.lock().push("response 2".to_string());
956 }
957 });
958
959 executor
960 .spawn({
961 let events = events.clone();
962 async move {
963 let incoming1 = client_incoming
964 .next()
965 .await
966 .unwrap()
967 .into_any()
968 .downcast::<TypedEnvelope<proto::Error>>()
969 .unwrap();
970 events.lock().push(incoming1.payload.message);
971 let incoming2 = client_incoming
972 .next()
973 .await
974 .unwrap()
975 .into_any()
976 .downcast::<TypedEnvelope<proto::Error>>()
977 .unwrap();
978 events.lock().push(incoming2.payload.message);
979
980 // Prevent the connection from being dropped
981 client_incoming.next().await;
982 }
983 })
984 .detach();
985
986 // Allow the request to make some progress before dropping it.
987 cx.executor().simulate_random_delay().await;
988 drop(request1_task);
989
990 request2_task.await;
991 assert_eq!(
992 &*events.lock(),
993 &[
994 "message 1".to_string(),
995 "message 2".to_string(),
996 "response 2".to_string()
997 ]
998 );
999 }
1000
1001 #[gpui::test(iterations = 50)]
1002 async fn test_disconnect(cx: &mut TestAppContext) {
1003 let executor = cx.executor();
1004
1005 let (client_conn, mut server_conn, _kill) = Connection::in_memory(executor.clone());
1006
1007 let client = Peer::new(0);
1008 let (connection_id, io_handler, mut incoming) =
1009 client.add_test_connection(client_conn, executor.clone());
1010
1011 let (io_ended_tx, io_ended_rx) = oneshot::channel();
1012 executor
1013 .spawn(async move {
1014 io_handler.await.ok();
1015 io_ended_tx.send(()).unwrap();
1016 })
1017 .detach();
1018
1019 let (messages_ended_tx, messages_ended_rx) = oneshot::channel();
1020 executor
1021 .spawn(async move {
1022 incoming.next().await;
1023 messages_ended_tx.send(()).unwrap();
1024 })
1025 .detach();
1026
1027 client.disconnect(connection_id);
1028
1029 let _ = io_ended_rx.await;
1030 let _ = messages_ended_rx.await;
1031 assert!(
1032 server_conn
1033 .send(WebSocketMessage::Binary(vec![].into()))
1034 .await
1035 .is_err()
1036 );
1037 }
1038
1039 #[gpui::test(iterations = 50)]
1040 async fn test_io_error(cx: &mut TestAppContext) {
1041 let executor = cx.executor();
1042 let (client_conn, mut server_conn, _kill) = Connection::in_memory(executor.clone());
1043
1044 let client = Peer::new(0);
1045 let (connection_id, io_handler, mut incoming) =
1046 client.add_test_connection(client_conn, executor.clone());
1047 executor.spawn(io_handler).detach();
1048 executor
1049 .spawn(async move { incoming.next().await })
1050 .detach();
1051
1052 let response = executor.spawn(client.request(connection_id, proto::Ping {}));
1053 let _request = server_conn.rx.next().await.unwrap().unwrap();
1054
1055 drop(server_conn);
1056 assert_eq!(
1057 response.await.unwrap_err().to_string(),
1058 "connection was closed"
1059 );
1060 }
1061}