-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
issue.rs
572 lines (522 loc) · 20.2 KB
/
issue.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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
use std::{
borrow::Cow,
cmp::min,
collections::{hash_map::Entry, HashMap, HashSet},
fmt::Write as _,
path::{Path, PathBuf},
str::FromStr,
sync::{Arc, Mutex},
};
use anyhow::{anyhow, Result};
use crossterm::style::{StyledContent, Stylize};
use owo_colors::{OwoColorize as _, Style};
use turbo_tasks::{RawVc, ReadRef, TransientInstance, TransientValue, TryJoinIterExt, Vc};
use turbo_tasks_fs::{source_context::get_source_context, FileLinesContent};
use turbopack_core::issue::{
CapturedIssues, Issue, IssueReporter, IssueSeverity, PlainIssue, PlainIssueProcessingPathItem,
PlainIssueSource,
};
use crate::source_context::format_source_context_lines;
#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct IssueSeverityCliOption(pub IssueSeverity);
impl serde::Serialize for IssueSeverityCliOption {
fn serialize<S: serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
serializer.serialize_str(&self.0.to_string())
}
}
impl<'de> serde::Deserialize<'de> for IssueSeverityCliOption {
fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
let s = String::deserialize(deserializer)?;
IssueSeverityCliOption::from_str(&s).map_err(serde::de::Error::custom)
}
}
impl clap::ValueEnum for IssueSeverityCliOption {
fn value_variants<'a>() -> &'a [Self] {
const VARIANTS: [IssueSeverityCliOption; 8] = [
Self(IssueSeverity::Bug),
Self(IssueSeverity::Fatal),
Self(IssueSeverity::Error),
Self(IssueSeverity::Warning),
Self(IssueSeverity::Hint),
Self(IssueSeverity::Note),
Self(IssueSeverity::Suggestion),
Self(IssueSeverity::Info),
];
&VARIANTS
}
fn to_possible_value<'a>(&self) -> Option<clap::builder::PossibleValue> {
Some(clap::builder::PossibleValue::new(self.0.as_str()).help(self.0.as_help_str()))
}
}
impl FromStr for IssueSeverityCliOption {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
<IssueSeverityCliOption as clap::ValueEnum>::from_str(s, true).map_err(|s| anyhow!("{}", s))
}
}
fn severity_to_style(severity: IssueSeverity) -> Style {
match severity {
IssueSeverity::Bug => Style::new().bright_red().underline(),
IssueSeverity::Fatal => Style::new().bright_red().underline(),
IssueSeverity::Error => Style::new().bright_red(),
IssueSeverity::Warning => Style::new().bright_yellow(),
IssueSeverity::Hint => Style::new().bold(),
IssueSeverity::Note => Style::new().bold(),
IssueSeverity::Suggestion => Style::new().bright_green().underline(),
IssueSeverity::Info => Style::new().bright_green(),
}
}
fn format_source_content(source: &PlainIssueSource, formatted_issue: &mut String) {
if let FileLinesContent::Lines(lines) = source.asset.content.lines_ref() {
let start_line = source.start.line;
let end_line = source.end.line;
let start_column = source.start.column;
let end_column = source.end.column;
let lines = lines.iter().map(|l| l.content.as_str());
let ctx = get_source_context(lines, start_line, start_column, end_line, end_column);
format_source_context_lines(&ctx, formatted_issue);
}
}
fn format_optional_path(
path: &Option<Vec<ReadRef<PlainIssueProcessingPathItem>>>,
formatted_issue: &mut String,
) -> Result<()> {
if let Some(path) = path {
let mut last_context = None;
for item in path.iter().rev() {
let PlainIssueProcessingPathItem {
file_path: ref context,
ref description,
} = **item;
if let Some(context) = context {
let option_context = Some(context.clone());
if last_context == option_context {
writeln!(formatted_issue, " at {}", description)?;
} else {
writeln!(
formatted_issue,
" at {} ({})",
context.to_string().bright_blue(),
description
)?;
last_context = option_context;
}
} else {
writeln!(formatted_issue, " at {}", description)?;
last_context = None;
}
}
}
Ok(())
}
pub fn format_issue(
plain_issue: &PlainIssue,
path: Option<String>,
options: &LogOptions,
) -> String {
let &LogOptions {
ref current_dir,
log_detail,
..
} = options;
let mut issue_text = String::new();
let severity = plain_issue.severity;
// TODO CLICKABLE PATHS
let context_path = plain_issue
.file_path
.replace("[project]", ¤t_dir.to_string_lossy())
.replace("/./", "/")
.replace("\\\\?\\", "");
let category = &plain_issue.category;
let title = &plain_issue.title;
let mut styled_issue = if let Some(source) = &plain_issue.source {
let mut styled_issue = format!(
"{}:{}:{} {}",
context_path,
source.start.line + 1,
source.start.column,
title.bold()
);
styled_issue.push('\n');
format_source_content(source, &mut styled_issue);
styled_issue
} else {
format!("{}", title.bold())
};
let description = &plain_issue.description;
if !description.is_empty() {
writeln!(styled_issue, "\n{description}").unwrap();
}
if log_detail {
styled_issue.push('\n');
let detail = &plain_issue.detail;
if !detail.is_empty() {
for line in detail.split('\n') {
writeln!(styled_issue, "| {line}").unwrap();
}
}
let documentation_link = &plain_issue.documentation_link;
if !documentation_link.is_empty() {
writeln!(styled_issue, "\ndocumentation: {documentation_link}").unwrap();
}
if let Some(path) = path {
writeln!(styled_issue, "{}", path).unwrap();
}
}
write!(
issue_text,
"{} - [{}] {}",
severity.style(severity_to_style(severity)),
category,
plain_issue.file_path
)
.unwrap();
for line in styled_issue.lines() {
writeln!(issue_text, " {line}").unwrap();
}
issue_text
}
pub type GroupedIssues = HashMap<IssueSeverity, HashMap<String, HashMap<String, Vec<String>>>>;
const DEFAULT_SHOW_COUNT: usize = 3;
const ORDERED_GROUPS: &[IssueSeverity] = &[
IssueSeverity::Bug,
IssueSeverity::Fatal,
IssueSeverity::Error,
IssueSeverity::Warning,
IssueSeverity::Hint,
IssueSeverity::Note,
IssueSeverity::Suggestion,
IssueSeverity::Info,
];
#[turbo_tasks::value(shared)]
#[derive(Debug, Clone)]
pub struct LogOptions {
pub current_dir: PathBuf,
pub project_dir: PathBuf,
pub show_all: bool,
pub log_detail: bool,
pub log_level: IssueSeverity,
}
/// Tracks the state of currently seen issues.
///
/// An issue is considered seen as long as a single source has pulled the issue.
/// When a source repulls emitted issues due to a recomputation somewhere in its
/// graph, there are a few possibilities:
///
/// 1. An issue from this pull is brand new to all sources, in which case it
/// will be logged and the issue's count is inremented.
/// 2. An issue from this pull is brand new to this source but another source
/// has already pulled it, in which case it will be logged and the issue's count
/// is incremented.
/// 3. The previous pull from this source had already seen the issue, in which
/// case the issue will be skipped and the issue's count remains constant.
/// 4. An issue seen in a previous pull was not repulled, and the issue's
/// count is decremented.
///
/// Once an issue's count reaches zero, it's removed. If it is ever seen again,
/// it is considered new and will be relogged.
#[derive(Default)]
struct SeenIssues {
/// Keeps track of all issue pulled from the source. Used so that we can
/// decrement issues that are not pulled in the current synchronization.
source_to_issue_ids: HashMap<RawVc, HashSet<u64>>,
/// Counts the number of times a particular issue is seen across all
/// sources. As long as the count is positive, an issue is considered
/// "seen" and will not be relogged. Once the count reaches zero, the
/// issue is removed and the next time its seen it will be considered new.
issues_count: HashMap<u64, usize>,
}
impl SeenIssues {
fn new() -> Self {
Default::default()
}
/// Synchronizes state between the issues previously pulled from this
/// source, to the issues now pulled.
fn new_ids(&mut self, source: RawVc, issue_ids: HashSet<u64>) -> HashSet<u64> {
let old = self.source_to_issue_ids.entry(source).or_default();
// difference is the issues that were never counted before.
let difference = issue_ids
.iter()
.filter(|id| match self.issues_count.entry(**id) {
Entry::Vacant(e) => {
// If the issue not currently counted, then it's new and should be logged.
e.insert(1);
true
}
Entry::Occupied(mut e) => {
if old.contains(*id) {
// If old contains the id, then we don't need to change the count, but we
// do need to remove the entry. Doing so allows us to iterate the final old
// state and decrement old issues.
old.remove(*id);
} else {
// If old didn't contain the entry, then this issue was already counted
// from a difference source.
*e.get_mut() += 1;
}
false
}
})
.cloned()
.collect::<HashSet<_>>();
// Old now contains only the ids that were not present in the new issue_ids.
for id in old.iter() {
match self.issues_count.entry(*id) {
Entry::Vacant(_) => unreachable!("issue must already be tracked to appear in old"),
Entry::Occupied(mut e) => {
let v = e.get_mut();
if *v == 1 {
// If this was the last counter of the issue, then we need to prune the
// value to free memory.
e.remove();
} else {
// Another source counted the issue, and it must not be relogged until all
// sources remove it.
*v -= 1;
}
}
}
}
*old = issue_ids;
difference
}
}
/// Logs emitted issues to console logs, deduplicating issues between peeks of
/// the collected issues. The ConsoleUi can be shared and capture issues from
/// multiple sources, with deduplication operating across all issues.
#[turbo_tasks::value(shared, serialization = "none", eq = "manual")]
#[derive(Clone)]
pub struct ConsoleUi {
options: LogOptions,
#[turbo_tasks(trace_ignore, debug_ignore)]
seen: Arc<Mutex<SeenIssues>>,
}
impl PartialEq for ConsoleUi {
fn eq(&self, other: &Self) -> bool {
self.options == other.options
}
}
#[turbo_tasks::value_impl]
impl ConsoleUi {
#[turbo_tasks::function]
pub fn new(options: TransientInstance<LogOptions>) -> Vc<Self> {
ConsoleUi {
options: (*options).clone(),
seen: Arc::new(Mutex::new(SeenIssues::new())),
}
.cell()
}
}
#[turbo_tasks::value_impl]
impl IssueReporter for ConsoleUi {
#[turbo_tasks::function]
async fn report_issues(
&self,
issues: TransientInstance<ReadRef<CapturedIssues>>,
source: TransientValue<RawVc>,
min_failing_severity: Vc<IssueSeverity>,
) -> Result<Vc<bool>> {
let issues = &*issues;
let LogOptions {
ref current_dir,
ref project_dir,
show_all,
log_detail,
log_level,
..
} = self.options;
let mut grouped_issues: GroupedIssues = HashMap::new();
let issues = issues
.iter_with_shortest_path()
.map(|(issue, path)| async move {
let plain_issue = issue.into_plain(path);
let id = plain_issue.internal_hash(false).await?;
Ok((plain_issue.await?, *id))
})
.try_join()
.await?;
let issue_ids = issues.iter().map(|(_, id)| *id).collect::<HashSet<_>>();
let mut new_ids = self
.seen
.lock()
.unwrap()
.new_ids(source.into_value(), issue_ids);
let mut has_fatal = false;
for (plain_issue, id) in issues {
if !new_ids.remove(&id) {
continue;
}
let severity = plain_issue.severity;
if severity <= *min_failing_severity.await? {
has_fatal = true;
}
let context_path =
make_relative_to_cwd(&plain_issue.file_path, project_dir, current_dir);
let category = &plain_issue.category;
let title = &plain_issue.title;
let processing_path = &*plain_issue.processing_path;
let severity_map = grouped_issues.entry(severity).or_default();
let category_map = severity_map.entry(category.clone()).or_default();
let issues = category_map.entry(context_path.to_string()).or_default();
let mut styled_issue = if let Some(source) = &plain_issue.source {
let mut styled_issue = format!(
"{}:{}:{} {}",
context_path,
source.start.line + 1,
source.start.column,
title.bold()
);
styled_issue.push('\n');
format_source_content(source, &mut styled_issue);
styled_issue
} else {
format!("{}", title.bold())
};
let description = &plain_issue.description;
if !description.is_empty() {
writeln!(&mut styled_issue, "\n{description}")?;
}
if log_detail {
styled_issue.push('\n');
let detail = &plain_issue.detail;
if !detail.is_empty() {
for line in detail.split('\n') {
writeln!(&mut styled_issue, "| {line}")?;
}
}
let documentation_link = &plain_issue.documentation_link;
if !documentation_link.is_empty() {
writeln!(&mut styled_issue, "\ndocumentation: {documentation_link}")?;
}
format_optional_path(processing_path, &mut styled_issue)?;
}
issues.push(styled_issue);
}
for severity in ORDERED_GROUPS.iter().copied().filter(|l| *l <= log_level) {
if let Some(severity_map) = grouped_issues.get_mut(&severity) {
let severity_map_size = severity_map.len();
let indent = if severity_map_size == 1 {
print!("{} - ", severity.style(severity_to_style(severity)));
""
} else {
println!("{} -", severity.style(severity_to_style(severity)));
" "
};
let severity_map_take_count = if show_all {
severity_map_size
} else {
DEFAULT_SHOW_COUNT
};
let mut categories = severity_map.keys().cloned().collect::<Vec<_>>();
categories.sort();
for category in categories.iter().take(severity_map_take_count) {
let category_issues = severity_map.get_mut(category).unwrap();
let category_issues_size = category_issues.len();
let indent = if category_issues_size == 1 && indent.is_empty() {
print!("[{category}] ");
"".to_string()
} else {
println!("{indent}[{category}]");
format!("{indent} ")
};
let (mut contextes, mut vendor_contextes): (Vec<_>, Vec<_>) = category_issues
.iter_mut()
.partition(|(context, _)| !context.contains("node_modules"));
contextes.sort_by_key(|(c, _)| *c);
if show_all {
vendor_contextes.sort_by_key(|(c, _)| *c);
contextes.extend(vendor_contextes);
}
let category_issues_take_count = if show_all {
category_issues_size
} else {
min(contextes.len(), DEFAULT_SHOW_COUNT)
};
for (context, issues) in contextes.into_iter().take(category_issues_take_count)
{
issues.sort();
println!("{indent}{}", context.bright_blue());
let issues_size = issues.len();
let issues_take_count = if show_all {
issues_size
} else {
DEFAULT_SHOW_COUNT
};
for issue in issues.iter().take(issues_take_count) {
let mut i = 0;
for line in issue.lines() {
println!("{indent} {line}");
i += 1;
}
if i > 1 {
// Spacing after multi line issues
println!();
}
}
if issues_size > issues_take_count {
println!("{indent} {}", show_all_message("issues", issues_size));
}
}
if category_issues_size > category_issues_take_count {
println!(
"{indent}{}",
show_all_message_with_shown_count(
"paths",
category_issues_size,
category_issues_take_count
)
);
}
}
if severity_map_size > severity_map_take_count {
println!(
"{indent}{}",
show_all_message("categories", severity_map_size)
)
}
}
}
Ok(Vc::cell(has_fatal))
}
}
fn make_relative_to_cwd<'a>(path: &'a str, project_dir: &Path, cwd: &Path) -> Cow<'a, str> {
if let Some(path_in_project) = path.strip_prefix("[project]/") {
let abs_path = if std::path::MAIN_SEPARATOR != '/' {
project_dir.join(path_in_project.replace('/', std::path::MAIN_SEPARATOR_STR))
} else {
project_dir.join(path_in_project)
};
let relative = abs_path
.strip_prefix(cwd)
.unwrap_or(&abs_path)
.to_string_lossy()
.to_string();
relative.into()
} else {
path.into()
}
}
fn show_all_message(label: &str, size: usize) -> StyledContent<String> {
show_all_message_with_shown_count(label, size, DEFAULT_SHOW_COUNT)
}
fn show_all_message_with_shown_count(
label: &str,
size: usize,
shown: usize,
) -> StyledContent<String> {
if shown == 0 {
format!(
"... [{} {label}] are hidden, run with {} to show them",
size,
"--show-all".bright_green()
)
.bold()
} else {
format!(
"... [{} more {label}] are hidden, run with {} to show all",
size - shown,
"--show-all".bright_green()
)
.bold()
}
}