Group related diagnostics visually

Cargo.toml

@@ -35,6 +35,7 @@ indenter = "0.3.0"
 rustversion = "1.0"
 trybuild = { version = "1.0.19", features = ["diff"] }
 syn = { version = "1.0", features = ["full"] }
+pretty_assertions = "1.2.1"
 
 [features]
 default = []

miette-derive/src/diagnostic_source.rs

@@ -59,7 +59,8 @@ impl DiagnosticSource {
                     };
                     quote! {
                         Self::#ident #display_pat => {
-                            std::option::Option::Some(#rel.as_ref())
+                            use std::borrow::Borrow;
+                            std::option::Option::Some(#rel.borrow())
                         }
                     }
                 })
@@ -71,7 +72,8 @@ impl DiagnosticSource {
         let rel = &self.0;
         Some(quote! {
             fn diagnostic_source<'a>(&'a self) -> std::option::Option<&'a dyn miette::Diagnostic> {
-                std::option::Option::Some(&self.#rel)
+                use std::borrow::Borrow;
+                std::option::Option::Some(self.#rel.borrow())
             }
         })
     }

src/handlers/graphical.rs

@@ -2,7 +2,7 @@ use std::fmt::{self, Write};
 
 use owo_colors::{OwoColorize, Style};
 
-use crate::diagnostic_chain::DiagnosticChain;
+use crate::diagnostic_chain::{DiagnosticChain, ErrorKind};
 use crate::handlers::theme::*;
 use crate::protocol::{Diagnostic, Severity};
 use crate::{LabeledSpan, MietteError, ReportHandler, SourceCode, SourceSpan, SpanContents};
@@ -133,7 +133,6 @@ impl GraphicalReportHandler {
         diagnostic: &(dyn Diagnostic),
     ) -> fmt::Result {
         self.render_header(f, diagnostic)?;
-        writeln!(f)?;
         self.render_causes(f, diagnostic)?;
         let src = diagnostic.source_code();
         self.render_snippets(f, diagnostic, src)?;
@@ -172,13 +171,15 @@ impl GraphicalReportHandler {
             );
             write!(header, "{}", link)?;
             writeln!(f, "{}", header)?;
+            writeln!(f)?;
         } else if let Some(code) = diagnostic.code() {
             write!(header, "{}", code.style(severity_style),)?;
             if self.links == LinkStyle::Text && diagnostic.url().is_some() {
                 let url = diagnostic.url().unwrap(); // safe
                 write!(header, " ({})", url.style(self.theme.styles.link))?;
             }
             writeln!(f, "{}", header)?;
+            writeln!(f)?;
         }
         Ok(())
     }
@@ -231,7 +232,21 @@ impl GraphicalReportHandler {
                 let opts = textwrap::Options::new(width)
                     .initial_indent(&initial_indent)
                     .subsequent_indent(&rest_indent);
-                writeln!(f, "{}", textwrap::fill(&error.to_string(), opts))?;
+                match error {
+                    ErrorKind::Diagnostic(diag) => {
+                        let mut inner = String::new();
+
+                        // Don't print footer for inner errors
+                        let mut inner_renderer = self.clone();
+                        inner_renderer.footer = None;
+                        inner_renderer.render_report(&mut inner, diag)?;
+
+                        writeln!(f, "{}", textwrap::fill(&inner, opts))?;
+                    }
+                    ErrorKind::StdError(err) => {
+                        writeln!(f, "{}", textwrap::fill(&err.to_string(), opts))?;
+                    }
+                }
             }
         }
 
