language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-03 07:04:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge #8265

Browse source 
8265: Improve rustc diagnostic mapping r=jonas-schievink a=jonas-schievink

Try to mirror rustc diagnostics more closely by:

* Emitting hint-level diagnostics at *all* macro invocation sites that caused the diagnostic
  * Previously we emitted a copy of the diagnostic (not at hint level) at the last macro invocation site only
* Emitting the original diagnostic inside the macro, if it was caused by a macro
* Always including related information pointing to the invocation site or the macro, respectively (the old code contained a bug that would sometimes omit it)

Fixes https://github.com/rust-analyzer/rust-analyzer/issues/8260


![screenshot-2021-03-30-19:34:56](https://user-images.githubusercontent.com/1786438/113031484-1266a600-918f-11eb-9164-fed01c8ba37e.png)
![screenshot-2021-03-30-19:35:10](https://user-images.githubusercontent.com/1786438/113031486-12ff3c80-918f-11eb-8f15-9d7f23b69653.png)


Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
Co-authored-by: Jonas Schievink <jonas.schievink@ferrous-systems.com>
This commit is contained in:
bors[bot] 2021-04-01 21:22:11 +00:00 • committed by GitHub
commit ea8feca31a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 220 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

194
crates/rust-analyzer/src/diagnostics/test_data/macro_compiler_error.txt
View file

@ -1,4 +1,134 @@
[ [
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 271,
character: 8,
},
end: Position {
line: 271,
character: 50,
},
},
severity: Some(
Hint,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 264,
character: 8,
},
end: Position {
line: 264,
character: 76,
},
},
},
message: "Exact error occurred here",
},
],
),
tags: None,
data: None,
},
fixes: [],
},
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/data.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 79,
character: 15,
},
end: Position {
line: 79,
character: 41,
},
},
severity: Some(
Hint,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 264,
character: 8,
},
end: Position {
line: 264,
character: 76,
},
},
},
message: "Exact error occurred here",
},
],
),
tags: None,
data: None,
},
fixes: [],
},
MappedRustDiagnostic { MappedRustDiagnostic {
url: Url { url: Url {
scheme: "file", scheme: "file",
@ -32,6 +162,31 @@
message: "Please register your known path in the path module", message: "Please register your known path in the path module",
related_information: Some( related_information: Some(
[ [
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 271,
character: 8,
},
end: Position {
line: 271,
character: 50,
},
},
},
message: "Error originated from macro call here",
},
DiagnosticRelatedInformation { DiagnosticRelatedInformation {
location: Location { location: Location {
uri: Url { uri: Url {
@ -55,7 +210,7 @@
}, },
}, },
}, },
message: "Exact error occurred here", message: "Error originated from macro call here",
}, },
], ],
), ),
@ -64,41 +219,4 @@
}, },
fixes: [], fixes: [],
}, },
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/data.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 79,
character: 15,
},
end: Position {
line: 79,
character: 41,
},
},
severity: Some(
Error,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: None,
tags: None,
data: None,
},
fixes: [],
},
] ]

101
crates/rust-analyzer/src/diagnostics/to_proto.rs
View file

