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").is_ok_and(|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;
 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, 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        {
 870            credentials = Some(old_credentials);
 871        }
 872
 873        if credentials.is_none()
 874            && try_provider
 875            && let Some(stored_credentials) = self.credentials_provider.read_credentials(cx).await
 876        {
 877            if self.validate_credentials(&stored_credentials, cx).await? {
 878                credentials = Some(stored_credentials);
 879            } else {
 880                self.credentials_provider
 881                    .delete_credentials(cx)
 882                    .await
 883                    .log_err();
 884            }
 885        }
 886
 887        if credentials.is_none() {
 888            let mut status_rx = self.status();
 889            let _ = status_rx.next().await;
 890            futures::select_biased! {
 891                authenticate = self.authenticate(cx).fuse() => {
 892                    match authenticate {
 893                        Ok(creds) => {
 894                            if IMPERSONATE_LOGIN.is_none() {
 895                                self.credentials_provider
 896                                    .write_credentials(creds.user_id, creds.access_token.clone(), cx)
 897                                    .await
 898                                    .log_err();
 899                            }
 900
 901                            credentials = Some(creds);
 902                        },
 903                        Err(err) => {
 904                            self.set_status(Status::AuthenticationError, cx);
 905                            return Err(err);
 906                        }
 907                    }
 908                }
 909                _ = status_rx.next().fuse() => {
 910                    return Err(anyhow!("authentication canceled"));
 911                }
 912            }
 913        }
 914
 915        let credentials = credentials.unwrap();
 916        self.set_id(credentials.user_id);
 917        self.cloud_client
 918            .set_credentials(credentials.user_id as u32, credentials.access_token.clone());
 919        self.state.write().credentials = Some(credentials.clone());
 920        self.set_status(Status::Authenticated, cx);
 921
 922        Ok(credentials)
 923    }
 924
 925    async fn validate_credentials(
 926        self: &Arc<Self>,
 927        credentials: &Credentials,
 928        cx: &AsyncApp,
 929    ) -> Result<bool> {
 930        match self
 931            .cloud_client
 932            .validate_credentials(credentials.user_id as u32, &credentials.access_token)
 933            .await
 934        {
 935            Ok(valid) => Ok(valid),
 936            Err(err) => {
 937                self.set_status(Status::AuthenticationError, cx);
 938                Err(anyhow!("failed to validate credentials: {}", err))
 939            }
 940        }
 941    }
 942
 943    /// Establishes a WebSocket connection with Cloud for receiving updates from the server.
 944    async fn connect_to_cloud(self: &Arc<Self>, cx: &AsyncApp) -> Result<()> {
 945        let connect_task = cx.update({
 946            let cloud_client = self.cloud_client.clone();
 947            move |cx| cloud_client.connect(cx)
 948        })??;
 949        let connection = connect_task.await?;
 950
 951        let (mut messages, task) = cx.update(|cx| connection.spawn(cx))?;
 952        task.detach();
 953
 954        cx.spawn({
 955            let this = self.clone();
 956            async move |cx| {
 957                while let Some(message) = messages.next().await {
 958                    if let Some(message) = message.log_err() {
 959                        this.handle_message_to_client(message, cx);
 960                    }
 961                }
 962            }
 963        })
 964        .detach();
 965
 966        Ok(())
 967    }
 968
 969    /// Performs a sign-in and also (optionally) connects to Collab.
 970    ///
 971    /// Only Zed staff automatically connect to Collab.
 972    pub async fn sign_in_with_optional_connect(
 973        self: &Arc<Self>,
 974        try_provider: bool,
 975        cx: &AsyncApp,
 976    ) -> Result<()> {
 977        // Don't try to sign in again if we're already connected to Collab, as it will temporarily disconnect us.
 978        if self.status().borrow().is_connected() {
 979            return Ok(());
 980        }
 981
 982        let (is_staff_tx, is_staff_rx) = oneshot::channel::<bool>();
 983        let mut is_staff_tx = Some(is_staff_tx);
 984        cx.update(|cx| {
 985            cx.on_flags_ready(move |state, _cx| {
 986                if let Some(is_staff_tx) = is_staff_tx.take() {
 987                    is_staff_tx.send(state.is_staff).log_err();
 988                }
 989            })
 990            .detach();
 991        })
 992        .log_err();
 993
 994        let credentials = self.sign_in(try_provider, cx).await?;
 995
 996        self.connect_to_cloud(cx).await.log_err();
 997
 998        cx.update(move |cx| {
 999            cx.spawn({
1000                let client = self.clone();
1001                async move |cx| {
1002                    let is_staff = is_staff_rx.await?;
1003                    if is_staff {
1004                        match client.connect_with_credentials(credentials, cx).await {
1005                            ConnectionResult::Timeout => Err(anyhow!("connection timed out")),
1006                            ConnectionResult::ConnectionReset => Err(anyhow!("connection reset")),
1007                            ConnectionResult::Result(result) => {
1008                                result.context("client auth and connect")
1009                            }
1010                        }
1011                    } else {
1012                        Ok(())
1013                    }
1014                }
1015            })
1016            .detach_and_log_err(cx);
1017        })
1018        .log_err();
1019
1020        Ok(())
1021    }
1022
1023    pub async fn connect(
1024        self: &Arc<Self>,
1025        try_provider: bool,
1026        cx: &AsyncApp,
1027    ) -> ConnectionResult<()> {
1028        let was_disconnected = match *self.status().borrow() {
1029            Status::SignedOut | Status::Authenticated => true,
1030            Status::ConnectionError
1031            | Status::ConnectionLost
1032            | Status::Authenticating
1033            | Status::AuthenticationError
1034            | Status::Reauthenticating
1035            | Status::ReconnectionError { .. } => false,
1036            Status::Connected { .. } | Status::Connecting | Status::Reconnecting => {
1037                return ConnectionResult::Result(Ok(()));
1038            }
1039            Status::UpgradeRequired => {
1040                return ConnectionResult::Result(
1041                    Err(EstablishConnectionError::UpgradeRequired)
1042                        .context("client auth and connect"),
1043                );
1044            }
1045        };
1046        let credentials = match self.sign_in(try_provider, cx).await {
1047            Ok(credentials) => credentials,
1048            Err(err) => return ConnectionResult::Result(Err(err)),
1049        };
1050
1051        if was_disconnected {
1052            self.set_status(Status::Connecting, cx);
1053        } else {
1054            self.set_status(Status::Reconnecting, cx);
1055        }
1056
1057        self.connect_with_credentials(credentials, cx).await
1058    }
1059
1060    async fn connect_with_credentials(
1061        self: &Arc<Self>,
1062        credentials: Credentials,
1063        cx: &AsyncApp,
1064    ) -> ConnectionResult<()> {
1065        let mut timeout =
1066            futures::FutureExt::fuse(cx.background_executor().timer(CONNECTION_TIMEOUT));
1067        futures::select_biased! {
1068            connection = self.establish_connection(&credentials, cx).fuse() => {
1069                match connection {
1070                    Ok(conn) => {
1071                        futures::select_biased! {
1072                            result = self.set_connection(conn, cx).fuse() => {
1073                                match result.context("client auth and connect") {
1074                                    Ok(()) => ConnectionResult::Result(Ok(())),
1075                                    Err(err) => {
1076                                        self.set_status(Status::ConnectionError, cx);
1077                                        ConnectionResult::Result(Err(err))
1078                                    },
1079                                }
1080                            },
1081                            _ = timeout => {
1082                                self.set_status(Status::ConnectionError, cx);
1083                                ConnectionResult::Timeout
1084                            }
1085                        }
1086                    }
1087                    Err(EstablishConnectionError::Unauthorized) => {
1088                        self.set_status(Status::ConnectionError, cx);
1089                        ConnectionResult::Result(Err(EstablishConnectionError::Unauthorized).context("client auth and connect"))
1090                    }
1091                    Err(EstablishConnectionError::UpgradeRequired) => {
1092                        self.set_status(Status::UpgradeRequired, cx);
1093                        ConnectionResult::Result(Err(EstablishConnectionError::UpgradeRequired).context("client auth and connect"))
1094                    }
1095                    Err(error) => {
1096                        self.set_status(Status::ConnectionError, cx);
1097                        ConnectionResult::Result(Err(error).context("client auth and connect"))
1098                    }
1099                }
1100            }
1101            _ = &mut timeout => {
1102                self.set_status(Status::ConnectionError, cx);
1103                ConnectionResult::Timeout
1104            }
1105        }
1106    }
1107
1108    async fn set_connection(self: &Arc<Self>, conn: Connection, cx: &AsyncApp) -> Result<()> {
1109        let executor = cx.background_executor();
1110        log::debug!("add connection to peer");
1111        let (connection_id, handle_io, mut incoming) = self.peer.add_connection(conn, {
1112            let executor = executor.clone();
1113            move |duration| executor.timer(duration)
1114        });
1115        let handle_io = executor.spawn(handle_io);
1116
1117        let peer_id = async {
1118            log::debug!("waiting for server hello");
1119            let message = incoming.next().await.context("no hello message received")?;
1120            log::debug!("got server hello");
1121            let hello_message_type_name = message.payload_type_name().to_string();
1122            let hello = message
1123                .into_any()
1124                .downcast::<TypedEnvelope<proto::Hello>>()
1125                .map_err(|_| {
1126                    anyhow!(
1127                        "invalid hello message received: {:?}",
1128                        hello_message_type_name
1129                    )
1130                })?;
1131            let peer_id = hello.payload.peer_id.context("invalid peer id")?;
1132            Ok(peer_id)
1133        };
1134
1135        let peer_id = match peer_id.await {
1136            Ok(peer_id) => peer_id,
1137            Err(error) => {
1138                self.peer.disconnect(connection_id);
1139                return Err(error);
1140            }
1141        };
1142
1143        log::debug!(
1144            "set status to connected (connection id: {:?}, peer id: {:?})",
1145            connection_id,
1146            peer_id
1147        );
1148        self.set_status(
1149            Status::Connected {
1150                peer_id,
1151                connection_id,
1152            },
1153            cx,
1154        );
1155
1156        cx.spawn({
1157            let this = self.clone();
1158            async move |cx| {
1159                while let Some(message) = incoming.next().await {
1160                    this.handle_message(message, cx);
1161                    // Don't starve the main thread when receiving lots of messages at once.
1162                    smol::future::yield_now().await;
1163                }
1164            }
1165        })
1166        .detach();
1167
1168        cx.spawn({
1169            let this = self.clone();
1170            async move |cx| match handle_io.await {
1171                Ok(()) => {
1172                    if *this.status().borrow()
1173                        == (Status::Connected {
1174                            connection_id,
1175                            peer_id,
1176                        })
1177                    {
1178                        this.set_status(Status::SignedOut, cx);
1179                    }
1180                }
1181                Err(err) => {
1182                    log::error!("connection error: {:?}", err);
1183                    this.set_status(Status::ConnectionLost, cx);
1184                }
1185            }
1186        })
1187        .detach();
1188
1189        Ok(())
1190    }
1191
1192    fn authenticate(self: &Arc<Self>, cx: &AsyncApp) -> Task<Result<Credentials>> {
1193        #[cfg(any(test, feature = "test-support"))]
1194        if let Some(callback) = self.authenticate.read().as_ref() {
1195            return callback(cx);
1196        }
1197
1198        self.authenticate_with_browser(cx)
1199    }
1200
1201    fn establish_connection(
1202        self: &Arc<Self>,
1203        credentials: &Credentials,
1204        cx: &AsyncApp,
1205    ) -> Task<Result<Connection, EstablishConnectionError>> {
1206        #[cfg(any(test, feature = "test-support"))]
1207        if let Some(callback) = self.establish_connection.read().as_ref() {
1208            return callback(credentials, cx);
1209        }
1210
1211        self.establish_websocket_connection(credentials, cx)
1212    }
1213
1214    fn rpc_url(
1215        &self,
1216        http: Arc<HttpClientWithUrl>,
1217        release_channel: Option<ReleaseChannel>,
1218    ) -> impl Future<Output = Result<url::Url>> + use<> {
1219        #[cfg(any(test, feature = "test-support"))]
1220        let url_override = self.rpc_url.read().clone();
1221
1222        async move {
1223            #[cfg(any(test, feature = "test-support"))]
1224            if let Some(url) = url_override {
1225                return Ok(url);
1226            }
1227
1228            if let Some(url) = &*ZED_RPC_URL {
1229                return Url::parse(url).context("invalid rpc url");
1230            }
1231
1232            let mut url = http.build_url("/rpc");
1233            if let Some(preview_param) =
1234                release_channel.and_then(|channel| channel.release_query_param())
1235            {
1236                url += "?";
1237                url += preview_param;
1238            }
1239
1240            let response = http.get(&url, Default::default(), false).await?;
1241            anyhow::ensure!(
1242                response.status().is_redirection(),
1243                "unexpected /rpc response status {}",
1244                response.status()
1245            );
1246            let collab_url = response
1247                .headers()
1248                .get("Location")
1249                .context("missing location header in /rpc response")?
1250                .to_str()
1251                .map_err(EstablishConnectionError::other)?
1252                .to_string();
1253            Url::parse(&collab_url).with_context(|| format!("parsing collab rpc url {collab_url}"))
1254        }
1255    }
1256
1257    fn establish_websocket_connection(
1258        self: &Arc<Self>,
1259        credentials: &Credentials,
1260        cx: &AsyncApp,
1261    ) -> Task<Result<Connection, EstablishConnectionError>> {
1262        let release_channel = cx
1263            .update(|cx| ReleaseChannel::try_global(cx))
1264            .ok()
1265            .flatten();
1266        let app_version = cx
1267            .update(|cx| AppVersion::global(cx).to_string())
1268            .ok()
1269            .unwrap_or_default();
1270
1271        let http = self.http.clone();
1272        let proxy = http.proxy().cloned();
1273        let user_agent = http.user_agent().cloned();
1274        let credentials = credentials.clone();
1275        let rpc_url = self.rpc_url(http, release_channel);
1276        let system_id = self.telemetry.system_id();
1277        let metrics_id = self.telemetry.metrics_id();
1278        cx.spawn(async move |cx| {
1279            use HttpOrHttps::*;
1280
1281            #[derive(Debug)]
1282            enum HttpOrHttps {
1283                Http,
1284                Https,
1285            }
1286
1287            let mut rpc_url = rpc_url.await?;
1288            let url_scheme = match rpc_url.scheme() {
1289                "https" => Https,
1290                "http" => Http,
1291                _ => Err(anyhow!("invalid rpc url: {}", rpc_url))?,
1292            };
1293
1294            let stream = gpui_tokio::Tokio::spawn_result(cx, {
1295                let rpc_url = rpc_url.clone();
1296                async move {
1297                    let rpc_host = rpc_url
1298                        .host_str()
1299                        .zip(rpc_url.port_or_known_default())
1300                        .context("missing host in rpc url")?;
1301                    Ok(match proxy {
1302                        Some(proxy) => connect_proxy_stream(&proxy, rpc_host).await?,
1303                        None => Box::new(TcpStream::connect(rpc_host).await?),
1304                    })
1305                }
1306            })?
1307            .await?;
1308
1309            log::info!("connected to rpc endpoint {}", rpc_url);
1310
1311            rpc_url
1312                .set_scheme(match url_scheme {
1313                    Https => "wss",
1314                    Http => "ws",
1315                })
1316                .unwrap();
1317
1318            // We call `into_client_request` to let `tungstenite` construct the WebSocket request
1319            // for us from the RPC URL.
1320            //
1321            // Among other things, it will generate and set a `Sec-WebSocket-Key` header for us.
1322            let mut request = IntoClientRequest::into_client_request(rpc_url.as_str())?;
1323
1324            // We then modify the request to add our desired headers.
1325            let request_headers = request.headers_mut();
1326            request_headers.insert(
1327                http::header::AUTHORIZATION,
1328                HeaderValue::from_str(&credentials.authorization_header())?,
1329            );
1330            request_headers.insert(
1331                "x-zed-protocol-version",
1332                HeaderValue::from_str(&rpc::PROTOCOL_VERSION.to_string())?,
1333            );
1334            request_headers.insert("x-zed-app-version", HeaderValue::from_str(&app_version)?);
1335            request_headers.insert(
1336                "x-zed-release-channel",
1337                HeaderValue::from_str(release_channel.map(|r| r.dev_name()).unwrap_or("unknown"))?,
1338            );
1339            if let Some(user_agent) = user_agent {
1340                request_headers.insert(http::header::USER_AGENT, user_agent);
1341            }
1342            if let Some(system_id) = system_id {
1343                request_headers.insert("x-zed-system-id", HeaderValue::from_str(&system_id)?);
1344            }
1345            if let Some(metrics_id) = metrics_id {
1346                request_headers.insert("x-zed-metrics-id", HeaderValue::from_str(&metrics_id)?);
1347            }
1348
1349            let (stream, _) = async_tungstenite::tokio::client_async_tls_with_connector_and_config(
1350                request,
1351                stream,
1352                Some(Arc::new(http_client_tls::tls_config()).into()),
1353                None,
1354            )
1355            .await?;
1356
1357            Ok(Connection::new(
1358                stream
1359                    .map_err(|error| anyhow!(error))
1360                    .sink_map_err(|error| anyhow!(error)),
1361            ))
1362        })
1363    }
1364
1365    pub fn authenticate_with_browser(self: &Arc<Self>, cx: &AsyncApp) -> Task<Result<Credentials>> {
1366        let http = self.http.clone();
1367        let this = self.clone();
1368        cx.spawn(async move |cx| {
1369            let background = cx.background_executor().clone();
1370
1371            let (open_url_tx, open_url_rx) = oneshot::channel::<String>();
1372            cx.update(|cx| {
1373                cx.spawn(async move |cx| {
1374                    let url = open_url_rx.await?;
1375                    cx.update(|cx| cx.open_url(&url))
1376                })
1377                .detach_and_log_err(cx);
1378            })
1379            .log_err();
1380
1381            let credentials = background
1382                .clone()
1383                .spawn(async move {
1384                    // Generate a pair of asymmetric encryption keys. The public key will be used by the
1385                    // zed server to encrypt the user's access token, so that it can'be intercepted by
1386                    // any other app running on the user's device.
1387                    let (public_key, private_key) =
1388                        rpc::auth::keypair().expect("failed to generate keypair for auth");
1389                    let public_key_string = String::try_from(public_key)
1390                        .expect("failed to serialize public key for auth");
1391
1392                    if let Some((login, token)) =
1393                        IMPERSONATE_LOGIN.as_ref().zip(ADMIN_API_TOKEN.as_ref())
1394                    {
1395                        eprintln!("authenticate as admin {login}, {token}");
1396
1397                        return this
1398                            .authenticate_as_admin(http, login.clone(), token.clone())
1399                            .await;
1400                    }
1401
1402                    // Start an HTTP server to receive the redirect from Zed's sign-in page.
1403                    let server =
1404                        tiny_http::Server::http("127.0.0.1:0").expect("failed to find open port");
1405                    let port = server.server_addr().port();
1406
1407                    // Open the Zed sign-in page in the user's browser, with query parameters that indicate
1408                    // that the user is signing in from a Zed app running on the same device.
1409                    let mut url = http.build_url(&format!(
1410                        "/native_app_signin?native_app_port={}&native_app_public_key={}",
1411                        port, public_key_string
1412                    ));
1413
1414                    if let Some(impersonate_login) = IMPERSONATE_LOGIN.as_ref() {
1415                        log::info!("impersonating user @{}", impersonate_login);
1416                        write!(&mut url, "&impersonate={}", impersonate_login).unwrap();
1417                    }
1418
1419                    open_url_tx.send(url).log_err();
1420
1421                    #[derive(Deserialize)]
1422                    struct CallbackParams {
1423                        pub user_id: String,
1424                        pub access_token: String,
1425                    }
1426
1427                    // Receive the HTTP request from the user's browser. Retrieve the user id and encrypted
1428                    // access token from the query params.
1429                    //
1430                    // TODO - Avoid ever starting more than one HTTP server. Maybe switch to using a
1431                    // custom URL scheme instead of this local HTTP server.
1432                    let (user_id, access_token) = background
1433                        .spawn(async move {
1434                            for _ in 0..100 {
1435                                if let Some(req) = server.recv_timeout(Duration::from_secs(1))? {
1436                                    let path = req.url();
1437                                    let url = Url::parse(&format!("http://example.com{}", path))
1438                                        .context("failed to parse login notification url")?;
1439                                    let callback_params: CallbackParams =
1440                                        serde_urlencoded::from_str(url.query().unwrap_or_default())
1441                                            .context(
1442                                                "failed to parse sign-in callback query parameters",
1443                                            )?;
1444
1445                                    let post_auth_url =
1446                                        http.build_url("/native_app_signin_succeeded");
1447                                    req.respond(
1448                                        tiny_http::Response::empty(302).with_header(
1449                                            tiny_http::Header::from_bytes(
1450                                                &b"Location"[..],
1451                                                post_auth_url.as_bytes(),
1452                                            )
1453                                            .unwrap(),
1454                                        ),
1455                                    )
1456                                    .context("failed to respond to login http request")?;
1457                                    return Ok((
1458                                        callback_params.user_id,
1459                                        callback_params.access_token,
1460                                    ));
1461                                }
1462                            }
1463
1464                            anyhow::bail!("didn't receive login redirect");
1465                        })
1466                        .await?;
1467
1468                    let access_token = private_key
1469                        .decrypt_string(&access_token)
1470                        .context("failed to decrypt access token")?;
1471
1472                    Ok(Credentials {
1473                        user_id: user_id.parse()?,
1474                        access_token,
1475                    })
1476                })
1477                .await?;
1478
1479            cx.update(|cx| cx.activate(true))?;
1480            Ok(credentials)
1481        })
1482    }
1483
1484    async fn authenticate_as_admin(
1485        self: &Arc<Self>,
1486        http: Arc<HttpClientWithUrl>,
1487        login: String,
1488        api_token: String,
1489    ) -> Result<Credentials> {
1490        #[derive(Serialize)]
1491        struct ImpersonateUserBody {
1492            github_login: String,
1493        }
1494
1495        #[derive(Deserialize)]
1496        struct ImpersonateUserResponse {
1497            user_id: u64,
1498            access_token: String,
1499        }
1500
1501        let url = self
1502            .http
1503            .build_zed_cloud_url("/internal/users/impersonate", &[])?;
1504        let request = Request::post(url.as_str())
1505            .header("Content-Type", "application/json")
1506            .header("Authorization", format!("Bearer {api_token}"))
1507            .body(
1508                serde_json::to_string(&ImpersonateUserBody {
1509                    github_login: login,
1510                })?
1511                .into(),
1512            )?;
1513
1514        let mut response = http.send(request).await?;
1515        let mut body = String::new();
1516        response.body_mut().read_to_string(&mut body).await?;
1517        anyhow::ensure!(
1518            response.status().is_success(),
1519            "admin user request failed {} - {}",
1520            response.status().as_u16(),
1521            body,
1522        );
1523        let response: ImpersonateUserResponse = serde_json::from_str(&body)?;
1524
1525        Ok(Credentials {
1526            user_id: response.user_id,
1527            access_token: response.access_token,
1528        })
1529    }
1530
1531    pub async fn sign_out(self: &Arc<Self>, cx: &AsyncApp) {
1532        self.state.write().credentials = None;
1533        self.cloud_client.clear_credentials();
1534        self.disconnect(cx);
1535
1536        if self.has_credentials(cx).await {
1537            self.credentials_provider
1538                .delete_credentials(cx)
1539                .await
1540                .log_err();
1541        }
1542    }
1543
1544    pub fn disconnect(self: &Arc<Self>, cx: &AsyncApp) {
1545        self.peer.teardown();
1546        self.set_status(Status::SignedOut, cx);
1547    }
1548
1549    pub fn reconnect(self: &Arc<Self>, cx: &AsyncApp) {
1550        self.peer.teardown();
1551        self.set_status(Status::ConnectionLost, cx);
1552    }
1553
1554    fn connection_id(&self) -> Result<ConnectionId> {
1555        if let Status::Connected { connection_id, .. } = *self.status().borrow() {
1556            Ok(connection_id)
1557        } else {
1558            anyhow::bail!("not connected");
1559        }
1560    }
1561
1562    pub fn send<T: EnvelopedMessage>(&self, message: T) -> Result<()> {
1563        log::debug!("rpc send. client_id:{}, name:{}", self.id(), T::NAME);
1564        self.peer.send(self.connection_id()?, message)
1565    }
1566
1567    pub fn request<T: RequestMessage>(
1568        &self,
1569        request: T,
1570    ) -> impl Future<Output = Result<T::Response>> + use<T> {
1571        self.request_envelope(request)
1572            .map_ok(|envelope| envelope.payload)
1573    }
1574
1575    pub fn request_stream<T: RequestMessage>(
1576        &self,
1577        request: T,
1578    ) -> impl Future<Output = Result<impl Stream<Item = Result<T::Response>>>> {
1579        let client_id = self.id.load(Ordering::SeqCst);
1580        log::debug!(
1581            "rpc request start. client_id:{}. name:{}",
1582            client_id,
1583            T::NAME
1584        );
1585        let response = self
1586            .connection_id()
1587            .map(|conn_id| self.peer.request_stream(conn_id, request));
1588        async move {
1589            let response = response?.await;
1590            log::debug!(
1591                "rpc request finish. client_id:{}. name:{}",
1592                client_id,
1593                T::NAME
1594            );
1595            response
1596        }
1597    }
1598
1599    pub fn request_envelope<T: RequestMessage>(
1600        &self,
1601        request: T,
1602    ) -> impl Future<Output = Result<TypedEnvelope<T::Response>>> + use<T> {
1603        let client_id = self.id();
1604        log::debug!(
1605            "rpc request start. client_id:{}. name:{}",
1606            client_id,
1607            T::NAME
1608        );
1609        let response = self
1610            .connection_id()
1611            .map(|conn_id| self.peer.request_envelope(conn_id, request));
1612        async move {
1613            let response = response?.await;
1614            log::debug!(
1615                "rpc request finish. client_id:{}. name:{}",
1616                client_id,
1617                T::NAME
1618            );
1619            response
1620        }
1621    }
1622
1623    pub fn request_dynamic(
1624        &self,
1625        envelope: proto::Envelope,
1626        request_type: &'static str,
1627    ) -> impl Future<Output = Result<proto::Envelope>> + use<> {
1628        let client_id = self.id();
1629        log::debug!(
1630            "rpc request start. client_id:{}. name:{}",
1631            client_id,
1632            request_type
1633        );
1634        let response = self
1635            .connection_id()
1636            .map(|conn_id| self.peer.request_dynamic(conn_id, envelope, request_type));
1637        async move {
1638            let response = response?.await;
1639            log::debug!(
1640                "rpc request finish. client_id:{}. name:{}",
1641                client_id,
1642                request_type
1643            );
1644            Ok(response?.0)
1645        }
1646    }
1647
1648    fn handle_message(self: &Arc<Client>, message: Box<dyn AnyTypedEnvelope>, cx: &AsyncApp) {
1649        let sender_id = message.sender_id();
1650        let request_id = message.message_id();
1651        let type_name = message.payload_type_name();
1652        let original_sender_id = message.original_sender_id();
1653
1654        if let Some(future) = ProtoMessageHandlerSet::handle_message(
1655            &self.handler_set,
1656            message,
1657            self.clone().into(),
1658            cx.clone(),
1659        ) {
1660            let client_id = self.id();
1661            log::debug!(
1662                "rpc message received. client_id:{}, sender_id:{:?}, type:{}",
1663                client_id,
1664                original_sender_id,
1665                type_name
1666            );
1667            cx.spawn(async move |_| match future.await {
1668                Ok(()) => {
1669                    log::debug!(
1670                        "rpc message handled. client_id:{}, sender_id:{:?}, type:{}",
1671                        client_id,
1672                        original_sender_id,
1673                        type_name
1674                    );
1675                }
1676                Err(error) => {
1677                    log::error!(
1678                        "error handling message. client_id:{}, sender_id:{:?}, type:{}, error:{:?}",
1679                        client_id,
1680                        original_sender_id,
1681                        type_name,
1682                        error
1683                    );
1684                }
1685            })
1686            .detach();
1687        } else {
1688            log::info!("unhandled message {}", type_name);
1689            self.peer
1690                .respond_with_unhandled_message(sender_id.into(), request_id, type_name)
1691                .log_err();
1692        }
1693    }
1694
1695    pub fn add_message_to_client_handler(
1696        self: &Arc<Client>,
1697        handler: impl Fn(&MessageToClient, &mut App) + Send + Sync + 'static,
1698    ) {
1699        self.message_to_client_handlers
1700            .lock()
1701            .push(Box::new(handler));
1702    }
1703
1704    fn handle_message_to_client(self: &Arc<Client>, message: MessageToClient, cx: &AsyncApp) {
1705        cx.update(|cx| {
1706            for handler in self.message_to_client_handlers.lock().iter() {
1707                handler(&message, cx);
1708            }
1709        })
1710        .ok();
1711    }
1712
1713    pub fn telemetry(&self) -> &Arc<Telemetry> {
1714        &self.telemetry
1715    }
1716}
1717
1718impl ProtoClient for Client {
1719    fn request(
1720        &self,
1721        envelope: proto::Envelope,
1722        request_type: &'static str,
1723    ) -> BoxFuture<'static, Result<proto::Envelope>> {
1724        self.request_dynamic(envelope, request_type).boxed()
1725    }
1726
1727    fn send(&self, envelope: proto::Envelope, message_type: &'static str) -> Result<()> {
1728        log::debug!("rpc send. client_id:{}, name:{}", self.id(), message_type);
1729        let connection_id = self.connection_id()?;
1730        self.peer.send_dynamic(connection_id, envelope)
1731    }
1732
1733    fn send_response(&self, envelope: proto::Envelope, message_type: &'static str) -> Result<()> {
1734        log::debug!(
1735            "rpc respond. client_id:{}, name:{}",
1736            self.id(),
1737            message_type
1738        );
1739        let connection_id = self.connection_id()?;
1740        self.peer.send_dynamic(connection_id, envelope)
1741    }
1742
1743    fn message_handler_set(&self) -> &parking_lot::Mutex<ProtoMessageHandlerSet> {
1744        &self.handler_set
1745    }
1746
1747    fn is_via_collab(&self) -> bool {
1748        true
1749    }
1750}
1751
1752/// prefix for the zed:// url scheme
1753pub const ZED_URL_SCHEME: &str = "zed";
1754
1755/// Parses the given link into a Zed link.
1756///
1757/// Returns a [`Some`] containing the unprefixed link if the link is a Zed link.
1758/// Returns [`None`] otherwise.
1759pub fn parse_zed_link<'a>(link: &'a str, cx: &App) -> Option<&'a str> {
1760    let server_url = &ClientSettings::get_global(cx).server_url;
1761    if let Some(stripped) = link
1762        .strip_prefix(server_url)
1763        .and_then(|result| result.strip_prefix('/'))
1764    {
1765        return Some(stripped);
1766    }
1767    if let Some(stripped) = link
1768        .strip_prefix(ZED_URL_SCHEME)
1769        .and_then(|result| result.strip_prefix("://"))
1770    {
1771        return Some(stripped);
1772    }
1773
1774    None
1775}
1776
1777#[cfg(test)]
1778mod tests {
1779    use super::*;
1780    use crate::test::{FakeServer, parse_authorization_header};
1781
1782    use clock::FakeSystemClock;
1783    use gpui::{AppContext as _, BackgroundExecutor, TestAppContext};
1784    use http_client::FakeHttpClient;
1785    use parking_lot::Mutex;
1786    use proto::TypedEnvelope;
1787    use settings::SettingsStore;
1788    use std::future;
1789
1790    #[gpui::test(iterations = 10)]
1791    async fn test_reconnection(cx: &mut TestAppContext) {
1792        init_test(cx);
1793        let user_id = 5;
1794        let client = cx.update(|cx| {
1795            Client::new(
1796                Arc::new(FakeSystemClock::new()),
1797                FakeHttpClient::with_404_response(),
1798                cx,
1799            )
1800        });
1801        let server = FakeServer::for_client(user_id, &client, cx).await;
1802        let mut status = client.status();
1803        assert!(matches!(
1804            status.next().await,
1805            Some(Status::Connected { .. })
1806        ));
1807        assert_eq!(server.auth_count(), 1);
1808
1809        server.forbid_connections();
1810        server.disconnect();
1811        while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1812
1813        server.allow_connections();
1814        cx.executor().advance_clock(Duration::from_secs(10));
1815        while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1816        assert_eq!(server.auth_count(), 1); // Client reused the cached credentials when reconnecting
1817
1818        server.forbid_connections();
1819        server.disconnect();
1820        while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1821
1822        // Clear cached credentials after authentication fails
1823        server.roll_access_token();
1824        server.allow_connections();
1825        cx.executor().run_until_parked();
1826        cx.executor().advance_clock(Duration::from_secs(10));
1827        while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1828        assert_eq!(server.auth_count(), 2); // Client re-authenticated due to an invalid token
1829    }
1830
1831    #[gpui::test(iterations = 10)]
1832    async fn test_auth_failure_during_reconnection(cx: &mut TestAppContext) {
1833        init_test(cx);
1834        let http_client = FakeHttpClient::with_200_response();
1835        let client =
1836            cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client.clone(), cx));
1837        let server = FakeServer::for_client(42, &client, cx).await;
1838        let mut status = client.status();
1839        assert!(matches!(
1840            status.next().await,
1841            Some(Status::Connected { .. })
1842        ));
1843        assert_eq!(server.auth_count(), 1);
1844
1845        // Simulate an auth failure during reconnection.
1846        http_client
1847            .as_fake()
1848            .replace_handler(|_, _request| async move {
1849                Ok(http_client::Response::builder()
1850                    .status(503)
1851                    .body("".into())
1852                    .unwrap())
1853            });
1854        server.disconnect();
1855        while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1856
1857        // Restore the ability to authenticate.
1858        http_client
1859            .as_fake()
1860            .replace_handler(|_, _request| async move {
1861                Ok(http_client::Response::builder()
1862                    .status(200)
1863                    .body("".into())
1864                    .unwrap())
1865            });
1866        cx.executor().advance_clock(Duration::from_secs(10));
1867        while !matches!(status.next().await, Some(Status::Connected { .. })) {}
1868        assert_eq!(server.auth_count(), 1); // Client reused the cached credentials when reconnecting
1869    }
1870
1871    #[gpui::test(iterations = 10)]
1872    async fn test_connection_timeout(executor: BackgroundExecutor, cx: &mut TestAppContext) {
1873        init_test(cx);
1874        let user_id = 5;
1875        let client = cx.update(|cx| {
1876            Client::new(
1877                Arc::new(FakeSystemClock::new()),
1878                FakeHttpClient::with_404_response(),
1879                cx,
1880            )
1881        });
1882        let mut status = client.status();
1883
1884        // Time out when client tries to connect.
1885        client.override_authenticate(move |cx| {
1886            cx.background_spawn(async move {
1887                Ok(Credentials {
1888                    user_id,
1889                    access_token: "token".into(),
1890                })
1891            })
1892        });
1893        client.override_establish_connection(|_, cx| {
1894            cx.background_spawn(async move {
1895                future::pending::<()>().await;
1896                unreachable!()
1897            })
1898        });
1899        let auth_and_connect = cx.spawn({
1900            let client = client.clone();
1901            |cx| async move { client.connect(false, &cx).await }
1902        });
1903        executor.run_until_parked();
1904        assert!(matches!(status.next().await, Some(Status::Connecting)));
1905
1906        executor.advance_clock(CONNECTION_TIMEOUT);
1907        assert!(matches!(status.next().await, Some(Status::ConnectionError)));
1908        auth_and_connect.await.into_response().unwrap_err();
1909
1910        // Allow the connection to be established.
1911        let server = FakeServer::for_client(user_id, &client, cx).await;
1912        assert!(matches!(
1913            status.next().await,
1914            Some(Status::Connected { .. })
1915        ));
1916
1917        // Disconnect client.
1918        server.forbid_connections();
1919        server.disconnect();
1920        while !matches!(status.next().await, Some(Status::ReconnectionError { .. })) {}
1921
1922        // Time out when re-establishing the connection.
1923        server.allow_connections();
1924        client.override_establish_connection(|_, cx| {
1925            cx.background_spawn(async move {
1926                future::pending::<()>().await;
1927                unreachable!()
1928            })
1929        });
1930        executor.advance_clock(2 * INITIAL_RECONNECTION_DELAY);
1931        assert!(matches!(status.next().await, Some(Status::Reconnecting)));
1932
1933        executor.advance_clock(CONNECTION_TIMEOUT);
1934        assert!(matches!(
1935            status.next().await,
1936            Some(Status::ReconnectionError { .. })
1937        ));
1938    }
1939
1940    #[gpui::test(iterations = 10)]
1941    async fn test_reauthenticate_only_if_unauthorized(cx: &mut TestAppContext) {
1942        init_test(cx);
1943        let auth_count = Arc::new(Mutex::new(0));
1944        let http_client = FakeHttpClient::create(|_request| async move {
1945            Ok(http_client::Response::builder()
1946                .status(200)
1947                .body("".into())
1948                .unwrap())
1949        });
1950        let client =
1951            cx.update(|cx| Client::new(Arc::new(FakeSystemClock::new()), http_client.clone(), cx));
1952        client.override_authenticate({
1953            let auth_count = auth_count.clone();
1954            move |cx| {
1955                let auth_count = auth_count.clone();
1956                cx.background_spawn(async move {
1957                    *auth_count.lock() += 1;
1958                    Ok(Credentials {
1959                        user_id: 1,
1960                        access_token: auth_count.lock().to_string(),
1961                    })
1962                })
1963            }
1964        });
1965
1966        let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
1967        assert_eq!(*auth_count.lock(), 1);
1968        assert_eq!(credentials.access_token, "1");
1969
1970        // If credentials are still valid, signing in doesn't trigger authentication.
1971        let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
1972        assert_eq!(*auth_count.lock(), 1);
1973        assert_eq!(credentials.access_token, "1");
1974
1975        // If the server is unavailable, signing in doesn't trigger authentication.
1976        http_client
1977            .as_fake()
1978            .replace_handler(|_, _request| async move {
1979                Ok(http_client::Response::builder()
1980                    .status(503)
1981                    .body("".into())
1982                    .unwrap())
1983            });
1984        client.sign_in(false, &cx.to_async()).await.unwrap_err();
1985        assert_eq!(*auth_count.lock(), 1);
1986
1987        // If credentials became invalid, signing in triggers authentication.
1988        http_client
1989            .as_fake()
1990            .replace_handler(|_, request| async move {
1991                let credentials = parse_authorization_header(&request).unwrap();
1992                if credentials.access_token == "2" {
1993                    Ok(http_client::Response::builder()
1994                        .status(200)
1995                        .body("".into())
1996                        .unwrap())
1997                } else {
1998                    Ok(http_client::Response::builder()
1999                        .status(401)
2000                        .body("".into())
2001                        .unwrap())
2002                }
2003            });
2004        let credentials = client.sign_in(false, &cx.to_async()).await.unwrap();
2005        assert_eq!(*auth_count.lock(), 2);
2006        assert_eq!(credentials.access_token, "2");
2007    }
2008
2009    #[gpui::test(iterations = 10)]
2010    async fn test_authenticating_more_than_once(
2011        cx: &mut TestAppContext,
2012        executor: BackgroundExecutor,
2013    ) {
2014        init_test(cx);
2015        let auth_count = Arc::new(Mutex::new(0));
2016        let dropped_auth_count = Arc::new(Mutex::new(0));
2017        let client = cx.update(|cx| {
2018            Client::new(
2019                Arc::new(FakeSystemClock::new()),
2020                FakeHttpClient::with_404_response(),
2021                cx,
2022            )
2023        });
2024        client.override_authenticate({
2025            let auth_count = auth_count.clone();
2026            let dropped_auth_count = dropped_auth_count.clone();
2027            move |cx| {
2028                let auth_count = auth_count.clone();
2029                let dropped_auth_count = dropped_auth_count.clone();
2030                cx.background_spawn(async move {
2031                    *auth_count.lock() += 1;
2032                    let _drop = util::defer(move || *dropped_auth_count.lock() += 1);
2033                    future::pending::<()>().await;
2034                    unreachable!()
2035                })
2036            }
2037        });
2038
2039        let _authenticate = cx.spawn({
2040            let client = client.clone();
2041            move |cx| async move { client.connect(false, &cx).await }
2042        });
2043        executor.run_until_parked();
2044        assert_eq!(*auth_count.lock(), 1);
2045        assert_eq!(*dropped_auth_count.lock(), 0);
2046
2047        let _authenticate = cx.spawn(|cx| async move { client.connect(false, &cx).await });
2048        executor.run_until_parked();
2049        assert_eq!(*auth_count.lock(), 2);
2050        assert_eq!(*dropped_auth_count.lock(), 1);
2051    }
2052
2053    #[gpui::test]
2054    async fn test_subscribing_to_entity(cx: &mut TestAppContext) {
2055        init_test(cx);
2056        let user_id = 5;
2057        let client = cx.update(|cx| {
2058            Client::new(
2059                Arc::new(FakeSystemClock::new()),
2060                FakeHttpClient::with_404_response(),
2061                cx,
2062            )
2063        });
2064        let server = FakeServer::for_client(user_id, &client, cx).await;
2065
2066        let (done_tx1, done_rx1) = smol::channel::unbounded();
2067        let (done_tx2, done_rx2) = smol::channel::unbounded();
2068        AnyProtoClient::from(client.clone()).add_entity_message_handler(
2069            move |entity: Entity<TestEntity>, _: TypedEnvelope<proto::JoinProject>, cx| {
2070                match entity.read_with(&cx, |entity, _| entity.id).unwrap() {
2071                    1 => done_tx1.try_send(()).unwrap(),
2072                    2 => done_tx2.try_send(()).unwrap(),
2073                    _ => unreachable!(),
2074                }
2075                async { Ok(()) }
2076            },
2077        );
2078        let entity1 = cx.new(|_| TestEntity {
2079            id: 1,
2080            subscription: None,
2081        });
2082        let entity2 = cx.new(|_| TestEntity {
2083            id: 2,
2084            subscription: None,
2085        });
2086        let entity3 = cx.new(|_| TestEntity {
2087            id: 3,
2088            subscription: None,
2089        });
2090
2091        let _subscription1 = client
2092            .subscribe_to_entity(1)
2093            .unwrap()
2094            .set_entity(&entity1, &cx.to_async());
2095        let _subscription2 = client
2096            .subscribe_to_entity(2)
2097            .unwrap()
2098            .set_entity(&entity2, &cx.to_async());
2099        // Ensure dropping a subscription for the same entity type still allows receiving of
2100        // messages for other entity IDs of the same type.
2101        let subscription3 = client
2102            .subscribe_to_entity(3)
2103            .unwrap()
2104            .set_entity(&entity3, &cx.to_async());
2105        drop(subscription3);
2106
2107        server.send(proto::JoinProject {
2108            project_id: 1,
2109            committer_name: None,
2110            committer_email: None,
2111        });
2112        server.send(proto::JoinProject {
2113            project_id: 2,
2114            committer_name: None,
2115            committer_email: None,
2116        });
2117        done_rx1.recv().await.unwrap();
2118        done_rx2.recv().await.unwrap();
2119    }
2120
2121    #[gpui::test]
2122    async fn test_subscribing_after_dropping_subscription(cx: &mut TestAppContext) {
2123        init_test(cx);
2124        let user_id = 5;
2125        let client = cx.update(|cx| {
2126            Client::new(
2127                Arc::new(FakeSystemClock::new()),
2128                FakeHttpClient::with_404_response(),
2129                cx,
2130            )
2131        });
2132        let server = FakeServer::for_client(user_id, &client, cx).await;
2133
2134        let entity = cx.new(|_| TestEntity::default());
2135        let (done_tx1, _done_rx1) = smol::channel::unbounded();
2136        let (done_tx2, done_rx2) = smol::channel::unbounded();
2137        let subscription1 = client.add_message_handler(
2138            entity.downgrade(),
2139            move |_, _: TypedEnvelope<proto::Ping>, _| {
2140                done_tx1.try_send(()).unwrap();
2141                async { Ok(()) }
2142            },
2143        );
2144        drop(subscription1);
2145        let _subscription2 = client.add_message_handler(
2146            entity.downgrade(),
2147            move |_, _: TypedEnvelope<proto::Ping>, _| {
2148                done_tx2.try_send(()).unwrap();
2149                async { Ok(()) }
2150            },
2151        );
2152        server.send(proto::Ping {});
2153        done_rx2.recv().await.unwrap();
2154    }
2155
2156    #[gpui::test]
2157    async fn test_dropping_subscription_in_handler(cx: &mut TestAppContext) {
2158        init_test(cx);
2159        let user_id = 5;
2160        let client = cx.update(|cx| {
2161            Client::new(
2162                Arc::new(FakeSystemClock::new()),
2163                FakeHttpClient::with_404_response(),
2164                cx,
2165            )
2166        });
2167        let server = FakeServer::for_client(user_id, &client, cx).await;
2168
2169        let entity = cx.new(|_| TestEntity::default());
2170        let (done_tx, done_rx) = smol::channel::unbounded();
2171        let subscription = client.add_message_handler(
2172            entity.clone().downgrade(),
2173            move |entity: Entity<TestEntity>, _: TypedEnvelope<proto::Ping>, mut cx| {
2174                entity
2175                    .update(&mut cx, |entity, _| entity.subscription.take())
2176                    .unwrap();
2177                done_tx.try_send(()).unwrap();
2178                async { Ok(()) }
2179            },
2180        );
2181        entity.update(cx, |entity, _| {
2182            entity.subscription = Some(subscription);
2183        });
2184        server.send(proto::Ping {});
2185        done_rx.recv().await.unwrap();
2186    }
2187
2188    #[derive(Default)]
2189    struct TestEntity {
2190        id: usize,
2191        subscription: Option<Subscription>,
2192    }
2193
2194    fn init_test(cx: &mut TestAppContext) {
2195        cx.update(|cx| {
2196            let settings_store = SettingsStore::test(cx);
2197            cx.set_global(settings_store);
2198            init_settings(cx);
2199        });
2200    }
2201}