Merge pull request #401 from Shopify/js.return-error-when-module-errors

optionally return non-zero error code when function run sees error

Author: jacobsteves

Cargo.lock

@@ -3,6 +3,7 @@ members = [
   "tests/fixtures/exit_code",
   "tests/fixtures/log_truncation_function",
   "tests/fixtures/exports",
+  "tests/fixtures/noop",
 ]
 
 [package]

Cargo.toml

@@ -136,6 +136,7 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
     let memory_usage: u64;
     let instructions: u64;
     let mut error_logs: String = String::new();
+    let mut module_result: Result<(), anyhow::Error>;
     let profile_data: Option<String>;
 
     {
@@ -158,7 +159,6 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
 
         let func = instance.get_typed_func::<(), ()>(store.as_context_mut(), export)?;
 
-        let module_result;
         (module_result, profile_data) = if let Some(profile_opts) = profile_opts {
             let (result, profile_data) = wasmprof::ProfilerBuilder::new(&mut store)
                 .frequency(profile_opts.interval)
@@ -176,7 +176,7 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
         // modules may exit with a specific exit code, an exit code of 0 is considered success but is reported as
         // a GuestFault by wasmtime, so we need to map it to a success result. Any other exit code is considered
         // a failure.
-        let module_result =
+        module_result =
             module_result.or_else(|error| match error.downcast_ref::<wasi_common::I32Exit>() {
                 Some(I32Exit(0)) => Ok(()),
                 Some(I32Exit(code)) => Err(anyhow!("module exited with code: {}", code)),
@@ -188,7 +188,7 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
 
         match module_result {
             Ok(_) => {}
-            Err(e) => {
+            Err(ref e) => {
                 error_logs = e.to_string();
             }
         }
@@ -234,6 +234,7 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
         output,
         profile: profile_data,
         scale_factor,
+        success: module_result.is_ok(),
     };
 
     Ok(function_run_result)

src/engine.rs

@@ -30,6 +30,7 @@ pub struct FunctionRunResult {
     pub profile: Option<String>,
     #[serde(skip)]
     pub scale_factor: f64,
+    pub success: bool,
 }
 
 const DEFAULT_INSTRUCTIONS_LIMIT: u64 = 11_000_000;
@@ -253,6 +254,7 @@ mod tests {
             })),
             profile: None,
             scale_factor: 1.0,
+            success: true,
         };
 
         let predicate = predicates::str::contains("Instructions: 1.001K")
@@ -284,6 +286,7 @@ mod tests {
             })),
             profile: None,
             scale_factor: 1.0,
+            success: true,
         };
 
         let predicate = predicates::str::contains("Instructions: 1")
@@ -311,6 +314,7 @@ mod tests {
             })),
             profile: None,
             scale_factor: 1.0,
+            success: true,
         };
 
         let predicate = predicates::str::contains("Instructions: 999")

src/function_run_result.rs

@@ -196,5 +196,9 @@ fn main() -> Result<()> {
         std::fs::write(profile_opts.unwrap().out, profile)?;
     }
 
-    Ok(())
+    if function_run_result.success {
+        Ok(())
+    } else {
+        anyhow::bail!("The Function execution failed. Review the logs for more information.")
+    }
 }

src/main.rs

@@ -11,8 +11,8 @@ Example Functions used as test fixtures.
 
 **Rust examples:**
 ```
-cargo wasi build --profile=wasm -p exit_code -p exports -p log_truncation_function &&
-  cp target/wasm32-wasi/wasm/{exit_code.wasm,exports.wasm,log_truncation_function.wasm} tests/fixtures/build
+cargo wasi build --profile=wasm -p exit_code -p exports -p log_truncation_function -p noop &&
+  cp target/wasm32-wasi/wasm/{exit_code.wasm,exports.wasm,log_truncation_function.wasm,noop.wasm} tests/fixtures/build
 ```
 
 **JS examples:**
@@ -31,6 +31,11 @@ js_functions_javy_v1.wasm:
 javy build -C dynamic -C plugin=providers/shopify_functions_javy_v1.wasm -o tests/fixtures/build/js_functions_javy_v1.wasm tests/fixtures/js_function/src/functions.js
 ```
 
+js_function_that_throws.wasm:
+```
+javy build -C dynamic -C plugin=providers/javy_quickjs_provider_v3.wasm -o tests/fixtures/build/js_function_that_throws.wasm tests/fixtures/js_function_that_throws/src/functions.js
+```
+
 **`*.wat` examples:**
 ```
 find tests/fixtures -maxdepth 1 -type f -name "*.wat" \