internal: nicer error reporting

Author: davidbarsky

crates/flycheck/src/json_workspace.rs

@@ -46,15 +46,15 @@ pub struct JsonWorkspaceHandle {
 #[derive(Debug, Clone, Deserialize, Serialize)]
 #[serde(tag = "type")]
 pub enum DiscoverProjectMessage {
-    Error { message: String },
+    Error { message: String, context: Option<String> },
     Progress { message: String },
     Finished { project_json: Vec<ProjectJsonData> },
 }
 
 impl ParseFromLine for DiscoverProjectMessage {
     fn from_line(line: &str, _error: &mut String) -> Option<Self> {
         let Ok(value) = serde_json::from_str::<serde_json::Value>(line) else {
-            return Some(DiscoverProjectMessage::Error { message: line.to_owned() });
+            return Some(DiscoverProjectMessage::Error { message: line.to_owned(), context: None });
         };
 
         if let Ok(project) = serde_json::from_value::<ProjectJsonData>(value.clone()) {
@@ -67,6 +67,15 @@ impl ParseFromLine for DiscoverProjectMessage {
             });
         }
 
+        if let Some(error) = value.pointer("/fields/error") {
+            if let Some(source) = value.pointer("/fields/source") {
+                return Some(DiscoverProjectMessage::Error {
+                    message: error.as_str().unwrap().to_owned(),
+                    context: Some(source.as_str().unwrap().to_owned()),
+                });
+            }
+        }
+
         None
     }
 

crates/rust-analyzer/src/lsp/utils.rs

@@ -80,16 +80,19 @@ impl GlobalState {
         match additional_info {
             Some(additional_info) => {
                 tracing::error!("{}:\n{}", &message, &additional_info);
+                self.show_message(
+                    lsp_types::MessageType::ERROR,
+                    message,
+                    tracing::enabled!(tracing::Level::ERROR),
+                );
             }
             None => {
                 tracing::error!("{}", &message);
+                self.send_notification::<lsp_types::notification::ShowMessage>(
+                    lsp_types::ShowMessageParams { typ: lsp_types::MessageType::ERROR, message },
+                );
             }
         }
-        self.show_message(
-            lsp_types::MessageType::ERROR,
-            message,
-            tracing::enabled!(tracing::Level::ERROR),
-        );
     }
 
     /// rust-analyzer is resilient -- if it fails, this doesn't usually affect

crates/rust-analyzer/src/main_loop.rs

@@ -794,8 +794,9 @@ impl GlobalState {
             flycheck::DiscoverProjectMessage::Progress { message } => {
                 self.report_progress("Buck", Progress::Report, Some(message), None, None)
             }
-            flycheck::DiscoverProjectMessage::Error { message } => {
-                self.show_and_log_error(message.clone(), None);
+            flycheck::DiscoverProjectMessage::Error { message, context } => {
+                let message = format!("Project discovery failed: {message}");
+                self.show_and_log_error(message.clone(), context);
                 self.report_progress("Buck", Progress::End, Some(message), None, None)
             }
         }

crates/rust-analyzer/src/reload.rs

@@ -629,6 +629,7 @@ impl GlobalState {
         let Some((last_op_result, _)) = self.fetch_workspaces_queue.last_op_result() else {
             return Ok(());
         };
+
         if last_op_result.is_empty() {
             stdx::format_to!(buf, "rust-analyzer failed to discover workspace");
         } else {

docs/dev/lsp-extensions.md

@@ -1,5 +1,5 @@
 <!---
-lsp/ext.rs hash: 1babf76a3c2cef3b
+lsp/ext.rs hash: a0cfbd01ed51ad5f
 
 If you need to change the above hash to make the test pass, please check if you
 need to adjust this doc as well and ping this issue: