test_server.rs

  1use crate::{
  2    AppState, Config, RateLimiter,
  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};
 17use dap::DapRegistry;
 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 debug_adapters = Arc::new(DapRegistry::default());
279        let session = cx.new(|cx| AppSession::new(Session::test(), cx));
280        let app_state = Arc::new(workspace::AppState {
281            client: client.clone(),
282            user_store: user_store.clone(),
283            workspace_store,
284            languages: language_registry,
285            debug_adapters,
286            fs: fs.clone(),
287            build_window_options: |_, _| Default::default(),
288            node_runtime: NodeRuntime::unavailable(),
289            session,
290        });
291
292        let os_keymap = "keymaps/default-macos.json";
293
294        cx.update(|cx| {
295            theme::init(theme::LoadThemes::JustBase, cx);
296            Project::init(&client, cx);
297            client::init(&client, cx);
298            language::init(cx);
299            editor::init(cx);
300            workspace::init(app_state.clone(), cx);
301            call::init(client.clone(), user_store.clone(), cx);
302            channel::init(&client, user_store.clone(), cx);
303            notifications::init(client.clone(), user_store, cx);
304            collab_ui::init(&app_state, cx);
305            file_finder::init(cx);
306            menu::init();
307            cx.bind_keys(
308                settings::KeymapFile::load_asset_allow_partial_failure(os_keymap, cx).unwrap(),
309            );
310            language_model::LanguageModelRegistry::test(cx);
311            assistant_context_editor::init(client.clone(), cx);
312        });
313
314        client
315            .authenticate_and_connect(false, &cx.to_async())
316            .await
317            .unwrap();
318
319        let client = TestClient {
320            app_state,
321            username: name.to_string(),
322            channel_store: cx.read(ChannelStore::global).clone(),
323            notification_store: cx.read(NotificationStore::global).clone(),
324            state: Default::default(),
325        };
326        client.wait_for_current_user(cx).await;
327        client
328    }
329
330    pub fn disconnect_client(&self, peer_id: PeerId) {
331        self.connection_killers
332            .lock()
333            .remove(&peer_id)
334            .unwrap()
335            .store(true, SeqCst);
336    }
337
338    pub fn simulate_long_connection_interruption(
339        &self,
340        peer_id: PeerId,
341        deterministic: BackgroundExecutor,
342    ) {
343        self.forbid_connections();
344        self.disconnect_client(peer_id);
345        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
346        self.allow_connections();
347        deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
348        deterministic.run_until_parked();
349    }
350
351    pub fn forbid_connections(&self) {
352        self.forbid_connections.store(true, SeqCst);
353    }
354
355    pub fn allow_connections(&self) {
356        self.forbid_connections.store(false, SeqCst);
357    }
358
359    pub async fn make_contacts(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
360        for ix in 1..clients.len() {
361            let (left, right) = clients.split_at_mut(ix);
362            let (client_a, cx_a) = left.last_mut().unwrap();
363            for (client_b, cx_b) in right {
364                client_a
365                    .app_state
366                    .user_store
367                    .update(*cx_a, |store, cx| {
368                        store.request_contact(client_b.user_id().unwrap(), cx)
369                    })
370                    .await
371                    .unwrap();
372                cx_a.executor().run_until_parked();
373                client_b
374                    .app_state
375                    .user_store
376                    .update(*cx_b, |store, cx| {
377                        store.respond_to_contact_request(client_a.user_id().unwrap(), true, cx)
378                    })
379                    .await
380                    .unwrap();
381            }
382        }
383    }
384
385    pub async fn make_channel(
386        &self,
387        channel: &str,
388        parent: Option<ChannelId>,
389        admin: (&TestClient, &mut TestAppContext),
390        members: &mut [(&TestClient, &mut TestAppContext)],
391    ) -> ChannelId {
392        let (_, admin_cx) = admin;
393        let channel_id = admin_cx
394            .read(ChannelStore::global)
395            .update(admin_cx, |channel_store, cx| {
396                channel_store.create_channel(channel, parent, cx)
397            })
398            .await
399            .unwrap();
400
401        for (member_client, member_cx) in members {
402            admin_cx
403                .read(ChannelStore::global)
404                .update(admin_cx, |channel_store, cx| {
405                    channel_store.invite_member(
406                        channel_id,
407                        member_client.user_id().unwrap(),
408                        ChannelRole::Member,
409                        cx,
410                    )
411                })
412                .await
413                .unwrap();
414
415            admin_cx.executor().run_until_parked();
416
417            member_cx
418                .read(ChannelStore::global)
419                .update(*member_cx, |channels, cx| {
420                    channels.respond_to_channel_invite(channel_id, true, cx)
421                })
422                .await
423                .unwrap();
424        }
425
426        channel_id
427    }
428
429    pub async fn make_public_channel(
430        &self,
431        channel: &str,
432        client: &TestClient,
433        cx: &mut TestAppContext,
434    ) -> ChannelId {
435        let channel_id = self
436            .make_channel(channel, None, (client, cx), &mut [])
437            .await;
438
439        client
440            .channel_store()
441            .update(cx, |channel_store, cx| {
442                channel_store.set_channel_visibility(
443                    channel_id,
444                    proto::ChannelVisibility::Public,
445                    cx,
446                )
447            })
448            .await
449            .unwrap();
450
451        channel_id
452    }
453
454    pub async fn make_channel_tree(
455        &self,
456        channels: &[(&str, Option<&str>)],
457        creator: (&TestClient, &mut TestAppContext),
458    ) -> Vec<ChannelId> {
459        let mut observed_channels = HashMap::default();
460        let mut result = Vec::new();
461        for (channel, parent) in channels {
462            let id;
463            if let Some(parent) = parent {
464                if let Some(parent_id) = observed_channels.get(parent) {
465                    id = self
466                        .make_channel(channel, Some(*parent_id), (creator.0, creator.1), &mut [])
467                        .await;
468                } else {
469                    panic!(
470                        "Edge {}->{} referenced before {} was created",
471                        parent, channel, parent
472                    )
473                }
474            } else {
475                id = self
476                    .make_channel(channel, None, (creator.0, creator.1), &mut [])
477                    .await;
478            }
479
480            observed_channels.insert(channel, id);
481            result.push(id);
482        }
483
484        result
485    }
486
487    pub async fn create_room(&self, clients: &mut [(&TestClient, &mut TestAppContext)]) {
488        self.make_contacts(clients).await;
489
490        let (left, right) = clients.split_at_mut(1);
491        let (_client_a, cx_a) = &mut left[0];
492        let active_call_a = cx_a.read(ActiveCall::global);
493
494        for (client_b, cx_b) in right {
495            let user_id_b = client_b.current_user_id(cx_b).to_proto();
496            active_call_a
497                .update(*cx_a, |call, cx| call.invite(user_id_b, None, cx))
498                .await
499                .unwrap();
500
501            cx_b.executor().run_until_parked();
502            let active_call_b = cx_b.read(ActiveCall::global);
503            active_call_b
504                .update(*cx_b, |call, cx| call.accept_incoming(cx))
505                .await
506                .unwrap();
507        }
508    }
509
510    pub async fn build_app_state(
511        test_db: &TestDb,
512        livekit_test_server: &LivekitTestServer,
513        executor: Executor,
514    ) -> Arc<AppState> {
515        Arc::new(AppState {
516            db: test_db.db().clone(),
517            llm_db: None,
518            livekit_client: Some(Arc::new(livekit_test_server.create_api_client())),
519            blob_store_client: None,
520            stripe_client: None,
521            stripe_billing: None,
522            rate_limiter: Arc::new(RateLimiter::new(test_db.db().clone())),
523            executor,
524            kinesis_client: None,
525            config: Config {
526                http_port: 0,
527                database_url: "".into(),
528                database_max_connections: 0,
529                api_token: "".into(),
530                invite_link_prefix: "".into(),
531                livekit_server: None,
532                livekit_key: None,
533                livekit_secret: None,
534                llm_database_url: None,
535                llm_database_max_connections: None,
536                llm_database_migrations_path: None,
537                llm_api_secret: None,
538                rust_log: None,
539                log_json: None,
540                zed_environment: "test".into(),
541                blob_store_url: None,
542                blob_store_region: None,
543                blob_store_access_key: None,
544                blob_store_secret_key: None,
545                blob_store_bucket: None,
546                openai_api_key: None,
547                google_ai_api_key: None,
548                anthropic_api_key: None,
549                anthropic_staff_api_key: None,
550                llm_closed_beta_model_name: None,
551                prediction_api_url: None,
552                prediction_api_key: None,
553                prediction_model: None,
554                zed_client_checksum_seed: None,
555                slack_panics_webhook: None,
556                auto_join_channel_id: None,
557                migrations_path: None,
558                seed_path: None,
559                stripe_api_key: None,
560                stripe_zed_pro_price_id: None,
561                stripe_zed_pro_trial_price_id: None,
562                stripe_zed_free_price_id: None,
563                supermaven_admin_api_key: None,
564                user_backfiller_github_access_token: None,
565                kinesis_region: None,
566                kinesis_stream: None,
567                kinesis_access_key: None,
568                kinesis_secret_key: None,
569            },
570        })
571    }
572}
573
574impl Deref for TestServer {
575    type Target = Server;
576
577    fn deref(&self) -> &Self::Target {
578        &self.server
579    }
580}
581
582impl Drop for TestServer {
583    fn drop(&mut self) {
584        self.server.teardown();
585        self.test_livekit_server.teardown().unwrap();
586    }
587}
588
589impl Deref for TestClient {
590    type Target = Arc<Client>;
591
592    fn deref(&self) -> &Self::Target {
593        &self.app_state.client
594    }
595}
596
597impl TestClient {
598    pub fn fs(&self) -> Arc<FakeFs> {
599        self.app_state.fs.as_fake()
600    }
601
602    pub fn channel_store(&self) -> &Entity<ChannelStore> {
603        &self.channel_store
604    }
605
606    pub fn notification_store(&self) -> &Entity<NotificationStore> {
607        &self.notification_store
608    }
609
610    pub fn user_store(&self) -> &Entity<UserStore> {
611        &self.app_state.user_store
612    }
613
614    pub fn language_registry(&self) -> &Arc<LanguageRegistry> {
615        &self.app_state.languages
616    }
617
618    pub fn client(&self) -> &Arc<Client> {
619        &self.app_state.client
620    }
621
622    pub fn current_user_id(&self, cx: &TestAppContext) -> UserId {
623        UserId::from_proto(
624            self.app_state
625                .user_store
626                .read_with(cx, |user_store, _| user_store.current_user().unwrap().id),
627        )
628    }
629
630    pub async fn wait_for_current_user(&self, cx: &TestAppContext) {
631        let mut authed_user = self
632            .app_state
633            .user_store
634            .read_with(cx, |user_store, _| user_store.watch_current_user());
635        while authed_user.next().await.unwrap().is_none() {}
636    }
637
638    pub async fn clear_contacts(&self, cx: &mut TestAppContext) {
639        self.app_state
640            .user_store
641            .update(cx, |store, _| store.clear_contacts())
642            .await;
643    }
644
645    pub fn local_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
646        Ref::map(self.state.borrow(), |state| &state.local_projects)
647    }
648
649    pub fn dev_server_projects(&self) -> impl Deref<Target = Vec<Entity<Project>>> + '_ {
650        Ref::map(self.state.borrow(), |state| &state.dev_server_projects)
651    }
652
653    pub fn local_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
654        RefMut::map(self.state.borrow_mut(), |state| &mut state.local_projects)
655    }
656
657    pub fn dev_server_projects_mut(&self) -> impl DerefMut<Target = Vec<Entity<Project>>> + '_ {
658        RefMut::map(self.state.borrow_mut(), |state| {
659            &mut state.dev_server_projects
660        })
661    }
662
663    pub fn buffers_for_project<'a>(
664        &'a self,
665        project: &Entity<Project>,
666    ) -> impl DerefMut<Target = HashSet<Entity<language::Buffer>>> + 'a {
667        RefMut::map(self.state.borrow_mut(), |state| {
668            state.buffers.entry(project.clone()).or_default()
669        })
670    }
671
672    pub fn buffers(
673        &self,
674    ) -> impl DerefMut<Target = HashMap<Entity<Project>, HashSet<Entity<language::Buffer>>>> + '_
675    {
676        RefMut::map(self.state.borrow_mut(), |state| &mut state.buffers)
677    }
678
679    pub fn channel_buffers(&self) -> impl DerefMut<Target = HashSet<Entity<ChannelBuffer>>> + '_ {
680        RefMut::map(self.state.borrow_mut(), |state| &mut state.channel_buffers)
681    }
682
683    pub fn summarize_contacts(&self, cx: &TestAppContext) -> ContactsSummary {
684        self.app_state
685            .user_store
686            .read_with(cx, |store, _| ContactsSummary {
687                current: store
688                    .contacts()
689                    .iter()
690                    .map(|contact| contact.user.github_login.clone())
691                    .collect(),
692                outgoing_requests: store
693                    .outgoing_contact_requests()
694                    .iter()
695                    .map(|user| user.github_login.clone())
696                    .collect(),
697                incoming_requests: store
698                    .incoming_contact_requests()
699                    .iter()
700                    .map(|user| user.github_login.clone())
701                    .collect(),
702            })
703    }
704
705    pub async fn build_local_project(
706        &self,
707        root_path: impl AsRef<Path>,
708        cx: &mut TestAppContext,
709    ) -> (Entity<Project>, WorktreeId) {
710        let project = self.build_empty_local_project(cx);
711        let (worktree, _) = project
712            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
713            .await
714            .unwrap();
715        worktree
716            .read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
717            .await;
718        (project, worktree.read_with(cx, |tree, _| tree.id()))
719    }
720
721    pub async fn build_ssh_project(
722        &self,
723        root_path: impl AsRef<Path>,
724        ssh: Entity<SshRemoteClient>,
725        cx: &mut TestAppContext,
726    ) -> (Entity<Project>, WorktreeId) {
727        let project = cx.update(|cx| {
728            Project::ssh(
729                ssh,
730                self.client().clone(),
731                self.app_state.node_runtime.clone(),
732                self.app_state.user_store.clone(),
733                self.app_state.languages.clone(),
734                self.app_state.fs.clone(),
735                cx,
736            )
737        });
738        let (worktree, _) = project
739            .update(cx, |p, cx| p.find_or_create_worktree(root_path, true, cx))
740            .await
741            .unwrap();
742        (project, worktree.read_with(cx, |tree, _| tree.id()))
743    }
744
745    pub async fn build_test_project(&self, cx: &mut TestAppContext) -> Entity<Project> {
746        self.fs()
747            .insert_tree(
748                path!("/a"),
749                json!({
750                    "1.txt": "one\none\none",
751                    "2.js": "function two() { return 2; }",
752                    "3.rs": "mod test",
753                }),
754            )
755            .await;
756        self.build_local_project(path!("/a"), cx).await.0
757    }
758
759    pub async fn host_workspace(
760        &self,
761        workspace: &Entity<Workspace>,
762        channel_id: ChannelId,
763        cx: &mut VisualTestContext,
764    ) {
765        cx.update(|_, cx| {
766            let active_call = ActiveCall::global(cx);
767            active_call.update(cx, |call, cx| call.join_channel(channel_id, cx))
768        })
769        .await
770        .unwrap();
771        cx.update(|_, cx| {
772            let active_call = ActiveCall::global(cx);
773            let project = workspace.read(cx).project().clone();
774            active_call.update(cx, |call, cx| call.share_project(project, cx))
775        })
776        .await
777        .unwrap();
778        cx.executor().run_until_parked();
779    }
780
781    pub async fn join_workspace<'a>(
782        &'a self,
783        channel_id: ChannelId,
784        cx: &'a mut TestAppContext,
785    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
786        cx.update(|cx| workspace::join_channel(channel_id, self.app_state.clone(), None, cx))
787            .await
788            .unwrap();
789        cx.run_until_parked();
790
791        self.active_workspace(cx)
792    }
793
794    pub fn build_empty_local_project(&self, cx: &mut TestAppContext) -> Entity<Project> {
795        cx.update(|cx| {
796            Project::local(
797                self.client().clone(),
798                self.app_state.node_runtime.clone(),
799                self.app_state.user_store.clone(),
800                self.app_state.languages.clone(),
801                self.app_state.debug_adapters.clone(),
802                self.app_state.fs.clone(),
803                None,
804                cx,
805            )
806        })
807    }
808
809    pub async fn join_remote_project(
810        &self,
811        host_project_id: u64,
812        guest_cx: &mut TestAppContext,
813    ) -> Entity<Project> {
814        let active_call = guest_cx.read(ActiveCall::global);
815        let room = active_call.read_with(guest_cx, |call, _| call.room().unwrap().clone());
816        room.update(guest_cx, |room, cx| {
817            room.join_project(
818                host_project_id,
819                self.app_state.languages.clone(),
820                self.app_state.fs.clone(),
821                cx,
822            )
823        })
824        .await
825        .unwrap()
826    }
827
828    pub fn build_workspace<'a>(
829        &'a self,
830        project: &Entity<Project>,
831        cx: &'a mut TestAppContext,
832    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
833        cx.add_window_view(|window, cx| {
834            window.activate_window();
835            Workspace::new(None, project.clone(), self.app_state.clone(), window, cx)
836        })
837    }
838
839    pub async fn build_test_workspace<'a>(
840        &'a self,
841        cx: &'a mut TestAppContext,
842    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
843        let project = self.build_test_project(cx).await;
844        cx.add_window_view(|window, cx| {
845            window.activate_window();
846            Workspace::new(None, project.clone(), self.app_state.clone(), window, cx)
847        })
848    }
849
850    pub fn active_workspace<'a>(
851        &'a self,
852        cx: &'a mut TestAppContext,
853    ) -> (Entity<Workspace>, &'a mut VisualTestContext) {
854        let window = cx.update(|cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
855
856        let entity = window.root(cx).unwrap();
857        let cx = VisualTestContext::from_window(*window.deref(), cx).as_mut();
858        // it might be nice to try and cleanup these at the end of each test.
859        (entity, cx)
860    }
861}
862
863pub fn open_channel_notes(
864    channel_id: ChannelId,
865    cx: &mut VisualTestContext,
866) -> Task<anyhow::Result<Entity<ChannelView>>> {
867    let window = cx.update(|_, cx| cx.active_window().unwrap().downcast::<Workspace>().unwrap());
868    let entity = window.root(cx).unwrap();
869
870    cx.update(|window, cx| ChannelView::open(channel_id, None, entity.clone(), window, cx))
871}
872
873impl Drop for TestClient {
874    fn drop(&mut self) {
875        self.app_state.client.teardown();
876    }
877}