test_server.rs

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