test_server.rs

  1use crate::{
  2    auth::split_dev_server_token,
  3    db::{tests::TestDb, NewUserParams, UserId},
  4    executor::Executor,
  5    rpc::{Principal, Server, ZedVersion, CLEANUP_TIMEOUT, RECONNECT_TIMEOUT},
  6    AppState, Config, RateLimiter,
  7};
  8use anyhow::anyhow;
  9use call::ActiveCall;
 10use channel::{ChannelBuffer, ChannelStore};
 11use client::{
 12    self, proto::PeerId, ChannelId, Client, Connection, Credentials, EstablishConnectionError,
 13    UserStore,
 14};
 15use clock::FakeSystemClock;
 16use collab_ui::channel_view::ChannelView;
 17use collections::{HashMap, HashSet};
 18use fs::FakeFs;
 19use futures::{channel::oneshot, StreamExt as _};
 20use git::GitHostingProviderRegistry;
 21use gpui::{BackgroundExecutor, Context, Model, Task, TestAppContext, View, VisualTestContext};
 22use http_client::FakeHttpClient;
 23use language::LanguageRegistry;
 24use node_runtime::FakeNodeRuntime;
 25use notifications::NotificationStore;
 26use parking_lot::Mutex;
 27use project::{Project, WorktreeId};
 28use remote::SshSession;
 29use rpc::{
 30    proto::{self, ChannelRole},
 31    RECEIVE_TIMEOUT,
 32};
 33use semantic_version::SemanticVersion;
 34use serde_json::json;
 35use session::{AppSession, Session};
 36use settings::SettingsStore;
 37use std::{
 38    cell::{Ref, RefCell, RefMut},
 39    env,
 40    ops::{Deref, DerefMut},
 41    path::Path,
 42    sync::{
 43        atomic::{AtomicBool, AtomicUsize, Ordering::SeqCst},
 44        Arc,
 45    },
 46};
 47use workspace::{Workspace, WorkspaceStore};
 48
 49pub struct TestServer {
 50    pub app_state: Arc<AppState>,
 51    pub test_live_kit_server: Arc<live_kit_client::TestServer>,
 52    server: Arc<Server>,
 53    next_github_user_id: i32,
 54    connection_killers: Arc<Mutex<HashMap<PeerId, Arc<AtomicBool>>>>,
 55    forbid_connections: Arc<AtomicBool>,
 56    _test_db: TestDb,
 57}
 58
 59pub struct TestClient {
 60    pub username: String,
 61    pub app_state: Arc<workspace::AppState>,
 62    channel_store: Model<ChannelStore>,
 63    notification_store: Model<NotificationStore>,
 64    state: RefCell<TestClientState>,
 65}
 66
 67#[derive(Default)]
 68struct TestClientState {
 69    local_projects: Vec<Model<Project>>,
 70    dev_server_projects: Vec<Model<Project>>,
 71    buffers: HashMap<Model<Project>, HashSet<Model<language::Buffer>>>,
 72    channel_buffers: HashSet<Model<ChannelBuffer>>,
 73}
 74
 75pub struct ContactsSummary {
 76    pub current: Vec<String>,
 77    pub outgoing_requests: Vec<String>,
 78    pub incoming_requests: Vec<String>,
 79}
 80
 81impl TestServer {
 82    pub async fn start(deterministic: BackgroundExecutor) -> Self {
 83        static NEXT_LIVE_KIT_SERVER_ID: AtomicUsize = AtomicUsize::new(0);
 84
 85        let use_postgres = env::var("USE_POSTGRES").ok();
 86        let use_postgres = use_postgres.as_deref();
 87        let test_db = if use_postgres == Some("true") || use_postgres == Some("1") {
 88            TestDb::postgres(deterministic.clone())
 89        } else {
 90            TestDb::sqlite(deterministic.clone())
 91        };
 92        let live_kit_server_id = NEXT_LIVE_KIT_SERVER_ID.fetch_add(1, SeqCst);
 93        let live_kit_server = live_kit_client::TestServer::create(
 94            format!("http://livekit.{}.test", live_kit_server_id),
 95            format!("devkey-{}", live_kit_server_id),
 96            format!("secret-{}", live_kit_server_id),
 97            deterministic.clone(),
 98        )
 99        .unwrap();
100        let executor = Executor::Deterministic(deterministic.clone());
101        let app_state = Self::build_app_state(&test_db, &live_kit_server, executor.clone()).await;
102        let epoch = app_state
103            .db
104            .create_server(&app_state.config.zed_environment)
105            .await
106            .unwrap();
107        let server = Server::new(epoch, app_state.clone());
108        server.start().await.unwrap();
109        // Advance clock to ensure the server's cleanup task is finished.
110        deterministic.advance_clock(CLEANUP_TIMEOUT);
111        Self {
112            app_state,
113            server,
114            connection_killers: Default::default(),
115            forbid_connections: Default::default(),
116            next_github_user_id: 0,
117            _test_db: test_db,
118            test_live_kit_server: live_kit_server,
119        }
120    }
121
122    pub async fn start2(
123        cx_a: &mut TestAppContext,
124        cx_b: &mut TestAppContext,
125    ) -> (TestServer, TestClient, TestClient, ChannelId) {
126        let mut server = Self::start(cx_a.executor()).await;
127        let client_a = server.create_client(cx_a, "user_a").await;
128        let client_b = server.create_client(cx_b, "user_b").await;
129        let channel_id = server
130            .make_channel(
131                "test-channel",
132                None,
133                (&client_a, cx_a),
134                &mut [(&client_b, cx_b)],
135            )
136            .await;
137        cx_a.run_until_parked();
138
139        (server, client_a, client_b, channel_id)
140    }
141
142    pub async fn start1(cx: &mut TestAppContext) -> (TestServer, TestClient) {
143        let mut server = Self::start(cx.executor().clone()).await;
144        let client = server.create_client(cx, "user_a").await;
145        (server, client)
146    }
147
148    pub async fn reset(&self) {
149        self.app_state.db.reset();
150        let epoch = self
151            .app_state
152            .db
153            .create_server(&self.app_state.config.zed_environment)
154            .await
155            .unwrap();
156        self.server.reset(epoch);
157    }
158
159    pub async fn create_client(&mut self, cx: &mut TestAppContext, name: &str) -> TestClient {
160        let fs = FakeFs::new(cx.executor());
161
162        cx.update(|cx| {
163            if cx.has_global::<SettingsStore>() {
164                panic!("Same cx used to create two test clients")
165            }
166            let settings = SettingsStore::test(cx);
167            cx.set_global(settings);
168            release_channel::init(SemanticVersion::default(), cx);
169            client::init_settings(cx);
170        });
171
172        let clock = Arc::new(FakeSystemClock::default());
173        let http = FakeHttpClient::with_404_response();
174        let user_id = if let Ok(Some(user)) = self.app_state.db.get_user_by_github_login(name).await
175        {
176            user.id
177        } else {
178            let github_user_id = self.next_github_user_id;
179            self.next_github_user_id += 1;
180            self.app_state
181                .db
182                .create_user(
183                    &format!("{name}@example.com"),
184                    false,
185                    NewUserParams {
186                        github_login: name.into(),
187                        github_user_id,
188                    },
189                )
190                .await
191                .expect("creating user failed")
192                .user_id
193        };
194        let client_name = name.to_string();
195        let mut client = cx.update(|cx| Client::new(clock, http.clone(), cx));
196        let server = self.server.clone();
197        let db = self.app_state.db.clone();
198        let connection_killers = self.connection_killers.clone();
199        let forbid_connections = self.forbid_connections.clone();
200
201        Arc::get_mut(&mut client)
202            .unwrap()
203            .set_id(user_id.to_proto())
204            .override_authenticate(move |cx| {
205                cx.spawn(|_| async move {
206                    let access_token = "the-token".to_string();
207                    Ok(Credentials::User {
208                        user_id: user_id.to_proto(),
209                        access_token,
210                    })
211                })
212            })
213            .override_establish_connection(move |credentials, cx| {
214                assert_eq!(
215                    credentials,
216                    &Credentials::User {
217                        user_id: user_id.0 as u64,
218                        access_token: "the-token".into()
219                    }
220                );
221
222                let server = server.clone();
223                let db = db.clone();
224                let connection_killers = connection_killers.clone();
225                let forbid_connections = forbid_connections.clone();
226                let client_name = client_name.clone();
227                cx.spawn(move |cx| async move {
228                    if forbid_connections.load(SeqCst) {
229                        Err(EstablishConnectionError::other(anyhow!(
230                            "server is forbidding connections"
231                        )))
232                    } else {
233                        let (client_conn, server_conn, killed) =
234                            Connection::in_memory(cx.background_executor().clone());
235                        let (connection_id_tx, connection_id_rx) = oneshot::channel();
236                        let user = db
237                            .get_user_by_id(user_id)
238                            .await
239                            .expect("retrieving user failed")
240                            .unwrap();
241                        cx.background_executor()
242                            .spawn(server.handle_connection(
243                                server_conn,
244                                client_name,
245                                Principal::User(user),
246                                ZedVersion(SemanticVersion::new(1, 0, 0)),
247                                Some(connection_id_tx),
248                                Executor::Deterministic(cx.background_executor().clone()),
249                            ))
250                            .detach();
251                        let connection_id = connection_id_rx.await.map_err(|e| {
252                            EstablishConnectionError::Other(anyhow!(
253                                "{} (is server shutting down?)",
254                                e
255                            ))
256                        })?;
257                        connection_killers
258                            .lock()
259                            .insert(connection_id.into(), killed);
260                        Ok(client_conn)
261                    }
262                })
263            });
264
265        let git_hosting_provider_registry =
266            cx.update(|cx| GitHostingProviderRegistry::default_global(cx));
267        git_hosting_provider_registry
268            .register_hosting_provider(Arc::new(git_hosting_providers::Github));
269
270        let user_store = cx.new_model(|cx| UserStore::new(client.clone(), cx));
271        let workspace_store = cx.new_model(|cx| WorkspaceStore::new(client.clone(), cx));
272        let language_registry = Arc::new(LanguageRegistry::test(cx.executor()));
273        let session = cx.new_model(|cx| AppSession::new(Session::test(), cx));
274        let app_state = Arc::new(workspace::AppState {
275            client: client.clone(),
276            user_store: user_store.clone(),
277            workspace_store,
278            languages: language_registry,
279            fs: fs.clone(),
280            build_window_options: |_, _| Default::default(),
281            node_runtime: FakeNodeRuntime::new(),
282            session,
283        });
284
285        let os_keymap = "keymaps/default-macos.json";
286
287        cx.update(|cx| {
288            theme::init(theme::LoadThemes::JustBase, cx);
289            Project::init(&client, cx);
290            client::init(&client, cx);
291            language::init(cx);
292            editor::init(cx);
293            workspace::init(app_state.clone(), cx);
294            call::init(client.clone(), user_store.clone(), cx);
295            channel::init(&client, user_store.clone(), cx);
296            notifications::init(client.clone(), user_store, cx);
297            collab_ui::init(&app_state, cx);
298            file_finder::init(cx);
299            menu::init();
300            dev_server_projects::init(client.clone(), cx);
301            settings::KeymapFile::load_asset(os_keymap, cx).unwrap();
302            language_model::LanguageModelRegistry::test(cx);
303            assistant::context_store::init(&client);
304        });
305
306        client
307            .authenticate_and_connect(false, &cx.to_async())
308            .await
309            .unwrap();
310
311        let client = TestClient {
312            app_state,
313            username: name.to_string(),
314            channel_store: cx.read(ChannelStore::global).clone(),
315            notification_store: cx.read(NotificationStore::global).clone(),
316            state: Default::default(),
317        };
318        client.wait_for_current_user(cx).await;
319        client
320    }
321
322    pub async fn create_dev_server(
323        &self,
324        access_token: String,
325        cx: &mut TestAppContext,
326    ) -> TestClient {
327        cx.update(|cx| {
328            if cx.has_global::<SettingsStore>() {
329                panic!("Same cx used to create two test clients")
330            }
331            let settings = SettingsStore::test(cx);
332            cx.set_global(settings);
333            release_channel::init(SemanticVersion::default(), cx);
334            client::init_settings(cx);
335        });
336        let (dev_server_id, _) = split_dev_server_token(&access_token).unwrap();
337
338        let clock = Arc::new(FakeSystemClock::default());
339        let http = FakeHttpClient::with_404_response();
340        let mut client = cx.update(|cx| Client::new(clock, http.clone(), cx));
341        let server = self.server.clone();
342        let db = self.app_state.db.clone();
343        let connection_killers = self.connection_killers.clone();
344        let forbid_connections = self.forbid_connections.clone();
345        Arc::get_mut(&mut client)
346            .unwrap()
347            .set_id(1)
348            .set_dev_server_token(client::DevServerToken(access_token.clone()))
349            .override_establish_connection(move |credentials, cx| {
350                assert_eq!(
351                    credentials,
352                    &Credentials::DevServer {
353                        token: client::DevServerToken(access_token.to_string())
354                    }
355                );
356
357                let server = server.clone();
358                let db = db.clone();
359                let connection_killers = connection_killers.clone();
360                let forbid_connections = forbid_connections.clone();
361                cx.spawn(move |cx| async move {
362                    if forbid_connections.load(SeqCst) {
363                        Err(EstablishConnectionError::other(anyhow!(
364                            "server is forbidding connections"
365                        )))
366                    } else {
367                        let (client_conn, server_conn, killed) =
368                            Connection::in_memory(cx.background_executor().clone());
369                        let (connection_id_tx, connection_id_rx) = oneshot::channel();
370                        let dev_server = db
371                            .get_dev_server(dev_server_id)
372                            .await
373                            .expect("retrieving dev_server failed");
374                        cx.background_executor()
375                            .spawn(server.handle_connection(
376                                server_conn,
377                                "dev-server".to_string(),
378                                Principal::DevServer(dev_server),
379                                ZedVersion(SemanticVersion::new(1, 0, 0)),
380                                Some(connection_id_tx),
381                                Executor::Deterministic(cx.background_executor().clone()),
382                            ))
383                            .detach();
384                        let connection_id = connection_id_rx.await.map_err(|e| {
385                            EstablishConnectionError::Other(anyhow!(
386                                "{} (is server shutting down?)",
387                                e
388                            ))
389                        })?;
390                        connection_killers
391                            .lock()
392                            .insert(connection_id.into(), killed);
393                        Ok(client_conn)
394                    }
395                })
396            });
397
398        let fs = FakeFs::new(cx.executor());
399        let user_store = cx.new_model(|cx| UserStore::new(client.clone(), cx));
400        let workspace_store = cx.new_model(|cx| WorkspaceStore::new(client.clone(), cx));
401        let language_registry = Arc::new(LanguageRegistry::test(cx.executor()));
402        let session = cx.new_model(|cx| AppSession::new(Session::test(), cx));
403        let app_state = Arc::new(workspace::AppState {
404            client: client.clone(),
405            user_store: user_store.clone(),
406            workspace_store,
407            languages: language_registry,
408            fs: fs.clone(),
409            build_window_options: |_, _| Default::default(),
410            node_runtime: FakeNodeRuntime::new(),
411            session,
412        });
413
414        cx.update(|cx| {
415            theme::init(theme::LoadThemes::JustBase, cx);
416            Project::init(&client, cx);
417            client::init(&client, cx);
418            language::init(cx);
419            editor::init(cx);
420            workspace::init(app_state.clone(), cx);
421            call::init(client.clone(), user_store.clone(), cx);
422            channel::init(&client, user_store.clone(), cx);
423            notifications::init(client.clone(), user_store, cx);
424            collab_ui::init(&app_state, cx);
425            file_finder::init(cx);
426            menu::init();
427            headless::init(
428                client.clone(),
429                headless::AppState {
430                    languages: app_state.languages.clone(),
431                    user_store: app_state.user_store.clone(),
432                    fs: fs.clone(),
433                    node_runtime: app_state.node_runtime.clone(),
434                },
435                cx,
436            )
437        })
438        .await
439        .unwrap();
440
441        TestClient {
442            app_state,
443            username: "dev-server".to_string(),
444            channel_store: cx.read(ChannelStore::global).clone(),
445            notification_store: cx.read(NotificationStore::global).clone(),
446            state: Default::default(),
447        }
448    }
449
450    pub fn disconnect_client(&self, peer_id: PeerId) {
451        self.connection_killers
452            .lock()
453            .remove(&peer_id)
454            .unwrap()
455            .store(true, SeqCst);
456    }
457
458    pub fn simulate_long_connection_interruption(
459        &self,
460        peer_id: PeerId,
461        deterministic: BackgroundExecutor,
462    ) {
463        self.forbid_connections();
464        self.disconnect_client(peer_id);
465        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
466        self.allow_connections();
467        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
468        deterministic.run_until_parked();
469    }
470
471    pub fn forbid_connections(&self) {
472        self.forbid_connections.store(true, SeqCst);
473    }
474
475    pub fn allow_connections(&self) {
476        self.forbid_connections.store(false, SeqCst);
477    }
478
479    pub async fn make_contacts(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
480        for ix in 1..clients.len() {
481            let (left, right) = clients.split_at_mut(ix);
482            let (client_a, cx_a) = left.last_mut().unwrap();
483            for (client_b, cx_b) in right {
484                client_a
485                    .app_state
486                    .user_store
487                    .update(*cx_a, |store, cx| {
488                        store.request_contact(client_b.user_id().unwrap(), cx)
489                    })
490                    .await
491                    .unwrap();
492                cx_a.executor().run_until_parked();
493                client_b
494                    .app_state
495                    .user_store
496                    .update(*cx_b, |store, cx| {
497                        store.respond_to_contact_request(client_a.user_id().unwrap(), true, cx)
498                    })
499                    .await
500                    .unwrap();
501            }
502        }
503    }
504
505    pub async fn make_channel(
506        &self,
507        channel: &str,
508        parent: Option<ChannelId>,
509        admin: (&TestClient, &mut TestAppContext),
510        members: &mut [(&TestClient, &mut TestAppContext)],
511    ) -> ChannelId {
512        let (_, admin_cx) = admin;
513        let channel_id = admin_cx
514            .read(ChannelStore::global)
515            .update(admin_cx, |channel_store, cx| {
516                channel_store.create_channel(channel, parent, cx)
517            })
518            .await
519            .unwrap();
520
521        for (member_client, member_cx) in members {
522            admin_cx
523                .read(ChannelStore::global)
524                .update(admin_cx, |channel_store, cx| {
525                    channel_store.invite_member(
526                        channel_id,
527                        member_client.user_id().unwrap(),
528                        ChannelRole::Member,
529                        cx,
530                    )
531                })
532                .await
533                .unwrap();
534
535            admin_cx.executor().run_until_parked();
536
537            member_cx
538                .read(ChannelStore::global)
539                .update(*member_cx, |channels, cx| {
540                    channels.respond_to_channel_invite(channel_id, true, cx)
541                })
542                .await
543                .unwrap();
544        }
545
546        channel_id
547    }
548
549    pub async fn make_public_channel(
550        &self,
551        channel: &str,
552        client: &TestClient,
553        cx: &mut TestAppContext,
554    ) -> ChannelId {
555        let channel_id = self
556            .make_channel(channel, None, (client, cx), &mut [])
557            .await;
558
559        client
560            .channel_store()
561            .update(cx, |channel_store, cx| {
562                channel_store.set_channel_visibility(
563                    channel_id,
564                    proto::ChannelVisibility::Public,
565                    cx,
566                )
567            })
568            .await
569            .unwrap();
570
571        channel_id
572    }
573
574    pub async fn make_channel_tree(
575        &self,
576        channels: &[(&str, Option<&str>)],
577        creator: (&TestClient, &mut TestAppContext),
578    ) -> Vec<ChannelId> {
579        let mut observed_channels = HashMap::default();
580        let mut result = Vec::new();
581        for (channel, parent) in channels {
582            let id;
583            if let Some(parent) = parent {
584                if let Some(parent_id) = observed_channels.get(parent) {
585                    id = self
586                        .make_channel(channel, Some(*parent_id), (creator.0, creator.1), &mut [])
587                        .await;
588                } else {
589                    panic!(
590                        "Edge {}->{} referenced before {} was created",
591                        parent, channel, parent
592                    )
593                }
594            } else {
595                id = self
596                    .make_channel(channel, None, (creator.0, creator.1), &mut [])
597                    .await;
598            }
599
600            observed_channels.insert(channel, id);
601            result.push(id);
602        }
603
604        result
605    }
606
607    pub async fn create_room(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
608        self.make_contacts(clients).await;
609
610        let (left, right) = clients.split_at_mut(1);
611        let (_client_a, cx_a) = &mut left[0];
612        let active_call_a = cx_a.read(ActiveCall::global);
613
614        for (client_b, cx_b) in right {
615            let user_id_b = client_b.current_user_id(cx_b).to_proto();
616            active_call_a
617                .update(*cx_a, |call, cx| call.invite(user_id_b, None, cx))
618                .await
619                .unwrap();
620
621            cx_b.executor().run_until_parked();
622            let active_call_b = cx_b.read(ActiveCall::global);
623            active_call_b
624                .update(*cx_b, |call, cx| call.accept_incoming(cx))
625                .await
626                .unwrap();
627        }
628    }
629
630    pub async fn build_app_state(
631        test_db: &TestDb,
632        live_kit_test_server: &live_kit_client::TestServer,
633        executor: Executor,
634    ) -> Arc<AppState> {
635        Arc::new(AppState {
636            db: test_db.db().clone(),
637            live_kit_client: Some(Arc::new(live_kit_test_server.create_api_client())),
638            blob_store_client: None,
639            stripe_client: None,
640            rate_limiter: Arc::new(RateLimiter::new(test_db.db().clone())),
641            executor,
642            clickhouse_client: None,
643            config: Config {
644                http_port: 0,
645                database_url: "".into(),
646                database_max_connections: 0,
647                api_token: "".into(),
648                invite_link_prefix: "".into(),
649                live_kit_server: None,
650                live_kit_key: None,
651                live_kit_secret: None,
652                rust_log: None,
653                log_json: None,
654                zed_environment: "test".into(),
655                blob_store_url: None,
656                blob_store_region: None,
657                blob_store_access_key: None,
658                blob_store_secret_key: None,
659                blob_store_bucket: None,
660                openai_api_key: None,
661                google_ai_api_key: None,
662                anthropic_api_key: None,
663                clickhouse_url: None,
664                clickhouse_user: None,
665                clickhouse_password: None,
666                clickhouse_database: None,
667                zed_client_checksum_seed: None,
668                slack_panics_webhook: None,
669                auto_join_channel_id: None,
670                migrations_path: None,
671                seed_path: None,
672                stripe_api_key: None,
673                stripe_price_id: None,
674                supermaven_admin_api_key: None,
675                qwen2_7b_api_key: None,
676                qwen2_7b_api_url: None,
677            },
678        })
679    }
680}
681
682impl Deref for TestServer {
683    type Target = Server;
684
685    fn deref(&self) -> &Self::Target {
686        &self.server
687    }
688}
689
690impl Drop for TestServer {
691    fn drop(&mut self) {
692        self.server.teardown();
693        self.test_live_kit_server.teardown().unwrap();
694    }
695}
696
697impl Deref for TestClient {
698    type Target = Arc<Client>;
699
700    fn deref(&self) -> &Self::Target {
701        &self.app_state.client
702    }
703}
704
705impl TestClient {
706    pub fn fs(&self) -> &FakeFs {
707        self.app_state.fs.as_fake()
708    }
709
710    pub fn channel_store(&self) -> &Model<ChannelStore> {
711        &self.channel_store
712    }
713
714    pub fn notification_store(&self) -> &Model<NotificationStore> {
715        &self.notification_store
716    }
717
718    pub fn user_store(&self) -> &Model<UserStore> {
719        &self.app_state.user_store
720    }
721
722    pub fn language_registry(&self) -> &Arc<LanguageRegistry> {
723        &self.app_state.languages
724    }
725
726    pub fn client(&self) -> &Arc<Client> {
727        &self.app_state.client
728    }
729
730    pub fn current_user_id(&self, cx: &TestAppContext) -> UserId {
731        UserId::from_proto(
732            self.app_state
733                .user_store
734                .read_with(cx, |user_store, _| user_store.current_user().unwrap().id),
735        )
736    }
737
738    pub async fn wait_for_current_user(&self, cx: &TestAppContext) {
739        let mut authed_user = self
740            .app_state
741            .user_store
742            .read_with(cx, |user_store, _| user_store.watch_current_user());
743        while authed_user.next().await.unwrap().is_none() {}
744    }
745
746    pub async fn clear_contacts(&self, cx: &mut TestAppContext) {
747        self.app_state
748            .user_store
749            .update(cx, |store, _| store.clear_contacts())
750            .await;
751    }
752
753    pub fn local_projects(&self) -> impl Deref<Target = Vec<Model<Project>>> + '_ {
754        Ref::map(self.state.borrow(), |state| &state.local_projects)
755    }
756
757    pub fn dev_server_projects(&self) -> impl Deref<Target = Vec<Model<Project>>> + '_ {
758        Ref::map(self.state.borrow(), |state| &state.dev_server_projects)
759    }
760
761    pub fn local_projects_mut(&self) -> impl DerefMut<Target = Vec<Model<Project>>> + '_ {
762        RefMut::map(self.state.borrow_mut(), |state| &mut state.local_projects)
763    }
764
765    pub fn dev_server_projects_mut(&self) -> impl DerefMut<Target = Vec<Model<Project>>> + '_ {
766        RefMut::map(self.state.borrow_mut(), |state| {
767            &mut state.dev_server_projects
768        })
769    }
770
771    pub fn buffers_for_project<'a>(
772        &'a self,
773        project: &Model<Project>,
774    ) -> impl DerefMut<Target = HashSet<Model<language::Buffer>>> + 'a {
775        RefMut::map(self.state.borrow_mut(), |state| {
776            state.buffers.entry(project.clone()).or_default()
777        })
778    }
779
780    pub fn buffers(
781        &self,
782    ) -> impl DerefMut<Target = HashMap<Model<Project>, HashSet<Model<language::Buffer>>>> + '_
783    {
784        RefMut::map(self.state.borrow_mut(), |state| &mut state.buffers)
785    }
786
787    pub fn channel_buffers(&self) -> impl DerefMut<Target = HashSet<Model<ChannelBuffer>>> + '_ {
788        RefMut::map(self.state.borrow_mut(), |state| &mut state.channel_buffers)
789    }
790
791    pub fn summarize_contacts(&self, cx: &TestAppContext) -> ContactsSummary {
792        self.app_state
793            .user_store
794            .read_with(cx, |store, _| ContactsSummary {
795                current: store
796                    .contacts()
797                    .iter()
798                    .map(|contact| contact.user.github_login.clone())
799                    .collect(),
800                outgoing_requests: store
801                    .outgoing_contact_requests()
802                    .iter()
803                    .map(|user| user.github_login.clone())
804                    .collect(),
805                incoming_requests: store
806                    .incoming_contact_requests()
807                    .iter()
808                    .map(|user| user.github_login.clone())
809                    .collect(),
810            })
811    }
812
813    pub async fn build_local_project(
814        &self,
815        root_path: impl AsRef<Path>,
816        cx: &mut TestAppContext,
817    ) -> (Model<Project>, WorktreeId) {
818        let project = self.build_empty_local_project(cx);
819        let (worktree, _) = project
820            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
821            .await
822            .unwrap();
823        worktree
824            .read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
825            .await;
826        (project, worktree.read_with(cx, |tree, _| tree.id()))
827    }
828
829    pub async fn build_ssh_project(
830        &self,
831        root_path: impl AsRef<Path>,
832        ssh: Arc<SshSession>,
833        cx: &mut TestAppContext,
834    ) -> (Model<Project>, WorktreeId) {
835        let project = cx.update(|cx| {
836            Project::ssh(
837                ssh,
838                self.client().clone(),
839                self.app_state.node_runtime.clone(),
840                self.app_state.user_store.clone(),
841                self.app_state.languages.clone(),
842                self.app_state.fs.clone(),
843                cx,
844            )
845        });
846        let (worktree, _) = project
847            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
848            .await
849            .unwrap();
850        (project, worktree.read_with(cx, |tree, _| tree.id()))
851    }
852
853    pub async fn build_test_project(&self, cx: &mut TestAppContext) -> Model<Project> {
854        self.fs()
855            .insert_tree(
856                "/a",
857                json!({
858                    "1.txt": "one\none\none",
859                    "2.js": "function two() { return 2; }",
860                    "3.rs": "mod test",
861                }),
862            )
863            .await;
864        self.build_local_project("/a", cx).await.0
865    }
866
867    pub async fn host_workspace(
868        &self,
869        workspace: &View<Workspace>,
870        channel_id: ChannelId,
871        cx: &mut VisualTestContext,
872    ) {
873        cx.update(|cx| {
874            let active_call = ActiveCall::global(cx);
875            active_call.update(cx, |call, cx| call.join_channel(channel_id, cx))
876        })
877        .await
878        .unwrap();
879        cx.update(|cx| {
880            let active_call = ActiveCall::global(cx);
881            let project = workspace.read(cx).project().clone();
882            active_call.update(cx, |call, cx| call.share_project(project, cx))
883        })
884        .await
885        .unwrap();
886        cx.executor().run_until_parked();
887    }
888
889    pub async fn join_workspace<'a>(
890        &'a self,
891        channel_id: ChannelId,
892        cx: &'a mut TestAppContext,
893    ) -> (View<Workspace>, &'a mut VisualTestContext) {
894        cx.update(|cx| workspace::join_channel(channel_id, self.app_state.clone(), None, cx))
895            .await
896            .unwrap();
897        cx.run_until_parked();
898
899        self.active_workspace(cx)
900    }
901
902    pub fn build_empty_local_project(&self, cx: &mut TestAppContext) -> Model<Project> {
903        cx.update(|cx| {
904            Project::local(
905                self.client().clone(),
906                self.app_state.node_runtime.clone(),
907                self.app_state.user_store.clone(),
908                self.app_state.languages.clone(),
909                self.app_state.fs.clone(),
910                cx,
911            )
912        })
913    }
914
915    pub async fn build_dev_server_project(
916        &self,
917        host_project_id: u64,
918        guest_cx: &mut TestAppContext,
919    ) -> Model<Project> {
920        let active_call = guest_cx.read(ActiveCall::global);
921        let room = active_call.read_with(guest_cx, |call, _| call.room().unwrap().clone());
922        room.update(guest_cx, |room, cx| {
923            room.join_project(
924                host_project_id,
925                self.app_state.languages.clone(),
926                self.app_state.fs.clone(),
927                cx,
928            )
929        })
930        .await
931        .unwrap()
932    }
933
934    pub fn build_workspace<'a>(
935        &'a self,
936        project: &Model<Project>,
937        cx: &'a mut TestAppContext,
938    ) -> (View<Workspace>, &'a mut VisualTestContext) {
939        cx.add_window_view(|cx| {
940            cx.activate_window();
941            Workspace::new(None, project.clone(), self.app_state.clone(), cx)
942        })
943    }
944
945    pub async fn build_test_workspace<'a>(
946        &'a self,
947        cx: &'a mut TestAppContext,
948    ) -> (View<Workspace>, &'a mut VisualTestContext) {
949        let project = self.build_test_project(cx).await;
950        cx.add_window_view(|cx| {
951            cx.activate_window();
952            Workspace::new(None, project.clone(), self.app_state.clone(), cx)
953        })
954    }
955
956    pub fn active_workspace<'a>(
957        &'a self,
958        cx: &'a mut TestAppContext,
959    ) -> (View<Workspace>, &'a mut VisualTestContext) {
960        let window = cx.update(|cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
961
962        let view = window.root_view(cx).unwrap();
963        let cx = VisualTestContext::from_window(*window.deref(), cx).as_mut();
964        // it might be nice to try and cleanup these at the end of each test.
965        (view, cx)
966    }
967}
968
969pub fn open_channel_notes(
970    channel_id: ChannelId,
971    cx: &mut VisualTestContext,
972) -> Task<anyhow::Result<View<ChannelView>>> {
973    let window = cx.update(|cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
974    let view = window.root_view(cx).unwrap();
975
976    cx.update(|cx| ChannelView::open(channel_id, None, view.clone(), cx))
977}
978
979impl Drop for TestClient {
980    fn drop(&mut self) {
981        self.app_state.client.teardown();
982    }
983}