Support related errors in error-stack

packages/libs/error-stack/Cargo.toml

@@ -13,10 +13,11 @@ keywords = ["error", "library", "report", "no_std", "stack"]
 categories = ["rust-patterns", "no-std"]
 
 [dependencies]
-tracing-error = { version = "0.2.0", optional = true }
-once_cell = { version = "1.10.0", optional = true }
-pin-project = { version = "1.0.10", optional = true }
+tracing-error = { version = "0.2.0", optional = true, default_features = false }
+once_cell = { version = "1.10.0", optional = true, default_features = false }
+pin-project = { version = "1.0.10", optional = true, default_features = false }
 futures-core = { version = "0.3.21", optional = true, default-features = false }
+smallvec = { version = "1.9.0", optional = true, default_features = false, features = ['union'] }
 anyhow = { version = "1.0.58", default-features = false, optional = true }
 eyre = { version = "0.6.8", default-features = false, optional = true }
 
@@ -27,16 +28,18 @@ futures = { version = "0.3.21", default-features = false, features = ["executor"
 trybuild = "1.0.63"
 tracing = "0.1.35"
 tracing-subscriber = "0.3.14"
+once_cell = "1.13.0"
 
 [build-dependencies]
 rustc_version = "0.2.3"
 
 [features]
-default = ["std"]
-std = ["anyhow?/std"]
+default = ["std", "small"]
+std = ["anyhow?/std", "once_cell?/std"]
 hooks = ["dep:once_cell", "std"]
 spantrace = ["dep:tracing-error"]
 futures = ["dep:pin-project", "dep:futures-core"]
+small = ["dep:smallvec"]
 
 [package.metadata.docs.rs]
 all-features = true

packages/libs/error-stack/src/compat/anyhow.rs

@@ -1,3 +1,4 @@
+use alloc::boxed::Box;
 #[cfg(nightly)]
 use core::any::Demand;
 use core::{fmt, panic::Location};
@@ -62,33 +63,46 @@ impl<T> IntoReportCompat for core::result::Result<T, AnyhowError> {
         match self {
             Ok(t) => Ok(t),
             Err(anyhow) => {
+                // we cannot use `Report::new()` directly, due to the fact that it captures traces,
+                // regardless of the fact if anyhow already provided one.
+
+                // only capture a backtrace if needed, otherwise the anyhow context provides one
+                #[cfg(all(nightly, feature = "std"))]
+                let backtrace = anyhow
+                    .deref()
+                    .backtrace()
+                    .filter(|bt| matches!(bt.status(), std::backtrace::BacktraceStatus::Captured))
+                    .is_none()
+                    .then(Backtrace::capture)
+                    .filter(|bt| matches!(bt.status(), std::backtrace::BacktraceStatus::Captured));
+
+                #[cfg(feature = "spantrace")]
+                let spantrace = Some(tracing_error::SpanTrace::capture())
+                    .filter(|st| st.status() == tracing_error::SpanTraceStatus::CAPTURED);
+
                 #[cfg(feature = "std")]
                 let sources = anyhow
                     .chain()
                     .skip(1)
                     .map(ToString::to_string)
-                    .collect::<Vec<_>>();
+                    .collect::<alloc::vec::Vec<_>>();
+
+                #[allow(unused_mut)]
+                let mut report = Report::from_frame(Frame::from_context(
+                    AnyhowContext(anyhow),
+                    Location::caller(),
+                    Box::new([]),
+                ));
 
                 #[cfg(all(nightly, feature = "std"))]
-                let backtrace = if anyhow
-                    .deref()
-                    .backtrace()
-                    .filter(|backtrace| backtrace.status() == BacktraceStatus::Captured)
-                    .is_some()
-                {
-                    None
-                } else {
-                    Some(Backtrace::capture())
-                };
-
-                #[cfg_attr(not(feature = "std"), allow(unused_mut))]
-                let mut report = Report::from_frame(
-                    Frame::from_context(AnyhowContext(anyhow), Location::caller(), None),
-                    #[cfg(all(nightly, feature = "std"))]
-                    backtrace,
-                    #[cfg(feature = "spantrace")]
-                    Some(tracing_error::SpanTrace::capture()),
-                );
+                if let Some(backtrace) = backtrace {
+                    report = report.attach(backtrace);
+                }
+
+                #[cfg(feature = "spantrace")]
+                if let Some(spantrace) = spantrace {
+                    report = report.attach(spantrace);
+                }
 
                 #[cfg(feature = "std")]
                 for source in sources {

packages/libs/error-stack/src/compat/eyre.rs

@@ -1,3 +1,4 @@
+use alloc::boxed::Box;
 #[cfg(nightly)]
 use core::any::Demand;
 use core::{fmt, panic::Location};
@@ -61,31 +62,44 @@ impl<T> IntoReportCompat for core::result::Result<T, EyreReport> {
         match self {
             Ok(t) => Ok(t),
             Err(eyre) => {
+                // we cannot use `Report::new()` directly, due to the fact that it captures traces,
+                // regardless of the fact if eyre already provided one.
+
+                // only capture a backtrace if needed, otherwise the eyre context provides one
+                #[cfg(all(nightly, feature = "std"))]
+                let backtrace = eyre
+                    .deref()
+                    .backtrace()
+                    .filter(|bt| matches!(bt.status(), std::backtrace::BacktraceStatus::Captured))
+                    .is_none()
+                    .then(Backtrace::capture)
+                    .filter(|bt| matches!(bt.status(), std::backtrace::BacktraceStatus::Captured));
+
+                #[cfg(feature = "spantrace")]
+                let spantrace = Some(tracing_error::SpanTrace::capture())
+                    .filter(|st| st.status() == tracing_error::SpanTraceStatus::CAPTURED);
+
                 let sources = eyre
                     .chain()
                     .skip(1)
                     .map(alloc::string::ToString::to_string)
                     .collect::<alloc::vec::Vec<_>>();
 
+                let mut report = Report::from_frame(Frame::from_context(
+                    EyreContext(eyre),
+                    Location::caller(),
+                    Box::new([]),
+                ));
+
                 #[cfg(all(nightly, feature = "std"))]
-                let backtrace = if eyre
-                    .deref()
-                    .backtrace()
-                    .filter(|backtrace| backtrace.status() == BacktraceStatus::Captured)
-                    .is_some()
-                {
-                    None
-                } else {
-                    Some(Backtrace::capture())
-                };
-
-                let mut report = Report::from_frame(
-                    Frame::from_context(EyreContext(eyre), Location::caller(), None),
-                    #[cfg(all(nightly, feature = "std"))]
-                    backtrace,
-                    #[cfg(feature = "spantrace")]
-                    Some(tracing_error::SpanTrace::capture()),
-                );
+                if let Some(backtrace) = backtrace {
+                    report = report.attach(backtrace);
+                }
+
+                #[cfg(feature = "spantrace")]
+                if let Some(spantrace) = spantrace {
+                    report = report.attach(spantrace);
+                }
 
                 for source in sources {
                     report = report.attach_printable(source);

packages/libs/error-stack/src/context.rs

@@ -63,7 +63,6 @@ use crate::Report;
 /// # #[cfg(all(feature = "std", not(miri)))]
 /// # assert!(err.contains::<io::Error>());
 /// # assert!(err.contains::<ConfigError>());
-/// # assert_eq!(err.frames().count(), 2);
 /// ```
 pub trait Context: fmt::Display + fmt::Debug + Send + Sync + 'static {
     /// Provide values which can then be requested by [`Report`].

packages/libs/error-stack/src/frame/frame_impl.rs

@@ -37,14 +37,14 @@ pub(super) unsafe trait FrameImpl: 'static {
     /// This corresponds to the `Frame` below this one in a [`Report`].
     ///
     /// [`Report`]: crate::Report
-    fn source(&self) -> Option<&Frame>;
+    fn sources(&self) -> &[Frame];
 
     /// Returns a mutable reference to the source of this `Frame`.
     ///
     /// This corresponds to the `Frame` below this one in a [`Report`].
     ///
     /// [`Report`]: crate::Report
-    fn source_mut(&mut self) -> Option<&mut Frame>;
+    fn sources_mut(&mut self) -> &mut [Frame];
 
     /// Provide values which can then be requested.
     #[cfg(nightly)]
@@ -55,7 +55,7 @@ pub(super) unsafe trait FrameImpl: 'static {
 struct ContextFrame<C> {
     context: C,
     location: &'static Location<'static>,
-    source: Option<Box<Frame>>,
+    sources: Box<[Frame]>,
 }
 
 // SAFETY: `type_id` returns `C` and `C` is the first field in `#[repr(C)]`
@@ -72,12 +72,12 @@ unsafe impl<C: Context> FrameImpl for ContextFrame<C> {
         self.location
     }
 
-    fn source(&self) -> Option<&Frame> {
-        self.source.as_ref().map(Box::as_ref)
+    fn sources(&self) -> &[Frame] {
+        &self.sources
     }
 
-    fn source_mut(&mut self) -> Option<&mut Frame> {
-        self.source.as_mut().map(Box::as_mut)
+    fn sources_mut(&mut self) -> &mut [Frame] {
+        &mut self.sources
     }
 
     #[cfg(nightly)]
@@ -90,7 +90,7 @@ unsafe impl<C: Context> FrameImpl for ContextFrame<C> {
 struct AttachmentFrame<A> {
     attachment: A,
     location: &'static Location<'static>,
-    source: Option<Box<Frame>>,
+    sources: Box<[Frame]>,
 }
 
 // SAFETY: `type_id` returns `A` and `A` is the first field in `#[repr(C)]`
@@ -107,12 +107,12 @@ unsafe impl<A: 'static + Send + Sync> FrameImpl for AttachmentFrame<A> {
         self.location
     }
 
-    fn source(&self) -> Option<&Frame> {
-        self.source.as_ref().map(Box::as_ref)
+    fn sources(&self) -> &[Frame] {
+        &self.sources
     }
 
-    fn source_mut(&mut self) -> Option<&mut Frame> {
-        self.source.as_mut().map(Box::as_mut)
+    fn sources_mut(&mut self) -> &mut [Frame] {
+        &mut self.sources
     }
 
     #[cfg(nightly)]
@@ -125,7 +125,7 @@ unsafe impl<A: 'static + Send + Sync> FrameImpl for AttachmentFrame<A> {
 struct PrintableAttachmentFrame<A> {
     attachment: A,
     location: &'static Location<'static>,
-    source: Option<Box<Frame>>,
+    sources: Box<[Frame]>,
 }
 
 // SAFETY: `type_id` returns `A` and `A` is the first field in `#[repr(C)]`
@@ -142,12 +142,12 @@ unsafe impl<A: 'static + Debug + Display + Send + Sync> FrameImpl for PrintableA
         self.location
     }
 
-    fn source(&self) -> Option<&Frame> {
-        self.source.as_ref().map(Box::as_ref)
+    fn sources(&self) -> &[Frame] {
+        &self.sources
     }
 
-    fn source_mut(&mut self) -> Option<&mut Frame> {
-        self.source.as_mut().map(Box::as_mut)
+    fn sources_mut(&mut self) -> &mut [Frame] {
+        &mut self.sources
     }
 
     #[cfg(nightly)]
@@ -161,7 +161,7 @@ impl Frame {
     pub(crate) fn from_context<C>(
         context: C,
         location: &'static Location<'static>,
-        source: Option<Box<Self>>,
+        sources: Box<[Self]>,
     ) -> Self
     where
         C: Context,
@@ -170,7 +170,7 @@ impl Frame {
             frame: Box::new(ContextFrame {
                 context,
                 location,
-                source,
+                sources,
             }),
         }
     }
@@ -179,7 +179,7 @@ impl Frame {
     pub(crate) fn from_attachment<A>(
         attachment: A,
         location: &'static Location<'static>,
-        source: Option<Box<Self>>,
+        sources: Box<[Self]>,
     ) -> Self
     where
         A: Send + Sync + 'static,
@@ -188,7 +188,7 @@ impl Frame {
             frame: Box::new(AttachmentFrame {
                 attachment,
                 location,
-                source,
+                sources,
             }),
         }
     }
@@ -200,7 +200,7 @@ impl Frame {
     pub(crate) fn from_printable_attachment<A>(
         attachment: A,
         location: &'static Location<'static>,
-        source: Option<Box<Self>>,
+        sources: Box<[Self]>,
     ) -> Self
     where
         A: Display + Debug + Send + Sync + 'static,
@@ -209,7 +209,7 @@ impl Frame {
             frame: Box::new(PrintableAttachmentFrame {
                 attachment,
                 location,
-                source,
+                sources,
             }),
         }
     }

packages/libs/error-stack/src/frame/mod.rs

@@ -31,24 +31,38 @@ impl Frame {
         self.frame.location()
     }
 
+    #[allow(missing_docs)]
+    #[must_use]
+    #[deprecated = "use `sources()` instead"]
+    pub fn source(&self) -> Option<&Self> {
+        self.frame.sources().first()
+    }
+
     /// Returns a shared reference to the source of this `Frame`.
     ///
     /// This corresponds to the `Frame` below this one in a [`Report`].
     ///
     /// [`Report`]: crate::Report
     #[must_use]
-    pub fn source(&self) -> Option<&Self> {
-        self.frame.source()
+    pub fn sources(&self) -> &[Self] {
+        self.frame.sources()
     }
 
-    /// Returns a mutable reference to the source of this `Frame`.
+    #[allow(missing_docs)]
+    #[must_use]
+    #[deprecated = "use `sources_mut()` instead"]
+    pub fn source_mut(&mut self) -> Option<&mut Self> {
+        self.frame.sources_mut().first_mut()
+    }
+
+    /// Returns a mutable reference to the sources of this `Frame`.
     ///
     /// This corresponds to the `Frame` below this one in a [`Report`].
     ///
     /// [`Report`]: crate::Report
     #[must_use]
-    pub fn source_mut(&mut self) -> Option<&mut Self> {
-        self.frame.source_mut()
+    pub fn sources_mut(&mut self) -> &mut [Self] {
+        self.frame.sources_mut()
     }
 
     /// Returns how the `Frame` was created.