test_server.rs

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