1use super::{HoverTarget, HoveredWord, TerminalView};
2use anyhow::{Context as _, Result};
3use editor::Editor;
4use gpui::{App, AppContext, Context, Task, WeakEntity, Window};
5use itertools::Itertools;
6use project::{Entry, Metadata};
7use std::path::PathBuf;
8use terminal::PathLikeTarget;
9use util::{
10 ResultExt, debug_panic,
11 paths::{PathStyle, PathWithPosition},
12 rel_path::RelPath,
13};
14use workspace::{OpenOptions, OpenVisible, Workspace};
15
16/// The way we found the open target. This is important to have for test assertions.
17/// For example, remote projects never look in the file system.
18#[cfg(test)]
19#[derive(Debug, Clone, Copy, Eq, PartialEq)]
20enum OpenTargetFoundBy {
21 WorktreeExact,
22 WorktreeScan,
23 FileSystemBackground,
24}
25
26#[cfg(test)]
27#[derive(Debug, Clone, Copy, Eq, PartialEq)]
28enum BackgroundFsChecks {
29 Enabled,
30 Disabled,
31}
32
33#[derive(Debug, Clone)]
34enum OpenTarget {
35 Worktree(PathWithPosition, Entry, #[cfg(test)] OpenTargetFoundBy),
36 File(PathWithPosition, Metadata),
37}
38
39impl OpenTarget {
40 fn is_file(&self) -> bool {
41 match self {
42 OpenTarget::Worktree(_, entry, ..) => entry.is_file(),
43 OpenTarget::File(_, metadata) => !metadata.is_dir,
44 }
45 }
46
47 fn is_dir(&self) -> bool {
48 match self {
49 OpenTarget::Worktree(_, entry, ..) => entry.is_dir(),
50 OpenTarget::File(_, metadata) => metadata.is_dir,
51 }
52 }
53
54 fn path(&self) -> &PathWithPosition {
55 match self {
56 OpenTarget::Worktree(path, ..) => path,
57 OpenTarget::File(path, _) => path,
58 }
59 }
60
61 #[cfg(test)]
62 fn found_by(&self) -> OpenTargetFoundBy {
63 match self {
64 OpenTarget::Worktree(.., found_by) => *found_by,
65 OpenTarget::File(..) => OpenTargetFoundBy::FileSystemBackground,
66 }
67 }
68}
69
70pub(super) fn hover_path_like_target(
71 workspace: &WeakEntity<Workspace>,
72 hovered_word: HoveredWord,
73 path_like_target: &PathLikeTarget,
74 cx: &mut Context<TerminalView>,
75) -> Task<()> {
76 #[cfg(not(test))]
77 {
78 possible_hover_target(workspace, hovered_word, path_like_target, cx)
79 }
80 #[cfg(test)]
81 {
82 possible_hover_target(
83 workspace,
84 hovered_word,
85 path_like_target,
86 cx,
87 BackgroundFsChecks::Enabled,
88 )
89 }
90}
91
92fn possible_hover_target(
93 workspace: &WeakEntity<Workspace>,
94 hovered_word: HoveredWord,
95 path_like_target: &PathLikeTarget,
96 cx: &mut Context<TerminalView>,
97 #[cfg(test)] background_fs_checks: BackgroundFsChecks,
98) -> Task<()> {
99 let file_to_open_task = possible_open_target(
100 workspace,
101 path_like_target,
102 cx,
103 #[cfg(test)]
104 background_fs_checks,
105 );
106 cx.spawn(async move |terminal_view, cx| {
107 let file_to_open = file_to_open_task.await;
108 terminal_view
109 .update(cx, |terminal_view, _| match file_to_open {
110 Some(OpenTarget::File(path, _) | OpenTarget::Worktree(path, ..)) => {
111 terminal_view.hover = Some(HoverTarget {
112 tooltip: path.to_string(|path| path.to_string_lossy().into_owned()),
113 hovered_word,
114 });
115 }
116 None => {
117 terminal_view.hover = None;
118 }
119 })
120 .ok();
121 })
122}
123
124fn possible_open_target(
125 workspace: &WeakEntity<Workspace>,
126 path_like_target: &PathLikeTarget,
127 cx: &App,
128 #[cfg(test)] background_fs_checks: BackgroundFsChecks,
129) -> Task<Option<OpenTarget>> {
130 let Some(workspace) = workspace.upgrade() else {
131 return Task::ready(None);
132 };
133 // We have to check for both paths, as on Unix, certain paths with positions are valid file paths too.
134 // We can be on FS remote part, without real FS, so cannot canonicalize or check for existence the path right away.
135 let mut potential_paths = Vec::new();
136 let cwd = path_like_target.terminal_dir.as_ref();
137 let maybe_path = &path_like_target.maybe_path;
138 let original_path = PathWithPosition::from_path(PathBuf::from(maybe_path));
139 let path_with_position = PathWithPosition::parse_str(maybe_path);
140 let worktree_candidates = workspace
141 .read(cx)
142 .worktrees(cx)
143 .sorted_by_key(|worktree| {
144 let worktree_root = worktree.read(cx).abs_path();
145 match cwd.and_then(|cwd| worktree_root.strip_prefix(cwd).ok()) {
146 Some(cwd_child) => cwd_child.components().count(),
147 None => usize::MAX,
148 }
149 })
150 .collect::<Vec<_>>();
151 // Since we do not check paths via FS and joining, we need to strip off potential `./`, `a/`, `b/` prefixes out of it.
152 const GIT_DIFF_PATH_PREFIXES: &[&str] = &["a", "b"];
153 for prefix_str in GIT_DIFF_PATH_PREFIXES.iter().chain(std::iter::once(&".")) {
154 if let Some(stripped) = original_path.path.strip_prefix(prefix_str).ok() {
155 potential_paths.push(PathWithPosition {
156 path: stripped.to_owned(),
157 row: original_path.row,
158 column: original_path.column,
159 });
160 }
161 if let Some(stripped) = path_with_position.path.strip_prefix(prefix_str).ok() {
162 potential_paths.push(PathWithPosition {
163 path: stripped.to_owned(),
164 row: path_with_position.row,
165 column: path_with_position.column,
166 });
167 }
168 }
169
170 let insert_both_paths = original_path != path_with_position;
171 potential_paths.insert(0, original_path);
172 if insert_both_paths {
173 potential_paths.insert(1, path_with_position);
174 }
175
176 // If we won't find paths "easily", we can traverse the entire worktree to look what ends with the potential path suffix.
177 // That will be slow, though, so do the fast checks first.
178 let mut worktree_paths_to_check = Vec::new();
179 let mut is_cwd_in_worktree = false;
180 let mut open_target = None;
181 'worktree_loop: for worktree in &worktree_candidates {
182 let worktree_root = worktree.read(cx).abs_path();
183 let mut paths_to_check = Vec::with_capacity(potential_paths.len());
184 let relative_cwd = cwd
185 .and_then(|cwd| cwd.strip_prefix(&worktree_root).ok())
186 .and_then(|cwd| RelPath::new(cwd, PathStyle::local()).ok())
187 .and_then(|cwd_stripped| {
188 (cwd_stripped.as_ref() != RelPath::empty()).then(|| {
189 is_cwd_in_worktree = true;
190 cwd_stripped
191 })
192 });
193
194 for path_with_position in &potential_paths {
195 let path_to_check = if worktree_root.ends_with(&path_with_position.path) {
196 let root_path_with_position = PathWithPosition {
197 path: worktree_root.to_path_buf(),
198 row: path_with_position.row,
199 column: path_with_position.column,
200 };
201 match worktree.read(cx).root_entry() {
202 Some(root_entry) => {
203 open_target = Some(OpenTarget::Worktree(
204 root_path_with_position,
205 root_entry.clone(),
206 #[cfg(test)]
207 OpenTargetFoundBy::WorktreeExact,
208 ));
209 break 'worktree_loop;
210 }
211 None => root_path_with_position,
212 }
213 } else {
214 PathWithPosition {
215 path: path_with_position
216 .path
217 .strip_prefix(&worktree_root)
218 .unwrap_or(&path_with_position.path)
219 .to_owned(),
220 row: path_with_position.row,
221 column: path_with_position.column,
222 }
223 };
224
225 if let Ok(relative_path_to_check) =
226 RelPath::new(&path_to_check.path, PathStyle::local())
227 && !worktree.read(cx).is_single_file()
228 && let Some(entry) = relative_cwd
229 .clone()
230 .and_then(|relative_cwd| {
231 worktree
232 .read(cx)
233 .entry_for_path(&relative_cwd.join(&relative_path_to_check))
234 })
235 .or_else(|| worktree.read(cx).entry_for_path(&relative_path_to_check))
236 {
237 open_target = Some(OpenTarget::Worktree(
238 PathWithPosition {
239 path: worktree.read(cx).absolutize(&entry.path),
240 row: path_to_check.row,
241 column: path_to_check.column,
242 },
243 entry.clone(),
244 #[cfg(test)]
245 OpenTargetFoundBy::WorktreeExact,
246 ));
247 break 'worktree_loop;
248 }
249
250 paths_to_check.push(path_to_check);
251 }
252
253 if !paths_to_check.is_empty() {
254 worktree_paths_to_check.push((worktree.clone(), paths_to_check));
255 }
256 }
257
258 #[cfg(not(test))]
259 let enable_background_fs_checks = workspace.read(cx).project().read(cx).is_local();
260 #[cfg(test)]
261 let enable_background_fs_checks = background_fs_checks == BackgroundFsChecks::Enabled;
262
263 if open_target.is_some() {
264 // We we want to prefer open targets found via background fs checks over worktree matches,
265 // however we can return early if either:
266 // - This is a remote project, or
267 // - If the terminal working directory is inside of at least one worktree
268 if !enable_background_fs_checks || is_cwd_in_worktree {
269 return Task::ready(open_target);
270 }
271 }
272
273 // Before entire worktree traversal(s), make an attempt to do FS checks if available.
274 let fs_paths_to_check =
275 if enable_background_fs_checks {
276 let fs_cwd_paths_to_check = cwd
277 .iter()
278 .flat_map(|cwd| {
279 let mut paths_to_check = Vec::new();
280 for path_to_check in &potential_paths {
281 let maybe_path = &path_to_check.path;
282 if path_to_check.path.is_relative() {
283 paths_to_check.push(PathWithPosition {
284 path: cwd.join(&maybe_path),
285 row: path_to_check.row,
286 column: path_to_check.column,
287 });
288 }
289 }
290 paths_to_check
291 })
292 .collect::<Vec<_>>();
293 fs_cwd_paths_to_check
294 .into_iter()
295 .chain(
296 potential_paths
297 .into_iter()
298 .flat_map(|path_to_check| {
299 let mut paths_to_check = Vec::new();
300 let maybe_path = &path_to_check.path;
301 if maybe_path.starts_with("~") {
302 if let Some(home_path) = maybe_path.strip_prefix("~").ok().and_then(
303 |stripped_maybe_path| {
304 Some(dirs::home_dir()?.join(stripped_maybe_path))
305 },
306 ) {
307 paths_to_check.push(PathWithPosition {
308 path: home_path,
309 row: path_to_check.row,
310 column: path_to_check.column,
311 });
312 }
313 } else {
314 paths_to_check.push(PathWithPosition {
315 path: maybe_path.clone(),
316 row: path_to_check.row,
317 column: path_to_check.column,
318 });
319 if maybe_path.is_relative() {
320 for worktree in &worktree_candidates {
321 if !worktree.read(cx).is_single_file() {
322 paths_to_check.push(PathWithPosition {
323 path: worktree.read(cx).abs_path().join(maybe_path),
324 row: path_to_check.row,
325 column: path_to_check.column,
326 });
327 }
328 }
329 }
330 }
331 paths_to_check
332 })
333 .collect::<Vec<_>>(),
334 )
335 .collect()
336 } else {
337 Vec::new()
338 };
339
340 let fs = workspace.read(cx).project().read(cx).fs().clone();
341 let background_fs_checks_task = cx.background_spawn(async move {
342 for mut path_to_check in fs_paths_to_check {
343 if let Some(fs_path_to_check) = fs.canonicalize(&path_to_check.path).await.ok()
344 && let Some(metadata) = fs.metadata(&fs_path_to_check).await.ok().flatten()
345 {
346 if open_target
347 .as_ref()
348 .map(|open_target| open_target.path().path != fs_path_to_check)
349 .unwrap_or(true)
350 {
351 path_to_check.path = fs_path_to_check;
352 return Some(OpenTarget::File(path_to_check, metadata));
353 }
354
355 break;
356 }
357 }
358
359 open_target
360 });
361
362 cx.spawn(async move |cx| {
363 background_fs_checks_task.await.or_else(|| {
364 for (worktree, worktree_paths_to_check) in worktree_paths_to_check {
365 if let Some(found_entry) =
366 worktree.update(cx, |worktree, _| -> Option<OpenTarget> {
367 let traversal =
368 worktree.traverse_from_path(true, true, false, RelPath::empty());
369 for entry in traversal {
370 if let Some(path_in_worktree) =
371 worktree_paths_to_check.iter().find(|path_to_check| {
372 RelPath::new(&path_to_check.path, PathStyle::local())
373 .is_ok_and(|path| entry.path.ends_with(&path))
374 })
375 {
376 return Some(OpenTarget::Worktree(
377 PathWithPosition {
378 path: worktree.absolutize(&entry.path),
379 row: path_in_worktree.row,
380 column: path_in_worktree.column,
381 },
382 entry.clone(),
383 #[cfg(test)]
384 OpenTargetFoundBy::WorktreeScan,
385 ));
386 }
387 }
388 None
389 })
390 {
391 return Some(found_entry);
392 }
393 }
394 None
395 })
396 })
397}
398
399pub(super) fn open_path_like_target(
400 workspace: &WeakEntity<Workspace>,
401 terminal_view: &mut TerminalView,
402 path_like_target: &PathLikeTarget,
403 window: &mut Window,
404 cx: &mut Context<TerminalView>,
405) {
406 #[cfg(not(test))]
407 {
408 possibly_open_target(workspace, terminal_view, path_like_target, window, cx)
409 .detach_and_log_err(cx)
410 }
411 #[cfg(test)]
412 {
413 possibly_open_target(
414 workspace,
415 terminal_view,
416 path_like_target,
417 window,
418 cx,
419 BackgroundFsChecks::Enabled,
420 )
421 .detach_and_log_err(cx)
422 }
423}
424
425fn possibly_open_target(
426 workspace: &WeakEntity<Workspace>,
427 terminal_view: &mut TerminalView,
428 path_like_target: &PathLikeTarget,
429 window: &mut Window,
430 cx: &mut Context<TerminalView>,
431 #[cfg(test)] background_fs_checks: BackgroundFsChecks,
432) -> Task<Result<Option<OpenTarget>>> {
433 if terminal_view.hover.is_none() {
434 return Task::ready(Ok(None));
435 }
436 let workspace = workspace.clone();
437 let path_like_target = path_like_target.clone();
438 cx.spawn_in(window, async move |terminal_view, cx| {
439 let Some(open_target) = terminal_view
440 .update(cx, |_, cx| {
441 possible_open_target(
442 &workspace,
443 &path_like_target,
444 cx,
445 #[cfg(test)]
446 background_fs_checks,
447 )
448 })?
449 .await
450 else {
451 return Ok(None);
452 };
453
454 let path_to_open = open_target.path();
455 let opened_items = workspace
456 .update_in(cx, |workspace, window, cx| {
457 workspace.open_paths(
458 vec![path_to_open.path.clone()],
459 OpenOptions {
460 visible: Some(OpenVisible::OnlyDirectories),
461 ..Default::default()
462 },
463 None,
464 window,
465 cx,
466 )
467 })
468 .context("workspace update")?
469 .await;
470 if opened_items.len() != 1 {
471 debug_panic!(
472 "Received {} items for one path {path_to_open:?}",
473 opened_items.len(),
474 );
475 }
476
477 if let Some(opened_item) = opened_items.first() {
478 if open_target.is_file() {
479 if let Some(Ok(opened_item)) = opened_item {
480 if let Some(row) = path_to_open.row {
481 let col = path_to_open.column.unwrap_or(0);
482 if let Some(active_editor) = opened_item.downcast::<Editor>() {
483 active_editor
484 .downgrade()
485 .update_in(cx, |editor, window, cx| {
486 editor.go_to_singleton_buffer_point(
487 language::Point::new(
488 row.saturating_sub(1),
489 col.saturating_sub(1),
490 ),
491 window,
492 cx,
493 )
494 })
495 .log_err();
496 }
497 }
498 return Ok(Some(open_target));
499 }
500 } else if open_target.is_dir() {
501 workspace.update(cx, |workspace, cx| {
502 workspace.project().update(cx, |_, cx| {
503 cx.emit(project::Event::ActivateProjectPanel);
504 })
505 })?;
506 return Ok(Some(open_target));
507 }
508 }
509 Ok(None)
510 })
511}
512
513#[cfg(test)]
514mod tests {
515 use super::*;
516 use gpui::TestAppContext;
517 use project::Project;
518 use serde_json::json;
519 use std::path::{Path, PathBuf};
520 use terminal::{
521 HoveredWord, TerminalBuilder,
522 alacritty_terminal::index::Point as AlacPoint,
523 terminal_settings::{AlternateScroll, CursorShape},
524 };
525 use util::path;
526 use workspace::AppState;
527
528 async fn init_test(
529 app_cx: &mut TestAppContext,
530 trees: impl IntoIterator<Item = (&str, serde_json::Value)>,
531 worktree_roots: impl IntoIterator<Item = &str>,
532 ) -> impl AsyncFnMut(
533 HoveredWord,
534 PathLikeTarget,
535 BackgroundFsChecks,
536 ) -> (Option<HoverTarget>, Option<OpenTarget>) {
537 let fs = app_cx.update(AppState::test).fs.as_fake().clone();
538
539 app_cx.update(|cx| {
540 theme::init(theme::LoadThemes::JustBase, cx);
541 editor::init(cx);
542 });
543
544 for (path, tree) in trees {
545 fs.insert_tree(path, tree).await;
546 }
547
548 let project: gpui::Entity<Project> = Project::test(
549 fs.clone(),
550 worktree_roots.into_iter().map(Path::new),
551 app_cx,
552 )
553 .await;
554
555 let (workspace, _cx) =
556 app_cx.add_window_view(|window, cx| Workspace::test_new(project.clone(), window, cx));
557
558 let terminal = app_cx.new(|cx| {
559 TerminalBuilder::new_display_only(CursorShape::default(), AlternateScroll::On, None, 0)
560 .expect("Failed to create display-only terminal")
561 .subscribe(cx)
562 });
563
564 let workspace_a = workspace.clone();
565 let (terminal_view, cx) = app_cx.add_window_view(|window, cx| {
566 TerminalView::new(
567 terminal,
568 workspace_a.downgrade(),
569 None,
570 project.downgrade(),
571 window,
572 cx,
573 )
574 });
575
576 async move |hovered_word: HoveredWord,
577 path_like_target: PathLikeTarget,
578 background_fs_checks: BackgroundFsChecks|
579 -> (Option<HoverTarget>, Option<OpenTarget>) {
580 let workspace_a = workspace.clone();
581 terminal_view
582 .update(cx, |_, cx| {
583 possible_hover_target(
584 &workspace_a.downgrade(),
585 hovered_word,
586 &path_like_target,
587 cx,
588 background_fs_checks,
589 )
590 })
591 .await;
592
593 let hover_target =
594 terminal_view.read_with(cx, |terminal_view, _| terminal_view.hover.clone());
595
596 let open_target = terminal_view
597 .update_in(cx, |terminal_view, window, cx| {
598 possibly_open_target(
599 &workspace.downgrade(),
600 terminal_view,
601 &path_like_target,
602 window,
603 cx,
604 background_fs_checks,
605 )
606 })
607 .await
608 .expect("Failed to possibly open target");
609
610 (hover_target, open_target)
611 }
612 }
613
614 async fn test_path_like_simple(
615 test_path_like: &mut impl AsyncFnMut(
616 HoveredWord,
617 PathLikeTarget,
618 BackgroundFsChecks,
619 ) -> (Option<HoverTarget>, Option<OpenTarget>),
620 maybe_path: &str,
621 tooltip: &str,
622 terminal_dir: Option<PathBuf>,
623 background_fs_checks: BackgroundFsChecks,
624 mut open_target_found_by: OpenTargetFoundBy,
625 file: &str,
626 line: u32,
627 ) {
628 let (hover_target, open_target) = test_path_like(
629 HoveredWord {
630 word: maybe_path.to_string(),
631 word_match: AlacPoint::default()..=AlacPoint::default(),
632 id: 0,
633 },
634 PathLikeTarget {
635 maybe_path: maybe_path.to_string(),
636 terminal_dir,
637 },
638 background_fs_checks,
639 )
640 .await;
641
642 let Some(hover_target) = hover_target else {
643 assert!(
644 hover_target.is_some(),
645 "Hover target should not be `None` at {file}:{line}:"
646 );
647 return;
648 };
649
650 assert_eq!(
651 hover_target.tooltip, tooltip,
652 "Tooltip mismatch at {file}:{line}:"
653 );
654 assert_eq!(
655 hover_target.hovered_word.word, maybe_path,
656 "Hovered word mismatch at {file}:{line}:"
657 );
658
659 let Some(open_target) = open_target else {
660 assert!(
661 open_target.is_some(),
662 "Open target should not be `None` at {file}:{line}:"
663 );
664 return;
665 };
666
667 assert_eq!(
668 open_target.path().path,
669 Path::new(tooltip),
670 "Open target path mismatch at {file}:{line}:"
671 );
672
673 if background_fs_checks == BackgroundFsChecks::Disabled
674 && open_target_found_by == OpenTargetFoundBy::FileSystemBackground
675 {
676 open_target_found_by = OpenTargetFoundBy::WorktreeScan;
677 }
678
679 assert_eq!(
680 open_target.found_by(),
681 open_target_found_by,
682 "Open target found by mismatch at {file}:{line}:"
683 );
684 }
685
686 macro_rules! none_or_some_pathbuf {
687 (None) => {
688 None
689 };
690 ($cwd:literal) => {
691 Some($crate::PathBuf::from(path!($cwd)))
692 };
693 }
694
695 macro_rules! test_path_like {
696 (
697 $test_path_like:expr,
698 $maybe_path:literal,
699 $tooltip:literal,
700 $cwd:tt,
701 $found_by:expr
702 ) => {{
703 test_path_like!(
704 $test_path_like,
705 $maybe_path,
706 $tooltip,
707 $cwd,
708 BackgroundFsChecks::Enabled,
709 $found_by
710 );
711 test_path_like!(
712 $test_path_like,
713 $maybe_path,
714 $tooltip,
715 $cwd,
716 BackgroundFsChecks::Disabled,
717 $found_by
718 );
719 }};
720
721 (
722 $test_path_like:expr,
723 $maybe_path:literal,
724 $tooltip:literal,
725 $cwd:tt,
726 $background_fs_checks:path,
727 $found_by:expr
728 ) => {
729 test_path_like_simple(
730 &mut $test_path_like,
731 path!($maybe_path),
732 path!($tooltip),
733 none_or_some_pathbuf!($cwd),
734 $background_fs_checks,
735 $found_by,
736 std::file!(),
737 std::line!(),
738 )
739 .await
740 };
741 }
742
743 // Note the arms of `test`, `test_local`, and `test_remote` should be collapsed once macro
744 // metavariable expressions (#![feature(macro_metavar_expr)]) are stabilized.
745 // See https://github.com/rust-lang/rust/issues/83527
746 #[doc = "test_path_likes!(<cx>, <trees>, <worktrees>, { $(<tests>;)+ })"]
747 macro_rules! test_path_likes {
748 ($cx:expr, $trees:expr, $worktrees:expr, { $($tests:expr;)+ }) => { {
749 let mut test_path_like = init_test($cx, $trees, $worktrees).await;
750 #[doc ="test!(<hovered maybe_path>, <expected tooltip>, <terminal cwd> "]
751 #[doc ="\\[, found by \\])"]
752 #[allow(unused_macros)]
753 macro_rules! test {
754 ($maybe_path:literal, $tooltip:literal, $cwd:tt) => {
755 test_path_like!(
756 test_path_like,
757 $maybe_path,
758 $tooltip,
759 $cwd,
760 OpenTargetFoundBy::WorktreeExact
761 )
762 };
763 ($maybe_path:literal, $tooltip:literal, $cwd:tt, $found_by:ident) => {
764 test_path_like!(
765 test_path_like,
766 $maybe_path,
767 $tooltip,
768 $cwd,
769 OpenTargetFoundBy::$found_by
770 )
771 }
772 }
773 #[doc ="test_local!(<hovered maybe_path>, <expected tooltip>, <terminal cwd> "]
774 #[doc ="\\[, found by \\])"]
775 #[allow(unused_macros)]
776 macro_rules! test_local {
777 ($maybe_path:literal, $tooltip:literal, $cwd:tt) => {
778 test_path_like!(
779 test_path_like,
780 $maybe_path,
781 $tooltip,
782 $cwd,
783 BackgroundFsChecks::Enabled,
784 OpenTargetFoundBy::WorktreeExact
785 )
786 };
787 ($maybe_path:literal, $tooltip:literal, $cwd:tt, $found_by:ident) => {
788 test_path_like!(
789 test_path_like,
790 $maybe_path,
791 $tooltip,
792 $cwd,
793 BackgroundFsChecks::Enabled,
794 OpenTargetFoundBy::$found_by
795 )
796 }
797 }
798 #[doc ="test_remote!(<hovered maybe_path>, <expected tooltip>, <terminal cwd> "]
799 #[doc ="\\[, found by \\])"]
800 #[allow(unused_macros)]
801 macro_rules! test_remote {
802 ($maybe_path:literal, $tooltip:literal, $cwd:tt) => {
803 test_path_like!(
804 test_path_like,
805 $maybe_path,
806 $tooltip,
807 $cwd,
808 BackgroundFsChecks::Disabled,
809 OpenTargetFoundBy::WorktreeExact
810 )
811 };
812 ($maybe_path:literal, $tooltip:literal, $cwd:tt, $found_by:ident) => {
813 test_path_like!(
814 test_path_like,
815 $maybe_path,
816 $tooltip,
817 $cwd,
818 BackgroundFsChecks::Disabled,
819 OpenTargetFoundBy::$found_by
820 )
821 }
822 }
823 $($tests);+
824 } }
825 }
826
827 #[gpui::test]
828 async fn one_folder_worktree(cx: &mut TestAppContext) {
829 test_path_likes!(
830 cx,
831 vec![(
832 path!("/test"),
833 json!({
834 "lib.rs": "",
835 "test.rs": "",
836 }),
837 )],
838 vec![path!("/test")],
839 {
840 test!("lib.rs", "/test/lib.rs", None);
841 test!("/test/lib.rs", "/test/lib.rs", None);
842 test!("test.rs", "/test/test.rs", None);
843 test!("/test/test.rs", "/test/test.rs", None);
844 }
845 )
846 }
847
848 #[gpui::test]
849 async fn mixed_worktrees(cx: &mut TestAppContext) {
850 test_path_likes!(
851 cx,
852 vec![
853 (
854 path!("/"),
855 json!({
856 "file.txt": "",
857 }),
858 ),
859 (
860 path!("/test"),
861 json!({
862 "lib.rs": "",
863 "test.rs": "",
864 "file.txt": "",
865 }),
866 ),
867 ],
868 vec![path!("/file.txt"), path!("/test")],
869 {
870 test!("file.txt", "/file.txt", "/");
871 test!("/file.txt", "/file.txt", "/");
872
873 test!("lib.rs", "/test/lib.rs", "/test");
874 test!("test.rs", "/test/test.rs", "/test");
875 test!("file.txt", "/test/file.txt", "/test");
876
877 test!("/test/lib.rs", "/test/lib.rs", "/test");
878 test!("/test/test.rs", "/test/test.rs", "/test");
879 test!("/test/file.txt", "/test/file.txt", "/test");
880 }
881 )
882 }
883
884 #[gpui::test]
885 async fn worktree_file_preferred(cx: &mut TestAppContext) {
886 test_path_likes!(
887 cx,
888 vec![
889 (
890 path!("/"),
891 json!({
892 "file.txt": "",
893 }),
894 ),
895 (
896 path!("/test"),
897 json!({
898 "file.txt": "",
899 }),
900 ),
901 ],
902 vec![path!("/test")],
903 {
904 test!("file.txt", "/test/file.txt", "/test");
905 }
906 )
907 }
908
909 mod issues {
910 use super::*;
911
912 // https://github.com/zed-industries/zed/issues/28407
913 #[gpui::test]
914 async fn issue_28407_siblings(cx: &mut TestAppContext) {
915 test_path_likes!(
916 cx,
917 vec![(
918 path!("/dir1"),
919 json!({
920 "dir 2": {
921 "C.py": ""
922 },
923 "dir 3": {
924 "C.py": ""
925 },
926 }),
927 )],
928 vec![path!("/dir1")],
929 {
930 test!("C.py", "/dir1/dir 2/C.py", "/dir1", WorktreeScan);
931 test!("C.py", "/dir1/dir 2/C.py", "/dir1/dir 2");
932 test!("C.py", "/dir1/dir 3/C.py", "/dir1/dir 3");
933 }
934 )
935 }
936
937 // https://github.com/zed-industries/zed/issues/28407
938 // See https://github.com/zed-industries/zed/issues/34027
939 // See https://github.com/zed-industries/zed/issues/33498
940 #[gpui::test]
941 async fn issue_28407_nesting(cx: &mut TestAppContext) {
942 test_path_likes!(
943 cx,
944 vec![(
945 path!("/project"),
946 json!({
947 "lib": {
948 "src": {
949 "main.rs": "",
950 "only_in_lib.rs": ""
951 },
952 },
953 "src": {
954 "main.rs": ""
955 },
956 }),
957 )],
958 vec![path!("/project")],
959 {
960 test!("main.rs", "/project/src/main.rs", "/project/src");
961 test!("main.rs", "/project/lib/src/main.rs", "/project/lib/src");
962
963 test!("src/main.rs", "/project/src/main.rs", "/project");
964 test!("src/main.rs", "/project/src/main.rs", "/project/src");
965 test!("src/main.rs", "/project/lib/src/main.rs", "/project/lib");
966
967 test!("lib/src/main.rs", "/project/lib/src/main.rs", "/project");
968 test!(
969 "lib/src/main.rs",
970 "/project/lib/src/main.rs",
971 "/project/src"
972 );
973 test!(
974 "lib/src/main.rs",
975 "/project/lib/src/main.rs",
976 "/project/lib"
977 );
978 test!(
979 "lib/src/main.rs",
980 "/project/lib/src/main.rs",
981 "/project/lib/src"
982 );
983 test!(
984 "src/only_in_lib.rs",
985 "/project/lib/src/only_in_lib.rs",
986 "/project/lib/src",
987 WorktreeScan
988 );
989 }
990 )
991 }
992
993 // https://github.com/zed-industries/zed/issues/28339
994 // Note: These could all be found by WorktreeExact if we used
995 // `fs::normalize_path(&maybe_path)`
996 #[gpui::test]
997 async fn issue_28339(cx: &mut TestAppContext) {
998 test_path_likes!(
999 cx,
1000 vec![(
1001 path!("/tmp"),
1002 json!({
1003 "issue28339": {
1004 "foo": {
1005 "bar.txt": ""
1006 },
1007 },
1008 }),
1009 )],
1010 vec![path!("/tmp")],
1011 {
1012 test_local!(
1013 "foo/./bar.txt",
1014 "/tmp/issue28339/foo/bar.txt",
1015 "/tmp/issue28339",
1016 WorktreeExact
1017 );
1018 test_local!(
1019 "foo/../foo/bar.txt",
1020 "/tmp/issue28339/foo/bar.txt",
1021 "/tmp/issue28339",
1022 WorktreeExact
1023 );
1024 test_local!(
1025 "foo/..///foo/bar.txt",
1026 "/tmp/issue28339/foo/bar.txt",
1027 "/tmp/issue28339",
1028 WorktreeExact
1029 );
1030 test_local!(
1031 "issue28339/../issue28339/foo/../foo/bar.txt",
1032 "/tmp/issue28339/foo/bar.txt",
1033 "/tmp/issue28339",
1034 WorktreeExact
1035 );
1036 test_local!(
1037 "./bar.txt",
1038 "/tmp/issue28339/foo/bar.txt",
1039 "/tmp/issue28339/foo",
1040 WorktreeExact
1041 );
1042 test_local!(
1043 "../foo/bar.txt",
1044 "/tmp/issue28339/foo/bar.txt",
1045 "/tmp/issue28339/foo",
1046 FileSystemBackground
1047 );
1048 }
1049 )
1050 }
1051
1052 // https://github.com/zed-industries/zed/issues/28339
1053 // Note: These could all be found by WorktreeExact if we used
1054 // `fs::normalize_path(&maybe_path)`
1055 #[gpui::test]
1056 #[should_panic(expected = "Hover target should not be `None`")]
1057 async fn issue_28339_remote(cx: &mut TestAppContext) {
1058 test_path_likes!(
1059 cx,
1060 vec![(
1061 path!("/tmp"),
1062 json!({
1063 "issue28339": {
1064 "foo": {
1065 "bar.txt": ""
1066 },
1067 },
1068 }),
1069 )],
1070 vec![path!("/tmp")],
1071 {
1072 test_remote!(
1073 "foo/./bar.txt",
1074 "/tmp/issue28339/foo/bar.txt",
1075 "/tmp/issue28339"
1076 );
1077 test_remote!(
1078 "foo/../foo/bar.txt",
1079 "/tmp/issue28339/foo/bar.txt",
1080 "/tmp/issue28339"
1081 );
1082 test_remote!(
1083 "foo/..///foo/bar.txt",
1084 "/tmp/issue28339/foo/bar.txt",
1085 "/tmp/issue28339"
1086 );
1087 test_remote!(
1088 "issue28339/../issue28339/foo/../foo/bar.txt",
1089 "/tmp/issue28339/foo/bar.txt",
1090 "/tmp/issue28339"
1091 );
1092 test_remote!(
1093 "./bar.txt",
1094 "/tmp/issue28339/foo/bar.txt",
1095 "/tmp/issue28339/foo"
1096 );
1097 test_remote!(
1098 "../foo/bar.txt",
1099 "/tmp/issue28339/foo/bar.txt",
1100 "/tmp/issue28339/foo"
1101 );
1102 }
1103 )
1104 }
1105
1106 // https://github.com/zed-industries/zed/issues/34027
1107 #[gpui::test]
1108 async fn issue_34027(cx: &mut TestAppContext) {
1109 test_path_likes!(
1110 cx,
1111 vec![(
1112 path!("/tmp/issue34027"),
1113 json!({
1114 "test.txt": "",
1115 "foo": {
1116 "test.txt": "",
1117 }
1118 }),
1119 ),],
1120 vec![path!("/tmp/issue34027")],
1121 {
1122 test!("test.txt", "/tmp/issue34027/test.txt", "/tmp/issue34027");
1123 test!(
1124 "test.txt",
1125 "/tmp/issue34027/foo/test.txt",
1126 "/tmp/issue34027/foo"
1127 );
1128 }
1129 )
1130 }
1131
1132 // https://github.com/zed-industries/zed/issues/34027
1133 #[gpui::test]
1134 async fn issue_34027_siblings(cx: &mut TestAppContext) {
1135 test_path_likes!(
1136 cx,
1137 vec![(
1138 path!("/test"),
1139 json!({
1140 "sub1": {
1141 "file.txt": "",
1142 },
1143 "sub2": {
1144 "file.txt": "",
1145 }
1146 }),
1147 ),],
1148 vec![path!("/test")],
1149 {
1150 test!("file.txt", "/test/sub1/file.txt", "/test/sub1");
1151 test!("file.txt", "/test/sub2/file.txt", "/test/sub2");
1152 test!("sub1/file.txt", "/test/sub1/file.txt", "/test/sub1");
1153 test!("sub2/file.txt", "/test/sub2/file.txt", "/test/sub2");
1154 test!("sub1/file.txt", "/test/sub1/file.txt", "/test/sub2");
1155 test!("sub2/file.txt", "/test/sub2/file.txt", "/test/sub1");
1156 }
1157 )
1158 }
1159
1160 // https://github.com/zed-industries/zed/issues/34027
1161 #[gpui::test]
1162 async fn issue_34027_nesting(cx: &mut TestAppContext) {
1163 test_path_likes!(
1164 cx,
1165 vec![(
1166 path!("/test"),
1167 json!({
1168 "sub1": {
1169 "file.txt": "",
1170 "subsub1": {
1171 "file.txt": "",
1172 }
1173 },
1174 "sub2": {
1175 "file.txt": "",
1176 "subsub1": {
1177 "file.txt": "",
1178 }
1179 }
1180 }),
1181 ),],
1182 vec![path!("/test")],
1183 {
1184 test!(
1185 "file.txt",
1186 "/test/sub1/subsub1/file.txt",
1187 "/test/sub1/subsub1"
1188 );
1189 test!(
1190 "file.txt",
1191 "/test/sub2/subsub1/file.txt",
1192 "/test/sub2/subsub1"
1193 );
1194 test!(
1195 "subsub1/file.txt",
1196 "/test/sub1/subsub1/file.txt",
1197 "/test",
1198 WorktreeScan
1199 );
1200 test!(
1201 "subsub1/file.txt",
1202 "/test/sub1/subsub1/file.txt",
1203 "/test",
1204 WorktreeScan
1205 );
1206 test!(
1207 "subsub1/file.txt",
1208 "/test/sub1/subsub1/file.txt",
1209 "/test/sub1"
1210 );
1211 test!(
1212 "subsub1/file.txt",
1213 "/test/sub2/subsub1/file.txt",
1214 "/test/sub2"
1215 );
1216 test!(
1217 "subsub1/file.txt",
1218 "/test/sub1/subsub1/file.txt",
1219 "/test/sub1/subsub1",
1220 WorktreeScan
1221 );
1222 }
1223 )
1224 }
1225
1226 // https://github.com/zed-industries/zed/issues/34027
1227 #[gpui::test]
1228 async fn issue_34027_non_worktree_local_file(cx: &mut TestAppContext) {
1229 test_path_likes!(
1230 cx,
1231 vec![
1232 (
1233 path!("/"),
1234 json!({
1235 "file.txt": "",
1236 }),
1237 ),
1238 (
1239 path!("/test"),
1240 json!({
1241 "file.txt": "",
1242 }),
1243 ),
1244 ],
1245 vec![path!("/test")],
1246 {
1247 // Note: Opening a non-worktree file adds that file as a single file worktree.
1248 test_local!("file.txt", "/file.txt", "/", FileSystemBackground);
1249 }
1250 )
1251 }
1252
1253 // https://github.com/zed-industries/zed/issues/34027
1254 #[gpui::test]
1255 async fn issue_34027_non_worktree_remote_file(cx: &mut TestAppContext) {
1256 test_path_likes!(
1257 cx,
1258 vec![
1259 (
1260 path!("/"),
1261 json!({
1262 "file.txt": "",
1263 }),
1264 ),
1265 (
1266 path!("/test"),
1267 json!({
1268 "file.txt": "",
1269 }),
1270 ),
1271 ],
1272 vec![path!("/test")],
1273 {
1274 // Note: Opening a non-worktree file adds that file as a single file worktree.
1275 test_remote!("file.txt", "/test/file.txt", "/");
1276 test_remote!("/test/file.txt", "/test/file.txt", "/");
1277 }
1278 )
1279 }
1280
1281 // See https://github.com/zed-industries/zed/issues/34027
1282 #[gpui::test]
1283 #[should_panic(expected = "Tooltip mismatch")]
1284 async fn issue_34027_gaps(cx: &mut TestAppContext) {
1285 test_path_likes!(
1286 cx,
1287 vec![(
1288 path!("/project"),
1289 json!({
1290 "lib": {
1291 "src": {
1292 "main.rs": ""
1293 },
1294 },
1295 "src": {
1296 "main.rs": ""
1297 },
1298 }),
1299 )],
1300 vec![path!("/project")],
1301 {
1302 test!("main.rs", "/project/src/main.rs", "/project");
1303 test!("main.rs", "/project/lib/src/main.rs", "/project/lib");
1304 }
1305 )
1306 }
1307
1308 // See https://github.com/zed-industries/zed/issues/34027
1309 #[gpui::test]
1310 #[should_panic(expected = "Tooltip mismatch")]
1311 async fn issue_34027_overlap(cx: &mut TestAppContext) {
1312 test_path_likes!(
1313 cx,
1314 vec![(
1315 path!("/project"),
1316 json!({
1317 "lib": {
1318 "src": {
1319 "main.rs": ""
1320 },
1321 },
1322 "src": {
1323 "main.rs": ""
1324 },
1325 }),
1326 )],
1327 vec![path!("/project")],
1328 {
1329 // Finds "/project/src/main.rs"
1330 test!(
1331 "src/main.rs",
1332 "/project/lib/src/main.rs",
1333 "/project/lib/src"
1334 );
1335 }
1336 )
1337 }
1338 }
1339}