Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lsp: Use Path instead of String for path handling #22762

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
+192 −144
Draft

lsp: Use Path instead of String for path handling #22762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ae947b
init
JunkuiZhang Jan 7, 2025
8da9c74
robust `test_glob_literal_prefix`
JunkuiZhang Jan 7, 2025
0de6ecc
fix `test_reporting_fs_changes_to_language_servers`
JunkuiZhang Jan 7, 2025
4e4ff83
remove comments
JunkuiZhang Jan 7, 2025
0779581
better function name
JunkuiZhang Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 138 additions & 114 deletions crates/project/src/lsp_store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ use std::{
};
use text::{Anchor, BufferId, LineEnding, Point, Selection};
use util::{
debug_panic, defer, maybe, merge_json_value_into, post_inc, ResultExt, TryFutureExt as _,
debug_panic, defer, maybe, merge_json_value_into, paths::SanitizedPath, post_inc, ResultExt,
TryFutureExt as _,
};

pub use fs::*;
Expand Down Expand Up @@ -2527,112 +2528,107 @@ impl LocalLspStore {
let mut found_host = false;
for worktree in &worktrees {
let glob_is_inside_worktree = worktree.update(cx, |tree, _| {
if let Some(worktree_root_path) = tree.abs_path().to_str() {
let path_to_watch = match &watcher.glob_pattern {
lsp::GlobPattern::String(s) => {
match s.strip_prefix(worktree_root_path) {
Some(relative) => {
let pattern = relative
.strip_prefix(std::path::MAIN_SEPARATOR)
.unwrap_or(relative)
.to_owned();
let literal_prefix = glob_literal_prefix(&pattern);

let literal_prefix = Arc::from(PathBuf::from(
literal_prefix
.strip_prefix(std::path::MAIN_SEPARATOR)
.unwrap_or(literal_prefix),
));
PathToWatch::Worktree {
literal_prefix,
pattern,
}
let worktree_root_path = tree.abs_path();
let path_to_watch = match &watcher.glob_pattern {
lsp::GlobPattern::String(s) => {
let watcher_path = SanitizedPath::from(s);
match watcher_path.as_path().strip_prefix(&worktree_root_path) {
Ok(relative) => {
let pattern = relative.to_string_lossy().to_string();
let literal_prefix = glob_literal_prefix(relative).into();

PathToWatch::Worktree {
literal_prefix,
pattern,
}
None => {
let path = glob_literal_prefix(s);
let glob = &s[path.len()..];
let pattern = glob
.strip_prefix(std::path::MAIN_SEPARATOR)
.unwrap_or(glob)
.to_owned();
let path = if Path::new(path).components().next().is_none()
{
Arc::from(Path::new(worktree_root_path))
} else {
PathBuf::from(path).into()
};
}
Err(_) => {
let path = glob_literal_prefix(watcher_path.as_path());
let pattern = watcher_path
.as_path()
.strip_prefix(&path)
.unwrap_or(path.as_path())
.to_string_lossy()
.to_string();
let path = if path.components().next().is_none() {
worktree_root_path.clone()
} else {
path.into()
};

PathToWatch::Absolute { path, pattern }
}
PathToWatch::Absolute { path, pattern }
}
}
lsp::GlobPattern::Relative(rp) => {
let Ok(mut base_uri) = match &rp.base_uri {
lsp::OneOf::Left(workspace_folder) => &workspace_folder.uri,
lsp::OneOf::Right(base_uri) => base_uri,
}
.to_file_path() else {
return false;
};

match base_uri.strip_prefix(worktree_root_path) {
Ok(relative) => {
let mut literal_prefix = relative.to_owned();
literal_prefix.push(glob_literal_prefix(&rp.pattern));

PathToWatch::Worktree {
literal_prefix: literal_prefix.into(),
pattern: rp.pattern.clone(),
}
}
Err(_) => {
let path = glob_literal_prefix(&rp.pattern);
let glob = &rp.pattern[path.len()..];
let pattern = glob
.strip_prefix(std::path::MAIN_SEPARATOR)
.unwrap_or(glob)
.to_owned();
base_uri.push(path);

let path = if base_uri.components().next().is_none() {
Arc::from(Path::new("/"))
} else {
base_uri.into()
};
PathToWatch::Absolute { path, pattern }
}
lsp::GlobPattern::Relative(rp) => {
let Ok(mut base_uri) = match &rp.base_uri {
lsp::OneOf::Left(workspace_folder) => &workspace_folder.uri,
lsp::OneOf::Right(base_uri) => base_uri,
}
.to_file_path() else {
return false;
};

match base_uri.strip_prefix(&worktree_root_path) {
Ok(relative) => {
let mut literal_prefix = relative.to_owned();
literal_prefix
.push(glob_literal_prefix(Path::new(&rp.pattern)));

PathToWatch::Worktree {
literal_prefix: literal_prefix.into(),
pattern: rp.pattern.clone(),
}
}
}
};
match path_to_watch {
PathToWatch::Worktree {
literal_prefix,
pattern,
} => {
if let Some((tree, glob)) =
tree.as_local_mut().zip(Glob::new(&pattern).log_err())
{
tree.add_path_prefix_to_scan(literal_prefix);
worktree_globs
.entry(tree.id())
.or_insert_with(GlobSetBuilder::new)
.add(glob);
} else {
return false;
Err(_) => {
let path = glob_literal_prefix(Path::new(&rp.pattern));
let pattern = Path::new(&rp.pattern)
.strip_prefix(&path)
.unwrap_or(path.as_path())
.to_string_lossy()
.to_string();
base_uri.push(path);

let path = if base_uri.components().next().is_none() {
// TODO:
// why just return the root path?
// how should we handle this on Windows?
Arc::from(Path::new("/"))
Comment on lines +2592 to +2596
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, I dont know how to handle this on Windows.

} else {
base_uri.into()
};
PathToWatch::Absolute { path, pattern }
}
}
PathToWatch::Absolute { path, pattern } => {
if let Some(glob) = Glob::new(&pattern).log_err() {
abs_globs
.entry(path)
.or_insert_with(GlobSetBuilder::new)
.add(glob);
}
}
};
match path_to_watch {
PathToWatch::Worktree {
literal_prefix,
pattern,
} => {
if let Some((tree, glob)) =
tree.as_local_mut().zip(Glob::new(&pattern).log_err())
{
tree.add_path_prefix_to_scan(literal_prefix);
worktree_globs
.entry(tree.id())
.or_insert_with(GlobSetBuilder::new)
.add(glob);
} else {
return false;
}
}
PathToWatch::Absolute { path, pattern } => {
if let Some(glob) = Glob::new(&pattern).log_err() {
abs_globs
.entry(path)
.or_insert_with(GlobSetBuilder::new)
.add(glob);
}
}
return true;
}
false
true
});
if glob_is_inside_worktree {
log::trace!(
Expand Down Expand Up @@ -8271,23 +8267,25 @@ impl DiagnosticSummary {
}
}

fn glob_literal_prefix(glob: &str) -> &str {
let is_absolute = glob.starts_with(path::MAIN_SEPARATOR);

let mut literal_end = is_absolute as usize;
for (i, part) in glob.split(path::MAIN_SEPARATOR).enumerate() {
if part.contains(['*', '?', '{', '}']) {
break;
} else {
if i > 0 {
// Account for separator prior to this part
literal_end += path::MAIN_SEPARATOR.len_utf8();
fn glob_literal_prefix(glob: &Path) -> PathBuf {
let mut idx_end = None;
for (idx, component) in glob.components().enumerate() {
match component {
path::Component::Normal(part) => {
let part_str = part.to_str().unwrap_or("");
if part_str.contains(['*', '?', '{', '}']) {
idx_end = Some(idx);
break;
}
}
literal_end += part.len();
_ => {}
}
}
let literal_end = literal_end.min(glob.len());
&glob[..literal_end]
if let Some(idx_end) = idx_end {
glob.components().take(idx_end).collect::<PathBuf>()
} else {
glob.to_path_buf()
}
}

pub struct SshLspAdapter {
Expand Down Expand Up @@ -8667,8 +8665,34 @@ fn include_text(server: &lsp::LanguageServer) -> Option<bool> {
#[cfg(test)]
#[test]
fn test_glob_literal_prefix() {
assert_eq!(glob_literal_prefix("**/*.js"), "");
assert_eq!(glob_literal_prefix("node_modules/**/*.js"), "node_modules");
assert_eq!(glob_literal_prefix("foo/{bar,baz}.js"), "foo");
assert_eq!(glob_literal_prefix("foo/bar/baz.js"), "foo/bar/baz.js");
assert_eq!(glob_literal_prefix(Path::new("**/*.js")), Path::new(""));
assert_eq!(
glob_literal_prefix(Path::new("node_modules/**/*.js")),
Path::new("node_modules")
);
assert_eq!(
glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
Path::new("foo")
);
assert_eq!(
glob_literal_prefix(Path::new("foo/bar/baz.js")),
Path::new("foo/bar/baz.js")
);

#[cfg(target_os = "windows")]
{
assert_eq!(glob_literal_prefix(Path::new("**\\*.js")), Path::new(""));
assert_eq!(
glob_literal_prefix(Path::new("node_modules\\**/*.js")),
Path::new("node_modules")
);
assert_eq!(
glob_literal_prefix(Path::new("foo/{bar,baz}.js")),
Path::new("foo")
);
assert_eq!(
glob_literal_prefix(Path::new("foo\\bar\\baz.js")),
Path::new("foo/bar/baz.js")
);
}
}
Loading
Loading