@@ -257,20 +272,47 @@ impl GraphicalReportHandler {
         parent_src: Option<&dyn SourceCode>,
     ) -> fmt::Result {
         if let Some(related) = diagnostic.related() {
-            writeln!(f)?;
-            for rel in related {
+            let related: Vec<_> = related.collect();
+            writeln!(
+                f,
+                "{}{}There were {} related diagnostics:",
+                if related.is_empty() {
+                    self.theme.characters.lcross
+                } else {
+                    self.theme.characters.ltop
+                },
+                self.theme.characters.hbar,
+                related.len()
+            )?;
+            let width = self.termwidth.saturating_sub(2);
+            let mut inner = String::new();
+            for (idx, rel) in related.into_iter().enumerate() {
+                let init_ident = format!(
+                    "{}{} {}.",
+                    self.theme.characters.lcross,
+                    self.theme.characters.hbar,
+                    idx + 1
+                );
+                let subseq_ident = format!("{} ", self.theme.characters.vbar);
+                let opts = textwrap::Options::new(width)
+                    .initial_indent(&init_ident)
+                    .subsequent_indent(&subseq_ident);
                 match diagnostic.severity() {
-                    Some(Severity::Error) | None => write!(f, "Error: ")?,
-                    Some(Severity::Warning) => write!(f, "Warning: ")?,
-                    Some(Severity::Advice) => write!(f, "Advice: ")?,
+                    Some(Severity::Error) | None => write!(&mut inner, "Error: ")?,
+                    Some(Severity::Warning) => write!(&mut inner, "Warning: ")?,
+                    Some(Severity::Advice) => write!(&mut inner, "Advice: ")?,
                 };
-                self.render_header(f, rel)?;
-                writeln!(f)?;
-                self.render_causes(f, rel)?;
+                self.render_header(&mut inner, rel)?;
+                writeln!(&mut inner)?;
+                self.render_causes(&mut inner, rel)?;
                 let src = rel.source_code().or(parent_src);
-                self.render_snippets(f, rel, src)?;
-                self.render_footer(f, rel)?;
-                self.render_related(f, rel, src)?;
+                self.render_snippets(&mut inner, rel, src)?;
+                self.render_footer(&mut inner, rel)?;
+                self.render_related(&mut inner, rel, src)?;
+
+                writeln!(f, "{}", textwrap::fill(&inner, opts))?;
+
+                inner.clear();
             }
         }
         Ok(())

tests/graphical.rs

@@ -5,6 +5,7 @@ use miette::{
     NarratableReportHandler, Report, SourceSpan,
 };
 use thiserror::Error;
+use pretty_assertions::assert_eq;
 
 fn fmt_report(diag: Report) -> String {
     let mut out = String::new();
@@ -784,11 +785,22 @@ fn related() -> Result<(), MietteError> {
     let err = MyBad {
         src: NamedSource::new("bad_file.rs", src.clone()),
         highlight: (9, 4).into(),
-        related: vec![MyBad {
-            src: NamedSource::new("bad_file.rs", src),
-            highlight: (0, 6).into(),
-            related: vec![],
-        }],
+        related: vec![
+            MyBad {
+                src: NamedSource::new("bad_file.rs", src.clone()),
+                highlight: (0, 6).into(),
+                related: vec![MyBad {
+                    src: NamedSource::new("bad_file.rs", src.clone()),
+                    highlight: (0, 6).into(),
+                    related: vec![],
+                }],
+            },
+            MyBad {
+                src: NamedSource::new("bad_file.rs", src.clone()),
+                highlight: (0, 6).into(),
+                related: vec![],
+            },
+        ],
     };
     let out = fmt_report(err.into());
     println!("Error: {}", out);
@@ -803,18 +815,46 @@ fn related() -> Result<(), MietteError> {
  3 │     here
    ╰────
   help: try doing it better next time?
-
-Error: oops::my::bad
-
-  × oops!
-   ╭─[bad_file.rs:1:1]
- 1 │ source
-   · ───┬──
-   ·    ╰── this bit here
- 2 │   text
-   ╰────
-  help: try doing it better next time?
-
+╭─There were 2 related diagnostics:
+├─ 1.Error: oops::my::bad
+│ 
+│ 
+│   × oops!
+│    ╭─[bad_file.rs:1:1]
+│  1 │ source
+│    · ───┬──
+│    ·    ╰── this bit here
+│  2 │   text
+│    ╰────
+│   help: try doing it better next time?
+│ ╭─There were 1 related diagnostics:
+│ ├─ 1.Error: oops::my::bad
+│ │
+│ │
+│ │   × oops!
+│ │    ╭─[bad_file.rs:1:1]
+│ │  1 │ source
+│ │    · ───┬──
+│ │    ·    ╰── this bit here
+│ │  2 │   text
+│ │    ╰────
+│ │   help: try doing it better next time?
+│ │ ├─There were 0 related diagnostics:
+│ │
+│ 
+├─ 2.Error: oops::my::bad
+│ 
+│ 
+│   × oops!
+│    ╭─[bad_file.rs:1:1]
+│  1 │ source
+│    · ───┬──
+│    ·    ╰── this bit here
+│  2 │   text
+│    ╰────
+│   help: try doing it better next time?
+│ ├─There were 0 related diagnostics:
+│ 
 "#
     .trim_start()
     .to_string();
@@ -865,16 +905,18 @@ fn related_source_code_propagation() -> Result<(), MietteError> {
  3 │     here
    ╰────
   help: try doing it better next time?
-
-Error: oops::my::bad
-
-  × oops!
-   ╭─[bad_file.rs:1:1]
- 1 │ source
-   · ───┬──
-   ·    ╰── this bit here
- 2 │   text
-   ╰────
+╭─There were 1 related diagnostics:
+├─ 1.Error: oops::my::bad
+│ 
+│ 
+│   × oops!
+│    ╭─[bad_file.rs:1:1]
+│  1 │ source
+│    · ───┬──
+│    ·    ╰── this bit here
+│  2 │   text
+│    ╰────
+│ 
 "#
     .trim_start()
     .to_string();
@@ -900,8 +942,7 @@ fn zero_length_eol_span() {
     let out = fmt_report(err.into());
     println!("Error: {}", out);
 
-    let expected = r#"
-  × oops!
+    let expected = r#"  × oops!
    ╭─[issue:1:1]
  1 │ this is the first line
  2 │ this is the second line

tests/test_diagnostic_source_macro.rs

@@ -1,20 +1,103 @@
 use miette::Diagnostic;
 
+#[derive(Debug, miette::Diagnostic, thiserror::Error)]
+#[error("A complex error happened")]
+struct SourceError {
+    #[source_code]
+    code: String,
+    #[help]
+    help: String,
+    #[label("here")]
+    label: (usize, usize),
+}
+
 #[derive(Debug, miette::Diagnostic, thiserror::Error)]
 #[error("AnErr")]
 struct AnErr;
 
 #[derive(Debug, miette::Diagnostic, thiserror::Error)]
 #[error("TestError")]
-struct TestError {
+struct TestStructError {
     #[diagnostic_source]
     asdf_inner_foo: AnErr,
 }
 
+#[derive(Debug, miette::Diagnostic, thiserror::Error)]
+#[error("TestError")]
+enum TestEnumError {
+    Without,
+    WithTuple(#[diagnostic_source] AnErr),
+    WithStruct {
+        #[diagnostic_source]
+        inner: AnErr,
+    },
+}
+
+#[derive(Debug, miette::Diagnostic, thiserror::Error)]
+#[error("TestError")]
+struct TestTupleError(#[diagnostic_source] AnErr);
+
+#[derive(Debug, miette::Diagnostic, thiserror::Error)]
+#[error("TestError")]
+struct TestBoxedError(#[diagnostic_source] Box<dyn Diagnostic>);
+
+#[derive(Debug, miette::Diagnostic, thiserror::Error)]
+#[error("TestError")]
+struct TestArcedError(#[diagnostic_source] std::sync::Arc<dyn Diagnostic>);
+
 #[test]
 fn test_diagnostic_source() {
-    let error = TestError {
+    let error = TestStructError {
         asdf_inner_foo: AnErr,
     };
     assert!(error.diagnostic_source().is_some());
+
+    let error = TestEnumError::Without;
+    assert!(error.diagnostic_source().is_none());
+
+    let error = TestEnumError::WithTuple(AnErr);
+    assert!(error.diagnostic_source().is_some());
+
+    let error = TestEnumError::WithStruct { inner: AnErr };
+    assert!(error.diagnostic_source().is_some());
+
+    let error = TestTupleError(AnErr);
+    assert!(error.diagnostic_source().is_some());
+
+    let error = TestBoxedError(Box::new(AnErr));
+    assert!(error.diagnostic_source().is_some());
+
+    let error = TestArcedError(std::sync::Arc::new(AnErr));
+    assert!(error.diagnostic_source().is_some());
+}
+
+#[test]
+fn test_diagnostic_source_pass_extra_info() {
+    let diag = TestBoxedError(Box::new(SourceError {
+        code: String::from("Hello\nWorld!"),
+        help: format!("Have you tried turning it on and off again?"),
+        label: (1, 4),
+    }));
+    let mut out = String::new();
+    miette::GraphicalReportHandler::new_themed(miette::GraphicalTheme::unicode_nocolor())
+        .with_width(80)
+        .with_footer("this is a footer".into())
+        .render_report(&mut out, &diag)
+        .unwrap();
+    println!("Error: {}", out);
+    let expected = r#"  × TestError
+  ╰─▶   × A complex error happened
+         ╭─[1:1]
+       1 │ Hello
+         ·  ──┬─
+         ·    ╰── here
+       2 │ World!
+         ╰────
+        help: Have you tried turning it on and off again?
+
+
+  this is a footer
+"#
+    .to_string();
+    assert_eq!(expected, out);
 }