test.rs

  1use anyhow::{anyhow, Result};
  2use async_trait::async_trait;
  3use collections::HashMap;
  4use futures::Stream;
  5use gpui::executor::Background;
  6use lazy_static::lazy_static;
  7use live_kit_server::token;
  8use media::core_video::CVImageBuffer;
  9use parking_lot::Mutex;
 10use postage::watch;
 11use std::{future::Future, mem, sync::Arc};
 12
 13lazy_static! {
 14    static ref SERVERS: Mutex<HashMap<String, Arc<TestServer>>> = Default::default();
 15}
 16
 17pub struct TestServer {
 18    pub url: String,
 19    pub api_key: String,
 20    pub secret_key: String,
 21    rooms: Mutex<HashMap<String, TestServerRoom>>,
 22    background: Arc<Background>,
 23}
 24
 25impl TestServer {
 26    pub fn create(
 27        url: String,
 28        api_key: String,
 29        secret_key: String,
 30        background: Arc<Background>,
 31    ) -> Result<Arc<TestServer>> {
 32        let mut servers = SERVERS.lock();
 33        if servers.contains_key(&url) {
 34            Err(anyhow!("a server with url {:?} already exists", url))
 35        } else {
 36            let server = Arc::new(TestServer {
 37                url: url.clone(),
 38                api_key,
 39                secret_key,
 40                rooms: Default::default(),
 41                background,
 42            });
 43            servers.insert(url, server.clone());
 44            Ok(server)
 45        }
 46    }
 47
 48    fn get(url: &str) -> Result<Arc<TestServer>> {
 49        Ok(SERVERS
 50            .lock()
 51            .get(url)
 52            .ok_or_else(|| anyhow!("no server found for url"))?
 53            .clone())
 54    }
 55
 56    pub fn teardown(&self) -> Result<()> {
 57        SERVERS
 58            .lock()
 59            .remove(&self.url)
 60            .ok_or_else(|| anyhow!("server with url {:?} does not exist", self.url))?;
 61        Ok(())
 62    }
 63
 64    pub fn create_api_client(&self) -> TestApiClient {
 65        TestApiClient {
 66            url: self.url.clone(),
 67        }
 68    }
 69
 70    async fn create_room(&self, room: String) -> Result<()> {
 71        self.background.simulate_random_delay().await;
 72        let mut server_rooms = self.rooms.lock();
 73        if server_rooms.contains_key(&room) {
 74            Err(anyhow!("room {:?} already exists", room))
 75        } else {
 76            server_rooms.insert(room, Default::default());
 77            Ok(())
 78        }
 79    }
 80
 81    async fn delete_room(&self, room: String) -> Result<()> {
 82        // TODO: clear state associated with all `Room`s.
 83        self.background.simulate_random_delay().await;
 84        let mut server_rooms = self.rooms.lock();
 85        server_rooms
 86            .remove(&room)
 87            .ok_or_else(|| anyhow!("room {:?} does not exist", room))?;
 88        Ok(())
 89    }
 90
 91    async fn join_room(&self, token: String, client_room: Arc<Room>) -> Result<()> {
 92        self.background.simulate_random_delay().await;
 93        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
 94        let identity = claims.sub.unwrap().to_string();
 95        let room_name = claims.video.room.unwrap();
 96        let mut server_rooms = self.rooms.lock();
 97        let room = server_rooms
 98            .get_mut(&*room_name)
 99            .ok_or_else(|| anyhow!("room {:?} does not exist", room_name))?;
100        if room.client_rooms.contains_key(&identity) {
101            Err(anyhow!(
102                "{:?} attempted to join room {:?} twice",
103                identity,
104                room_name
105            ))
106        } else {
107            for track in &room.tracks {
108                client_room
109                    .0
110                    .lock()
111                    .video_track_updates
112                    .0
113                    .try_broadcast(RemoteVideoTrackUpdate::Subscribed(track.clone()))
114                    .unwrap();
115            }
116            room.client_rooms.insert(identity, client_room);
117            Ok(())
118        }
119    }
120
121    async fn leave_room(&self, token: String) -> Result<()> {
122        self.background.simulate_random_delay().await;
123        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
124        let identity = claims.sub.unwrap().to_string();
125        let room_name = claims.video.room.unwrap();
126        let mut server_rooms = self.rooms.lock();
127        let room = server_rooms
128            .get_mut(&*room_name)
129            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
130        room.client_rooms.remove(&identity).ok_or_else(|| {
131            anyhow!(
132                "{:?} attempted to leave room {:?} before joining it",
133                identity,
134                room_name
135            )
136        })?;
137        Ok(())
138    }
139
140    async fn remove_participant(&self, room_name: String, identity: String) -> Result<()> {
141        // TODO: clear state associated with the `Room`.
142
143        self.background.simulate_random_delay().await;
144        let mut server_rooms = self.rooms.lock();
145        let room = server_rooms
146            .get_mut(&room_name)
147            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
148        room.client_rooms.remove(&identity).ok_or_else(|| {
149            anyhow!(
150                "participant {:?} did not join room {:?}",
151                identity,
152                room_name
153            )
154        })?;
155        Ok(())
156    }
157
158    pub async fn disconnect_client(&self, client_identity: String) {
159        self.background.simulate_random_delay().await;
160        let mut server_rooms = self.rooms.lock();
161        for room in server_rooms.values_mut() {
162            if let Some(room) = room.client_rooms.remove(&client_identity) {
163                *room.0.lock().connection.0.borrow_mut() = ConnectionState::Disconnected;
164            }
165        }
166    }
167
168    async fn publish_video_track(&self, token: String, local_track: LocalVideoTrack) -> Result<()> {
169        self.background.simulate_random_delay().await;
170        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
171        let identity = claims.sub.unwrap().to_string();
172        let room_name = claims.video.room.unwrap();
173
174        let mut server_rooms = self.rooms.lock();
175        let room = server_rooms
176            .get_mut(&*room_name)
177            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
178
179        let track = Arc::new(RemoteVideoTrack {
180            sid: nanoid::nanoid!(17),
181            publisher_id: identity.clone(),
182            frames_rx: local_track.frames_rx.clone(),
183        });
184
185        room.tracks.push(track.clone());
186
187        for (id, client_room) in &room.client_rooms {
188            if *id != identity {
189                let _ = client_room
190                    .0
191                    .lock()
192                    .video_track_updates
193                    .0
194                    .try_broadcast(RemoteVideoTrackUpdate::Subscribed(track.clone()))
195                    .unwrap();
196            }
197        }
198
199        Ok(())
200    }
201
202    fn video_tracks(&self, token: String) -> Result<Vec<Arc<RemoteVideoTrack>>> {
203        let claims = live_kit_server::token::validate(&token, &self.secret_key)?;
204        let room_name = claims.video.room.unwrap();
205
206        let mut server_rooms = self.rooms.lock();
207        let room = server_rooms
208            .get_mut(&*room_name)
209            .ok_or_else(|| anyhow!("room {} does not exist", room_name))?;
210        Ok(room.tracks.clone())
211    }
212}
213
214#[derive(Default)]
215struct TestServerRoom {
216    client_rooms: HashMap<Sid, Arc<Room>>,
217    tracks: Vec<Arc<RemoteVideoTrack>>,
218}
219
220impl TestServerRoom {}
221
222pub struct TestApiClient {
223    url: String,
224}
225
226#[async_trait]
227impl live_kit_server::api::Client for TestApiClient {
228    fn url(&self) -> &str {
229        &self.url
230    }
231
232    async fn create_room(&self, name: String) -> Result<()> {
233        let server = TestServer::get(&self.url)?;
234        server.create_room(name).await?;
235        Ok(())
236    }
237
238    async fn delete_room(&self, name: String) -> Result<()> {
239        let server = TestServer::get(&self.url)?;
240        server.delete_room(name).await?;
241        Ok(())
242    }
243
244    async fn remove_participant(&self, room: String, identity: String) -> Result<()> {
245        let server = TestServer::get(&self.url)?;
246        server.remove_participant(room, identity).await?;
247        Ok(())
248    }
249
250    fn room_token(&self, room: &str, identity: &str) -> Result<String> {
251        let server = TestServer::get(&self.url)?;
252        token::create(
253            &server.api_key,
254            &server.secret_key,
255            Some(identity),
256            token::VideoGrant::to_join(room),
257        )
258    }
259}
260
261pub type Sid = String;
262
263struct RoomState {
264    connection: (
265        watch::Sender<ConnectionState>,
266        watch::Receiver<ConnectionState>,
267    ),
268    display_sources: Vec<MacOSDisplay>,
269    video_track_updates: (
270        async_broadcast::Sender<RemoteVideoTrackUpdate>,
271        async_broadcast::Receiver<RemoteVideoTrackUpdate>,
272    ),
273}
274
275#[derive(Clone, Eq, PartialEq)]
276pub enum ConnectionState {
277    Disconnected,
278    Connected { url: String, token: String },
279}
280
281pub struct Room(Mutex<RoomState>);
282
283impl Room {
284    pub fn new() -> Arc<Self> {
285        Arc::new(Self(Mutex::new(RoomState {
286            connection: watch::channel_with(ConnectionState::Disconnected),
287            display_sources: Default::default(),
288            video_track_updates: async_broadcast::broadcast(128),
289        })))
290    }
291
292    pub fn status(&self) -> watch::Receiver<ConnectionState> {
293        self.0.lock().connection.1.clone()
294    }
295
296    pub fn connect(self: &Arc<Self>, url: &str, token: &str) -> impl Future<Output = Result<()>> {
297        let this = self.clone();
298        let url = url.to_string();
299        let token = token.to_string();
300        async move {
301            let server = TestServer::get(&url)?;
302            server.join_room(token.clone(), this.clone()).await?;
303            *this.0.lock().connection.0.borrow_mut() = ConnectionState::Connected { url, token };
304            Ok(())
305        }
306    }
307
308    pub fn display_sources(self: &Arc<Self>) -> impl Future<Output = Result<Vec<MacOSDisplay>>> {
309        let this = self.clone();
310        async move {
311            let server = this.test_server();
312            server.background.simulate_random_delay().await;
313            Ok(this.0.lock().display_sources.clone())
314        }
315    }
316
317    pub fn publish_video_track(
318        self: &Arc<Self>,
319        track: &LocalVideoTrack,
320    ) -> impl Future<Output = Result<LocalTrackPublication>> {
321        let this = self.clone();
322        let track = track.clone();
323        async move {
324            this.test_server()
325                .publish_video_track(this.token(), track)
326                .await?;
327            Ok(LocalTrackPublication)
328        }
329    }
330
331    pub fn unpublish_track(&self, _: LocalTrackPublication) {}
332
333    pub fn remote_video_tracks(&self, publisher_id: &str) -> Vec<Arc<RemoteVideoTrack>> {
334        if !self.is_connected() {
335            return Vec::new();
336        }
337
338        self.test_server()
339            .video_tracks(self.token())
340            .unwrap()
341            .into_iter()
342            .filter(|track| track.publisher_id() == publisher_id)
343            .collect()
344    }
345
346    pub fn remote_video_track_updates(&self) -> impl Stream<Item = RemoteVideoTrackUpdate> {
347        self.0.lock().video_track_updates.1.clone()
348    }
349
350    pub fn set_display_sources(&self, sources: Vec<MacOSDisplay>) {
351        self.0.lock().display_sources = sources;
352    }
353
354    fn test_server(&self) -> Arc<TestServer> {
355        match self.0.lock().connection.1.borrow().clone() {
356            ConnectionState::Disconnected => panic!("must be connected to call this method"),
357            ConnectionState::Connected { url, .. } => TestServer::get(&url).unwrap(),
358        }
359    }
360
361    fn token(&self) -> String {
362        match self.0.lock().connection.1.borrow().clone() {
363            ConnectionState::Disconnected => panic!("must be connected to call this method"),
364            ConnectionState::Connected { token, .. } => token,
365        }
366    }
367
368    fn is_connected(&self) -> bool {
369        match *self.0.lock().connection.1.borrow() {
370            ConnectionState::Disconnected => false,
371            ConnectionState::Connected { .. } => true,
372        }
373    }
374}
375
376impl Drop for Room {
377    fn drop(&mut self) {
378        if let ConnectionState::Connected { token, .. } = mem::replace(
379            &mut *self.0.lock().connection.0.borrow_mut(),
380            ConnectionState::Disconnected,
381        ) {
382            if let Ok(server) = TestServer::get(&token) {
383                let background = server.background.clone();
384                background
385                    .spawn(async move { server.leave_room(token).await.unwrap() })
386                    .detach();
387            }
388        }
389    }
390}
391
392pub struct LocalTrackPublication;
393
394#[derive(Clone)]
395pub struct LocalVideoTrack {
396    frames_rx: async_broadcast::Receiver<Frame>,
397}
398
399impl LocalVideoTrack {
400    pub fn screen_share_for_display(display: &MacOSDisplay) -> Self {
401        Self {
402            frames_rx: display.frames.1.clone(),
403        }
404    }
405}
406
407pub struct RemoteVideoTrack {
408    sid: Sid,
409    publisher_id: Sid,
410    frames_rx: async_broadcast::Receiver<Frame>,
411}
412
413impl RemoteVideoTrack {
414    pub fn sid(&self) -> &str {
415        &self.sid
416    }
417
418    pub fn publisher_id(&self) -> &str {
419        &self.publisher_id
420    }
421
422    pub fn frames(&self) -> async_broadcast::Receiver<Frame> {
423        self.frames_rx.clone()
424    }
425}
426
427#[derive(Clone)]
428pub enum RemoteVideoTrackUpdate {
429    Subscribed(Arc<RemoteVideoTrack>),
430    Unsubscribed { publisher_id: Sid, track_id: Sid },
431}
432
433#[derive(Clone)]
434pub struct MacOSDisplay {
435    frames: (
436        async_broadcast::Sender<Frame>,
437        async_broadcast::Receiver<Frame>,
438    ),
439}
440
441impl MacOSDisplay {
442    pub fn new() -> Self {
443        Self {
444            frames: async_broadcast::broadcast(128),
445        }
446    }
447
448    pub fn send_frame(&self, frame: Frame) {
449        self.frames.0.try_broadcast(frame).unwrap();
450    }
451}
452
453#[derive(Clone, Debug, PartialEq, Eq)]
454pub struct Frame {
455    pub label: String,
456    pub width: usize,
457    pub height: usize,
458}
459
460impl Frame {
461    pub fn width(&self) -> usize {
462        self.width
463    }
464
465    pub fn height(&self) -> usize {
466        self.height
467    }
468
469    pub fn image(&self) -> CVImageBuffer {
470        unimplemented!("you can't call this in test mode")
471    }
472}