pub mod participant; pub mod room; use anyhow::{Context as _, Result, anyhow}; use audio::Audio; use client::{ChannelId, Client, TypedEnvelope, User, UserStore, ZED_ALWAYS_ACTIVE, proto}; use collections::HashSet; use futures::{Future, FutureExt, channel::oneshot, future::Shared}; use gpui::{ AnyView, App, AppContext as _, AsyncApp, Context, Entity, EventEmitter, Subscription, Task, WeakEntity, Window, }; use postage::watch; use project::Project; use room::Event; use settings::Settings; use std::sync::Arc; use workspace::{ ActiveCallEvent, AnyActiveCall, GlobalAnyActiveCall, Pane, RemoteCollaborator, SharedScreen, Workspace, }; pub use livekit_client::{RemoteVideoTrack, RemoteVideoTrackView, RemoteVideoTrackViewEvent}; pub use room::Room; use crate::call_settings::CallSettings; pub fn init(client: Arc, user_store: Entity, cx: &mut App) { let active_call = cx.new(|cx| ActiveCall::new(client, user_store, cx)); cx.set_global(GlobalAnyActiveCall(Arc::new(ActiveCallEntity(active_call)))) } #[derive(Clone)] struct ActiveCallEntity(Entity); impl AnyActiveCall for ActiveCallEntity { fn entity(&self) -> gpui::AnyEntity { self.0.clone().into_any() } fn is_in_room(&self, cx: &App) -> bool { self.0.read(cx).room().is_some() } fn room_id(&self, cx: &App) -> Option { Some(self.0.read(cx).room()?.read(cx).id()) } fn channel_id(&self, cx: &App) -> Option { self.0.read(cx).room()?.read(cx).channel_id() } fn hang_up(&self, cx: &mut App) -> Task> { self.0.update(cx, |this, cx| this.hang_up(cx)) } fn unshare_project(&self, project: Entity, cx: &mut App) -> Result<()> { self.0 .update(cx, |this, cx| this.unshare_project(project, cx)) } fn remote_participant_for_peer_id( &self, peer_id: proto::PeerId, cx: &App, ) -> Option { let room = self.0.read(cx).room()?.read(cx); let participant = room.remote_participant_for_peer_id(peer_id)?; Some(RemoteCollaborator { user: participant.user.clone(), peer_id: participant.peer_id, location: participant.location, participant_index: participant.participant_index, }) } fn is_sharing_project(&self, cx: &App) -> bool { self.0 .read(cx) .room() .map_or(false, |room| room.read(cx).is_sharing_project()) } fn has_remote_participants(&self, cx: &App) -> bool { self.0.read(cx).room().map_or(false, |room| { !room.read(cx).remote_participants().is_empty() }) } fn local_participant_is_guest(&self, cx: &App) -> bool { self.0 .read(cx) .room() .map_or(false, |room| room.read(cx).local_participant_is_guest()) } fn client(&self, cx: &App) -> Arc { self.0.read(cx).client() } fn share_on_join(&self, cx: &App) -> bool { CallSettings::get_global(cx).share_on_join } fn join_channel(&self, channel_id: ChannelId, cx: &mut App) -> Task> { let task = self .0 .update(cx, |this, cx| this.join_channel(channel_id, cx)); cx.spawn(async move |_cx| { let result = task.await?; Ok(result.is_some()) }) } fn room_update_completed(&self, cx: &mut App) -> Task<()> { let Some(room) = self.0.read(cx).room().cloned() else { return Task::ready(()); }; let future = room.update(cx, |room, _cx| room.room_update_completed()); cx.spawn(async move |_cx| { future.await; }) } fn most_active_project(&self, cx: &App) -> Option<(u64, u64)> { let room = self.0.read(cx).room()?; room.read(cx).most_active_project(cx) } fn share_project(&self, project: Entity, cx: &mut App) -> Task> { self.0 .update(cx, |this, cx| this.share_project(project, cx)) } fn join_project( &self, project_id: u64, language_registry: Arc, fs: Arc, cx: &mut App, ) -> Task>> { let Some(room) = self.0.read(cx).room().cloned() else { return Task::ready(Err(anyhow::anyhow!("not in a call"))); }; room.update(cx, |room, cx| { room.join_project(project_id, language_registry, fs, cx) }) } fn peer_id_for_user_in_room(&self, user_id: u64, cx: &App) -> Option { let room = self.0.read(cx).room()?.read(cx); room.remote_participants() .values() .find(|p| p.user.id == user_id) .map(|p| p.peer_id) } fn subscribe( &self, window: &mut Window, cx: &mut Context, handler: Box< dyn Fn(&mut Workspace, &ActiveCallEvent, &mut Window, &mut Context), >, ) -> Subscription { cx.subscribe_in( &self.0, window, move |workspace, _, event: &room::Event, window, cx| { let mapped = match event { room::Event::ParticipantLocationChanged { participant_id } => { Some(ActiveCallEvent::ParticipantLocationChanged { participant_id: *participant_id, }) } room::Event::RemoteVideoTracksChanged { participant_id } => { Some(ActiveCallEvent::RemoteVideoTracksChanged { participant_id: *participant_id, }) } _ => None, }; if let Some(event) = mapped { handler(workspace, &event, window, cx); } }, ) } fn create_shared_screen( &self, peer_id: client::proto::PeerId, pane: &Entity, window: &mut Window, cx: &mut App, ) -> Option> { let room = self.0.read(cx).room()?.clone(); let participant = room.read(cx).remote_participant_for_peer_id(peer_id)?; let track = participant.video_tracks.values().next()?.clone(); let user = participant.user.clone(); for item in pane.read(cx).items_of_type::() { if item.read(cx).peer_id == peer_id { return Some(item); } } Some(cx.new(|cx: &mut Context| { let my_sid = track.sid(); cx.subscribe( &room, move |_: &mut SharedScreen, _: Entity, ev: &room::Event, cx: &mut Context| { if let room::Event::RemoteVideoTrackUnsubscribed { sid } = ev && *sid == my_sid { cx.emit(workspace::shared_screen::Event::Close); } }, ) .detach(); cx.observe_release( &room, |_: &mut SharedScreen, _: &mut Room, cx: &mut Context| { cx.emit(workspace::shared_screen::Event::Close); }, ) .detach(); let view = cx.new(|cx| RemoteVideoTrackView::new(track.clone(), window, cx)); cx.subscribe( &view, |_: &mut SharedScreen, _: Entity, ev: &RemoteVideoTrackViewEvent, cx: &mut Context| match ev { RemoteVideoTrackViewEvent::Close => { cx.emit(workspace::shared_screen::Event::Close); } }, ) .detach(); pub(super) fn clone_remote_video_track_view( view: &AnyView, window: &mut Window, cx: &mut App, ) -> AnyView { let view = view .clone() .downcast::() .expect("SharedScreen view must be a RemoteVideoTrackView"); let cloned = view.update(cx, |view, cx| view.clone(window, cx)); AnyView::from(cloned) } SharedScreen::new( peer_id, user, AnyView::from(view), clone_remote_video_track_view, cx, ) })) } } pub struct OneAtATime { cancel: Option>, } impl OneAtATime { /// spawn a task in the given context. /// if another task is spawned before that resolves, or if the OneAtATime itself is dropped, the first task will be cancelled and return Ok(None) /// otherwise you'll see the result of the task. fn spawn(&mut self, cx: &mut App, f: F) -> Task>> where F: 'static + FnOnce(AsyncApp) -> Fut, Fut: Future>, R: 'static, { let (tx, rx) = oneshot::channel(); self.cancel.replace(tx); cx.spawn(async move |cx| { futures::select_biased! { _ = rx.fuse() => Ok(None), result = f(cx.clone()).fuse() => result.map(Some), } }) } fn running(&self) -> bool { self.cancel .as_ref() .is_some_and(|cancel| !cancel.is_canceled()) } } #[derive(Clone)] pub struct IncomingCall { pub room_id: u64, pub calling_user: Arc, pub participants: Vec>, pub initial_project: Option, } /// Singleton global maintaining the user's participation in a room across workspaces. pub struct ActiveCall { room: Option<(Entity, Vec)>, pending_room_creation: Option, Arc>>>>, location: Option>, _join_debouncer: OneAtATime, pending_invites: HashSet, incoming_call: ( watch::Sender>, watch::Receiver>, ), client: Arc, user_store: Entity, _subscriptions: Vec, } impl EventEmitter for ActiveCall {} impl ActiveCall { fn new(client: Arc, user_store: Entity, cx: &mut Context) -> Self { Self { room: None, pending_room_creation: None, location: None, pending_invites: Default::default(), incoming_call: watch::channel(), _join_debouncer: OneAtATime { cancel: None }, _subscriptions: vec![ client.add_request_handler(cx.weak_entity(), Self::handle_incoming_call), client.add_message_handler(cx.weak_entity(), Self::handle_call_canceled), ], client, user_store, } } pub fn channel_id(&self, cx: &App) -> Option { self.room()?.read(cx).channel_id() } async fn handle_incoming_call( this: Entity, envelope: TypedEnvelope, mut cx: AsyncApp, ) -> Result { let user_store = this.read_with(&cx, |this, _| this.user_store.clone()); let call = IncomingCall { room_id: envelope.payload.room_id, participants: user_store .update(&mut cx, |user_store, cx| { user_store.get_users(envelope.payload.participant_user_ids, cx) }) .await?, calling_user: user_store .update(&mut cx, |user_store, cx| { user_store.get_user(envelope.payload.calling_user_id, cx) }) .await?, initial_project: envelope.payload.initial_project, }; this.update(&mut cx, |this, _| { *this.incoming_call.0.borrow_mut() = Some(call); }); Ok(proto::Ack {}) } async fn handle_call_canceled( this: Entity, envelope: TypedEnvelope, mut cx: AsyncApp, ) -> Result<()> { this.update(&mut cx, |this, _| { let mut incoming_call = this.incoming_call.0.borrow_mut(); if incoming_call .as_ref() .is_some_and(|call| call.room_id == envelope.payload.room_id) { incoming_call.take(); } }); Ok(()) } pub fn global(cx: &App) -> Entity { Self::try_global(cx).unwrap() } pub fn try_global(cx: &App) -> Option> { let any = cx.try_global::()?; any.0.entity().downcast::().ok() } pub fn invite( &mut self, called_user_id: u64, initial_project: Option>, cx: &mut Context, ) -> Task> { if !self.pending_invites.insert(called_user_id) { return Task::ready(Err(anyhow!("user was already invited"))); } cx.notify(); if self._join_debouncer.running() { return Task::ready(Ok(())); } let room = if let Some(room) = self.room().cloned() { Some(Task::ready(Ok(room)).shared()) } else { self.pending_room_creation.clone() }; let invite = if let Some(room) = room { cx.spawn(async move |_, cx| { let room = room.await.map_err(|err| anyhow!("{err:?}"))?; let initial_project_id = if let Some(initial_project) = initial_project { Some( room.update(cx, |room, cx| room.share_project(initial_project, cx)) .await?, ) } else { None }; room.update(cx, move |room, cx| { room.call(called_user_id, initial_project_id, cx) }) .await?; anyhow::Ok(()) }) } else { let client = self.client.clone(); let user_store = self.user_store.clone(); let room = cx .spawn(async move |this, cx| { let create_room = async { let room = cx .update(|cx| { Room::create( called_user_id, initial_project, client, user_store, cx, ) }) .await?; this.update(cx, |this, cx| this.set_room(Some(room.clone()), cx))? .await?; anyhow::Ok(room) }; let room = create_room.await; this.update(cx, |this, _| this.pending_room_creation = None)?; room.map_err(Arc::new) }) .shared(); self.pending_room_creation = Some(room.clone()); cx.background_spawn(async move { room.await.map_err(|err| anyhow!("{err:?}"))?; anyhow::Ok(()) }) }; cx.spawn(async move |this, cx| { let result = invite.await; if result.is_ok() { this.update(cx, |this, cx| { this.report_call_event("Participant Invited", cx) })?; } else { //TODO: report collaboration error log::error!("invite failed: {:?}", result); } this.update(cx, |this, cx| { this.pending_invites.remove(&called_user_id); cx.notify(); })?; result }) } pub fn cancel_invite( &mut self, called_user_id: u64, cx: &mut Context, ) -> Task> { let room_id = if let Some(room) = self.room() { room.read(cx).id() } else { return Task::ready(Err(anyhow!("no active call"))); }; let client = self.client.clone(); cx.background_spawn(async move { client .request(proto::CancelCall { room_id, called_user_id, }) .await?; anyhow::Ok(()) }) } pub fn incoming(&self) -> watch::Receiver> { self.incoming_call.1.clone() } pub fn accept_incoming(&mut self, cx: &mut Context) -> Task> { if self.room.is_some() { return Task::ready(Err(anyhow!("cannot join while on another call"))); } let call = if let Some(call) = self.incoming_call.0.borrow_mut().take() { call } else { return Task::ready(Err(anyhow!("no incoming call"))); }; if self.pending_room_creation.is_some() { return Task::ready(Ok(())); } let room_id = call.room_id; let client = self.client.clone(); let user_store = self.user_store.clone(); let join = self ._join_debouncer .spawn(cx, move |cx| Room::join(room_id, client, user_store, cx)); cx.spawn(async move |this, cx| { let room = join.await?; this.update(cx, |this, cx| this.set_room(room.clone(), cx))? .await?; this.update(cx, |this, cx| { this.report_call_event("Incoming Call Accepted", cx) })?; Ok(()) }) } pub fn decline_incoming(&mut self, _: &mut Context) -> Result<()> { let call = self .incoming_call .0 .borrow_mut() .take() .context("no incoming call")?; telemetry::event!("Incoming Call Declined", room_id = call.room_id); self.client.send(proto::DeclineCall { room_id: call.room_id, })?; Ok(()) } pub fn join_channel( &mut self, channel_id: ChannelId, cx: &mut Context, ) -> Task>>> { if let Some(room) = self.room().cloned() { if room.read(cx).channel_id() == Some(channel_id) { return Task::ready(Ok(Some(room))); } else { room.update(cx, |room, cx| room.clear_state(cx)); } } if self.pending_room_creation.is_some() { return Task::ready(Ok(None)); } let client = self.client.clone(); let user_store = self.user_store.clone(); let join = self._join_debouncer.spawn(cx, move |cx| async move { Room::join_channel(channel_id, client, user_store, cx).await }); cx.spawn(async move |this, cx| { let room = join.await?; this.update(cx, |this, cx| this.set_room(room.clone(), cx))? .await?; this.update(cx, |this, cx| this.report_call_event("Channel Joined", cx))?; Ok(room) }) } pub fn hang_up(&mut self, cx: &mut Context) -> Task> { cx.notify(); self.report_call_event("Call Ended", cx); Audio::end_call(cx); let channel_id = self.channel_id(cx); if let Some((room, _)) = self.room.take() { cx.emit(Event::RoomLeft { channel_id }); room.update(cx, |room, cx| room.leave(cx)) } else { Task::ready(Ok(())) } } pub fn share_project( &mut self, project: Entity, cx: &mut Context, ) -> Task> { if let Some((room, _)) = self.room.as_ref() { self.report_call_event("Project Shared", cx); room.update(cx, |room, cx| room.share_project(project, cx)) } else { Task::ready(Err(anyhow!("no active call"))) } } pub fn unshare_project( &mut self, project: Entity, cx: &mut Context, ) -> Result<()> { let (room, _) = self.room.as_ref().context("no active call")?; self.report_call_event("Project Unshared", cx); room.update(cx, |room, cx| room.unshare_project(project, cx)) } pub fn location(&self) -> Option<&WeakEntity> { self.location.as_ref() } pub fn set_location( &mut self, project: Option<&Entity>, cx: &mut Context, ) -> Task> { if project.is_some() || !*ZED_ALWAYS_ACTIVE { self.location = project.map(|project| project.downgrade()); if let Some((room, _)) = self.room.as_ref() { return room.update(cx, |room, cx| room.set_location(project, cx)); } } Task::ready(Ok(())) } fn set_room(&mut self, room: Option>, cx: &mut Context) -> Task> { if room.as_ref() == self.room.as_ref().map(|room| &room.0) { Task::ready(Ok(())) } else { cx.notify(); if let Some(room) = room { if room.read(cx).status().is_offline() { self.room = None; Task::ready(Ok(())) } else { let subscriptions = vec![ cx.observe(&room, |this, room, cx| { if room.read(cx).status().is_offline() { this.set_room(None, cx).detach_and_log_err(cx); } cx.notify(); }), cx.subscribe(&room, |_, _, event, cx| cx.emit(event.clone())), ]; self.room = Some((room.clone(), subscriptions)); let location = self .location .as_ref() .and_then(|location| location.upgrade()); let channel_id = room.read(cx).channel_id(); cx.emit(Event::RoomJoined { channel_id }); room.update(cx, |room, cx| room.set_location(location.as_ref(), cx)) } } else { self.room = None; Task::ready(Ok(())) } } } pub fn room(&self) -> Option<&Entity> { self.room.as_ref().map(|(room, _)| room) } pub fn client(&self) -> Arc { self.client.clone() } pub fn pending_invites(&self) -> &HashSet { &self.pending_invites } pub fn report_call_event(&self, operation: &'static str, cx: &mut App) { if let Some(room) = self.room() { let room = room.read(cx); telemetry::event!( operation, room_id = room.id(), channel_id = room.channel_id() ) } } } #[cfg(test)] mod test { use gpui::TestAppContext; use crate::OneAtATime; #[gpui::test] async fn test_one_at_a_time(cx: &mut TestAppContext) { let mut one_at_a_time = OneAtATime { cancel: None }; assert_eq!( cx.update(|cx| one_at_a_time.spawn(cx, |_| async { Ok(1) })) .await .unwrap(), Some(1) ); let (a, b) = cx.update(|cx| { ( one_at_a_time.spawn(cx, |_| async { panic!(""); }), one_at_a_time.spawn(cx, |_| async { Ok(3) }), ) }); assert_eq!(a.await.unwrap(), None::); assert_eq!(b.await.unwrap(), Some(3)); let promise = cx.update(|cx| one_at_a_time.spawn(cx, |_| async { Ok(4) })); drop(one_at_a_time); assert_eq!(promise.await.unwrap(), None); } }