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