1#[cfg(any(test, feature = "test-support"))]
2pub mod test;
3
4pub mod telemetry;
5pub mod user;
6
7use anyhow::{anyhow, Context as _, Result};
8use async_recursion::async_recursion;
9use async_tungstenite::tungstenite::{
10 error::Error as WebsocketError,
11 http::{Request, StatusCode},
12};
13use futures::{
14 channel::oneshot, future::LocalBoxFuture, AsyncReadExt, FutureExt, SinkExt, StreamExt,
15 TryFutureExt as _, TryStreamExt,
16};
17use gpui::{
18 actions, AnyModel, AnyWeakModel, AppContext, AsyncAppContext, Model, SemanticVersion, Task,
19 WeakModel,
20};
21use lazy_static::lazy_static;
22use parking_lot::RwLock;
23use postage::watch;
24use rand::prelude::*;
25use rpc::proto::{AnyTypedEnvelope, EntityMessage, EnvelopedMessage, PeerId, RequestMessage};
26use schemars::JsonSchema;
27use serde::{Deserialize, Serialize};
28use serde_json;
29use settings::Settings;
30use std::{
31 any::TypeId,
32 collections::HashMap,
33 convert::TryFrom,
34 fmt::Write as _,
35 future::Future,
36 marker::PhantomData,
37 path::PathBuf,
38 sync::{atomic::AtomicU64, Arc, Weak},
39 time::{Duration, Instant},
40};
41use telemetry::Telemetry;
42use thiserror::Error;
43use url::Url;
44use util::channel::ReleaseChannel;
45use util::http::HttpClient;
46use util::{ResultExt, TryFutureExt};
47
48pub use rpc::*;
49pub use telemetry::Event;
50pub use user::*;
51
52lazy_static! {
53 pub static ref ZED_SERVER_URL: String =
54 std::env::var("ZED_SERVER_URL").unwrap_or_else(|_| "https://zed.dev".to_string());
55 pub static ref ZED_RPC_URL: Option<String> = std::env::var("ZED_RPC_URL").ok();
56 pub static ref IMPERSONATE_LOGIN: Option<String> = std::env::var("ZED_IMPERSONATE")
57 .ok()
58 .and_then(|s| if s.is_empty() { None } else { Some(s) });
59 pub static ref ADMIN_API_TOKEN: Option<String> = std::env::var("ZED_ADMIN_API_TOKEN")
60 .ok()
61 .and_then(|s| if s.is_empty() { None } else { Some(s) });
62 pub static ref ZED_APP_VERSION: Option<SemanticVersion> = std::env::var("ZED_APP_VERSION")
63 .ok()
64 .and_then(|v| v.parse().ok());
65 pub static ref ZED_APP_PATH: Option<PathBuf> =
66 std::env::var("ZED_APP_PATH").ok().map(PathBuf::from);
67 pub static ref ZED_ALWAYS_ACTIVE: bool =
68 std::env::var("ZED_ALWAYS_ACTIVE").map_or(false, |e| e.len() > 0);
69}
70
71pub const INITIAL_RECONNECTION_DELAY: Duration = Duration::from_millis(100);
72pub const CONNECTION_TIMEOUT: Duration = Duration::from_secs(5);
73
74actions!(client, [SignIn, SignOut, Reconnect]);
75
76pub fn init_settings(cx: &mut AppContext) {
77 TelemetrySettings::register(cx);
78}
79
80pub fn init(client: &Arc<Client>, cx: &mut AppContext) {
81 init_settings(cx);
82
83 let client = Arc::downgrade(client);
84 cx.on_action({
85 let client = client.clone();
86 move |_: &SignIn, cx| {
87 if let Some(client) = client.upgrade() {
88 cx.spawn(
89 |cx| async move { client.authenticate_and_connect(true, &cx).log_err().await },
90 )
91 .detach();
92 }
93 }
94 });
95
96 cx.on_action({
97 let client = client.clone();
98 move |_: &SignOut, cx| {
99 if let Some(client) = client.upgrade() {
100 cx.spawn(|cx| async move {
101 client.disconnect(&cx);
102 })
103 .detach();
104 }
105 }
106 });
107
108 cx.on_action({
109 let client = client.clone();
110 move |_: &Reconnect, cx| {
111 if let Some(client) = client.upgrade() {
112 cx.spawn(|cx| async move {
113 client.reconnect(&cx);
114 })
115 .detach();
116 }
117 }
118 });
119}
120
121pub struct Client {
122 id: AtomicU64,
123 peer: Arc<Peer>,
124 http: Arc<dyn HttpClient>,
125 telemetry: Arc<Telemetry>,
126 state: RwLock<ClientState>,
127
128 #[allow(clippy::type_complexity)]
129 #[cfg(any(test, feature = "test-support"))]
130 authenticate: RwLock<
131 Option<Box<dyn 'static + Send + Sync + Fn(&AsyncAppContext) -> Task<Result<Credentials>>>>,
132 >,
133
134 #[allow(clippy::type_complexity)]
135 #[cfg(any(test, feature = "test-support"))]
136 establish_connection: RwLock<
137 Option<
138 Box<
139 dyn 'static
140 + Send
141 + Sync
142 + Fn(
143 &Credentials,
144 &AsyncAppContext,
145 ) -> Task<Result<Connection, EstablishConnectionError>>,
146 >,
147 >,
148 >,
149}
150
151#[derive(Error, Debug)]
152pub enum EstablishConnectionError {
153 #[error("upgrade required")]
154 UpgradeRequired,
155 #[error("unauthorized")]
156 Unauthorized,
157 #[error("{0}")]
158 Other(#[from] anyhow::Error),
159 #[error("{0}")]
160 Http(#[from] util::http::Error),
161 #[error("{0}")]
162 Io(#[from] std::io::Error),
163 #[error("{0}")]
164 Websocket(#[from] async_tungstenite::tungstenite::http::Error),
165}
166
167impl From<WebsocketError> for EstablishConnectionError {
168 fn from(error: WebsocketError) -> Self {
169 if let WebsocketError::Http(response) = &error {
170 match response.status() {
171 StatusCode::UNAUTHORIZED => return EstablishConnectionError::Unauthorized,
172 StatusCode::UPGRADE_REQUIRED => return EstablishConnectionError::UpgradeRequired,
173 _ => {}
174 }
175 }
176 EstablishConnectionError::Other(error.into())
177 }
178}
179
180impl EstablishConnectionError {
181 pub fn other(error: impl Into<anyhow::Error> + Send + Sync) -> Self {
182 Self::Other(error.into())
183 }
184}
185
186#[derive(Copy, Clone, Debug, PartialEq)]
187pub enum Status {
188 SignedOut,
189 UpgradeRequired,
190 Authenticating,
191 Connecting,
192 ConnectionError,
193 Connected {
194 peer_id: PeerId,
195 connection_id: ConnectionId,
196 },
197 ConnectionLost,
198 Reauthenticating,
199 Reconnecting,
200 ReconnectionError {
201 next_reconnection: Instant,
202 },
203}
204
205impl Status {
206 pub fn is_connected(&self) -> bool {
207 matches!(self, Self::Connected { .. })
208 }
209
210 pub fn is_signed_out(&self) -> bool {
211 matches!(self, Self::SignedOut | Self::UpgradeRequired)
212 }
213}
214
215struct ClientState {
216 credentials: Option<Credentials>,
217 status: (watch::Sender<Status>, watch::Receiver<Status>),
218 entity_id_extractors: HashMap<TypeId, fn(&dyn AnyTypedEnvelope) -> u64>,
219 _reconnect_task: Option<Task<()>>,
220 reconnect_interval: Duration,
221 entities_by_type_and_remote_id: HashMap<(TypeId, u64), WeakSubscriber>,
222 models_by_message_type: HashMap<TypeId, AnyWeakModel>,
223 entity_types_by_message_type: HashMap<TypeId, TypeId>,
224 #[allow(clippy::type_complexity)]
225 message_handlers: HashMap<
226 TypeId,
227 Arc<
228 dyn Send
229 + Sync
230 + Fn(
231 AnyModel,
232 Box<dyn AnyTypedEnvelope>,
233 &Arc<Client>,
234 AsyncAppContext,
235 ) -> LocalBoxFuture<'static, Result<()>>,
236 >,
237 >,
238}
239
240enum WeakSubscriber {
241 Entity { handle: AnyWeakModel },
242 Pending(Vec<Box<dyn AnyTypedEnvelope>>),
243}
244
245#[derive(Clone, Debug)]
246pub struct Credentials {
247 pub user_id: u64,
248 pub access_token: String,
249}
250
251impl Default for ClientState {
252 fn default() -> Self {
253 Self {
254 credentials: None,
255 status: watch::channel_with(Status::SignedOut),
256 entity_id_extractors: Default::default(),
257 _reconnect_task: None,
258 reconnect_interval: Duration::from_secs(5),
259 models_by_message_type: Default::default(),
260 entities_by_type_and_remote_id: Default::default(),
261 entity_types_by_message_type: Default::default(),
262 message_handlers: Default::default(),
263 }
264 }
265}
266
267pub enum Subscription {
268 Entity {
269 client: Weak<Client>,
270 id: (TypeId, u64),
271 },
272 Message {
273 client: Weak<Client>,
274 id: TypeId,
275 },
276}
277
278impl Drop for Subscription {
279 fn drop(&mut self) {
280 match self {
281 Subscription::Entity { client, id } => {
282 if let Some(client) = client.upgrade() {
283 let mut state = client.state.write();
284 let _ = state.entities_by_type_and_remote_id.remove(id);
285 }
286 }
287 Subscription::Message { client, id } => {
288 if let Some(client) = client.upgrade() {
289 let mut state = client.state.write();
290 let _ = state.entity_types_by_message_type.remove(id);
291 let _ = state.message_handlers.remove(id);
292 }
293 }
294 }
295 }
296}
297
298pub struct PendingEntitySubscription<T: 'static> {
299 client: Arc<Client>,
300 remote_id: u64,
301 _entity_type: PhantomData<T>,
302 consumed: bool,
303}
304
305impl<T: 'static> PendingEntitySubscription<T> {
306 pub fn set_model(mut self, model: &Model<T>, cx: &mut AsyncAppContext) -> Subscription {
307 self.consumed = true;
308 let mut state = self.client.state.write();
309 let id = (TypeId::of::<T>(), self.remote_id);
310 let Some(WeakSubscriber::Pending(messages)) =
311 state.entities_by_type_and_remote_id.remove(&id)
312 else {
313 unreachable!()
314 };
315
316 state.entities_by_type_and_remote_id.insert(
317 id,
318 WeakSubscriber::Entity {
319 handle: model.downgrade().into(),
320 },
321 );
322 drop(state);
323 for message in messages {
324 self.client.handle_message(message, cx);
325 }
326 Subscription::Entity {
327 client: Arc::downgrade(&self.client),
328 id,
329 }
330 }
331}
332
333impl<T: 'static> Drop for PendingEntitySubscription<T> {
334 fn drop(&mut self) {
335 if !self.consumed {
336 let mut state = self.client.state.write();
337 if let Some(WeakSubscriber::Pending(messages)) = state
338 .entities_by_type_and_remote_id
339 .remove(&(TypeId::of::<T>(), self.remote_id))
340 {
341 for message in messages {
342 log::info!("unhandled message {}", message.payload_type_name());
343 }
344 }
345 }
346 }
347}
348
349#[derive(Copy, Clone)]
350pub struct TelemetrySettings {
351 pub diagnostics: bool,
352 pub metrics: bool,
353}
354
355/// Control what info is collected by Zed.
356#[derive(Default, Clone, Serialize, Deserialize, JsonSchema)]
357pub struct TelemetrySettingsContent {
358 /// Send debug info like crash reports.
359 ///
360 /// Default: true
361 pub diagnostics: Option<bool>,
362 /// Send anonymized usage data like what languages you're using Zed with.
363 ///
364 /// Default: true
365 pub metrics: Option<bool>,
366}
367
368impl settings::Settings for TelemetrySettings {
369 const KEY: Option<&'static str> = Some("telemetry");
370
371 type FileContent = TelemetrySettingsContent;
372
373 fn load(
374 default_value: &Self::FileContent,
375 user_values: &[&Self::FileContent],
376 _: &mut AppContext,
377 ) -> Result<Self> {
378 Ok(Self {
379 diagnostics: user_values.first().and_then(|v| v.diagnostics).unwrap_or(
380 default_value
381 .diagnostics
382 .ok_or_else(Self::missing_default)?,
383 ),
384 metrics: user_values
385 .first()
386 .and_then(|v| v.metrics)
387 .unwrap_or(default_value.metrics.ok_or_else(Self::missing_default)?),
388 })
389 }
390}
391
392impl Client {
393 pub fn new(http: Arc<dyn HttpClient>, cx: &mut AppContext) -> Arc<Self> {
394 Arc::new(Self {
395 id: AtomicU64::new(0),
396 peer: Peer::new(0),
397 telemetry: Telemetry::new(http.clone(), cx),
398 http,
399 state: Default::default(),
400
401 #[cfg(any(test, feature = "test-support"))]
402 authenticate: Default::default(),
403 #[cfg(any(test, feature = "test-support"))]
404 establish_connection: Default::default(),
405 })
406 }
407
408 pub fn id(&self) -> u64 {
409 self.id.load(std::sync::atomic::Ordering::SeqCst)
410 }
411
412 pub fn http_client(&self) -> Arc<dyn HttpClient> {
413 self.http.clone()
414 }
415
416 pub fn set_id(&self, id: u64) -> &Self {
417 self.id.store(id, std::sync::atomic::Ordering::SeqCst);
418 self
419 }
420
421 #[cfg(any(test, feature = "test-support"))]
422 pub fn teardown(&self) {
423 let mut state = self.state.write();
424 state._reconnect_task.take();
425 state.message_handlers.clear();
426 state.models_by_message_type.clear();
427 state.entities_by_type_and_remote_id.clear();
428 state.entity_id_extractors.clear();
429 self.peer.teardown();
430 }
431
432 #[cfg(any(test, feature = "test-support"))]
433 pub fn override_authenticate<F>(&self, authenticate: F) -> &Self
434 where
435 F: 'static + Send + Sync + Fn(&AsyncAppContext) -> Task<Result<Credentials>>,
436 {
437 *self.authenticate.write() = Some(Box::new(authenticate));
438 self
439 }
440
441 #[cfg(any(test, feature = "test-support"))]
442 pub fn override_establish_connection<F>(&self, connect: F) -> &Self
443 where
444 F: 'static
445 + Send
446 + Sync
447 + Fn(&Credentials, &AsyncAppContext) -> Task<Result<Connection, EstablishConnectionError>>,
448 {
449 *self.establish_connection.write() = Some(Box::new(connect));
450 self
451 }
452
453 pub fn user_id(&self) -> Option<u64> {
454 self.state
455 .read()
456 .credentials
457 .as_ref()
458 .map(|credentials| credentials.user_id)
459 }
460
461 pub fn peer_id(&self) -> Option<PeerId> {
462 if let Status::Connected { peer_id, .. } = &*self.status().borrow() {
463 Some(*peer_id)
464 } else {
465 None
466 }
467 }
468
469 pub fn status(&self) -> watch::Receiver<Status> {
470 self.state.read().status.1.clone()
471 }
472
473 fn set_status(self: &Arc<Self>, status: Status, cx: &AsyncAppContext) {
474 log::info!("set status on client {}: {:?}", self.id(), status);
475 let mut state = self.state.write();
476 *state.status.0.borrow_mut() = status;
477
478 match status {
479 Status::Connected { .. } => {
480 state._reconnect_task = None;
481 }
482 Status::ConnectionLost => {
483 let this = self.clone();
484 let reconnect_interval = state.reconnect_interval;
485 state._reconnect_task = Some(cx.spawn(move |cx| async move {
486 #[cfg(any(test, feature = "test-support"))]
487 let mut rng = StdRng::seed_from_u64(0);
488 #[cfg(not(any(test, feature = "test-support")))]
489 let mut rng = StdRng::from_entropy();
490
491 let mut delay = INITIAL_RECONNECTION_DELAY;
492 while let Err(error) = this.authenticate_and_connect(true, &cx).await {
493 log::error!("failed to connect {}", error);
494 if matches!(*this.status().borrow(), Status::ConnectionError) {
495 this.set_status(
496 Status::ReconnectionError {
497 next_reconnection: Instant::now() + delay,
498 },
499 &cx,
500 );
501 cx.background_executor().timer(delay).await;
502 delay = delay
503 .mul_f32(rng.gen_range(1.0..=2.0))
504 .min(reconnect_interval);
505 } else {
506 break;
507 }
508 }
509 }));
510 }
511 Status::SignedOut | Status::UpgradeRequired => {
512 self.telemetry.set_authenticated_user_info(None, false);
513 state._reconnect_task.take();
514 }
515 _ => {}
516 }
517 }
518
519 pub fn subscribe_to_entity<T>(
520 self: &Arc<Self>,
521 remote_id: u64,
522 ) -> Result<PendingEntitySubscription<T>>
523 where
524 T: 'static,
525 {
526 let id = (TypeId::of::<T>(), remote_id);
527
528 let mut state = self.state.write();
529 if state.entities_by_type_and_remote_id.contains_key(&id) {
530 return Err(anyhow!("already subscribed to entity"));
531 } else {
532 state
533 .entities_by_type_and_remote_id
534 .insert(id, WeakSubscriber::Pending(Default::default()));
535 Ok(PendingEntitySubscription {
536 client: self.clone(),
537 remote_id,
538 consumed: false,
539 _entity_type: PhantomData,
540 })
541 }
542 }
543
544 #[track_caller]
545 pub fn add_message_handler<M, E, H, F>(
546 self: &Arc<Self>,
547 entity: WeakModel<E>,
548 handler: H,
549 ) -> Subscription
550 where
551 M: EnvelopedMessage,
552 E: 'static,
553 H: 'static
554 + Sync
555 + Fn(Model<E>, TypedEnvelope<M>, Arc<Self>, AsyncAppContext) -> F
556 + Send
557 + Sync,
558 F: 'static + Future<Output = Result<()>>,
559 {
560 let message_type_id = TypeId::of::<M>();
561 let mut state = self.state.write();
562 state
563 .models_by_message_type
564 .insert(message_type_id, entity.into());
565
566 let prev_handler = state.message_handlers.insert(
567 message_type_id,
568 Arc::new(move |subscriber, envelope, client, cx| {
569 let subscriber = subscriber.downcast::<E>().unwrap();
570 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
571 handler(subscriber, *envelope, client.clone(), cx).boxed_local()
572 }),
573 );
574 if prev_handler.is_some() {
575 let location = std::panic::Location::caller();
576 panic!(
577 "{}:{} registered handler for the same message {} twice",
578 location.file(),
579 location.line(),
580 std::any::type_name::<M>()
581 );
582 }
583
584 Subscription::Message {
585 client: Arc::downgrade(self),
586 id: message_type_id,
587 }
588 }
589
590 pub fn add_request_handler<M, E, H, F>(
591 self: &Arc<Self>,
592 model: WeakModel<E>,
593 handler: H,
594 ) -> Subscription
595 where
596 M: RequestMessage,
597 E: 'static,
598 H: 'static
599 + Sync
600 + Fn(Model<E>, TypedEnvelope<M>, Arc<Self>, AsyncAppContext) -> F
601 + Send
602 + Sync,
603 F: 'static + Future<Output = Result<M::Response>>,
604 {
605 self.add_message_handler(model, move |handle, envelope, this, cx| {
606 Self::respond_to_request(
607 envelope.receipt(),
608 handler(handle, envelope, this.clone(), cx),
609 this,
610 )
611 })
612 }
613
614 pub fn add_model_message_handler<M, E, H, F>(self: &Arc<Self>, handler: H)
615 where
616 M: EntityMessage,
617 E: 'static,
618 H: 'static + Fn(Model<E>, TypedEnvelope<M>, Arc<Self>, AsyncAppContext) -> F + Send + Sync,
619 F: 'static + Future<Output = Result<()>>,
620 {
621 self.add_entity_message_handler::<M, E, _, _>(move |subscriber, message, client, cx| {
622 handler(subscriber.downcast::<E>().unwrap(), message, client, cx)
623 })
624 }
625
626 fn add_entity_message_handler<M, E, H, F>(self: &Arc<Self>, handler: H)
627 where
628 M: EntityMessage,
629 E: 'static,
630 H: 'static + Fn(AnyModel, TypedEnvelope<M>, Arc<Self>, AsyncAppContext) -> F + Send + Sync,
631 F: 'static + Future<Output = Result<()>>,
632 {
633 let model_type_id = TypeId::of::<E>();
634 let message_type_id = TypeId::of::<M>();
635
636 let mut state = self.state.write();
637 state
638 .entity_types_by_message_type
639 .insert(message_type_id, model_type_id);
640 state
641 .entity_id_extractors
642 .entry(message_type_id)
643 .or_insert_with(|| {
644 |envelope| {
645 envelope
646 .as_any()
647 .downcast_ref::<TypedEnvelope<M>>()
648 .unwrap()
649 .payload
650 .remote_entity_id()
651 }
652 });
653 let prev_handler = state.message_handlers.insert(
654 message_type_id,
655 Arc::new(move |handle, envelope, client, cx| {
656 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
657 handler(handle, *envelope, client.clone(), cx).boxed_local()
658 }),
659 );
660 if prev_handler.is_some() {
661 panic!("registered handler for the same message twice");
662 }
663 }
664
665 pub fn add_model_request_handler<M, E, H, F>(self: &Arc<Self>, handler: H)
666 where
667 M: EntityMessage + RequestMessage,
668 E: 'static,
669 H: 'static + Fn(Model<E>, TypedEnvelope<M>, Arc<Self>, AsyncAppContext) -> F + Send + Sync,
670 F: 'static + Future<Output = Result<M::Response>>,
671 {
672 self.add_model_message_handler(move |entity, envelope, client, cx| {
673 Self::respond_to_request::<M, _>(
674 envelope.receipt(),
675 handler(entity, envelope, client.clone(), cx),
676 client,
677 )
678 })
679 }
680
681 async fn respond_to_request<T: RequestMessage, F: Future<Output = Result<T::Response>>>(
682 receipt: Receipt<T>,
683 response: F,
684 client: Arc<Self>,
685 ) -> Result<()> {
686 match response.await {
687 Ok(response) => {
688 client.respond(receipt, response)?;
689 Ok(())
690 }
691 Err(error) => {
692 client.respond_with_error(
693 receipt,
694 proto::Error {
695 message: format!("{:?}", error),
696 },
697 )?;
698 Err(error)
699 }
700 }
701 }
702
703 pub fn has_keychain_credentials(&self, cx: &AsyncAppContext) -> bool {
704 read_credentials_from_keychain(cx).is_some()
705 }
706
707 #[async_recursion(?Send)]
708 pub async fn authenticate_and_connect(
709 self: &Arc<Self>,
710 try_keychain: bool,
711 cx: &AsyncAppContext,
712 ) -> anyhow::Result<()> {
713 let was_disconnected = match *self.status().borrow() {
714 Status::SignedOut => true,
715 Status::ConnectionError
716 | Status::ConnectionLost
717 | Status::Authenticating { .. }
718 | Status::Reauthenticating { .. }
719 | Status::ReconnectionError { .. } => false,
720 Status::Connected { .. } | Status::Connecting { .. } | Status::Reconnecting { .. } => {
721 return Ok(())
722 }
723 Status::UpgradeRequired => return Err(EstablishConnectionError::UpgradeRequired)?,
724 };
725
726 if was_disconnected {
727 self.set_status(Status::Authenticating, cx);
728 } else {
729 self.set_status(Status::Reauthenticating, cx)
730 }
731
732 let mut read_from_keychain = false;
733 let mut credentials = self.state.read().credentials.clone();
734 if credentials.is_none() && try_keychain {
735 credentials = read_credentials_from_keychain(cx);
736 read_from_keychain = credentials.is_some();
737 }
738 if credentials.is_none() {
739 let mut status_rx = self.status();
740 let _ = status_rx.next().await;
741 futures::select_biased! {
742 authenticate = self.authenticate(cx).fuse() => {
743 match authenticate {
744 Ok(creds) => credentials = Some(creds),
745 Err(err) => {
746 self.set_status(Status::ConnectionError, cx);
747 return Err(err);
748 }
749 }
750 }
751 _ = status_rx.next().fuse() => {
752 return Err(anyhow!("authentication canceled"));
753 }
754 }
755 }
756 let credentials = credentials.unwrap();
757 self.set_id(credentials.user_id);
758
759 if was_disconnected {
760 self.set_status(Status::Connecting, cx);
761 } else {
762 self.set_status(Status::Reconnecting, cx);
763 }
764
765 let mut timeout =
766 futures::FutureExt::fuse(cx.background_executor().timer(CONNECTION_TIMEOUT));
767 futures::select_biased! {
768 connection = self.establish_connection(&credentials, cx).fuse() => {
769 match connection {
770 Ok(conn) => {
771 self.state.write().credentials = Some(credentials.clone());
772 if !read_from_keychain && IMPERSONATE_LOGIN.is_none() {
773 write_credentials_to_keychain(credentials, cx).log_err();
774 }
775
776 futures::select_biased! {
777 result = self.set_connection(conn, cx).fuse() => result,
778 _ = timeout => {
779 self.set_status(Status::ConnectionError, cx);
780 Err(anyhow!("timed out waiting on hello message from server"))
781 }
782 }
783 }
784 Err(EstablishConnectionError::Unauthorized) => {
785 self.state.write().credentials.take();
786 if read_from_keychain {
787 delete_credentials_from_keychain(cx).log_err();
788 self.set_status(Status::SignedOut, cx);
789 self.authenticate_and_connect(false, cx).await
790 } else {
791 self.set_status(Status::ConnectionError, cx);
792 Err(EstablishConnectionError::Unauthorized)?
793 }
794 }
795 Err(EstablishConnectionError::UpgradeRequired) => {
796 self.set_status(Status::UpgradeRequired, cx);
797 Err(EstablishConnectionError::UpgradeRequired)?
798 }
799 Err(error) => {
800 self.set_status(Status::ConnectionError, cx);
801 Err(error)?
802 }
803 }
804 }
805 _ = &mut timeout => {
806 self.set_status(Status::ConnectionError, cx);
807 Err(anyhow!("timed out trying to establish connection"))
808 }
809 }
810 }
811
812 async fn set_connection(
813 self: &Arc<Self>,
814 conn: Connection,
815 cx: &AsyncAppContext,
816 ) -> Result<()> {
817 let executor = cx.background_executor();
818 log::info!("add connection to peer");
819 let (connection_id, handle_io, mut incoming) = self.peer.add_connection(conn, {
820 let executor = executor.clone();
821 move |duration| executor.timer(duration)
822 });
823 let handle_io = executor.spawn(handle_io);
824
825 let peer_id = async {
826 log::info!("waiting for server hello");
827 let message = incoming
828 .next()
829 .await
830 .ok_or_else(|| anyhow!("no hello message received"))?;
831 log::info!("got server hello");
832 let hello_message_type_name = message.payload_type_name().to_string();
833 let hello = message
834 .into_any()
835 .downcast::<TypedEnvelope<proto::Hello>>()
836 .map_err(|_| {
837 anyhow!(
838 "invalid hello message received: {:?}",
839 hello_message_type_name
840 )
841 })?;
842 let peer_id = hello
843 .payload
844 .peer_id
845 .ok_or_else(|| anyhow!("invalid peer id"))?;
846 Ok(peer_id)
847 };
848
849 let peer_id = match peer_id.await {
850 Ok(peer_id) => peer_id,
851 Err(error) => {
852 self.peer.disconnect(connection_id);
853 return Err(error);
854 }
855 };
856
857 log::info!(
858 "set status to connected (connection id: {:?}, peer id: {:?})",
859 connection_id,
860 peer_id
861 );
862 self.set_status(
863 Status::Connected {
864 peer_id,
865 connection_id,
866 },
867 cx,
868 );
869
870 cx.spawn({
871 let this = self.clone();
872 |cx| {
873 async move {
874 while let Some(message) = incoming.next().await {
875 this.handle_message(message, &cx);
876 // Don't starve the main thread when receiving lots of messages at once.
877 smol::future::yield_now().await;
878 }
879 }
880 }
881 })
882 .detach();
883
884 cx.spawn({
885 let this = self.clone();
886 move |cx| async move {
887 match handle_io.await {
888 Ok(()) => {
889 if this.status().borrow().clone()
890 == (Status::Connected {
891 connection_id,
892 peer_id,
893 })
894 {
895 this.set_status(Status::SignedOut, &cx);
896 }
897 }
898 Err(err) => {
899 log::error!("connection error: {:?}", err);
900 this.set_status(Status::ConnectionLost, &cx);
901 }
902 }
903 }
904 })
905 .detach();
906
907 Ok(())
908 }
909
910 fn authenticate(self: &Arc<Self>, cx: &AsyncAppContext) -> Task<Result<Credentials>> {
911 #[cfg(any(test, feature = "test-support"))]
912 if let Some(callback) = self.authenticate.read().as_ref() {
913 return callback(cx);
914 }
915
916 self.authenticate_with_browser(cx)
917 }
918
919 fn establish_connection(
920 self: &Arc<Self>,
921 credentials: &Credentials,
922 cx: &AsyncAppContext,
923 ) -> Task<Result<Connection, EstablishConnectionError>> {
924 #[cfg(any(test, feature = "test-support"))]
925 if let Some(callback) = self.establish_connection.read().as_ref() {
926 return callback(credentials, cx);
927 }
928
929 self.establish_websocket_connection(credentials, cx)
930 }
931
932 async fn get_rpc_url(
933 http: Arc<dyn HttpClient>,
934 release_channel: Option<ReleaseChannel>,
935 ) -> Result<Url> {
936 if let Some(url) = &*ZED_RPC_URL {
937 return Url::parse(url).context("invalid rpc url");
938 }
939
940 let mut url = format!("{}/rpc", *ZED_SERVER_URL);
941 if let Some(preview_param) =
942 release_channel.and_then(|channel| channel.release_query_param())
943 {
944 url += "?";
945 url += preview_param;
946 }
947 let response = http.get(&url, Default::default(), false).await?;
948 let collab_url = if response.status().is_redirection() {
949 response
950 .headers()
951 .get("Location")
952 .ok_or_else(|| anyhow!("missing location header in /rpc response"))?
953 .to_str()
954 .map_err(EstablishConnectionError::other)?
955 .to_string()
956 } else {
957 Err(anyhow!(
958 "unexpected /rpc response status {}",
959 response.status()
960 ))?
961 };
962
963 Url::parse(&collab_url).context("invalid rpc url")
964 }
965
966 fn establish_websocket_connection(
967 self: &Arc<Self>,
968 credentials: &Credentials,
969 cx: &AsyncAppContext,
970 ) -> Task<Result<Connection, EstablishConnectionError>> {
971 let release_channel = cx.try_read_global(|channel: &ReleaseChannel, _| *channel);
972
973 let request = Request::builder()
974 .header(
975 "Authorization",
976 format!("{} {}", credentials.user_id, credentials.access_token),
977 )
978 .header("x-zed-protocol-version", rpc::PROTOCOL_VERSION);
979
980 let http = self.http.clone();
981 cx.background_executor().spawn(async move {
982 let mut rpc_url = Self::get_rpc_url(http, release_channel).await?;
983 let rpc_host = rpc_url
984 .host_str()
985 .zip(rpc_url.port_or_known_default())
986 .ok_or_else(|| anyhow!("missing host in rpc url"))?;
987 let stream = smol::net::TcpStream::connect(rpc_host).await?;
988
989 log::info!("connected to rpc endpoint {}", rpc_url);
990
991 match rpc_url.scheme() {
992 "https" => {
993 rpc_url.set_scheme("wss").unwrap();
994 let request = request.uri(rpc_url.as_str()).body(())?;
995 let (stream, _) =
996 async_tungstenite::async_tls::client_async_tls(request, stream).await?;
997 Ok(Connection::new(
998 stream
999 .map_err(|error| anyhow!(error))
1000 .sink_map_err(|error| anyhow!(error)),
1001 ))
1002 }
1003 "http" => {
1004 rpc_url.set_scheme("ws").unwrap();
1005 let request = request.uri(rpc_url.as_str()).body(())?;
1006 let (stream, _) = async_tungstenite::client_async(request, stream).await?;
1007 Ok(Connection::new(
1008 stream
1009 .map_err(|error| anyhow!(error))
1010 .sink_map_err(|error| anyhow!(error)),
1011 ))
1012 }
1013 _ => Err(anyhow!("invalid rpc url: {}", rpc_url))?,
1014 }
1015 })
1016 }
1017
1018 pub fn authenticate_with_browser(
1019 self: &Arc<Self>,
1020 cx: &AsyncAppContext,
1021 ) -> Task<Result<Credentials>> {
1022 let http = self.http.clone();
1023 cx.spawn(|cx| async move {
1024 let background = cx.background_executor().clone();
1025
1026 let (open_url_tx, open_url_rx) = oneshot::channel::<String>();
1027 cx.update(|cx| {
1028 cx.spawn(move |cx| async move {
1029 let url = open_url_rx.await?;
1030 cx.update(|cx| cx.open_url(&url))
1031 })
1032 .detach_and_log_err(cx);
1033 })
1034 .log_err();
1035
1036 let credentials = background
1037 .clone()
1038 .spawn(async move {
1039 // Generate a pair of asymmetric encryption keys. The public key will be used by the
1040 // zed server to encrypt the user's access token, so that it can'be intercepted by
1041 // any other app running on the user's device.
1042 let (public_key, private_key) =
1043 rpc::auth::keypair().expect("failed to generate keypair for auth");
1044 let public_key_string = String::try_from(public_key)
1045 .expect("failed to serialize public key for auth");
1046
1047 if let Some((login, token)) =
1048 IMPERSONATE_LOGIN.as_ref().zip(ADMIN_API_TOKEN.as_ref())
1049 {
1050 return Self::authenticate_as_admin(http, login.clone(), token.clone())
1051 .await;
1052 }
1053
1054 // Start an HTTP server to receive the redirect from Zed's sign-in page.
1055 let server =
1056 tiny_http::Server::http("127.0.0.1:0").expect("failed to find open port");
1057 let port = server.server_addr().port();
1058
1059 // Open the Zed sign-in page in the user's browser, with query parameters that indicate
1060 // that the user is signing in from a Zed app running on the same device.
1061 let mut url = format!(
1062 "{}/native_app_signin?native_app_port={}&native_app_public_key={}",
1063 *ZED_SERVER_URL, port, public_key_string
1064 );
1065
1066 if let Some(impersonate_login) = IMPERSONATE_LOGIN.as_ref() {
1067 log::info!("impersonating user @{}", impersonate_login);
1068 write!(&mut url, "&impersonate={}", impersonate_login).unwrap();
1069 }
1070
1071 open_url_tx.send(url).log_err();
1072
1073 // Receive the HTTP request from the user's browser. Retrieve the user id and encrypted
1074 // access token from the query params.
1075 //
1076 // TODO - Avoid ever starting more than one HTTP server. Maybe switch to using a
1077 // custom URL scheme instead of this local HTTP server.
1078 let (user_id, access_token) = background
1079 .spawn(async move {
1080 for _ in 0..100 {
1081 if let Some(req) = server.recv_timeout(Duration::from_secs(1))? {
1082 let path = req.url();
1083 let mut user_id = None;
1084 let mut access_token = None;
1085 let url = Url::parse(&format!("http://example.com{}", path))
1086 .context("failed to parse login notification url")?;
1087 for (key, value) in url.query_pairs() {
1088 if key == "access_token" {
1089 access_token = Some(value.to_string());
1090 } else if key == "user_id" {
1091 user_id = Some(value.to_string());
1092 }
1093 }
1094
1095 let post_auth_url =
1096 format!("{}/native_app_signin_succeeded", *ZED_SERVER_URL);
1097 req.respond(
1098 tiny_http::Response::empty(302).with_header(
1099 tiny_http::Header::from_bytes(
1100 &b"Location"[..],
1101 post_auth_url.as_bytes(),
1102 )
1103 .unwrap(),
1104 ),
1105 )
1106 .context("failed to respond to login http request")?;
1107 return Ok((
1108 user_id
1109 .ok_or_else(|| anyhow!("missing user_id parameter"))?,
1110 access_token.ok_or_else(|| {
1111 anyhow!("missing access_token parameter")
1112 })?,
1113 ));
1114 }
1115 }
1116
1117 Err(anyhow!("didn't receive login redirect"))
1118 })
1119 .await?;
1120
1121 let access_token = private_key
1122 .decrypt_string(&access_token)
1123 .context("failed to decrypt access token")?;
1124
1125 Ok(Credentials {
1126 user_id: user_id.parse()?,
1127 access_token,
1128 })
1129 })
1130 .await?;
1131
1132 cx.update(|cx| cx.activate(true))?;
1133 Ok(credentials)
1134 })
1135 }
1136
1137 async fn authenticate_as_admin(
1138 http: Arc<dyn HttpClient>,
1139 login: String,
1140 mut api_token: String,
1141 ) -> Result<Credentials> {
1142 #[derive(Deserialize)]
1143 struct AuthenticatedUserResponse {
1144 user: User,
1145 }
1146
1147 #[derive(Deserialize)]
1148 struct User {
1149 id: u64,
1150 }
1151
1152 // Use the collab server's admin API to retrieve the id
1153 // of the impersonated user.
1154 let mut url = Self::get_rpc_url(http.clone(), None).await?;
1155 url.set_path("/user");
1156 url.set_query(Some(&format!("github_login={login}")));
1157 let request = Request::get(url.as_str())
1158 .header("Authorization", format!("token {api_token}"))
1159 .body("".into())?;
1160
1161 let mut response = http.send(request).await?;
1162 let mut body = String::new();
1163 response.body_mut().read_to_string(&mut body).await?;
1164 if !response.status().is_success() {
1165 Err(anyhow!(
1166 "admin user request failed {} - {}",
1167 response.status().as_u16(),
1168 body,
1169 ))?;
1170 }
1171 let response: AuthenticatedUserResponse = serde_json::from_str(&body)?;
1172
1173 // Use the admin API token to authenticate as the impersonated user.
1174 api_token.insert_str(0, "ADMIN_TOKEN:");
1175 Ok(Credentials {
1176 user_id: response.user.id,
1177 access_token: api_token,
1178 })
1179 }
1180
1181 pub fn disconnect(self: &Arc<Self>, cx: &AsyncAppContext) {
1182 self.peer.teardown();
1183 self.set_status(Status::SignedOut, cx);
1184 }
1185
1186 pub fn reconnect(self: &Arc<Self>, cx: &AsyncAppContext) {
1187 self.peer.teardown();
1188 self.set_status(Status::ConnectionLost, cx);
1189 }
1190
1191 fn connection_id(&self) -> Result<ConnectionId> {
1192 if let Status::Connected { connection_id, .. } = *self.status().borrow() {
1193 Ok(connection_id)
1194 } else {
1195 Err(anyhow!("not connected"))
1196 }
1197 }
1198
1199 pub fn send<T: EnvelopedMessage>(&self, message: T) -> Result<()> {
1200 log::debug!("rpc send. client_id:{}, name:{}", self.id(), T::NAME);
1201 self.peer.send(self.connection_id()?, message)
1202 }
1203
1204 pub fn request<T: RequestMessage>(
1205 &self,
1206 request: T,
1207 ) -> impl Future<Output = Result<T::Response>> {
1208 self.request_envelope(request)
1209 .map_ok(|envelope| envelope.payload)
1210 }
1211
1212 pub fn request_envelope<T: RequestMessage>(
1213 &self,
1214 request: T,
1215 ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> {
1216 let client_id = self.id();
1217 log::debug!(
1218 "rpc request start. client_id:{}. name:{}",
1219 client_id,
1220 T::NAME
1221 );
1222 let response = self
1223 .connection_id()
1224 .map(|conn_id| self.peer.request_envelope(conn_id, request));
1225 async move {
1226 let response = response?.await;
1227 log::debug!(
1228 "rpc request finish. client_id:{}. name:{}",
1229 client_id,
1230 T::NAME
1231 );
1232 response
1233 }
1234 }
1235
1236 fn respond<T: RequestMessage>(&self, receipt: Receipt<T>, response: T::Response) -> Result<()> {
1237 log::debug!("rpc respond. client_id:{}. name:{}", self.id(), T::NAME);
1238 self.peer.respond(receipt, response)
1239 }
1240
1241 fn respond_with_error<T: RequestMessage>(
1242 &self,
1243 receipt: Receipt<T>,
1244 error: proto::Error,
1245 ) -> Result<()> {
1246 log::debug!("rpc respond. client_id:{}. name:{}", self.id(), T::NAME);
1247 self.peer.respond_with_error(receipt, error)
1248 }
1249
1250 fn handle_message(
1251 self: &Arc<Client>,
1252 message: Box<dyn AnyTypedEnvelope>,
1253 cx: &AsyncAppContext,
1254 ) {
1255 let mut state = self.state.write();
1256 let type_name = message.payload_type_name();
1257 let payload_type_id = message.payload_type_id();
1258 let sender_id = message.original_sender_id();
1259
1260 let mut subscriber = None;
1261
1262 if let Some(handle) = state
1263 .models_by_message_type
1264 .get(&payload_type_id)
1265 .and_then(|handle| handle.upgrade())
1266 {
1267 subscriber = Some(handle);
1268 } else if let Some((extract_entity_id, entity_type_id)) =
1269 state.entity_id_extractors.get(&payload_type_id).zip(
1270 state
1271 .entity_types_by_message_type
1272 .get(&payload_type_id)
1273 .copied(),
1274 )
1275 {
1276 let entity_id = (extract_entity_id)(message.as_ref());
1277
1278 match state
1279 .entities_by_type_and_remote_id
1280 .get_mut(&(entity_type_id, entity_id))
1281 {
1282 Some(WeakSubscriber::Pending(pending)) => {
1283 pending.push(message);
1284 return;
1285 }
1286 Some(weak_subscriber @ _) => match weak_subscriber {
1287 WeakSubscriber::Entity { handle } => {
1288 subscriber = handle.upgrade();
1289 }
1290
1291 WeakSubscriber::Pending(_) => {}
1292 },
1293 _ => {}
1294 }
1295 }
1296
1297 let subscriber = if let Some(subscriber) = subscriber {
1298 subscriber
1299 } else {
1300 log::info!("unhandled message {}", type_name);
1301 self.peer.respond_with_unhandled_message(message).log_err();
1302 return;
1303 };
1304
1305 let handler = state.message_handlers.get(&payload_type_id).cloned();
1306 // Dropping the state prevents deadlocks if the handler interacts with rpc::Client.
1307 // It also ensures we don't hold the lock while yielding back to the executor, as
1308 // that might cause the executor thread driving this future to block indefinitely.
1309 drop(state);
1310
1311 if let Some(handler) = handler {
1312 let future = handler(subscriber, message, self, cx.clone());
1313 let client_id = self.id();
1314 log::debug!(
1315 "rpc message received. client_id:{}, sender_id:{:?}, type:{}",
1316 client_id,
1317 sender_id,
1318 type_name
1319 );
1320 cx.spawn(move |_| async move {
1321 match future.await {
1322 Ok(()) => {
1323 log::debug!(
1324 "rpc message handled. client_id:{}, sender_id:{:?}, type:{}",
1325 client_id,
1326 sender_id,
1327 type_name
1328 );
1329 }
1330 Err(error) => {
1331 log::error!(
1332 "error handling message. client_id:{}, sender_id:{:?}, type:{}, error:{:?}",
1333 client_id,
1334 sender_id,
1335 type_name,
1336 error
1337 );
1338 }
1339 }
1340 })
1341 .detach();
1342 } else {
1343 log::info!("unhandled message {}", type_name);
1344 self.peer.respond_with_unhandled_message(message).log_err();
1345 }
1346 }
1347
1348 pub fn telemetry(&self) -> &Arc<Telemetry> {
1349 &self.telemetry
1350 }
1351}
1352
1353fn read_credentials_from_keychain(cx: &AsyncAppContext) -> Option<Credentials> {
1354 if IMPERSONATE_LOGIN.is_some() {
1355 return None;
1356 }
1357
1358 let (user_id, access_token) = cx
1359 .update(|cx| cx.read_credentials(&ZED_SERVER_URL).log_err().flatten())
1360 .ok()??;
1361
1362 Some(Credentials {
1363 user_id: user_id.parse().ok()?,
1364 access_token: String::from_utf8(access_token).ok()?,
1365 })
1366}
1367
1368fn write_credentials_to_keychain(credentials: Credentials, cx: &AsyncAppContext) -> Result<()> {
1369 cx.update(move |cx| {
1370 cx.write_credentials(
1371 &ZED_SERVER_URL,
1372 &credentials.user_id.to_string(),
1373 credentials.access_token.as_bytes(),
1374 )
1375 })?
1376}
1377
1378fn delete_credentials_from_keychain(cx: &AsyncAppContext) -> Result<()> {
1379 cx.update(move |cx| cx.delete_credentials(&ZED_SERVER_URL))?
1380}
1381
1382const WORKTREE_URL_PREFIX: &str = "zed://worktrees/";
1383
1384pub fn encode_worktree_url(id: u64, access_token: &str) -> String {
1385 format!("{}{}/{}", WORKTREE_URL_PREFIX, id, access_token)
1386}
1387
1388pub fn decode_worktree_url(url: &str) -> Option<(u64, String)> {
1389 let path = url.trim().strip_prefix(WORKTREE_URL_PREFIX)?;
1390 let mut parts = path.split('/');
1391 let id = parts.next()?.parse::<u64>().ok()?;
1392 let access_token = parts.next()?;
1393 if access_token.is_empty() {
1394 return None;
1395 }
1396 Some((id, access_token.to_string()))
1397}
1398
1399#[cfg(test)]
1400mod tests {
1401 use super::*;
1402 use crate::test::FakeServer;
1403
1404 use gpui::{BackgroundExecutor, Context, TestAppContext};
1405 use parking_lot::Mutex;
1406 use settings::SettingsStore;
1407 use std::future;
1408 use util::http::FakeHttpClient;
1409
1410 #[gpui::test(iterations = 10)]
1411 async fn test_reconnection(cx: &mut TestAppContext) {
1412 init_test(cx);
1413 let user_id = 5;
1414 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1415 let server = FakeServer::for_client(user_id, &client, cx).await;
1416 let mut status = client.status();
1417 assert!(matches!(
1418 status.next().await,
1419 Some(Status::Connected { .. })
1420 ));
1421 assert_eq!(server.auth_count(), 1);
1422
1423 server.forbid_connections();
1424 server.disconnect();
1425 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1426
1427 server.allow_connections();
1428 cx.executor().advance_clock(Duration::from_secs(10));
1429 while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1430 assert_eq!(server.auth_count(), 1); // Client reused the cached credentials when reconnecting
1431
1432 server.forbid_connections();
1433 server.disconnect();
1434 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1435
1436 // Clear cached credentials after authentication fails
1437 server.roll_access_token();
1438 server.allow_connections();
1439 cx.executor().run_until_parked();
1440 cx.executor().advance_clock(Duration::from_secs(10));
1441 while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1442 assert_eq!(server.auth_count(), 2); // Client re-authenticated due to an invalid token
1443 }
1444
1445 #[gpui::test(iterations = 10)]
1446 async fn test_connection_timeout(executor: BackgroundExecutor, cx: &mut TestAppContext) {
1447 init_test(cx);
1448 let user_id = 5;
1449 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1450 let mut status = client.status();
1451
1452 // Time out when client tries to connect.
1453 client.override_authenticate(move |cx| {
1454 cx.background_executor().spawn(async move {
1455 Ok(Credentials {
1456 user_id,
1457 access_token: "token".into(),
1458 })
1459 })
1460 });
1461 client.override_establish_connection(|_, cx| {
1462 cx.background_executor().spawn(async move {
1463 future::pending::<()>().await;
1464 unreachable!()
1465 })
1466 });
1467 let auth_and_connect = cx.spawn({
1468 let client = client.clone();
1469 |cx| async move { client.authenticate_and_connect(false, &cx).await }
1470 });
1471 executor.run_until_parked();
1472 assert!(matches!(status.next().await, Some(Status::Connecting)));
1473
1474 executor.advance_clock(CONNECTION_TIMEOUT);
1475 assert!(matches!(
1476 status.next().await,
1477 Some(Status::ConnectionError { .. })
1478 ));
1479 auth_and_connect.await.unwrap_err();
1480
1481 // Allow the connection to be established.
1482 let server = FakeServer::for_client(user_id, &client, cx).await;
1483 assert!(matches!(
1484 status.next().await,
1485 Some(Status::Connected { .. })
1486 ));
1487
1488 // Disconnect client.
1489 server.forbid_connections();
1490 server.disconnect();
1491 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1492
1493 // Time out when re-establishing the connection.
1494 server.allow_connections();
1495 client.override_establish_connection(|_, cx| {
1496 cx.background_executor().spawn(async move {
1497 future::pending::<()>().await;
1498 unreachable!()
1499 })
1500 });
1501 executor.advance_clock(2 * INITIAL_RECONNECTION_DELAY);
1502 assert!(matches!(
1503 status.next().await,
1504 Some(Status::Reconnecting { .. })
1505 ));
1506
1507 executor.advance_clock(CONNECTION_TIMEOUT);
1508 assert!(matches!(
1509 status.next().await,
1510 Some(Status::ReconnectionError { .. })
1511 ));
1512 }
1513
1514 #[gpui::test(iterations = 10)]
1515 async fn test_authenticating_more_than_once(
1516 cx: &mut TestAppContext,
1517 executor: BackgroundExecutor,
1518 ) {
1519 init_test(cx);
1520 let auth_count = Arc::new(Mutex::new(0));
1521 let dropped_auth_count = Arc::new(Mutex::new(0));
1522 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1523 client.override_authenticate({
1524 let auth_count = auth_count.clone();
1525 let dropped_auth_count = dropped_auth_count.clone();
1526 move |cx| {
1527 let auth_count = auth_count.clone();
1528 let dropped_auth_count = dropped_auth_count.clone();
1529 cx.background_executor().spawn(async move {
1530 *auth_count.lock() += 1;
1531 let _drop = util::defer(move || *dropped_auth_count.lock() += 1);
1532 future::pending::<()>().await;
1533 unreachable!()
1534 })
1535 }
1536 });
1537
1538 let _authenticate = cx.spawn({
1539 let client = client.clone();
1540 move |cx| async move { client.authenticate_and_connect(false, &cx).await }
1541 });
1542 executor.run_until_parked();
1543 assert_eq!(*auth_count.lock(), 1);
1544 assert_eq!(*dropped_auth_count.lock(), 0);
1545
1546 let _authenticate = cx.spawn({
1547 let client = client.clone();
1548 |cx| async move { client.authenticate_and_connect(false, &cx).await }
1549 });
1550 executor.run_until_parked();
1551 assert_eq!(*auth_count.lock(), 2);
1552 assert_eq!(*dropped_auth_count.lock(), 1);
1553 }
1554
1555 #[test]
1556 fn test_encode_and_decode_worktree_url() {
1557 let url = encode_worktree_url(5, "deadbeef");
1558 assert_eq!(decode_worktree_url(&url), Some((5, "deadbeef".to_string())));
1559 assert_eq!(
1560 decode_worktree_url(&format!("\n {}\t", url)),
1561 Some((5, "deadbeef".to_string()))
1562 );
1563 assert_eq!(decode_worktree_url("not://the-right-format"), None);
1564 }
1565
1566 #[gpui::test]
1567 async fn test_subscribing_to_entity(cx: &mut TestAppContext) {
1568 init_test(cx);
1569 let user_id = 5;
1570 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1571 let server = FakeServer::for_client(user_id, &client, cx).await;
1572
1573 let (done_tx1, mut done_rx1) = smol::channel::unbounded();
1574 let (done_tx2, mut done_rx2) = smol::channel::unbounded();
1575 client.add_model_message_handler(
1576 move |model: Model<TestModel>, _: TypedEnvelope<proto::JoinProject>, _, mut cx| {
1577 match model.update(&mut cx, |model, _| model.id).unwrap() {
1578 1 => done_tx1.try_send(()).unwrap(),
1579 2 => done_tx2.try_send(()).unwrap(),
1580 _ => unreachable!(),
1581 }
1582 async { Ok(()) }
1583 },
1584 );
1585 let model1 = cx.new_model(|_| TestModel {
1586 id: 1,
1587 subscription: None,
1588 });
1589 let model2 = cx.new_model(|_| TestModel {
1590 id: 2,
1591 subscription: None,
1592 });
1593 let model3 = cx.new_model(|_| TestModel {
1594 id: 3,
1595 subscription: None,
1596 });
1597
1598 let _subscription1 = client
1599 .subscribe_to_entity(1)
1600 .unwrap()
1601 .set_model(&model1, &mut cx.to_async());
1602 let _subscription2 = client
1603 .subscribe_to_entity(2)
1604 .unwrap()
1605 .set_model(&model2, &mut cx.to_async());
1606 // Ensure dropping a subscription for the same entity type still allows receiving of
1607 // messages for other entity IDs of the same type.
1608 let subscription3 = client
1609 .subscribe_to_entity(3)
1610 .unwrap()
1611 .set_model(&model3, &mut cx.to_async());
1612 drop(subscription3);
1613
1614 server.send(proto::JoinProject { project_id: 1 });
1615 server.send(proto::JoinProject { project_id: 2 });
1616 done_rx1.next().await.unwrap();
1617 done_rx2.next().await.unwrap();
1618 }
1619
1620 #[gpui::test]
1621 async fn test_subscribing_after_dropping_subscription(cx: &mut TestAppContext) {
1622 init_test(cx);
1623 let user_id = 5;
1624 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1625 let server = FakeServer::for_client(user_id, &client, cx).await;
1626
1627 let model = cx.new_model(|_| TestModel::default());
1628 let (done_tx1, _done_rx1) = smol::channel::unbounded();
1629 let (done_tx2, mut done_rx2) = smol::channel::unbounded();
1630 let subscription1 = client.add_message_handler(
1631 model.downgrade(),
1632 move |_, _: TypedEnvelope<proto::Ping>, _, _| {
1633 done_tx1.try_send(()).unwrap();
1634 async { Ok(()) }
1635 },
1636 );
1637 drop(subscription1);
1638 let _subscription2 = client.add_message_handler(
1639 model.downgrade(),
1640 move |_, _: TypedEnvelope<proto::Ping>, _, _| {
1641 done_tx2.try_send(()).unwrap();
1642 async { Ok(()) }
1643 },
1644 );
1645 server.send(proto::Ping {});
1646 done_rx2.next().await.unwrap();
1647 }
1648
1649 #[gpui::test]
1650 async fn test_dropping_subscription_in_handler(cx: &mut TestAppContext) {
1651 init_test(cx);
1652 let user_id = 5;
1653 let client = cx.update(|cx| Client::new(FakeHttpClient::with_404_response(), cx));
1654 let server = FakeServer::for_client(user_id, &client, cx).await;
1655
1656 let model = cx.new_model(|_| TestModel::default());
1657 let (done_tx, mut done_rx) = smol::channel::unbounded();
1658 let subscription = client.add_message_handler(
1659 model.clone().downgrade(),
1660 move |model: Model<TestModel>, _: TypedEnvelope<proto::Ping>, _, mut cx| {
1661 model
1662 .update(&mut cx, |model, _| model.subscription.take())
1663 .unwrap();
1664 done_tx.try_send(()).unwrap();
1665 async { Ok(()) }
1666 },
1667 );
1668 model.update(cx, |model, _| {
1669 model.subscription = Some(subscription);
1670 });
1671 server.send(proto::Ping {});
1672 done_rx.next().await.unwrap();
1673 }
1674
1675 #[derive(Default)]
1676 struct TestModel {
1677 id: usize,
1678 subscription: Option<Subscription>,
1679 }
1680
1681 fn init_test(cx: &mut TestAppContext) {
1682 cx.update(|cx| {
1683 let settings_store = SettingsStore::test(cx);
1684 cx.set_global(settings_store);
1685 });
1686 }
1687}