Merge #3564

3564: Better handling of a few kinds of cargo/clippy diagnostics r=matklad a=kiljacken

This was initially supposed to just be a fix for #3433, but I caught a few things that ended up being useful as well.

This PR primarily makes us handle multi-edit fix suggestions properly. Instead of just applying the first fix we apply all the parts of the fix in a single action.

Second up, this PR handles diagnostics with multiple primary spans, f.x. the unused import diagnostic from rustc:
![image](https://user-images.githubusercontent.com/209321/76531793-03269480-6476-11ea-9180-41c0ea705553.png)

The LSP doesn't handle this too well, as it only support a single complete range for each diagnostic, so we get duplicate messages in the problem panel of VSCode:
![image](https://user-images.githubusercontent.com/209321/76531901-29e4cb00-6476-11ea-9746-cd57f8974b85.png)

However, I feel like the improved visual aspect in-editor outweighs the duplication in the problem panel. I'm open to not including the second commit if anybody really doesn't like the idea of duplicate diagnostics in the problem pane.

Fixes #3433
Fixes #3257

Co-authored-by: Emil Lauridsen <mine809@gmail.com>

crates/ra_cargo_watch/src/conv.rs

@@ -8,6 +8,7 @@ use lsp_types::{
     Location, NumberOrString, Position, Range, TextEdit, Url, WorkspaceEdit,
 };
 use std::{
+    collections::HashMap,
     fmt::Write,
     path::{Component, Path, PathBuf, Prefix},
     str::FromStr,
@@ -126,44 +127,34 @@ fn map_rust_child_diagnostic(
     rd: &RustDiagnostic,
     workspace_root: &PathBuf,
 ) -> MappedRustChildDiagnostic {
-    let span: &DiagnosticSpan = match rd.spans.iter().find(|s| s.is_primary) {
+    let spans: Vec<&DiagnosticSpan> = rd.spans.iter().filter(|s| s.is_primary).collect();
-        Some(span) => span,
+    if spans.is_empty() {
-        None => {
         // `rustc` uses these spanless children as a way to print multi-line
         // messages
         return MappedRustChildDiagnostic::MessageLine(rd.message.clone());
     }
-    };
-
-    // If we have a primary span use its location, otherwise use the parent
-    let location = map_span_to_location(&span, workspace_root);
 
+    let mut edit_map: HashMap<Url, Vec<TextEdit>> = HashMap::new();
+    for &span in &spans {
         if let Some(suggested_replacement) = &span.suggested_replacement {
-        // Include our replacement in the title unless it's empty
+            let location = map_span_to_location(span, workspace_root);
-        let title = if !suggested_replacement.is_empty() {
+            let edit = TextEdit::new(location.range, suggested_replacement.clone());
-            format!("{}: '{}'", rd.message, suggested_replacement)
+            edit_map.entry(location.uri).or_default().push(edit);
-        } else {
+        }
-            rd.message.clone()
+    }
-        };
-
-        let edit = {
-            let edits = vec![TextEdit::new(location.range, suggested_replacement.clone())];
-            let mut edit_map = std::collections::HashMap::new();
-            edit_map.insert(location.uri, edits);
-            WorkspaceEdit::new(edit_map)
-        };
 
+    if !edit_map.is_empty() {
         MappedRustChildDiagnostic::SuggestedFix(CodeAction {
-            title,
+            title: rd.message.clone(),
             kind: Some("quickfix".to_string()),
             diagnostics: None,
-            edit: Some(edit),
+            edit: Some(WorkspaceEdit::new(edit_map)),
             command: None,
             is_preferred: None,
         })
     } else {
         MappedRustChildDiagnostic::Related(DiagnosticRelatedInformation {
-            location,
+            location: map_span_to_location(spans[0], workspace_root),
             message: rd.message.clone(),
         })
     }
@@ -189,13 +180,13 @@ pub(crate) struct MappedRustDiagnostic {
 pub(crate) fn map_rust_diagnostic_to_lsp(
     rd: &RustDiagnostic,
     workspace_root: &PathBuf,
-) -> Option<MappedRustDiagnostic> {
+) -> Vec<MappedRustDiagnostic> {
-    let primary_span = rd.spans.iter().find(|s| s.is_primary)?;
+    let primary_spans: Vec<&DiagnosticSpan> = rd.spans.iter().filter(|s| s.is_primary).collect();
-
+    if primary_spans.is_empty() {
-    let location = map_span_to_location(&primary_span, workspace_root);
+        return vec![];
+    }
 
     let severity = map_level_to_severity(rd.level);
-    let mut primary_span_label = primary_span.label.as_ref();
 
     let mut source = String::from("rustc");
     let mut code = rd.code.as_ref().map(|c| c.code.clone());
@@ -208,19 +199,10 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
         }
     }
 
+    let mut needs_primary_span_label = true;
     let mut related_information = vec![];
     let mut tags = vec![];
 
-    // If error occurs from macro expansion, add related info pointing to
-    // where the error originated
-    if !is_from_macro(&primary_span.file_name) && primary_span.expansion.is_some() {
-        let def_loc = map_span_to_location_naive(&primary_span, workspace_root);
-        related_information.push(DiagnosticRelatedInformation {
-            location: def_loc,
-            message: "Error originated from macro here".to_string(),
-        });
-    }
-
     for secondary_span in rd.spans.iter().filter(|s| !s.is_primary) {
         let related = map_secondary_span_to_related(secondary_span, workspace_root);
         if let Some(related) = related {
@@ -240,15 +222,11 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
 
                 // These secondary messages usually duplicate the content of the
                 // primary span label.
-                primary_span_label = None;
+                needs_primary_span_label = false;
             }
         }
     }
 
-    if let Some(primary_span_label) = primary_span_label {
-        write!(&mut message, "\n{}", primary_span_label).unwrap();
-    }
-
     if is_unused_or_unnecessary(rd) {
         tags.push(DiagnosticTag::Unnecessary);
     }
@@ -257,21 +235,45 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
         tags.push(DiagnosticTag::Deprecated);
     }
 
+    primary_spans
+        .iter()
+        .map(|primary_span| {
+            let location = map_span_to_location(&primary_span, workspace_root);
+
+            let mut message = message.clone();
+            if needs_primary_span_label {
+                if let Some(primary_span_label) = &primary_span.label {
+                    write!(&mut message, "\n{}", primary_span_label).unwrap();
+                }
+            }
+
+            // If error occurs from macro expansion, add related info pointing to
+            // where the error originated
+            if !is_from_macro(&primary_span.file_name) && primary_span.expansion.is_some() {
+                let def_loc = map_span_to_location_naive(&primary_span, workspace_root);
+                related_information.push(DiagnosticRelatedInformation {
+                    location: def_loc,
+                    message: "Error originated from macro here".to_string(),
+                });
+            }
+
             let diagnostic = Diagnostic {
                 range: location.range,
                 severity,
-        code: code.map(NumberOrString::String),
+                code: code.clone().map(NumberOrString::String),
-        source: Some(source),
+                source: Some(source.clone()),
                 message,
                 related_information: if !related_information.is_empty() {
-            Some(related_information)
+                    Some(related_information.clone())
                 } else {
                     None
                 },
-        tags: if !tags.is_empty() { Some(tags) } else { None },
+                tags: if !tags.is_empty() { Some(tags.clone()) } else { None },
             };
 
-    Some(MappedRustDiagnostic { location, diagnostic, fixes })
+            MappedRustDiagnostic { location, diagnostic, fixes: fixes.clone() }
+        })
+        .collect()
 }
 
 /// Returns a `Url` object from a given path, will lowercase drive letters if present.

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_clippy_pass_by_ref.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/compiler/mir/tagset.rs",
@@ -63,7 +64,7 @@ MappedRustDiagnostic {
         },
         fixes: [
             CodeAction {
-            title: "consider passing by value instead: \'self\'",
+                title: "consider passing by value instead",
                 kind: Some(
                     "quickfix",
                 ),
@@ -96,4 +97,5 @@ MappedRustDiagnostic {
                 is_preferred: None,
             },
         ],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_handles_macro_location.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/src/main.rs",
@@ -43,4 +44,5 @@ MappedRustDiagnostic {
             tags: None,
         },
         fixes: [],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_macro_compiler_error.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/crates/ra_hir_def/src/data.rs",
@@ -58,4 +59,5 @@ MappedRustDiagnostic {
             tags: None,
         },
         fixes: [],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_multi_line_fix.snap

@@ -0,0 +1,114 @@
+---
+source: crates/ra_cargo_watch/src/conv/test.rs
+expression: diag
+---
+[
+    MappedRustDiagnostic {
+        location: Location {
+            uri: "file:///test/src/main.rs",
+            range: Range {
+                start: Position {
+                    line: 3,
+                    character: 4,
+                },
+                end: Position {
+                    line: 3,
+                    character: 5,
+                },
+            },
+        },
+        diagnostic: Diagnostic {
+            range: Range {
+                start: Position {
+                    line: 3,
+                    character: 4,
+                },
+                end: Position {
+                    line: 3,
+                    character: 5,
+                },
+            },
+            severity: Some(
+                Warning,
+            ),
+            code: Some(
+                String(
+                    "let_and_return",
+                ),
+            ),
+            source: Some(
+                "clippy",
+            ),
+            message: "returning the result of a let binding from a block\n`#[warn(clippy::let_and_return)]` on by default\nfor further information visit https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return",
+            related_information: Some(
+                [
+                    DiagnosticRelatedInformation {
+                        location: Location {
+                            uri: "file:///test/src/main.rs",
+                            range: Range {
+                                start: Position {
+                                    line: 2,
+                                    character: 4,
+                                },
+                                end: Position {
+                                    line: 2,
+                                    character: 30,
+                                },
+                            },
+                        },
+                        message: "unnecessary let binding",
+                    },
+                ],
+            ),
+            tags: None,
+        },
+        fixes: [
+            CodeAction {
+                title: "return the expression directly",
+                kind: Some(
+                    "quickfix",
+                ),
+                diagnostics: None,
+                edit: Some(
+                    WorkspaceEdit {
+                        changes: Some(
+                            {
+                                "file:///test/src/main.rs": [
+                                    TextEdit {
+                                        range: Range {
+                                            start: Position {
+                                                line: 2,
+                                                character: 4,
+                                            },
+                                            end: Position {
+                                                line: 2,
+                                                character: 30,
+                                            },
+                                        },
+                                        new_text: "",
+                                    },
+                                    TextEdit {
+                                        range: Range {
+                                            start: Position {
+                                                line: 3,
+                                                character: 4,
+                                            },
+                                            end: Position {
+                                                line: 3,
+                                                character: 5,
+                                            },
+                                        },
+                                        new_text: "(0..10).collect()",
+                                    },
+                                ],
+                            },
+                        ),
+                        document_changes: None,
+                    },
+                ),
+                command: None,
+                is_preferred: None,
+            },
+        ],
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_rustc_incompatible_type_for_trait.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/compiler/ty/list_iter.rs",
@@ -43,4 +44,5 @@ MappedRustDiagnostic {
             tags: None,
         },
         fixes: [],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_rustc_mismatched_type.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/runtime/compiler_support.rs",
@@ -43,4 +44,5 @@ MappedRustDiagnostic {
             tags: None,
         },
         fixes: [],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_rustc_unused_variable.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/driver/subcommand/repl.rs",
@@ -48,7 +49,7 @@ MappedRustDiagnostic {
         },
         fixes: [
             CodeAction {
-            title: "consider prefixing with an underscore: \'_foo\'",
+                title: "consider prefixing with an underscore",
                 kind: Some(
                     "quickfix",
                 ),
@@ -81,4 +82,5 @@ MappedRustDiagnostic {
                 is_preferred: None,
             },
         ],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/snapshots/ra_cargo_watch__conv__test__snap_rustc_wrong_number_of_parameters.snap

@@ -2,6 +2,7 @@
 source: crates/ra_cargo_watch/src/conv/test.rs
 expression: diag
 ---
+[
     MappedRustDiagnostic {
         location: Location {
             uri: "file:///test/compiler/ty/select.rs",
@@ -62,4 +63,5 @@ MappedRustDiagnostic {
             tags: None,
         },
         fixes: [],
-}
+    },
+]

crates/ra_cargo_watch/src/conv/test.rs

@@ -58,7 +58,7 @@ fn snap_rustc_incompatible_type_for_trait() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -141,7 +141,7 @@ fn snap_rustc_unused_variable() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -266,7 +266,7 @@ fn snap_rustc_wrong_number_of_parameters() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -387,7 +387,7 @@ fn snap_clippy_pass_by_ref() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -431,7 +431,7 @@ fn snap_rustc_mismatched_type() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -703,7 +703,7 @@ fn snap_handles_macro_location() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }
 
@@ -933,6 +933,140 @@ fn snap_macro_compiler_error() {
     );
 
     let workspace_root = PathBuf::from("/test/");
-    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root).expect("couldn't map diagnostic");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
+    insta::assert_debug_snapshot!(diag);
+}
+
+#[test]
+#[cfg(not(windows))]
+fn snap_multi_line_fix() {
+    let diag = parse_diagnostic(
+        r##"{
+            "rendered": "warning: returning the result of a let binding from a block\n --> src/main.rs:4:5\n  |\n3 |     let a = (0..10).collect();\n  |     -------------------------- unnecessary let binding\n4 |     a\n  |     ^\n  |\n  = note: `#[warn(clippy::let_and_return)]` on by default\n  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return\nhelp: return the expression directly\n  |\n3 |     \n4 |     (0..10).collect()\n  |\n\n",
+            "children": [
+                {
+                "children": [],
+                "code": null,
+                "level": "note",
+                "message": "`#[warn(clippy::let_and_return)]` on by default",
+                "rendered": null,
+                "spans": []
+                },
+                {
+                "children": [],
+                "code": null,
+                "level": "help",
+                "message": "for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return",
+                "rendered": null,
+                "spans": []
+                },
+                {
+                "children": [],
+                "code": null,
+                "level": "help",
+                "message": "return the expression directly",
+                "rendered": null,
+                "spans": [
+                    {
+                    "byte_end": 55,
+                    "byte_start": 29,
+                    "column_end": 31,
+                    "column_start": 5,
+                    "expansion": null,
+                    "file_name": "src/main.rs",
+                    "is_primary": true,
+                    "label": null,
+                    "line_end": 3,
+                    "line_start": 3,
+                    "suggested_replacement": "",
+                    "suggestion_applicability": "MachineApplicable",
+                    "text": [
+                        {
+                        "highlight_end": 31,
+                        "highlight_start": 5,
+                        "text": "    let a = (0..10).collect();"
+                        }
+                    ]
+                    },
+                    {
+                    "byte_end": 61,
+                    "byte_start": 60,
+                    "column_end": 6,
+                    "column_start": 5,
+                    "expansion": null,
+                    "file_name": "src/main.rs",
+                    "is_primary": true,
+                    "label": null,
+                    "line_end": 4,
+                    "line_start": 4,
+                    "suggested_replacement": "(0..10).collect()",
+                    "suggestion_applicability": "MachineApplicable",
+                    "text": [
+                        {
+                        "highlight_end": 6,
+                        "highlight_start": 5,
+                        "text": "    a"
+                        }
+                    ]
+                    }
+                ]
+                }
+            ],
+            "code": {
+                "code": "clippy::let_and_return",
+                "explanation": null
+            },
+            "level": "warning",
+            "message": "returning the result of a let binding from a block",
+            "spans": [
+                {
+                "byte_end": 55,
+                "byte_start": 29,
+                "column_end": 31,
+                "column_start": 5,
+                "expansion": null,
+                "file_name": "src/main.rs",
+                "is_primary": false,
+                "label": "unnecessary let binding",
+                "line_end": 3,
+                "line_start": 3,
+                "suggested_replacement": null,
+                "suggestion_applicability": null,
+                "text": [
+                    {
+                    "highlight_end": 31,
+                    "highlight_start": 5,
+                    "text": "    let a = (0..10).collect();"
+                    }
+                ]
+                },
+                {
+                "byte_end": 61,
+                "byte_start": 60,
+                "column_end": 6,
+                "column_start": 5,
+                "expansion": null,
+                "file_name": "src/main.rs",
+                "is_primary": true,
+                "label": null,
+                "line_end": 4,
+                "line_start": 4,
+                "suggested_replacement": null,
+                "suggestion_applicability": null,
+                "text": [
+                    {
+                    "highlight_end": 6,
+                    "highlight_start": 5,
+                    "text": "    a"
+                    }
+                ]
+                }
+            ]
+        }
+        "##,
+    );
+
+    let workspace_root = PathBuf::from("/test/");
+    let diag = map_rust_diagnostic_to_lsp(&diag, &workspace_root);
     insta::assert_debug_snapshot!(diag);
 }

crates/ra_cargo_watch/src/lib.rs

@@ -197,13 +197,12 @@ impl CheckWatcherThread {
             }
 
             CheckEvent::Msg(Message::CompilerMessage(msg)) => {
-                let map_result =
+                let map_result = map_rust_diagnostic_to_lsp(&msg.message, &self.workspace_root);
-                    match map_rust_diagnostic_to_lsp(&msg.message, &self.workspace_root) {
+                if map_result.is_empty() {
-                        Some(map_result) => map_result,
+                    return;
-                        None => return,
+                }
-                    };
 
-                let MappedRustDiagnostic { location, diagnostic, fixes } = map_result;
+                for MappedRustDiagnostic { location, diagnostic, fixes } in map_result {
                     let fixes = fixes
                         .into_iter()
                         .map(|fix| {
@@ -215,6 +214,7 @@ impl CheckWatcherThread {
                         .send(CheckTask::AddDiagnostic { url: location.uri, diagnostic, fixes })
                         .unwrap();
                 }
+            }
 
             CheckEvent::Msg(Message::BuildScriptExecuted(_msg)) => {}
             CheckEvent::Msg(Message::Unknown) => {}