Skip to content

Commit

Permalink
update: adding information about new wasm jsexception handling (#4518)
Browse files Browse the repository at this point in the history
* update: adding information about new wasm jsexception handling

* implementing comments for TWr review
  • Loading branch information
daniCsorbaJB authored and sarahhaggarty committed Nov 4, 2024
1 parent ea55677 commit 6abacb5
Showing 1 changed file with 51 additions and 2 deletions.
53 changes: 51 additions & 2 deletions docs/topics/wasm/wasm-js-interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,56 @@ external fun <T : JsAny> processData(data: JsArray<T>): T

## Exception handling

The Kotlin `try-catch` expression can't catch JavaScript exceptions.
You can use Kotlin `try-catch` expression to catch JavaScript exceptions.
However, accessing specific details about the thrown value in Kotlin/Wasm isn’t possible by default.

You can configure the `JsException` type to include the original error message and stack trace from JavaScript.
To do so, add the following compiler flag to your `build.gradle.kts` file:

```kotlin
kotlin {
wasmJs {
compilerOptions {
freeCompilerArgs.add("-Xwasm-attach-js-exception")
}
}
}
```

This behavior depends on the `WebAssembly.JSTag` API, which is only available in certain browsers:

* **Chrome:** Supported from version 115
* **Firefox:** Supported from version 129
* **Safari:** Not yet supported

Here’s an example demonstrating this behavior:

```kotlin
external object JSON {
fun <T: JsAny> parse(json: String): T
}

fun main() {
try {
JSON.parse("an invalid JSON")
} catch (e: JsException) {
println("Thrown value is: ${e.thrownValue}")
// SyntaxError: Unexpected token 'a', "an invalid JSON" is not valid JSON

println("Message: ${e.message}")
// Message: Unexpected token 'a', "an invalid JSON" is not valid JSON

println("Stacktrace:")
// Stacktrace:

// Prints the full JavaScript stack trace
e.printStackTrace()
}
}
```

With the `-Xwasm-attach-js-exception` flag enabled, the `JsException` type provides specific details from the JavaScript error.
Without the flag, `JsException` includes only a generic message stating that an exception was thrown while running JavaScript code.

If you try to use a JavaScript `try-catch` expression to catch Kotlin/Wasm exceptions, it looks like a
generic `WebAssembly.Exception` without directly accessible messages and data.
Expand All @@ -381,7 +430,7 @@ Although Kotlin/Wasm interoperability shares similarities with Kotlin/JS interop
| **Long** | Type corresponds to JavaScript `BigInt`. | Visible as a custom class in JavaScript. |
| **Arrays** | Not supported in interop directly yet. You can use the new `JsArray` type instead. | Implemented as JavaScript arrays. |
| **Other types** | Requires `JsReference<>` to pass Kotlin objects to JavaScript. | Allows the use of non-external Kotlin class types in external declarations. |
| **Exception handling** | Starting from Kotlin 2.0.0, it can catch any JavaScript exception via the `JsException` and `Throwable` types. | Can catch JavaScript `Error` via the `Throwable` type. It can catch any JavaScript exception using the `dynamic` type. |
| **Exception handling** | You can catch any JavaScript exception with the `JsException` and `Throwable` types. | Can catch JavaScript `Error` using the `Throwable` type. It can catch any JavaScript exception using the `dynamic` type. |
| **Dynamic types** | Does not support the `dynamic` type. Use `JsAny` instead (see sample code below). | Supports the `dynamic` type. |

> Kotlin/JS [dynamic type](dynamic-type.md) for interoperability with untyped or loosely typed objects is not
Expand Down

0 comments on commit 6abacb5

Please sign in to comment.