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