errors.md

description
In this example we'll see how to pattern match for the error and output the error message returned from Wasmer.

⚠️ Handling Errors

There will come a time when running a WebAssembly module will not work, and trying to figure out why it does not work can be a difficult task! In the current MVP of WebAssembly, debugging isn't explicitly defined for runtimes both in and out of the browser. So we'll have to write some error handling code ourselves.

In this example, we will load a WebAssembly module that purposely produces an error in its exported function call. The Host (our Rust application) will pattern match for the error and output the error message returned from Wasmer.

First we are going to want to initialize a new project. To do this we can navigate to our project folder, or create one. In this example, we will create a new project. Lets create it and navigate to it:

{% tabs %} {% tab title="Rust" %} {% hint style="info" %} The final Rust code for this example can be found on Github: errors.rs.

Please take a look at the setup steps for Rust. {% endhint %}

cargo new errors
cd errors

We have to modify Cargo.toml to add the Wasmer dependencies as shown below:

[dependencies]
# The Wasmer API
wasmer = "3.0"

{% endtab %}

{% tab title="Go" %} {% hint style="info" %} The final Go code for this example can be found on Github: errors.go.

Please take a look at the setup steps for Go. {% endhint %}

mkdir wasmer-example-errors
cd wasmer-example-errors
go mod init github.com/$USER/wasmer-example-errors

{% endtab %}

{% tab title="PHP" %} {% hint style="info" %} The final PHP code for this example can be found on Github: errors.go.

Please take a look at the setup steps for PHP. {% endhint %}

mkdir wasmer-example-errors
cd wasmer-example-errors
composer init --name=wasmer-example-errors
composer require wasm/wasm

{% endtab %} {% endtabs %}

Now that we have everything set up, let's go ahead and try it out!

Handling the error

There is nothing special about the Wasm module, or the way we'll set it up.

The only things we'll need to do are:

• Getting the exported function
• Calling the function;
• Handling the error.

Here is the easy part, getting and calling the function:

{% tabs %} {% tab title="Rust" %}

let div_by_zero: TypedFunction<(), i32> = instance
    .exports
    .get_function("div_by_zero")?
    .typed(&mut store)?;
let result = div_by_zero.call(&mut store);

{% endtab %}

{% tab title="Go" %}

divByZero, err := instance.Exports.GetFunction("div_by_zero")

if err != nil {
    panic(fmt.Sprintln("Failed to get the `div_by_zero` function:", err))
}

_, err = divByZero()

{% endtab %}

{% tab title="PHP" %}

$divByZero = (new Wasm\Module\Extern($exports[0]))->asFunc();

{% endtab %} {% endtabs %}

And here is the interesting part, handling the error:

{% tabs %} {% tab title="Rust" %}

match result {
    Ok(_) => {
        panic!("throw_wasm_error did not error");
    },
    Err(e) => {
        println!("Error caught from `div_by_zero`: {}", e.message());

        let frames = e.trace();
        let frames_len = frames.len();

        for i in 0..frames_len {
            println!(
                "  Frame #{}: {:?}::{:?}",
                frames_len - i,
                frames[i].module_name(),
                frames[i].function_name().or(Some("<func>")).unwrap()
            );
        }
    }
}

{% endtab %}

{% tab title="Go" %}

if err == nil {
    panic(fmt.Sprintln("`div_by_zero` did not error"))
}

fmt.Println("Error caught from `div_by_zero`:", err)

trap, ok := err.(*wasmer.TrapError)

if !ok {
    panic(fmt.Sprintln("Error was not of the expected type"))
}

frames := trap.Trace()
framesLen := len(frames)

for index, frame := range frames {
    fmt.Printf(
        "  Frame #%d: function index: %d\n", 
        framesLen - index, 
        frame.FunctionIndex()
    )
}

{% endtab %}

{% tab title="PHP" %}

try {
    $result = $divByZero();

    echo '`div_by_zero` did not error'.PHP_EOL;

    exit(1);
} catch (Exception $exception) {
    echo 'Error caught from `div_by_zero`: '.$exception->getMessage().PHP_EOL;
}

{% endtab %} {% endtabs %}

Here we verify the result of calling the function to see if we actually got an error.

If we got an error we format a nice message containing information to help debug the problem:

• The error message.
• The error trace.

Running

We now have everything we need to run the Wasm module, let's do it!

You should be able to run it using the cargo run command. The output should look like this:

Compiling module...
Instantiating module...
Calling `div_by_zero` function...
Error caught from `div_by_zero`: integer divide by zero
  Frame #2: "<module>"::"do_div_by_zero_f"
  Frame #1: "<module>"::"div_by_zero_f"

{% hint style="info" %} If you want to run the examples from the Wasmer repository codebase directly, you can also do:

git clone https://github.com/wasmerio/wasmer.git
cd wasmer
cargo run --example errors --release --features "cranelift"

{% endhint %}

You should be able to run it using the go run main.go command. The output should look like this:

Compiling module...
Instantiating module...
Calling `div_by_zero` function...
Error caught from `div_by_zero`: integer divide by zero
  Frame #2: function index: 0
  Frame #1: function index: 50

{% hint style="info" %} If you want to run the examples from the Wasmer repository codebase directly, you can also do:

git clone https://github.com/wasmerio/wasmer-go.git
cd wasmer-go
go test examples/example_errors_test.go

{% endhint %}

You should be able to run it using the php errors.php command.

{% hint style="info" %} If you want to run the examples from the Wasmer PHP repository codebase directly, you can also do:

git clone https://github.com/wasmerio/wasmer-php.git
cd wasmer-php
make EXAMPLE=errors test-doc-examples

{% endhint %}