GEN-35: error-stack implement serde hooks

packages/libs/error-stack/Cargo.toml

@@ -17,11 +17,13 @@ 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 }
 owo-colors = { version = "3", default-features = false, optional = true, features = ['supports-colors'] }
 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]
@@ -31,7 +33,7 @@ futures = { version = "0.3.25", default-features = false, features = ["executor"
 trybuild = "1.0.72"
 tracing = "0.1.37"
 tracing-subscriber = "0.3.16"
-insta = { version = "1.22.0", features = ['filters', 'ron'] }
+insta = { version = "1.22.0", features = ['filters', 'json'] }
 regex = "1.7.0"
 expect-test = "1.4.0"
 ansi-to-html = "0.1.2"
@@ -44,10 +46,10 @@ rustc_version = "0.4"
 default = ["std", "pretty-print"]
 
 pretty-print = ["dep:owo-colors"]
-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]
@@ -66,8 +68,3 @@ required-features = ["std"]
 [[example]]
 name = "parse_config"
 required-features = ["std"]
-
-
-[[test]]
-name = "common"
-test = false

packages/libs/error-stack/Makefile.toml

@@ -6,9 +6,9 @@ CARGO_TEST_HACK_FLAGS = "--workspace --optional-deps --feature-powerset --exclud
 CARGO_INSTA_TEST_FLAGS = "--no-fail-fast"
 CARGO_RUSTDOC_HACK_FLAGS = ""
 CARGO_DOC_HACK_FLAGS = ""
-# The only features that are of relevance are: spantrace, pretty-print, 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,pretty-print,std,hooks"
+CARGO_INSTA_TEST_HACK_FLAGS = "--keep-going --feature-powerset --include-features spantrace,pretty-print,std,hooks,serde"
 
 
 [tasks.test]

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

@@ -642,7 +642,7 @@ fn debug_context(context: &dyn Context) -> Lines {
         .collect()
 }
 
-struct Opaque(usize);
+pub(crate) struct Opaque(usize);
 
 impl Opaque {
     const fn new() -> Self {
@@ -668,7 +668,7 @@ impl Opaque {
     }
 }
 
-fn debug_attachments_invoke<'a>(
+pub(crate) fn debug_attachments_invoke<'a>(
     frames: impl IntoIterator<Item = &'a Frame>,
     #[cfg(any(feature = "std", feature = "hooks"))] context: &mut HookContext<Frame>,
 ) -> (Opaque, Vec<String>) {

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

@@ -16,6 +16,8 @@ type RwLock<T> = std::sync::RwLock<T>;
 type RwLock<T> = spin::rwlock::RwLock<T>;
 
 static FMT_HOOK: RwLock<Hooks> = RwLock::new(Hooks { inner: Vec::new() });
+#[cfg(feature = "serde")]
+static SERDE_HOOK: RwLock<crate::serde::Hooks> = RwLock::new(crate::serde::Hooks::new());
 
 impl Report<()> {
     /// Can be used to globally set a [`Debug`] format hook, for a specific type `T`.
@@ -181,4 +183,50 @@ impl Report<()> {
 
         closure(&hook)
     }
+
+    #[cfg(all(any(feature = "std", feature = "hooks"), feature = "serde"))]
+    pub fn install_serde_hook<T: serde::Serialize + Send + Sync + 'static>() {
+        crate::serde::install_builtin_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>();
+    }
+
+    #[cfg(all(any(feature = "std", feature = "hooks"), feature = "serde"))]
+    pub fn install_custom_serde_hook<F, T>(closure: F)
+    where
+        F: for<'a> crate::serde::DynamicFn<'a, T>,
+        T: Send + Sync + 'static,
+    {
+        crate::serde::install_builtin_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(&crate::serde::Hooks) -> T) -> T {
+        crate::serde::install_builtin_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)
+    }
 }

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

@@ -483,7 +483,7 @@ mod fmt;
 #[cfg(any(feature = "std", feature = "hooks"))]
 mod hook;
 #[cfg(feature = "serde")]
-mod serde;
+pub mod serde;
 
 #[cfg(all(doc, any(feature = "std", feature = "hooks")))]
 pub use hook::context::HookContext;