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.send(
1045                    conn_id,
1046                    proto::AddProjectCollaborator {
1047                        project_id: project_id.to_proto(),
1048                        collaborator: Some(proto::Collaborator {
1049                            peer_id: request.sender_id.0,
1050                            replica_id: replica_id as u32,
1051                            user_id: guest_user_id.to_proto(),
1052                        }),
1053                    },
1054                )?;
1055            }
1056        }
1057
1058        // First, we send the metadata associated with each worktree.
1059        response.send(proto::JoinProjectResponse {
1060            worktrees: worktrees.clone(),
1061            replica_id: replica_id as u32,
1062            collaborators: collaborators.clone(),
1063            language_servers: project.language_servers.clone(),
1064        })?;
1065
1066        for (worktree_id, worktree) in &project.worktrees {
1067            #[cfg(any(test, feature = "test-support"))]
1068            const MAX_CHUNK_SIZE: usize = 2;
1069            #[cfg(not(any(test, feature = "test-support")))]
1070            const MAX_CHUNK_SIZE: usize = 256;
1071
1072            // Stream this worktree's entries.
1073            let message = proto::UpdateWorktree {
1074                project_id: project_id.to_proto(),
1075                worktree_id: *worktree_id,
1076                abs_path: worktree.abs_path.as_os_str().as_bytes().to_vec(),
1077                root_name: worktree.root_name.clone(),
1078                updated_entries: worktree.entries.values().cloned().collect(),
1079                removed_entries: Default::default(),
1080                scan_id: worktree.scan_id,
1081                is_last_update: worktree.is_complete,
1082            };
1083            for update in proto::split_worktree_update(message, MAX_CHUNK_SIZE) {
1084                self.peer.send(request.sender_id, update.clone())?;
1085            }
1086
1087            // Stream this worktree's diagnostics.
1088            for summary in worktree.diagnostic_summaries.values() {
1089                self.peer.send(
1090                    request.sender_id,
1091                    proto::UpdateDiagnosticSummary {
1092                        project_id: project_id.to_proto(),
1093                        worktree_id: *worktree_id,
1094                        summary: Some(summary.clone()),
1095                    },
1096                )?;
1097            }
1098        }
1099
1100        for language_server in &project.language_servers {
1101            self.peer.send(
1102                request.sender_id,
1103                proto::UpdateLanguageServer {
1104                    project_id: project_id.to_proto(),
1105                    language_server_id: language_server.id,
1106                    variant: Some(
1107                        proto::update_language_server::Variant::DiskBasedDiagnosticsUpdated(
1108                            proto::LspDiskBasedDiagnosticsUpdated {},
1109                        ),
1110                    ),
1111                },
1112            )?;
1113        }
1114
1115        Ok(())
1116    }
1117
1118    async fn leave_project(
1119        self: Arc<Server>,
1120        request: TypedEnvelope<proto::LeaveProject>,
1121    ) -> Result<()> {
1122        let sender_id = request.sender_id;
1123        let project_id = ProjectId::from_proto(request.payload.project_id);
1124        let project;
1125        {
1126            let mut store = self.store().await;
1127            project = store.leave_project(project_id, sender_id)?;
1128            tracing::info!(
1129                %project_id,
1130                host_user_id = %project.host_user_id,
1131                host_connection_id = %project.host_connection_id,
1132                "leave project"
1133            );
1134
1135            if project.remove_collaborator {
1136                broadcast(sender_id, project.connection_ids, |conn_id| {
1137                    self.peer.send(
1138                        conn_id,
1139                        proto::RemoveProjectCollaborator {
1140                            project_id: project_id.to_proto(),
1141                            peer_id: sender_id.0,
1142                        },
1143                    )
1144                });
1145            }
1146        }
1147
1148        Ok(())
1149    }
1150
1151    async fn update_project(
1152        self: Arc<Server>,
1153        request: TypedEnvelope<proto::UpdateProject>,
1154    ) -> Result<()> {
1155        let project_id = ProjectId::from_proto(request.payload.project_id);
1156        {
1157            let mut state = self.store().await;
1158            let guest_connection_ids = state
1159                .read_project(project_id, request.sender_id)?
1160                .guest_connection_ids();
1161            let room =
1162                state.update_project(project_id, &request.payload.worktrees, request.sender_id)?;
1163            broadcast(request.sender_id, guest_connection_ids, |connection_id| {
1164                self.peer
1165                    .forward_send(request.sender_id, connection_id, request.payload.clone())
1166            });
1167            self.room_updated(room);
1168        };
1169
1170        Ok(())
1171    }
1172
1173    async fn register_project_activity(
1174        self: Arc<Server>,
1175        request: TypedEnvelope<proto::RegisterProjectActivity>,
1176    ) -> Result<()> {
1177        self.store().await.register_project_activity(
1178            ProjectId::from_proto(request.payload.project_id),
1179            request.sender_id,
1180        )?;
1181        Ok(())
1182    }
1183
1184    async fn update_worktree(
1185        self: Arc<Server>,
1186        request: TypedEnvelope<proto::UpdateWorktree>,
1187        response: Response<proto::UpdateWorktree>,
1188    ) -> Result<()> {
1189        let project_id = ProjectId::from_proto(request.payload.project_id);
1190        let worktree_id = request.payload.worktree_id;
1191        let connection_ids = self.store().await.update_worktree(
1192            request.sender_id,
1193            project_id,
1194            worktree_id,
1195            &request.payload.root_name,
1196            &request.payload.removed_entries,
1197            &request.payload.updated_entries,
1198            request.payload.scan_id,
1199            request.payload.is_last_update,
1200        )?;
1201
1202        broadcast(request.sender_id, connection_ids, |connection_id| {
1203            self.peer
1204                .forward_send(request.sender_id, connection_id, request.payload.clone())
1205        });
1206        response.send(proto::Ack {})?;
1207        Ok(())
1208    }
1209
1210    async fn update_worktree_extensions(
1211        self: Arc<Server>,
1212        request: TypedEnvelope<proto::UpdateWorktreeExtensions>,
1213    ) -> Result<()> {
1214        let project_id = ProjectId::from_proto(request.payload.project_id);
1215        let worktree_id = request.payload.worktree_id;
1216        let extensions = request
1217            .payload
1218            .extensions
1219            .into_iter()
1220            .zip(request.payload.counts)
1221            .collect();
1222        self.app_state
1223            .db
1224            .update_worktree_extensions(project_id, worktree_id, extensions)
1225            .await?;
1226        Ok(())
1227    }
1228
1229    async fn update_diagnostic_summary(
1230        self: Arc<Server>,
1231        request: TypedEnvelope<proto::UpdateDiagnosticSummary>,
1232    ) -> Result<()> {
1233        let summary = request
1234            .payload
1235            .summary
1236            .clone()
1237            .ok_or_else(|| anyhow!("invalid summary"))?;
1238        let receiver_ids = self.store().await.update_diagnostic_summary(
1239            ProjectId::from_proto(request.payload.project_id),
1240            request.payload.worktree_id,
1241            request.sender_id,
1242            summary,
1243        )?;
1244
1245        broadcast(request.sender_id, receiver_ids, |connection_id| {
1246            self.peer
1247                .forward_send(request.sender_id, connection_id, request.payload.clone())
1248        });
1249        Ok(())
1250    }
1251
1252    async fn start_language_server(
1253        self: Arc<Server>,
1254        request: TypedEnvelope<proto::StartLanguageServer>,
1255    ) -> Result<()> {
1256        let receiver_ids = self.store().await.start_language_server(
1257            ProjectId::from_proto(request.payload.project_id),
1258            request.sender_id,
1259            request
1260                .payload
1261                .server
1262                .clone()
1263                .ok_or_else(|| anyhow!("invalid language server"))?,
1264        )?;
1265        broadcast(request.sender_id, receiver_ids, |connection_id| {
1266            self.peer
1267                .forward_send(request.sender_id, connection_id, request.payload.clone())
1268        });
1269        Ok(())
1270    }
1271
1272    async fn update_language_server(
1273        self: Arc<Server>,
1274        request: TypedEnvelope<proto::UpdateLanguageServer>,
1275    ) -> Result<()> {
1276        let receiver_ids = self.store().await.project_connection_ids(
1277            ProjectId::from_proto(request.payload.project_id),
1278            request.sender_id,
1279        )?;
1280        broadcast(request.sender_id, receiver_ids, |connection_id| {
1281            self.peer
1282                .forward_send(request.sender_id, connection_id, request.payload.clone())
1283        });
1284        Ok(())
1285    }
1286
1287    async fn forward_project_request<T>(
1288        self: Arc<Server>,
1289        request: TypedEnvelope<T>,
1290        response: Response<T>,
1291    ) -> Result<()>
1292    where
1293        T: EntityMessage + RequestMessage,
1294    {
1295        let project_id = ProjectId::from_proto(request.payload.remote_entity_id());
1296        let host_connection_id = self
1297            .store()
1298            .await
1299            .read_project(project_id, request.sender_id)?
1300            .host_connection_id;
1301        let payload = self
1302            .peer
1303            .forward_request(request.sender_id, host_connection_id, request.payload)
1304            .await?;
1305
1306        // Ensure project still exists by the time we get the response from the host.
1307        self.store()
1308            .await
1309            .read_project(project_id, request.sender_id)?;
1310
1311        response.send(payload)?;
1312        Ok(())
1313    }
1314
1315    async fn save_buffer(
1316        self: Arc<Server>,
1317        request: TypedEnvelope<proto::SaveBuffer>,
1318        response: Response<proto::SaveBuffer>,
1319    ) -> Result<()> {
1320        let project_id = ProjectId::from_proto(request.payload.project_id);
1321        let host = self
1322            .store()
1323            .await
1324            .read_project(project_id, request.sender_id)?
1325            .host_connection_id;
1326        let response_payload = self
1327            .peer
1328            .forward_request(request.sender_id, host, request.payload.clone())
1329            .await?;
1330
1331        let mut guests = self
1332            .store()
1333            .await
1334            .read_project(project_id, request.sender_id)?
1335            .connection_ids();
1336        guests.retain(|guest_connection_id| *guest_connection_id != request.sender_id);
1337        broadcast(host, guests, |conn_id| {
1338            self.peer
1339                .forward_send(host, conn_id, response_payload.clone())
1340        });
1341        response.send(response_payload)?;
1342        Ok(())
1343    }
1344
1345    async fn create_buffer_for_peer(
1346        self: Arc<Server>,
1347        request: TypedEnvelope<proto::CreateBufferForPeer>,
1348    ) -> Result<()> {
1349        self.peer.forward_send(
1350            request.sender_id,
1351            ConnectionId(request.payload.peer_id),
1352            request.payload,
1353        )?;
1354        Ok(())
1355    }
1356
1357    async fn update_buffer(
1358        self: Arc<Server>,
1359        request: TypedEnvelope<proto::UpdateBuffer>,
1360        response: Response<proto::UpdateBuffer>,
1361    ) -> Result<()> {
1362        let project_id = ProjectId::from_proto(request.payload.project_id);
1363        let receiver_ids = {
1364            let mut store = self.store().await;
1365            store.register_project_activity(project_id, request.sender_id)?;
1366            store.project_connection_ids(project_id, request.sender_id)?
1367        };
1368
1369        broadcast(request.sender_id, receiver_ids, |connection_id| {
1370            self.peer
1371                .forward_send(request.sender_id, connection_id, request.payload.clone())
1372        });
1373        response.send(proto::Ack {})?;
1374        Ok(())
1375    }
1376
1377    async fn update_buffer_file(
1378        self: Arc<Server>,
1379        request: TypedEnvelope<proto::UpdateBufferFile>,
1380    ) -> Result<()> {
1381        let receiver_ids = self.store().await.project_connection_ids(
1382            ProjectId::from_proto(request.payload.project_id),
1383            request.sender_id,
1384        )?;
1385        broadcast(request.sender_id, receiver_ids, |connection_id| {
1386            self.peer
1387                .forward_send(request.sender_id, connection_id, request.payload.clone())
1388        });
1389        Ok(())
1390    }
1391
1392    async fn buffer_reloaded(
1393        self: Arc<Server>,
1394        request: TypedEnvelope<proto::BufferReloaded>,
1395    ) -> Result<()> {
1396        let receiver_ids = self.store().await.project_connection_ids(
1397            ProjectId::from_proto(request.payload.project_id),
1398            request.sender_id,
1399        )?;
1400        broadcast(request.sender_id, receiver_ids, |connection_id| {
1401            self.peer
1402                .forward_send(request.sender_id, connection_id, request.payload.clone())
1403        });
1404        Ok(())
1405    }
1406
1407    async fn buffer_saved(
1408        self: Arc<Server>,
1409        request: TypedEnvelope<proto::BufferSaved>,
1410    ) -> Result<()> {
1411        let receiver_ids = self.store().await.project_connection_ids(
1412            ProjectId::from_proto(request.payload.project_id),
1413            request.sender_id,
1414        )?;
1415        broadcast(request.sender_id, receiver_ids, |connection_id| {
1416            self.peer
1417                .forward_send(request.sender_id, connection_id, request.payload.clone())
1418        });
1419        Ok(())
1420    }
1421
1422    async fn follow(
1423        self: Arc<Self>,
1424        request: TypedEnvelope<proto::Follow>,
1425        response: Response<proto::Follow>,
1426    ) -> Result<()> {
1427        let project_id = ProjectId::from_proto(request.payload.project_id);
1428        let leader_id = ConnectionId(request.payload.leader_id);
1429        let follower_id = request.sender_id;
1430        {
1431            let mut store = self.store().await;
1432            if !store
1433                .project_connection_ids(project_id, follower_id)?
1434                .contains(&leader_id)
1435            {
1436                Err(anyhow!("no such peer"))?;
1437            }
1438
1439            store.register_project_activity(project_id, follower_id)?;
1440        }
1441
1442        let mut response_payload = self
1443            .peer
1444            .forward_request(request.sender_id, leader_id, request.payload)
1445            .await?;
1446        response_payload
1447            .views
1448            .retain(|view| view.leader_id != Some(follower_id.0));
1449        response.send(response_payload)?;
1450        Ok(())
1451    }
1452
1453    async fn unfollow(self: Arc<Self>, request: TypedEnvelope<proto::Unfollow>) -> Result<()> {
1454        let project_id = ProjectId::from_proto(request.payload.project_id);
1455        let leader_id = ConnectionId(request.payload.leader_id);
1456        let mut store = self.store().await;
1457        if !store
1458            .project_connection_ids(project_id, request.sender_id)?
1459            .contains(&leader_id)
1460        {
1461            Err(anyhow!("no such peer"))?;
1462        }
1463        store.register_project_activity(project_id, request.sender_id)?;
1464        self.peer
1465            .forward_send(request.sender_id, leader_id, request.payload)?;
1466        Ok(())
1467    }
1468
1469    async fn update_followers(
1470        self: Arc<Self>,
1471        request: TypedEnvelope<proto::UpdateFollowers>,
1472    ) -> Result<()> {
1473        let project_id = ProjectId::from_proto(request.payload.project_id);
1474        let mut store = self.store().await;
1475        store.register_project_activity(project_id, request.sender_id)?;
1476        let connection_ids = store.project_connection_ids(project_id, request.sender_id)?;
1477        let leader_id = request
1478            .payload
1479            .variant
1480            .as_ref()
1481            .and_then(|variant| match variant {
1482                proto::update_followers::Variant::CreateView(payload) => payload.leader_id,
1483                proto::update_followers::Variant::UpdateView(payload) => payload.leader_id,
1484                proto::update_followers::Variant::UpdateActiveView(payload) => payload.leader_id,
1485            });
1486        for follower_id in &request.payload.follower_ids {
1487            let follower_id = ConnectionId(*follower_id);
1488            if connection_ids.contains(&follower_id) && Some(follower_id.0) != leader_id {
1489                self.peer
1490                    .forward_send(request.sender_id, follower_id, request.payload.clone())?;
1491            }
1492        }
1493        Ok(())
1494    }
1495
1496    async fn get_channels(
1497        self: Arc<Server>,
1498        request: TypedEnvelope<proto::GetChannels>,
1499        response: Response<proto::GetChannels>,
1500    ) -> Result<()> {
1501        let user_id = self
1502            .store()
1503            .await
1504            .user_id_for_connection(request.sender_id)?;
1505        let channels = self.app_state.db.get_accessible_channels(user_id).await?;
1506        response.send(proto::GetChannelsResponse {
1507            channels: channels
1508                .into_iter()
1509                .map(|chan| proto::Channel {
1510                    id: chan.id.to_proto(),
1511                    name: chan.name,
1512                })
1513                .collect(),
1514        })?;
1515        Ok(())
1516    }
1517
1518    async fn get_users(
1519        self: Arc<Server>,
1520        request: TypedEnvelope<proto::GetUsers>,
1521        response: Response<proto::GetUsers>,
1522    ) -> Result<()> {
1523        let user_ids = request
1524            .payload
1525            .user_ids
1526            .into_iter()
1527            .map(UserId::from_proto)
1528            .collect();
1529        let users = self
1530            .app_state
1531            .db
1532            .get_users_by_ids(user_ids)
1533            .await?
1534            .into_iter()
1535            .map(|user| proto::User {
1536                id: user.id.to_proto(),
1537                avatar_url: format!("https://github.com/{}.png?size=128", user.github_login),
1538                github_login: user.github_login,
1539            })
1540            .collect();
1541        response.send(proto::UsersResponse { users })?;
1542        Ok(())
1543    }
1544
1545    async fn fuzzy_search_users(
1546        self: Arc<Server>,
1547        request: TypedEnvelope<proto::FuzzySearchUsers>,
1548        response: Response<proto::FuzzySearchUsers>,
1549    ) -> Result<()> {
1550        let user_id = self
1551            .store()
1552            .await
1553            .user_id_for_connection(request.sender_id)?;
1554        let query = request.payload.query;
1555        let db = &self.app_state.db;
1556        let users = match query.len() {
1557            0 => vec![],
1558            1 | 2 => db
1559                .get_user_by_github_account(&query, None)
1560                .await?
1561                .into_iter()
1562                .collect(),
1563            _ => db.fuzzy_search_users(&query, 10).await?,
1564        };
1565        let users = users
1566            .into_iter()
1567            .filter(|user| user.id != user_id)
1568            .map(|user| proto::User {
1569                id: user.id.to_proto(),
1570                avatar_url: format!("https://github.com/{}.png?size=128", user.github_login),
1571                github_login: user.github_login,
1572            })
1573            .collect();
1574        response.send(proto::UsersResponse { users })?;
1575        Ok(())
1576    }
1577
1578    async fn request_contact(
1579        self: Arc<Server>,
1580        request: TypedEnvelope<proto::RequestContact>,
1581        response: Response<proto::RequestContact>,
1582    ) -> Result<()> {
1583        let requester_id = self
1584            .store()
1585            .await
1586            .user_id_for_connection(request.sender_id)?;
1587        let responder_id = UserId::from_proto(request.payload.responder_id);
1588        if requester_id == responder_id {
1589            return Err(anyhow!("cannot add yourself as a contact"))?;
1590        }
1591
1592        self.app_state
1593            .db
1594            .send_contact_request(requester_id, responder_id)
1595            .await?;
1596
1597        // Update outgoing contact requests of requester
1598        let mut update = proto::UpdateContacts::default();
1599        update.outgoing_requests.push(responder_id.to_proto());
1600        for connection_id in self.store().await.connection_ids_for_user(requester_id) {
1601            self.peer.send(connection_id, update.clone())?;
1602        }
1603
1604        // Update incoming contact requests of responder
1605        let mut update = proto::UpdateContacts::default();
1606        update
1607            .incoming_requests
1608            .push(proto::IncomingContactRequest {
1609                requester_id: requester_id.to_proto(),
1610                should_notify: true,
1611            });
1612        for connection_id in self.store().await.connection_ids_for_user(responder_id) {
1613            self.peer.send(connection_id, update.clone())?;
1614        }
1615
1616        response.send(proto::Ack {})?;
1617        Ok(())
1618    }
1619
1620    async fn respond_to_contact_request(
1621        self: Arc<Server>,
1622        request: TypedEnvelope<proto::RespondToContactRequest>,
1623        response: Response<proto::RespondToContactRequest>,
1624    ) -> Result<()> {
1625        let responder_id = self
1626            .store()
1627            .await
1628            .user_id_for_connection(request.sender_id)?;
1629        let requester_id = UserId::from_proto(request.payload.requester_id);
1630        if request.payload.response == proto::ContactRequestResponse::Dismiss as i32 {
1631            self.app_state
1632                .db
1633                .dismiss_contact_notification(responder_id, requester_id)
1634                .await?;
1635        } else {
1636            let accept = request.payload.response == proto::ContactRequestResponse::Accept as i32;
1637            self.app_state
1638                .db
1639                .respond_to_contact_request(responder_id, requester_id, accept)
1640                .await?;
1641
1642            let store = self.store().await;
1643            // Update responder with new contact
1644            let mut update = proto::UpdateContacts::default();
1645            if accept {
1646                update
1647                    .contacts
1648                    .push(store.contact_for_user(requester_id, false));
1649            }
1650            update
1651                .remove_incoming_requests
1652                .push(requester_id.to_proto());
1653            for connection_id in store.connection_ids_for_user(responder_id) {
1654                self.peer.send(connection_id, update.clone())?;
1655            }
1656
1657            // Update requester with new contact
1658            let mut update = proto::UpdateContacts::default();
1659            if accept {
1660                update
1661                    .contacts
1662                    .push(store.contact_for_user(responder_id, true));
1663            }
1664            update
1665                .remove_outgoing_requests
1666                .push(responder_id.to_proto());
1667            for connection_id in store.connection_ids_for_user(requester_id) {
1668                self.peer.send(connection_id, update.clone())?;
1669            }
1670        }
1671
1672        response.send(proto::Ack {})?;
1673        Ok(())
1674    }
1675
1676    async fn remove_contact(
1677        self: Arc<Server>,
1678        request: TypedEnvelope<proto::RemoveContact>,
1679        response: Response<proto::RemoveContact>,
1680    ) -> Result<()> {
1681        let requester_id = self
1682            .store()
1683            .await
1684            .user_id_for_connection(request.sender_id)?;
1685        let responder_id = UserId::from_proto(request.payload.user_id);
1686        self.app_state
1687            .db
1688            .remove_contact(requester_id, responder_id)
1689            .await?;
1690
1691        // Update outgoing contact requests of requester
1692        let mut update = proto::UpdateContacts::default();
1693        update
1694            .remove_outgoing_requests
1695            .push(responder_id.to_proto());
1696        for connection_id in self.store().await.connection_ids_for_user(requester_id) {
1697            self.peer.send(connection_id, update.clone())?;
1698        }
1699
1700        // Update incoming contact requests of responder
1701        let mut update = proto::UpdateContacts::default();
1702        update
1703            .remove_incoming_requests
1704            .push(requester_id.to_proto());
1705        for connection_id in self.store().await.connection_ids_for_user(responder_id) {
1706            self.peer.send(connection_id, update.clone())?;
1707        }
1708
1709        response.send(proto::Ack {})?;
1710        Ok(())
1711    }
1712
1713    async fn join_channel(
1714        self: Arc<Self>,
1715        request: TypedEnvelope<proto::JoinChannel>,
1716        response: Response<proto::JoinChannel>,
1717    ) -> Result<()> {
1718        let user_id = self
1719            .store()
1720            .await
1721            .user_id_for_connection(request.sender_id)?;
1722        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1723        if !self
1724            .app_state
1725            .db
1726            .can_user_access_channel(user_id, channel_id)
1727            .await?
1728        {
1729            Err(anyhow!("access denied"))?;
1730        }
1731
1732        self.store()
1733            .await
1734            .join_channel(request.sender_id, channel_id);
1735        let messages = self
1736            .app_state
1737            .db
1738            .get_channel_messages(channel_id, MESSAGE_COUNT_PER_PAGE, None)
1739            .await?
1740            .into_iter()
1741            .map(|msg| proto::ChannelMessage {
1742                id: msg.id.to_proto(),
1743                body: msg.body,
1744                timestamp: msg.sent_at.unix_timestamp() as u64,
1745                sender_id: msg.sender_id.to_proto(),
1746                nonce: Some(msg.nonce.as_u128().into()),
1747            })
1748            .collect::<Vec<_>>();
1749        response.send(proto::JoinChannelResponse {
1750            done: messages.len() < MESSAGE_COUNT_PER_PAGE,
1751            messages,
1752        })?;
1753        Ok(())
1754    }
1755
1756    async fn leave_channel(
1757        self: Arc<Self>,
1758        request: TypedEnvelope<proto::LeaveChannel>,
1759    ) -> Result<()> {
1760        let user_id = self
1761            .store()
1762            .await
1763            .user_id_for_connection(request.sender_id)?;
1764        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1765        if !self
1766            .app_state
1767            .db
1768            .can_user_access_channel(user_id, channel_id)
1769            .await?
1770        {
1771            Err(anyhow!("access denied"))?;
1772        }
1773
1774        self.store()
1775            .await
1776            .leave_channel(request.sender_id, channel_id);
1777
1778        Ok(())
1779    }
1780
1781    async fn send_channel_message(
1782        self: Arc<Self>,
1783        request: TypedEnvelope<proto::SendChannelMessage>,
1784        response: Response<proto::SendChannelMessage>,
1785    ) -> Result<()> {
1786        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1787        let user_id;
1788        let connection_ids;
1789        {
1790            let state = self.store().await;
1791            user_id = state.user_id_for_connection(request.sender_id)?;
1792            connection_ids = state.channel_connection_ids(channel_id)?;
1793        }
1794
1795        // Validate the message body.
1796        let body = request.payload.body.trim().to_string();
1797        if body.len() > MAX_MESSAGE_LEN {
1798            return Err(anyhow!("message is too long"))?;
1799        }
1800        if body.is_empty() {
1801            return Err(anyhow!("message can't be blank"))?;
1802        }
1803
1804        let timestamp = OffsetDateTime::now_utc();
1805        let nonce = request
1806            .payload
1807            .nonce
1808            .ok_or_else(|| anyhow!("nonce can't be blank"))?;
1809
1810        let message_id = self
1811            .app_state
1812            .db
1813            .create_channel_message(channel_id, user_id, &body, timestamp, nonce.clone().into())
1814            .await?
1815            .to_proto();
1816        let message = proto::ChannelMessage {
1817            sender_id: user_id.to_proto(),
1818            id: message_id,
1819            body,
1820            timestamp: timestamp.unix_timestamp() as u64,
1821            nonce: Some(nonce),
1822        };
1823        broadcast(request.sender_id, connection_ids, |conn_id| {
1824            self.peer.send(
1825                conn_id,
1826                proto::ChannelMessageSent {
1827                    channel_id: channel_id.to_proto(),
1828                    message: Some(message.clone()),
1829                },
1830            )
1831        });
1832        response.send(proto::SendChannelMessageResponse {
1833            message: Some(message),
1834        })?;
1835        Ok(())
1836    }
1837
1838    async fn get_channel_messages(
1839        self: Arc<Self>,
1840        request: TypedEnvelope<proto::GetChannelMessages>,
1841        response: Response<proto::GetChannelMessages>,
1842    ) -> Result<()> {
1843        let user_id = self
1844            .store()
1845            .await
1846            .user_id_for_connection(request.sender_id)?;
1847        let channel_id = ChannelId::from_proto(request.payload.channel_id);
1848        if !self
1849            .app_state
1850            .db
1851            .can_user_access_channel(user_id, channel_id)
1852            .await?
1853        {
1854            Err(anyhow!("access denied"))?;
1855        }
1856
1857        let messages = self
1858            .app_state
1859            .db
1860            .get_channel_messages(
1861                channel_id,
1862                MESSAGE_COUNT_PER_PAGE,
1863                Some(MessageId::from_proto(request.payload.before_message_id)),
1864            )
1865            .await?
1866            .into_iter()
1867            .map(|msg| proto::ChannelMessage {
1868                id: msg.id.to_proto(),
1869                body: msg.body,
1870                timestamp: msg.sent_at.unix_timestamp() as u64,
1871                sender_id: msg.sender_id.to_proto(),
1872                nonce: Some(msg.nonce.as_u128().into()),
1873            })
1874            .collect::<Vec<_>>();
1875        response.send(proto::GetChannelMessagesResponse {
1876            done: messages.len() < MESSAGE_COUNT_PER_PAGE,
1877            messages,
1878        })?;
1879        Ok(())
1880    }
1881
1882    async fn update_diff_base(
1883        self: Arc<Server>,
1884        request: TypedEnvelope<proto::UpdateDiffBase>,
1885    ) -> Result<()> {
1886        let receiver_ids = self.store().await.project_connection_ids(
1887            ProjectId::from_proto(request.payload.project_id),
1888            request.sender_id,
1889        )?;
1890        broadcast(request.sender_id, receiver_ids, |connection_id| {
1891            self.peer
1892                .forward_send(request.sender_id, connection_id, request.payload.clone())
1893        });
1894        Ok(())
1895    }
1896
1897    async fn get_private_user_info(
1898        self: Arc<Self>,
1899        request: TypedEnvelope<proto::GetPrivateUserInfo>,
1900        response: Response<proto::GetPrivateUserInfo>,
1901    ) -> Result<()> {
1902        let user_id = self
1903            .store()
1904            .await
1905            .user_id_for_connection(request.sender_id)?;
1906        let metrics_id = self.app_state.db.get_user_metrics_id(user_id).await?;
1907        let user = self
1908            .app_state
1909            .db
1910            .get_user_by_id(user_id)
1911            .await?
1912            .ok_or_else(|| anyhow!("user not found"))?;
1913        response.send(proto::GetPrivateUserInfoResponse {
1914            metrics_id,
1915            staff: user.admin,
1916        })?;
1917        Ok(())
1918    }
1919
1920    pub(crate) async fn store(&self) -> StoreGuard<'_> {
1921        #[cfg(test)]
1922        tokio::task::yield_now().await;
1923        let guard = self.store.lock().await;
1924        #[cfg(test)]
1925        tokio::task::yield_now().await;
1926        StoreGuard {
1927            guard,
1928            _not_send: PhantomData,
1929        }
1930    }
1931
1932    pub async fn snapshot<'a>(self: &'a Arc<Self>) -> ServerSnapshot<'a> {
1933        ServerSnapshot {
1934            store: self.store().await,
1935            peer: &self.peer,
1936        }
1937    }
1938}
1939
1940impl<'a> Deref for StoreGuard<'a> {
1941    type Target = Store;
1942
1943    fn deref(&self) -> &Self::Target {
1944        &*self.guard
1945    }
1946}
1947
1948impl<'a> DerefMut for StoreGuard<'a> {
1949    fn deref_mut(&mut self) -> &mut Self::Target {
1950        &mut *self.guard
1951    }
1952}
1953
1954impl<'a> Drop for StoreGuard<'a> {
1955    fn drop(&mut self) {
1956        #[cfg(test)]
1957        self.check_invariants();
1958    }
1959}
1960
1961impl Executor for RealExecutor {
1962    type Sleep = Sleep;
1963
1964    fn spawn_detached<F: 'static + Send + Future<Output = ()>>(&self, future: F) {
1965        tokio::task::spawn(future);
1966    }
1967
1968    fn sleep(&self, duration: Duration) -> Self::Sleep {
1969        tokio::time::sleep(duration)
1970    }
1971}
1972
1973fn broadcast<F>(
1974    sender_id: ConnectionId,
1975    receiver_ids: impl IntoIterator<Item = ConnectionId>,
1976    mut f: F,
1977) where
1978    F: FnMut(ConnectionId) -> anyhow::Result<()>,
1979{
1980    for receiver_id in receiver_ids {
1981        if receiver_id != sender_id {
1982            f(receiver_id).trace_err();
1983        }
1984    }
1985}
1986
1987lazy_static! {
1988    static ref ZED_PROTOCOL_VERSION: HeaderName = HeaderName::from_static("x-zed-protocol-version");
1989}
1990
1991pub struct ProtocolVersion(u32);
1992
1993impl Header for ProtocolVersion {
1994    fn name() -> &'static HeaderName {
1995        &ZED_PROTOCOL_VERSION
1996    }
1997
1998    fn decode<'i, I>(values: &mut I) -> Result<Self, axum::headers::Error>
1999    where
2000        Self: Sized,
2001        I: Iterator<Item = &'i axum::http::HeaderValue>,
2002    {
2003        let version = values
2004            .next()
2005            .ok_or_else(axum::headers::Error::invalid)?
2006            .to_str()
2007            .map_err(|_| axum::headers::Error::invalid())?
2008            .parse()
2009            .map_err(|_| axum::headers::Error::invalid())?;
2010        Ok(Self(version))
2011    }
2012
2013    fn encode<E: Extend<axum::http::HeaderValue>>(&self, values: &mut E) {
2014        values.extend([self.0.to_string().parse().unwrap()]);
2015    }
2016}
2017
2018pub fn routes(server: Arc<Server>) -> Router<Body> {
2019    Router::new()
2020        .route("/rpc", get(handle_websocket_request))
2021        .layer(
2022            ServiceBuilder::new()
2023                .layer(Extension(server.app_state.clone()))
2024                .layer(middleware::from_fn(auth::validate_header)),
2025        )
2026        .route("/metrics", get(handle_metrics))
2027        .layer(Extension(server))
2028}
2029
2030pub async fn handle_websocket_request(
2031    TypedHeader(ProtocolVersion(protocol_version)): TypedHeader<ProtocolVersion>,
2032    ConnectInfo(socket_address): ConnectInfo<SocketAddr>,
2033    Extension(server): Extension<Arc<Server>>,
2034    Extension(user): Extension<User>,
2035    ws: WebSocketUpgrade,
2036) -> axum::response::Response {
2037    if protocol_version != rpc::PROTOCOL_VERSION {
2038        return (
2039            StatusCode::UPGRADE_REQUIRED,
2040            "client must be upgraded".to_string(),
2041        )
2042            .into_response();
2043    }
2044    let socket_address = socket_address.to_string();
2045    ws.on_upgrade(move |socket| {
2046        use util::ResultExt;
2047        let socket = socket
2048            .map_ok(to_tungstenite_message)
2049            .err_into()
2050            .with(|message| async move { Ok(to_axum_message(message)) });
2051        let connection = Connection::new(Box::pin(socket));
2052        async move {
2053            server
2054                .handle_connection(connection, socket_address, user, None, RealExecutor)
2055                .await
2056                .log_err();
2057        }
2058    })
2059}
2060
2061pub async fn handle_metrics(Extension(server): Extension<Arc<Server>>) -> axum::response::Response {
2062    // We call `store_mut` here for its side effects of updating metrics.
2063    let metrics = server.store().await.metrics();
2064    METRIC_CONNECTIONS.set(metrics.connections as _);
2065    METRIC_REGISTERED_PROJECTS.set(metrics.registered_projects as _);
2066    METRIC_ACTIVE_PROJECTS.set(metrics.active_projects as _);
2067    METRIC_SHARED_PROJECTS.set(metrics.shared_projects as _);
2068
2069    let encoder = prometheus::TextEncoder::new();
2070    let metric_families = prometheus::gather();
2071    match encoder.encode_to_string(&metric_families) {
2072        Ok(string) => (StatusCode::OK, string).into_response(),
2073        Err(error) => (
2074            StatusCode::INTERNAL_SERVER_ERROR,
2075            format!("failed to encode metrics {:?}", error),
2076        )
2077            .into_response(),
2078    }
2079}
2080
2081fn to_axum_message(message: TungsteniteMessage) -> AxumMessage {
2082    match message {
2083        TungsteniteMessage::Text(payload) => AxumMessage::Text(payload),
2084        TungsteniteMessage::Binary(payload) => AxumMessage::Binary(payload),
2085        TungsteniteMessage::Ping(payload) => AxumMessage::Ping(payload),
2086        TungsteniteMessage::Pong(payload) => AxumMessage::Pong(payload),
2087        TungsteniteMessage::Close(frame) => AxumMessage::Close(frame.map(|frame| AxumCloseFrame {
2088            code: frame.code.into(),
2089            reason: frame.reason,
2090        })),
2091    }
2092}
2093
2094fn to_tungstenite_message(message: AxumMessage) -> TungsteniteMessage {
2095    match message {
2096        AxumMessage::Text(payload) => TungsteniteMessage::Text(payload),
2097        AxumMessage::Binary(payload) => TungsteniteMessage::Binary(payload),
2098        AxumMessage::Ping(payload) => TungsteniteMessage::Ping(payload),
2099        AxumMessage::Pong(payload) => TungsteniteMessage::Pong(payload),
2100        AxumMessage::Close(frame) => {
2101            TungsteniteMessage::Close(frame.map(|frame| TungsteniteCloseFrame {
2102                code: frame.code.into(),
2103                reason: frame.reason,
2104            }))
2105        }
2106    }
2107}
2108
2109pub trait ResultExt {
2110    type Ok;
2111
2112    fn trace_err(self) -> Option<Self::Ok>;
2113}
2114
2115impl<T, E> ResultExt for Result<T, E>
2116where
2117    E: std::fmt::Debug,
2118{
2119    type Ok = T;
2120
2121    fn trace_err(self) -> Option<T> {
2122        match self {
2123            Ok(value) => Some(value),
2124            Err(error) => {
2125                tracing::error!("{:?}", error);
2126                None
2127            }
2128        }
2129    }
2130}