feat: support guided panic info with backtrace (#2097)

* feat: support guided panic info with backtrace

* chore: changeset

* feat: wording

* chore: clippy

* chore: lint

Author: h-a-n-a

.changeset/slow-trains-melt.md

@@ -0,0 +1,5 @@
+---
+"@rspack/binding": patch
+---
+
+feat: support guided panic info with backtrace

crates/rspack_error/src/catch_unwind.rs

@@ -1,4 +1,5 @@
 use std::{
+  cell::RefCell,
   future::Future,
   pin::Pin,
   task::{Context, Poll},
@@ -42,33 +43,65 @@ pub mod PanicStrategy {
 
 #[inline]
 fn panic_hook_handler<S: PanicStrategy::S, R>(f: impl FnOnce() -> R) -> R {
-  let prev_hook = if S::is_suppressed() {
-    let prev = Some(std::panic::take_hook());
-    std::panic::set_hook(Box::new(|_| {}));
-    prev
-  } else {
-    None
-  };
+  PANIC_HOOK.with(|hook| {
+    if !S::is_suppressed() {
+      *hook.borrow_mut() = Some(std::panic::take_hook());
+    }
+  });
+  std::panic::set_hook(Box::new(move |info| {
+    PANIC_HOOK.with(|hook| {
+      if let Some(hook) = &*hook.borrow() {
+        hook(info);
+      }
+    });
+    PANIC_INFO_AND_BACKTRACE.with(|bt| {
+      *bt.borrow_mut() = Some((
+        info.to_string(),
+        std::backtrace::Backtrace::force_capture().to_string(),
+      ));
+    });
+  }));
   let result = f();
-  if let Some(prev_hook) = prev_hook {
-    std::panic::set_hook(prev_hook);
-  }
+  PANIC_HOOK.with(|hook| {
+    if let Some(hook) = hook.borrow_mut().take() {
+      std::panic::set_hook(hook);
+    }
+  });
 
   result
 }
 
+type PanicHook = Box<dyn Fn(&std::panic::PanicInfo<'_>) + 'static + Sync + Send>;
+
+thread_local! {
+  static PANIC_INFO_AND_BACKTRACE: RefCell<Option<(String, String)>> = RefCell::new(None);
+  static PANIC_HOOK: RefCell<Option<PanicHook>> = RefCell::new(None);
+}
+
 pub fn catch_unwind<S: PanicStrategy::S, R>(f: impl FnOnce() -> R) -> Result<R> {
   match panic_hook_handler::<S, _>(move || {
     std::panic::catch_unwind(std::panic::AssertUnwindSafe(f))
   }) {
     Ok(res) => Ok(res),
-    Err(cause) => match cause.downcast_ref::<&'static str>() {
-      None => match cause.downcast_ref::<String>() {
-        None => Err(internal_error!("Unknown panic message")),
-        Some(message) => Err(internal_error!("{message}")),
-      },
-      Some(message) => Err(internal_error!("{message}")),
-    },
+    Err(cause) => {
+      let (info, backtrace) = PANIC_INFO_AND_BACKTRACE
+        .with(|b| b.borrow_mut().take())
+        .unwrap_or_default();
+
+      match cause.downcast_ref::<&'static str>() {
+        None => match cause.downcast_ref::<String>() {
+          None => Err(internal_error!(
+            "Unknown fatal error.\nRaw: {info}\n{GENERIC_FATAL_MESSAGE}\n\n{backtrace}"
+          )),
+          Some(message) => Err(internal_error!(
+            "{message}.\nRaw: {info}\n{GENERIC_FATAL_MESSAGE}\n\n{backtrace}"
+          )),
+        },
+        Some(message) => Err(internal_error!(
+          "{message}.\nRaw: {info}\n{GENERIC_FATAL_MESSAGE}\n\n{backtrace}"
+        )),
+      }
+    }
   }
 }
 
@@ -95,3 +128,6 @@ impl<F: Future + Send + 'static> Future for CatchUnwindFuture<F> {
     }
   }
 }
+
+const GENERIC_FATAL_MESSAGE: &str =
+  "This is not expected, please file an issue at https://github.com/web-infra-dev/rspack/issues.";

crates/rspack_error/src/lib.rs

@@ -1,3 +1,4 @@
+#![feature(let_chains)]
 #![feature(anonymous_lifetime_in_impl_trait)]
 
 mod catch_unwind;