test_server.rs

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