Skip to content

Commit

Permalink
Document the trust model and panics in the codebase.
Browse files Browse the repository at this point in the history
Signed-off-by: Piotr Sikora <[email protected]>
  • Loading branch information
PiotrSikora committed Oct 28, 2024
1 parent 6d88ed5 commit 5e46d91
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Development

## Proxy-Wasm ABI compliance & trust model

It is expected that the host environment is completely trusted and compliant
with the [Proxy-Wasm ABI specification] (currently v0.2.1).

This means that receiving unexpected callback, status, lifecycle flow and/or
incorrectly serialized parameters is considered a permanent failure and will
result in a `panic`.

## Testing

GitHub Actions can be executed locally using the [`act`] tool.
Expand Down Expand Up @@ -28,5 +37,6 @@ bazelisk run //bazel/cargo:crates_vendor -- --repin all
```


[Proxy-Wasm ABI specification]: https://github.com/proxy-wasm/spec
[`act`]: https://github.com/nektos/act
[`bazelisk`]: https://github.com/bazelbuild/bazelisk

0 comments on commit 5e46d91

Please sign in to comment.