improve error to string

Author: andrieshiemstra

CHANGELOG.md

@@ -1,6 +1,14 @@
+# 0.15.7
+
+* updated error handling / toString (include cause and such)
+
+# 0.15.6
+
+* minor textual update to unhandled promise rejection logging
+
 # 0.15.5
 
-* unhandled promise rejection stacktrace fixed (typescript transpiled) 
+* unhandled promise rejection stacktrace fixed (typescript transpiled)
 
 # 0.15.4
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "quickjs_runtime"
-version = "0.15.6"
+version = "0.15.7"
 authors = ["Andries Hiemstra <[email protected]>"]
 edition = "2021"
 description = "Wrapper API and utils for the QuickJS JavaScript engine with support for Promise, Modules, Async/await"
@@ -56,7 +56,7 @@ anyhow = "1"
 swc = { version = "=35.0.0", optional = true }
 swc_config = { version = "=3.1.2", optional = true }
 swc_config_macro = { version = "=1.0.1", optional = true }
-swc_ecma_ast = { version = "=15.0.0", features = ["serde-impl"] , optional=true}
+swc_ecma_ast = { version = "=15.0.0", features = ["serde-impl"], optional = true }
 swc_atoms = { version = "=7.0.0", optional = true }
 swc_cached = { version = "=2.0.0", optional = true }
 swc_eq_ignore_macros = { version = "=1.0.1", optional = true }
@@ -65,8 +65,8 @@ swc_common = { version = "=14.0.4", optional = true, features = ["tty-emitter"]
 swc_ecma_codegen = { version = "=17.0.0", optional = true }
 swc_ecma_codegen_macros = { version = "=2.0.2", optional = true }
 swc_ecma_loader = { version = "=14.0.0", optional = true }
-swc_ecma_lexer = { version="=23.0.1" , optional=true}
-swc_ecma_parser = {version="=23.0.0", optional=true}
+swc_ecma_lexer = { version = "=23.0.1", optional = true }
+swc_ecma_parser = { version = "=23.0.0", optional = true }
 swc_ecma_transforms_base = { version = "=25.0.0", features = ["inline-helpers"], optional = true }
 swc_ecma_transforms_classes = { version = "=25.0.0", optional = true }
 swc_ecma_transforms_compat = { version = "=27.0.0", optional = true }

src/jsutils/mod.rs

@@ -3,6 +3,7 @@
 //! The facade classes are for use outside the worker thread, they are Send
 //!
 
+use crate::values::JsValueFacade;
 use backtrace::Backtrace;
 use std::fmt::{Debug, Display, Error, Formatter};
 
@@ -58,6 +59,7 @@ pub struct JsError {
     name: String,
     message: String,
     stack: String,
+    cause: Option<Box<JsValueFacade>>,
 }
 
 impl JsError {
@@ -66,6 +68,15 @@ impl JsError {
             name,
             message,
             stack,
+            cause: None,
+        }
+    }
+    pub fn new2(name: String, message: String, stack: String, cause: JsValueFacade) -> Self {
+        Self {
+            name,
+            message,
+            stack,
+            cause: Some(Box::new(cause)),
         }
     }
     pub fn new_str(err: &str) -> Self {
@@ -77,6 +88,7 @@ impl JsError {
             name: "Error".to_string(),
             message: err,
             stack: format!("{bt:?}"),
+            cause: None,
         }
     }
     pub fn get_message(&self) -> &str {
@@ -88,6 +100,9 @@ impl JsError {
     pub fn get_name(&self) -> &str {
         self.name.as_str()
     }
+    pub fn get_cause(&self) -> &Option<Box<JsValueFacade>> {
+        &self.cause
+    }
 }
 
 impl std::error::Error for JsError {
@@ -98,7 +113,7 @@ impl std::error::Error for JsError {
 
 impl From<anyhow::Error> for JsError {
     fn from(err: anyhow::Error) -> Self {
-        JsError::new_string(err.to_string())
+        JsError::new_string(format!("{err:?}"))
     }
 }
 impl std::fmt::Display for JsError {
@@ -110,7 +125,7 @@ impl std::fmt::Display for JsError {
 
 impl From<Error> for JsError {
     fn from(e: Error) -> Self {
-        JsError::new_string(format!("{e}"))
+        JsError::new_string(format!("{e:?}"))
     }
 }
 

src/quickjs_utils/errors.rs

@@ -24,10 +24,12 @@ pub unsafe fn get_exception(context: *mut q::JSContext) -> Option<JsError> {
         } else if exception_ref.is_object() {
             error_to_js_error(context, &exception_ref)
         } else {
-            JsError::new_string(format!(
-                "no clue what happened {}",
-                exception_ref.get_js_type()
-            ))
+            match exception_ref.to_string() {
+                Ok(s) => JsError::new_string(s),
+                Err(ex) => {
+                    JsError::new_string(format!("Could not determine error due to error: {ex:?}"))
+                }
+            }
         };
         Some(err)
     }
@@ -74,7 +76,24 @@ pub unsafe fn error_to_js_error(
         stack_string.push_str(stack_str.as_str());
     }
 
-    JsError::new(name_string, message_string, stack_string)
+    let cause_ref = objects::get_property(context, exception_ref, "cause")
+        .ok()
+        .unwrap();
+    // add cause as cause but also extend the stack trace with the cause stack trace
+
+    if cause_ref.is_null_or_undefined() {
+        JsError::new(name_string, message_string, stack_string)
+    } else {
+        QuickJsRealmAdapter::with_context(context, |realm| {
+            let cause_str = cause_ref.to_string().ok().unwrap();
+            let cause_jsvf = realm.to_js_value_facade(&cause_ref).ok().unwrap();
+
+            stack_string.push_str("Caused by: ");
+            stack_string.push_str(cause_str.as_str());
+
+            JsError::new2(name_string, message_string, stack_string, cause_jsvf)
+        })
+    }
 }
 
 /// Create a new Error object
@@ -185,6 +204,44 @@ pub mod tests {
         assert_eq!(ex.get_message(), "__c_v__ is not defined");
     }
 
+    #[test]
+    fn test_ex_cause() {
+        // check if stacktrace is preserved when invoking native methods
+
+        let rt = init_test_rt();
+        let res = rt.eval_sync(
+            None,
+            Script::new(
+                "ex.ts",
+                r#"
+                let a = 2;
+                let b = 3;
+                type Foo = {
+                    a: number
+                }
+                function f1(a, b) {
+                    throw new Error('Could not f1', { cause: 'Sabotage here' });
+                }
+                function f2() {
+                    try {
+                        let r = f1(a, b);
+                    } catch(ex) {
+                        throw new Error('could not f2', { cause: ex});
+                    }
+                }
+                f2()
+                "#,
+            ),
+        );
+        let ex = res.expect_err("script should have failed;");
+
+        assert_eq!(ex.get_message(), "could not f2");
+
+        let complete_err = format!("{ex}");
+        assert!(complete_err.contains("Caused by: Error: Could not f1"));
+        assert!(complete_err.contains("Caused by: Sabotage here"));
+    }
+
     #[test]
     fn test_ex0() {
         // check if stacktrace is preserved when invoking native methods