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