1use super::{
2 auth,
3 db::{ChannelId, MessageId, UserId},
4 AppState,
5};
6use anyhow::anyhow;
7use async_std::{sync::RwLock, task};
8use async_tungstenite::{tungstenite::protocol::Role, WebSocketStream};
9use futures::{future::BoxFuture, FutureExt};
10use postage::{mpsc, prelude::Sink as _, prelude::Stream as _};
11use sha1::{Digest as _, Sha1};
12use std::{
13 any::TypeId,
14 collections::{hash_map, HashMap, HashSet},
15 future::Future,
16 mem,
17 sync::Arc,
18 time::Instant,
19};
20use surf::StatusCode;
21use tide::log;
22use tide::{
23 http::headers::{HeaderName, CONNECTION, UPGRADE},
24 Request, Response,
25};
26use time::OffsetDateTime;
27use zrpc::{
28 auth::random_token,
29 proto::{self, AnyTypedEnvelope, EnvelopedMessage},
30 Connection, ConnectionId, Peer, TypedEnvelope,
31};
32
33type ReplicaId = u16;
34
35type MessageHandler = Box<
36 dyn Send
37 + Sync
38 + Fn(Arc<Server>, Box<dyn AnyTypedEnvelope>) -> BoxFuture<'static, tide::Result<()>>,
39>;
40
41pub struct Server {
42 peer: Arc<Peer>,
43 state: RwLock<ServerState>,
44 app_state: Arc<AppState>,
45 handlers: HashMap<TypeId, MessageHandler>,
46 notifications: Option<mpsc::Sender<()>>,
47}
48
49#[derive(Default)]
50struct ServerState {
51 connections: HashMap<ConnectionId, ConnectionState>,
52 pub worktrees: HashMap<u64, Worktree>,
53 channels: HashMap<ChannelId, Channel>,
54 next_worktree_id: u64,
55}
56
57struct ConnectionState {
58 user_id: UserId,
59 worktrees: HashSet<u64>,
60 channels: HashSet<ChannelId>,
61}
62
63struct Worktree {
64 host_connection_id: Option<ConnectionId>,
65 guest_connection_ids: HashMap<ConnectionId, ReplicaId>,
66 active_replica_ids: HashSet<ReplicaId>,
67 access_token: String,
68 root_name: String,
69 entries: HashMap<u64, proto::Entry>,
70}
71
72#[derive(Default)]
73struct Channel {
74 connection_ids: HashSet<ConnectionId>,
75}
76
77const MESSAGE_COUNT_PER_PAGE: usize = 100;
78const MAX_MESSAGE_LEN: usize = 1024;
79
80impl Server {
81 pub fn new(
82 app_state: Arc<AppState>,
83 peer: Arc<Peer>,
84 notifications: Option<mpsc::Sender<()>>,
85 ) -> Arc<Self> {
86 let mut server = Self {
87 peer,
88 app_state,
89 state: Default::default(),
90 handlers: Default::default(),
91 notifications,
92 };
93
94 server
95 .add_handler(Server::ping)
96 .add_handler(Server::share_worktree)
97 .add_handler(Server::join_worktree)
98 .add_handler(Server::update_worktree)
99 .add_handler(Server::close_worktree)
100 .add_handler(Server::open_buffer)
101 .add_handler(Server::close_buffer)
102 .add_handler(Server::update_buffer)
103 .add_handler(Server::buffer_saved)
104 .add_handler(Server::save_buffer)
105 .add_handler(Server::get_channels)
106 .add_handler(Server::get_users)
107 .add_handler(Server::join_channel)
108 .add_handler(Server::leave_channel)
109 .add_handler(Server::send_channel_message)
110 .add_handler(Server::get_channel_messages);
111
112 Arc::new(server)
113 }
114
115 fn add_handler<F, Fut, M>(&mut self, handler: F) -> &mut Self
116 where
117 F: 'static + Send + Sync + Fn(Arc<Self>, TypedEnvelope<M>) -> Fut,
118 Fut: 'static + Send + Future<Output = tide::Result<()>>,
119 M: EnvelopedMessage,
120 {
121 let prev_handler = self.handlers.insert(
122 TypeId::of::<M>(),
123 Box::new(move |server, envelope| {
124 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
125 (handler)(server, *envelope).boxed()
126 }),
127 );
128 if prev_handler.is_some() {
129 panic!("registered a handler for the same message twice");
130 }
131 self
132 }
133
134 pub fn handle_connection(
135 self: &Arc<Self>,
136 connection: Connection,
137 addr: String,
138 user_id: UserId,
139 ) -> impl Future<Output = ()> {
140 let this = self.clone();
141 async move {
142 let (connection_id, handle_io, mut incoming_rx) =
143 this.peer.add_connection(connection).await;
144 this.add_connection(connection_id, user_id).await;
145
146 let handle_io = handle_io.fuse();
147 futures::pin_mut!(handle_io);
148 loop {
149 let next_message = incoming_rx.recv().fuse();
150 futures::pin_mut!(next_message);
151 futures::select_biased! {
152 message = next_message => {
153 if let Some(message) = message {
154 let start_time = Instant::now();
155 log::info!("RPC message received: {}", message.payload_type_name());
156 if let Some(handler) = this.handlers.get(&message.payload_type_id()) {
157 if let Err(err) = (handler)(this.clone(), message).await {
158 log::error!("error handling message: {:?}", err);
159 } else {
160 log::info!("RPC message handled. duration:{:?}", start_time.elapsed());
161 }
162
163 if let Some(mut notifications) = this.notifications.clone() {
164 let _ = notifications.send(()).await;
165 }
166 } else {
167 log::warn!("unhandled message: {}", message.payload_type_name());
168 }
169 } else {
170 log::info!("rpc connection closed {:?}", addr);
171 break;
172 }
173 }
174 handle_io = handle_io => {
175 if let Err(err) = handle_io {
176 log::error!("error handling rpc connection {:?} - {:?}", addr, err);
177 }
178 break;
179 }
180 }
181 }
182
183 if let Err(err) = this.sign_out(connection_id).await {
184 log::error!("error signing out connection {:?} - {:?}", addr, err);
185 }
186 }
187 }
188
189 async fn sign_out(self: &Arc<Self>, connection_id: zrpc::ConnectionId) -> tide::Result<()> {
190 self.peer.disconnect(connection_id).await;
191 let worktree_ids = self.remove_connection(connection_id).await;
192 for worktree_id in worktree_ids {
193 let state = self.state.read().await;
194 if let Some(worktree) = state.worktrees.get(&worktree_id) {
195 broadcast(connection_id, worktree.connection_ids(), |conn_id| {
196 self.peer.send(
197 conn_id,
198 proto::RemovePeer {
199 worktree_id,
200 peer_id: connection_id.0,
201 },
202 )
203 })
204 .await?;
205 }
206 }
207 Ok(())
208 }
209
210 // Add a new connection associated with a given user.
211 async fn add_connection(&self, connection_id: ConnectionId, user_id: UserId) {
212 self.state.write().await.connections.insert(
213 connection_id,
214 ConnectionState {
215 user_id,
216 worktrees: Default::default(),
217 channels: Default::default(),
218 },
219 );
220 }
221
222 // Remove the given connection and its association with any worktrees.
223 async fn remove_connection(&self, connection_id: ConnectionId) -> Vec<u64> {
224 let mut worktree_ids = Vec::new();
225 let mut state = self.state.write().await;
226 if let Some(connection) = state.connections.remove(&connection_id) {
227 for channel_id in connection.channels {
228 if let Some(channel) = state.channels.get_mut(&channel_id) {
229 channel.connection_ids.remove(&connection_id);
230 }
231 }
232 for worktree_id in connection.worktrees {
233 if let Some(worktree) = state.worktrees.get_mut(&worktree_id) {
234 if worktree.host_connection_id == Some(connection_id) {
235 worktree_ids.push(worktree_id);
236 } else if let Some(replica_id) =
237 worktree.guest_connection_ids.remove(&connection_id)
238 {
239 worktree.active_replica_ids.remove(&replica_id);
240 worktree_ids.push(worktree_id);
241 }
242 }
243 }
244 }
245 worktree_ids
246 }
247
248 async fn ping(self: Arc<Server>, request: TypedEnvelope<proto::Ping>) -> tide::Result<()> {
249 self.peer.respond(request.receipt(), proto::Ack {}).await?;
250 Ok(())
251 }
252
253 async fn share_worktree(
254 self: Arc<Server>,
255 mut request: TypedEnvelope<proto::ShareWorktree>,
256 ) -> tide::Result<()> {
257 let mut state = self.state.write().await;
258 let worktree_id = state.next_worktree_id;
259 state.next_worktree_id += 1;
260 let access_token = random_token();
261 let worktree = request
262 .payload
263 .worktree
264 .as_mut()
265 .ok_or_else(|| anyhow!("missing worktree"))?;
266 let entries = mem::take(&mut worktree.entries)
267 .into_iter()
268 .map(|entry| (entry.id, entry))
269 .collect();
270 state.worktrees.insert(
271 worktree_id,
272 Worktree {
273 host_connection_id: Some(request.sender_id),
274 guest_connection_ids: Default::default(),
275 active_replica_ids: Default::default(),
276 access_token: access_token.clone(),
277 root_name: mem::take(&mut worktree.root_name),
278 entries,
279 },
280 );
281
282 self.peer
283 .respond(
284 request.receipt(),
285 proto::ShareWorktreeResponse {
286 worktree_id,
287 access_token,
288 },
289 )
290 .await?;
291 Ok(())
292 }
293
294 async fn join_worktree(
295 self: Arc<Server>,
296 request: TypedEnvelope<proto::OpenWorktree>,
297 ) -> tide::Result<()> {
298 let worktree_id = request.payload.worktree_id;
299 let access_token = &request.payload.access_token;
300
301 let mut state = self.state.write().await;
302 if let Some((peer_replica_id, worktree)) =
303 state.join_worktree(request.sender_id, worktree_id, access_token)
304 {
305 let mut peers = Vec::new();
306 if let Some(host_connection_id) = worktree.host_connection_id {
307 peers.push(proto::Peer {
308 peer_id: host_connection_id.0,
309 replica_id: 0,
310 });
311 }
312 for (peer_conn_id, peer_replica_id) in &worktree.guest_connection_ids {
313 if *peer_conn_id != request.sender_id {
314 peers.push(proto::Peer {
315 peer_id: peer_conn_id.0,
316 replica_id: *peer_replica_id as u32,
317 });
318 }
319 }
320
321 broadcast(request.sender_id, worktree.connection_ids(), |conn_id| {
322 self.peer.send(
323 conn_id,
324 proto::AddPeer {
325 worktree_id,
326 peer: Some(proto::Peer {
327 peer_id: request.sender_id.0,
328 replica_id: peer_replica_id as u32,
329 }),
330 },
331 )
332 })
333 .await?;
334 self.peer
335 .respond(
336 request.receipt(),
337 proto::OpenWorktreeResponse {
338 worktree_id,
339 worktree: Some(proto::Worktree {
340 root_name: worktree.root_name.clone(),
341 entries: worktree.entries.values().cloned().collect(),
342 }),
343 replica_id: peer_replica_id as u32,
344 peers,
345 },
346 )
347 .await?;
348 } else {
349 self.peer
350 .respond(
351 request.receipt(),
352 proto::OpenWorktreeResponse {
353 worktree_id,
354 worktree: None,
355 replica_id: 0,
356 peers: Vec::new(),
357 },
358 )
359 .await?;
360 }
361
362 Ok(())
363 }
364
365 async fn update_worktree(
366 self: Arc<Server>,
367 request: TypedEnvelope<proto::UpdateWorktree>,
368 ) -> tide::Result<()> {
369 {
370 let mut state = self.state.write().await;
371 let worktree = state.write_worktree(request.payload.worktree_id, request.sender_id)?;
372 for entry_id in &request.payload.removed_entries {
373 worktree.entries.remove(&entry_id);
374 }
375
376 for entry in &request.payload.updated_entries {
377 worktree.entries.insert(entry.id, entry.clone());
378 }
379 }
380
381 self.broadcast_in_worktree(request.payload.worktree_id, &request)
382 .await?;
383 Ok(())
384 }
385
386 async fn close_worktree(
387 self: Arc<Server>,
388 request: TypedEnvelope<proto::CloseWorktree>,
389 ) -> tide::Result<()> {
390 let connection_ids;
391 {
392 let mut state = self.state.write().await;
393 let worktree = state.write_worktree(request.payload.worktree_id, request.sender_id)?;
394 connection_ids = worktree.connection_ids();
395 if worktree.host_connection_id == Some(request.sender_id) {
396 worktree.host_connection_id = None;
397 } else if let Some(replica_id) =
398 worktree.guest_connection_ids.remove(&request.sender_id)
399 {
400 worktree.active_replica_ids.remove(&replica_id);
401 }
402 }
403
404 broadcast(request.sender_id, connection_ids, |conn_id| {
405 self.peer.send(
406 conn_id,
407 proto::RemovePeer {
408 worktree_id: request.payload.worktree_id,
409 peer_id: request.sender_id.0,
410 },
411 )
412 })
413 .await?;
414
415 Ok(())
416 }
417
418 async fn open_buffer(
419 self: Arc<Server>,
420 request: TypedEnvelope<proto::OpenBuffer>,
421 ) -> tide::Result<()> {
422 let receipt = request.receipt();
423 let worktree_id = request.payload.worktree_id;
424 let host_connection_id = self
425 .state
426 .read()
427 .await
428 .read_worktree(worktree_id, request.sender_id)?
429 .host_connection_id()?;
430
431 let response = self
432 .peer
433 .forward_request(request.sender_id, host_connection_id, request.payload)
434 .await?;
435 self.peer.respond(receipt, response).await?;
436 Ok(())
437 }
438
439 async fn close_buffer(
440 self: Arc<Server>,
441 request: TypedEnvelope<proto::CloseBuffer>,
442 ) -> tide::Result<()> {
443 let host_connection_id = self
444 .state
445 .read()
446 .await
447 .read_worktree(request.payload.worktree_id, request.sender_id)?
448 .host_connection_id()?;
449
450 self.peer
451 .forward_send(request.sender_id, host_connection_id, request.payload)
452 .await?;
453
454 Ok(())
455 }
456
457 async fn save_buffer(
458 self: Arc<Server>,
459 request: TypedEnvelope<proto::SaveBuffer>,
460 ) -> tide::Result<()> {
461 let host;
462 let guests;
463 {
464 let state = self.state.read().await;
465 let worktree = state.read_worktree(request.payload.worktree_id, request.sender_id)?;
466 host = worktree.host_connection_id()?;
467 guests = worktree
468 .guest_connection_ids
469 .keys()
470 .copied()
471 .collect::<Vec<_>>();
472 }
473
474 let sender = request.sender_id;
475 let receipt = request.receipt();
476 let response = self
477 .peer
478 .forward_request(sender, host, request.payload.clone())
479 .await?;
480
481 broadcast(host, guests, |conn_id| {
482 let response = response.clone();
483 let peer = &self.peer;
484 async move {
485 if conn_id == sender {
486 peer.respond(receipt, response).await
487 } else {
488 peer.forward_send(host, conn_id, response).await
489 }
490 }
491 })
492 .await?;
493
494 Ok(())
495 }
496
497 async fn update_buffer(
498 self: Arc<Server>,
499 request: TypedEnvelope<proto::UpdateBuffer>,
500 ) -> tide::Result<()> {
501 self.broadcast_in_worktree(request.payload.worktree_id, &request)
502 .await?;
503 self.peer.respond(request.receipt(), proto::Ack {}).await?;
504 Ok(())
505 }
506
507 async fn buffer_saved(
508 self: Arc<Server>,
509 request: TypedEnvelope<proto::BufferSaved>,
510 ) -> tide::Result<()> {
511 self.broadcast_in_worktree(request.payload.worktree_id, &request)
512 .await
513 }
514
515 async fn get_channels(
516 self: Arc<Server>,
517 request: TypedEnvelope<proto::GetChannels>,
518 ) -> tide::Result<()> {
519 let user_id = self
520 .state
521 .read()
522 .await
523 .user_id_for_connection(request.sender_id)?;
524 let channels = self.app_state.db.get_accessible_channels(user_id).await?;
525 self.peer
526 .respond(
527 request.receipt(),
528 proto::GetChannelsResponse {
529 channels: channels
530 .into_iter()
531 .map(|chan| proto::Channel {
532 id: chan.id.to_proto(),
533 name: chan.name,
534 })
535 .collect(),
536 },
537 )
538 .await?;
539 Ok(())
540 }
541
542 async fn get_users(
543 self: Arc<Server>,
544 request: TypedEnvelope<proto::GetUsers>,
545 ) -> tide::Result<()> {
546 let user_id = self
547 .state
548 .read()
549 .await
550 .user_id_for_connection(request.sender_id)?;
551 let receipt = request.receipt();
552 let user_ids = request.payload.user_ids.into_iter().map(UserId::from_proto);
553 let users = self
554 .app_state
555 .db
556 .get_users_by_ids(user_id, user_ids)
557 .await?
558 .into_iter()
559 .map(|user| proto::User {
560 id: user.id.to_proto(),
561 avatar_url: format!("https://github.com/{}.png?size=128", user.github_login),
562 github_login: user.github_login,
563 })
564 .collect();
565 self.peer
566 .respond(receipt, proto::GetUsersResponse { users })
567 .await?;
568 Ok(())
569 }
570
571 async fn join_channel(
572 self: Arc<Self>,
573 request: TypedEnvelope<proto::JoinChannel>,
574 ) -> tide::Result<()> {
575 let user_id = self
576 .state
577 .read()
578 .await
579 .user_id_for_connection(request.sender_id)?;
580 let channel_id = ChannelId::from_proto(request.payload.channel_id);
581 if !self
582 .app_state
583 .db
584 .can_user_access_channel(user_id, channel_id)
585 .await?
586 {
587 Err(anyhow!("access denied"))?;
588 }
589
590 self.state
591 .write()
592 .await
593 .join_channel(request.sender_id, channel_id);
594 let messages = self
595 .app_state
596 .db
597 .get_channel_messages(channel_id, MESSAGE_COUNT_PER_PAGE, None)
598 .await?
599 .into_iter()
600 .map(|msg| proto::ChannelMessage {
601 id: msg.id.to_proto(),
602 body: msg.body,
603 timestamp: msg.sent_at.unix_timestamp() as u64,
604 sender_id: msg.sender_id.to_proto(),
605 nonce: Some(msg.nonce.as_u128().into()),
606 })
607 .collect::<Vec<_>>();
608 self.peer
609 .respond(
610 request.receipt(),
611 proto::JoinChannelResponse {
612 done: messages.len() < MESSAGE_COUNT_PER_PAGE,
613 messages,
614 },
615 )
616 .await?;
617 Ok(())
618 }
619
620 async fn leave_channel(
621 self: Arc<Self>,
622 request: TypedEnvelope<proto::LeaveChannel>,
623 ) -> tide::Result<()> {
624 let user_id = self
625 .state
626 .read()
627 .await
628 .user_id_for_connection(request.sender_id)?;
629 let channel_id = ChannelId::from_proto(request.payload.channel_id);
630 if !self
631 .app_state
632 .db
633 .can_user_access_channel(user_id, channel_id)
634 .await?
635 {
636 Err(anyhow!("access denied"))?;
637 }
638
639 self.state
640 .write()
641 .await
642 .leave_channel(request.sender_id, channel_id);
643
644 Ok(())
645 }
646
647 async fn send_channel_message(
648 self: Arc<Self>,
649 request: TypedEnvelope<proto::SendChannelMessage>,
650 ) -> tide::Result<()> {
651 let receipt = request.receipt();
652 let channel_id = ChannelId::from_proto(request.payload.channel_id);
653 let user_id;
654 let connection_ids;
655 {
656 let state = self.state.read().await;
657 user_id = state.user_id_for_connection(request.sender_id)?;
658 if let Some(channel) = state.channels.get(&channel_id) {
659 connection_ids = channel.connection_ids();
660 } else {
661 return Ok(());
662 }
663 }
664
665 // Validate the message body.
666 let body = request.payload.body.trim().to_string();
667 if body.len() > MAX_MESSAGE_LEN {
668 self.peer
669 .respond_with_error(
670 receipt,
671 proto::Error {
672 message: "message is too long".to_string(),
673 },
674 )
675 .await?;
676 return Ok(());
677 }
678 if body.is_empty() {
679 self.peer
680 .respond_with_error(
681 receipt,
682 proto::Error {
683 message: "message can't be blank".to_string(),
684 },
685 )
686 .await?;
687 return Ok(());
688 }
689
690 let timestamp = OffsetDateTime::now_utc();
691 let nonce = if let Some(nonce) = request.payload.nonce {
692 nonce
693 } else {
694 self.peer
695 .respond_with_error(
696 receipt,
697 proto::Error {
698 message: "nonce can't be blank".to_string(),
699 },
700 )
701 .await?;
702 return Ok(());
703 };
704
705 let message_id = self
706 .app_state
707 .db
708 .create_channel_message(channel_id, user_id, &body, timestamp, nonce.clone().into())
709 .await?
710 .to_proto();
711 let message = proto::ChannelMessage {
712 sender_id: user_id.to_proto(),
713 id: message_id,
714 body,
715 timestamp: timestamp.unix_timestamp() as u64,
716 nonce: Some(nonce),
717 };
718 broadcast(request.sender_id, connection_ids, |conn_id| {
719 self.peer.send(
720 conn_id,
721 proto::ChannelMessageSent {
722 channel_id: channel_id.to_proto(),
723 message: Some(message.clone()),
724 },
725 )
726 })
727 .await?;
728 self.peer
729 .respond(
730 receipt,
731 proto::SendChannelMessageResponse {
732 message: Some(message),
733 },
734 )
735 .await?;
736 Ok(())
737 }
738
739 async fn get_channel_messages(
740 self: Arc<Self>,
741 request: TypedEnvelope<proto::GetChannelMessages>,
742 ) -> tide::Result<()> {
743 let user_id = self
744 .state
745 .read()
746 .await
747 .user_id_for_connection(request.sender_id)?;
748 let channel_id = ChannelId::from_proto(request.payload.channel_id);
749 if !self
750 .app_state
751 .db
752 .can_user_access_channel(user_id, channel_id)
753 .await?
754 {
755 Err(anyhow!("access denied"))?;
756 }
757
758 let messages = self
759 .app_state
760 .db
761 .get_channel_messages(
762 channel_id,
763 MESSAGE_COUNT_PER_PAGE,
764 Some(MessageId::from_proto(request.payload.before_message_id)),
765 )
766 .await?
767 .into_iter()
768 .map(|msg| proto::ChannelMessage {
769 id: msg.id.to_proto(),
770 body: msg.body,
771 timestamp: msg.sent_at.unix_timestamp() as u64,
772 sender_id: msg.sender_id.to_proto(),
773 nonce: Some(msg.nonce.as_u128().into()),
774 })
775 .collect::<Vec<_>>();
776 self.peer
777 .respond(
778 request.receipt(),
779 proto::GetChannelMessagesResponse {
780 done: messages.len() < MESSAGE_COUNT_PER_PAGE,
781 messages,
782 },
783 )
784 .await?;
785 Ok(())
786 }
787
788 async fn broadcast_in_worktree<T: proto::EnvelopedMessage>(
789 &self,
790 worktree_id: u64,
791 message: &TypedEnvelope<T>,
792 ) -> tide::Result<()> {
793 let connection_ids = self
794 .state
795 .read()
796 .await
797 .read_worktree(worktree_id, message.sender_id)?
798 .connection_ids();
799
800 broadcast(message.sender_id, connection_ids, |conn_id| {
801 self.peer
802 .forward_send(message.sender_id, conn_id, message.payload.clone())
803 })
804 .await?;
805
806 Ok(())
807 }
808}
809
810pub async fn broadcast<F, T>(
811 sender_id: ConnectionId,
812 receiver_ids: Vec<ConnectionId>,
813 mut f: F,
814) -> anyhow::Result<()>
815where
816 F: FnMut(ConnectionId) -> T,
817 T: Future<Output = anyhow::Result<()>>,
818{
819 let futures = receiver_ids
820 .into_iter()
821 .filter(|id| *id != sender_id)
822 .map(|id| f(id));
823 futures::future::try_join_all(futures).await?;
824 Ok(())
825}
826
827impl ServerState {
828 fn join_channel(&mut self, connection_id: ConnectionId, channel_id: ChannelId) {
829 if let Some(connection) = self.connections.get_mut(&connection_id) {
830 connection.channels.insert(channel_id);
831 self.channels
832 .entry(channel_id)
833 .or_default()
834 .connection_ids
835 .insert(connection_id);
836 }
837 }
838
839 fn leave_channel(&mut self, connection_id: ConnectionId, channel_id: ChannelId) {
840 if let Some(connection) = self.connections.get_mut(&connection_id) {
841 connection.channels.remove(&channel_id);
842 if let hash_map::Entry::Occupied(mut entry) = self.channels.entry(channel_id) {
843 entry.get_mut().connection_ids.remove(&connection_id);
844 if entry.get_mut().connection_ids.is_empty() {
845 entry.remove();
846 }
847 }
848 }
849 }
850
851 fn user_id_for_connection(&self, connection_id: ConnectionId) -> tide::Result<UserId> {
852 Ok(self
853 .connections
854 .get(&connection_id)
855 .ok_or_else(|| anyhow!("unknown connection"))?
856 .user_id)
857 }
858
859 // Add the given connection as a guest of the given worktree
860 fn join_worktree(
861 &mut self,
862 connection_id: ConnectionId,
863 worktree_id: u64,
864 access_token: &str,
865 ) -> Option<(ReplicaId, &Worktree)> {
866 if let Some(worktree) = self.worktrees.get_mut(&worktree_id) {
867 if access_token == worktree.access_token {
868 if let Some(connection) = self.connections.get_mut(&connection_id) {
869 connection.worktrees.insert(worktree_id);
870 }
871
872 let mut replica_id = 1;
873 while worktree.active_replica_ids.contains(&replica_id) {
874 replica_id += 1;
875 }
876 worktree.active_replica_ids.insert(replica_id);
877 worktree
878 .guest_connection_ids
879 .insert(connection_id, replica_id);
880 Some((replica_id, worktree))
881 } else {
882 None
883 }
884 } else {
885 None
886 }
887 }
888
889 fn read_worktree(
890 &self,
891 worktree_id: u64,
892 connection_id: ConnectionId,
893 ) -> tide::Result<&Worktree> {
894 let worktree = self
895 .worktrees
896 .get(&worktree_id)
897 .ok_or_else(|| anyhow!("worktree not found"))?;
898
899 if worktree.host_connection_id == Some(connection_id)
900 || worktree.guest_connection_ids.contains_key(&connection_id)
901 {
902 Ok(worktree)
903 } else {
904 Err(anyhow!(
905 "{} is not a member of worktree {}",
906 connection_id,
907 worktree_id
908 ))?
909 }
910 }
911
912 fn write_worktree(
913 &mut self,
914 worktree_id: u64,
915 connection_id: ConnectionId,
916 ) -> tide::Result<&mut Worktree> {
917 let worktree = self
918 .worktrees
919 .get_mut(&worktree_id)
920 .ok_or_else(|| anyhow!("worktree not found"))?;
921
922 if worktree.host_connection_id == Some(connection_id)
923 || worktree.guest_connection_ids.contains_key(&connection_id)
924 {
925 Ok(worktree)
926 } else {
927 Err(anyhow!(
928 "{} is not a member of worktree {}",
929 connection_id,
930 worktree_id
931 ))?
932 }
933 }
934}
935
936impl Worktree {
937 pub fn connection_ids(&self) -> Vec<ConnectionId> {
938 self.guest_connection_ids
939 .keys()
940 .copied()
941 .chain(self.host_connection_id)
942 .collect()
943 }
944
945 fn host_connection_id(&self) -> tide::Result<ConnectionId> {
946 Ok(self
947 .host_connection_id
948 .ok_or_else(|| anyhow!("host disconnected from worktree"))?)
949 }
950}
951
952impl Channel {
953 fn connection_ids(&self) -> Vec<ConnectionId> {
954 self.connection_ids.iter().copied().collect()
955 }
956}
957
958pub fn add_routes(app: &mut tide::Server<Arc<AppState>>, rpc: &Arc<Peer>) {
959 let server = Server::new(app.state().clone(), rpc.clone(), None);
960 app.at("/rpc").with(auth::VerifyToken).get(move |request: Request<Arc<AppState>>| {
961 let user_id = request.ext::<UserId>().copied();
962 let server = server.clone();
963 async move {
964 const WEBSOCKET_GUID: &str = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
965
966 let connection_upgrade = header_contains_ignore_case(&request, CONNECTION, "upgrade");
967 let upgrade_to_websocket = header_contains_ignore_case(&request, UPGRADE, "websocket");
968 let upgrade_requested = connection_upgrade && upgrade_to_websocket;
969
970 if !upgrade_requested {
971 return Ok(Response::new(StatusCode::UpgradeRequired));
972 }
973
974 let header = match request.header("Sec-Websocket-Key") {
975 Some(h) => h.as_str(),
976 None => return Err(anyhow!("expected sec-websocket-key"))?,
977 };
978
979 let mut response = Response::new(StatusCode::SwitchingProtocols);
980 response.insert_header(UPGRADE, "websocket");
981 response.insert_header(CONNECTION, "Upgrade");
982 let hash = Sha1::new().chain(header).chain(WEBSOCKET_GUID).finalize();
983 response.insert_header("Sec-Websocket-Accept", base64::encode(&hash[..]));
984 response.insert_header("Sec-Websocket-Version", "13");
985
986 let http_res: &mut tide::http::Response = response.as_mut();
987 let upgrade_receiver = http_res.recv_upgrade().await;
988 let addr = request.remote().unwrap_or("unknown").to_string();
989 let user_id = user_id.ok_or_else(|| anyhow!("user_id is not present on request. ensure auth::VerifyToken middleware is present"))?;
990 task::spawn(async move {
991 if let Some(stream) = upgrade_receiver.await {
992 server.handle_connection(Connection::new(WebSocketStream::from_raw_socket(stream, Role::Server, None).await), addr, user_id).await;
993 }
994 });
995
996 Ok(response)
997 }
998 });
999}
1000
1001fn header_contains_ignore_case<T>(
1002 request: &tide::Request<T>,
1003 header_name: HeaderName,
1004 value: &str,
1005) -> bool {
1006 request
1007 .header(header_name)
1008 .map(|h| {
1009 h.as_str()
1010 .split(',')
1011 .any(|s| s.trim().eq_ignore_ascii_case(value.trim()))
1012 })
1013 .unwrap_or(false)
1014}
1015
1016#[cfg(test)]
1017mod tests {
1018 use super::*;
1019 use crate::{
1020 auth,
1021 db::{tests::TestDb, UserId},
1022 github, AppState, Config,
1023 };
1024 use async_std::{sync::RwLockReadGuard, task};
1025 use gpui::TestAppContext;
1026 use parking_lot::Mutex;
1027 use postage::{mpsc, watch};
1028 use serde_json::json;
1029 use sqlx::types::time::OffsetDateTime;
1030 use std::{
1031 path::Path,
1032 sync::{
1033 atomic::{AtomicBool, Ordering::SeqCst},
1034 Arc,
1035 },
1036 time::Duration,
1037 };
1038 use zed::{
1039 channel::{Channel, ChannelDetails, ChannelList},
1040 editor::{Editor, Insert},
1041 fs::{FakeFs, Fs as _},
1042 language::LanguageRegistry,
1043 rpc::{self, Client, Credentials, EstablishConnectionError},
1044 settings,
1045 test::FakeHttpClient,
1046 user::UserStore,
1047 worktree::Worktree,
1048 };
1049 use zrpc::Peer;
1050
1051 #[gpui::test]
1052 async fn test_share_worktree(mut cx_a: TestAppContext, mut cx_b: TestAppContext) {
1053 let (window_b, _) = cx_b.add_window(|_| EmptyView);
1054 let settings = cx_b.read(settings::test).1;
1055 let lang_registry = Arc::new(LanguageRegistry::new());
1056
1057 // Connect to a server as 2 clients.
1058 let mut server = TestServer::start().await;
1059 let (client_a, _) = server.create_client(&mut cx_a, "user_a").await;
1060 let (client_b, _) = server.create_client(&mut cx_b, "user_b").await;
1061
1062 cx_a.foreground().forbid_parking();
1063
1064 // Share a local worktree as client A
1065 let fs = Arc::new(FakeFs::new());
1066 fs.insert_tree(
1067 "/a",
1068 json!({
1069 "a.txt": "a-contents",
1070 "b.txt": "b-contents",
1071 }),
1072 )
1073 .await;
1074 let worktree_a = Worktree::open_local(
1075 "/a".as_ref(),
1076 lang_registry.clone(),
1077 fs,
1078 &mut cx_a.to_async(),
1079 )
1080 .await
1081 .unwrap();
1082 worktree_a
1083 .read_with(&cx_a, |tree, _| tree.as_local().unwrap().scan_complete())
1084 .await;
1085 let (worktree_id, worktree_token) = worktree_a
1086 .update(&mut cx_a, |tree, cx| {
1087 tree.as_local_mut().unwrap().share(client_a.clone(), cx)
1088 })
1089 .await
1090 .unwrap();
1091
1092 // Join that worktree as client B, and see that a guest has joined as client A.
1093 let worktree_b = Worktree::open_remote(
1094 client_b.clone(),
1095 worktree_id,
1096 worktree_token,
1097 lang_registry.clone(),
1098 &mut cx_b.to_async(),
1099 )
1100 .await
1101 .unwrap();
1102 let replica_id_b = worktree_b.read_with(&cx_b, |tree, _| tree.replica_id());
1103 worktree_a
1104 .condition(&cx_a, |tree, _| {
1105 tree.peers()
1106 .values()
1107 .any(|replica_id| *replica_id == replica_id_b)
1108 })
1109 .await;
1110
1111 // Open the same file as client B and client A.
1112 let buffer_b = worktree_b
1113 .update(&mut cx_b, |worktree, cx| worktree.open_buffer("b.txt", cx))
1114 .await
1115 .unwrap();
1116 buffer_b.read_with(&cx_b, |buf, _| assert_eq!(buf.text(), "b-contents"));
1117 worktree_a.read_with(&cx_a, |tree, cx| assert!(tree.has_open_buffer("b.txt", cx)));
1118 let buffer_a = worktree_a
1119 .update(&mut cx_a, |tree, cx| tree.open_buffer("b.txt", cx))
1120 .await
1121 .unwrap();
1122
1123 // Create a selection set as client B and see that selection set as client A.
1124 let editor_b = cx_b.add_view(window_b, |cx| {
1125 Editor::for_buffer(buffer_b, settings, |_| Default::default(), cx)
1126 });
1127 buffer_a
1128 .condition(&cx_a, |buffer, _| buffer.selection_sets().count() == 1)
1129 .await;
1130
1131 // Edit the buffer as client B and see that edit as client A.
1132 editor_b.update(&mut cx_b, |editor, cx| {
1133 editor.insert(&Insert("ok, ".into()), cx)
1134 });
1135 buffer_a
1136 .condition(&cx_a, |buffer, _| buffer.text() == "ok, b-contents")
1137 .await;
1138
1139 // Remove the selection set as client B, see those selections disappear as client A.
1140 cx_b.update(move |_| drop(editor_b));
1141 buffer_a
1142 .condition(&cx_a, |buffer, _| buffer.selection_sets().count() == 0)
1143 .await;
1144
1145 // Close the buffer as client A, see that the buffer is closed.
1146 cx_a.update(move |_| drop(buffer_a));
1147 worktree_a
1148 .condition(&cx_a, |tree, cx| !tree.has_open_buffer("b.txt", cx))
1149 .await;
1150
1151 // Dropping the worktree removes client B from client A's peers.
1152 cx_b.update(move |_| drop(worktree_b));
1153 worktree_a
1154 .condition(&cx_a, |tree, _| tree.peers().is_empty())
1155 .await;
1156 }
1157
1158 #[gpui::test]
1159 async fn test_propagate_saves_and_fs_changes_in_shared_worktree(
1160 mut cx_a: TestAppContext,
1161 mut cx_b: TestAppContext,
1162 mut cx_c: TestAppContext,
1163 ) {
1164 cx_a.foreground().forbid_parking();
1165 let lang_registry = Arc::new(LanguageRegistry::new());
1166
1167 // Connect to a server as 3 clients.
1168 let mut server = TestServer::start().await;
1169 let (client_a, _) = server.create_client(&mut cx_a, "user_a").await;
1170 let (client_b, _) = server.create_client(&mut cx_b, "user_b").await;
1171 let (client_c, _) = server.create_client(&mut cx_c, "user_c").await;
1172
1173 let fs = Arc::new(FakeFs::new());
1174
1175 // Share a worktree as client A.
1176 fs.insert_tree(
1177 "/a",
1178 json!({
1179 "file1": "",
1180 "file2": ""
1181 }),
1182 )
1183 .await;
1184
1185 let worktree_a = Worktree::open_local(
1186 "/a".as_ref(),
1187 lang_registry.clone(),
1188 fs.clone(),
1189 &mut cx_a.to_async(),
1190 )
1191 .await
1192 .unwrap();
1193 worktree_a
1194 .read_with(&cx_a, |tree, _| tree.as_local().unwrap().scan_complete())
1195 .await;
1196 let (worktree_id, worktree_token) = worktree_a
1197 .update(&mut cx_a, |tree, cx| {
1198 tree.as_local_mut().unwrap().share(client_a.clone(), cx)
1199 })
1200 .await
1201 .unwrap();
1202
1203 // Join that worktree as clients B and C.
1204 let worktree_b = Worktree::open_remote(
1205 client_b.clone(),
1206 worktree_id,
1207 worktree_token.clone(),
1208 lang_registry.clone(),
1209 &mut cx_b.to_async(),
1210 )
1211 .await
1212 .unwrap();
1213 let worktree_c = Worktree::open_remote(
1214 client_c.clone(),
1215 worktree_id,
1216 worktree_token,
1217 lang_registry.clone(),
1218 &mut cx_c.to_async(),
1219 )
1220 .await
1221 .unwrap();
1222
1223 // Open and edit a buffer as both guests B and C.
1224 let buffer_b = worktree_b
1225 .update(&mut cx_b, |tree, cx| tree.open_buffer("file1", cx))
1226 .await
1227 .unwrap();
1228 let buffer_c = worktree_c
1229 .update(&mut cx_c, |tree, cx| tree.open_buffer("file1", cx))
1230 .await
1231 .unwrap();
1232 buffer_b.update(&mut cx_b, |buf, cx| buf.edit([0..0], "i-am-b, ", cx));
1233 buffer_c.update(&mut cx_c, |buf, cx| buf.edit([0..0], "i-am-c, ", cx));
1234
1235 // Open and edit that buffer as the host.
1236 let buffer_a = worktree_a
1237 .update(&mut cx_a, |tree, cx| tree.open_buffer("file1", cx))
1238 .await
1239 .unwrap();
1240
1241 buffer_a
1242 .condition(&mut cx_a, |buf, _| buf.text() == "i-am-c, i-am-b, ")
1243 .await;
1244 buffer_a.update(&mut cx_a, |buf, cx| {
1245 buf.edit([buf.len()..buf.len()], "i-am-a", cx)
1246 });
1247
1248 // Wait for edits to propagate
1249 buffer_a
1250 .condition(&mut cx_a, |buf, _| buf.text() == "i-am-c, i-am-b, i-am-a")
1251 .await;
1252 buffer_b
1253 .condition(&mut cx_b, |buf, _| buf.text() == "i-am-c, i-am-b, i-am-a")
1254 .await;
1255 buffer_c
1256 .condition(&mut cx_c, |buf, _| buf.text() == "i-am-c, i-am-b, i-am-a")
1257 .await;
1258
1259 // Edit the buffer as the host and concurrently save as guest B.
1260 let save_b = buffer_b.update(&mut cx_b, |buf, cx| buf.save(cx).unwrap());
1261 buffer_a.update(&mut cx_a, |buf, cx| buf.edit([0..0], "hi-a, ", cx));
1262 save_b.await.unwrap();
1263 assert_eq!(
1264 fs.load("/a/file1".as_ref()).await.unwrap(),
1265 "hi-a, i-am-c, i-am-b, i-am-a"
1266 );
1267 buffer_a.read_with(&cx_a, |buf, _| assert!(!buf.is_dirty()));
1268 buffer_b.read_with(&cx_b, |buf, _| assert!(!buf.is_dirty()));
1269 buffer_c.condition(&cx_c, |buf, _| !buf.is_dirty()).await;
1270
1271 // Make changes on host's file system, see those changes on the guests.
1272 fs.rename("/a/file2".as_ref(), "/a/file3".as_ref())
1273 .await
1274 .unwrap();
1275 fs.insert_file(Path::new("/a/file4"), "4".into())
1276 .await
1277 .unwrap();
1278
1279 worktree_b
1280 .condition(&cx_b, |tree, _| tree.file_count() == 3)
1281 .await;
1282 worktree_c
1283 .condition(&cx_c, |tree, _| tree.file_count() == 3)
1284 .await;
1285 worktree_b.read_with(&cx_b, |tree, _| {
1286 assert_eq!(
1287 tree.paths()
1288 .map(|p| p.to_string_lossy())
1289 .collect::<Vec<_>>(),
1290 &["file1", "file3", "file4"]
1291 )
1292 });
1293 worktree_c.read_with(&cx_c, |tree, _| {
1294 assert_eq!(
1295 tree.paths()
1296 .map(|p| p.to_string_lossy())
1297 .collect::<Vec<_>>(),
1298 &["file1", "file3", "file4"]
1299 )
1300 });
1301 }
1302
1303 #[gpui::test]
1304 async fn test_buffer_conflict_after_save(mut cx_a: TestAppContext, mut cx_b: TestAppContext) {
1305 cx_a.foreground().forbid_parking();
1306 let lang_registry = Arc::new(LanguageRegistry::new());
1307
1308 // Connect to a server as 2 clients.
1309 let mut server = TestServer::start().await;
1310 let (client_a, _) = server.create_client(&mut cx_a, "user_a").await;
1311 let (client_b, _) = server.create_client(&mut cx_b, "user_b").await;
1312
1313 // Share a local worktree as client A
1314 let fs = Arc::new(FakeFs::new());
1315 fs.save(Path::new("/a.txt"), &"a-contents".into())
1316 .await
1317 .unwrap();
1318 let worktree_a = Worktree::open_local(
1319 "/".as_ref(),
1320 lang_registry.clone(),
1321 fs,
1322 &mut cx_a.to_async(),
1323 )
1324 .await
1325 .unwrap();
1326 worktree_a
1327 .read_with(&cx_a, |tree, _| tree.as_local().unwrap().scan_complete())
1328 .await;
1329 let (worktree_id, worktree_token) = worktree_a
1330 .update(&mut cx_a, |tree, cx| {
1331 tree.as_local_mut().unwrap().share(client_a.clone(), cx)
1332 })
1333 .await
1334 .unwrap();
1335
1336 // Join that worktree as client B, and see that a guest has joined as client A.
1337 let worktree_b = Worktree::open_remote(
1338 client_b.clone(),
1339 worktree_id,
1340 worktree_token,
1341 lang_registry.clone(),
1342 &mut cx_b.to_async(),
1343 )
1344 .await
1345 .unwrap();
1346
1347 let buffer_b = worktree_b
1348 .update(&mut cx_b, |worktree, cx| worktree.open_buffer("a.txt", cx))
1349 .await
1350 .unwrap();
1351 let mtime = buffer_b.read_with(&cx_b, |buf, _| buf.file().unwrap().mtime);
1352
1353 buffer_b.update(&mut cx_b, |buf, cx| buf.edit([0..0], "world ", cx));
1354 buffer_b.read_with(&cx_b, |buf, _| {
1355 assert!(buf.is_dirty());
1356 assert!(!buf.has_conflict());
1357 });
1358
1359 buffer_b
1360 .update(&mut cx_b, |buf, cx| buf.save(cx))
1361 .unwrap()
1362 .await
1363 .unwrap();
1364 worktree_b
1365 .condition(&cx_b, |_, cx| {
1366 buffer_b.read(cx).file().unwrap().mtime != mtime
1367 })
1368 .await;
1369 buffer_b.read_with(&cx_b, |buf, _| {
1370 assert!(!buf.is_dirty());
1371 assert!(!buf.has_conflict());
1372 });
1373
1374 buffer_b.update(&mut cx_b, |buf, cx| buf.edit([0..0], "hello ", cx));
1375 buffer_b.read_with(&cx_b, |buf, _| {
1376 assert!(buf.is_dirty());
1377 assert!(!buf.has_conflict());
1378 });
1379 }
1380
1381 #[gpui::test]
1382 async fn test_editing_while_guest_opens_buffer(
1383 mut cx_a: TestAppContext,
1384 mut cx_b: TestAppContext,
1385 ) {
1386 cx_a.foreground().forbid_parking();
1387 let lang_registry = Arc::new(LanguageRegistry::new());
1388
1389 // Connect to a server as 2 clients.
1390 let mut server = TestServer::start().await;
1391 let (client_a, _) = server.create_client(&mut cx_a, "user_a").await;
1392 let (client_b, _) = server.create_client(&mut cx_b, "user_b").await;
1393
1394 // Share a local worktree as client A
1395 let fs = Arc::new(FakeFs::new());
1396 fs.save(Path::new("/a.txt"), &"a-contents".into())
1397 .await
1398 .unwrap();
1399 let worktree_a = Worktree::open_local(
1400 "/".as_ref(),
1401 lang_registry.clone(),
1402 fs,
1403 &mut cx_a.to_async(),
1404 )
1405 .await
1406 .unwrap();
1407 worktree_a
1408 .read_with(&cx_a, |tree, _| tree.as_local().unwrap().scan_complete())
1409 .await;
1410 let (worktree_id, worktree_token) = worktree_a
1411 .update(&mut cx_a, |tree, cx| {
1412 tree.as_local_mut().unwrap().share(client_a.clone(), cx)
1413 })
1414 .await
1415 .unwrap();
1416
1417 // Join that worktree as client B, and see that a guest has joined as client A.
1418 let worktree_b = Worktree::open_remote(
1419 client_b.clone(),
1420 worktree_id,
1421 worktree_token,
1422 lang_registry.clone(),
1423 &mut cx_b.to_async(),
1424 )
1425 .await
1426 .unwrap();
1427
1428 let buffer_a = worktree_a
1429 .update(&mut cx_a, |tree, cx| tree.open_buffer("a.txt", cx))
1430 .await
1431 .unwrap();
1432 let buffer_b = cx_b
1433 .background()
1434 .spawn(worktree_b.update(&mut cx_b, |worktree, cx| worktree.open_buffer("a.txt", cx)));
1435
1436 task::yield_now().await;
1437 buffer_a.update(&mut cx_a, |buf, cx| buf.edit([0..0], "z", cx));
1438
1439 let text = buffer_a.read_with(&cx_a, |buf, _| buf.text());
1440 let buffer_b = buffer_b.await.unwrap();
1441 buffer_b.condition(&cx_b, |buf, _| buf.text() == text).await;
1442 }
1443
1444 #[gpui::test]
1445 async fn test_peer_disconnection(mut cx_a: TestAppContext, cx_b: TestAppContext) {
1446 cx_a.foreground().forbid_parking();
1447 let lang_registry = Arc::new(LanguageRegistry::new());
1448
1449 // Connect to a server as 2 clients.
1450 let mut server = TestServer::start().await;
1451 let (client_a, _) = server.create_client(&mut cx_a, "user_a").await;
1452 let (client_b, _) = server.create_client(&mut cx_a, "user_b").await;
1453
1454 // Share a local worktree as client A
1455 let fs = Arc::new(FakeFs::new());
1456 fs.insert_tree(
1457 "/a",
1458 json!({
1459 "a.txt": "a-contents",
1460 "b.txt": "b-contents",
1461 }),
1462 )
1463 .await;
1464 let worktree_a = Worktree::open_local(
1465 "/a".as_ref(),
1466 lang_registry.clone(),
1467 fs,
1468 &mut cx_a.to_async(),
1469 )
1470 .await
1471 .unwrap();
1472 worktree_a
1473 .read_with(&cx_a, |tree, _| tree.as_local().unwrap().scan_complete())
1474 .await;
1475 let (worktree_id, worktree_token) = worktree_a
1476 .update(&mut cx_a, |tree, cx| {
1477 tree.as_local_mut().unwrap().share(client_a.clone(), cx)
1478 })
1479 .await
1480 .unwrap();
1481
1482 // Join that worktree as client B, and see that a guest has joined as client A.
1483 let _worktree_b = Worktree::open_remote(
1484 client_b.clone(),
1485 worktree_id,
1486 worktree_token,
1487 lang_registry.clone(),
1488 &mut cx_b.to_async(),
1489 )
1490 .await
1491 .unwrap();
1492 worktree_a
1493 .condition(&cx_a, |tree, _| tree.peers().len() == 1)
1494 .await;
1495
1496 // Drop client B's connection and ensure client A observes client B leaving the worktree.
1497 client_b.disconnect(&cx_b.to_async()).await.unwrap();
1498 worktree_a
1499 .condition(&cx_a, |tree, _| tree.peers().len() == 0)
1500 .await;
1501 }
1502
1503 #[gpui::test]
1504 async fn test_basic_chat(mut cx_a: TestAppContext, mut cx_b: TestAppContext) {
1505 cx_a.foreground().forbid_parking();
1506
1507 // Connect to a server as 2 clients.
1508 let mut server = TestServer::start().await;
1509 let (client_a, user_store_a) = server.create_client(&mut cx_a, "user_a").await;
1510 let (client_b, user_store_b) = server.create_client(&mut cx_b, "user_b").await;
1511
1512 // Create an org that includes these 2 users.
1513 let db = &server.app_state.db;
1514 let org_id = db.create_org("Test Org", "test-org").await.unwrap();
1515 db.add_org_member(org_id, current_user_id(&user_store_a), false)
1516 .await
1517 .unwrap();
1518 db.add_org_member(org_id, current_user_id(&user_store_b), false)
1519 .await
1520 .unwrap();
1521
1522 // Create a channel that includes all the users.
1523 let channel_id = db.create_org_channel(org_id, "test-channel").await.unwrap();
1524 db.add_channel_member(channel_id, current_user_id(&user_store_a), false)
1525 .await
1526 .unwrap();
1527 db.add_channel_member(channel_id, current_user_id(&user_store_b), false)
1528 .await
1529 .unwrap();
1530 db.create_channel_message(
1531 channel_id,
1532 current_user_id(&user_store_b),
1533 "hello A, it's B.",
1534 OffsetDateTime::now_utc(),
1535 1,
1536 )
1537 .await
1538 .unwrap();
1539
1540 let channels_a = cx_a.add_model(|cx| ChannelList::new(user_store_a, client_a, cx));
1541 channels_a
1542 .condition(&mut cx_a, |list, _| list.available_channels().is_some())
1543 .await;
1544 channels_a.read_with(&cx_a, |list, _| {
1545 assert_eq!(
1546 list.available_channels().unwrap(),
1547 &[ChannelDetails {
1548 id: channel_id.to_proto(),
1549 name: "test-channel".to_string()
1550 }]
1551 )
1552 });
1553 let channel_a = channels_a.update(&mut cx_a, |this, cx| {
1554 this.get_channel(channel_id.to_proto(), cx).unwrap()
1555 });
1556 channel_a.read_with(&cx_a, |channel, _| assert!(channel.messages().is_empty()));
1557 channel_a
1558 .condition(&cx_a, |channel, _| {
1559 channel_messages(channel)
1560 == [("user_b".to_string(), "hello A, it's B.".to_string(), false)]
1561 })
1562 .await;
1563
1564 let channels_b = cx_b.add_model(|cx| ChannelList::new(user_store_b, client_b, cx));
1565 channels_b
1566 .condition(&mut cx_b, |list, _| list.available_channels().is_some())
1567 .await;
1568 channels_b.read_with(&cx_b, |list, _| {
1569 assert_eq!(
1570 list.available_channels().unwrap(),
1571 &[ChannelDetails {
1572 id: channel_id.to_proto(),
1573 name: "test-channel".to_string()
1574 }]
1575 )
1576 });
1577
1578 let channel_b = channels_b.update(&mut cx_b, |this, cx| {
1579 this.get_channel(channel_id.to_proto(), cx).unwrap()
1580 });
1581 channel_b.read_with(&cx_b, |channel, _| assert!(channel.messages().is_empty()));
1582 channel_b
1583 .condition(&cx_b, |channel, _| {
1584 channel_messages(channel)
1585 == [("user_b".to_string(), "hello A, it's B.".to_string(), false)]
1586 })
1587 .await;
1588
1589 channel_a
1590 .update(&mut cx_a, |channel, cx| {
1591 channel
1592 .send_message("oh, hi B.".to_string(), cx)
1593 .unwrap()
1594 .detach();
1595 let task = channel.send_message("sup".to_string(), cx).unwrap();
1596 assert_eq!(
1597 channel_messages(channel),
1598 &[
1599 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1600 ("user_a".to_string(), "oh, hi B.".to_string(), true),
1601 ("user_a".to_string(), "sup".to_string(), true)
1602 ]
1603 );
1604 task
1605 })
1606 .await
1607 .unwrap();
1608
1609 channel_b
1610 .condition(&cx_b, |channel, _| {
1611 channel_messages(channel)
1612 == [
1613 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1614 ("user_a".to_string(), "oh, hi B.".to_string(), false),
1615 ("user_a".to_string(), "sup".to_string(), false),
1616 ]
1617 })
1618 .await;
1619
1620 assert_eq!(
1621 server.state().await.channels[&channel_id]
1622 .connection_ids
1623 .len(),
1624 2
1625 );
1626 cx_b.update(|_| drop(channel_b));
1627 server
1628 .condition(|state| state.channels[&channel_id].connection_ids.len() == 1)
1629 .await;
1630
1631 cx_a.update(|_| drop(channel_a));
1632 server
1633 .condition(|state| !state.channels.contains_key(&channel_id))
1634 .await;
1635 }
1636
1637 #[gpui::test]
1638 async fn test_chat_message_validation(mut cx_a: TestAppContext) {
1639 cx_a.foreground().forbid_parking();
1640
1641 let mut server = TestServer::start().await;
1642 let (client_a, user_store_a) = server.create_client(&mut cx_a, "user_a").await;
1643
1644 let db = &server.app_state.db;
1645 let org_id = db.create_org("Test Org", "test-org").await.unwrap();
1646 let channel_id = db.create_org_channel(org_id, "test-channel").await.unwrap();
1647 db.add_org_member(org_id, current_user_id(&user_store_a), false)
1648 .await
1649 .unwrap();
1650 db.add_channel_member(channel_id, current_user_id(&user_store_a), false)
1651 .await
1652 .unwrap();
1653
1654 let channels_a = cx_a.add_model(|cx| ChannelList::new(user_store_a, client_a, cx));
1655 channels_a
1656 .condition(&mut cx_a, |list, _| list.available_channels().is_some())
1657 .await;
1658 let channel_a = channels_a.update(&mut cx_a, |this, cx| {
1659 this.get_channel(channel_id.to_proto(), cx).unwrap()
1660 });
1661
1662 // Messages aren't allowed to be too long.
1663 channel_a
1664 .update(&mut cx_a, |channel, cx| {
1665 let long_body = "this is long.\n".repeat(1024);
1666 channel.send_message(long_body, cx).unwrap()
1667 })
1668 .await
1669 .unwrap_err();
1670
1671 // Messages aren't allowed to be blank.
1672 channel_a.update(&mut cx_a, |channel, cx| {
1673 channel.send_message(String::new(), cx).unwrap_err()
1674 });
1675
1676 // Leading and trailing whitespace are trimmed.
1677 channel_a
1678 .update(&mut cx_a, |channel, cx| {
1679 channel
1680 .send_message("\n surrounded by whitespace \n".to_string(), cx)
1681 .unwrap()
1682 })
1683 .await
1684 .unwrap();
1685 assert_eq!(
1686 db.get_channel_messages(channel_id, 10, None)
1687 .await
1688 .unwrap()
1689 .iter()
1690 .map(|m| &m.body)
1691 .collect::<Vec<_>>(),
1692 &["surrounded by whitespace"]
1693 );
1694 }
1695
1696 #[gpui::test]
1697 async fn test_chat_reconnection(mut cx_a: TestAppContext, mut cx_b: TestAppContext) {
1698 cx_a.foreground().forbid_parking();
1699 let http = FakeHttpClient::new(|_| async move { Ok(surf::http::Response::new(404)) });
1700
1701 // Connect to a server as 2 clients.
1702 let mut server = TestServer::start().await;
1703 let (client_a, user_store_a) = server.create_client(&mut cx_a, "user_a").await;
1704 let (client_b, user_store_b) = server.create_client(&mut cx_b, "user_b").await;
1705 let mut status_b = client_b.status();
1706
1707 // Create an org that includes these 2 users.
1708 let db = &server.app_state.db;
1709 let org_id = db.create_org("Test Org", "test-org").await.unwrap();
1710 db.add_org_member(org_id, current_user_id(&user_store_a), false)
1711 .await
1712 .unwrap();
1713 db.add_org_member(org_id, current_user_id(&user_store_b), false)
1714 .await
1715 .unwrap();
1716
1717 // Create a channel that includes all the users.
1718 let channel_id = db.create_org_channel(org_id, "test-channel").await.unwrap();
1719 db.add_channel_member(channel_id, current_user_id(&user_store_a), false)
1720 .await
1721 .unwrap();
1722 db.add_channel_member(channel_id, current_user_id(&user_store_b), false)
1723 .await
1724 .unwrap();
1725 db.create_channel_message(
1726 channel_id,
1727 current_user_id(&user_store_b),
1728 "hello A, it's B.",
1729 OffsetDateTime::now_utc(),
1730 2,
1731 )
1732 .await
1733 .unwrap();
1734
1735 let user_store_a =
1736 UserStore::new(client_a.clone(), http.clone(), cx_a.background().as_ref());
1737 let channels_a = cx_a.add_model(|cx| ChannelList::new(user_store_a, client_a, cx));
1738 channels_a
1739 .condition(&mut cx_a, |list, _| list.available_channels().is_some())
1740 .await;
1741
1742 channels_a.read_with(&cx_a, |list, _| {
1743 assert_eq!(
1744 list.available_channels().unwrap(),
1745 &[ChannelDetails {
1746 id: channel_id.to_proto(),
1747 name: "test-channel".to_string()
1748 }]
1749 )
1750 });
1751 let channel_a = channels_a.update(&mut cx_a, |this, cx| {
1752 this.get_channel(channel_id.to_proto(), cx).unwrap()
1753 });
1754 channel_a.read_with(&cx_a, |channel, _| assert!(channel.messages().is_empty()));
1755 channel_a
1756 .condition(&cx_a, |channel, _| {
1757 channel_messages(channel)
1758 == [("user_b".to_string(), "hello A, it's B.".to_string(), false)]
1759 })
1760 .await;
1761
1762 let channels_b = cx_b.add_model(|cx| ChannelList::new(user_store_b.clone(), client_b, cx));
1763 channels_b
1764 .condition(&mut cx_b, |list, _| list.available_channels().is_some())
1765 .await;
1766 channels_b.read_with(&cx_b, |list, _| {
1767 assert_eq!(
1768 list.available_channels().unwrap(),
1769 &[ChannelDetails {
1770 id: channel_id.to_proto(),
1771 name: "test-channel".to_string()
1772 }]
1773 )
1774 });
1775
1776 let channel_b = channels_b.update(&mut cx_b, |this, cx| {
1777 this.get_channel(channel_id.to_proto(), cx).unwrap()
1778 });
1779 channel_b.read_with(&cx_b, |channel, _| assert!(channel.messages().is_empty()));
1780 channel_b
1781 .condition(&cx_b, |channel, _| {
1782 channel_messages(channel)
1783 == [("user_b".to_string(), "hello A, it's B.".to_string(), false)]
1784 })
1785 .await;
1786
1787 // Disconnect client B, ensuring we can still access its cached channel data.
1788 server.forbid_connections();
1789 server.disconnect_client(current_user_id(&user_store_b));
1790 while !matches!(
1791 status_b.recv().await,
1792 Some(rpc::Status::ReconnectionError { .. })
1793 ) {}
1794
1795 channels_b.read_with(&cx_b, |channels, _| {
1796 assert_eq!(
1797 channels.available_channels().unwrap(),
1798 [ChannelDetails {
1799 id: channel_id.to_proto(),
1800 name: "test-channel".to_string()
1801 }]
1802 )
1803 });
1804 channel_b.read_with(&cx_b, |channel, _| {
1805 assert_eq!(
1806 channel_messages(channel),
1807 [("user_b".to_string(), "hello A, it's B.".to_string(), false)]
1808 )
1809 });
1810
1811 // Send a message from client B while it is disconnected.
1812 channel_b
1813 .update(&mut cx_b, |channel, cx| {
1814 let task = channel
1815 .send_message("can you see this?".to_string(), cx)
1816 .unwrap();
1817 assert_eq!(
1818 channel_messages(channel),
1819 &[
1820 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1821 ("user_b".to_string(), "can you see this?".to_string(), true)
1822 ]
1823 );
1824 task
1825 })
1826 .await
1827 .unwrap_err();
1828
1829 // Send a message from client A while B is disconnected.
1830 channel_a
1831 .update(&mut cx_a, |channel, cx| {
1832 channel
1833 .send_message("oh, hi B.".to_string(), cx)
1834 .unwrap()
1835 .detach();
1836 let task = channel.send_message("sup".to_string(), cx).unwrap();
1837 assert_eq!(
1838 channel_messages(channel),
1839 &[
1840 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1841 ("user_a".to_string(), "oh, hi B.".to_string(), true),
1842 ("user_a".to_string(), "sup".to_string(), true)
1843 ]
1844 );
1845 task
1846 })
1847 .await
1848 .unwrap();
1849
1850 // Give client B a chance to reconnect.
1851 server.allow_connections();
1852 cx_b.foreground().advance_clock(Duration::from_secs(10));
1853
1854 // Verify that B sees the new messages upon reconnection, as well as the message client B
1855 // sent while offline.
1856 channel_b
1857 .condition(&cx_b, |channel, _| {
1858 channel_messages(channel)
1859 == [
1860 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1861 ("user_a".to_string(), "oh, hi B.".to_string(), false),
1862 ("user_a".to_string(), "sup".to_string(), false),
1863 ("user_b".to_string(), "can you see this?".to_string(), false),
1864 ]
1865 })
1866 .await;
1867
1868 // Ensure client A and B can communicate normally after reconnection.
1869 channel_a
1870 .update(&mut cx_a, |channel, cx| {
1871 channel.send_message("you online?".to_string(), cx).unwrap()
1872 })
1873 .await
1874 .unwrap();
1875 channel_b
1876 .condition(&cx_b, |channel, _| {
1877 channel_messages(channel)
1878 == [
1879 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1880 ("user_a".to_string(), "oh, hi B.".to_string(), false),
1881 ("user_a".to_string(), "sup".to_string(), false),
1882 ("user_b".to_string(), "can you see this?".to_string(), false),
1883 ("user_a".to_string(), "you online?".to_string(), false),
1884 ]
1885 })
1886 .await;
1887
1888 channel_b
1889 .update(&mut cx_b, |channel, cx| {
1890 channel.send_message("yep".to_string(), cx).unwrap()
1891 })
1892 .await
1893 .unwrap();
1894 channel_a
1895 .condition(&cx_a, |channel, _| {
1896 channel_messages(channel)
1897 == [
1898 ("user_b".to_string(), "hello A, it's B.".to_string(), false),
1899 ("user_a".to_string(), "oh, hi B.".to_string(), false),
1900 ("user_a".to_string(), "sup".to_string(), false),
1901 ("user_b".to_string(), "can you see this?".to_string(), false),
1902 ("user_a".to_string(), "you online?".to_string(), false),
1903 ("user_b".to_string(), "yep".to_string(), false),
1904 ]
1905 })
1906 .await;
1907 }
1908
1909 struct TestServer {
1910 peer: Arc<Peer>,
1911 app_state: Arc<AppState>,
1912 server: Arc<Server>,
1913 notifications: mpsc::Receiver<()>,
1914 connection_killers: Arc<Mutex<HashMap<UserId, watch::Sender<Option<()>>>>>,
1915 forbid_connections: Arc<AtomicBool>,
1916 _test_db: TestDb,
1917 }
1918
1919 impl TestServer {
1920 async fn start() -> Self {
1921 let test_db = TestDb::new();
1922 let app_state = Self::build_app_state(&test_db).await;
1923 let peer = Peer::new();
1924 let notifications = mpsc::channel(128);
1925 let server = Server::new(app_state.clone(), peer.clone(), Some(notifications.0));
1926 Self {
1927 peer,
1928 app_state,
1929 server,
1930 notifications: notifications.1,
1931 connection_killers: Default::default(),
1932 forbid_connections: Default::default(),
1933 _test_db: test_db,
1934 }
1935 }
1936
1937 async fn create_client(
1938 &mut self,
1939 cx: &mut TestAppContext,
1940 name: &str,
1941 ) -> (Arc<Client>, Arc<UserStore>) {
1942 let user_id = self.app_state.db.create_user(name, false).await.unwrap();
1943 let client_name = name.to_string();
1944 let mut client = Client::new();
1945 let server = self.server.clone();
1946 let connection_killers = self.connection_killers.clone();
1947 let forbid_connections = self.forbid_connections.clone();
1948 Arc::get_mut(&mut client)
1949 .unwrap()
1950 .override_authenticate(move |cx| {
1951 cx.spawn(|_| async move {
1952 let access_token = "the-token".to_string();
1953 Ok(Credentials {
1954 user_id: user_id.0 as u64,
1955 access_token,
1956 })
1957 })
1958 })
1959 .override_establish_connection(move |credentials, cx| {
1960 assert_eq!(credentials.user_id, user_id.0 as u64);
1961 assert_eq!(credentials.access_token, "the-token");
1962
1963 let server = server.clone();
1964 let connection_killers = connection_killers.clone();
1965 let forbid_connections = forbid_connections.clone();
1966 let client_name = client_name.clone();
1967 cx.spawn(move |cx| async move {
1968 if forbid_connections.load(SeqCst) {
1969 Err(EstablishConnectionError::other(anyhow!(
1970 "server is forbidding connections"
1971 )))
1972 } else {
1973 let (client_conn, server_conn, kill_conn) = Connection::in_memory();
1974 connection_killers.lock().insert(user_id, kill_conn);
1975 cx.background()
1976 .spawn(server.handle_connection(server_conn, client_name, user_id))
1977 .detach();
1978 Ok(client_conn)
1979 }
1980 })
1981 });
1982
1983 let http = FakeHttpClient::new(|_| async move { Ok(surf::http::Response::new(404)) });
1984 client
1985 .authenticate_and_connect(&cx.to_async())
1986 .await
1987 .unwrap();
1988
1989 let user_store = UserStore::new(client.clone(), http, &cx.background());
1990 let mut authed_user = user_store.watch_current_user();
1991 while authed_user.recv().await.unwrap().is_none() {}
1992
1993 (client, user_store)
1994 }
1995
1996 fn disconnect_client(&self, user_id: UserId) {
1997 if let Some(mut kill_conn) = self.connection_killers.lock().remove(&user_id) {
1998 let _ = kill_conn.try_send(Some(()));
1999 }
2000 }
2001
2002 fn forbid_connections(&self) {
2003 self.forbid_connections.store(true, SeqCst);
2004 }
2005
2006 fn allow_connections(&self) {
2007 self.forbid_connections.store(false, SeqCst);
2008 }
2009
2010 async fn build_app_state(test_db: &TestDb) -> Arc<AppState> {
2011 let mut config = Config::default();
2012 config.session_secret = "a".repeat(32);
2013 config.database_url = test_db.url.clone();
2014 let github_client = github::AppClient::test();
2015 Arc::new(AppState {
2016 db: test_db.db().clone(),
2017 handlebars: Default::default(),
2018 auth_client: auth::build_client("", ""),
2019 repo_client: github::RepoClient::test(&github_client),
2020 github_client,
2021 config,
2022 })
2023 }
2024
2025 async fn state<'a>(&'a self) -> RwLockReadGuard<'a, ServerState> {
2026 self.server.state.read().await
2027 }
2028
2029 async fn condition<F>(&mut self, mut predicate: F)
2030 where
2031 F: FnMut(&ServerState) -> bool,
2032 {
2033 async_std::future::timeout(Duration::from_millis(500), async {
2034 while !(predicate)(&*self.server.state.read().await) {
2035 self.notifications.recv().await;
2036 }
2037 })
2038 .await
2039 .expect("condition timed out");
2040 }
2041 }
2042
2043 impl Drop for TestServer {
2044 fn drop(&mut self) {
2045 task::block_on(self.peer.reset());
2046 }
2047 }
2048
2049 fn current_user_id(user_store: &Arc<UserStore>) -> UserId {
2050 UserId::from_proto(user_store.current_user().unwrap().id)
2051 }
2052
2053 fn channel_messages(channel: &Channel) -> Vec<(String, String, bool)> {
2054 channel
2055 .messages()
2056 .cursor::<(), ()>()
2057 .map(|m| {
2058 (
2059 m.sender.github_login.clone(),
2060 m.body.clone(),
2061 m.is_pending(),
2062 )
2063 })
2064 .collect()
2065 }
2066
2067 struct EmptyView;
2068
2069 impl gpui::Entity for EmptyView {
2070 type Event = ();
2071 }
2072
2073 impl gpui::View for EmptyView {
2074 fn ui_name() -> &'static str {
2075 "empty view"
2076 }
2077
2078 fn render(&mut self, _: &mut gpui::RenderContext<Self>) -> gpui::ElementBox {
2079 gpui::Element::boxed(gpui::elements::Empty)
2080 }
2081 }
2082}