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 anyhow::bail!("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 anyhow::bail!("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 anyhow::bail!("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 anyhow::bail!("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 let request_start_time = Instant::now();
426 let elapsed_time = move || request_start_time.elapsed().as_millis();
427 tracing::info!("start forwarding request");
428 self.request_internal(Some(sender_id), receiver_id, request)
429 .map_ok(|envelope| envelope.payload)
430 .inspect_err(move |_| {
431 tracing::error!(
432 waiting_for_host_ms = elapsed_time(),
433 "error forwarding request"
434 )
435 })
436 .inspect_ok(move |_| {
437 tracing::info!(
438 waiting_for_host_ms = elapsed_time(),
439 "finished forwarding request"
440 )
441 })
442 }
443
444 fn request_internal<T: RequestMessage>(
445 &self,
446 original_sender_id: Option<ConnectionId>,
447 receiver_id: ConnectionId,
448 request: T,
449 ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> + use<T> {
450 let envelope = request.into_envelope(0, None, original_sender_id.map(Into::into));
451 let response = self.request_dynamic(receiver_id, envelope, T::NAME);
452 async move {
453 let (response, received_at) = response.await?;
454 Ok(TypedEnvelope {
455 message_id: response.id,
456 sender_id: receiver_id.into(),
457 original_sender_id: response.original_sender_id,
458 payload: T::Response::from_envelope(response)
459 .context("received response of the wrong type")?,
460 received_at,
461 })
462 }
463 }
464
465 /// Make a request and wait for a response.
466 ///
467 /// The caller must make sure to deserialize the response into the request's
468 /// response type. This interface is only useful in trait objects, where
469 /// generics can't be used. If you have a concrete type, use `request`.
470 pub fn request_dynamic(
471 &self,
472 receiver_id: ConnectionId,
473 mut envelope: proto::Envelope,
474 type_name: &'static str,
475 ) -> impl Future<Output = Result<(proto::Envelope, Instant)>> + use<> {
476 let (tx, rx) = oneshot::channel();
477 let send = self.connection_state(receiver_id).and_then(|connection| {
478 envelope.id = connection.next_message_id.fetch_add(1, SeqCst);
479 connection
480 .response_channels
481 .lock()
482 .as_mut()
483 .context("connection was closed")?
484 .insert(envelope.id, tx);
485 connection
486 .outgoing_tx
487 .unbounded_send(Message::Envelope(envelope))
488 .context("connection was closed")?;
489 Ok(())
490 });
491 async move {
492 send?;
493 let (response, received_at, _barrier) = rx.await.context("connection was closed")?;
494 if let Some(proto::envelope::Payload::Error(error)) = &response.payload {
495 return Err(RpcError::from_proto(error, type_name));
496 }
497 Ok((response, received_at))
498 }
499 }
500
501 pub fn request_stream<T: RequestMessage>(
502 &self,
503 receiver_id: ConnectionId,
504 request: T,
505 ) -> impl Future<Output = Result<impl Unpin + Stream<Item = Result<T::Response>>>> {
506 let (tx, rx) = mpsc::unbounded();
507 let send = self.connection_state(receiver_id).and_then(|connection| {
508 let message_id = connection.next_message_id.fetch_add(1, SeqCst);
509 let stream_response_channels = connection.stream_response_channels.clone();
510 stream_response_channels
511 .lock()
512 .as_mut()
513 .context("connection was closed")?
514 .insert(message_id, tx);
515 connection
516 .outgoing_tx
517 .unbounded_send(Message::Envelope(
518 request.into_envelope(message_id, None, None),
519 ))
520 .context("connection was closed")?;
521 Ok((message_id, stream_response_channels))
522 });
523
524 async move {
525 let (message_id, stream_response_channels) = send?;
526 let stream_response_channels = Arc::downgrade(&stream_response_channels);
527
528 Ok(rx.filter_map(move |(response, _barrier)| {
529 let stream_response_channels = stream_response_channels.clone();
530 future::ready(match response {
531 Ok(response) => {
532 if let Some(proto::envelope::Payload::Error(error)) = &response.payload {
533 Some(Err(RpcError::from_proto(error, T::NAME)))
534 } else if let Some(proto::envelope::Payload::EndStream(_)) =
535 &response.payload
536 {
537 // Remove the transmitting end of the response channel to end the stream.
538 if let Some(channels) = stream_response_channels.upgrade() {
539 if let Some(channels) = channels.lock().as_mut() {
540 channels.remove(&message_id);
541 }
542 }
543 None
544 } else {
545 Some(
546 T::Response::from_envelope(response)
547 .context("received response of the wrong type"),
548 )
549 }
550 }
551 Err(error) => Some(Err(error)),
552 })
553 }))
554 }
555 }
556
557 pub fn send<T: EnvelopedMessage>(&self, receiver_id: ConnectionId, message: T) -> Result<()> {
558 let connection = self.connection_state(receiver_id)?;
559 let message_id = connection
560 .next_message_id
561 .fetch_add(1, atomic::Ordering::SeqCst);
562 connection.outgoing_tx.unbounded_send(Message::Envelope(
563 message.into_envelope(message_id, None, None),
564 ))?;
565 Ok(())
566 }
567
568 pub fn send_dynamic(&self, receiver_id: ConnectionId, message: proto::Envelope) -> Result<()> {
569 let connection = self.connection_state(receiver_id)?;
570 connection
571 .outgoing_tx
572 .unbounded_send(Message::Envelope(message))?;
573 Ok(())
574 }
575
576 pub fn forward_send<T: EnvelopedMessage>(
577 &self,
578 sender_id: ConnectionId,
579 receiver_id: ConnectionId,
580 message: T,
581 ) -> Result<()> {
582 let connection = self.connection_state(receiver_id)?;
583 let message_id = connection
584 .next_message_id
585 .fetch_add(1, atomic::Ordering::SeqCst);
586 connection
587 .outgoing_tx
588 .unbounded_send(Message::Envelope(message.into_envelope(
589 message_id,
590 None,
591 Some(sender_id.into()),
592 )))?;
593 Ok(())
594 }
595
596 pub fn respond<T: RequestMessage>(
597 &self,
598 receipt: Receipt<T>,
599 response: T::Response,
600 ) -> Result<()> {
601 let connection = self.connection_state(receipt.sender_id.into())?;
602 let message_id = connection
603 .next_message_id
604 .fetch_add(1, atomic::Ordering::SeqCst);
605 connection
606 .outgoing_tx
607 .unbounded_send(Message::Envelope(response.into_envelope(
608 message_id,
609 Some(receipt.message_id),
610 None,
611 )))?;
612 Ok(())
613 }
614
615 pub fn end_stream<T: RequestMessage>(&self, receipt: Receipt<T>) -> Result<()> {
616 let connection = self.connection_state(receipt.sender_id.into())?;
617 let message_id = connection
618 .next_message_id
619 .fetch_add(1, atomic::Ordering::SeqCst);
620
621 let message = proto::EndStream {};
622
623 connection
624 .outgoing_tx
625 .unbounded_send(Message::Envelope(message.into_envelope(
626 message_id,
627 Some(receipt.message_id),
628 None,
629 )))?;
630 Ok(())
631 }
632
633 pub fn respond_with_error<T: RequestMessage>(
634 &self,
635 receipt: Receipt<T>,
636 response: proto::Error,
637 ) -> Result<()> {
638 let connection = self.connection_state(receipt.sender_id.into())?;
639 let message_id = connection
640 .next_message_id
641 .fetch_add(1, atomic::Ordering::SeqCst);
642 connection
643 .outgoing_tx
644 .unbounded_send(Message::Envelope(response.into_envelope(
645 message_id,
646 Some(receipt.message_id),
647 None,
648 )))?;
649 Ok(())
650 }
651
652 pub fn respond_with_unhandled_message(
653 &self,
654 sender_id: ConnectionId,
655 request_message_id: u32,
656 message_type_name: &'static str,
657 ) -> Result<()> {
658 let connection = self.connection_state(sender_id)?;
659 let response = ErrorCode::Internal
660 .message(format!("message {} was not handled", message_type_name))
661 .to_proto();
662 let message_id = connection
663 .next_message_id
664 .fetch_add(1, atomic::Ordering::SeqCst);
665 connection
666 .outgoing_tx
667 .unbounded_send(Message::Envelope(response.into_envelope(
668 message_id,
669 Some(request_message_id),
670 None,
671 )))?;
672 Ok(())
673 }
674
675 fn connection_state(&self, connection_id: ConnectionId) -> Result<ConnectionState> {
676 let connections = self.connections.read();
677 let connection = connections
678 .get(&connection_id)
679 .with_context(|| format!("no such connection: {connection_id}"))?;
680 Ok(connection.clone())
681 }
682}
683
684impl Serialize for Peer {
685 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
686 where
687 S: serde::Serializer,
688 {
689 let mut state = serializer.serialize_struct("Peer", 2)?;
690 state.serialize_field("connections", &*self.connections.read())?;
691 state.end()
692 }
693}
694
695#[cfg(test)]
696mod tests {
697 use super::*;
698 use async_tungstenite::tungstenite::Message as WebSocketMessage;
699 use gpui::TestAppContext;
700
701 fn init_logger() {
702 zlog::init_test();
703 }
704
705 #[gpui::test(iterations = 50)]
706 async fn test_request_response(cx: &mut TestAppContext) {
707 init_logger();
708
709 let executor = cx.executor();
710
711 // create 2 clients connected to 1 server
712 let server = Peer::new(0);
713 let client1 = Peer::new(0);
714 let client2 = Peer::new(0);
715
716 let (client1_to_server_conn, server_to_client_1_conn, _kill) =
717 Connection::in_memory(cx.executor());
718 let (client1_conn_id, io_task1, client1_incoming) =
719 client1.add_test_connection(client1_to_server_conn, cx.executor());
720 let (_, io_task2, server_incoming1) =
721 server.add_test_connection(server_to_client_1_conn, cx.executor());
722
723 let (client2_to_server_conn, server_to_client_2_conn, _kill) =
724 Connection::in_memory(cx.executor());
725 let (client2_conn_id, io_task3, client2_incoming) =
726 client2.add_test_connection(client2_to_server_conn, cx.executor());
727 let (_, io_task4, server_incoming2) =
728 server.add_test_connection(server_to_client_2_conn, cx.executor());
729
730 executor.spawn(io_task1).detach();
731 executor.spawn(io_task2).detach();
732 executor.spawn(io_task3).detach();
733 executor.spawn(io_task4).detach();
734 executor
735 .spawn(handle_messages(server_incoming1, server.clone()))
736 .detach();
737 executor
738 .spawn(handle_messages(client1_incoming, client1.clone()))
739 .detach();
740 executor
741 .spawn(handle_messages(server_incoming2, server.clone()))
742 .detach();
743 executor
744 .spawn(handle_messages(client2_incoming, client2.clone()))
745 .detach();
746
747 assert_eq!(
748 client1
749 .request(client1_conn_id, proto::Ping {},)
750 .await
751 .unwrap(),
752 proto::Ack {}
753 );
754
755 assert_eq!(
756 client2
757 .request(client2_conn_id, proto::Ping {},)
758 .await
759 .unwrap(),
760 proto::Ack {}
761 );
762
763 assert_eq!(
764 client1
765 .request(client1_conn_id, proto::Test { id: 1 },)
766 .await
767 .unwrap(),
768 proto::Test { id: 1 }
769 );
770
771 assert_eq!(
772 client2
773 .request(client2_conn_id, proto::Test { id: 2 })
774 .await
775 .unwrap(),
776 proto::Test { id: 2 }
777 );
778
779 client1.disconnect(client1_conn_id);
780 client2.disconnect(client1_conn_id);
781
782 async fn handle_messages(
783 mut messages: BoxStream<'static, Box<dyn AnyTypedEnvelope>>,
784 peer: Arc<Peer>,
785 ) -> Result<()> {
786 while let Some(envelope) = messages.next().await {
787 let envelope = envelope.into_any();
788 if let Some(envelope) = envelope.downcast_ref::<TypedEnvelope<proto::Ping>>() {
789 let receipt = envelope.receipt();
790 peer.respond(receipt, proto::Ack {})?
791 } else if let Some(envelope) = envelope.downcast_ref::<TypedEnvelope<proto::Test>>()
792 {
793 peer.respond(envelope.receipt(), envelope.payload.clone())?
794 } else {
795 panic!("unknown message type");
796 }
797 }
798
799 Ok(())
800 }
801 }
802
803 #[gpui::test(iterations = 50)]
804 async fn test_order_of_response_and_incoming(cx: &mut TestAppContext) {
805 let executor = cx.executor();
806 let server = Peer::new(0);
807 let client = Peer::new(0);
808
809 let (client_to_server_conn, server_to_client_conn, _kill) =
810 Connection::in_memory(executor.clone());
811 let (client_to_server_conn_id, io_task1, mut client_incoming) =
812 client.add_test_connection(client_to_server_conn, executor.clone());
813
814 let (server_to_client_conn_id, io_task2, mut server_incoming) =
815 server.add_test_connection(server_to_client_conn, executor.clone());
816
817 executor.spawn(io_task1).detach();
818 executor.spawn(io_task2).detach();
819
820 executor
821 .spawn(async move {
822 let future = server_incoming.next().await;
823 let request = future
824 .unwrap()
825 .into_any()
826 .downcast::<TypedEnvelope<proto::Ping>>()
827 .unwrap();
828
829 server
830 .send(
831 server_to_client_conn_id,
832 ErrorCode::Internal
833 .message("message 1".to_string())
834 .to_proto(),
835 )
836 .unwrap();
837 server
838 .send(
839 server_to_client_conn_id,
840 ErrorCode::Internal
841 .message("message 2".to_string())
842 .to_proto(),
843 )
844 .unwrap();
845 server.respond(request.receipt(), proto::Ack {}).unwrap();
846
847 // Prevent the connection from being dropped
848 server_incoming.next().await;
849 })
850 .detach();
851
852 let events = Arc::new(Mutex::new(Vec::new()));
853
854 let response = client.request(client_to_server_conn_id, proto::Ping {});
855 let response_task = executor.spawn({
856 let events = events.clone();
857 async move {
858 response.await.unwrap();
859 events.lock().push("response".to_string());
860 }
861 });
862
863 executor
864 .spawn({
865 let events = events.clone();
866 async move {
867 let incoming1 = client_incoming
868 .next()
869 .await
870 .unwrap()
871 .into_any()
872 .downcast::<TypedEnvelope<proto::Error>>()
873 .unwrap();
874 events.lock().push(incoming1.payload.message);
875 let incoming2 = client_incoming
876 .next()
877 .await
878 .unwrap()
879 .into_any()
880 .downcast::<TypedEnvelope<proto::Error>>()
881 .unwrap();
882 events.lock().push(incoming2.payload.message);
883
884 // Prevent the connection from being dropped
885 client_incoming.next().await;
886 }
887 })
888 .detach();
889
890 response_task.await;
891 assert_eq!(
892 &*events.lock(),
893 &[
894 "message 1".to_string(),
895 "message 2".to_string(),
896 "response".to_string()
897 ]
898 );
899 }
900
901 #[gpui::test(iterations = 50)]
902 async fn test_dropping_request_before_completion(cx: &mut TestAppContext) {
903 let executor = cx.executor();
904 let server = Peer::new(0);
905 let client = Peer::new(0);
906
907 let (client_to_server_conn, server_to_client_conn, _kill) =
908 Connection::in_memory(cx.executor());
909 let (client_to_server_conn_id, io_task1, mut client_incoming) =
910 client.add_test_connection(client_to_server_conn, cx.executor());
911 let (server_to_client_conn_id, io_task2, mut server_incoming) =
912 server.add_test_connection(server_to_client_conn, cx.executor());
913
914 executor.spawn(io_task1).detach();
915 executor.spawn(io_task2).detach();
916
917 executor
918 .spawn(async move {
919 let request1 = server_incoming
920 .next()
921 .await
922 .unwrap()
923 .into_any()
924 .downcast::<TypedEnvelope<proto::Ping>>()
925 .unwrap();
926 let request2 = server_incoming
927 .next()
928 .await
929 .unwrap()
930 .into_any()
931 .downcast::<TypedEnvelope<proto::Ping>>()
932 .unwrap();
933
934 server
935 .send(
936 server_to_client_conn_id,
937 ErrorCode::Internal
938 .message("message 1".to_string())
939 .to_proto(),
940 )
941 .unwrap();
942 server
943 .send(
944 server_to_client_conn_id,
945 ErrorCode::Internal
946 .message("message 2".to_string())
947 .to_proto(),
948 )
949 .unwrap();
950 server.respond(request1.receipt(), proto::Ack {}).unwrap();
951 server.respond(request2.receipt(), proto::Ack {}).unwrap();
952
953 // Prevent the connection from being dropped
954 server_incoming.next().await;
955 })
956 .detach();
957
958 let events = Arc::new(Mutex::new(Vec::new()));
959
960 let request1 = client.request(client_to_server_conn_id, proto::Ping {});
961 let request1_task = executor.spawn(request1);
962 let request2 = client.request(client_to_server_conn_id, proto::Ping {});
963 let request2_task = executor.spawn({
964 let events = events.clone();
965 async move {
966 request2.await.unwrap();
967 events.lock().push("response 2".to_string());
968 }
969 });
970
971 executor
972 .spawn({
973 let events = events.clone();
974 async move {
975 let incoming1 = client_incoming
976 .next()
977 .await
978 .unwrap()
979 .into_any()
980 .downcast::<TypedEnvelope<proto::Error>>()
981 .unwrap();
982 events.lock().push(incoming1.payload.message);
983 let incoming2 = client_incoming
984 .next()
985 .await
986 .unwrap()
987 .into_any()
988 .downcast::<TypedEnvelope<proto::Error>>()
989 .unwrap();
990 events.lock().push(incoming2.payload.message);
991
992 // Prevent the connection from being dropped
993 client_incoming.next().await;
994 }
995 })
996 .detach();
997
998 // Allow the request to make some progress before dropping it.
999 cx.executor().simulate_random_delay().await;
1000 drop(request1_task);
1001
1002 request2_task.await;
1003 assert_eq!(
1004 &*events.lock(),
1005 &[
1006 "message 1".to_string(),
1007 "message 2".to_string(),
1008 "response 2".to_string()
1009 ]
1010 );
1011 }
1012
1013 #[gpui::test(iterations = 50)]
1014 async fn test_disconnect(cx: &mut TestAppContext) {
1015 let executor = cx.executor();
1016
1017 let (client_conn, mut server_conn, _kill) = Connection::in_memory(executor.clone());
1018
1019 let client = Peer::new(0);
1020 let (connection_id, io_handler, mut incoming) =
1021 client.add_test_connection(client_conn, executor.clone());
1022
1023 let (io_ended_tx, io_ended_rx) = oneshot::channel();
1024 executor
1025 .spawn(async move {
1026 io_handler.await.ok();
1027 io_ended_tx.send(()).unwrap();
1028 })
1029 .detach();
1030
1031 let (messages_ended_tx, messages_ended_rx) = oneshot::channel();
1032 executor
1033 .spawn(async move {
1034 incoming.next().await;
1035 messages_ended_tx.send(()).unwrap();
1036 })
1037 .detach();
1038
1039 client.disconnect(connection_id);
1040
1041 let _ = io_ended_rx.await;
1042 let _ = messages_ended_rx.await;
1043 assert!(
1044 server_conn
1045 .send(WebSocketMessage::Binary(vec![].into()))
1046 .await
1047 .is_err()
1048 );
1049 }
1050
1051 #[gpui::test(iterations = 50)]
1052 async fn test_io_error(cx: &mut TestAppContext) {
1053 let executor = cx.executor();
1054 let (client_conn, mut server_conn, _kill) = Connection::in_memory(executor.clone());
1055
1056 let client = Peer::new(0);
1057 let (connection_id, io_handler, mut incoming) =
1058 client.add_test_connection(client_conn, executor.clone());
1059 executor.spawn(io_handler).detach();
1060 executor
1061 .spawn(async move { incoming.next().await })
1062 .detach();
1063
1064 let response = executor.spawn(client.request(connection_id, proto::Ping {}));
1065 let _request = server_conn.rx.next().await.unwrap().unwrap();
1066
1067 drop(server_conn);
1068 assert_eq!(
1069 response.await.unwrap_err().to_string(),
1070 "connection was closed"
1071 );
1072 }
1073}