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

Author: jacobsteves

src/engine.rs

@@ -234,6 +234,7 @@ pub fn run(params: FunctionRunParams) -> Result<FunctionRunResult> {
         output,
         profile: profile_data,
         scale_factor,
+        success: error_logs.is_empty(),
     };
 
     Ok(function_run_result)

src/function_run_result.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/main.rs

@@ -72,6 +72,10 @@ struct Opts {
     /// Path to graphql file containing Function input query; if omitted, defaults will be used to calculate limits.
     #[clap(short = 'q', long)]
     query_path: Option<PathBuf>,
+
+    /// Return a non-zero exit code when a module error occurs during the function run.
+    #[clap(short = 'n', long)]
+    non_zero_exit_code_for_module_errors: bool,
 }
 
 impl Opts {
@@ -196,5 +200,11 @@ fn main() -> Result<()> {
         std::fs::write(profile_opts.unwrap().out, profile)?;
     }
 
-    Ok(())
+    if function_run_result.success || !opts.non_zero_exit_code_for_module_errors {
+        Ok(())
+    } else {
+        Err(anyhow!(
+            "The Function execution failed. Review the logs for more information."
+        ))
+    }
 }

tests/fixtures/README.md

@@ -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" \

tests/fixtures/build/js_function_that_throws.wasm

@@ -0,0 +1,52 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// node_modules/javy/dist/fs/index.js
+var o = /* @__PURE__ */ ((r) => (r[r.Stdin = 0] = "Stdin", r[r.Stdout = 1] = "Stdout", r[r.Stderr = 2] = "Stderr", r))(o || {});
+function a(r) {
+  let e = new Uint8Array(1024), t = 0;
+  for (; ;) {
+    const i = Javy.IO.readSync(r, e.subarray(t));
+    if (i < 0)
+      throw Error("Error while reading from file descriptor");
+    if (i === 0)
+      return e.subarray(0, t + i);
+    if (t += i, t === e.length) {
+      const n = new Uint8Array(e.length * 2);
+      n.set(e), e = n;
+    }
+  }
+}
+function s(r, e) {
+  for (; e.length > 0;) {
+    const t = Javy.IO.writeSync(r, e);
+    if (t < 0)
+      throw Error("Error while writing to file descriptor");
+    e = e.subarray(t);
+  }
+}
+
+// extensions/volume-js/src/index.js
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+var EMPTY_DISCOUNT = {
+  discountApplicationStrategy: "FIRST" /* First */,
+  discounts: []
+};
+var src_default = (input) => {
+  throw Error("A problem occurred.")
+};
+
+// node_modules/@shopify/shopify_function/index.ts
+var input_data = a(o.Stdin);
+var input_str = new TextDecoder("utf-8").decode(input_data);
+var input_obj = JSON.parse(input_str);
+var output_obj = src_exports?.default(input_obj);
+var output_str = JSON.stringify(output_obj);
+var output_data = new TextEncoder().encode(output_str);
+s(o.Stdout, output_data);

tests/fixtures/js_function_that_throws/src/functions.js

@@ -221,6 +221,43 @@ mod tests {
         Ok(())
     }
 
+    #[test]
+    fn failing_function_without_non_zero_exit_code_for_module_errors_flag(
+    ) -> Result<(), Box<dyn std::error::Error>> {
+        let mut cmd = Command::cargo_bin("function-runner")?;
+        let input_file = temp_input(json!({}))?;
+        cmd.args([
+            "--function",
+            "tests/fixtures/build/js_function_that_throws.wasm",
+        ])
+        .arg("--input")
+        .arg(input_file.as_os_str());
+
+        cmd.assert().success();
+
+        Ok(())
+    }
+
+    #[test]
+    fn failing_function_with_non_zero_exit_code_for_module_errors_flag(
+    ) -> Result<(), Box<dyn std::error::Error>> {
+        let mut cmd = Command::cargo_bin("function-runner")?;
+        let input_file = temp_input(json!({}))?;
+        cmd.args([
+            "--function",
+            "tests/fixtures/build/js_function_that_throws.wasm",
+        ])
+        .arg("--non-zero-exit-code-for-module-errors")
+        .arg("--input")
+        .arg(input_file.as_os_str());
+
+        cmd.assert().failure().stderr(contains(
+            "The Function execution failed. Review the logs for more information.",
+        ));
+
+        Ok(())
+    }
+
     fn profile_base_cmd_in_temp_dir(
     ) -> Result<(Command, assert_fs::TempDir), Box<dyn std::error::Error>> {
         let mut cmd = Command::cargo_bin("function-runner")?;