rpc.rs

   1mod store;
   2
   3use crate::{
   4    auth,
   5    db::{self, ChannelId, MessageId, ProjectId, User, UserId},
   6    AppState, Result,
   7};
   8use anyhow::anyhow;
   9use async_tungstenite::tungstenite::{
  10    protocol::CloseFrame as TungsteniteCloseFrame, Message as TungsteniteMessage,
  11};
  12use axum::{
  13    body::Body,
  14    extract::{
  15        ws::{CloseFrame as AxumCloseFrame, Message as AxumMessage},
  16        ConnectInfo, WebSocketUpgrade,
  17    },
  18    headers::{Header, HeaderName},
  19    http::StatusCode,
  20    middleware,
  21    response::IntoResponse,
  22    routing::get,
  23    Extension, Router, TypedHeader,
  24};
  25use collections::{HashMap, HashSet};
  26use futures::{
  27    channel::{mpsc, oneshot},
  28    future::{self, BoxFuture},
  29    stream::FuturesUnordered,
  30    FutureExt, SinkExt, StreamExt, TryStreamExt,
  31};
  32use lazy_static::lazy_static;
  33use prometheus::{register_int_gauge, IntGauge};
  34use rpc::{
  35    proto::{self, AnyTypedEnvelope, EntityMessage, EnvelopedMessage, RequestMessage},
  36    Connection, ConnectionId, Peer, Receipt, TypedEnvelope,
  37};
  38use serde::{Serialize, Serializer};
  39use std::{
  40    any::TypeId,
  41    future::Future,
  42    marker::PhantomData,
  43    net::SocketAddr,
  44    ops::{Deref, DerefMut},
  45    os::unix::prelude::OsStrExt,
  46    rc::Rc,
  47    sync::{
  48        atomic::{AtomicBool, Ordering::SeqCst},
  49        Arc,
  50    },
  51    time::Duration,
  52};
  53pub use store::{Store, Worktree};
  54use time::OffsetDateTime;
  55use tokio::{
  56    sync::{Mutex, MutexGuard},
  57    time::Sleep,
  58};
  59use tower::ServiceBuilder;
  60use tracing::{info_span, instrument, Instrument};
  61
  62lazy_static! {
  63    static ref METRIC_CONNECTIONS: IntGauge =
  64        register_int_gauge!("connections", "number of connections").unwrap();
  65    static ref METRIC_REGISTERED_PROJECTS: IntGauge =
  66        register_int_gauge!("registered_projects", "number of registered projects").unwrap();
  67    static ref METRIC_ACTIVE_PROJECTS: IntGauge =
  68        register_int_gauge!("active_projects", "number of active projects").unwrap();
  69    static ref METRIC_SHARED_PROJECTS: IntGauge = register_int_gauge!(
  70        "shared_projects",
  71        "number of open projects with one or more guests"
  72    )
  73    .unwrap();
  74}
  75
  76type MessageHandler =
  77    Box<dyn Send + Sync + Fn(Arc<Server>, Box<dyn AnyTypedEnvelope>) -> BoxFuture<'static, ()>>;
  78
  79struct Response<R> {
  80    server: Arc<Server>,
  81    receipt: Receipt<R>,
  82    responded: Arc<AtomicBool>,
  83}
  84
  85impl<R: RequestMessage> Response<R> {
  86    fn send(self, payload: R::Response) -> Result<()> {
  87        self.responded.store(true, SeqCst);
  88        self.server.peer.respond(self.receipt, payload)?;
  89        Ok(())
  90    }
  91}
  92
  93pub struct Server {
  94    peer: Arc<Peer>,
  95    pub(crate) store: Mutex<Store>,
  96    app_state: Arc<AppState>,
  97    handlers: HashMap<TypeId, MessageHandler>,
  98    notifications: Option<mpsc::UnboundedSender<()>>,
  99}
 100
 101pub trait Executor: Send + Clone {
 102    type Sleep: Send + Future;
 103    fn spawn_detached<F: 'static + Send + Future<Output = ()>>(&self, future: F);
 104    fn sleep(&self, duration: Duration) -> Self::Sleep;
 105}
 106
 107#[derive(Clone)]
 108pub struct RealExecutor;
 109
 110const MESSAGE_COUNT_PER_PAGE: usize = 100;
 111const MAX_MESSAGE_LEN: usize = 1024;
 112
 113pub(crate) struct StoreGuard<'a> {
 114    guard: MutexGuard<'a, Store>,
 115    _not_send: PhantomData<Rc<()>>,
 116}
 117
 118#[derive(Serialize)]
 119pub struct ServerSnapshot<'a> {
 120    peer: &'a Peer,
 121    #[serde(serialize_with = "serialize_deref")]
 122    store: StoreGuard<'a>,
 123}
 124
 125pub fn serialize_deref<S, T, U>(value: &T, serializer: S) -> Result<S::Ok, S::Error>
 126where
 127    S: Serializer,
 128    T: Deref<Target = U>,
 129    U: Serialize,
 130{
 131    Serialize::serialize(value.deref(), serializer)
 132}
 133
 134impl Server {
 135    pub fn new(
 136        app_state: Arc<AppState>,
 137        notifications: Option<mpsc::UnboundedSender<()>>,
 138    ) -> Arc<Self> {
 139        let mut server = Self {
 140            peer: Peer::new(),
 141            app_state,
 142            store: Default::default(),
 143            handlers: Default::default(),
 144            notifications,
 145        };
 146
 147        server
 148            .add_request_handler(Server::ping)
 149            .add_request_handler(Server::create_room)
 150            .add_request_handler(Server::join_room)
 151            .add_message_handler(Server::leave_room)
 152            .add_request_handler(Server::call)
 153            .add_request_handler(Server::cancel_call)
 154            .add_message_handler(Server::decline_call)
 155            .add_request_handler(Server::update_participant_location)
 156            .add_request_handler(Server::share_project)
 157            .add_message_handler(Server::unshare_project)
 158            .add_request_handler(Server::join_project)
 159            .add_message_handler(Server::leave_project)
 160            .add_message_handler(Server::update_project)
 161            .add_message_handler(Server::register_project_activity)
 162            .add_request_handler(Server::update_worktree)
 163            .add_message_handler(Server::update_worktree_extensions)
 164            .add_message_handler(Server::start_language_server)
 165            .add_message_handler(Server::update_language_server)
 166            .add_message_handler(Server::update_diagnostic_summary)
 167            .add_request_handler(Server::forward_project_request::<proto::GetHover>)
 168            .add_request_handler(Server::forward_project_request::<proto::GetDefinition>)
 169            .add_request_handler(Server::forward_project_request::<proto::GetTypeDefinition>)
 170            .add_request_handler(Server::forward_project_request::<proto::GetReferences>)
 171            .add_request_handler(Server::forward_project_request::<proto::SearchProject>)
 172            .add_request_handler(Server::forward_project_request::<proto::GetDocumentHighlights>)
 173            .add_request_handler(Server::forward_project_request::<proto::GetProjectSymbols>)
 174            .add_request_handler(Server::forward_project_request::<proto::OpenBufferForSymbol>)
 175            .add_request_handler(Server::forward_project_request::<proto::OpenBufferById>)
 176            .add_request_handler(Server::forward_project_request::<proto::OpenBufferByPath>)
 177            .add_request_handler(Server::forward_project_request::<proto::GetCompletions>)
 178            .add_request_handler(
 179                Server::forward_project_request::<proto::ApplyCompletionAdditionalEdits>,
 180            )
 181            .add_request_handler(Server::forward_project_request::<proto::GetCodeActions>)
 182            .add_request_handler(Server::forward_project_request::<proto::ApplyCodeAction>)
 183            .add_request_handler(Server::forward_project_request::<proto::PrepareRename>)
 184            .add_request_handler(Server::forward_project_request::<proto::PerformRename>)
 185            .add_request_handler(Server::forward_project_request::<proto::ReloadBuffers>)
 186            .add_request_handler(Server::forward_project_request::<proto::FormatBuffers>)
 187            .add_request_handler(Server::forward_project_request::<proto::CreateProjectEntry>)
 188            .add_request_handler(Server::forward_project_request::<proto::RenameProjectEntry>)
 189            .add_request_handler(Server::forward_project_request::<proto::CopyProjectEntry>)
 190            .add_request_handler(Server::forward_project_request::<proto::DeleteProjectEntry>)
 191            .add_message_handler(Server::create_buffer_for_peer)
 192            .add_request_handler(Server::update_buffer)
 193            .add_message_handler(Server::update_buffer_file)
 194            .add_message_handler(Server::buffer_reloaded)
 195            .add_message_handler(Server::buffer_saved)
 196            .add_request_handler(Server::save_buffer)
 197            .add_request_handler(Server::get_channels)
 198            .add_request_handler(Server::get_users)
 199            .add_request_handler(Server::fuzzy_search_users)
 200            .add_request_handler(Server::request_contact)
 201            .add_request_handler(Server::remove_contact)
 202            .add_request_handler(Server::respond_to_contact_request)
 203            .add_request_handler(Server::join_channel)
 204            .add_message_handler(Server::leave_channel)
 205            .add_request_handler(Server::send_channel_message)
 206            .add_request_handler(Server::follow)
 207            .add_message_handler(Server::unfollow)
 208            .add_message_handler(Server::update_followers)
 209            .add_request_handler(Server::get_channel_messages)
 210            .add_message_handler(Server::update_diff_base)
 211            .add_request_handler(Server::get_private_user_info);
 212
 213        Arc::new(server)
 214    }
 215
 216    fn add_message_handler<F, Fut, M>(&mut self, handler: F) -> &mut Self
 217    where
 218        F: 'static + Send + Sync + Fn(Arc<Self>, TypedEnvelope<M>) -> Fut,
 219        Fut: 'static + Send + Future<Output = Result<()>>,
 220        M: EnvelopedMessage,
 221    {
 222        let prev_handler = self.handlers.insert(
 223            TypeId::of::<M>(),
 224            Box::new(move |server, envelope| {
 225                let envelope = envelope.into_any().downcast::<TypedEnvelope<M>>().unwrap();
 226                let span = info_span!(
 227                    "handle message",
 228                    payload_type = envelope.payload_type_name()
 229                );
 230                span.in_scope(|| {
 231                    tracing::info!(
 232                        payload_type = envelope.payload_type_name(),
 233                        "message received"
 234                    );
 235                });
 236                let future = (handler)(server, *envelope);
 237                async move {
 238                    if let Err(error) = future.await {
 239                        tracing::error!(%error, "error handling message");
 240                    }
 241                }
 242                .instrument(span)
 243                .boxed()
 244            }),
 245        );
 246        if prev_handler.is_some() {
 247            panic!("registered a handler for the same message twice");
 248        }
 249        self
 250    }
 251
 252    /// Handle a request while holding a lock to the store. This is useful when we're registering
 253    /// a connection but we want to respond on the connection before anybody else can send on it.
 254    fn add_request_handler<F, Fut, M>(&mut self, handler: F) -> &mut Self
 255    where
 256        F: 'static + Send + Sync + Fn(Arc<Self>, TypedEnvelope<M>, Response<M>) -> Fut,
 257        Fut: Send + Future<Output = Result<()>>,
 258        M: RequestMessage,
 259    {
 260        let handler = Arc::new(handler);
 261        self.add_message_handler(move |server, envelope| {
 262            let receipt = envelope.receipt();
 263            let handler = handler.clone();
 264            async move {
 265                let responded = Arc::new(AtomicBool::default());
 266                let response = Response {
 267                    server: server.clone(),
 268                    responded: responded.clone(),
 269                    receipt: envelope.receipt(),
 270                };
 271                match (handler)(server.clone(), envelope, response).await {
 272                    Ok(()) => {
 273                        if responded.load(std::sync::atomic::Ordering::SeqCst) {
 274                            Ok(())
 275                        } else {
 276                            Err(anyhow!("handler did not send a response"))?
 277                        }
 278                    }
 279                    Err(error) => {
 280                        server.peer.respond_with_error(
 281                            receipt,
 282                            proto::Error {
 283                                message: error.to_string(),
 284                            },
 285                        )?;
 286                        Err(error)
 287                    }
 288                }
 289            }
 290        })
 291    }
 292
 293    /// Start a long lived task that records which users are active in which projects.
 294    pub fn start_recording_project_activity<E: 'static + Executor>(
 295        self: &Arc<Self>,
 296        interval: Duration,
 297        executor: E,
 298    ) {
 299        executor.spawn_detached({
 300            let this = Arc::downgrade(self);
 301            let executor = executor.clone();
 302            async move {
 303                let mut period_start = OffsetDateTime::now_utc();
 304                let mut active_projects = Vec::<(UserId, ProjectId)>::new();
 305                loop {
 306                    let sleep = executor.sleep(interval);
 307                    sleep.await;
 308                    let this = if let Some(this) = this.upgrade() {
 309                        this
 310                    } else {
 311                        break;
 312                    };
 313
 314                    active_projects.clear();
 315                    active_projects.extend(this.store().await.projects().flat_map(
 316                        |(project_id, project)| {
 317                            project.guests.values().chain([&project.host]).filter_map(
 318                                |collaborator| {
 319                                    if !collaborator.admin
 320                                        && collaborator
 321                                            .last_activity
 322                                            .map_or(false, |activity| activity > period_start)
 323                                    {
 324                                        Some((collaborator.user_id, *project_id))
 325                                    } else {
 326                                        None
 327                                    }
 328                                },
 329                            )
 330                        },
 331                    ));
 332
 333                    let period_end = OffsetDateTime::now_utc();
 334                    this.app_state
 335                        .db
 336                        .record_user_activity(period_start..period_end, &active_projects)
 337                        .await
 338                        .trace_err();
 339                    period_start = period_end;
 340                }
 341            }
 342        });
 343    }
 344
 345    pub fn handle_connection<E: Executor>(
 346        self: &Arc<Self>,
 347        connection: Connection,
 348        address: String,
 349        user: User,
 350        mut send_connection_id: Option<oneshot::Sender<ConnectionId>>,
 351        executor: E,
 352    ) -> impl Future<Output = Result<()>> {
 353        let mut this = self.clone();
 354        let user_id = user.id;
 355        let login = user.github_login;
 356        let span = info_span!("handle connection", %user_id, %login, %address);
 357        async move {
 358            let (connection_id, handle_io, mut incoming_rx) = this
 359                .peer
 360                .add_connection(connection, {
 361                    let executor = executor.clone();
 362                    move |duration| {
 363                        let timer = executor.sleep(duration);
 364                        async move {
 365                            timer.await;
 366                        }
 367                    }
 368                });
 369
 370            tracing::info!(%user_id, %login, %connection_id, %address, "connection opened");
 371            this.peer.send(connection_id, proto::Hello { peer_id: connection_id.0 })?;
 372            tracing::info!(%user_id, %login, %connection_id, %address, "sent hello message");
 373
 374            if let Some(send_connection_id) = send_connection_id.take() {
 375                let _ = send_connection_id.send(connection_id);
 376            }
 377
 378            if !user.connected_once {
 379                this.peer.send(connection_id, proto::ShowContacts {})?;
 380                this.app_state.db.set_user_connected_once(user_id, true).await?;
 381            }
 382
 383            let (contacts, invite_code) = future::try_join(
 384                this.app_state.db.get_contacts(user_id),
 385                this.app_state.db.get_invite_code_for_user(user_id)
 386            ).await?;
 387
 388            {
 389                let mut store = this.store().await;
 390                let incoming_call = store.add_connection(connection_id, user_id, user.admin);
 391                if let Some(incoming_call) = incoming_call {
 392                    this.peer.send(connection_id, incoming_call)?;
 393                }
 394
 395                this.peer.send(connection_id, store.build_initial_contacts_update(contacts))?;
 396
 397                if let Some((code, count)) = invite_code {
 398                    this.peer.send(connection_id, proto::UpdateInviteInfo {
 399                        url: format!("{}{}", this.app_state.config.invite_link_prefix, code),
 400                        count,
 401                    })?;
 402                }
 403            }
 404            this.update_user_contacts(user_id).await?;
 405
 406            let handle_io = handle_io.fuse();
 407            futures::pin_mut!(handle_io);
 408
 409            // Handlers for foreground messages are pushed into the following `FuturesUnordered`.
 410            // This prevents deadlocks when e.g., client A performs a request to client B and
 411            // client B performs a request to client A. If both clients stop processing further
 412            // messages until their respective request completes, they won't have a chance to
 413            // respond to the other client's request and cause a deadlock.
 414            //
 415            // This arrangement ensures we will attempt to process earlier messages first, but fall
 416            // back to processing messages arrived later in the spirit of making progress.
 417            let mut foreground_message_handlers = FuturesUnordered::new();
 418            loop {
 419                let next_message = incoming_rx.next().fuse();
 420                futures::pin_mut!(next_message);
 421                futures::select_biased! {
 422                    result = handle_io => {
 423                        if let Err(error) = result {
 424                            tracing::error!(?error, %user_id, %login, %connection_id, %address, "error handling I/O");
 425                        }
 426                        break;
 427                    }
 428                    _ = foreground_message_handlers.next() => {}
 429                    message = next_message => {
 430                        if let Some(message) = message {
 431                            let type_name = message.payload_type_name();
 432                            let span = tracing::info_span!("receive message", %user_id, %login, %connection_id, %address, type_name);
 433                            let span_enter = span.enter();
 434                            if let Some(handler) = this.handlers.get(&message.payload_type_id()) {
 435                                let notifications = this.notifications.clone();
 436                                let is_background = message.is_background();
 437                                let handle_message = (handler)(this.clone(), message);
 438
 439                                drop(span_enter);
 440                                let handle_message = async move {
 441                                    handle_message.await;
 442                                    if let Some(mut notifications) = notifications {
 443                                        let _ = notifications.send(()).await;
 444                                    }
 445                                }.instrument(span);
 446
 447                                if is_background {
 448                                    executor.spawn_detached(handle_message);
 449                                } else {
 450                                    foreground_message_handlers.push(handle_message);
 451                                }
 452                            } else {
 453                                tracing::error!(%user_id, %login, %connection_id, %address, "no message handler");
 454                            }
 455                        } else {
 456                            tracing::info!(%user_id, %login, %connection_id, %address, "connection closed");
 457                            break;
 458                        }
 459                    }
 460                }
 461            }
 462
 463            drop(foreground_message_handlers);
 464            tracing::info!(%user_id, %login, %connection_id, %address, "signing out");
 465            if let Err(error) = this.sign_out(connection_id).await {
 466                tracing::error!(%user_id, %login, %connection_id, %address, ?error, "error signing out");
 467            }
 468
 469            Ok(())
 470        }.instrument(span)
 471    }
 472
 473    #[instrument(skip(self), err)]
 474    async fn sign_out(self: &mut Arc<Self>, connection_id: ConnectionId) -> Result<()> {
 475        self.peer.disconnect(connection_id);
 476
 477        let mut projects_to_unshare = Vec::new();
 478        let mut contacts_to_update = HashSet::default();
 479        let mut room_left = None;
 480        {
 481            let mut store = self.store().await;
 482
 483            #[cfg(test)]
 484            let removed_connection = store.remove_connection(connection_id).unwrap();
 485            #[cfg(not(test))]
 486            let removed_connection = store.remove_connection(connection_id)?;
 487
 488            for project in removed_connection.hosted_projects {
 489                projects_to_unshare.push(project.id);
 490                broadcast(connection_id, project.guests.keys().copied(), |conn_id| {
 491                    self.peer.send(
 492                        conn_id,
 493                        proto::UnshareProject {
 494                            project_id: project.id.to_proto(),
 495                        },
 496                    )
 497                });
 498            }
 499
 500            for project in removed_connection.guest_projects {
 501                broadcast(connection_id, project.connection_ids, |conn_id| {
 502                    self.peer.send(
 503                        conn_id,
 504                        proto::RemoveProjectCollaborator {
 505                            project_id: project.id.to_proto(),
 506                            peer_id: connection_id.0,
 507                        },
 508                    )
 509                });
 510            }
 511
 512            if let Some(room) = removed_connection.room {
 513                self.room_updated(&room);
 514                room_left = Some(self.room_left(&room, connection_id));
 515            }
 516
 517            contacts_to_update.insert(removed_connection.user_id);
 518            for connection_id in removed_connection.canceled_call_connection_ids {
 519                self.peer
 520                    .send(connection_id, proto::CallCanceled {})
 521                    .trace_err();
 522                contacts_to_update.extend(store.user_id_for_connection(connection_id).ok());
 523            }
 524        };
 525
 526        if let Some(room_left) = room_left {
 527            room_left.await.trace_err();
 528        }
 529
 530        for user_id in contacts_to_update {
 531            self.update_user_contacts(user_id).await.trace_err();
 532        }
 533
 534        for project_id in projects_to_unshare {
 535            self.app_state
 536                .db
 537                .unregister_project(project_id)
 538                .await
 539                .trace_err();
 540        }
 541
 542        Ok(())
 543    }
 544
 545    pub async fn invite_code_redeemed(
 546        self: &Arc<Self>,
 547        inviter_id: UserId,
 548        invitee_id: UserId,
 549    ) -> Result<()> {
 550        if let Some(user) = self.app_state.db.get_user_by_id(inviter_id).await? {
 551            if let Some(code) = &user.invite_code {
 552                let store = self.store().await;
 553                let invitee_contact = store.contact_for_user(invitee_id, true);
 554                for connection_id in store.connection_ids_for_user(inviter_id) {
 555                    self.peer.send(
 556                        connection_id,
 557                        proto::UpdateContacts {
 558                            contacts: vec![invitee_contact.clone()],
 559                            ..Default::default()
 560                        },
 561                    )?;
 562                    self.peer.send(
 563                        connection_id,
 564                        proto::UpdateInviteInfo {
 565                            url: format!("{}{}", self.app_state.config.invite_link_prefix, &code),
 566                            count: user.invite_count as u32,
 567                        },
 568                    )?;
 569                }
 570            }
 571        }
 572        Ok(())
 573    }
 574
 575    pub async fn invite_count_updated(self: &Arc<Self>, user_id: UserId) -> Result<()> {
 576        if let Some(user) = self.app_state.db.get_user_by_id(user_id).await? {
 577            if let Some(invite_code) = &user.invite_code {
 578                let store = self.store().await;
 579                for connection_id in store.connection_ids_for_user(user_id) {
 580                    self.peer.send(
 581                        connection_id,
 582                        proto::UpdateInviteInfo {
 583                            url: format!(
 584                                "{}{}",
 585                                self.app_state.config.invite_link_prefix, invite_code
 586                            ),
 587                            count: user.invite_count as u32,
 588                        },
 589                    )?;
 590                }
 591            }
 592        }
 593        Ok(())
 594    }
 595
 596    async fn ping(
 597        self: Arc<Server>,
 598        _: TypedEnvelope<proto::Ping>,
 599        response: Response<proto::Ping>,
 600    ) -> Result<()> {
 601        response.send(proto::Ack {})?;
 602        Ok(())
 603    }
 604
 605    async fn create_room(
 606        self: Arc<Server>,
 607        request: TypedEnvelope<proto::CreateRoom>,
 608        response: Response<proto::CreateRoom>,
 609    ) -> Result<()> {
 610        let user_id;
 611        let room;
 612        {
 613            let mut store = self.store().await;
 614            user_id = store.user_id_for_connection(request.sender_id)?;
 615            room = store.create_room(request.sender_id)?.clone();
 616        }
 617
 618        let live_kit_connection_info =
 619            if let Some(live_kit) = self.app_state.live_kit_client.as_ref() {
 620                if let Some(_) = live_kit
 621                    .create_room(room.live_kit_room.clone())
 622                    .await
 623                    .trace_err()
 624                {
 625                    if let Some(token) = live_kit
 626                        .room_token(&room.live_kit_room, &request.sender_id.to_string())
 627                        .trace_err()
 628                    {
 629                        Some(proto::LiveKitConnectionInfo {
 630                            server_url: live_kit.url().into(),
 631                            token,
 632                        })
 633                    } else {
 634                        None
 635                    }
 636                } else {
 637                    None
 638                }
 639            } else {
 640                None
 641            };
 642
 643        response.send(proto::CreateRoomResponse {
 644            room: Some(room),
 645            live_kit_connection_info,
 646        })?;
 647        self.update_user_contacts(user_id).await?;
 648        Ok(())
 649    }
 650
 651    async fn join_room(
 652        self: Arc<Server>,
 653        request: TypedEnvelope<proto::JoinRoom>,
 654        response: Response<proto::JoinRoom>,
 655    ) -> Result<()> {
 656        let user_id;
 657        {
 658            let mut store = self.store().await;
 659            user_id = store.user_id_for_connection(request.sender_id)?;
 660            let (room, recipient_connection_ids) =
 661                store.join_room(request.payload.id, request.sender_id)?;
 662            for recipient_id in recipient_connection_ids {
 663                self.peer
 664                    .send(recipient_id, proto::CallCanceled {})
 665                    .trace_err();
 666            }
 667
 668            let live_kit_connection_info =
 669                if let Some(live_kit) = self.app_state.live_kit_client.as_ref() {
 670                    if let Some(token) = live_kit
 671                        .room_token(&room.live_kit_room, &request.sender_id.to_string())
 672                        .trace_err()
 673                    {
 674                        Some(proto::LiveKitConnectionInfo {
 675                            server_url: live_kit.url().into(),
 676                            token,
 677                        })
 678                    } else {
 679                        None
 680                    }
 681                } else {
 682                    None
 683                };
 684
 685            response.send(proto::JoinRoomResponse {
 686                room: Some(room.clone()),
 687                live_kit_connection_info,
 688            })?;
 689            self.room_updated(room);
 690        }
 691        self.update_user_contacts(user_id).await?;
 692        Ok(())
 693    }
 694
 695    async fn leave_room(self: Arc<Server>, message: TypedEnvelope<proto::LeaveRoom>) -> Result<()> {
 696        let mut contacts_to_update = HashSet::default();
 697        let room_left;
 698        {
 699            let mut store = self.store().await;
 700            let user_id = store.user_id_for_connection(message.sender_id)?;
 701            let left_room = store.leave_room(message.payload.id, message.sender_id)?;
 702            contacts_to_update.insert(user_id);
 703
 704            for project in left_room.unshared_projects {
 705                for connection_id in project.connection_ids() {
 706                    self.peer.send(
 707                        connection_id,
 708                        proto::UnshareProject {
 709                            project_id: project.id.to_proto(),
 710                        },
 711                    )?;
 712                }
 713            }
 714
 715            for project in left_room.left_projects {
 716                if project.remove_collaborator {
 717                    for connection_id in project.connection_ids {
 718                        self.peer.send(
 719                            connection_id,
 720                            proto::RemoveProjectCollaborator {
 721                                project_id: project.id.to_proto(),
 722                                peer_id: message.sender_id.0,
 723                            },
 724                        )?;
 725                    }
 726
 727                    self.peer.send(
 728                        message.sender_id,
 729                        proto::UnshareProject {
 730                            project_id: project.id.to_proto(),
 731                        },
 732                    )?;
 733                }
 734            }
 735
 736            self.room_updated(&left_room.room);
 737            room_left = self.room_left(&left_room.room, message.sender_id);
 738
 739            for connection_id in left_room.canceled_call_connection_ids {
 740                self.peer
 741                    .send(connection_id, proto::CallCanceled {})
 742                    .trace_err();
 743                contacts_to_update.extend(store.user_id_for_connection(connection_id).ok());
 744            }
 745        }
 746
 747        room_left.await.trace_err();
 748        for user_id in contacts_to_update {
 749            self.update_user_contacts(user_id).await?;
 750        }
 751
 752        Ok(())
 753    }
 754
 755    async fn call(
 756        self: Arc<Server>,
 757        request: TypedEnvelope<proto::Call>,
 758        response: Response<proto::Call>,
 759    ) -> Result<()> {
 760        let caller_user_id = self
 761            .store()
 762            .await
 763            .user_id_for_connection(request.sender_id)?;
 764        let recipient_user_id = UserId::from_proto(request.payload.recipient_user_id);
 765        let initial_project_id = request
 766            .payload
 767            .initial_project_id
 768            .map(ProjectId::from_proto);
 769        if !self
 770            .app_state
 771            .db
 772            .has_contact(caller_user_id, recipient_user_id)
 773            .await?
 774        {
 775            return Err(anyhow!("cannot call a user who isn't a contact"))?;
 776        }
 777
 778        let room_id = request.payload.room_id;
 779        let mut calls = {
 780            let mut store = self.store().await;
 781            let (room, recipient_connection_ids, incoming_call) = store.call(
 782                room_id,
 783                recipient_user_id,
 784                initial_project_id,
 785                request.sender_id,
 786            )?;
 787            self.room_updated(room);
 788            recipient_connection_ids
 789                .into_iter()
 790                .map(|recipient_connection_id| {
 791                    self.peer
 792                        .request(recipient_connection_id, incoming_call.clone())
 793                })
 794                .collect::<FuturesUnordered<_>>()
 795        };
 796        self.update_user_contacts(recipient_user_id).await?;
 797
 798        while let Some(call_response) = calls.next().await {
 799            match call_response.as_ref() {
 800                Ok(_) => {
 801                    response.send(proto::Ack {})?;
 802                    return Ok(());
 803                }
 804                Err(_) => {
 805                    call_response.trace_err();
 806                }
 807            }
 808        }
 809
 810        {
 811            let mut store = self.store().await;
 812            let room = store.call_failed(room_id, recipient_user_id)?;
 813            self.room_updated(&room);
 814        }
 815        self.update_user_contacts(recipient_user_id).await?;
 816
 817        Err(anyhow!("failed to ring call recipient"))?
 818    }
 819
 820    async fn cancel_call(
 821        self: Arc<Server>,
 822        request: TypedEnvelope<proto::CancelCall>,
 823        response: Response<proto::CancelCall>,
 824    ) -> Result<()> {
 825        let recipient_user_id = UserId::from_proto(request.payload.recipient_user_id);
 826        {
 827            let mut store = self.store().await;
 828            let (room, recipient_connection_ids) = store.cancel_call(
 829                request.payload.room_id,
 830                recipient_user_id,
 831                request.sender_id,
 832            )?;
 833            for recipient_id in recipient_connection_ids {
 834                self.peer
 835                    .send(recipient_id, proto::CallCanceled {})
 836                    .trace_err();
 837            }
 838            self.room_updated(room);
 839            response.send(proto::Ack {})?;
 840        }
 841        self.update_user_contacts(recipient_user_id).await?;
 842        Ok(())
 843    }
 844
 845    async fn decline_call(
 846        self: Arc<Server>,
 847        message: TypedEnvelope<proto::DeclineCall>,
 848    ) -> Result<()> {
 849        let recipient_user_id;
 850        {
 851            let mut store = self.store().await;
 852            recipient_user_id = store.user_id_for_connection(message.sender_id)?;
 853            let (room, recipient_connection_ids) =
 854                store.decline_call(message.payload.room_id, message.sender_id)?;
 855            for recipient_id in recipient_connection_ids {
 856                self.peer
 857                    .send(recipient_id, proto::CallCanceled {})
 858                    .trace_err();
 859            }
 860            self.room_updated(room);
 861        }
 862        self.update_user_contacts(recipient_user_id).await?;
 863        Ok(())
 864    }
 865
 866    async fn update_participant_location(
 867        self: Arc<Server>,
 868        request: TypedEnvelope<proto::UpdateParticipantLocation>,
 869        response: Response<proto::UpdateParticipantLocation>,
 870    ) -> Result<()> {
 871        let room_id = request.payload.room_id;
 872        let location = request
 873            .payload
 874            .location
 875            .ok_or_else(|| anyhow!("invalid location"))?;
 876        let mut store = self.store().await;
 877        let room = store.update_participant_location(room_id, location, request.sender_id)?;
 878        self.room_updated(room);
 879        response.send(proto::Ack {})?;
 880        Ok(())
 881    }
 882
 883    fn room_updated(&self, room: &proto::Room) {
 884        for participant in &room.participants {
 885            self.peer
 886                .send(
 887                    ConnectionId(participant.peer_id),
 888                    proto::RoomUpdated {
 889                        room: Some(room.clone()),
 890                    },
 891                )
 892                .trace_err();
 893        }
 894    }
 895
 896    fn room_left(
 897        &self,
 898        room: &proto::Room,
 899        connection_id: ConnectionId,
 900    ) -> impl Future<Output = Result<()>> {
 901        let client = self.app_state.live_kit_client.clone();
 902        let room_name = room.live_kit_room.clone();
 903        let participant_count = room.participants.len();
 904        async move {
 905            if let Some(client) = client {
 906                client
 907                    .remove_participant(room_name.clone(), connection_id.to_string())
 908                    .await?;
 909
 910                if participant_count == 0 {
 911                    client.delete_room(room_name).await?;
 912                }
 913            }
 914
 915            Ok(())
 916        }
 917    }
 918
 919    async fn share_project(
 920        self: Arc<Server>,
 921        request: TypedEnvelope<proto::ShareProject>,
 922        response: Response<proto::ShareProject>,
 923    ) -> Result<()> {
 924        let user_id = self
 925            .store()
 926            .await
 927            .user_id_for_connection(request.sender_id)?;
 928        let project_id = self.app_state.db.register_project(user_id).await?;
 929        let mut store = self.store().await;
 930        let room = store.share_project(
 931            request.payload.room_id,
 932            project_id,
 933            request.payload.worktrees,
 934            request.sender_id,
 935        )?;
 936        response.send(proto::ShareProjectResponse {
 937            project_id: project_id.to_proto(),
 938        })?;
 939        self.room_updated(room);
 940
 941        Ok(())
 942    }
 943
 944    async fn unshare_project(
 945        self: Arc<Server>,
 946        message: TypedEnvelope<proto::UnshareProject>,
 947    ) -> Result<()> {
 948        let project_id = ProjectId::from_proto(message.payload.project_id);
 949        let mut store = self.store().await;
 950        let (room, project) = store.unshare_project(project_id, message.sender_id)?;
 951        broadcast(
 952            message.sender_id,
 953            project.guest_connection_ids(),
 954            |conn_id| self.peer.send(conn_id, message.payload.clone()),
 955        );
 956        self.room_updated(room);
 957
 958        Ok(())
 959    }
 960
 961    async fn update_user_contacts(self: &Arc<Server>, user_id: UserId) -> Result<()> {
 962        let contacts = self.app_state.db.get_contacts(user_id).await?;
 963        let store = self.store().await;
 964        let updated_contact = store.contact_for_user(user_id, false);
 965        for contact in contacts {
 966            if let db::Contact::Accepted {
 967                user_id: contact_user_id,
 968                ..
 969            } = contact
 970            {
 971                for contact_conn_id in store.connection_ids_for_user(contact_user_id) {
 972                    self.peer
 973                        .send(
 974                            contact_conn_id,
 975                            proto::UpdateContacts {
 976                                contacts: vec![updated_contact.clone()],
 977                                remove_contacts: Default::default(),
 978                                incoming_requests: Default::default(),
 979                                remove_incoming_requests: Default::default(),
 980                                outgoing_requests: Default::default(),
 981                                remove_outgoing_requests: Default::default(),
 982                            },
 983                        )
 984                        .trace_err();
 985                }
 986            }
 987        }
 988        Ok(())
 989    }
 990
 991    async fn join_project(
 992        self: Arc<Server>,
 993        request: TypedEnvelope<proto::JoinProject>,
 994        response: Response<proto::JoinProject>,
 995    ) -> Result<()> {
 996        let project_id = ProjectId::from_proto(request.payload.project_id);
 997
 998        let host_user_id;
 999        let guest_user_id;
1000        let host_connection_id;
1001        {
1002            let state = self.store().await;
1003            let project = state.project(project_id)?;
1004            host_user_id = project.host.user_id;
1005            host_connection_id = project.host_connection_id;
1006            guest_user_id = state.user_id_for_connection(request.sender_id)?;
1007        };
1008
1009        tracing::info!(%project_id, %host_user_id, %host_connection_id, "join project");
1010
1011        let mut store = self.store().await;
1012        let (project, replica_id) = store.join_project(request.sender_id, project_id)?;
1013        let peer_count = project.guests.len();
1014        let mut collaborators = Vec::with_capacity(peer_count);
1015        collaborators.push(proto::Collaborator {
1016            peer_id: project.host_connection_id.0,
1017            replica_id: 0,
1018            user_id: project.host.user_id.to_proto(),
1019        });
1020        let worktrees = project
1021            .worktrees
1022            .iter()
1023            .map(|(id, worktree)| proto::WorktreeMetadata {
1024                id: *id,
1025                root_name: worktree.root_name.clone(),
1026                visible: worktree.visible,
1027                abs_path: worktree.abs_path.as_os_str().as_bytes().to_vec(),
1028            })
1029            .collect::<Vec<_>>();
1030
1031        // Add all guests other than the requesting user's own connections as collaborators
1032        for (guest_conn_id, guest) in &project.guests {
1033            if request.sender_id != *guest_conn_id {
1034                collaborators.push(proto::Collaborator {
1035                    peer_id: guest_conn_id.0,
1036                    replica_id: guest.replica_id as u32,
1037                    user_id: guest.user_id.to_proto(),
1038                });
1039            }
1040        }
1041
1042        for conn_id in project.connection_ids() {
1043            if conn_id != request.sender_id {
1044                self.peer
1045                    .send(
1046                        conn_id,
1047                        proto::AddProjectCollaborator {
1048                            project_id: project_id.to_proto(),
1049                            collaborator: Some(proto::Collaborator {
1050                                peer_id: request.sender_id.0,
1051                                replica_id: replica_id as u32,
1052                                user_id: guest_user_id.to_proto(),
1053                            }),
1054                        },
1055                    )
1056                    .trace_err();
1057            }
1058        }
1059
1060        // First, we send the metadata associated with each worktree.
1061        response.send(proto::JoinProjectResponse {
1062            worktrees: worktrees.clone(),
1063            replica_id: replica_id as u32,
1064            collaborators: collaborators.clone(),
1065            language_servers: project.language_servers.clone(),
1066        })?;
1067
1068        for (worktree_id, worktree) in &project.worktrees {
1069            #[cfg(any(test, feature = "test-support"))]
1070            const MAX_CHUNK_SIZE: usize = 2;
1071            #[cfg(not(any(test, feature = "test-support")))]
1072            const MAX_CHUNK_SIZE: usize = 256;
1073
1074            // Stream this worktree's entries.
1075            let message = proto::UpdateWorktree {
1076                project_id: project_id.to_proto(),
1077                worktree_id: *worktree_id,
1078                abs_path: worktree.abs_path.as_os_str().as_bytes().to_vec(),
1079                root_name: worktree.root_name.clone(),
1080                updated_entries: worktree.entries.values().cloned().collect(),
1081                removed_entries: Default::default(),
1082                scan_id: worktree.scan_id,
1083                is_last_update: worktree.is_complete,
1084            };
1085            for update in proto::split_worktree_update(message, MAX_CHUNK_SIZE) {
1086                self.peer.send(request.sender_id, update.clone())?;
1087            }
1088
1089            // Stream this worktree's diagnostics.
1090            for summary in worktree.diagnostic_summaries.values() {
1091                self.peer.send(
1092                    request.sender_id,
1093                    proto::UpdateDiagnosticSummary {
1094                        project_id: project_id.to_proto(),
1095                        worktree_id: *worktree_id,
1096                        summary: Some(summary.clone()),
1097                    },
1098                )?;
1099            }
1100        }
1101
1102        for language_server in &project.language_servers {
1103            self.peer.send(
1104                request.sender_id,
1105                proto::UpdateLanguageServer {
1106                    project_id: project_id.to_proto(),
1107                    language_server_id: language_server.id,
1108                    variant: Some(
1109                        proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
1110                            proto::LspDiskBasedDiagnosticsUpdated {},
1111                        ),
1112                    ),
1113                },
1114            )?;
1115        }
1116
1117        Ok(())
1118    }
1119
1120    async fn leave_project(
1121        self: Arc<Server>,
1122        request: TypedEnvelope<proto::LeaveProject>,
1123    ) -> Result<()> {
1124        let sender_id = request.sender_id;
1125        let project_id = ProjectId::from_proto(request.payload.project_id);
1126        let project;
1127        {
1128            let mut store = self.store().await;
1129            project = store.leave_project(project_id, sender_id)?;
1130            tracing::info!(
1131                %project_id,
1132                host_user_id = %project.host_user_id,
1133                host_connection_id = %project.host_connection_id,
1134                "leave project"
1135            );
1136
1137            if project.remove_collaborator {
1138                broadcast(sender_id, project.connection_ids, |conn_id| {
1139                    self.peer.send(
1140                        conn_id,
1141                        proto::RemoveProjectCollaborator {
1142                            project_id: project_id.to_proto(),
1143                            peer_id: sender_id.0,
1144                        },
1145                    )
1146                });
1147            }
1148        }
1149
1150        Ok(())
1151    }
1152
1153    async fn update_project(
1154        self: Arc<Server>,
1155        request: TypedEnvelope<proto::UpdateProject>,
1156    ) -> Result<()> {
1157        let project_id = ProjectId::from_proto(request.payload.project_id);
1158        {
1159            let mut state = self.store().await;
1160            let guest_connection_ids = state
1161                .read_project(project_id, request.sender_id)?
1162                .guest_connection_ids();
1163            let room =
1164                state.update_project(project_id, &request.payload.worktrees, request.sender_id)?;
1165            broadcast(request.sender_id, guest_connection_ids, |connection_id| {
1166                self.peer
1167                    .forward_send(request.sender_id, connection_id, request.payload.clone())
1168            });
1169            self.room_updated(room);
1170        };
1171
1172        Ok(())
1173    }
1174
1175    async fn register_project_activity(
1176        self: Arc<Server>,
1177        request: TypedEnvelope<proto::RegisterProjectActivity>,
1178    ) -> Result<()> {
1179        self.store().await.register_project_activity(
1180            ProjectId::from_proto(request.payload.project_id),
1181            request.sender_id,
1182        )?;
1183        Ok(())
1184    }
1185
1186    async fn update_worktree(
1187        self: Arc<Server>,
1188        request: TypedEnvelope<proto::UpdateWorktree>,
1189        response: Response<proto::UpdateWorktree>,
1190    ) -> Result<()> {
1191        let project_id = ProjectId::from_proto(request.payload.project_id);
1192        let worktree_id = request.payload.worktree_id;
1193        let connection_ids = self.store().await.update_worktree(
1194            request.sender_id,
1195            project_id,
1196            worktree_id,
1197            &request.payload.root_name,
1198            &request.payload.removed_entries,
1199            &request.payload.updated_entries,
1200            request.payload.scan_id,
1201            request.payload.is_last_update,
1202        )?;
1203
1204        broadcast(request.sender_id, connection_ids, |connection_id| {
1205            self.peer
1206                .forward_send(request.sender_id, connection_id, request.payload.clone())
1207        });
1208        response.send(proto::Ack {})?;
1209        Ok(())
1210    }
1211
1212    async fn update_worktree_extensions(
1213        self: Arc<Server>,
1214        request: TypedEnvelope<proto::UpdateWorktreeExtensions>,
1215    ) -> Result<()> {
1216        let project_id = ProjectId::from_proto(request.payload.project_id);
1217        let worktree_id = request.payload.worktree_id;
1218        let extensions = request
1219            .payload
1220            .extensions
1221            .into_iter()
1222            .zip(request.payload.counts)
1223            .collect();
1224        self.app_state
1225            .db
1226            .update_worktree_extensions(project_id, worktree_id, extensions)
1227            .await?;
1228        Ok(())
1229    }
1230
1231    async fn update_diagnostic_summary(
1232        self: Arc<Server>,
1233        request: TypedEnvelope<proto::UpdateDiagnosticSummary>,
1234    ) -> Result<()> {
1235        let summary = request
1236            .payload
1237            .summary
1238            .clone()
1239            .ok_or_else(|| anyhow!("invalid summary"))?;
1240        let receiver_ids = self.store().await.update_diagnostic_summary(
1241            ProjectId::from_proto(request.payload.project_id),
1242            request.payload.worktree_id,
1243            request.sender_id,
1244            summary,
1245        )?;
1246
1247        broadcast(request.sender_id, receiver_ids, |connection_id| {
1248            self.peer
1249                .forward_send(request.sender_id, connection_id, request.payload.clone())
1250        });
1251        Ok(())
1252    }
1253
1254    async fn start_language_server(
1255        self: Arc<Server>,
1256        request: TypedEnvelope<proto::StartLanguageServer>,
1257    ) -> Result<()> {
1258        let receiver_ids = self.store().await.start_language_server(
1259            ProjectId::from_proto(request.payload.project_id),
1260            request.sender_id,
1261            request
1262                .payload
1263                .server
1264                .clone()
1265                .ok_or_else(|| anyhow!("invalid language server"))?,
1266        )?;
1267        broadcast(request.sender_id, receiver_ids, |connection_id| {
1268            self.peer
1269                .forward_send(request.sender_id, connection_id, request.payload.clone())
1270        });
1271        Ok(())
1272    }
1273
1274    async fn update_language_server(
1275        self: Arc<Server>,
1276        request: TypedEnvelope<proto::UpdateLanguageServer>,
1277    ) -> Result<()> {
1278        let receiver_ids = self.store().await.project_connection_ids(
1279            ProjectId::from_proto(request.payload.project_id),
1280            request.sender_id,
1281        )?;
1282        broadcast(request.sender_id, receiver_ids, |connection_id| {
1283            self.peer
1284                .forward_send(request.sender_id, connection_id, request.payload.clone())
1285        });
1286        Ok(())
1287    }
1288
1289    async fn forward_project_request<T>(
1290        self: Arc<Server>,
1291        request: TypedEnvelope<T>,
1292        response: Response<T>,
1293    ) -> Result<()>
1294    where
1295        T: EntityMessage + RequestMessage,
1296    {
1297        let project_id = ProjectId::from_proto(request.payload.remote_entity_id());
1298        let host_connection_id = self
1299            .store()
1300            .await
1301            .read_project(project_id, request.sender_id)?
1302            .host_connection_id;
1303        let payload = self
1304            .peer
1305            .forward_request(request.sender_id, host_connection_id, request.payload)
1306            .await?;
1307
1308        // Ensure project still exists by the time we get the response from the host.
1309        self.store()
1310            .await
1311            .read_project(project_id, request.sender_id)?;
1312
1313        response.send(payload)?;
1314        Ok(())
1315    }
1316
1317    async fn save_buffer(
1318        self: Arc<Server>,
1319        request: TypedEnvelope<proto::SaveBuffer>,
1320        response: Response<proto::SaveBuffer>,
1321    ) -> Result<()> {
1322        let project_id = ProjectId::from_proto(request.payload.project_id);
1323        let host = self
1324            .store()
1325            .await
1326            .read_project(project_id, request.sender_id)?
1327            .host_connection_id;
1328        let response_payload = self
1329            .peer
1330            .forward_request(request.sender_id, host, request.payload.clone())
1331            .await?;
1332
1333        let mut guests = self
1334            .store()
1335            .await
1336            .read_project(project_id, request.sender_id)?
1337            .connection_ids();
1338        guests.retain(|guest_connection_id| *guest_connection_id != request.sender_id);
1339        broadcast(host, guests, |conn_id| {
1340            self.peer
1341                .forward_send(host, conn_id, response_payload.clone())
1342        });
1343        response.send(response_payload)?;
1344        Ok(())
1345    }
1346
1347    async fn create_buffer_for_peer(
1348        self: Arc<Server>,
1349        request: TypedEnvelope<proto::CreateBufferForPeer>,
1350    ) -> Result<()> {
1351        self.peer.forward_send(
1352            request.sender_id,
1353            ConnectionId(request.payload.peer_id),
1354            request.payload,
1355        )?;
1356        Ok(())
1357    }
1358
1359    async fn update_buffer(
1360        self: Arc<Server>,
1361        request: TypedEnvelope<proto::UpdateBuffer>,
1362        response: Response<proto::UpdateBuffer>,
1363    ) -> Result<()> {
1364        let project_id = ProjectId::from_proto(request.payload.project_id);
1365        let receiver_ids = {
1366            let mut store = self.store().await;
1367            store.register_project_activity(project_id, request.sender_id)?;
1368            store.project_connection_ids(project_id, request.sender_id)?
1369        };
1370
1371        broadcast(request.sender_id, receiver_ids, |connection_id| {
1372            self.peer
1373                .forward_send(request.sender_id, connection_id, request.payload.clone())
1374        });
1375        response.send(proto::Ack {})?;
1376        Ok(())
1377    }
1378
1379    async fn update_buffer_file(
1380        self: Arc<Server>,
1381        request: TypedEnvelope<proto::UpdateBufferFile>,
1382    ) -> Result<()> {
1383        let receiver_ids = self.store().await.project_connection_ids(
1384            ProjectId::from_proto(request.payload.project_id),
1385            request.sender_id,
1386        )?;
1387        broadcast(request.sender_id, receiver_ids, |connection_id| {
1388            self.peer
1389                .forward_send(request.sender_id, connection_id, request.payload.clone())
1390        });
1391        Ok(())
1392    }
1393
1394    async fn buffer_reloaded(
1395        self: Arc<Server>,
1396        request: TypedEnvelope<proto::BufferReloaded>,
1397    ) -> Result<()> {
1398        let receiver_ids = self.store().await.project_connection_ids(
1399            ProjectId::from_proto(request.payload.project_id),
1400            request.sender_id,
1401        )?;
1402        broadcast(request.sender_id, receiver_ids, |connection_id| {
1403            self.peer
1404                .forward_send(request.sender_id, connection_id, request.payload.clone())
1405        });
1406        Ok(())
1407    }
1408
1409    async fn buffer_saved(
1410        self: Arc<Server>,
1411        request: TypedEnvelope<proto::BufferSaved>,
1412    ) -> Result<()> {
1413        let receiver_ids = self.store().await.project_connection_ids(
1414            ProjectId::from_proto(request.payload.project_id),
1415            request.sender_id,
1416        )?;
1417        broadcast(request.sender_id, receiver_ids, |connection_id| {
1418            self.peer
1419                .forward_send(request.sender_id, connection_id, request.payload.clone())
1420        });
1421        Ok(())
1422    }
1423
1424    async fn follow(
1425        self: Arc<Self>,
1426        request: TypedEnvelope<proto::Follow>,
1427        response: Response<proto::Follow>,
1428    ) -> Result<()> {
1429        let project_id = ProjectId::from_proto(request.payload.project_id);
1430        let leader_id = ConnectionId(request.payload.leader_id);
1431        let follower_id = request.sender_id;
1432        {
1433            let mut store = self.store().await;
1434            if !store
1435                .project_connection_ids(project_id, follower_id)?
1436                .contains(&leader_id)
1437            {
1438                Err(anyhow!("no such peer"))?;
1439            }
1440
1441            store.register_project_activity(project_id, follower_id)?;
1442        }
1443
1444        let mut response_payload = self
1445            .peer
1446            .forward_request(request.sender_id, leader_id, request.payload)
1447            .await?;
1448        response_payload
1449            .views
1450            .retain(|view| view.leader_id != Some(follower_id.0));
1451        response.send(response_payload)?;
1452        Ok(())
1453    }
1454
1455    async fn unfollow(self: Arc<Self>, request: TypedEnvelope<proto::Unfollow>) -> Result<()> {
1456        let project_id = ProjectId::from_proto(request.payload.project_id);
1457        let leader_id = ConnectionId(request.payload.leader_id);
1458        let mut store = self.store().await;
1459        if !store
1460            .project_connection_ids(project_id, request.sender_id)?
1461            .contains(&leader_id)
1462        {
1463            Err(anyhow!("no such peer"))?;
1464        }
1465        store.register_project_activity(project_id, request.sender_id)?;
1466        self.peer
1467            .forward_send(request.sender_id, leader_id, request.payload)?;
1468        Ok(())
1469    }
1470
1471    async fn update_followers(
1472        self: Arc<Self>,
1473        request: TypedEnvelope<proto::UpdateFollowers>,
1474    ) -> Result<()> {
1475        let project_id = ProjectId::from_proto(request.payload.project_id);
1476        let mut store = self.store().await;
1477        store.register_project_activity(project_id, request.sender_id)?;
1478        let connection_ids = store.project_connection_ids(project_id, request.sender_id)?;
1479        let leader_id = request
1480            .payload
1481            .variant
1482            .as_ref()
1483            .and_then(|variant| match variant {
1484                proto::update_followers::Variant::CreateView(payload) => payload.leader_id,
1485                proto::update_followers::Variant::UpdateView(payload) => payload.leader_id,
1486                proto::update_followers::Variant::UpdateActiveView(payload) => payload.leader_id,
1487            });
1488        for follower_id in &request.payload.follower_ids {
1489            let follower_id = ConnectionId(*follower_id);
1490            if connection_ids.contains(&follower_id) && Some(follower_id.0) != leader_id {
1491                self.peer
1492                    .forward_send(request.sender_id, follower_id, request.payload.clone())?;
1493            }
1494        }
1495        Ok(())
1496    }
1497
1498    async fn get_channels(
1499        self: Arc<Server>,
1500        request: TypedEnvelope<proto::GetChannels>,
1501        response: Response<proto::GetChannels>,
1502    ) -> Result<()> {
1503        let user_id = self
1504            .store()
1505            .await
1506            .user_id_for_connection(request.sender_id)?;
1507        let channels = self.app_state.db.get_accessible_channels(user_id).await?;
1508        response.send(proto::GetChannelsResponse {
1509            channels: channels
1510                .into_iter()
1511                .map(|chan| proto::Channel {
1512                    id: chan.id.to_proto(),
1513                    name: chan.name,
1514                })
1515                .collect(),
1516        })?;
1517        Ok(())
1518    }
1519
1520    async fn get_users(
1521        self: Arc<Server>,
1522        request: TypedEnvelope<proto::GetUsers>,
1523        response: Response<proto::GetUsers>,
1524    ) -> Result<()> {
1525        let user_ids = request
1526            .payload
1527            .user_ids
1528            .into_iter()
1529            .map(UserId::from_proto)
1530            .collect();
1531        let users = self
1532            .app_state
1533            .db
1534            .get_users_by_ids(user_ids)
1535            .await?
1536            .into_iter()
1537            .map(|user| proto::User {
1538                id: user.id.to_proto(),
1539                avatar_url: format!("https://github.com/{}.png?size=128", user.github_login),
1540                github_login: user.github_login,
1541            })
1542            .collect();
1543        response.send(proto::UsersResponse { users })?;
1544        Ok(())
1545    }
1546
1547    async fn fuzzy_search_users(
1548        self: Arc<Server>,
1549        request: TypedEnvelope<proto::FuzzySearchUsers>,
1550        response: Response<proto::FuzzySearchUsers>,
1551    ) -> Result<()> {
1552        let user_id = self
1553            .store()
1554            .await
1555            .user_id_for_connection(request.sender_id)?;
1556        let query = request.payload.query;
1557        let db = &self.app_state.db;
1558        let users = match query.len() {
1559            0 => vec![],
1560            1 | 2 => db
1561                .get_user_by_github_account(&query, None)
1562                .await?
1563                .into_iter()
1564                .collect(),
1565            _ => db.fuzzy_search_users(&query, 10).await?,
1566        };
1567        let users = users
1568            .into_iter()
1569            .filter(|user| user.id != user_id)
1570            .map(|user| proto::User {
1571                id: user.id.to_proto(),
1572                avatar_url: format!("https://github.com/{}.png?size=128", user.github_login),
1573                github_login: user.github_login,
1574            })
1575            .collect();
1576        response.send(proto::UsersResponse { users })?;
1577        Ok(())
1578    }
1579
1580    async fn request_contact(
1581        self: Arc<Server>,
1582        request: TypedEnvelope<proto::RequestContact>,
1583        response: Response<proto::RequestContact>,
1584    ) -> Result<()> {
1585        let requester_id = self
1586            .store()
1587            .await
1588            .user_id_for_connection(request.sender_id)?;
1589        let responder_id = UserId::from_proto(request.payload.responder_id);
1590        if requester_id == responder_id {
1591            return Err(anyhow!("cannot add yourself as a contact"))?;
1592        }
1593
1594        self.app_state
1595            .db
1596            .send_contact_request(requester_id, responder_id)
1597            .await?;
1598
1599        // Update outgoing contact requests of requester
1600        let mut update = proto::UpdateContacts::default();
1601        update.outgoing_requests.push(responder_id.to_proto());
1602        for connection_id in self.store().await.connection_ids_for_user(requester_id) {
1603            self.peer.send(connection_id, update.clone())?;
1604        }
1605
1606        // Update incoming contact requests of responder
1607        let mut update = proto::UpdateContacts::default();
1608        update
1609            .incoming_requests
1610            .push(proto::IncomingContactRequest {
1611                requester_id: requester_id.to_proto(),
1612                should_notify: true,
1613            });
1614        for connection_id in self.store().await.connection_ids_for_user(responder_id) {
1615            self.peer.send(connection_id, update.clone())?;
1616        }
1617
1618        response.send(proto::Ack {})?;
1619        Ok(())
1620    }
1621
1622    async fn respond_to_contact_request(
1623        self: Arc<Server>,
1624        request: TypedEnvelope<proto::RespondToContactRequest>,
1625        response: Response<proto::RespondToContactRequest>,
1626    ) -> Result<()> {
1627        let responder_id = self
1628            .store()
1629            .await
1630            .user_id_for_connection(request.sender_id)?;
1631        let requester_id = UserId::from_proto(request.payload.requester_id);
1632        if request.payload.response == proto::ContactRequestResponse::Dismiss as i32 {
1633            self.app_state
1634                .db
1635                .dismiss_contact_notification(responder_id, requester_id)
1636                .await?;
1637        } else {
1638            let accept = request.payload.response == proto::ContactRequestResponse::Accept as i32;
1639            self.app_state
1640                .db
1641                .respond_to_contact_request(responder_id, requester_id, accept)
1642                .await?;
1643
1644            let store = self.store().await;
1645            // Update responder with new contact
1646            let mut update = proto::UpdateContacts::default();
1647            if accept {
1648                update
1649                    .contacts
1650                    .push(store.contact_for_user(requester_id, false));
1651            }
1652            update
1653                .remove_incoming_requests
1654                .push(requester_id.to_proto());
1655            for connection_id in store.connection_ids_for_user(responder_id) {
1656                self.peer.send(connection_id, update.clone())?;
1657            }
1658
1659            // Update requester with new contact
1660            let mut update = proto::UpdateContacts::default();
1661            if accept {
1662                update
1663                    .contacts
1664                    .push(store.contact_for_user(responder_id, true));
1665            }
1666            update
1667                .remove_outgoing_requests
1668                .push(responder_id.to_proto());
1669            for connection_id in store.connection_ids_for_user(requester_id) {
1670                self.peer.send(connection_id, update.clone())?;
1671            }
1672        }
1673
1674        response.send(proto::Ack {})?;
1675        Ok(())
1676    }
1677
1678    async fn remove_contact(
1679        self: Arc<Server>,
1680        request: TypedEnvelope<proto::RemoveContact>,
1681        response: Response<proto::RemoveContact>,
1682    ) -> Result<()> {
1683        let requester_id = self
1684            .store()
1685            .await
1686            .user_id_for_connection(request.sender_id)?;
1687        let responder_id = UserId::from_proto(request.payload.user_id);
1688        self.app_state
1689            .db
1690            .remove_contact(requester_id, responder_id)
1691            .await?;
1692
1693        // Update outgoing contact requests of requester
1694        let mut update = proto::UpdateContacts::default();
1695        update
1696            .remove_outgoing_requests
1697            .push(responder_id.to_proto());
1698        for connection_id in self.store().await.connection_ids_for_user(requester_id) {
1699            self.peer.send(connection_id, update.clone())?;
1700        }
1701
1702        // Update incoming contact requests of responder
1703        let mut update = proto::UpdateContacts::default();
1704        update
1705            .remove_incoming_requests
1706            .push(requester_id.to_proto());
1707        for connection_id in self.store().await.connection_ids_for_user(responder_id) {
1708            self.peer.send(connection_id, update.clone())?;
1709        }
1710
1711        response.send(proto::Ack {})?;
1712        Ok(())
1713    }
1714
1715    async fn join_channel(
1716        self: Arc<Self>,
1717        request: TypedEnvelope<proto::JoinChannel>,
1718        response: Response<proto::JoinChannel>,
1719    ) -> Result<()> {
1720        let user_id = self
1721            .store()
1722            .await
1723            .user_id_for_connection(request.sender_id)?;
1724        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1725        if !self
1726            .app_state
1727            .db
1728            .can_user_access_channel(user_id, channel_id)
1729            .await?
1730        {
1731            Err(anyhow!("access denied"))?;
1732        }
1733
1734        self.store()
1735            .await
1736            .join_channel(request.sender_id, channel_id);
1737        let messages = self
1738            .app_state
1739            .db
1740            .get_channel_messages(channel_id, MESSAGE_COUNT_PER_PAGE, None)
1741            .await?
1742            .into_iter()
1743            .map(|msg| proto::ChannelMessage {
1744                id: msg.id.to_proto(),
1745                body: msg.body,
1746                timestamp: msg.sent_at.unix_timestamp() as u64,
1747                sender_id: msg.sender_id.to_proto(),
1748                nonce: Some(msg.nonce.as_u128().into()),
1749            })
1750            .collect::<Vec<_>>();
1751        response.send(proto::JoinChannelResponse {
1752            done: messages.len() < MESSAGE_COUNT_PER_PAGE,
1753            messages,
1754        })?;
1755        Ok(())
1756    }
1757
1758    async fn leave_channel(
1759        self: Arc<Self>,
1760        request: TypedEnvelope<proto::LeaveChannel>,
1761    ) -> Result<()> {
1762        let user_id = self
1763            .store()
1764            .await
1765            .user_id_for_connection(request.sender_id)?;
1766        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1767        if !self
1768            .app_state
1769            .db
1770            .can_user_access_channel(user_id, channel_id)
1771            .await?
1772        {
1773            Err(anyhow!("access denied"))?;
1774        }
1775
1776        self.store()
1777            .await
1778            .leave_channel(request.sender_id, channel_id);
1779
1780        Ok(())
1781    }
1782
1783    async fn send_channel_message(
1784        self: Arc<Self>,
1785        request: TypedEnvelope<proto::SendChannelMessage>,
1786        response: Response<proto::SendChannelMessage>,
1787    ) -> Result<()> {
1788        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1789        let user_id;
1790        let connection_ids;
1791        {
1792            let state = self.store().await;
1793            user_id = state.user_id_for_connection(request.sender_id)?;
1794            connection_ids = state.channel_connection_ids(channel_id)?;
1795        }
1796
1797        // Validate the message body.
1798        let body = request.payload.body.trim().to_string();
1799        if body.len() > MAX_MESSAGE_LEN {
1800            return Err(anyhow!("message is too long"))?;
1801        }
1802        if body.is_empty() {
1803            return Err(anyhow!("message can't be blank"))?;
1804        }
1805
1806        let timestamp = OffsetDateTime::now_utc();
1807        let nonce = request
1808            .payload
1809            .nonce
1810            .ok_or_else(|| anyhow!("nonce can't be blank"))?;
1811
1812        let message_id = self
1813            .app_state
1814            .db
1815            .create_channel_message(channel_id, user_id, &body, timestamp, nonce.clone().into())
1816            .await?
1817            .to_proto();
1818        let message = proto::ChannelMessage {
1819            sender_id: user_id.to_proto(),
1820            id: message_id,
1821            body,
1822            timestamp: timestamp.unix_timestamp() as u64,
1823            nonce: Some(nonce),
1824        };
1825        broadcast(request.sender_id, connection_ids, |conn_id| {
1826            self.peer.send(
1827                conn_id,
1828                proto::ChannelMessageSent {
1829                    channel_id: channel_id.to_proto(),
1830                    message: Some(message.clone()),
1831                },
1832            )
1833        });
1834        response.send(proto::SendChannelMessageResponse {
1835            message: Some(message),
1836        })?;
1837        Ok(())
1838    }
1839
1840    async fn get_channel_messages(
1841        self: Arc<Self>,
1842        request: TypedEnvelope<proto::GetChannelMessages>,
1843        response: Response<proto::GetChannelMessages>,
1844    ) -> Result<()> {
1845        let user_id = self
1846            .store()
1847            .await
1848            .user_id_for_connection(request.sender_id)?;
1849        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1850        if !self
1851            .app_state
1852            .db
1853            .can_user_access_channel(user_id, channel_id)
1854            .await?
1855        {
1856            Err(anyhow!("access denied"))?;
1857        }
1858
1859        let messages = self
1860            .app_state
1861            .db
1862            .get_channel_messages(
1863                channel_id,
1864                MESSAGE_COUNT_PER_PAGE,
1865                Some(MessageId::from_proto(request.payload.before_message_id)),
1866            )
1867            .await?
1868            .into_iter()
1869            .map(|msg| proto::ChannelMessage {
1870                id: msg.id.to_proto(),
1871                body: msg.body,
1872                timestamp: msg.sent_at.unix_timestamp() as u64,
1873                sender_id: msg.sender_id.to_proto(),
1874                nonce: Some(msg.nonce.as_u128().into()),
1875            })
1876            .collect::<Vec<_>>();
1877        response.send(proto::GetChannelMessagesResponse {
1878            done: messages.len() < MESSAGE_COUNT_PER_PAGE,
1879            messages,
1880        })?;
1881        Ok(())
1882    }
1883
1884    async fn update_diff_base(
1885        self: Arc<Server>,
1886        request: TypedEnvelope<proto::UpdateDiffBase>,
1887    ) -> Result<()> {
1888        let receiver_ids = self.store().await.project_connection_ids(
1889            ProjectId::from_proto(request.payload.project_id),
1890            request.sender_id,
1891        )?;
1892        broadcast(request.sender_id, receiver_ids, |connection_id| {
1893            self.peer
1894                .forward_send(request.sender_id, connection_id, request.payload.clone())
1895        });
1896        Ok(())
1897    }
1898
1899    async fn get_private_user_info(
1900        self: Arc<Self>,
1901        request: TypedEnvelope<proto::GetPrivateUserInfo>,
1902        response: Response<proto::GetPrivateUserInfo>,
1903    ) -> Result<()> {
1904        let user_id = self
1905            .store()
1906            .await
1907            .user_id_for_connection(request.sender_id)?;
1908        let metrics_id = self.app_state.db.get_user_metrics_id(user_id).await?;
1909        let user = self
1910            .app_state
1911            .db
1912            .get_user_by_id(user_id)
1913            .await?
1914            .ok_or_else(|| anyhow!("user not found"))?;
1915        response.send(proto::GetPrivateUserInfoResponse {
1916            metrics_id,
1917            staff: user.admin,
1918        })?;
1919        Ok(())
1920    }
1921
1922    pub(crate) async fn store(&self) -> StoreGuard<'_> {
1923        #[cfg(test)]
1924        tokio::task::yield_now().await;
1925        let guard = self.store.lock().await;
1926        #[cfg(test)]
1927        tokio::task::yield_now().await;
1928        StoreGuard {
1929            guard,
1930            _not_send: PhantomData,
1931        }
1932    }
1933
1934    pub async fn snapshot<'a>(self: &'a Arc<Self>) -> ServerSnapshot<'a> {
1935        ServerSnapshot {
1936            store: self.store().await,
1937            peer: &self.peer,
1938        }
1939    }
1940}
1941
1942impl<'a> Deref for StoreGuard<'a> {
1943    type Target = Store;
1944
1945    fn deref(&self) -> &Self::Target {
1946        &*self.guard
1947    }
1948}
1949
1950impl<'a> DerefMut for StoreGuard<'a> {
1951    fn deref_mut(&mut self) -> &mut Self::Target {
1952        &mut *self.guard
1953    }
1954}
1955
1956impl<'a> Drop for StoreGuard<'a> {
1957    fn drop(&mut self) {
1958        #[cfg(test)]
1959        self.check_invariants();
1960    }
1961}
1962
1963impl Executor for RealExecutor {
1964    type Sleep = Sleep;
1965
1966    fn spawn_detached<F: 'static + Send + Future<Output = ()>>(&self, future: F) {
1967        tokio::task::spawn(future);
1968    }
1969
1970    fn sleep(&self, duration: Duration) -> Self::Sleep {
1971        tokio::time::sleep(duration)
1972    }
1973}
1974
1975fn broadcast<F>(
1976    sender_id: ConnectionId,
1977    receiver_ids: impl IntoIterator<Item = ConnectionId>,
1978    mut f: F,
1979) where
1980    F: FnMut(ConnectionId) -> anyhow::Result<()>,
1981{
1982    for receiver_id in receiver_ids {
1983        if receiver_id != sender_id {
1984            f(receiver_id).trace_err();
1985        }
1986    }
1987}
1988
1989lazy_static! {
1990    static ref ZED_PROTOCOL_VERSION: HeaderName = HeaderName::from_static("x-zed-protocol-version");
1991}
1992
1993pub struct ProtocolVersion(u32);
1994
1995impl Header for ProtocolVersion {
1996    fn name() -> &'static HeaderName {
1997        &ZED_PROTOCOL_VERSION
1998    }
1999
2000    fn decode<'i, I>(values: &mut I) -> Result<Self, axum::headers::Error>
2001    where
2002        Self: Sized,
2003        I: Iterator<Item = &'i axum::http::HeaderValue>,
2004    {
2005        let version = values
2006            .next()
2007            .ok_or_else(axum::headers::Error::invalid)?
2008            .to_str()
2009            .map_err(|_| axum::headers::Error::invalid())?
2010            .parse()
2011            .map_err(|_| axum::headers::Error::invalid())?;
2012        Ok(Self(version))
2013    }
2014
2015    fn encode<E: Extend<axum::http::HeaderValue>>(&self, values: &mut E) {
2016        values.extend([self.0.to_string().parse().unwrap()]);
2017    }
2018}
2019
2020pub fn routes(server: Arc<Server>) -> Router<Body> {
2021    Router::new()
2022        .route("/rpc", get(handle_websocket_request))
2023        .layer(
2024            ServiceBuilder::new()
2025                .layer(Extension(server.app_state.clone()))
2026                .layer(middleware::from_fn(auth::validate_header)),
2027        )
2028        .route("/metrics", get(handle_metrics))
2029        .layer(Extension(server))
2030}
2031
2032pub async fn handle_websocket_request(
2033    TypedHeader(ProtocolVersion(protocol_version)): TypedHeader<ProtocolVersion>,
2034    ConnectInfo(socket_address): ConnectInfo<SocketAddr>,
2035    Extension(server): Extension<Arc<Server>>,
2036    Extension(user): Extension<User>,
2037    ws: WebSocketUpgrade,
2038) -> axum::response::Response {
2039    if protocol_version != rpc::PROTOCOL_VERSION {
2040        return (
2041            StatusCode::UPGRADE_REQUIRED,
2042            "client must be upgraded".to_string(),
2043        )
2044            .into_response();
2045    }
2046    let socket_address = socket_address.to_string();
2047    ws.on_upgrade(move |socket| {
2048        use util::ResultExt;
2049        let socket = socket
2050            .map_ok(to_tungstenite_message)
2051            .err_into()
2052            .with(|message| async move { Ok(to_axum_message(message)) });
2053        let connection = Connection::new(Box::pin(socket));
2054        async move {
2055            server
2056                .handle_connection(connection, socket_address, user, None, RealExecutor)
2057                .await
2058                .log_err();
2059        }
2060    })
2061}
2062
2063pub async fn handle_metrics(Extension(server): Extension<Arc<Server>>) -> axum::response::Response {
2064    // We call `store_mut` here for its side effects of updating metrics.
2065    let metrics = server.store().await.metrics();
2066    METRIC_CONNECTIONS.set(metrics.connections as _);
2067    METRIC_REGISTERED_PROJECTS.set(metrics.registered_projects as _);
2068    METRIC_ACTIVE_PROJECTS.set(metrics.active_projects as _);
2069    METRIC_SHARED_PROJECTS.set(metrics.shared_projects as _);
2070
2071    let encoder = prometheus::TextEncoder::new();
2072    let metric_families = prometheus::gather();
2073    match encoder.encode_to_string(&metric_families) {
2074        Ok(string) => (StatusCode::OK, string).into_response(),
2075        Err(error) => (
2076            StatusCode::INTERNAL_SERVER_ERROR,
2077            format!("failed to encode metrics {:?}", error),
2078        )
2079            .into_response(),
2080    }
2081}
2082
2083fn to_axum_message(message: TungsteniteMessage) -> AxumMessage {
2084    match message {
2085        TungsteniteMessage::Text(payload) => AxumMessage::Text(payload),
2086        TungsteniteMessage::Binary(payload) => AxumMessage::Binary(payload),
2087        TungsteniteMessage::Ping(payload) => AxumMessage::Ping(payload),
2088        TungsteniteMessage::Pong(payload) => AxumMessage::Pong(payload),
2089        TungsteniteMessage::Close(frame) => AxumMessage::Close(frame.map(|frame| AxumCloseFrame {
2090            code: frame.code.into(),
2091            reason: frame.reason,
2092        })),
2093    }
2094}
2095
2096fn to_tungstenite_message(message: AxumMessage) -> TungsteniteMessage {
2097    match message {
2098        AxumMessage::Text(payload) => TungsteniteMessage::Text(payload),
2099        AxumMessage::Binary(payload) => TungsteniteMessage::Binary(payload),
2100        AxumMessage::Ping(payload) => TungsteniteMessage::Ping(payload),
2101        AxumMessage::Pong(payload) => TungsteniteMessage::Pong(payload),
2102        AxumMessage::Close(frame) => {
2103            TungsteniteMessage::Close(frame.map(|frame| TungsteniteCloseFrame {
2104                code: frame.code.into(),
2105                reason: frame.reason,
2106            }))
2107        }
2108    }
2109}
2110
2111pub trait ResultExt {
2112    type Ok;
2113
2114    fn trace_err(self) -> Option<Self::Ok>;
2115}
2116
2117impl<T, E> ResultExt for Result<T, E>
2118where
2119    E: std::fmt::Debug,
2120{
2121    type Ok = T;
2122
2123    fn trace_err(self) -> Option<T> {
2124        match self {
2125            Ok(value) => Some(value),
2126            Err(error) => {
2127                tracing::error!("{:?}", error);
2128                None
2129            }
2130        }
2131    }
2132}