Stream: git-wasmtime

Topic: wasmtime / PR #7130 Refactor how `subscribe` works in WASI

Wasmtime GitHub notifications bot (Oct 02 2023 at 20:08):

alexcrichton opened PR #7130 from alexcrichton:refactor-subscribe to bytecodealliance:main:

This commit refactors how the Pollable resource is created in WASI. Previously this was created manually via two variants of a Pollable enum but this was somewhat error prone for a few reasons:

• The more common representation, TableEntry, had boilerplate associated with it that had dynamic downcasts and such. This is now all hidden behind a more typed API.

• Callers had to remember to use push_child_resource which is easy to forget.

• The previous signature of the readiness check returned a Result<()> which made it accidentally easy for errors to be propagated into traps rather than being returned as a "last operation failed" error.

This commit replaces the previous API with a single subscribe function which takes a Resource<T> and returns a Resource<Pollable>. The T type must implement a new trait, Subscribe, which indicates the asynchronous readiness check. This readiness check additionally returns () so it's no longer possible to accidentally return errors (or trap).

This namely required refactoring the HostOutputStream trait and implementations. The trait itself now has a check_write method corresponding to to the same WASI function. The old write_ready function is now a convenience helper combo between ready and check_write. Concrete implementations are refactored to store errors discovered during ready to get communicated through check-write later on.

<!--
Please make sure you include the following information:

• If this work has been discussed elsewhere, please include a link to that
  conversation. If it was discussed in an issue, just mention "issue #...".

• Explain why this change is needed. If the details are in an issue already,
  this can be brief.

Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.html

Please ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->

Wasmtime GitHub notifications bot (Oct 02 2023 at 20:08):

alexcrichton requested pchickey for a review on PR #7130.

Wasmtime GitHub notifications bot (Oct 02 2023 at 20:08):

alexcrichton requested wasmtime-core-reviewers for a review on PR #7130.

Wasmtime GitHub notifications bot (Oct 02 2023 at 22:56):

pchickey requested elliottt for a review on PR #7130.

Wasmtime GitHub notifications bot (Oct 02 2023 at 23:01):

pchickey submitted PR review:

This is a really nice improvement given all the safety changes. Thanks!

Wasmtime GitHub notifications bot (Oct 03 2023 at 01:50):

alexcrichton merged PR #7130.

Last updated: Dec 23 2024 at 13:07 UTC