1#[cfg(any(test, feature = "test-support"))]
2pub mod test;
3
4mod proxy;
5pub mod telemetry;
6pub mod user;
7pub mod zed_urls;
8
9use anyhow::{Context as _, Result, anyhow};
10use async_tungstenite::tungstenite::{
11 client::IntoClientRequest,
12 error::Error as WebsocketError,
13 http::{HeaderValue, Request, StatusCode},
14};
15use clock::SystemClock;
16use cloud_api_client::CloudApiClient;
17use cloud_api_client::websocket_protocol::MessageToClient;
18use credentials_provider::CredentialsProvider;
19use feature_flags::FeatureFlagAppExt as _;
20use futures::{
21 AsyncReadExt, FutureExt, SinkExt, Stream, StreamExt, TryFutureExt as _, TryStreamExt,
22 channel::oneshot, future::BoxFuture,
23};
24use gpui::{App, AsyncApp, Entity, Global, Task, WeakEntity, actions};
25use http_client::{HttpClient, HttpClientWithUrl, http};
26use parking_lot::RwLock;
27use postage::watch;
28use proxy::connect_proxy_stream;
29use rand::prelude::*;
30use release_channel::{AppVersion, ReleaseChannel};
31use rpc::proto::{AnyTypedEnvelope, EnvelopedMessage, PeerId, RequestMessage};
32use schemars::JsonSchema;
33use serde::{Deserialize, Serialize};
34use settings::{Settings, SettingsSources};
35use std::{
36 any::TypeId,
37 convert::TryFrom,
38 fmt::Write as _,
39 future::Future,
40 marker::PhantomData,
41 path::PathBuf,
42 sync::{
43 Arc, LazyLock, Weak,
44 atomic::{AtomicU64, Ordering},
45 },
46 time::{Duration, Instant},
47};
48use std::{cmp, pin::Pin};
49use telemetry::Telemetry;
50use thiserror::Error;
51use tokio::net::TcpStream;
52use url::Url;
53use util::{ConnectionResult, ResultExt};
54
55pub use rpc::*;
56pub use telemetry_events::Event;
57pub use user::*;
58
59static ZED_SERVER_URL: LazyLock<Option<String>> =
60 LazyLock::new(|| std::env::var("ZED_SERVER_URL").ok());
61static ZED_RPC_URL: LazyLock<Option<String>> = LazyLock::new(|| std::env::var("ZED_RPC_URL").ok());
62
63pub static IMPERSONATE_LOGIN: LazyLock<Option<String>> = LazyLock::new(|| {
64 std::env::var("ZED_IMPERSONATE")
65 .ok()
66 .and_then(|s| if s.is_empty() { None } else { Some(s) })
67});
68
69pub static ADMIN_API_TOKEN: LazyLock<Option<String>> = LazyLock::new(|| {
70 std::env::var("ZED_ADMIN_API_TOKEN")
71 .ok()
72 .and_then(|s| if s.is_empty() { None } else { Some(s) })
73});
74
75pub static ZED_APP_PATH: LazyLock<Option<PathBuf>> =
76 LazyLock::new(|| std::env::var("ZED_APP_PATH").ok().map(PathBuf::from));
77
78pub static ZED_ALWAYS_ACTIVE: LazyLock<bool> =
79 LazyLock::new(|| std::env::var("ZED_ALWAYS_ACTIVE").map_or(false, |e| !e.is_empty()));
80
81pub const INITIAL_RECONNECTION_DELAY: Duration = Duration::from_millis(500);
82pub const MAX_RECONNECTION_DELAY: Duration = Duration::from_secs(30);
83pub const CONNECTION_TIMEOUT: Duration = Duration::from_secs(20);
84
85actions!(
86 client,
87 [
88 /// Signs in to Zed account.
89 SignIn,
90 /// Signs out of Zed account.
91 SignOut,
92 /// Reconnects to the collaboration server.
93 Reconnect
94 ]
95);
96
97#[derive(Clone, Default, Serialize, Deserialize, JsonSchema)]
98pub struct ClientSettingsContent {
99 server_url: Option<String>,
100}
101
102#[derive(Deserialize)]
103pub struct ClientSettings {
104 pub server_url: String,
105}
106
107impl Settings for ClientSettings {
108 const KEY: Option<&'static str> = None;
109
110 type FileContent = ClientSettingsContent;
111
112 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
113 let mut result = sources.json_merge::<Self>()?;
114 if let Some(server_url) = &*ZED_SERVER_URL {
115 result.server_url.clone_from(server_url)
116 }
117 Ok(result)
118 }
119
120 fn import_from_vscode(_vscode: &settings::VsCodeSettings, _current: &mut Self::FileContent) {}
121}
122
123#[derive(Default, Clone, Serialize, Deserialize, JsonSchema)]
124pub struct ProxySettingsContent {
125 proxy: Option<String>,
126}
127
128#[derive(Deserialize, Default)]
129pub struct ProxySettings {
130 pub proxy: Option<String>,
131}
132
133impl Settings for ProxySettings {
134 const KEY: Option<&'static str> = None;
135
136 type FileContent = ProxySettingsContent;
137
138 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
139 Ok(Self {
140 proxy: sources
141 .user
142 .or(sources.server)
143 .and_then(|value| value.proxy.clone())
144 .or(sources.default.proxy.clone()),
145 })
146 }
147
148 fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
149 vscode.string_setting("http.proxy", &mut current.proxy);
150 }
151}
152
153pub fn init_settings(cx: &mut App) {
154 TelemetrySettings::register(cx);
155 ClientSettings::register(cx);
156 ProxySettings::register(cx);
157}
158
159pub fn init(client: &Arc<Client>, cx: &mut App) {
160 let client = Arc::downgrade(client);
161 cx.on_action({
162 let client = client.clone();
163 move |_: &SignIn, cx| {
164 if let Some(client) = client.upgrade() {
165 cx.spawn(async move |cx| client.sign_in_with_optional_connect(true, cx).await)
166 .detach_and_log_err(cx);
167 }
168 }
169 });
170
171 cx.on_action({
172 let client = client.clone();
173 move |_: &SignOut, cx| {
174 if let Some(client) = client.upgrade() {
175 cx.spawn(async move |cx| {
176 client.sign_out(cx).await;
177 })
178 .detach();
179 }
180 }
181 });
182
183 cx.on_action({
184 let client = client.clone();
185 move |_: &Reconnect, cx| {
186 if let Some(client) = client.upgrade() {
187 cx.spawn(async move |cx| {
188 client.reconnect(cx);
189 })
190 .detach();
191 }
192 }
193 });
194}
195
196pub type MessageToClientHandler = Box<dyn Fn(&MessageToClient, &mut App) + Send + Sync + 'static>;
197
198struct GlobalClient(Arc<Client>);
199
200impl Global for GlobalClient {}
201
202pub struct Client {
203 id: AtomicU64,
204 peer: Arc<Peer>,
205 http: Arc<HttpClientWithUrl>,
206 cloud_client: Arc<CloudApiClient>,
207 telemetry: Arc<Telemetry>,
208 credentials_provider: ClientCredentialsProvider,
209 state: RwLock<ClientState>,
210 handler_set: parking_lot::Mutex<ProtoMessageHandlerSet>,
211 message_to_client_handlers: parking_lot::Mutex<Vec<MessageToClientHandler>>,
212
213 #[allow(clippy::type_complexity)]
214 #[cfg(any(test, feature = "test-support"))]
215 authenticate:
216 RwLock<Option<Box<dyn 'static + Send + Sync + Fn(&AsyncApp) -> Task<Result<Credentials>>>>>,
217
218 #[allow(clippy::type_complexity)]
219 #[cfg(any(test, feature = "test-support"))]
220 establish_connection: RwLock<
221 Option<
222 Box<
223 dyn 'static
224 + Send
225 + Sync
226 + Fn(
227 &Credentials,
228 &AsyncApp,
229 ) -> Task<Result<Connection, EstablishConnectionError>>,
230 >,
231 >,
232 >,
233
234 #[cfg(any(test, feature = "test-support"))]
235 rpc_url: RwLock<Option<Url>>,
236}
237
238#[derive(Error, Debug)]
239pub enum EstablishConnectionError {
240 #[error("upgrade required")]
241 UpgradeRequired,
242 #[error("unauthorized")]
243 Unauthorized,
244 #[error("{0}")]
245 Other(#[from] anyhow::Error),
246 #[error("{0}")]
247 InvalidHeaderValue(#[from] async_tungstenite::tungstenite::http::header::InvalidHeaderValue),
248 #[error("{0}")]
249 Io(#[from] std::io::Error),
250 #[error("{0}")]
251 Websocket(#[from] async_tungstenite::tungstenite::http::Error),
252}
253
254impl From<WebsocketError> for EstablishConnectionError {
255 fn from(error: WebsocketError) -> Self {
256 if let WebsocketError::Http(response) = &error {
257 match response.status() {
258 StatusCode::UNAUTHORIZED => return EstablishConnectionError::Unauthorized,
259 StatusCode::UPGRADE_REQUIRED => return EstablishConnectionError::UpgradeRequired,
260 _ => {}
261 }
262 }
263 EstablishConnectionError::Other(error.into())
264 }
265}
266
267impl EstablishConnectionError {
268 pub fn other(error: impl Into<anyhow::Error> + Send + Sync) -> Self {
269 Self::Other(error.into())
270 }
271}
272
273#[derive(Copy, Clone, Debug, PartialEq)]
274pub enum Status {
275 SignedOut,
276 UpgradeRequired,
277 Authenticating,
278 Authenticated,
279 AuthenticationError,
280 Connecting,
281 ConnectionError,
282 Connected {
283 peer_id: PeerId,
284 connection_id: ConnectionId,
285 },
286 ConnectionLost,
287 Reauthenticating,
288 Reconnecting,
289 ReconnectionError {
290 next_reconnection: Instant,
291 },
292}
293
294impl Status {
295 pub fn is_connected(&self) -> bool {
296 matches!(self, Self::Connected { .. })
297 }
298
299 pub fn is_signing_in(&self) -> bool {
300 matches!(
301 self,
302 Self::Authenticating | Self::Reauthenticating | Self::Connecting | Self::Reconnecting
303 )
304 }
305
306 pub fn is_signed_out(&self) -> bool {
307 matches!(self, Self::SignedOut | Self::UpgradeRequired)
308 }
309}
310
311struct ClientState {
312 credentials: Option<Credentials>,
313 status: (watch::Sender<Status>, watch::Receiver<Status>),
314 _reconnect_task: Option<Task<()>>,
315}
316
317#[derive(Clone, Debug, Eq, PartialEq)]
318pub struct Credentials {
319 pub user_id: u64,
320 pub access_token: String,
321}
322
323impl Credentials {
324 pub fn authorization_header(&self) -> String {
325 format!("{} {}", self.user_id, self.access_token)
326 }
327}
328
329pub struct ClientCredentialsProvider {
330 provider: Arc<dyn CredentialsProvider>,
331}
332
333impl ClientCredentialsProvider {
334 pub fn new(cx: &App) -> Self {
335 Self {
336 provider: <dyn CredentialsProvider>::global(cx),
337 }
338 }
339
340 fn server_url(&self, cx: &AsyncApp) -> Result<String> {
341 cx.update(|cx| ClientSettings::get_global(cx).server_url.clone())
342 }
343
344 /// Reads the credentials from the provider.
345 fn read_credentials<'a>(
346 &'a self,
347 cx: &'a AsyncApp,
348 ) -> Pin<Box<dyn Future<Output = Option<Credentials>> + 'a>> {
349 async move {
350 if IMPERSONATE_LOGIN.is_some() {
351 return None;
352 }
353
354 let server_url = self.server_url(cx).ok()?;
355 let (user_id, access_token) = self
356 .provider
357 .read_credentials(&server_url, cx)
358 .await
359 .log_err()
360 .flatten()?;
361
362 Some(Credentials {
363 user_id: user_id.parse().ok()?,
364 access_token: String::from_utf8(access_token).ok()?,
365 })
366 }
367 .boxed_local()
368 }
369
370 /// Writes the credentials to the provider.
371 fn write_credentials<'a>(
372 &'a self,
373 user_id: u64,
374 access_token: String,
375 cx: &'a AsyncApp,
376 ) -> Pin<Box<dyn Future<Output = Result<()>> + 'a>> {
377 async move {
378 let server_url = self.server_url(cx)?;
379 self.provider
380 .write_credentials(
381 &server_url,
382 &user_id.to_string(),
383 access_token.as_bytes(),
384 cx,
385 )
386 .await
387 }
388 .boxed_local()
389 }
390
391 /// Deletes the credentials from the provider.
392 fn delete_credentials<'a>(
393 &'a self,
394 cx: &'a AsyncApp,
395 ) -> Pin<Box<dyn Future<Output = Result<()>> + 'a>> {
396 async move {
397 let server_url = self.server_url(cx)?;
398 self.provider.delete_credentials(&server_url, cx).await
399 }
400 .boxed_local()
401 }
402}
403
404impl Default for ClientState {
405 fn default() -> Self {
406 Self {
407 credentials: None,
408 status: watch::channel_with(Status::SignedOut),
409 _reconnect_task: None,
410 }
411 }
412}
413
414pub enum Subscription {
415 Entity {
416 client: Weak<Client>,
417 id: (TypeId, u64),
418 },
419 Message {
420 client: Weak<Client>,
421 id: TypeId,
422 },
423}
424
425impl Drop for Subscription {
426 fn drop(&mut self) {
427 match self {
428 Subscription::Entity { client, id } => {
429 if let Some(client) = client.upgrade() {
430 let mut state = client.handler_set.lock();
431 let _ = state.entities_by_type_and_remote_id.remove(id);
432 }
433 }
434 Subscription::Message { client, id } => {
435 if let Some(client) = client.upgrade() {
436 let mut state = client.handler_set.lock();
437 let _ = state.entity_types_by_message_type.remove(id);
438 let _ = state.message_handlers.remove(id);
439 }
440 }
441 }
442 }
443}
444
445pub struct PendingEntitySubscription<T: 'static> {
446 client: Arc<Client>,
447 remote_id: u64,
448 _entity_type: PhantomData<T>,
449 consumed: bool,
450}
451
452impl<T: 'static> PendingEntitySubscription<T> {
453 pub fn set_entity(mut self, entity: &Entity<T>, cx: &AsyncApp) -> Subscription {
454 self.consumed = true;
455 let mut handlers = self.client.handler_set.lock();
456 let id = (TypeId::of::<T>(), self.remote_id);
457 let Some(EntityMessageSubscriber::Pending(messages)) =
458 handlers.entities_by_type_and_remote_id.remove(&id)
459 else {
460 unreachable!()
461 };
462
463 handlers.entities_by_type_and_remote_id.insert(
464 id,
465 EntityMessageSubscriber::Entity {
466 handle: entity.downgrade().into(),
467 },
468 );
469 drop(handlers);
470 for message in messages {
471 let client_id = self.client.id();
472 let type_name = message.payload_type_name();
473 let sender_id = message.original_sender_id();
474 log::debug!(
475 "handling queued rpc message. client_id:{}, sender_id:{:?}, type:{}",
476 client_id,
477 sender_id,
478 type_name
479 );
480 self.client.handle_message(message, cx);
481 }
482 Subscription::Entity {
483 client: Arc::downgrade(&self.client),
484 id,
485 }
486 }
487}
488
489impl<T: 'static> Drop for PendingEntitySubscription<T> {
490 fn drop(&mut self) {
491 if !self.consumed {
492 let mut state = self.client.handler_set.lock();
493 if let Some(EntityMessageSubscriber::Pending(messages)) = state
494 .entities_by_type_and_remote_id
495 .remove(&(TypeId::of::<T>(), self.remote_id))
496 {
497 for message in messages {
498 log::info!("unhandled message {}", message.payload_type_name());
499 }
500 }
501 }
502 }
503}
504
505#[derive(Copy, Clone, Deserialize, Debug)]
506pub struct TelemetrySettings {
507 pub diagnostics: bool,
508 pub metrics: bool,
509}
510
511/// Control what info is collected by Zed.
512#[derive(Default, Clone, Serialize, Deserialize, JsonSchema, Debug)]
513pub struct TelemetrySettingsContent {
514 /// Send debug info like crash reports.
515 ///
516 /// Default: true
517 pub diagnostics: Option<bool>,
518 /// Send anonymized usage data like what languages you're using Zed with.
519 ///
520 /// Default: true
521 pub metrics: Option<bool>,
522}
523
524impl settings::Settings for TelemetrySettings {
525 const KEY: Option<&'static str> = Some("telemetry");
526
527 type FileContent = TelemetrySettingsContent;
528
529 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
530 sources.json_merge()
531 }
532
533 fn import_from_vscode(vscode: &settings::VsCodeSettings, current: &mut Self::FileContent) {
534 vscode.enum_setting("telemetry.telemetryLevel", &mut current.metrics, |s| {
535 Some(s == "all")
536 });
537 vscode.enum_setting("telemetry.telemetryLevel", &mut current.diagnostics, |s| {
538 Some(matches!(s, "all" | "error" | "crash"))
539 });
540 // we could translate telemetry.telemetryLevel, but just because users didn't want
541 // to send microsoft telemetry doesn't mean they don't want to send it to zed. their
542 // all/error/crash/off correspond to combinations of our "diagnostics" and "metrics".
543 }
544}
545
546impl Client {
547 pub fn new(
548 clock: Arc<dyn SystemClock>,
549 http: Arc<HttpClientWithUrl>,
550 cx: &mut App,
551 ) -> Arc<Self> {
552 Arc::new(Self {
553 id: AtomicU64::new(0),
554 peer: Peer::new(0),
555 telemetry: Telemetry::new(clock, http.clone(), cx),
556 cloud_client: Arc::new(CloudApiClient::new(http.clone())),
557 http,
558 credentials_provider: ClientCredentialsProvider::new(cx),
559 state: Default::default(),
560 handler_set: Default::default(),
561 message_to_client_handlers: parking_lot::Mutex::new(Vec::new()),
562
563 #[cfg(any(test, feature = "test-support"))]
564 authenticate: Default::default(),
565 #[cfg(any(test, feature = "test-support"))]
566 establish_connection: Default::default(),
567 #[cfg(any(test, feature = "test-support"))]
568 rpc_url: RwLock::default(),
569 })
570 }
571
572 pub fn production(cx: &mut App) -> Arc<Self> {
573 let clock = Arc::new(clock::RealSystemClock);
574 let http = Arc::new(HttpClientWithUrl::new_url(
575 cx.http_client(),
576 &ClientSettings::get_global(cx).server_url,
577 cx.http_client().proxy().cloned(),
578 ));
579 Self::new(clock, http, cx)
580 }
581
582 pub fn id(&self) -> u64 {
583 self.id.load(Ordering::SeqCst)
584 }
585
586 pub fn http_client(&self) -> Arc<HttpClientWithUrl> {
587 self.http.clone()
588 }
589
590 pub fn cloud_client(&self) -> Arc<CloudApiClient> {
591 self.cloud_client.clone()
592 }
593
594 pub fn set_id(&self, id: u64) -> &Self {
595 self.id.store(id, Ordering::SeqCst);
596 self
597 }
598
599 #[cfg(any(test, feature = "test-support"))]
600 pub fn teardown(&self) {
601 let mut state = self.state.write();
602 state._reconnect_task.take();
603 self.handler_set.lock().clear();
604 self.peer.teardown();
605 }
606
607 #[cfg(any(test, feature = "test-support"))]
608 pub fn override_authenticate<F>(&self, authenticate: F) -> &Self
609 where
610 F: 'static + Send + Sync + Fn(&AsyncApp) -> Task<Result<Credentials>>,
611 {
612 *self.authenticate.write() = Some(Box::new(authenticate));
613 self
614 }
615
616 #[cfg(any(test, feature = "test-support"))]
617 pub fn override_establish_connection<F>(&self, connect: F) -> &Self
618 where
619 F: 'static
620 + Send
621 + Sync
622 + Fn(&Credentials, &AsyncApp) -> Task<Result<Connection, EstablishConnectionError>>,
623 {
624 *self.establish_connection.write() = Some(Box::new(connect));
625 self
626 }
627
628 #[cfg(any(test, feature = "test-support"))]
629 pub fn override_rpc_url(&self, url: Url) -> &Self {
630 *self.rpc_url.write() = Some(url);
631 self
632 }
633
634 pub fn global(cx: &App) -> Arc<Self> {
635 cx.global::<GlobalClient>().0.clone()
636 }
637 pub fn set_global(client: Arc<Client>, cx: &mut App) {
638 cx.set_global(GlobalClient(client))
639 }
640
641 pub fn user_id(&self) -> Option<u64> {
642 self.state
643 .read()
644 .credentials
645 .as_ref()
646 .map(|credentials| credentials.user_id)
647 }
648
649 pub fn peer_id(&self) -> Option<PeerId> {
650 if let Status::Connected { peer_id, .. } = &*self.status().borrow() {
651 Some(*peer_id)
652 } else {
653 None
654 }
655 }
656
657 pub fn status(&self) -> watch::Receiver<Status> {
658 self.state.read().status.1.clone()
659 }
660
661 fn set_status(self: &Arc<Self>, status: Status, cx: &AsyncApp) {
662 log::info!("set status on client {}: {:?}", self.id(), status);
663 let mut state = self.state.write();
664 *state.status.0.borrow_mut() = status;
665
666 match status {
667 Status::Connected { .. } => {
668 state._reconnect_task = None;
669 }
670 Status::ConnectionLost => {
671 let client = self.clone();
672 state._reconnect_task = Some(cx.spawn(async move |cx| {
673 #[cfg(any(test, feature = "test-support"))]
674 let mut rng = StdRng::seed_from_u64(0);
675 #[cfg(not(any(test, feature = "test-support")))]
676 let mut rng = StdRng::from_entropy();
677
678 let mut delay = INITIAL_RECONNECTION_DELAY;
679 loop {
680 match client.connect(true, cx).await {
681 ConnectionResult::Timeout => {
682 log::error!("client connect attempt timed out")
683 }
684 ConnectionResult::ConnectionReset => {
685 log::error!("client connect attempt reset")
686 }
687 ConnectionResult::Result(r) => {
688 if let Err(error) = r {
689 log::error!("failed to connect: {error}");
690 } else {
691 break;
692 }
693 }
694 }
695
696 if matches!(
697 *client.status().borrow(),
698 Status::AuthenticationError | Status::ConnectionError
699 ) {
700 client.set_status(
701 Status::ReconnectionError {
702 next_reconnection: Instant::now() + delay,
703 },
704 cx,
705 );
706 let jitter =
707 Duration::from_millis(rng.gen_range(0..delay.as_millis() as u64));
708 cx.background_executor().timer(delay + jitter).await;
709 delay = cmp::min(delay * 2, MAX_RECONNECTION_DELAY);
710 } else {
711 break;
712 }
713 }
714 }));
715 }
716 Status::SignedOut | Status::UpgradeRequired => {
717 self.telemetry.set_authenticated_user_info(None, false);
718 state._reconnect_task.take();
719 }
720 _ => {}
721 }
722 }
723
724 pub fn subscribe_to_entity<T>(
725 self: &Arc<Self>,
726 remote_id: u64,
727 ) -> Result<PendingEntitySubscription<T>>
728 where
729 T: 'static,
730 {
731 let id = (TypeId::of::<T>(), remote_id);
732
733 let mut state = self.handler_set.lock();
734 anyhow::ensure!(
735 !state.entities_by_type_and_remote_id.contains_key(&id),
736 "already subscribed to entity"
737 );
738
739 state
740 .entities_by_type_and_remote_id
741 .insert(id, EntityMessageSubscriber::Pending(Default::default()));
742
743 Ok(PendingEntitySubscription {
744 client: self.clone(),
745 remote_id,
746 consumed: false,
747 _entity_type: PhantomData,
748 })
749 }
750
751 #[track_caller]
752 pub fn add_message_handler<M, E, H, F>(
753 self: &Arc<Self>,
754 entity: WeakEntity<E>,
755 handler: H,
756 ) -> Subscription
757 where
758 M: EnvelopedMessage,
759 E: 'static,
760 H: 'static + Sync + Fn(Entity<E>, TypedEnvelope<M>, AsyncApp) -> F + Send + Sync,
761 F: 'static + Future<Output = Result<()>>,
762 {
763 self.add_message_handler_impl(entity, move |entity, message, _, cx| {
764 handler(entity, message, cx)
765 })
766 }
767
768 fn add_message_handler_impl<M, E, H, F>(
769 self: &Arc<Self>,
770 entity: WeakEntity<E>,
771 handler: H,
772 ) -> Subscription
773 where
774 M: EnvelopedMessage,
775 E: 'static,
776 H: 'static
777 + Sync
778 + Fn(Entity<E>, TypedEnvelope<M>, AnyProtoClient, AsyncApp) -> F
779 + Send
780 + Sync,
781 F: 'static + Future<Output = Result<()>>,
782 {
783 let message_type_id = TypeId::of::<M>();
784 let mut state = self.handler_set.lock();
785 state
786 .entities_by_message_type
787 .insert(message_type_id, entity.into());
788
789 let prev_handler = state.message_handlers.insert(
790 message_type_id,
791 Arc::new(move |subscriber, envelope, client, cx| {
792 let subscriber = subscriber.downcast::<E>().unwrap();
793 let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
794 handler(subscriber, *envelope, client.clone(), cx).boxed_local()
795 }),
796 );
797 if prev_handler.is_some() {
798 let location = std::panic::Location::caller();
799 panic!(
800 "{}:{} registered handler for the same message {} twice",
801 location.file(),
802 location.line(),
803 std::any::type_name::<M>()
804 );
805 }
806
807 Subscription::Message {
808 client: Arc::downgrade(self),
809 id: message_type_id,
810 }
811 }
812
813 pub fn add_request_handler<M, E, H, F>(
814 self: &Arc<Self>,
815 entity: WeakEntity<E>,
816 handler: H,
817 ) -> Subscription
818 where
819 M: RequestMessage,
820 E: 'static,
821 H: 'static + Sync + Fn(Entity<E>, TypedEnvelope<M>, AsyncApp) -> F + Send + Sync,
822 F: 'static + Future<Output = Result<M::Response>>,
823 {
824 self.add_message_handler_impl(entity, move |handle, envelope, this, cx| {
825 Self::respond_to_request(envelope.receipt(), handler(handle, envelope, cx), this)
826 })
827 }
828
829 async fn respond_to_request<T: RequestMessage, F: Future<Output = Result<T::Response>>>(
830 receipt: Receipt<T>,
831 response: F,
832 client: AnyProtoClient,
833 ) -> Result<()> {
834 match response.await {
835 Ok(response) => {
836 client.send_response(receipt.message_id, response)?;
837 Ok(())
838 }
839 Err(error) => {
840 client.send_response(receipt.message_id, error.to_proto())?;
841 Err(error)
842 }
843 }
844 }
845
846 pub async fn has_credentials(&self, cx: &AsyncApp) -> bool {
847 self.credentials_provider
848 .read_credentials(cx)
849 .await
850 .is_some()
851 }
852
853 pub async fn sign_in(
854 self: &Arc<Self>,
855 try_provider: bool,
856 cx: &AsyncApp,
857 ) -> Result<Credentials> {
858 if self.status().borrow().is_signed_out() {
859 self.set_status(Status::Authenticating, cx);
860 } else {
861 self.set_status(Status::Reauthenticating, cx);
862 }
863
864 let mut credentials = None;
865
866 let old_credentials = self.state.read().credentials.clone();
867 if let Some(old_credentials) = old_credentials
868 && self.validate_credentials(&old_credentials, cx).await? {
869 credentials = Some(old_credentials);
870 }
871
872 if credentials.is_none() && try_provider
873 && let Some(stored_credentials) = self.credentials_provider.read_credentials(cx).await {
874 if self.validate_credentials(&stored_credentials, cx).await? {
875 credentials = Some(stored_credentials);
876 } else {
877 self.credentials_provider
878 .delete_credentials(cx)
879 .await
880 .log_err();
881 }
882 }
883
884 if credentials.is_none() {
885 let mut status_rx = self.status();
886 let _ = status_rx.next().await;
887 futures::select_biased! {
888 authenticate = self.authenticate(cx).fuse() => {
889 match authenticate {
890 Ok(creds) => {
891 if IMPERSONATE_LOGIN.is_none() {
892 self.credentials_provider
893 .write_credentials(creds.user_id, creds.access_token.clone(), cx)
894 .await
895 .log_err();
896 }
897
898 credentials = Some(creds);
899 },
900 Err(err) => {
901 self.set_status(Status::AuthenticationError, cx);
902 return Err(err);
903 }
904 }
905 }
906 _ = status_rx.next().fuse() => {
907 return Err(anyhow!("authentication canceled"));
908 }
909 }
910 }
911
912 let credentials = credentials.unwrap();
913 self.set_id(credentials.user_id);
914 self.cloud_client
915 .set_credentials(credentials.user_id as u32, credentials.access_token.clone());
916 self.state.write().credentials = Some(credentials.clone());
917 self.set_status(Status::Authenticated, cx);
918
919 Ok(credentials)
920 }
921
922 async fn validate_credentials(
923 self: &Arc<Self>,
924 credentials: &Credentials,
925 cx: &AsyncApp,
926 ) -> Result<bool> {
927 match self
928 .cloud_client
929 .validate_credentials(credentials.user_id as u32, &credentials.access_token)
930 .await
931 {
932 Ok(valid) => Ok(valid),
933 Err(err) => {
934 self.set_status(Status::AuthenticationError, cx);
935 Err(anyhow!("failed to validate credentials: {}", err))
936 }
937 }
938 }
939
940 /// Establishes a WebSocket connection with Cloud for receiving updates from the server.
941 async fn connect_to_cloud(self: &Arc<Self>, cx: &AsyncApp) -> Result<()> {
942 let connect_task = cx.update({
943 let cloud_client = self.cloud_client.clone();
944 move |cx| cloud_client.connect(cx)
945 })??;
946 let connection = connect_task.await?;
947
948 let (mut messages, task) = cx.update(|cx| connection.spawn(cx))?;
949 task.detach();
950
951 cx.spawn({
952 let this = self.clone();
953 async move |cx| {
954 while let Some(message) = messages.next().await {
955 if let Some(message) = message.log_err() {
956 this.handle_message_to_client(message, cx);
957 }
958 }
959 }
960 })
961 .detach();
962
963 Ok(())
964 }
965
966 /// Performs a sign-in and also (optionally) connects to Collab.
967 ///
968 /// Only Zed staff automatically connect to Collab.
969 pub async fn sign_in_with_optional_connect(
970 self: &Arc<Self>,
971 try_provider: bool,
972 cx: &AsyncApp,
973 ) -> Result<()> {
974 // Don't try to sign in again if we're already connected to Collab, as it will temporarily disconnect us.
975 if self.status().borrow().is_connected() {
976 return Ok(());
977 }
978
979 let (is_staff_tx, is_staff_rx) = oneshot::channel::<bool>();
980 let mut is_staff_tx = Some(is_staff_tx);
981 cx.update(|cx| {
982 cx.on_flags_ready(move |state, _cx| {
983 if let Some(is_staff_tx) = is_staff_tx.take() {
984 is_staff_tx.send(state.is_staff).log_err();
985 }
986 })
987 .detach();
988 })
989 .log_err();
990
991 let credentials = self.sign_in(try_provider, cx).await?;
992
993 self.connect_to_cloud(cx).await.log_err();
994
995 cx.update(move |cx| {
996 cx.spawn({
997 let client = self.clone();
998 async move |cx| {
999 let is_staff = is_staff_rx.await?;
1000 if is_staff {
1001 match client.connect_with_credentials(credentials, cx).await {
1002 ConnectionResult::Timeout => Err(anyhow!("connection timed out")),
1003 ConnectionResult::ConnectionReset => Err(anyhow!("connection reset")),
1004 ConnectionResult::Result(result) => {
1005 result.context("client auth and connect")
1006 }
1007 }
1008 } else {
1009 Ok(())
1010 }
1011 }
1012 })
1013 .detach_and_log_err(cx);
1014 })
1015 .log_err();
1016
1017 Ok(())
1018 }
1019
1020 pub async fn connect(
1021 self: &Arc<Self>,
1022 try_provider: bool,
1023 cx: &AsyncApp,
1024 ) -> ConnectionResult<()> {
1025 let was_disconnected = match *self.status().borrow() {
1026 Status::SignedOut | Status::Authenticated => true,
1027 Status::ConnectionError
1028 | Status::ConnectionLost
1029 | Status::Authenticating { .. }
1030 | Status::AuthenticationError
1031 | Status::Reauthenticating { .. }
1032 | Status::ReconnectionError { .. } => false,
1033 Status::Connected { .. } | Status::Connecting { .. } | Status::Reconnecting { .. } => {
1034 return ConnectionResult::Result(Ok(()));
1035 }
1036 Status::UpgradeRequired => {
1037 return ConnectionResult::Result(
1038 Err(EstablishConnectionError::UpgradeRequired)
1039 .context("client auth and connect"),
1040 );
1041 }
1042 };
1043 let credentials = match self.sign_in(try_provider, cx).await {
1044 Ok(credentials) => credentials,
1045 Err(err) => return ConnectionResult::Result(Err(err)),
1046 };
1047
1048 if was_disconnected {
1049 self.set_status(Status::Connecting, cx);
1050 } else {
1051 self.set_status(Status::Reconnecting, cx);
1052 }
1053
1054 self.connect_with_credentials(credentials, cx).await
1055 }
1056
1057 async fn connect_with_credentials(
1058 self: &Arc<Self>,
1059 credentials: Credentials,
1060 cx: &AsyncApp,
1061 ) -> ConnectionResult<()> {
1062 let mut timeout =
1063 futures::FutureExt::fuse(cx.background_executor().timer(CONNECTION_TIMEOUT));
1064 futures::select_biased! {
1065 connection = self.establish_connection(&credentials, cx).fuse() => {
1066 match connection {
1067 Ok(conn) => {
1068 futures::select_biased! {
1069 result = self.set_connection(conn, cx).fuse() => {
1070 match result.context("client auth and connect") {
1071 Ok(()) => ConnectionResult::Result(Ok(())),
1072 Err(err) => {
1073 self.set_status(Status::ConnectionError, cx);
1074 ConnectionResult::Result(Err(err))
1075 },
1076 }
1077 },
1078 _ = timeout => {
1079 self.set_status(Status::ConnectionError, cx);
1080 ConnectionResult::Timeout
1081 }
1082 }
1083 }
1084 Err(EstablishConnectionError::Unauthorized) => {
1085 self.set_status(Status::ConnectionError, cx);
1086 ConnectionResult::Result(Err(EstablishConnectionError::Unauthorized).context("client auth and connect"))
1087 }
1088 Err(EstablishConnectionError::UpgradeRequired) => {
1089 self.set_status(Status::UpgradeRequired, cx);
1090 ConnectionResult::Result(Err(EstablishConnectionError::UpgradeRequired).context("client auth and connect"))
1091 }
1092 Err(error) => {
1093 self.set_status(Status::ConnectionError, cx);
1094 ConnectionResult::Result(Err(error).context("client auth and connect"))
1095 }
1096 }
1097 }
1098 _ = &mut timeout => {
1099 self.set_status(Status::ConnectionError, cx);
1100 ConnectionResult::Timeout
1101 }
1102 }
1103 }
1104
1105 async fn set_connection(self: &Arc<Self>, conn: Connection, cx: &AsyncApp) -> Result<()> {
1106 let executor = cx.background_executor();
1107 log::debug!("add connection to peer");
1108 let (connection_id, handle_io, mut incoming) = self.peer.add_connection(conn, {
1109 let executor = executor.clone();
1110 move |duration| executor.timer(duration)
1111 });
1112 let handle_io = executor.spawn(handle_io);
1113
1114 let peer_id = async {
1115 log::debug!("waiting for server hello");
1116 let message = incoming.next().await.context("no hello message received")?;
1117 log::debug!("got server hello");
1118 let hello_message_type_name = message.payload_type_name().to_string();
1119 let hello = message
1120 .into_any()
1121 .downcast::<TypedEnvelope<proto::Hello>>()
1122 .map_err(|_| {
1123 anyhow!(
1124 "invalid hello message received: {:?}",
1125 hello_message_type_name
1126 )
1127 })?;
1128 let peer_id = hello.payload.peer_id.context("invalid peer id")?;
1129 Ok(peer_id)
1130 };
1131
1132 let peer_id = match peer_id.await {
1133 Ok(peer_id) => peer_id,
1134 Err(error) => {
1135 self.peer.disconnect(connection_id);
1136 return Err(error);
1137 }
1138 };
1139
1140 log::debug!(
1141 "set status to connected (connection id: {:?}, peer id: {:?})",
1142 connection_id,
1143 peer_id
1144 );
1145 self.set_status(
1146 Status::Connected {
1147 peer_id,
1148 connection_id,
1149 },
1150 cx,
1151 );
1152
1153 cx.spawn({
1154 let this = self.clone();
1155 async move |cx| {
1156 while let Some(message) = incoming.next().await {
1157 this.handle_message(message, cx);
1158 // Don't starve the main thread when receiving lots of messages at once.
1159 smol::future::yield_now().await;
1160 }
1161 }
1162 })
1163 .detach();
1164
1165 cx.spawn({
1166 let this = self.clone();
1167 async move |cx| match handle_io.await {
1168 Ok(()) => {
1169 if *this.status().borrow()
1170 == (Status::Connected {
1171 connection_id,
1172 peer_id,
1173 })
1174 {
1175 this.set_status(Status::SignedOut, cx);
1176 }
1177 }
1178 Err(err) => {
1179 log::error!("connection error: {:?}", err);
1180 this.set_status(Status::ConnectionLost, cx);
1181 }
1182 }
1183 })
1184 .detach();
1185
1186 Ok(())
1187 }
1188
1189 fn authenticate(self: &Arc<Self>, cx: &AsyncApp) -> Task<Result<Credentials>> {
1190 #[cfg(any(test, feature = "test-support"))]
1191 if let Some(callback) = self.authenticate.read().as_ref() {
1192 return callback(cx);
1193 }
1194
1195 self.authenticate_with_browser(cx)
1196 }
1197
1198 fn establish_connection(
1199 self: &Arc<Self>,
1200 credentials: &Credentials,
1201 cx: &AsyncApp,
1202 ) -> Task<Result<Connection, EstablishConnectionError>> {
1203 #[cfg(any(test, feature = "test-support"))]
1204 if let Some(callback) = self.establish_connection.read().as_ref() {
1205 return callback(credentials, cx);
1206 }
1207
1208 self.establish_websocket_connection(credentials, cx)
1209 }
1210
1211 fn rpc_url(
1212 &self,
1213 http: Arc<HttpClientWithUrl>,
1214 release_channel: Option<ReleaseChannel>,
1215 ) -> impl Future<Output = Result<url::Url>> + use<> {
1216 #[cfg(any(test, feature = "test-support"))]
1217 let url_override = self.rpc_url.read().clone();
1218
1219 async move {
1220 #[cfg(any(test, feature = "test-support"))]
1221 if let Some(url) = url_override {
1222 return Ok(url);
1223 }
1224
1225 if let Some(url) = &*ZED_RPC_URL {
1226 return Url::parse(url).context("invalid rpc url");
1227 }
1228
1229 let mut url = http.build_url("/rpc");
1230 if let Some(preview_param) =
1231 release_channel.and_then(|channel| channel.release_query_param())
1232 {
1233 url += "?";
1234 url += preview_param;
1235 }
1236
1237 let response = http.get(&url, Default::default(), false).await?;
1238 anyhow::ensure!(
1239 response.status().is_redirection(),
1240 "unexpected /rpc response status {}",
1241 response.status()
1242 );
1243 let collab_url = response
1244 .headers()
1245 .get("Location")
1246 .context("missing location header in /rpc response")?
1247 .to_str()
1248 .map_err(EstablishConnectionError::other)?
1249 .to_string();
1250 Url::parse(&collab_url).with_context(|| format!("parsing collab rpc url {collab_url}"))
1251 }
1252 }
1253
1254 fn establish_websocket_connection(
1255 self: &Arc<Self>,
1256 credentials: &Credentials,
1257 cx: &AsyncApp,
1258 ) -> Task<Result<Connection, EstablishConnectionError>> {
1259 let release_channel = cx
1260 .update(|cx| ReleaseChannel::try_global(cx))
1261 .ok()
1262 .flatten();
1263 let app_version = cx
1264 .update(|cx| AppVersion::global(cx).to_string())
1265 .ok()
1266 .unwrap_or_default();
1267
1268 let http = self.http.clone();
1269 let proxy = http.proxy().cloned();
1270 let user_agent = http.user_agent().cloned();
1271 let credentials = credentials.clone();
1272 let rpc_url = self.rpc_url(http, release_channel);
1273 let system_id = self.telemetry.system_id();
1274 let metrics_id = self.telemetry.metrics_id();
1275 cx.spawn(async move |cx| {
1276 use HttpOrHttps::*;
1277
1278 #[derive(Debug)]
1279 enum HttpOrHttps {
1280 Http,
1281 Https,
1282 }
1283
1284 let mut rpc_url = rpc_url.await?;
1285 let url_scheme = match rpc_url.scheme() {
1286 "https" => Https,
1287 "http" => Http,
1288 _ => Err(anyhow!("invalid rpc url: {}", rpc_url))?,
1289 };
1290 let rpc_host = rpc_url
1291 .host_str()
1292 .zip(rpc_url.port_or_known_default())
1293 .context("missing host in rpc url")?;
1294
1295 let stream = {
1296 let handle = cx.update(|cx| gpui_tokio::Tokio::handle(cx)).ok().unwrap();
1297 let _guard = handle.enter();
1298 match proxy {
1299 Some(proxy) => connect_proxy_stream(&proxy, rpc_host).await?,
1300 None => Box::new(TcpStream::connect(rpc_host).await?),
1301 }
1302 };
1303
1304 log::info!("connected to rpc endpoint {}", rpc_url);
1305
1306 rpc_url
1307 .set_scheme(match url_scheme {
1308 Https => "wss",
1309 Http => "ws",
1310 })
1311 .unwrap();
1312
1313 // We call `into_client_request` to let `tungstenite` construct the WebSocket request
1314 // for us from the RPC URL.
1315 //
1316 // Among other things, it will generate and set a `Sec-WebSocket-Key` header for us.
1317 let mut request = IntoClientRequest::into_client_request(rpc_url.as_str())?;
1318
1319 // We then modify the request to add our desired headers.
1320 let request_headers = request.headers_mut();
1321 request_headers.insert(
1322 http::header::AUTHORIZATION,
1323 HeaderValue::from_str(&credentials.authorization_header())?,
1324 );
1325 request_headers.insert(
1326 "x-zed-protocol-version",
1327 HeaderValue::from_str(&rpc::PROTOCOL_VERSION.to_string())?,
1328 );
1329 request_headers.insert("x-zed-app-version", HeaderValue::from_str(&app_version)?);
1330 request_headers.insert(
1331 "x-zed-release-channel",
1332 HeaderValue::from_str(release_channel.map(|r| r.dev_name()).unwrap_or("unknown"))?,
1333 );
1334 if let Some(user_agent) = user_agent {
1335 request_headers.insert(http::header::USER_AGENT, user_agent);
1336 }
1337 if let Some(system_id) = system_id {
1338 request_headers.insert("x-zed-system-id", HeaderValue::from_str(&system_id)?);
1339 }
1340 if let Some(metrics_id) = metrics_id {
1341 request_headers.insert("x-zed-metrics-id", HeaderValue::from_str(&metrics_id)?);
1342 }
1343
1344 let (stream, _) = async_tungstenite::tokio::client_async_tls_with_connector_and_config(
1345 request,
1346 stream,
1347 Some(Arc::new(http_client_tls::tls_config()).into()),
1348 None,
1349 )
1350 .await?;
1351
1352 Ok(Connection::new(
1353 stream
1354 .map_err(|error| anyhow!(error))
1355 .sink_map_err(|error| anyhow!(error)),
1356 ))
1357 })
1358 }
1359
1360 pub fn authenticate_with_browser(self: &Arc<Self>, cx: &AsyncApp) -> Task<Result<Credentials>> {
1361 let http = self.http.clone();
1362 let this = self.clone();
1363 cx.spawn(async move |cx| {
1364 let background = cx.background_executor().clone();
1365
1366 let (open_url_tx, open_url_rx) = oneshot::channel::<String>();
1367 cx.update(|cx| {
1368 cx.spawn(async move |cx| {
1369 let url = open_url_rx.await?;
1370 cx.update(|cx| cx.open_url(&url))
1371 })
1372 .detach_and_log_err(cx);
1373 })
1374 .log_err();
1375
1376 let credentials = background
1377 .clone()
1378 .spawn(async move {
1379 // Generate a pair of asymmetric encryption keys. The public key will be used by the
1380 // zed server to encrypt the user's access token, so that it can'be intercepted by
1381 // any other app running on the user's device.
1382 let (public_key, private_key) =
1383 rpc::auth::keypair().expect("failed to generate keypair for auth");
1384 let public_key_string = String::try_from(public_key)
1385 .expect("failed to serialize public key for auth");
1386
1387 if let Some((login, token)) =
1388 IMPERSONATE_LOGIN.as_ref().zip(ADMIN_API_TOKEN.as_ref())
1389 {
1390 eprintln!("authenticate as admin {login}, {token}");
1391
1392 return this
1393 .authenticate_as_admin(http, login.clone(), token.clone())
1394 .await;
1395 }
1396
1397 // Start an HTTP server to receive the redirect from Zed's sign-in page.
1398 let server =
1399 tiny_http::Server::http("127.0.0.1:0").expect("failed to find open port");
1400 let port = server.server_addr().port();
1401
1402 // Open the Zed sign-in page in the user's browser, with query parameters that indicate
1403 // that the user is signing in from a Zed app running on the same device.
1404 let mut url = http.build_url(&format!(
1405 "/native_app_signin?native_app_port={}&native_app_public_key={}",
1406 port, public_key_string
1407 ));
1408
1409 if let Some(impersonate_login) = IMPERSONATE_LOGIN.as_ref() {
1410 log::info!("impersonating user @{}", impersonate_login);
1411 write!(&mut url, "&impersonate={}", impersonate_login).unwrap();
1412 }
1413
1414 open_url_tx.send(url).log_err();
1415
1416 #[derive(Deserialize)]
1417 struct CallbackParams {
1418 pub user_id: String,
1419 pub access_token: String,
1420 }
1421
1422 // Receive the HTTP request from the user's browser. Retrieve the user id and encrypted
1423 // access token from the query params.
1424 //
1425 // TODO - Avoid ever starting more than one HTTP server. Maybe switch to using a
1426 // custom URL scheme instead of this local HTTP server.
1427 let (user_id, access_token) = background
1428 .spawn(async move {
1429 for _ in 0..100 {
1430 if let Some(req) = server.recv_timeout(Duration::from_secs(1))? {
1431 let path = req.url();
1432 let url = Url::parse(&format!("http://example.com{}", path))
1433 .context("failed to parse login notification url")?;
1434 let callback_params: CallbackParams =
1435 serde_urlencoded::from_str(url.query().unwrap_or_default())
1436 .context(
1437 "failed to parse sign-in callback query parameters",
1438 )?;
1439
1440 let post_auth_url =
1441 http.build_url("/native_app_signin_succeeded");
1442 req.respond(
1443 tiny_http::Response::empty(302).with_header(
1444 tiny_http::Header::from_bytes(
1445 &b"Location"[..],
1446 post_auth_url.as_bytes(),
1447 )
1448 .unwrap(),
1449 ),
1450 )
1451 .context("failed to respond to login http request")?;
1452 return Ok((
1453 callback_params.user_id,
1454 callback_params.access_token,
1455 ));
1456 }
1457 }
1458
1459 anyhow::bail!("didn't receive login redirect");
1460 })
1461 .await?;
1462
1463 let access_token = private_key
1464 .decrypt_string(&access_token)
1465 .context("failed to decrypt access token")?;
1466
1467 Ok(Credentials {
1468 user_id: user_id.parse()?,
1469 access_token,
1470 })
1471 })
1472 .await?;
1473
1474 cx.update(|cx| cx.activate(true))?;
1475 Ok(credentials)
1476 })
1477 }
1478
1479 async fn authenticate_as_admin(
1480 self: &Arc<Self>,
1481 http: Arc<HttpClientWithUrl>,
1482 login: String,
1483 api_token: String,
1484 ) -> Result<Credentials> {
1485 #[derive(Serialize)]
1486 struct ImpersonateUserBody {
1487 github_login: String,
1488 }
1489
1490 #[derive(Deserialize)]
1491 struct ImpersonateUserResponse {
1492 user_id: u64,
1493 access_token: String,
1494 }
1495
1496 let url = self
1497 .http
1498 .build_zed_cloud_url("/internal/users/impersonate", &[])?;
1499 let request = Request::post(url.as_str())
1500 .header("Content-Type", "application/json")
1501 .header("Authorization", format!("Bearer {api_token}"))
1502 .body(
1503 serde_json::to_string(&ImpersonateUserBody {
1504 github_login: login,
1505 })?
1506 .into(),
1507 )?;
1508
1509 let mut response = http.send(request).await?;
1510 let mut body = String::new();
1511 response.body_mut().read_to_string(&mut body).await?;
1512 anyhow::ensure!(
1513 response.status().is_success(),
1514 "admin user request failed {} - {}",
1515 response.status().as_u16(),
1516 body,
1517 );
1518 let response: ImpersonateUserResponse = serde_json::from_str(&body)?;
1519
1520 Ok(Credentials {
1521 user_id: response.user_id,
1522 access_token: response.access_token,
1523 })
1524 }
1525
1526 pub async fn sign_out(self: &Arc<Self>, cx: &AsyncApp) {
1527 self.state.write().credentials = None;
1528 self.cloud_client.clear_credentials();
1529 self.disconnect(cx);
1530
1531 if self.has_credentials(cx).await {
1532 self.credentials_provider
1533 .delete_credentials(cx)
1534 .await
1535 .log_err();
1536 }
1537 }
1538
1539 pub fn disconnect(self: &Arc<Self>, cx: &AsyncApp) {
1540 self.peer.teardown();
1541 self.set_status(Status::SignedOut, cx);
1542 }
1543
1544 pub fn reconnect(self: &Arc<Self>, cx: &AsyncApp) {
1545 self.peer.teardown();
1546 self.set_status(Status::ConnectionLost, cx);
1547 }
1548
1549 fn connection_id(&self) -> Result<ConnectionId> {
1550 if let Status::Connected { connection_id, .. } = *self.status().borrow() {
1551 Ok(connection_id)
1552 } else {
1553 anyhow::bail!("not connected");
1554 }
1555 }
1556
1557 pub fn send<T: EnvelopedMessage>(&self, message: T) -> Result<()> {
1558 log::debug!("rpc send. client_id:{}, name:{}", self.id(), T::NAME);
1559 self.peer.send(self.connection_id()?, message)
1560 }
1561
1562 pub fn request<T: RequestMessage>(
1563 &self,
1564 request: T,
1565 ) -> impl Future<Output = Result<T::Response>> + use<T> {
1566 self.request_envelope(request)
1567 .map_ok(|envelope| envelope.payload)
1568 }
1569
1570 pub fn request_stream<T: RequestMessage>(
1571 &self,
1572 request: T,
1573 ) -> impl Future<Output = Result<impl Stream<Item = Result<T::Response>>>> {
1574 let client_id = self.id.load(Ordering::SeqCst);
1575 log::debug!(
1576 "rpc request start. client_id:{}. name:{}",
1577 client_id,
1578 T::NAME
1579 );
1580 let response = self
1581 .connection_id()
1582 .map(|conn_id| self.peer.request_stream(conn_id, request));
1583 async move {
1584 let response = response?.await;
1585 log::debug!(
1586 "rpc request finish. client_id:{}. name:{}",
1587 client_id,
1588 T::NAME
1589 );
1590 response
1591 }
1592 }
1593
1594 pub fn request_envelope<T: RequestMessage>(
1595 &self,
1596 request: T,
1597 ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> + use<T> {
1598 let client_id = self.id();
1599 log::debug!(
1600 "rpc request start. client_id:{}. name:{}",
1601 client_id,
1602 T::NAME
1603 );
1604 let response = self
1605 .connection_id()
1606 .map(|conn_id| self.peer.request_envelope(conn_id, request));
1607 async move {
1608 let response = response?.await;
1609 log::debug!(
1610 "rpc request finish. client_id:{}. name:{}",
1611 client_id,
1612 T::NAME
1613 );
1614 response
1615 }
1616 }
1617
1618 pub fn request_dynamic(
1619 &self,
1620 envelope: proto::Envelope,
1621 request_type: &'static str,
1622 ) -> impl Future<Output = Result<proto::Envelope>> + use<> {
1623 let client_id = self.id();
1624 log::debug!(
1625 "rpc request start. client_id:{}. name:{}",
1626 client_id,
1627 request_type
1628 );
1629 let response = self
1630 .connection_id()
1631 .map(|conn_id| self.peer.request_dynamic(conn_id, envelope, request_type));
1632 async move {
1633 let response = response?.await;
1634 log::debug!(
1635 "rpc request finish. client_id:{}. name:{}",
1636 client_id,
1637 request_type
1638 );
1639 Ok(response?.0)
1640 }
1641 }
1642
1643 fn handle_message(self: &Arc<Client>, message: Box<dyn AnyTypedEnvelope>, cx: &AsyncApp) {
1644 let sender_id = message.sender_id();
1645 let request_id = message.message_id();
1646 let type_name = message.payload_type_name();
1647 let original_sender_id = message.original_sender_id();
1648
1649 if let Some(future) = ProtoMessageHandlerSet::handle_message(
1650 &self.handler_set,
1651 message,
1652 self.clone().into(),
1653 cx.clone(),
1654 ) {
1655 let client_id = self.id();
1656 log::debug!(
1657 "rpc message received. client_id:{}, sender_id:{:?}, type:{}",
1658 client_id,
1659 original_sender_id,
1660 type_name
1661 );
1662 cx.spawn(async move |_| match future.await {
1663 Ok(()) => {
1664 log::debug!(
1665 "rpc message handled. client_id:{}, sender_id:{:?}, type:{}",
1666 client_id,
1667 original_sender_id,
1668 type_name
1669 );
1670 }
1671 Err(error) => {
1672 log::error!(
1673 "error handling message. client_id:{}, sender_id:{:?}, type:{}, error:{:?}",
1674 client_id,
1675 original_sender_id,
1676 type_name,
1677 error
1678 );
1679 }
1680 })
1681 .detach();
1682 } else {
1683 log::info!("unhandled message {}", type_name);
1684 self.peer
1685 .respond_with_unhandled_message(sender_id.into(), request_id, type_name)
1686 .log_err();
1687 }
1688 }
1689
1690 pub fn add_message_to_client_handler(
1691 self: &Arc<Client>,
1692 handler: impl Fn(&MessageToClient, &mut App) + Send + Sync + 'static,
1693 ) {
1694 self.message_to_client_handlers
1695 .lock()
1696 .push(Box::new(handler));
1697 }
1698
1699 fn handle_message_to_client(self: &Arc<Client>, message: MessageToClient, cx: &AsyncApp) {
1700 cx.update(|cx| {
1701 for handler in self.message_to_client_handlers.lock().iter() {
1702 handler(&message, cx);
1703 }
1704 })
1705 .ok();
1706 }
1707
1708 pub fn telemetry(&self) -> &Arc<Telemetry> {
1709 &self.telemetry
1710 }
1711}
1712
1713impl ProtoClient for Client {
1714 fn request(
1715 &self,
1716 envelope: proto::Envelope,
1717 request_type: &'static str,
1718 ) -> BoxFuture<'static, Result<proto::Envelope>> {
1719 self.request_dynamic(envelope, request_type).boxed()
1720 }
1721
1722 fn send(&self, envelope: proto::Envelope, message_type: &'static str) -> Result<()> {
1723 log::debug!("rpc send. client_id:{}, name:{}", self.id(), message_type);
1724 let connection_id = self.connection_id()?;
1725 self.peer.send_dynamic(connection_id, envelope)
1726 }
1727
1728 fn send_response(&self, envelope: proto::Envelope, message_type: &'static str) -> Result<()> {
1729 log::debug!(
1730 "rpc respond. client_id:{}, name:{}",
1731 self.id(),
1732 message_type
1733 );
1734 let connection_id = self.connection_id()?;
1735 self.peer.send_dynamic(connection_id, envelope)
1736 }
1737
1738 fn message_handler_set(&self) -> &parking_lot::Mutex<ProtoMessageHandlerSet> {
1739 &self.handler_set
1740 }
1741
1742 fn is_via_collab(&self) -> bool {
1743 true
1744 }
1745}
1746
1747/// prefix for the zed:// url scheme
1748pub const ZED_URL_SCHEME: &str = "zed";
1749
1750/// Parses the given link into a Zed link.
1751///
1752/// Returns a [`Some`] containing the unprefixed link if the link is a Zed link.
1753/// Returns [`None`] otherwise.
1754pub fn parse_zed_link<'a>(link: &'a str, cx: &App) -> Option<&'a str> {
1755 let server_url = &ClientSettings::get_global(cx).server_url;
1756 if let Some(stripped) = link
1757 .strip_prefix(server_url)
1758 .and_then(|result| result.strip_prefix('/'))
1759 {
1760 return Some(stripped);
1761 }
1762 if let Some(stripped) = link
1763 .strip_prefix(ZED_URL_SCHEME)
1764 .and_then(|result| result.strip_prefix("://"))
1765 {
1766 return Some(stripped);
1767 }
1768
1769 None
1770}
1771
1772#[cfg(test)]
1773mod tests {
1774 use super::*;
1775 use crate::test::{FakeServer, parse_authorization_header};
1776
1777 use clock::FakeSystemClock;
1778 use gpui::{AppContext as _, BackgroundExecutor, TestAppContext};
1779 use http_client::FakeHttpClient;
1780 use parking_lot::Mutex;
1781 use proto::TypedEnvelope;
1782 use settings::SettingsStore;
1783 use std::future;
1784
1785 #[gpui::test(iterations = 10)]
1786 async fn test_reconnection(cx: &mut TestAppContext) {
1787 init_test(cx);
1788 let user_id = 5;
1789 let client = cx.update(|cx| {
1790 Client::new(
1791 Arc::new(FakeSystemClock::new()),
1792 FakeHttpClient::with_404_response(),
1793 cx,
1794 )
1795 });
1796 let server = FakeServer::for_client(user_id, &client, cx).await;
1797 let mut status = client.status();
1798 assert!(matches!(
1799 status.next().await,
1800 Some(Status::Connected { .. })
1801 ));
1802 assert_eq!(server.auth_count(), 1);
1803
1804 server.forbid_connections();
1805 server.disconnect();
1806 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1807
1808 server.allow_connections();
1809 cx.executor().advance_clock(Duration::from_secs(10));
1810 while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1811 assert_eq!(server.auth_count(), 1); // Client reused the cached credentials when reconnecting
1812
1813 server.forbid_connections();
1814 server.disconnect();
1815 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1816
1817 // Clear cached credentials after authentication fails
1818 server.roll_access_token();
1819 server.allow_connections();
1820 cx.executor().run_until_parked();
1821 cx.executor().advance_clock(Duration::from_secs(10));
1822 while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1823 assert_eq!(server.auth_count(), 2); // Client re-authenticated due to an invalid token
1824 }
1825
1826 #[gpui::test(iterations = 10)]
1827 async fn test_auth_failure_during_reconnection(cx: &mut TestAppContext) {
1828 init_test(cx);
1829 let http_client = FakeHttpClient::with_200_response();
1830 let client =
1831 cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client.clone(), cx));
1832 let server = FakeServer::for_client(42, &client, cx).await;
1833 let mut status = client.status();
1834 assert!(matches!(
1835 status.next().await,
1836 Some(Status::Connected { .. })
1837 ));
1838 assert_eq!(server.auth_count(), 1);
1839
1840 // Simulate an auth failure during reconnection.
1841 http_client
1842 .as_fake()
1843 .replace_handler(|_, _request| async move {
1844 Ok(http_client::Response::builder()
1845 .status(503)
1846 .body("".into())
1847 .unwrap())
1848 });
1849 server.disconnect();
1850 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1851
1852 // Restore the ability to authenticate.
1853 http_client
1854 .as_fake()
1855 .replace_handler(|_, _request| async move {
1856 Ok(http_client::Response::builder()
1857 .status(200)
1858 .body("".into())
1859 .unwrap())
1860 });
1861 cx.executor().advance_clock(Duration::from_secs(10));
1862 while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1863 assert_eq!(server.auth_count(), 1); // Client reused the cached credentials when reconnecting
1864 }
1865
1866 #[gpui::test(iterations = 10)]
1867 async fn test_connection_timeout(executor: BackgroundExecutor, cx: &mut TestAppContext) {
1868 init_test(cx);
1869 let user_id = 5;
1870 let client = cx.update(|cx| {
1871 Client::new(
1872 Arc::new(FakeSystemClock::new()),
1873 FakeHttpClient::with_404_response(),
1874 cx,
1875 )
1876 });
1877 let mut status = client.status();
1878
1879 // Time out when client tries to connect.
1880 client.override_authenticate(move |cx| {
1881 cx.background_spawn(async move {
1882 Ok(Credentials {
1883 user_id,
1884 access_token: "token".into(),
1885 })
1886 })
1887 });
1888 client.override_establish_connection(|_, cx| {
1889 cx.background_spawn(async move {
1890 future::pending::<()>().await;
1891 unreachable!()
1892 })
1893 });
1894 let auth_and_connect = cx.spawn({
1895 let client = client.clone();
1896 |cx| async move { client.connect(false, &cx).await }
1897 });
1898 executor.run_until_parked();
1899 assert!(matches!(status.next().await, Some(Status::Connecting)));
1900
1901 executor.advance_clock(CONNECTION_TIMEOUT);
1902 assert!(matches!(
1903 status.next().await,
1904 Some(Status::ConnectionError { .. })
1905 ));
1906 auth_and_connect.await.into_response().unwrap_err();
1907
1908 // Allow the connection to be established.
1909 let server = FakeServer::for_client(user_id, &client, cx).await;
1910 assert!(matches!(
1911 status.next().await,
1912 Some(Status::Connected { .. })
1913 ));
1914
1915 // Disconnect client.
1916 server.forbid_connections();
1917 server.disconnect();
1918 while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1919
1920 // Time out when re-establishing the connection.
1921 server.allow_connections();
1922 client.override_establish_connection(|_, cx| {
1923 cx.background_spawn(async move {
1924 future::pending::<()>().await;
1925 unreachable!()
1926 })
1927 });
1928 executor.advance_clock(2 * INITIAL_RECONNECTION_DELAY);
1929 assert!(matches!(
1930 status.next().await,
1931 Some(Status::Reconnecting { .. })
1932 ));
1933
1934 executor.advance_clock(CONNECTION_TIMEOUT);
1935 assert!(matches!(
1936 status.next().await,
1937 Some(Status::ReconnectionError { .. })
1938 ));
1939 }
1940
1941 #[gpui::test(iterations = 10)]
1942 async fn test_reauthenticate_only_if_unauthorized(cx: &mut TestAppContext) {
1943 init_test(cx);
1944 let auth_count = Arc::new(Mutex::new(0));
1945 let http_client = FakeHttpClient::create(|_request| async move {
1946 Ok(http_client::Response::builder()
1947 .status(200)
1948 .body("".into())
1949 .unwrap())
1950 });
1951 let client =
1952 cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client.clone(), cx));
1953 client.override_authenticate({
1954 let auth_count = auth_count.clone();
1955 move |cx| {
1956 let auth_count = auth_count.clone();
1957 cx.background_spawn(async move {
1958 *auth_count.lock() += 1;
1959 Ok(Credentials {
1960 user_id: 1,
1961 access_token: auth_count.lock().to_string(),
1962 })
1963 })
1964 }
1965 });
1966
1967 let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
1968 assert_eq!(*auth_count.lock(), 1);
1969 assert_eq!(credentials.access_token, "1");
1970
1971 // If credentials are still valid, signing in doesn't trigger authentication.
1972 let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
1973 assert_eq!(*auth_count.lock(), 1);
1974 assert_eq!(credentials.access_token, "1");
1975
1976 // If the server is unavailable, signing in doesn't trigger authentication.
1977 http_client
1978 .as_fake()
1979 .replace_handler(|_, _request| async move {
1980 Ok(http_client::Response::builder()
1981 .status(503)
1982 .body("".into())
1983 .unwrap())
1984 });
1985 client.sign_in(false, &cx.to_async()).await.unwrap_err();
1986 assert_eq!(*auth_count.lock(), 1);
1987
1988 // If credentials became invalid, signing in triggers authentication.
1989 http_client
1990 .as_fake()
1991 .replace_handler(|_, request| async move {
1992 let credentials = parse_authorization_header(&request).unwrap();
1993 if credentials.access_token == "2" {
1994 Ok(http_client::Response::builder()
1995 .status(200)
1996 .body("".into())
1997 .unwrap())
1998 } else {
1999 Ok(http_client::Response::builder()
2000 .status(401)
2001 .body("".into())
2002 .unwrap())
2003 }
2004 });
2005 let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
2006 assert_eq!(*auth_count.lock(), 2);
2007 assert_eq!(credentials.access_token, "2");
2008 }
2009
2010 #[gpui::test(iterations = 10)]
2011 async fn test_authenticating_more_than_once(
2012 cx: &mut TestAppContext,
2013 executor: BackgroundExecutor,
2014 ) {
2015 init_test(cx);
2016 let auth_count = Arc::new(Mutex::new(0));
2017 let dropped_auth_count = Arc::new(Mutex::new(0));
2018 let client = cx.update(|cx| {
2019 Client::new(
2020 Arc::new(FakeSystemClock::new()),
2021 FakeHttpClient::with_404_response(),
2022 cx,
2023 )
2024 });
2025 client.override_authenticate({
2026 let auth_count = auth_count.clone();
2027 let dropped_auth_count = dropped_auth_count.clone();
2028 move |cx| {
2029 let auth_count = auth_count.clone();
2030 let dropped_auth_count = dropped_auth_count.clone();
2031 cx.background_spawn(async move {
2032 *auth_count.lock() += 1;
2033 let _drop = util::defer(move || *dropped_auth_count.lock() += 1);
2034 future::pending::<()>().await;
2035 unreachable!()
2036 })
2037 }
2038 });
2039
2040 let _authenticate = cx.spawn({
2041 let client = client.clone();
2042 move |cx| async move { client.connect(false, &cx).await }
2043 });
2044 executor.run_until_parked();
2045 assert_eq!(*auth_count.lock(), 1);
2046 assert_eq!(*dropped_auth_count.lock(), 0);
2047
2048 let _authenticate = cx.spawn({
2049 let client = client.clone();
2050 |cx| async move { client.connect(false, &cx).await }
2051 });
2052 executor.run_until_parked();
2053 assert_eq!(*auth_count.lock(), 2);
2054 assert_eq!(*dropped_auth_count.lock(), 1);
2055 }
2056
2057 #[gpui::test]
2058 async fn test_subscribing_to_entity(cx: &mut TestAppContext) {
2059 init_test(cx);
2060 let user_id = 5;
2061 let client = cx.update(|cx| {
2062 Client::new(
2063 Arc::new(FakeSystemClock::new()),
2064 FakeHttpClient::with_404_response(),
2065 cx,
2066 )
2067 });
2068 let server = FakeServer::for_client(user_id, &client, cx).await;
2069
2070 let (done_tx1, done_rx1) = smol::channel::unbounded();
2071 let (done_tx2, done_rx2) = smol::channel::unbounded();
2072 AnyProtoClient::from(client.clone()).add_entity_message_handler(
2073 move |entity: Entity<TestEntity>, _: TypedEnvelope<proto::JoinProject>, mut cx| {
2074 match entity.read_with(&mut cx, |entity, _| entity.id).unwrap() {
2075 1 => done_tx1.try_send(()).unwrap(),
2076 2 => done_tx2.try_send(()).unwrap(),
2077 _ => unreachable!(),
2078 }
2079 async { Ok(()) }
2080 },
2081 );
2082 let entity1 = cx.new(|_| TestEntity {
2083 id: 1,
2084 subscription: None,
2085 });
2086 let entity2 = cx.new(|_| TestEntity {
2087 id: 2,
2088 subscription: None,
2089 });
2090 let entity3 = cx.new(|_| TestEntity {
2091 id: 3,
2092 subscription: None,
2093 });
2094
2095 let _subscription1 = client
2096 .subscribe_to_entity(1)
2097 .unwrap()
2098 .set_entity(&entity1, &mut cx.to_async());
2099 let _subscription2 = client
2100 .subscribe_to_entity(2)
2101 .unwrap()
2102 .set_entity(&entity2, &mut cx.to_async());
2103 // Ensure dropping a subscription for the same entity type still allows receiving of
2104 // messages for other entity IDs of the same type.
2105 let subscription3 = client
2106 .subscribe_to_entity(3)
2107 .unwrap()
2108 .set_entity(&entity3, &mut cx.to_async());
2109 drop(subscription3);
2110
2111 server.send(proto::JoinProject {
2112 project_id: 1,
2113 committer_name: None,
2114 committer_email: None,
2115 });
2116 server.send(proto::JoinProject {
2117 project_id: 2,
2118 committer_name: None,
2119 committer_email: None,
2120 });
2121 done_rx1.recv().await.unwrap();
2122 done_rx2.recv().await.unwrap();
2123 }
2124
2125 #[gpui::test]
2126 async fn test_subscribing_after_dropping_subscription(cx: &mut TestAppContext) {
2127 init_test(cx);
2128 let user_id = 5;
2129 let client = cx.update(|cx| {
2130 Client::new(
2131 Arc::new(FakeSystemClock::new()),
2132 FakeHttpClient::with_404_response(),
2133 cx,
2134 )
2135 });
2136 let server = FakeServer::for_client(user_id, &client, cx).await;
2137
2138 let entity = cx.new(|_| TestEntity::default());
2139 let (done_tx1, _done_rx1) = smol::channel::unbounded();
2140 let (done_tx2, done_rx2) = smol::channel::unbounded();
2141 let subscription1 = client.add_message_handler(
2142 entity.downgrade(),
2143 move |_, _: TypedEnvelope<proto::Ping>, _| {
2144 done_tx1.try_send(()).unwrap();
2145 async { Ok(()) }
2146 },
2147 );
2148 drop(subscription1);
2149 let _subscription2 = client.add_message_handler(
2150 entity.downgrade(),
2151 move |_, _: TypedEnvelope<proto::Ping>, _| {
2152 done_tx2.try_send(()).unwrap();
2153 async { Ok(()) }
2154 },
2155 );
2156 server.send(proto::Ping {});
2157 done_rx2.recv().await.unwrap();
2158 }
2159
2160 #[gpui::test]
2161 async fn test_dropping_subscription_in_handler(cx: &mut TestAppContext) {
2162 init_test(cx);
2163 let user_id = 5;
2164 let client = cx.update(|cx| {
2165 Client::new(
2166 Arc::new(FakeSystemClock::new()),
2167 FakeHttpClient::with_404_response(),
2168 cx,
2169 )
2170 });
2171 let server = FakeServer::for_client(user_id, &client, cx).await;
2172
2173 let entity = cx.new(|_| TestEntity::default());
2174 let (done_tx, done_rx) = smol::channel::unbounded();
2175 let subscription = client.add_message_handler(
2176 entity.clone().downgrade(),
2177 move |entity: Entity<TestEntity>, _: TypedEnvelope<proto::Ping>, mut cx| {
2178 entity
2179 .update(&mut cx, |entity, _| entity.subscription.take())
2180 .unwrap();
2181 done_tx.try_send(()).unwrap();
2182 async { Ok(()) }
2183 },
2184 );
2185 entity.update(cx, |entity, _| {
2186 entity.subscription = Some(subscription);
2187 });
2188 server.send(proto::Ping {});
2189 done_rx.recv().await.unwrap();
2190 }
2191
2192 #[derive(Default)]
2193 struct TestEntity {
2194 id: usize,
2195 subscription: Option<Subscription>,
2196 }
2197
2198 fn init_test(cx: &mut TestAppContext) {
2199 cx.update(|cx| {
2200 let settings_store = SettingsStore::test(cx);
2201 cx.set_global(settings_store);
2202 init_settings(cx);
2203 });
2204 }
2205}