-
-
Notifications
You must be signed in to change notification settings - Fork 463
/
os.rs
450 lines (400 loc) · 14.1 KB
/
os.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
//! Implementation of the [FileSystem] and related traits for the underlying OS filesystem
use super::{BoxedTraversal, ErrorKind, File, FileSystemDiagnostic};
use crate::fs::OpenOptions;
use crate::{
fs::{TraversalContext, TraversalScope},
BiomePath, FileSystem,
};
use biome_diagnostics::{adapters::IoError, DiagnosticExt, Error, Severity};
use oxc_resolver::{Resolution, ResolveError, ResolveOptions, Resolver};
use rayon::{scope, Scope};
use std::fs::{DirEntry, FileType};
use std::panic::AssertUnwindSafe;
use std::process::Command;
use std::{
env, fs,
io::{self, ErrorKind as IoErrorKind, Read, Seek, Write},
mem,
path::{Path, PathBuf},
};
const MAX_SYMLINK_DEPTH: u8 = 3;
/// Implementation of [FileSystem] that directly calls through to the underlying OS
pub struct OsFileSystem {
pub working_directory: Option<PathBuf>,
pub configuration_resolver: AssertUnwindSafe<Resolver>,
}
impl OsFileSystem {
pub fn new(working_directory: PathBuf) -> Self {
Self {
working_directory: Some(working_directory),
configuration_resolver: AssertUnwindSafe(Resolver::new(ResolveOptions {
condition_names: vec!["node".to_string(), "import".to_string()],
extensions: vec![".json".to_string(), ".jsonc".to_string()],
..ResolveOptions::default()
})),
}
}
}
impl Default for OsFileSystem {
fn default() -> Self {
Self {
working_directory: env::current_dir().ok(),
configuration_resolver: AssertUnwindSafe(Resolver::new(ResolveOptions {
condition_names: vec!["node".to_string(), "import".to_string()],
extensions: vec![".json".to_string(), ".jsonc".to_string()],
..ResolveOptions::default()
})),
}
}
}
impl FileSystem for OsFileSystem {
fn open_with_options(&self, path: &Path, options: OpenOptions) -> io::Result<Box<dyn File>> {
tracing::debug_span!("OsFileSystem::open_with_options", path = ?path, options = ?options)
.in_scope(move || -> io::Result<Box<dyn File>> {
let mut fs_options = fs::File::options();
Ok(Box::new(OsFile {
inner: options.into_fs_options(&mut fs_options).open(path)?,
version: 0,
}))
})
}
fn traversal(&self, func: BoxedTraversal) {
OsTraversalScope::with(move |scope| {
func(scope);
})
}
fn working_directory(&self) -> Option<PathBuf> {
self.working_directory.clone()
}
fn path_exists(&self, path: &Path) -> bool {
path.exists()
}
fn path_is_file(&self, path: &Path) -> bool {
path.is_file()
}
fn path_is_dir(&self, path: &Path) -> bool {
path.is_dir()
}
fn path_is_symlink(&self, path: &Path) -> bool {
path.is_symlink()
}
fn resolve_configuration(
&self,
specifier: &str,
path: &Path,
) -> Result<Resolution, ResolveError> {
self.configuration_resolver.resolve(path, specifier)
}
fn get_changed_files(&self, base: &str) -> io::Result<Vec<String>> {
let output = Command::new("git")
.arg("diff")
.arg("--name-only")
.arg("--relative")
// A: added
// C: copied
// M: modified
// R: renamed
// Source: https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
.arg("--diff-filter=ACMR")
.arg(format!("{base}...HEAD"))
.output()?;
Ok(String::from_utf8_lossy(&output.stdout)
.lines()
.map(|l| l.to_string())
.collect())
}
fn get_staged_files(&self) -> io::Result<Vec<String>> {
let output = Command::new("git")
.arg("diff")
.arg("--name-only")
.arg("--relative")
.arg("--staged")
// A: added
// C: copied
// M: modified
// R: renamed
// Source: https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---diff-filterACDMRTUXB82308203
.arg("--diff-filter=ACMR")
.output()?;
Ok(String::from_utf8_lossy(&output.stdout)
.lines()
.map(|l| l.to_string())
.collect())
}
}
struct OsFile {
inner: fs::File,
version: i32,
}
impl File for OsFile {
fn read_to_string(&mut self, buffer: &mut String) -> io::Result<()> {
tracing::debug_span!("OsFile::read_to_string").in_scope(move || {
// Reset the cursor to the starting position
self.inner.rewind()?;
// Read the file content
self.inner.read_to_string(buffer)?;
Ok(())
})
}
fn set_content(&mut self, content: &[u8]) -> io::Result<()> {
tracing::trace_span!("OsFile::set_content").in_scope(move || {
// Truncate the file
self.inner.set_len(0)?;
// Reset the cursor to the starting position
self.inner.rewind()?;
// Write the byte slice
self.inner.write_all(content)?;
// new version stored
self.version += 1;
Ok(())
})
}
fn file_version(&self) -> i32 {
self.version
}
}
#[repr(transparent)]
pub struct OsTraversalScope<'scope> {
scope: Scope<'scope>,
}
impl<'scope> OsTraversalScope<'scope> {
pub(crate) fn with<F>(func: F)
where
F: FnOnce(&Self) + Send,
{
scope(move |scope| func(Self::from_rayon(scope)))
}
fn from_rayon<'a>(scope: &'a Scope<'scope>) -> &'a Self {
// SAFETY: transmuting from Scope to OsTraversalScope is safe since
// OsTraversalScope has the `repr(transparent)` attribute that
// guarantees its layout is the same as Scope
unsafe { mem::transmute(scope) }
}
}
impl<'scope> TraversalScope<'scope> for OsTraversalScope<'scope> {
fn evaluate(&self, ctx: &'scope dyn TraversalContext, path: PathBuf) {
let file_type = match path.metadata() {
Ok(meta) => meta.file_type(),
Err(err) => {
ctx.push_diagnostic(
IoError::from(err).with_file_path(path.to_string_lossy().to_string()),
);
return;
}
};
handle_any_file(&self.scope, ctx, path, file_type, None);
}
fn handle(&self, context: &'scope dyn TraversalContext, path: PathBuf) {
self.scope.spawn(move |_| {
context.handle_path(BiomePath::new(path));
});
}
}
// TODO: remove in Biome 2.0, and directly use `.gitignore`
/// Default list of ignored directories, in the future will be supplanted by
/// detecting and parsing .ignore files
const DEFAULT_IGNORE: &[&[u8]] = &[b".git", b".svn", b".hg", b".yarn", b"node_modules"];
/// Traverse a single directory
fn handle_dir<'scope>(
scope: &Scope<'scope>,
ctx: &'scope dyn TraversalContext,
path: &Path,
// The unresolved origin path in case the directory is behind a symbolic link
origin_path: Option<PathBuf>,
) {
if let Some(file_name) = path.file_name() {
if DEFAULT_IGNORE.contains(&file_name.as_encoded_bytes()) {
return;
}
}
let iter = match fs::read_dir(path) {
Ok(iter) => iter,
Err(err) => {
ctx.push_diagnostic(IoError::from(err).with_file_path(path.display().to_string()));
return;
}
};
for entry in iter {
match entry {
Ok(entry) => handle_dir_entry(scope, ctx, entry, origin_path.clone()),
Err(err) => {
ctx.push_diagnostic(IoError::from(err).with_file_path(path.display().to_string()));
}
}
}
}
/// Traverse a single directory entry, scheduling any file to execute the context
/// handler and sub-directories for subsequent traversal
fn handle_dir_entry<'scope>(
scope: &Scope<'scope>,
ctx: &'scope dyn TraversalContext,
entry: DirEntry,
// The unresolved origin path in case the directory is behind a symbolic link
origin_path: Option<PathBuf>,
) {
let path = entry.path();
let file_type = match entry.file_type() {
Ok(file_type) => file_type,
Err(err) => {
ctx.push_diagnostic(
IoError::from(err).with_file_path(path.to_string_lossy().to_string()),
);
return;
}
};
handle_any_file(scope, ctx, path, file_type, origin_path);
}
fn handle_any_file<'scope>(
scope: &Scope<'scope>,
ctx: &'scope dyn TraversalContext,
mut path: PathBuf,
mut file_type: FileType,
// The unresolved origin path in case the directory is behind a symbolic link
mut origin_path: Option<PathBuf>,
) {
if !ctx.interner().intern_path(path.clone()) {
// If the path was already inserted, it could have been pointed at by
// multiple symlinks. No need to traverse again.
return;
}
if file_type.is_symlink() {
if !ctx.can_handle(&BiomePath::new(path.clone())) {
return;
}
let Ok((target_path, target_file_type)) = expand_symbolic_link(path.clone(), ctx) else {
return;
};
if !ctx.interner().intern_path(target_path.clone()) {
// If the path was already inserted, it could have been pointed at by
// multiple symlinks. No need to traverse again.
return;
}
if target_file_type.is_dir() {
scope.spawn(move |scope| {
handle_dir(scope, ctx, &target_path, Some(path));
});
return;
}
path = target_path;
file_type = target_file_type;
}
// In case the file is inside a directory that is behind a symbolic link,
// the unresolved origin path is used to construct a new path.
// This is required to support ignore patterns to symbolic links.
let biome_path = if let Some(old_origin_path) = &origin_path {
if let Some(file_name) = path.file_name() {
let new_origin_path = old_origin_path.join(file_name);
origin_path = Some(new_origin_path.clone());
BiomePath::new(new_origin_path)
} else {
ctx.push_diagnostic(Error::from(FileSystemDiagnostic {
path: path.to_string_lossy().to_string(),
error_kind: ErrorKind::UnknownFileType,
severity: Severity::Warning,
}));
return;
}
} else {
BiomePath::new(&path)
};
// Performing this check here let's us skip unsupported
// files entirely, as well as silently ignore unsupported files when
// doing a directory traversal, but printing an error message if the
// user explicitly requests an unsupported file to be handled.
// This check also works for symbolic links.
if !ctx.can_handle(&biome_path) {
return;
}
if file_type.is_dir() {
scope.spawn(move |scope| {
handle_dir(scope, ctx, &path, origin_path);
});
return;
}
if file_type.is_file() {
scope.spawn(move |_| {
ctx.store_path(BiomePath::new(path));
});
return;
}
ctx.push_diagnostic(Error::from(FileSystemDiagnostic {
path: path.to_string_lossy().to_string(),
error_kind: ErrorKind::from(file_type),
severity: Severity::Warning,
}));
}
/// Indicates a symbolic link could not be expanded.
///
/// Has no fields, since the diagnostics are already generated inside
/// [follow_symbolic_link()] and the caller doesn't need to do anything except
/// an early return.
struct SymlinkExpansionError;
/// Expands symlinks by recursively following them up to [MAX_SYMLINK_DEPTH].
///
/// ## Returns
///
/// Returns a tuple where the first argument is the target path being pointed to
/// and the second argument is the target file type.
fn expand_symbolic_link(
mut path: PathBuf,
ctx: &dyn TraversalContext,
) -> Result<(PathBuf, FileType), SymlinkExpansionError> {
let mut symlink_depth = 0;
loop {
symlink_depth += 1;
if symlink_depth > MAX_SYMLINK_DEPTH {
let path = path.to_string_lossy().to_string();
ctx.push_diagnostic(Error::from(FileSystemDiagnostic {
path: path.clone(),
error_kind: ErrorKind::DeeplyNestedSymlinkExpansion(path),
severity: Severity::Warning,
}));
return Err(SymlinkExpansionError);
}
let (target_path, target_file_type) = follow_symlink(&path, ctx)?;
if target_file_type.is_symlink() {
path = target_path;
continue;
}
return Ok((target_path, target_file_type));
}
}
fn follow_symlink(
path: &Path,
ctx: &dyn TraversalContext,
) -> Result<(PathBuf, FileType), SymlinkExpansionError> {
tracing::info!("Translating symlink: {path:?}");
let target_path = fs::read_link(path).map_err(|err| {
ctx.push_diagnostic(IoError::from(err).with_file_path(path.to_string_lossy().to_string()));
SymlinkExpansionError
})?;
// Make sure relative symlinks are resolved:
let target_path = path
.parent()
.map(|parent_dir| parent_dir.join(&target_path))
.unwrap_or(target_path);
let target_file_type = match fs::symlink_metadata(&target_path) {
Ok(meta) => meta.file_type(),
Err(err) => {
if err.kind() == IoErrorKind::NotFound {
let path = path.to_string_lossy().to_string();
ctx.push_diagnostic(Error::from(FileSystemDiagnostic {
path: path.clone(),
error_kind: ErrorKind::DereferencedSymlink(path),
severity: Severity::Warning,
}));
} else {
ctx.push_diagnostic(
IoError::from(err).with_file_path(path.to_string_lossy().to_string()),
);
}
return Err(SymlinkExpansionError);
}
};
Ok((target_path, target_file_type))
}
impl From<FileType> for ErrorKind {
fn from(_: FileType) -> Self {
Self::UnknownFileType
}
}