Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the trust model and panics in the codebase. #282

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the trust model and panics in the codebase. #282

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions DEVELOPMENT.md
View file
Open in desktop
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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional: "[...] incorrectly serialized parameters" -> "incorrectly serialized parameters in callbacks from the host"
(to make directionality clearer)

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
Loading