@ -34,22 +34,14 @@ fn diagnostic_severity(
Some(res) Some(res)
} }
/// Check whether a file name is from macro invocation /// Checks whether a file name is from macro invocation and does not refer to an actual file.
fn is_from_macro(file_name: &str) -> bool { fn is_dummy_macro_file(file_name: &str) -> bool {
// FIXME: current rustc does not seem to emit `<macro file>` files anymore?
file_name.starts_with('<') && file_name.ends_with('>') file_name.starts_with('<') && file_name.ends_with('>')
} }
/// Converts a Rust span to a LSP location, resolving macro expansion site if neccesary
fn location(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location {
let mut span = span.clone();
while let Some(expansion) = span.expansion {
span = expansion.span;
}
return location_naive(workspace_root, &span);
}
/// Converts a Rust span to a LSP location /// Converts a Rust span to a LSP location
fn location_naive(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location { fn location(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location {
let file_name = workspace_root.join(&span.file_name); let file_name = workspace_root.join(&span.file_name);
let uri = url_from_abs_path(&file_name); let uri = url_from_abs_path(&file_name);
@ -62,7 +54,25 @@ fn location_naive(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Lo
lsp_types::Location { uri, range } lsp_types::Location { uri, range }
} }
/// Converts a secondary Rust span to a LSP related inflocation(ormation /// Extracts a suitable "primary" location from a rustc diagnostic.
///
/// This takes locations pointing into the standard library, or generally outside the current
/// workspace into account and tries to avoid those, in case macros are involved.
fn primary_location(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location {
let span_stack = std::iter::successors(Some(span), |span| Some(&span.expansion.as_ref()?.span));
for span in span_stack.clone() {
let abs_path = workspace_root.join(&span.file_name);
if !is_dummy_macro_file(&span.file_name) && abs_path.starts_with(workspace_root) {
return location(workspace_root, span);
}
}
// Fall back to the outermost macro invocation if no suitable span comes up.
let last_span = span_stack.last().unwrap();
location(workspace_root, last_span)
}
/// Converts a secondary Rust span to a LSP related information
/// ///
/// If the span is unlabelled this will return `None`. /// If the span is unlabelled this will return `None`.
fn diagnostic_related_information( fn diagnostic_related_information(
@ -231,7 +241,7 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
primary_spans primary_spans
.iter() .iter()
.flat_map(|primary_span| { .flat_map(|primary_span| {
let location = location(workspace_root, &primary_span); let primary_location = primary_location(workspace_root, &primary_span);
let mut message = message.clone(); let mut message = message.clone();
if needs_primary_span_label { if needs_primary_span_label {
@ -243,31 +253,47 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
// Each primary diagnostic span may result in multiple LSP diagnostics. // Each primary diagnostic span may result in multiple LSP diagnostics.
let mut diagnostics = Vec::new(); let mut diagnostics = Vec::new();
let mut related_macro_info = None; let mut related_info_macro_calls = vec![];
// If error occurs from macro expansion, add related info pointing to // If error occurs from macro expansion, add related info pointing to
// where the error originated // where the error originated
// Also, we would generate an additional diagnostic, so that exact place of macro // Also, we would generate an additional diagnostic, so that exact place of macro
// will be highlighted in the error origin place. // will be highlighted in the error origin place.
if !is_from_macro(&primary_span.file_name) && primary_span.expansion.is_some() { let span_stack = std::iter::successors(Some(*primary_span), |span| {
let in_macro_location = location_naive(workspace_root, &primary_span); Some(&span.expansion.as_ref()?.span)
});
for (i, span) in span_stack.enumerate() {
if is_dummy_macro_file(&span.file_name) {
continue;
}
// Add related information for the main disagnostic. // First span is the original diagnostic, others are macro call locations that
related_macro_info = Some(lsp_types::DiagnosticRelatedInformation { // generated that code.
location: in_macro_location.clone(), let is_in_macro_call = i != 0;
message: "Error originated from macro here".to_string(),
let secondary_location = location(workspace_root, &span);
if secondary_location == primary_location {
continue;
}
related_info_macro_calls.push(lsp_types::DiagnosticRelatedInformation {
location: secondary_location.clone(),
message: if is_in_macro_call {
"Error originated from macro call here".to_string()
} else {
"Actual error occurred here".to_string()
},
}); });
// For the additional in-macro diagnostic we add the inverse message pointing to the error location in code. // For the additional in-macro diagnostic we add the inverse message pointing to the error location in code.
let information_for_additional_diagnostic = let information_for_additional_diagnostic =
vec![lsp_types::DiagnosticRelatedInformation { vec![lsp_types::DiagnosticRelatedInformation {
location: location.clone(), location: primary_location.clone(),
message: "Exact error occurred here".to_string(), message: "Exact error occurred here".to_string(),
}]; }];
let diagnostic = lsp_types::Diagnostic { let diagnostic = lsp_types::Diagnostic {
range: in_macro_location.range, range: secondary_location.range,
severity, // downgrade to hint if we're pointing at the macro
severity: Some(lsp_types::DiagnosticSeverity::Hint),
code: code.clone().map(lsp_types::NumberOrString::String), code: code.clone().map(lsp_types::NumberOrString::String),
code_description: code_description.clone(), code_description: code_description.clone(),
source: Some(source.clone()), source: Some(source.clone()),
@ -276,9 +302,8 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
tags: if tags.is_empty() { None } else { Some(tags.clone()) }, tags: if tags.is_empty() { None } else { Some(tags.clone()) },
data: None, data: None,
}; };
diagnostics.push(MappedRustDiagnostic { diagnostics.push(MappedRustDiagnostic {
url: in_macro_location.uri, url: secondary_location.uri,
diagnostic, diagnostic,
fixes: Vec::new(), fixes: Vec::new(),
}); });
@ -286,23 +311,25 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
// Emit the primary diagnostic. // Emit the primary diagnostic.
diagnostics.push(MappedRustDiagnostic { diagnostics.push(MappedRustDiagnostic {
url: location.uri.clone(), url: primary_location.uri.clone(),
diagnostic: lsp_types::Diagnostic { diagnostic: lsp_types::Diagnostic {
range: location.range, range: primary_location.range,
severity, severity,
code: code.clone().map(lsp_types::NumberOrString::String), code: code.clone().map(lsp_types::NumberOrString::String),
code_description: code_description.clone(), code_description: code_description.clone(),
source: Some(source.clone()), source: Some(source.clone()),
message, message,
related_information: if subdiagnostics.is_empty() { related_information: {
None let info = related_info_macro_calls
} else {
let mut related = subdiagnostics
.iter() .iter()
.map(|sub| sub.related.clone()) .cloned()
.chain(subdiagnostics.iter().map(|sub| sub.related.clone()))
.collect::<Vec<_>>(); .collect::<Vec<_>>();
related.extend(related_macro_info); if info.is_empty() {
Some(related) None
} else {
Some(info)
}
}, },
tags: if tags.is_empty() { None } else { Some(tags.clone()) }, tags: if tags.is_empty() { None } else { Some(tags.clone()) },
data: None, data: None,
@ -314,7 +341,7 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
// This is useful because they will show up in the user's editor, unlike // This is useful because they will show up in the user's editor, unlike
// `related_information`, which just produces hard-to-read links, at least in VS Code. // `related_information`, which just produces hard-to-read links, at least in VS Code.
let back_ref = lsp_types::DiagnosticRelatedInformation { let back_ref = lsp_types::DiagnosticRelatedInformation {
location, location: primary_location,
message: "original diagnostic".to_string(), message: "original diagnostic".to_string(),
}; };
for sub in &subdiagnostics { for sub in &subdiagnostics {