1use crate::{
2 db::{self, NewUserParams, UserId},
3 rpc::{CLEANUP_TIMEOUT, RECONNECT_TIMEOUT},
4 tests::{TestClient, TestServer},
5};
6use anyhow::{anyhow, Result};
7use call::ActiveCall;
8use client::RECEIVE_TIMEOUT;
9use collections::BTreeMap;
10use editor::Bias;
11use fs::{FakeFs, Fs as _};
12use futures::StreamExt as _;
13use gpui::{executor::Deterministic, ModelHandle, Task, TestAppContext};
14use language::{range_to_lsp, FakeLspAdapter, Language, LanguageConfig, PointUtf16};
15use lsp::FakeLanguageServer;
16use parking_lot::Mutex;
17use project::{search::SearchQuery, Project, ProjectPath};
18use rand::{
19 distributions::{Alphanumeric, DistString},
20 prelude::*,
21};
22use serde::{Deserialize, Serialize};
23use settings::Settings;
24use std::{
25 env,
26 ops::Range,
27 path::{Path, PathBuf},
28 rc::Rc,
29 sync::{
30 atomic::{AtomicBool, Ordering::SeqCst},
31 Arc,
32 },
33};
34use util::ResultExt;
35
36lazy_static::lazy_static! {
37 static ref PLAN_LOAD_PATH: Option<PathBuf> = path_env_var("LOAD_PLAN");
38 static ref PLAN_SAVE_PATH: Option<PathBuf> = path_env_var("SAVE_PLAN");
39 static ref LOADED_PLAN_JSON: Mutex<Option<Vec<u8>>> = Default::default();
40 static ref PLAN: Mutex<Option<Arc<Mutex<TestPlan>>>> = Default::default();
41}
42
43#[gpui::test(iterations = 100, on_failure = "on_failure")]
44async fn test_random_collaboration(
45 cx: &mut TestAppContext,
46 deterministic: Arc<Deterministic>,
47 rng: StdRng,
48) {
49 deterministic.forbid_parking();
50
51 let max_peers = env::var("MAX_PEERS")
52 .map(|i| i.parse().expect("invalid `MAX_PEERS` variable"))
53 .unwrap_or(3);
54 let max_operations = env::var("OPERATIONS")
55 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
56 .unwrap_or(10);
57
58 let mut server = TestServer::start(&deterministic).await;
59 let db = server.app_state.db.clone();
60
61 let mut users = Vec::new();
62 for ix in 0..max_peers {
63 let username = format!("user-{}", ix + 1);
64 let user_id = db
65 .create_user(
66 &format!("{username}@example.com"),
67 false,
68 NewUserParams {
69 github_login: username.clone(),
70 github_user_id: (ix + 1) as i32,
71 invite_count: 0,
72 },
73 )
74 .await
75 .unwrap()
76 .user_id;
77 users.push(UserTestPlan {
78 user_id,
79 username,
80 online: false,
81 next_root_id: 0,
82 operation_ix: 0,
83 });
84 }
85
86 for (ix, user_a) in users.iter().enumerate() {
87 for user_b in &users[ix + 1..] {
88 server
89 .app_state
90 .db
91 .send_contact_request(user_a.user_id, user_b.user_id)
92 .await
93 .unwrap();
94 server
95 .app_state
96 .db
97 .respond_to_contact_request(user_b.user_id, user_a.user_id, true)
98 .await
99 .unwrap();
100 }
101 }
102
103 let plan = Arc::new(Mutex::new(TestPlan::new(rng, users, max_operations)));
104
105 if let Some(path) = &*PLAN_LOAD_PATH {
106 let json = LOADED_PLAN_JSON
107 .lock()
108 .get_or_insert_with(|| {
109 eprintln!("loaded test plan from path {:?}", path);
110 std::fs::read(path).unwrap()
111 })
112 .clone();
113 plan.lock().deserialize(json);
114 }
115
116 PLAN.lock().replace(plan.clone());
117
118 let mut clients = Vec::new();
119 let mut client_tasks = Vec::new();
120 let mut operation_channels = Vec::new();
121
122 loop {
123 let Some((next_operation, applied)) = plan.lock().next_server_operation(&clients) else { break };
124 applied.store(true, SeqCst);
125 let did_apply = apply_server_operation(
126 deterministic.clone(),
127 &mut server,
128 &mut clients,
129 &mut client_tasks,
130 &mut operation_channels,
131 plan.clone(),
132 next_operation,
133 cx,
134 )
135 .await;
136 if !did_apply {
137 applied.store(false, SeqCst);
138 }
139 }
140
141 drop(operation_channels);
142 deterministic.start_waiting();
143 futures::future::join_all(client_tasks).await;
144 deterministic.finish_waiting();
145 deterministic.run_until_parked();
146
147 check_consistency_between_clients(&clients);
148
149 for (client, mut cx) in clients {
150 cx.update(|cx| {
151 cx.clear_globals();
152 cx.set_global(Settings::test(cx));
153 drop(client);
154 });
155 }
156
157 deterministic.run_until_parked();
158}
159
160fn on_failure() {
161 if let Some(plan) = PLAN.lock().clone() {
162 if let Some(path) = &*PLAN_SAVE_PATH {
163 eprintln!("saved test plan to path {:?}", path);
164 std::fs::write(path, plan.lock().serialize()).unwrap();
165 }
166 }
167}
168
169async fn apply_server_operation(
170 deterministic: Arc<Deterministic>,
171 server: &mut TestServer,
172 clients: &mut Vec<(Rc<TestClient>, TestAppContext)>,
173 client_tasks: &mut Vec<Task<()>>,
174 operation_channels: &mut Vec<futures::channel::mpsc::UnboundedSender<usize>>,
175 plan: Arc<Mutex<TestPlan>>,
176 operation: Operation,
177 cx: &mut TestAppContext,
178) -> bool {
179 match operation {
180 Operation::AddConnection { user_id } => {
181 let username;
182 {
183 let mut plan = plan.lock();
184 let mut user = plan.user(user_id);
185 if user.online {
186 return false;
187 }
188 user.online = true;
189 username = user.username.clone();
190 };
191 log::info!("Adding new connection for {}", username);
192 let next_entity_id = (user_id.0 * 10_000) as usize;
193 let mut client_cx = TestAppContext::new(
194 cx.foreground_platform(),
195 cx.platform(),
196 deterministic.build_foreground(user_id.0 as usize),
197 deterministic.build_background(),
198 cx.font_cache(),
199 cx.leak_detector(),
200 next_entity_id,
201 cx.function_name.clone(),
202 );
203
204 let (operation_tx, operation_rx) = futures::channel::mpsc::unbounded();
205 let client = Rc::new(server.create_client(&mut client_cx, &username).await);
206 operation_channels.push(operation_tx);
207 clients.push((client.clone(), client_cx.clone()));
208 client_tasks.push(client_cx.foreground().spawn(simulate_client(
209 client,
210 operation_rx,
211 plan.clone(),
212 client_cx,
213 )));
214
215 log::info!("Added connection for {}", username);
216 }
217
218 Operation::RemoveConnection {
219 user_id: removed_user_id,
220 } => {
221 log::info!("Simulating full disconnection of user {}", removed_user_id);
222 let client_ix = clients
223 .iter()
224 .position(|(client, cx)| client.current_user_id(cx) == removed_user_id);
225 let Some(client_ix) = client_ix else { return false };
226 let user_connection_ids = server
227 .connection_pool
228 .lock()
229 .user_connection_ids(removed_user_id)
230 .collect::<Vec<_>>();
231 assert_eq!(user_connection_ids.len(), 1);
232 let removed_peer_id = user_connection_ids[0].into();
233 let (client, mut client_cx) = clients.remove(client_ix);
234 let client_task = client_tasks.remove(client_ix);
235 operation_channels.remove(client_ix);
236 server.forbid_connections();
237 server.disconnect_client(removed_peer_id);
238 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
239 deterministic.start_waiting();
240 log::info!("Waiting for user {} to exit...", removed_user_id);
241 client_task.await;
242 deterministic.finish_waiting();
243 server.allow_connections();
244
245 for project in client.remote_projects().iter() {
246 project.read_with(&client_cx, |project, _| {
247 assert!(
248 project.is_read_only(),
249 "project {:?} should be read only",
250 project.remote_id()
251 )
252 });
253 }
254
255 for (client, cx) in clients {
256 let contacts = server
257 .app_state
258 .db
259 .get_contacts(client.current_user_id(cx))
260 .await
261 .unwrap();
262 let pool = server.connection_pool.lock();
263 for contact in contacts {
264 if let db::Contact::Accepted { user_id, busy, .. } = contact {
265 if user_id == removed_user_id {
266 assert!(!pool.is_user_online(user_id));
267 assert!(!busy);
268 }
269 }
270 }
271 }
272
273 log::info!("{} removed", client.username);
274 plan.lock().user(removed_user_id).online = false;
275 client_cx.update(|cx| {
276 cx.clear_globals();
277 drop(client);
278 });
279 }
280
281 Operation::BounceConnection { user_id } => {
282 log::info!("Simulating temporary disconnection of user {}", user_id);
283 let user_connection_ids = server
284 .connection_pool
285 .lock()
286 .user_connection_ids(user_id)
287 .collect::<Vec<_>>();
288 if user_connection_ids.is_empty() {
289 return false;
290 }
291 assert_eq!(user_connection_ids.len(), 1);
292 let peer_id = user_connection_ids[0].into();
293 server.disconnect_client(peer_id);
294 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
295 }
296
297 Operation::RestartServer => {
298 log::info!("Simulating server restart");
299 server.reset().await;
300 deterministic.advance_clock(RECEIVE_TIMEOUT);
301 server.start().await.unwrap();
302 deterministic.advance_clock(CLEANUP_TIMEOUT);
303 let environment = &server.app_state.config.zed_environment;
304 let stale_room_ids = server
305 .app_state
306 .db
307 .stale_room_ids(environment, server.id())
308 .await
309 .unwrap();
310 assert_eq!(stale_room_ids, vec![]);
311 }
312
313 Operation::MutateClients {
314 user_ids,
315 batch_id,
316 quiesce,
317 } => {
318 let mut applied = false;
319 for user_id in user_ids {
320 let client_ix = clients
321 .iter()
322 .position(|(client, cx)| client.current_user_id(cx) == user_id);
323 let Some(client_ix) = client_ix else { continue };
324 applied = true;
325 if let Err(err) = operation_channels[client_ix].unbounded_send(batch_id) {
326 log::error!("error signaling user {user_id}: {err}");
327 }
328 }
329
330 if quiesce && applied {
331 deterministic.run_until_parked();
332 check_consistency_between_clients(&clients);
333 }
334
335 return applied;
336 }
337 }
338 true
339}
340
341async fn apply_client_operation(
342 client: &TestClient,
343 operation: ClientOperation,
344 cx: &mut TestAppContext,
345) -> Result<(), TestError> {
346 match operation {
347 ClientOperation::AcceptIncomingCall => {
348 let active_call = cx.read(ActiveCall::global);
349 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
350 Err(TestError::Inapplicable)?;
351 }
352
353 log::info!("{}: accepting incoming call", client.username);
354 active_call
355 .update(cx, |call, cx| call.accept_incoming(cx))
356 .await?;
357 }
358
359 ClientOperation::RejectIncomingCall => {
360 let active_call = cx.read(ActiveCall::global);
361 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
362 Err(TestError::Inapplicable)?;
363 }
364
365 log::info!("{}: declining incoming call", client.username);
366 active_call.update(cx, |call, _| call.decline_incoming())?;
367 }
368
369 ClientOperation::LeaveCall => {
370 let active_call = cx.read(ActiveCall::global);
371 if active_call.read_with(cx, |call, _| call.room().is_none()) {
372 Err(TestError::Inapplicable)?;
373 }
374
375 log::info!("{}: hanging up", client.username);
376 active_call.update(cx, |call, cx| call.hang_up(cx)).await?;
377 }
378
379 ClientOperation::InviteContactToCall { user_id } => {
380 let active_call = cx.read(ActiveCall::global);
381
382 log::info!("{}: inviting {}", client.username, user_id,);
383 active_call
384 .update(cx, |call, cx| call.invite(user_id.to_proto(), None, cx))
385 .await
386 .log_err();
387 }
388
389 ClientOperation::OpenLocalProject { first_root_name } => {
390 log::info!(
391 "{}: opening local project at {:?}",
392 client.username,
393 first_root_name
394 );
395
396 let root_path = Path::new("/").join(&first_root_name);
397 client.fs.create_dir(&root_path).await.unwrap();
398 client
399 .fs
400 .create_file(&root_path.join("main.rs"), Default::default())
401 .await
402 .unwrap();
403 let project = client.build_local_project(root_path, cx).await.0;
404 ensure_project_shared(&project, client, cx).await;
405 client.local_projects_mut().push(project.clone());
406 }
407
408 ClientOperation::AddWorktreeToProject {
409 project_root_name,
410 new_root_path,
411 } => {
412 let project = project_for_root_name(client, &project_root_name, cx)
413 .ok_or(TestError::Inapplicable)?;
414
415 log::info!(
416 "{}: finding/creating local worktree at {:?} to project with root path {}",
417 client.username,
418 new_root_path,
419 project_root_name
420 );
421
422 ensure_project_shared(&project, client, cx).await;
423 if !client.fs.paths().contains(&new_root_path) {
424 client.fs.create_dir(&new_root_path).await.unwrap();
425 }
426 project
427 .update(cx, |project, cx| {
428 project.find_or_create_local_worktree(&new_root_path, true, cx)
429 })
430 .await
431 .unwrap();
432 }
433
434 ClientOperation::CloseRemoteProject { project_root_name } => {
435 let project = project_for_root_name(client, &project_root_name, cx)
436 .ok_or(TestError::Inapplicable)?;
437
438 log::info!(
439 "{}: closing remote project with root path {}",
440 client.username,
441 project_root_name,
442 );
443
444 let ix = client
445 .remote_projects()
446 .iter()
447 .position(|p| p == &project)
448 .unwrap();
449 cx.update(|_| {
450 client.remote_projects_mut().remove(ix);
451 client.buffers().retain(|p, _| *p != project);
452 drop(project);
453 });
454 }
455
456 ClientOperation::OpenRemoteProject {
457 host_id,
458 first_root_name,
459 } => {
460 let active_call = cx.read(ActiveCall::global);
461 let project = active_call
462 .update(cx, |call, cx| {
463 let room = call.room().cloned()?;
464 let participant = room
465 .read(cx)
466 .remote_participants()
467 .get(&host_id.to_proto())?;
468 let project_id = participant
469 .projects
470 .iter()
471 .find(|project| project.worktree_root_names[0] == first_root_name)?
472 .id;
473 Some(room.update(cx, |room, cx| {
474 room.join_project(
475 project_id,
476 client.language_registry.clone(),
477 FakeFs::new(cx.background().clone()),
478 cx,
479 )
480 }))
481 })
482 .ok_or(TestError::Inapplicable)?;
483
484 log::info!(
485 "{}: joining remote project of user {}, root name {}",
486 client.username,
487 host_id,
488 first_root_name,
489 );
490
491 let project = project.await?;
492 client.remote_projects_mut().push(project.clone());
493 }
494
495 ClientOperation::CreateWorktreeEntry {
496 project_root_name,
497 is_local,
498 full_path,
499 is_dir,
500 } => {
501 let project = project_for_root_name(client, &project_root_name, cx)
502 .ok_or(TestError::Inapplicable)?;
503 let project_path = project_path_for_full_path(&project, &full_path, cx)
504 .ok_or(TestError::Inapplicable)?;
505
506 log::info!(
507 "{}: creating {} at path {:?} in {} project {}",
508 client.username,
509 if is_dir { "dir" } else { "file" },
510 full_path,
511 if is_local { "local" } else { "remote" },
512 project_root_name,
513 );
514
515 ensure_project_shared(&project, client, cx).await;
516 project
517 .update(cx, |p, cx| p.create_entry(project_path, is_dir, cx))
518 .unwrap()
519 .await?;
520 }
521
522 ClientOperation::OpenBuffer {
523 project_root_name,
524 is_local,
525 full_path,
526 } => {
527 let project = project_for_root_name(client, &project_root_name, cx)
528 .ok_or(TestError::Inapplicable)?;
529 let project_path = project_path_for_full_path(&project, &full_path, cx)
530 .ok_or(TestError::Inapplicable)?;
531
532 log::info!(
533 "{}: opening buffer {:?} in {} project {}",
534 client.username,
535 full_path,
536 if is_local { "local" } else { "remote" },
537 project_root_name,
538 );
539
540 ensure_project_shared(&project, client, cx).await;
541 let buffer = project
542 .update(cx, |project, cx| project.open_buffer(project_path, cx))
543 .await?;
544 client.buffers_for_project(&project).insert(buffer);
545 }
546
547 ClientOperation::EditBuffer {
548 project_root_name,
549 is_local,
550 full_path,
551 edits,
552 } => {
553 let project = project_for_root_name(client, &project_root_name, cx)
554 .ok_or(TestError::Inapplicable)?;
555 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
556 .ok_or(TestError::Inapplicable)?;
557
558 log::info!(
559 "{}: editing buffer {:?} in {} project {} with {:?}",
560 client.username,
561 full_path,
562 if is_local { "local" } else { "remote" },
563 project_root_name,
564 edits
565 );
566
567 ensure_project_shared(&project, client, cx).await;
568 buffer.update(cx, |buffer, cx| {
569 let snapshot = buffer.snapshot();
570 buffer.edit(
571 edits.into_iter().map(|(range, text)| {
572 let start = snapshot.clip_offset(range.start, Bias::Left);
573 let end = snapshot.clip_offset(range.end, Bias::Right);
574 (start..end, text)
575 }),
576 None,
577 cx,
578 );
579 });
580 }
581
582 ClientOperation::CloseBuffer {
583 project_root_name,
584 is_local,
585 full_path,
586 } => {
587 let project = project_for_root_name(client, &project_root_name, cx)
588 .ok_or(TestError::Inapplicable)?;
589 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
590 .ok_or(TestError::Inapplicable)?;
591
592 log::info!(
593 "{}: closing buffer {:?} in {} project {}",
594 client.username,
595 full_path,
596 if is_local { "local" } else { "remote" },
597 project_root_name
598 );
599
600 ensure_project_shared(&project, client, cx).await;
601 cx.update(|_| {
602 client.buffers_for_project(&project).remove(&buffer);
603 drop(buffer);
604 });
605 }
606
607 ClientOperation::SaveBuffer {
608 project_root_name,
609 is_local,
610 full_path,
611 detach,
612 } => {
613 let project = project_for_root_name(client, &project_root_name, cx)
614 .ok_or(TestError::Inapplicable)?;
615 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
616 .ok_or(TestError::Inapplicable)?;
617
618 log::info!(
619 "{}: saving buffer {:?} in {} project {}, {}",
620 client.username,
621 full_path,
622 if is_local { "local" } else { "remote" },
623 project_root_name,
624 if detach { "detaching" } else { "awaiting" }
625 );
626
627 ensure_project_shared(&project, client, cx).await;
628 let requested_version = buffer.read_with(cx, |buffer, _| buffer.version());
629 let save = project.update(cx, |project, cx| project.save_buffer(buffer, cx));
630 let save = cx.background().spawn(async move {
631 let (saved_version, _, _) = save
632 .await
633 .map_err(|err| anyhow!("save request failed: {:?}", err))?;
634 assert!(saved_version.observed_all(&requested_version));
635 anyhow::Ok(())
636 });
637 if detach {
638 cx.update(|cx| save.detach_and_log_err(cx));
639 } else {
640 save.await?;
641 }
642 }
643
644 ClientOperation::RequestLspDataInBuffer {
645 project_root_name,
646 is_local,
647 full_path,
648 offset,
649 kind,
650 detach,
651 } => {
652 let project = project_for_root_name(client, &project_root_name, cx)
653 .ok_or(TestError::Inapplicable)?;
654 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
655 .ok_or(TestError::Inapplicable)?;
656
657 log::info!(
658 "{}: request LSP {:?} for buffer {:?} in {} project {}, {}",
659 client.username,
660 kind,
661 full_path,
662 if is_local { "local" } else { "remote" },
663 project_root_name,
664 if detach { "detaching" } else { "awaiting" }
665 );
666
667 use futures::{FutureExt as _, TryFutureExt as _};
668 let offset = buffer.read_with(cx, |b, _| b.clip_offset(offset, Bias::Left));
669 let request = cx.foreground().spawn(project.update(cx, |project, cx| {
670 match kind {
671 LspRequestKind::Rename => project
672 .prepare_rename(buffer, offset, cx)
673 .map_ok(|_| ())
674 .boxed(),
675 LspRequestKind::Completion => project
676 .completions(&buffer, offset, cx)
677 .map_ok(|_| ())
678 .boxed(),
679 LspRequestKind::CodeAction => project
680 .code_actions(&buffer, offset..offset, cx)
681 .map_ok(|_| ())
682 .boxed(),
683 LspRequestKind::Definition => project
684 .definition(&buffer, offset, cx)
685 .map_ok(|_| ())
686 .boxed(),
687 LspRequestKind::Highlights => project
688 .document_highlights(&buffer, offset, cx)
689 .map_ok(|_| ())
690 .boxed(),
691 }
692 }));
693 if detach {
694 request.detach();
695 } else {
696 request.await?;
697 }
698 }
699
700 ClientOperation::SearchProject {
701 project_root_name,
702 is_local,
703 query,
704 detach,
705 } => {
706 let project = project_for_root_name(client, &project_root_name, cx)
707 .ok_or(TestError::Inapplicable)?;
708
709 log::info!(
710 "{}: search {} project {} for {:?}, {}",
711 client.username,
712 if is_local { "local" } else { "remote" },
713 project_root_name,
714 query,
715 if detach { "detaching" } else { "awaiting" }
716 );
717
718 let search = project.update(cx, |project, cx| {
719 project.search(SearchQuery::text(query, false, false), cx)
720 });
721 drop(project);
722 let search = cx.background().spawn(async move {
723 search
724 .await
725 .map_err(|err| anyhow!("search request failed: {:?}", err))
726 });
727 if detach {
728 cx.update(|cx| search.detach_and_log_err(cx));
729 } else {
730 search.await?;
731 }
732 }
733
734 ClientOperation::WriteFsEntry {
735 path,
736 is_dir,
737 content,
738 } => {
739 if !client
740 .fs
741 .directories()
742 .contains(&path.parent().unwrap().to_owned())
743 {
744 return Err(TestError::Inapplicable);
745 }
746
747 if is_dir {
748 log::info!("{}: creating dir at {:?}", client.username, path);
749 client.fs.create_dir(&path).await.unwrap();
750 } else {
751 let exists = client.fs.metadata(&path).await?.is_some();
752 let verb = if exists { "updating" } else { "creating" };
753 log::info!("{}: {} file at {:?}", verb, client.username, path);
754
755 client
756 .fs
757 .save(&path, &content.as_str().into(), fs::LineEnding::Unix)
758 .await
759 .unwrap();
760 }
761 }
762
763 ClientOperation::WriteGitIndex {
764 repo_path,
765 contents,
766 } => {
767 if !client.fs.directories().contains(&repo_path) {
768 return Err(TestError::Inapplicable);
769 }
770
771 log::info!(
772 "{}: writing git index for repo {:?}: {:?}",
773 client.username,
774 repo_path,
775 contents
776 );
777
778 let dot_git_dir = repo_path.join(".git");
779 let contents = contents
780 .iter()
781 .map(|(path, contents)| (path.as_path(), contents.clone()))
782 .collect::<Vec<_>>();
783 if client.fs.metadata(&dot_git_dir).await?.is_none() {
784 client.fs.create_dir(&dot_git_dir).await?;
785 }
786 client.fs.set_index_for_repo(&dot_git_dir, &contents).await;
787 }
788 }
789 Ok(())
790}
791
792fn check_consistency_between_clients(clients: &[(Rc<TestClient>, TestAppContext)]) {
793 for (client, client_cx) in clients {
794 for guest_project in client.remote_projects().iter() {
795 guest_project.read_with(client_cx, |guest_project, cx| {
796 let host_project = clients.iter().find_map(|(client, cx)| {
797 let project = client
798 .local_projects()
799 .iter()
800 .find(|host_project| {
801 host_project.read_with(cx, |host_project, _| {
802 host_project.remote_id() == guest_project.remote_id()
803 })
804 })?
805 .clone();
806 Some((project, cx))
807 });
808
809 if !guest_project.is_read_only() {
810 if let Some((host_project, host_cx)) = host_project {
811 let host_worktree_snapshots =
812 host_project.read_with(host_cx, |host_project, cx| {
813 host_project
814 .worktrees(cx)
815 .map(|worktree| {
816 let worktree = worktree.read(cx);
817 (worktree.id(), worktree.snapshot())
818 })
819 .collect::<BTreeMap<_, _>>()
820 });
821 let guest_worktree_snapshots = guest_project
822 .worktrees(cx)
823 .map(|worktree| {
824 let worktree = worktree.read(cx);
825 (worktree.id(), worktree.snapshot())
826 })
827 .collect::<BTreeMap<_, _>>();
828
829 assert_eq!(
830 guest_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
831 host_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
832 "{} has different worktrees than the host for project {:?}",
833 client.username, guest_project.remote_id(),
834 );
835
836 for (id, host_snapshot) in &host_worktree_snapshots {
837 let guest_snapshot = &guest_worktree_snapshots[id];
838 assert_eq!(
839 guest_snapshot.root_name(),
840 host_snapshot.root_name(),
841 "{} has different root name than the host for worktree {}, project {:?}",
842 client.username,
843 id,
844 guest_project.remote_id(),
845 );
846 assert_eq!(
847 guest_snapshot.abs_path(),
848 host_snapshot.abs_path(),
849 "{} has different abs path than the host for worktree {}, project: {:?}",
850 client.username,
851 id,
852 guest_project.remote_id(),
853 );
854 assert_eq!(
855 guest_snapshot.entries(false).collect::<Vec<_>>(),
856 host_snapshot.entries(false).collect::<Vec<_>>(),
857 "{} has different snapshot than the host for worktree {:?} and project {:?}",
858 client.username,
859 host_snapshot.abs_path(),
860 guest_project.remote_id(),
861 );
862 assert_eq!(guest_snapshot.scan_id(), host_snapshot.scan_id(),
863 "{} has different scan id than the host for worktree {:?} and project {:?}",
864 client.username,
865 host_snapshot.abs_path(),
866 guest_project.remote_id(),
867 );
868 }
869 }
870 }
871
872 for buffer in guest_project.opened_buffers(cx) {
873 let buffer = buffer.read(cx);
874 assert_eq!(
875 buffer.deferred_ops_len(),
876 0,
877 "{} has deferred operations for buffer {:?} in project {:?}",
878 client.username,
879 buffer.file().unwrap().full_path(cx),
880 guest_project.remote_id(),
881 );
882 }
883 });
884 }
885
886 let buffers = client.buffers().clone();
887 for (guest_project, guest_buffers) in &buffers {
888 let project_id = if guest_project.read_with(client_cx, |project, _| {
889 project.is_local() || project.is_read_only()
890 }) {
891 continue;
892 } else {
893 guest_project
894 .read_with(client_cx, |project, _| project.remote_id())
895 .unwrap()
896 };
897 let guest_user_id = client.user_id().unwrap();
898
899 let host_project = clients.iter().find_map(|(client, cx)| {
900 let project = client
901 .local_projects()
902 .iter()
903 .find(|host_project| {
904 host_project.read_with(cx, |host_project, _| {
905 host_project.remote_id() == Some(project_id)
906 })
907 })?
908 .clone();
909 Some((client.user_id().unwrap(), project, cx))
910 });
911
912 let (host_user_id, host_project, host_cx) =
913 if let Some((host_user_id, host_project, host_cx)) = host_project {
914 (host_user_id, host_project, host_cx)
915 } else {
916 continue;
917 };
918
919 for guest_buffer in guest_buffers {
920 let buffer_id = guest_buffer.read_with(client_cx, |buffer, _| buffer.remote_id());
921 let host_buffer = host_project.read_with(host_cx, |project, cx| {
922 project.buffer_for_id(buffer_id, cx).unwrap_or_else(|| {
923 panic!(
924 "host does not have buffer for guest:{}, peer:{:?}, id:{}",
925 client.username,
926 client.peer_id(),
927 buffer_id
928 )
929 })
930 });
931 let path = host_buffer
932 .read_with(host_cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
933
934 assert_eq!(
935 guest_buffer.read_with(client_cx, |buffer, _| buffer.deferred_ops_len()),
936 0,
937 "{}, buffer {}, path {:?} has deferred operations",
938 client.username,
939 buffer_id,
940 path,
941 );
942 assert_eq!(
943 guest_buffer.read_with(client_cx, |buffer, _| buffer.text()),
944 host_buffer.read_with(host_cx, |buffer, _| buffer.text()),
945 "{}, buffer {}, path {:?}, differs from the host's buffer",
946 client.username,
947 buffer_id,
948 path
949 );
950
951 let host_file = host_buffer.read_with(host_cx, |b, _| b.file().cloned());
952 let guest_file = guest_buffer.read_with(client_cx, |b, _| b.file().cloned());
953 match (host_file, guest_file) {
954 (Some(host_file), Some(guest_file)) => {
955 assert_eq!(guest_file.path(), host_file.path());
956 assert_eq!(guest_file.is_deleted(), host_file.is_deleted());
957 assert_eq!(
958 guest_file.mtime(),
959 host_file.mtime(),
960 "guest {} mtime does not match host {} for path {:?} in project {}",
961 guest_user_id,
962 host_user_id,
963 guest_file.path(),
964 project_id,
965 );
966 }
967 (None, None) => {}
968 (None, _) => panic!("host's file is None, guest's isn't"),
969 (_, None) => panic!("guest's file is None, hosts's isn't"),
970 }
971
972 let host_diff_base =
973 host_buffer.read_with(host_cx, |b, _| b.diff_base().map(ToString::to_string));
974 let guest_diff_base = guest_buffer
975 .read_with(client_cx, |b, _| b.diff_base().map(ToString::to_string));
976 assert_eq!(guest_diff_base, host_diff_base);
977
978 let host_saved_version =
979 host_buffer.read_with(host_cx, |b, _| b.saved_version().clone());
980 let guest_saved_version =
981 guest_buffer.read_with(client_cx, |b, _| b.saved_version().clone());
982 assert_eq!(
983 guest_saved_version, host_saved_version,
984 "guest saved version does not match host's for path {path:?} in project {project_id}",
985 );
986
987 let host_saved_version_fingerprint =
988 host_buffer.read_with(host_cx, |b, _| b.saved_version_fingerprint());
989 let guest_saved_version_fingerprint =
990 guest_buffer.read_with(client_cx, |b, _| b.saved_version_fingerprint());
991 assert_eq!(
992 guest_saved_version_fingerprint, host_saved_version_fingerprint,
993 "guest's saved fingerprint does not match host's for path {path:?} in project {project_id}",
994 );
995
996 let host_saved_mtime = host_buffer.read_with(host_cx, |b, _| b.saved_mtime());
997 let guest_saved_mtime = guest_buffer.read_with(client_cx, |b, _| b.saved_mtime());
998 assert_eq!(
999 guest_saved_mtime, host_saved_mtime,
1000 "guest's saved mtime does not match host's for path {path:?} in project {project_id}",
1001 );
1002
1003 let host_is_dirty = host_buffer.read_with(host_cx, |b, _| b.is_dirty());
1004 let guest_is_dirty = guest_buffer.read_with(client_cx, |b, _| b.is_dirty());
1005 assert_eq!(guest_is_dirty, host_is_dirty,
1006 "guest's dirty status does not match host's for path {path:?} in project {project_id}",
1007 );
1008
1009 let host_has_conflict = host_buffer.read_with(host_cx, |b, _| b.has_conflict());
1010 let guest_has_conflict = guest_buffer.read_with(client_cx, |b, _| b.has_conflict());
1011 assert_eq!(guest_has_conflict, host_has_conflict,
1012 "guest's conflict status does not match host's for path {path:?} in project {project_id}",
1013 );
1014 }
1015 }
1016 }
1017}
1018
1019struct TestPlan {
1020 rng: StdRng,
1021 replay: bool,
1022 stored_operations: Vec<(StoredOperation, Arc<AtomicBool>)>,
1023 max_operations: usize,
1024 operation_ix: usize,
1025 users: Vec<UserTestPlan>,
1026 next_batch_id: usize,
1027 allow_server_restarts: bool,
1028 allow_client_reconnection: bool,
1029 allow_client_disconnection: bool,
1030}
1031
1032struct UserTestPlan {
1033 user_id: UserId,
1034 username: String,
1035 next_root_id: usize,
1036 operation_ix: usize,
1037 online: bool,
1038}
1039
1040#[derive(Clone, Debug, Serialize, Deserialize)]
1041#[serde(untagged)]
1042enum StoredOperation {
1043 Server(Operation),
1044 Client {
1045 user_id: UserId,
1046 batch_id: usize,
1047 operation: ClientOperation,
1048 },
1049}
1050
1051#[derive(Clone, Debug, Serialize, Deserialize)]
1052enum Operation {
1053 AddConnection {
1054 user_id: UserId,
1055 },
1056 RemoveConnection {
1057 user_id: UserId,
1058 },
1059 BounceConnection {
1060 user_id: UserId,
1061 },
1062 RestartServer,
1063 MutateClients {
1064 batch_id: usize,
1065 #[serde(skip_serializing)]
1066 #[serde(skip_deserializing)]
1067 user_ids: Vec<UserId>,
1068 quiesce: bool,
1069 },
1070}
1071
1072#[derive(Clone, Debug, Serialize, Deserialize)]
1073enum ClientOperation {
1074 AcceptIncomingCall,
1075 RejectIncomingCall,
1076 LeaveCall,
1077 InviteContactToCall {
1078 user_id: UserId,
1079 },
1080 OpenLocalProject {
1081 first_root_name: String,
1082 },
1083 OpenRemoteProject {
1084 host_id: UserId,
1085 first_root_name: String,
1086 },
1087 AddWorktreeToProject {
1088 project_root_name: String,
1089 new_root_path: PathBuf,
1090 },
1091 CloseRemoteProject {
1092 project_root_name: String,
1093 },
1094 OpenBuffer {
1095 project_root_name: String,
1096 is_local: bool,
1097 full_path: PathBuf,
1098 },
1099 SearchProject {
1100 project_root_name: String,
1101 is_local: bool,
1102 query: String,
1103 detach: bool,
1104 },
1105 EditBuffer {
1106 project_root_name: String,
1107 is_local: bool,
1108 full_path: PathBuf,
1109 edits: Vec<(Range<usize>, Arc<str>)>,
1110 },
1111 CloseBuffer {
1112 project_root_name: String,
1113 is_local: bool,
1114 full_path: PathBuf,
1115 },
1116 SaveBuffer {
1117 project_root_name: String,
1118 is_local: bool,
1119 full_path: PathBuf,
1120 detach: bool,
1121 },
1122 RequestLspDataInBuffer {
1123 project_root_name: String,
1124 is_local: bool,
1125 full_path: PathBuf,
1126 offset: usize,
1127 kind: LspRequestKind,
1128 detach: bool,
1129 },
1130 CreateWorktreeEntry {
1131 project_root_name: String,
1132 is_local: bool,
1133 full_path: PathBuf,
1134 is_dir: bool,
1135 },
1136 WriteFsEntry {
1137 path: PathBuf,
1138 is_dir: bool,
1139 content: String,
1140 },
1141 WriteGitIndex {
1142 repo_path: PathBuf,
1143 contents: Vec<(PathBuf, String)>,
1144 },
1145}
1146
1147#[derive(Clone, Debug, Serialize, Deserialize)]
1148enum LspRequestKind {
1149 Rename,
1150 Completion,
1151 CodeAction,
1152 Definition,
1153 Highlights,
1154}
1155
1156enum TestError {
1157 Inapplicable,
1158 Other(anyhow::Error),
1159}
1160
1161impl From<anyhow::Error> for TestError {
1162 fn from(value: anyhow::Error) -> Self {
1163 Self::Other(value)
1164 }
1165}
1166
1167impl TestPlan {
1168 fn new(mut rng: StdRng, users: Vec<UserTestPlan>, max_operations: usize) -> Self {
1169 Self {
1170 replay: false,
1171 allow_server_restarts: rng.gen_bool(0.7),
1172 allow_client_reconnection: rng.gen_bool(0.7),
1173 allow_client_disconnection: rng.gen_bool(0.1),
1174 stored_operations: Vec::new(),
1175 operation_ix: 0,
1176 next_batch_id: 0,
1177 max_operations,
1178 users,
1179 rng,
1180 }
1181 }
1182
1183 fn deserialize(&mut self, json: Vec<u8>) {
1184 let stored_operations: Vec<StoredOperation> = serde_json::from_slice(&json).unwrap();
1185 self.replay = true;
1186 self.stored_operations = stored_operations
1187 .iter()
1188 .cloned()
1189 .enumerate()
1190 .map(|(i, mut operation)| {
1191 if let StoredOperation::Server(Operation::MutateClients {
1192 batch_id: current_batch_id,
1193 user_ids,
1194 ..
1195 }) = &mut operation
1196 {
1197 assert!(user_ids.is_empty());
1198 user_ids.extend(stored_operations[i + 1..].iter().filter_map(|operation| {
1199 if let StoredOperation::Client {
1200 user_id, batch_id, ..
1201 } = operation
1202 {
1203 if batch_id == current_batch_id {
1204 return Some(user_id);
1205 }
1206 }
1207 None
1208 }));
1209 user_ids.sort_unstable();
1210 }
1211 (operation, Arc::new(AtomicBool::new(false)))
1212 })
1213 .collect()
1214 }
1215
1216 fn serialize(&mut self) -> Vec<u8> {
1217 // Format each operation as one line
1218 let mut json = Vec::new();
1219 json.push(b'[');
1220 for (operation, applied) in &self.stored_operations {
1221 if !applied.load(SeqCst) {
1222 continue;
1223 }
1224 if json.len() > 1 {
1225 json.push(b',');
1226 }
1227 json.extend_from_slice(b"\n ");
1228 serde_json::to_writer(&mut json, operation).unwrap();
1229 }
1230 json.extend_from_slice(b"\n]\n");
1231 json
1232 }
1233
1234 fn next_server_operation(
1235 &mut self,
1236 clients: &[(Rc<TestClient>, TestAppContext)],
1237 ) -> Option<(Operation, Arc<AtomicBool>)> {
1238 if self.replay {
1239 while let Some(stored_operation) = self.stored_operations.get(self.operation_ix) {
1240 self.operation_ix += 1;
1241 if let (StoredOperation::Server(operation), applied) = stored_operation {
1242 return Some((operation.clone(), applied.clone()));
1243 }
1244 }
1245 None
1246 } else {
1247 let operation = self.generate_server_operation(clients)?;
1248 let applied = Arc::new(AtomicBool::new(false));
1249 self.stored_operations
1250 .push((StoredOperation::Server(operation.clone()), applied.clone()));
1251 Some((operation, applied))
1252 }
1253 }
1254
1255 fn next_client_operation(
1256 &mut self,
1257 client: &TestClient,
1258 current_batch_id: usize,
1259 cx: &TestAppContext,
1260 ) -> Option<(ClientOperation, Arc<AtomicBool>)> {
1261 let current_user_id = client.current_user_id(cx);
1262 let user_ix = self
1263 .users
1264 .iter()
1265 .position(|user| user.user_id == current_user_id)
1266 .unwrap();
1267 let user_plan = &mut self.users[user_ix];
1268
1269 if self.replay {
1270 while let Some(stored_operation) = self.stored_operations.get(user_plan.operation_ix) {
1271 user_plan.operation_ix += 1;
1272 if let (
1273 StoredOperation::Client {
1274 user_id, operation, ..
1275 },
1276 applied,
1277 ) = stored_operation
1278 {
1279 if user_id == ¤t_user_id {
1280 return Some((operation.clone(), applied.clone()));
1281 }
1282 }
1283 }
1284 None
1285 } else {
1286 let operation = self.generate_client_operation(current_user_id, client, cx)?;
1287 let applied = Arc::new(AtomicBool::new(false));
1288 self.stored_operations.push((
1289 StoredOperation::Client {
1290 user_id: current_user_id,
1291 batch_id: current_batch_id,
1292 operation: operation.clone(),
1293 },
1294 applied.clone(),
1295 ));
1296 Some((operation, applied))
1297 }
1298 }
1299
1300 fn generate_server_operation(
1301 &mut self,
1302 clients: &[(Rc<TestClient>, TestAppContext)],
1303 ) -> Option<Operation> {
1304 if self.operation_ix == self.max_operations {
1305 return None;
1306 }
1307
1308 Some(loop {
1309 break match self.rng.gen_range(0..100) {
1310 0..=29 if clients.len() < self.users.len() => {
1311 let user = self
1312 .users
1313 .iter()
1314 .filter(|u| !u.online)
1315 .choose(&mut self.rng)
1316 .unwrap();
1317 self.operation_ix += 1;
1318 Operation::AddConnection {
1319 user_id: user.user_id,
1320 }
1321 }
1322 30..=34 if clients.len() > 1 && self.allow_client_disconnection => {
1323 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1324 let user_id = client.current_user_id(cx);
1325 self.operation_ix += 1;
1326 Operation::RemoveConnection { user_id }
1327 }
1328 35..=39 if clients.len() > 1 && self.allow_client_reconnection => {
1329 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1330 let user_id = client.current_user_id(cx);
1331 self.operation_ix += 1;
1332 Operation::BounceConnection { user_id }
1333 }
1334 40..=44 if self.allow_server_restarts && clients.len() > 1 => {
1335 self.operation_ix += 1;
1336 Operation::RestartServer
1337 }
1338 _ if !clients.is_empty() => {
1339 let count = self
1340 .rng
1341 .gen_range(1..10)
1342 .min(self.max_operations - self.operation_ix);
1343 let batch_id = util::post_inc(&mut self.next_batch_id);
1344 let mut user_ids = (0..count)
1345 .map(|_| {
1346 let ix = self.rng.gen_range(0..clients.len());
1347 let (client, cx) = &clients[ix];
1348 client.current_user_id(cx)
1349 })
1350 .collect::<Vec<_>>();
1351 user_ids.sort_unstable();
1352 Operation::MutateClients {
1353 user_ids,
1354 batch_id,
1355 quiesce: self.rng.gen_bool(0.7),
1356 }
1357 }
1358 _ => continue,
1359 };
1360 })
1361 }
1362
1363 fn generate_client_operation(
1364 &mut self,
1365 user_id: UserId,
1366 client: &TestClient,
1367 cx: &TestAppContext,
1368 ) -> Option<ClientOperation> {
1369 if self.operation_ix == self.max_operations {
1370 return None;
1371 }
1372
1373 self.operation_ix += 1;
1374 let call = cx.read(ActiveCall::global);
1375 Some(loop {
1376 match self.rng.gen_range(0..100_u32) {
1377 // Mutate the call
1378 0..=29 => {
1379 // Respond to an incoming call
1380 if call.read_with(cx, |call, _| call.incoming().borrow().is_some()) {
1381 break if self.rng.gen_bool(0.7) {
1382 ClientOperation::AcceptIncomingCall
1383 } else {
1384 ClientOperation::RejectIncomingCall
1385 };
1386 }
1387
1388 match self.rng.gen_range(0..100_u32) {
1389 // Invite a contact to the current call
1390 0..=70 => {
1391 let available_contacts =
1392 client.user_store.read_with(cx, |user_store, _| {
1393 user_store
1394 .contacts()
1395 .iter()
1396 .filter(|contact| contact.online && !contact.busy)
1397 .cloned()
1398 .collect::<Vec<_>>()
1399 });
1400 if !available_contacts.is_empty() {
1401 let contact = available_contacts.choose(&mut self.rng).unwrap();
1402 break ClientOperation::InviteContactToCall {
1403 user_id: UserId(contact.user.id as i32),
1404 };
1405 }
1406 }
1407
1408 // Leave the current call
1409 71.. => {
1410 if self.allow_client_disconnection
1411 && call.read_with(cx, |call, _| call.room().is_some())
1412 {
1413 break ClientOperation::LeaveCall;
1414 }
1415 }
1416 }
1417 }
1418
1419 // Mutate projects
1420 30..=59 => match self.rng.gen_range(0..100_u32) {
1421 // Open a new project
1422 0..=70 => {
1423 // Open a remote project
1424 if let Some(room) = call.read_with(cx, |call, _| call.room().cloned()) {
1425 let existing_remote_project_ids = cx.read(|cx| {
1426 client
1427 .remote_projects()
1428 .iter()
1429 .map(|p| p.read(cx).remote_id().unwrap())
1430 .collect::<Vec<_>>()
1431 });
1432 let new_remote_projects = room.read_with(cx, |room, _| {
1433 room.remote_participants()
1434 .values()
1435 .flat_map(|participant| {
1436 participant.projects.iter().filter_map(|project| {
1437 if existing_remote_project_ids.contains(&project.id) {
1438 None
1439 } else {
1440 Some((
1441 UserId::from_proto(participant.user.id),
1442 project.worktree_root_names[0].clone(),
1443 ))
1444 }
1445 })
1446 })
1447 .collect::<Vec<_>>()
1448 });
1449 if !new_remote_projects.is_empty() {
1450 let (host_id, first_root_name) =
1451 new_remote_projects.choose(&mut self.rng).unwrap().clone();
1452 break ClientOperation::OpenRemoteProject {
1453 host_id,
1454 first_root_name,
1455 };
1456 }
1457 }
1458 // Open a local project
1459 else {
1460 let first_root_name = self.next_root_dir_name(user_id);
1461 break ClientOperation::OpenLocalProject { first_root_name };
1462 }
1463 }
1464
1465 // Close a remote project
1466 71..=80 => {
1467 if !client.remote_projects().is_empty() {
1468 let project = client
1469 .remote_projects()
1470 .choose(&mut self.rng)
1471 .unwrap()
1472 .clone();
1473 let first_root_name = root_name_for_project(&project, cx);
1474 break ClientOperation::CloseRemoteProject {
1475 project_root_name: first_root_name,
1476 };
1477 }
1478 }
1479
1480 // Mutate project worktrees
1481 81.. => match self.rng.gen_range(0..100_u32) {
1482 // Add a worktree to a local project
1483 0..=50 => {
1484 let Some(project) = client
1485 .local_projects()
1486 .choose(&mut self.rng)
1487 .cloned() else { continue };
1488 let project_root_name = root_name_for_project(&project, cx);
1489 let mut paths = client.fs.paths();
1490 paths.remove(0);
1491 let new_root_path = if paths.is_empty() || self.rng.gen() {
1492 Path::new("/").join(&self.next_root_dir_name(user_id))
1493 } else {
1494 paths.choose(&mut self.rng).unwrap().clone()
1495 };
1496 break ClientOperation::AddWorktreeToProject {
1497 project_root_name,
1498 new_root_path,
1499 };
1500 }
1501
1502 // Add an entry to a worktree
1503 _ => {
1504 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1505 let project_root_name = root_name_for_project(&project, cx);
1506 let is_local = project.read_with(cx, |project, _| project.is_local());
1507 let worktree = project.read_with(cx, |project, cx| {
1508 project
1509 .worktrees(cx)
1510 .filter(|worktree| {
1511 let worktree = worktree.read(cx);
1512 worktree.is_visible()
1513 && worktree.entries(false).any(|e| e.is_file())
1514 && worktree.root_entry().map_or(false, |e| e.is_dir())
1515 })
1516 .choose(&mut self.rng)
1517 });
1518 let Some(worktree) = worktree else { continue };
1519 let is_dir = self.rng.gen::<bool>();
1520 let mut full_path =
1521 worktree.read_with(cx, |w, _| PathBuf::from(w.root_name()));
1522 full_path.push(gen_file_name(&mut self.rng));
1523 if !is_dir {
1524 full_path.set_extension("rs");
1525 }
1526 break ClientOperation::CreateWorktreeEntry {
1527 project_root_name,
1528 is_local,
1529 full_path,
1530 is_dir,
1531 };
1532 }
1533 },
1534 },
1535
1536 // Query and mutate buffers
1537 60..=90 => {
1538 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1539 let project_root_name = root_name_for_project(&project, cx);
1540 let is_local = project.read_with(cx, |project, _| project.is_local());
1541
1542 match self.rng.gen_range(0..100_u32) {
1543 // Manipulate an existing buffer
1544 0..=70 => {
1545 let Some(buffer) = client
1546 .buffers_for_project(&project)
1547 .iter()
1548 .choose(&mut self.rng)
1549 .cloned() else { continue };
1550
1551 let full_path = buffer
1552 .read_with(cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
1553
1554 match self.rng.gen_range(0..100_u32) {
1555 // Close the buffer
1556 0..=15 => {
1557 break ClientOperation::CloseBuffer {
1558 project_root_name,
1559 is_local,
1560 full_path,
1561 };
1562 }
1563 // Save the buffer
1564 16..=29 if buffer.read_with(cx, |b, _| b.is_dirty()) => {
1565 let detach = self.rng.gen_bool(0.3);
1566 break ClientOperation::SaveBuffer {
1567 project_root_name,
1568 is_local,
1569 full_path,
1570 detach,
1571 };
1572 }
1573 // Edit the buffer
1574 30..=69 => {
1575 let edits = buffer.read_with(cx, |buffer, _| {
1576 buffer.get_random_edits(&mut self.rng, 3)
1577 });
1578 break ClientOperation::EditBuffer {
1579 project_root_name,
1580 is_local,
1581 full_path,
1582 edits,
1583 };
1584 }
1585 // Make an LSP request
1586 _ => {
1587 let offset = buffer.read_with(cx, |buffer, _| {
1588 buffer.clip_offset(
1589 self.rng.gen_range(0..=buffer.len()),
1590 language::Bias::Left,
1591 )
1592 });
1593 let detach = self.rng.gen();
1594 break ClientOperation::RequestLspDataInBuffer {
1595 project_root_name,
1596 full_path,
1597 offset,
1598 is_local,
1599 kind: match self.rng.gen_range(0..5_u32) {
1600 0 => LspRequestKind::Rename,
1601 1 => LspRequestKind::Highlights,
1602 2 => LspRequestKind::Definition,
1603 3 => LspRequestKind::CodeAction,
1604 4.. => LspRequestKind::Completion,
1605 },
1606 detach,
1607 };
1608 }
1609 }
1610 }
1611
1612 71..=80 => {
1613 let query = self.rng.gen_range('a'..='z').to_string();
1614 let detach = self.rng.gen_bool(0.3);
1615 break ClientOperation::SearchProject {
1616 project_root_name,
1617 is_local,
1618 query,
1619 detach,
1620 };
1621 }
1622
1623 // Open a buffer
1624 81.. => {
1625 let worktree = project.read_with(cx, |project, cx| {
1626 project
1627 .worktrees(cx)
1628 .filter(|worktree| {
1629 let worktree = worktree.read(cx);
1630 worktree.is_visible()
1631 && worktree.entries(false).any(|e| e.is_file())
1632 })
1633 .choose(&mut self.rng)
1634 });
1635 let Some(worktree) = worktree else { continue };
1636 let full_path = worktree.read_with(cx, |worktree, _| {
1637 let entry = worktree
1638 .entries(false)
1639 .filter(|e| e.is_file())
1640 .choose(&mut self.rng)
1641 .unwrap();
1642 if entry.path.as_ref() == Path::new("") {
1643 Path::new(worktree.root_name()).into()
1644 } else {
1645 Path::new(worktree.root_name()).join(&entry.path)
1646 }
1647 });
1648 break ClientOperation::OpenBuffer {
1649 project_root_name,
1650 is_local,
1651 full_path,
1652 };
1653 }
1654 }
1655 }
1656
1657 // Update a git index
1658 91..=95 => {
1659 let repo_path = client
1660 .fs
1661 .directories()
1662 .choose(&mut self.rng)
1663 .unwrap()
1664 .clone();
1665
1666 let mut file_paths = client
1667 .fs
1668 .files()
1669 .into_iter()
1670 .filter(|path| path.starts_with(&repo_path))
1671 .collect::<Vec<_>>();
1672 let count = self.rng.gen_range(0..=file_paths.len());
1673 file_paths.shuffle(&mut self.rng);
1674 file_paths.truncate(count);
1675
1676 let mut contents = Vec::new();
1677 for abs_child_file_path in &file_paths {
1678 let child_file_path = abs_child_file_path
1679 .strip_prefix(&repo_path)
1680 .unwrap()
1681 .to_path_buf();
1682 let new_base = Alphanumeric.sample_string(&mut self.rng, 16);
1683 contents.push((child_file_path, new_base));
1684 }
1685
1686 break ClientOperation::WriteGitIndex {
1687 repo_path,
1688 contents,
1689 };
1690 }
1691
1692 // Create or update a file or directory
1693 96.. => {
1694 let is_dir = self.rng.gen::<bool>();
1695 let content;
1696 let mut path;
1697 let dir_paths = client.fs.directories();
1698
1699 if is_dir {
1700 content = String::new();
1701 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1702 path.push(gen_file_name(&mut self.rng));
1703 } else {
1704 content = Alphanumeric.sample_string(&mut self.rng, 16);
1705
1706 // Create a new file or overwrite an existing file
1707 let file_paths = client.fs.files();
1708 if file_paths.is_empty() || self.rng.gen_bool(0.5) {
1709 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1710 path.push(gen_file_name(&mut self.rng));
1711 path.set_extension("rs");
1712 } else {
1713 path = file_paths.choose(&mut self.rng).unwrap().clone()
1714 };
1715 }
1716 break ClientOperation::WriteFsEntry {
1717 path,
1718 is_dir,
1719 content,
1720 };
1721 }
1722 }
1723 })
1724 }
1725
1726 fn next_root_dir_name(&mut self, user_id: UserId) -> String {
1727 let user_ix = self
1728 .users
1729 .iter()
1730 .position(|user| user.user_id == user_id)
1731 .unwrap();
1732 let root_id = util::post_inc(&mut self.users[user_ix].next_root_id);
1733 format!("dir-{user_id}-{root_id}")
1734 }
1735
1736 fn user(&mut self, user_id: UserId) -> &mut UserTestPlan {
1737 let ix = self
1738 .users
1739 .iter()
1740 .position(|user| user.user_id == user_id)
1741 .unwrap();
1742 &mut self.users[ix]
1743 }
1744}
1745
1746async fn simulate_client(
1747 client: Rc<TestClient>,
1748 mut operation_rx: futures::channel::mpsc::UnboundedReceiver<usize>,
1749 plan: Arc<Mutex<TestPlan>>,
1750 mut cx: TestAppContext,
1751) {
1752 // Setup language server
1753 let mut language = Language::new(
1754 LanguageConfig {
1755 name: "Rust".into(),
1756 path_suffixes: vec!["rs".to_string()],
1757 ..Default::default()
1758 },
1759 None,
1760 );
1761 let _fake_language_servers = language
1762 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
1763 name: "the-fake-language-server",
1764 capabilities: lsp::LanguageServer::full_capabilities(),
1765 initializer: Some(Box::new({
1766 let fs = client.fs.clone();
1767 move |fake_server: &mut FakeLanguageServer| {
1768 fake_server.handle_request::<lsp::request::Completion, _, _>(
1769 |_, _| async move {
1770 Ok(Some(lsp::CompletionResponse::Array(vec![
1771 lsp::CompletionItem {
1772 text_edit: Some(lsp::CompletionTextEdit::Edit(lsp::TextEdit {
1773 range: lsp::Range::new(
1774 lsp::Position::new(0, 0),
1775 lsp::Position::new(0, 0),
1776 ),
1777 new_text: "the-new-text".to_string(),
1778 })),
1779 ..Default::default()
1780 },
1781 ])))
1782 },
1783 );
1784
1785 fake_server.handle_request::<lsp::request::CodeActionRequest, _, _>(
1786 |_, _| async move {
1787 Ok(Some(vec![lsp::CodeActionOrCommand::CodeAction(
1788 lsp::CodeAction {
1789 title: "the-code-action".to_string(),
1790 ..Default::default()
1791 },
1792 )]))
1793 },
1794 );
1795
1796 fake_server.handle_request::<lsp::request::PrepareRenameRequest, _, _>(
1797 |params, _| async move {
1798 Ok(Some(lsp::PrepareRenameResponse::Range(lsp::Range::new(
1799 params.position,
1800 params.position,
1801 ))))
1802 },
1803 );
1804
1805 fake_server.handle_request::<lsp::request::GotoDefinition, _, _>({
1806 let fs = fs.clone();
1807 move |_, cx| {
1808 let background = cx.background();
1809 let mut rng = background.rng();
1810 let count = rng.gen_range::<usize, _>(1..3);
1811 let files = fs.files();
1812 let files = (0..count)
1813 .map(|_| files.choose(&mut *rng).unwrap().clone())
1814 .collect::<Vec<_>>();
1815 async move {
1816 log::info!("LSP: Returning definitions in files {:?}", &files);
1817 Ok(Some(lsp::GotoDefinitionResponse::Array(
1818 files
1819 .into_iter()
1820 .map(|file| lsp::Location {
1821 uri: lsp::Url::from_file_path(file).unwrap(),
1822 range: Default::default(),
1823 })
1824 .collect(),
1825 )))
1826 }
1827 }
1828 });
1829
1830 fake_server.handle_request::<lsp::request::DocumentHighlightRequest, _, _>(
1831 move |_, cx| {
1832 let mut highlights = Vec::new();
1833 let background = cx.background();
1834 let mut rng = background.rng();
1835
1836 let highlight_count = rng.gen_range(1..=5);
1837 for _ in 0..highlight_count {
1838 let start_row = rng.gen_range(0..100);
1839 let start_column = rng.gen_range(0..100);
1840 let end_row = rng.gen_range(0..100);
1841 let end_column = rng.gen_range(0..100);
1842 let start = PointUtf16::new(start_row, start_column);
1843 let end = PointUtf16::new(end_row, end_column);
1844 let range = if start > end { end..start } else { start..end };
1845 highlights.push(lsp::DocumentHighlight {
1846 range: range_to_lsp(range.clone()),
1847 kind: Some(lsp::DocumentHighlightKind::READ),
1848 });
1849 }
1850 highlights.sort_unstable_by_key(|highlight| {
1851 (highlight.range.start, highlight.range.end)
1852 });
1853 async move { Ok(Some(highlights)) }
1854 },
1855 );
1856 }
1857 })),
1858 ..Default::default()
1859 }))
1860 .await;
1861 client.language_registry.add(Arc::new(language));
1862
1863 while let Some(batch_id) = operation_rx.next().await {
1864 let Some((operation, applied)) = plan.lock().next_client_operation(&client, batch_id, &cx) else { break };
1865 applied.store(true, SeqCst);
1866 match apply_client_operation(&client, operation, &mut cx).await {
1867 Ok(()) => {}
1868 Err(TestError::Inapplicable) => {
1869 applied.store(false, SeqCst);
1870 log::info!("skipped operation");
1871 }
1872 Err(TestError::Other(error)) => {
1873 log::error!("{} error: {}", client.username, error);
1874 }
1875 }
1876 cx.background().simulate_random_delay().await;
1877 }
1878 log::info!("{}: done", client.username);
1879}
1880
1881fn buffer_for_full_path(
1882 client: &TestClient,
1883 project: &ModelHandle<Project>,
1884 full_path: &PathBuf,
1885 cx: &TestAppContext,
1886) -> Option<ModelHandle<language::Buffer>> {
1887 client
1888 .buffers_for_project(project)
1889 .iter()
1890 .find(|buffer| {
1891 buffer.read_with(cx, |buffer, cx| {
1892 buffer.file().unwrap().full_path(cx) == *full_path
1893 })
1894 })
1895 .cloned()
1896}
1897
1898fn project_for_root_name(
1899 client: &TestClient,
1900 root_name: &str,
1901 cx: &TestAppContext,
1902) -> Option<ModelHandle<Project>> {
1903 if let Some(ix) = project_ix_for_root_name(&*client.local_projects(), root_name, cx) {
1904 return Some(client.local_projects()[ix].clone());
1905 }
1906 if let Some(ix) = project_ix_for_root_name(&*client.remote_projects(), root_name, cx) {
1907 return Some(client.remote_projects()[ix].clone());
1908 }
1909 None
1910}
1911
1912fn project_ix_for_root_name(
1913 projects: &[ModelHandle<Project>],
1914 root_name: &str,
1915 cx: &TestAppContext,
1916) -> Option<usize> {
1917 projects.iter().position(|project| {
1918 project.read_with(cx, |project, cx| {
1919 let worktree = project.visible_worktrees(cx).next().unwrap();
1920 worktree.read(cx).root_name() == root_name
1921 })
1922 })
1923}
1924
1925fn root_name_for_project(project: &ModelHandle<Project>, cx: &TestAppContext) -> String {
1926 project.read_with(cx, |project, cx| {
1927 project
1928 .visible_worktrees(cx)
1929 .next()
1930 .unwrap()
1931 .read(cx)
1932 .root_name()
1933 .to_string()
1934 })
1935}
1936
1937fn project_path_for_full_path(
1938 project: &ModelHandle<Project>,
1939 full_path: &Path,
1940 cx: &TestAppContext,
1941) -> Option<ProjectPath> {
1942 let mut components = full_path.components();
1943 let root_name = components.next().unwrap().as_os_str().to_str().unwrap();
1944 let path = components.as_path().into();
1945 let worktree_id = project.read_with(cx, |project, cx| {
1946 project.worktrees(cx).find_map(|worktree| {
1947 let worktree = worktree.read(cx);
1948 if worktree.root_name() == root_name {
1949 Some(worktree.id())
1950 } else {
1951 None
1952 }
1953 })
1954 })?;
1955 Some(ProjectPath { worktree_id, path })
1956}
1957
1958async fn ensure_project_shared(
1959 project: &ModelHandle<Project>,
1960 client: &TestClient,
1961 cx: &mut TestAppContext,
1962) {
1963 let first_root_name = root_name_for_project(project, cx);
1964 let active_call = cx.read(ActiveCall::global);
1965 if active_call.read_with(cx, |call, _| call.room().is_some())
1966 && project.read_with(cx, |project, _| project.is_local() && !project.is_shared())
1967 {
1968 match active_call
1969 .update(cx, |call, cx| call.share_project(project.clone(), cx))
1970 .await
1971 {
1972 Ok(project_id) => {
1973 log::info!(
1974 "{}: shared project {} with id {}",
1975 client.username,
1976 first_root_name,
1977 project_id
1978 );
1979 }
1980 Err(error) => {
1981 log::error!(
1982 "{}: error sharing project {}: {:?}",
1983 client.username,
1984 first_root_name,
1985 error
1986 );
1987 }
1988 }
1989 }
1990}
1991
1992fn choose_random_project(client: &TestClient, rng: &mut StdRng) -> Option<ModelHandle<Project>> {
1993 client
1994 .local_projects()
1995 .iter()
1996 .chain(client.remote_projects().iter())
1997 .choose(rng)
1998 .cloned()
1999}
2000
2001fn gen_file_name(rng: &mut StdRng) -> String {
2002 let mut name = String::new();
2003 for _ in 0..10 {
2004 let letter = rng.gen_range('a'..='z');
2005 name.push(letter);
2006 }
2007 name
2008}
2009
2010fn path_env_var(name: &str) -> Option<PathBuf> {
2011 let value = env::var(name).ok()?;
2012 let mut path = PathBuf::from(value);
2013 if path.is_relative() {
2014 let mut abs_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
2015 abs_path.pop();
2016 abs_path.pop();
2017 abs_path.push(path);
2018 path = abs_path
2019 }
2020 Some(path)
2021}