test.rs

  1use anyhow::{anyhow, Result};
  2use async_trait::async_trait;
  3use collections::{BTreeMap, HashMap};
  4use futures::Stream;
  5use gpui::executor::Background;
  6use live_kit_server::token;
  7use media::core_video::CVImageBuffer;
  8use parking_lot::Mutex;
  9use postage::watch;
 10use std::{future::Future, mem, sync::Arc};
 11
 12static SERVERS: Mutex<BTreeMap<String, Arc<TestServer>>> = Mutex::new(BTreeMap::new());
 13
 14pub struct TestServer {
 15    pub url: String,
 16    pub api_key: String,
 17    pub secret_key: String,
 18    rooms: Mutex<HashMap<String, TestServerRoom>>,
 19    background: Arc<Background>,
 20}
 21
 22impl TestServer {
 23    pub fn create(
 24        url: String,
 25        api_key: String,
 26        secret_key: String,
 27        background: Arc<Background>,
 28    ) -> Result<Arc<TestServer>> {
 29        let mut servers = SERVERS.lock();
 30        if servers.contains_key(&url) {
 31            Err(anyhow!("a server with url {:?} already exists", url))
 32        } else {
 33            let server = Arc::new(TestServer {
 34                url: url.clone(),
 35                api_key,
 36                secret_key,
 37                rooms: Default::default(),
 38                background,
 39            });
 40            servers.insert(url, server.clone());
 41            Ok(server)
 42        }
 43    }
 44
 45    fn get(url: &str) -> Result<Arc<TestServer>> {
 46        Ok(SERVERS
 47            .lock()
 48            .get(url)
 49            .ok_or_else(|| anyhow!("no server found for url"))?
 50            .clone())
 51    }
 52
 53    pub fn teardown(&self) -> Result<()> {
 54        SERVERS
 55            .lock()
 56            .remove(&self.url)
 57            .ok_or_else(|| anyhow!("server with url {:?} does not exist", self.url))?;
 58        Ok(())
 59    }
 60
 61    pub fn create_api_client(&self) -> TestApiClient {
 62        TestApiClient {
 63            url: self.url.clone(),
 64        }
 65    }
 66
 67    pub async fn create_room(&self, room: String) -> Result<()> {
 68        self.background.simulate_random_delay().await;
 69        let mut server_rooms = self.rooms.lock();
 70        if server_rooms.contains_key(&room) {
 71            Err(anyhow!("room {:?} already exists", room))
 72        } else {
 73            server_rooms.insert(room, Default::default());
 74            Ok(())
 75        }
 76    }
 77
 78    async fn delete_room(&self, room: String) -> Result<()> {
 79        // TODO: clear state associated with all `Room`s.
 80        self.background.simulate_random_delay().await;
 81        let mut server_rooms = self.rooms.lock();
 82        server_rooms
 83            .remove(&room)
 84            .ok_or_else(|| anyhow!("room {:?} does not exist", room))?;
 85        Ok(())
 86    }
 87
 88    async fn join_room(&self, token: String, client_room: Arc<Room>) -> Result<()> {
 89        self.background.simulate_random_delay().await;
 90        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
 91        let identity = claims.sub.unwrap().to_string();
 92        let room_name = claims.video.room.unwrap();
 93        let mut server_rooms = self.rooms.lock();
 94        let room = (*server_rooms).entry(room_name.to_string()).or_default();
 95
 96        if room.client_rooms.contains_key(&identity) {
 97            Err(anyhow!(
 98                "{:?} attempted to join room {:?} twice",
 99                identity,
100                room_name
101            ))
102        } else {
103            for track in &room.video_tracks {
104                client_room
105                    .0
106                    .lock()
107                    .video_track_updates
108                    .0
109                    .try_broadcast(RemoteVideoTrackUpdate::Subscribed(track.clone()))
110                    .unwrap();
111            }
112            room.client_rooms.insert(identity, client_room);
113            Ok(())
114        }
115    }
116
117    async fn leave_room(&self, token: String) -> Result<()> {
118        self.background.simulate_random_delay().await;
119        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
120        let identity = claims.sub.unwrap().to_string();
121        let room_name = claims.video.room.unwrap();
122        let mut server_rooms = self.rooms.lock();
123        let room = server_rooms
124            .get_mut(&*room_name)
125            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
126        room.client_rooms.remove(&identity).ok_or_else(|| {
127            anyhow!(
128                "{:?} attempted to leave room {:?} before joining it",
129                identity,
130                room_name
131            )
132        })?;
133        Ok(())
134    }
135
136    async fn remove_participant(&self, room_name: String, identity: String) -> Result<()> {
137        // TODO: clear state associated with the `Room`.
138
139        self.background.simulate_random_delay().await;
140        let mut server_rooms = self.rooms.lock();
141        let room = server_rooms
142            .get_mut(&room_name)
143            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
144        room.client_rooms.remove(&identity).ok_or_else(|| {
145            anyhow!(
146                "participant {:?} did not join room {:?}",
147                identity,
148                room_name
149            )
150        })?;
151        Ok(())
152    }
153
154    pub async fn disconnect_client(&self, client_identity: String) {
155        self.background.simulate_random_delay().await;
156        let mut server_rooms = self.rooms.lock();
157        for room in server_rooms.values_mut() {
158            if let Some(room) = room.client_rooms.remove(&client_identity) {
159                *room.0.lock().connection.0.borrow_mut() = ConnectionState::Disconnected;
160            }
161        }
162    }
163
164    async fn publish_video_track(&self, token: String, local_track: LocalVideoTrack) -> Result<()> {
165        self.background.simulate_random_delay().await;
166        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
167        let identity = claims.sub.unwrap().to_string();
168        let room_name = claims.video.room.unwrap();
169
170        let mut server_rooms = self.rooms.lock();
171        let room = server_rooms
172            .get_mut(&*room_name)
173            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
174
175        let track = Arc::new(RemoteVideoTrack {
176            sid: nanoid::nanoid!(17),
177            publisher_id: identity.clone(),
178            frames_rx: local_track.frames_rx.clone(),
179        });
180
181        room.video_tracks.push(track.clone());
182
183        for (id, client_room) in &room.client_rooms {
184            if *id != identity {
185                let _ = client_room
186                    .0
187                    .lock()
188                    .video_track_updates
189                    .0
190                    .try_broadcast(RemoteVideoTrackUpdate::Subscribed(track.clone()))
191                    .unwrap();
192            }
193        }
194
195        Ok(())
196    }
197
198    async fn publish_audio_track(
199        &self,
200        token: String,
201        _local_track: &LocalAudioTrack,
202    ) -> Result<()> {
203        self.background.simulate_random_delay().await;
204        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
205        let identity = claims.sub.unwrap().to_string();
206        let room_name = claims.video.room.unwrap();
207
208        let mut server_rooms = self.rooms.lock();
209        let room = server_rooms
210            .get_mut(&*room_name)
211            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
212
213        let track = Arc::new(RemoteAudioTrack {
214            sid: nanoid::nanoid!(17),
215            publisher_id: identity.clone(),
216        });
217
218        let publication = Arc::new(RemoteTrackPublication);
219
220        room.audio_tracks.push(track.clone());
221
222        for (id, client_room) in &room.client_rooms {
223            if *id != identity {
224                let _ = client_room
225                    .0
226                    .lock()
227                    .audio_track_updates
228                    .0
229                    .try_broadcast(RemoteAudioTrackUpdate::Subscribed(
230                        track.clone(),
231                        publication.clone(),
232                    ))
233                    .unwrap();
234            }
235        }
236
237        Ok(())
238    }
239
240    fn video_tracks(&self, token: String) -> Result<Vec<Arc<RemoteVideoTrack>>> {
241        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
242        let room_name = claims.video.room.unwrap();
243
244        let mut server_rooms = self.rooms.lock();
245        let room = server_rooms
246            .get_mut(&*room_name)
247            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
248        Ok(room.video_tracks.clone())
249    }
250
251    fn audio_tracks(&self, token: String) -> Result<Vec<Arc<RemoteAudioTrack>>> {
252        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
253        let room_name = claims.video.room.unwrap();
254
255        let mut server_rooms = self.rooms.lock();
256        let room = server_rooms
257            .get_mut(&*room_name)
258            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
259        Ok(room.audio_tracks.clone())
260    }
261}
262
263#[derive(Default)]
264struct TestServerRoom {
265    client_rooms: HashMap<Sid, Arc<Room>>,
266    video_tracks: Vec<Arc<RemoteVideoTrack>>,
267    audio_tracks: Vec<Arc<RemoteAudioTrack>>,
268}
269
270impl TestServerRoom {}
271
272pub struct TestApiClient {
273    url: String,
274}
275
276#[async_trait]
277impl live_kit_server::api::Client for TestApiClient {
278    fn url(&self) -> &str {
279        &self.url
280    }
281
282    async fn create_room(&self, name: String) -> Result<()> {
283        let server = TestServer::get(&self.url)?;
284        server.create_room(name).await?;
285        Ok(())
286    }
287
288    async fn delete_room(&self, name: String) -> Result<()> {
289        let server = TestServer::get(&self.url)?;
290        server.delete_room(name).await?;
291        Ok(())
292    }
293
294    async fn remove_participant(&self, room: String, identity: String) -> Result<()> {
295        let server = TestServer::get(&self.url)?;
296        server.remove_participant(room, identity).await?;
297        Ok(())
298    }
299
300    fn room_token(&self, room: &str, identity: &str) -> Result<String> {
301        let server = TestServer::get(&self.url)?;
302        token::create(
303            &server.api_key,
304            &server.secret_key,
305            Some(identity),
306            token::VideoGrant::to_join(room),
307        )
308    }
309}
310
311pub type Sid = String;
312
313struct RoomState {
314    connection: (
315        watch::Sender<ConnectionState>,
316        watch::Receiver<ConnectionState>,
317    ),
318    display_sources: Vec<MacOSDisplay>,
319    audio_track_updates: (
320        async_broadcast::Sender<RemoteAudioTrackUpdate>,
321        async_broadcast::Receiver<RemoteAudioTrackUpdate>,
322    ),
323    video_track_updates: (
324        async_broadcast::Sender<RemoteVideoTrackUpdate>,
325        async_broadcast::Receiver<RemoteVideoTrackUpdate>,
326    ),
327}
328
329#[derive(Clone, Eq, PartialEq)]
330pub enum ConnectionState {
331    Disconnected,
332    Connected { url: String, token: String },
333}
334
335pub struct Room(Mutex<RoomState>);
336
337impl Room {
338    pub fn new() -> Arc<Self> {
339        Arc::new(Self(Mutex::new(RoomState {
340            connection: watch::channel_with(ConnectionState::Disconnected),
341            display_sources: Default::default(),
342            video_track_updates: async_broadcast::broadcast(128),
343            audio_track_updates: async_broadcast::broadcast(128),
344        })))
345    }
346
347    pub fn status(&self) -> watch::Receiver<ConnectionState> {
348        self.0.lock().connection.1.clone()
349    }
350
351    pub fn connect(self: &Arc<Self>, url: &str, token: &str) -> impl Future<Output = Result<()>> {
352        let this = self.clone();
353        let url = url.to_string();
354        let token = token.to_string();
355        async move {
356            let server = TestServer::get(&url)?;
357            server.join_room(token.clone(), this.clone()).await?;
358            *this.0.lock().connection.0.borrow_mut() = ConnectionState::Connected { url, token };
359            Ok(())
360        }
361    }
362
363    pub fn display_sources(self: &Arc<Self>) -> impl Future<Output = Result<Vec<MacOSDisplay>>> {
364        let this = self.clone();
365        async move {
366            let server = this.test_server();
367            server.background.simulate_random_delay().await;
368            Ok(this.0.lock().display_sources.clone())
369        }
370    }
371
372    pub fn publish_video_track(
373        self: &Arc<Self>,
374        track: &LocalVideoTrack,
375    ) -> impl Future<Output = Result<LocalTrackPublication>> {
376        let this = self.clone();
377        let track = track.clone();
378        async move {
379            this.test_server()
380                .publish_video_track(this.token(), track)
381                .await?;
382            Ok(LocalTrackPublication)
383        }
384    }
385    pub fn publish_audio_track(
386        self: &Arc<Self>,
387        track: &LocalAudioTrack,
388    ) -> impl Future<Output = Result<LocalTrackPublication>> {
389        let this = self.clone();
390        let track = track.clone();
391        async move {
392            this.test_server()
393                .publish_audio_track(this.token(), &track)
394                .await?;
395            Ok(LocalTrackPublication)
396        }
397    }
398
399    pub fn unpublish_track(&self, _publication: LocalTrackPublication) {}
400
401    pub fn remote_audio_tracks(&self, publisher_id: &str) -> Vec<Arc<RemoteAudioTrack>> {
402        if !self.is_connected() {
403            return Vec::new();
404        }
405
406        self.test_server()
407            .audio_tracks(self.token())
408            .unwrap()
409            .into_iter()
410            .filter(|track| track.publisher_id() == publisher_id)
411            .collect()
412    }
413
414    pub fn remote_audio_track_publications(
415        &self,
416        publisher_id: &str,
417    ) -> Vec<Arc<RemoteTrackPublication>> {
418        if !self.is_connected() {
419            return Vec::new();
420        }
421
422        self.test_server()
423            .audio_tracks(self.token())
424            .unwrap()
425            .into_iter()
426            .filter(|track| track.publisher_id() == publisher_id)
427            .map(|_track| Arc::new(RemoteTrackPublication {}))
428            .collect()
429    }
430
431    pub fn remote_video_tracks(&self, publisher_id: &str) -> Vec<Arc<RemoteVideoTrack>> {
432        if !self.is_connected() {
433            return Vec::new();
434        }
435
436        self.test_server()
437            .video_tracks(self.token())
438            .unwrap()
439            .into_iter()
440            .filter(|track| track.publisher_id() == publisher_id)
441            .collect()
442    }
443
444    pub fn remote_audio_track_updates(&self) -> impl Stream<Item = RemoteAudioTrackUpdate> {
445        self.0.lock().audio_track_updates.1.clone()
446    }
447
448    pub fn remote_video_track_updates(&self) -> impl Stream<Item = RemoteVideoTrackUpdate> {
449        self.0.lock().video_track_updates.1.clone()
450    }
451
452    pub fn set_display_sources(&self, sources: Vec<MacOSDisplay>) {
453        self.0.lock().display_sources = sources;
454    }
455
456    fn test_server(&self) -> Arc<TestServer> {
457        match self.0.lock().connection.1.borrow().clone() {
458            ConnectionState::Disconnected => panic!("must be connected to call this method"),
459            ConnectionState::Connected { url, .. } => TestServer::get(&url).unwrap(),
460        }
461    }
462
463    fn token(&self) -> String {
464        match self.0.lock().connection.1.borrow().clone() {
465            ConnectionState::Disconnected => panic!("must be connected to call this method"),
466            ConnectionState::Connected { token, .. } => token,
467        }
468    }
469
470    fn is_connected(&self) -> bool {
471        match *self.0.lock().connection.1.borrow() {
472            ConnectionState::Disconnected => false,
473            ConnectionState::Connected { .. } => true,
474        }
475    }
476}
477
478impl Drop for Room {
479    fn drop(&mut self) {
480        if let ConnectionState::Connected { token, .. } = mem::replace(
481            &mut *self.0.lock().connection.0.borrow_mut(),
482            ConnectionState::Disconnected,
483        ) {
484            if let Ok(server) = TestServer::get(&token) {
485                let background = server.background.clone();
486                background
487                    .spawn(async move { server.leave_room(token).await.unwrap() })
488                    .detach();
489            }
490        }
491    }
492}
493
494pub struct LocalTrackPublication;
495
496impl LocalTrackPublication {
497    pub fn set_mute(&self, _mute: bool) -> impl Future<Output = Result<()>> {
498        async { Ok(()) }
499    }
500}
501
502pub struct RemoteTrackPublication;
503
504impl RemoteTrackPublication {
505    pub fn set_enabled(&self, _enabled: bool) -> impl Future<Output = Result<()>> {
506        async { Ok(()) }
507    }
508
509    pub fn is_muted(&self) -> bool {
510        false
511    }
512
513    pub fn sid(&self) -> String {
514        "".to_string()
515    }
516}
517
518#[derive(Clone)]
519pub struct LocalVideoTrack {
520    frames_rx: async_broadcast::Receiver<Frame>,
521}
522
523impl LocalVideoTrack {
524    pub fn screen_share_for_display(display: &MacOSDisplay) -> Self {
525        Self {
526            frames_rx: display.frames.1.clone(),
527        }
528    }
529}
530
531#[derive(Clone)]
532pub struct LocalAudioTrack;
533
534impl LocalAudioTrack {
535    pub fn create() -> Self {
536        Self
537    }
538}
539
540pub struct RemoteVideoTrack {
541    sid: Sid,
542    publisher_id: Sid,
543    frames_rx: async_broadcast::Receiver<Frame>,
544}
545
546impl RemoteVideoTrack {
547    pub fn sid(&self) -> &str {
548        &self.sid
549    }
550
551    pub fn publisher_id(&self) -> &str {
552        &self.publisher_id
553    }
554
555    pub fn frames(&self) -> async_broadcast::Receiver<Frame> {
556        self.frames_rx.clone()
557    }
558}
559
560#[derive(Debug)]
561pub struct RemoteAudioTrack {
562    sid: Sid,
563    publisher_id: Sid,
564}
565
566impl RemoteAudioTrack {
567    pub fn sid(&self) -> &str {
568        &self.sid
569    }
570
571    pub fn publisher_id(&self) -> &str {
572        &self.publisher_id
573    }
574
575    pub fn enable(&self) -> impl Future<Output = Result<()>> {
576        async { Ok(()) }
577    }
578
579    pub fn disable(&self) -> impl Future<Output = Result<()>> {
580        async { Ok(()) }
581    }
582}
583
584#[derive(Clone)]
585pub enum RemoteVideoTrackUpdate {
586    Subscribed(Arc<RemoteVideoTrack>),
587    Unsubscribed { publisher_id: Sid, track_id: Sid },
588}
589
590#[derive(Clone)]
591pub enum RemoteAudioTrackUpdate {
592    ActiveSpeakersChanged { speakers: Vec<Sid> },
593    MuteChanged { track_id: Sid, muted: bool },
594    Subscribed(Arc<RemoteAudioTrack>, Arc<RemoteTrackPublication>),
595    Unsubscribed { publisher_id: Sid, track_id: Sid },
596}
597
598#[derive(Clone)]
599pub struct MacOSDisplay {
600    frames: (
601        async_broadcast::Sender<Frame>,
602        async_broadcast::Receiver<Frame>,
603    ),
604}
605
606impl MacOSDisplay {
607    pub fn new() -> Self {
608        Self {
609            frames: async_broadcast::broadcast(128),
610        }
611    }
612
613    pub fn send_frame(&self, frame: Frame) {
614        self.frames.0.try_broadcast(frame).unwrap();
615    }
616}
617
618#[derive(Clone, Debug, PartialEq, Eq)]
619pub struct Frame {
620    pub label: String,
621    pub width: usize,
622    pub height: usize,
623}
624
625impl Frame {
626    pub fn width(&self) -> usize {
627        self.width
628    }
629
630    pub fn height(&self) -> usize {
631        self.height
632    }
633
634    pub fn image(&self) -> CVImageBuffer {
635        unimplemented!("you can't call this in test mode")
636    }
637}