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