GEN-35: error-stack implement serde hooks

libs/error-stack/Cargo.toml

@@ -18,10 +18,12 @@ keywords = ["error", "errorstack", "error-handling", "report", "no_std"]
 categories = ["rust-patterns", "no-std"]
 
 [dependencies]
+tracing-core = { version = "0.1", optional = true, default_features = false }
 tracing-error = { version = "0.2", optional = true, default_features = false }
 anyhow = { version = "1.0.65", default-features = false, optional = true }
 eyre = { version = "0.6", default-features = false, optional = true }
 serde = { version = "1", default-features = false, optional = true }
+erased-serde = { version = "0.3.23", default-features = false, optional = true, features = ['alloc'] }
 spin = { version = "0.9", default-features = false, optional = true, features = ['rwlock', 'once'] }
 
 [dev-dependencies]
@@ -46,10 +48,10 @@ rustc_version = "0.4"
 [features]
 default = ["std"]
 
-spantrace = ["dep:tracing-error", "std"]
+spantrace = ["dep:tracing-error", "dep:tracing-core", "std"]
 std = ["anyhow?/std"]
 eyre = ["dep:eyre", "std"]
-serde = ["dep:serde"]
+serde = ["dep:serde", "dep:erased-serde"]
 hooks = ['dep:spin']
 
 [package.metadata.docs.rs]
@@ -72,8 +74,3 @@ required-features = ["std"]
 [[example]]
 name = "detect"
 required-features = ['std']
-
-
-[[test]]
-name = "common"
-test = false

libs/error-stack/Makefile.toml

@@ -7,9 +7,9 @@ CARGO_TEST_HACK_FLAGS = { source = "${GITHUB_EVENT_NAME}", default_value = "${CO
 CARGO_INSTA_TEST_FLAGS = "--no-fail-fast"
 CARGO_RUSTDOC_HACK_FLAGS = ""
 CARGO_DOC_HACK_FLAGS = ""
-# The only features that are of relevance are: spantrace, std, hooks
+# The only features that are of relevance are: spantrace, pretty-print, std, hooks, serde
 # all others do not change the output
-CARGO_INSTA_TEST_HACK_FLAGS = "--keep-going --feature-powerset --include-features spantrace,std,hooks"
+CARGO_INSTA_TEST_HACK_FLAGS = "--keep-going --feature-powerset --include-features spantrace,std,hooks,serde"
 
 # Workaround for https://github.com/taiki-e/cargo-hack/issues/161
 # instead, we should pass `--ignore-unknown-features` to `cargo hack`

libs/error-stack/src/fmt.rs

@@ -144,7 +144,7 @@
 
 mod charset;
 mod color;
-mod config;
+pub(crate) mod config;
 #[cfg(any(feature = "std", feature = "hooks"))]
 mod hook;
 mod location;
@@ -169,7 +169,7 @@ pub use color::ColorMode;
 #[cfg(any(feature = "std", feature = "hooks"))]
 pub use hook::HookContext;
 #[cfg(any(feature = "std", feature = "hooks"))]
-pub(crate) use hook::{install_builtin_hooks, Format, Hooks};
+pub(crate) use hook::{install_builtin_debug_hooks, FmtHooks, Format};
 #[cfg(not(any(feature = "std", feature = "hooks")))]
 use location::LocationDisplay;
 
@@ -649,7 +649,7 @@ fn debug_context(context: &dyn Context, mode: ColorMode) -> Lines {
         .collect()
 }
 
-struct Opaque(usize);
+pub(crate) struct Opaque(usize);
 
 impl Opaque {
     const fn new() -> Self {
@@ -675,7 +675,7 @@ impl Opaque {
     }
 }
 
-fn debug_attachments_invoke<'a>(
+pub(crate) fn debug_attachments_invoke<'a>(
     frames: impl IntoIterator<Item = &'a Frame>,
     config: &mut Config,
 ) -> (Opaque, Vec<String>) {

libs/error-stack/src/fmt/hook.rs

@@ -6,9 +6,12 @@
 use alloc::{boxed::Box, string::String, vec::Vec};
 use core::{any::TypeId, mem};
 
-pub(crate) use default::install_builtin_hooks;
+pub(crate) use default::install_builtin_debug_hooks;
 
-use crate::fmt::{charset::Charset, ColorMode, Frame};
+use crate::{
+    fmt::{charset::Charset, ColorMode, Frame},
+    hook::context::impl_hook_context,
+};
 
 pub(crate) struct Format {
     alternate: bool,
@@ -42,7 +45,7 @@ impl Format {
     }
 }
 
-crate::hook::context::impl_hook_context! {
+impl_hook_context! {
     /// Carrier for contextual information used across hook invocations.
     ///
     /// `HookContext` has two fundamental use-cases:
@@ -418,14 +421,14 @@ fn into_boxed_hook<T: Send + Sync + 'static>(
 /// [`SpanTrace`]: tracing_error::SpanTrace
 /// [`Display`]: core::fmt::Display
 /// [`Debug`]: core::fmt::Debug
-/// [`.insert()`]: Hooks::insert
-pub(crate) struct Hooks {
+/// [`.insert()`]: FmtHooks::insert
+pub(crate) struct FmtHooks {
     // We use `Vec`, instead of `HashMap` or `BTreeMap`, so that ordering is consistent with the
     // insertion order of types.
     pub(crate) inner: Vec<(TypeId, BoxedHook)>,
 }
 
-impl Hooks {
+impl FmtHooks {
     pub(crate) fn insert<T: Send + Sync + 'static>(
         &mut self,
         hook: impl Fn(&T, &mut HookContext<T>) + Send + Sync + 'static,
@@ -472,7 +475,7 @@ mod default {
         Report,
     };
 
-    pub(crate) fn install_builtin_hooks() {
+    pub(crate) fn install_builtin_debug_hooks() {
         // We could in theory remove this and replace it with a single AtomicBool.
         static INSTALL_BUILTIN: Once = Once::new();
 

libs/error-stack/src/hook.rs

@@ -2,8 +2,10 @@ pub(crate) mod context;
 
 use alloc::vec::Vec;
 
+#[cfg(feature = "serde")]
+use crate::serde::{install_builtin_serde_hooks, SerdeHooks, SerializeFn};
 use crate::{
-    fmt::{install_builtin_hooks, Hooks},
+    fmt::{install_builtin_debug_hooks, FmtHooks},
     Report,
 };
 
@@ -15,7 +17,9 @@ type RwLock<T> = std::sync::RwLock<T>;
 #[cfg(all(not(feature = "std"), feature = "hooks"))]
 type RwLock<T> = spin::rwlock::RwLock<T>;
 
-static FMT_HOOK: RwLock<Hooks> = RwLock::new(Hooks { inner: Vec::new() });
+static FMT_HOOK: RwLock<FmtHooks> = RwLock::new(FmtHooks { inner: Vec::new() });
+#[cfg(feature = "serde")]
+static SERDE_HOOK: RwLock<SerdeHooks> = RwLock::new(SerdeHooks::new());
 
 impl Report<()> {
     /// Can be used to globally set a [`Debug`] format hook, for a specific type `T`.
@@ -153,7 +157,7 @@ impl Report<()> {
     pub fn install_debug_hook<T: Send + Sync + 'static>(
         hook: impl Fn(&T, &mut crate::fmt::HookContext<T>) + Send + Sync + 'static,
     ) {
-        install_builtin_hooks();
+        install_builtin_debug_hooks();
 
         #[cfg(feature = "std")]
         let mut lock = FMT_HOOK.write().expect("should not be poisoned");
@@ -169,8 +173,8 @@ impl Report<()> {
     ///
     /// [`install_debug_hook`]: Self::install_debug_hook
     #[cfg(any(feature = "std", feature = "hooks"))]
-    pub(crate) fn invoke_debug_format_hook<T>(closure: impl FnOnce(&Hooks) -> T) -> T {
-        install_builtin_hooks();
+    pub(crate) fn invoke_debug_format_hook<T>(closure: impl FnOnce(&FmtHooks) -> T) -> T {
+        install_builtin_debug_hooks();
 
         #[cfg(feature = "std")]
         let hook = FMT_HOOK.read().expect("should not be poisoned");
@@ -181,4 +185,53 @@ impl Report<()> {
 
         closure(&hook)
     }
+
+    // TODO: upcoming PR will add documentation
+    #[allow(missing_docs)]
+    #[cfg(all(any(feature = "std", feature = "hooks"), feature = "serde"))]
+    pub fn install_serde_hook<T: serde::Serialize + Send + Sync + 'static>() {
+        install_builtin_serde_hooks();
+
+        #[cfg(feature = "std")]
+        let mut lock = SERDE_HOOK.write().expect("should not be poisoned");
+
+        // The spin RwLock cannot panic
+        #[cfg(all(not(feature = "std"), feature = "hooks"))]
+        let mut lock = SERDE_HOOK.write();
+
+        lock.insert_static::<T>();
+    }
+
+    // TODO: upcoming PR will add documentation
+    #[allow(missing_docs)]
+    #[cfg(all(any(feature = "std", feature = "hooks"), feature = "serde"))]
+    pub fn install_custom_serde_hook<T>(closure: impl for<'a> SerializeFn<'a, T>)
+    where
+        T: Send + Sync + 'static,
+    {
+        install_builtin_serde_hooks();
+
+        #[cfg(feature = "std")]
+        let mut lock = SERDE_HOOK.write().expect("should not be poisoned");
+
+        // The spin RwLock cannot panic
+        #[cfg(all(not(feature = "std"), feature = "hooks"))]
+        let mut lock = SERDE_HOOK.write();
+
+        lock.insert_dynamic(closure);
+    }
+
+    #[cfg(all(any(feature = "std", feature = "hooks"), feature = "serde"))]
+    pub(crate) fn invoke_serde_hook<T>(closure: impl FnOnce(&SerdeHooks) -> T) -> T {
+        install_builtin_serde_hooks();
+
+        #[cfg(feature = "std")]
+        let hook = SERDE_HOOK.read().expect("should not be poisoned");
+
+        // The spin RwLock cannot panic
+        #[cfg(all(not(feature = "std"), feature = "hooks"))]
+        let hook = SERDE_HOOK.read();
+
+        closure(&hook)
+    }
 }

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

@@ -59,7 +59,7 @@ impl<T> Inner<T> {
 }
 
 macro_rules! impl_hook_context {
-    ($(#[$meta:meta])* $vis:vis struct HookContext<$extra:ident> {..}) => {
+    ($(#[$meta:meta])* $vis:vis struct HookContext<$extra:ty> { .. }) => {
 
 // TODO: add link to serde hooks once implemented
 // TODO: ideally we would want to make `HookContextInner` private, as it is an implementation

libs/error-stack/src/lib.rs

@@ -476,6 +476,8 @@ pub mod iter;
 
 mod compat;
 mod frame;
+#[cfg(any(feature = "std", feature = "hooks"))]
+mod hook;
 mod macros;
 mod report;
 mod result;
@@ -484,10 +486,8 @@ mod context;
 #[cfg(any(nightly, feature = "std"))]
 mod error;
 pub mod fmt;
-#[cfg(any(feature = "std", feature = "hooks"))]
-mod hook;
 #[cfg(feature = "serde")]
-mod serde;
+pub mod serde;
 
 pub use self::{
     compat::IntoReportCompat,