Skip to content
This repository was archived by the owner on Nov 25, 2025. It is now read-only.

feat: add wasi-0.3.0 draft#164

Merged
sunfishcode merged 7 commits intoWebAssembly:mainfrom
rvolosatovs:feat/0.3.0-draft
Feb 4, 2025
Merged

feat: add wasi-0.3.0 draft#164
sunfishcode merged 7 commits intoWebAssembly:mainfrom
rvolosatovs:feat/0.3.0-draft

Conversation

@rvolosatovs
Copy link
Copy Markdown
Contributor

@rvolosatovs rvolosatovs commented Jan 14, 2025 •
edited
Loading

Refs Ship WASIp3 (view)
Refs WebAssembly/wasi-sockets#111
Refs #156 (change sets seem to be complimentary)

Followed the example of wasi-http and wasi-clocks duplicating the package in a subdirectory

This vendors wasi-clocks from WebAssembly/wasi-clocks#77

  • Remove would-block error code
  • Replace wasi:io/error.error usage by error-context
  • Replace wasi:io/streams.input-stream return values by stream<u8> in return position
  • Replace wasi:io/streams.output-stream return values by stream<u8> in parameter position - Guests should be able to rely on stream.new to construct streams
  • Merge read{,via-stream} into a singular read. Both functions take an offset as a parameter and since they now return stream<u8>, callers can limit the amount of bytes read by using the stream<u8> directly, therefore functionality of both is identical
  • Merge write{,via-stream} into a singular write. Both functions take an offset and stream<u8> as a parameter.

It is assumed that error-context returned by writes to the stream and reads from the stream are sufficient for error handling.

See also

@rvolosatovs
feat: add wasi-0.3.0 draft
d23ba6e 
Followed the example of `wasi-http` and `wasi-clocks` duplicating the
package in a subdirectory

- Remove `would-block` error code
- Replace `wasi:io/error.error` usage by `error-context`
- Replace `wasi:io/streams.input-stream` return values by `stream<u8>`
  in return position
- Replace `wasi:io/streams.output-stream` return values by `stream<u8>`
  in parameter position
     - Guests should be able to rely on `stream.new` to construct
       streams
- Merge `read{,via-stream}` into a singular `read`. Both functions take
  an offset as a parameter and since they now return `stream<u8>`,
  callers can limit the amount of bytes read by using the `stream<u8>`
  directly, therefore functionality of both is identical
- Merge `write{,via-stream}` into a singular `write`. Both functions take
  an offset and `stream<u8>` as a parameter.

It is assumed that `error-context` returned by writes to the stream and
reads from the stream are sufficient for error handling.

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@rvolosatovs rvolosatovs marked this pull request as ready for review January 14, 2025 12:25
@rvolosatovs
Copy link
Copy Markdown
Contributor Author

rvolosatovs commented Jan 14, 2025

Same as in WebAssembly/wasi-sockets#111 (comment), removed the error-context introspection in a separate commit (which can be dropped if desired)

@rvolosatovs
refactor: avoid introspecting error-context
a7b76d0 
This seems to be better aligned with latest specification on error context

https://github.com/WebAssembly/component-model/blob/cbdd15d9033446558571824af52a78022aaa3f58/design/mvp/Explainer.md#error-context-type

> A consequence of this, however, is that components *must not* depend on the
> contents of `error-context` values for behavioral correctness. In particular,
> case analysis of the contents of an `error-context` should not determine
> *error recovery*; explicit `result` or `variant` types must be used in the
> function return type instead (e.g.,
> `(func (result (tuple (stream u8) (future $my-error)))`).

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
ricochet
ricochet reviewed Jan 14, 2025
View reviewed changes
rvolosatovs added a commit to rvolosatovs/wasi-sockets that referenced this pull request Jan 14, 2025
@rvolosatovs
chore: bump @since to 0.3.0
dfc429e 
WebAssembly/wasi-filesystem#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
rvolosatovs added a commit to rvolosatovs/wasi-filesystem that referenced this pull request Jan 14, 2025
@rvolosatovs
chore: bump @since to 0.3.0
0a23094 
WebAssembly#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@rvolosatovs
chore: bump @since to 0.3.0
81bd8bb 
WebAssembly#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
rvolosatovs added a commit to rvolosatovs/wasi-sockets that referenced this pull request Jan 14, 2025
@rvolosatovs
chore: bump @since to 0.3.0
8a3b482 
WebAssembly/wasi-filesystem#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@ricochet ricochet requested a review from sunfishcode January 14, 2025 18:35
@sunfishcode
Copy link
Copy Markdown
Member

sunfishcode commented Jan 15, 2025 •
edited
Loading

Thanks for putting this together! Overall this looks good.

One additional thing we should look into is translating directory-entry-stream into stream<directory-entry>.

Similar to this discussion in wasi-sockets, what would you think about renaming read/write/append back to read-via-stream/write-via-stream/append-via-stream in order to make room for a future read/write that uses newer language features when they become available?

    read: func(
        /// The offset within the file at which to start reading.
        offset: filesize,
    ) -> result<tuple<stream<u8>, future<option<error-code>>>, error-code>;

Could we simplify this interface by eliminating the outer result and error-code here? The way this function works, any implementation is likely going to need to maintain its own cursor, so this function itself doesn't need to do any I/O. It currently does fail if the stream is not readable, but perhaps we could instead have implementations return a closed stream and report it in the future<option<error-code>> instead.

@rvolosatovs
refactor(0.3): simplify error handling
b8a2536 
Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@rvolosatovs
refactor(0.3): asyncify read-directory
8e315f4 
Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@rvolosatovs rvolosatovs force-pushed the feat/0.3.0-draft branch 2 times, most recently from 07e2d44 to eed891a Compare January 17, 2025 09:21
@rvolosatovs
feat: update wit-deps to 0.5.0
70fa400 
Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
@rvolosatovs
drop -draft version suffix
44b42cd 
This ensures that e.g.:

```
wit-bindgen markdown wit-0.3.0-draft -w imports --html-in-md
```

works with wit-bindgen 0.37

refs:
WebAssembly/wasi-sockets@3abda6e

refs:
WebAssembly/wasi-sockets#111 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
This was referenced Jan 17, 2025
Merged
Merged
Merged
@sunfishcode sunfishcode mentioned this pull request Jan 17, 2025
Closed
@rvolosatovs
Copy link
Copy Markdown
Contributor Author

rvolosatovs commented Feb 3, 2025

@sunfishcode could you please take another look at this PR?

@sunfishcode sunfishcode merged commit d6be43f into WebAssembly:main Feb 4, 2025
@sunfishcode
Copy link
Copy Markdown
Member

sunfishcode commented Feb 4, 2025

This looks good. There may be some more details to figure out, but we can iterate from here.

@badeend badeend mentioned this pull request Feb 26, 2025
Merged
yoshuawuyts pushed a commit to yoshuawuyts/WASI that referenced this pull request Nov 25, 2025
@rvolosatovs
feat: add wasi-0.3.0 draft (WebAssembly#164)
d8a20d1 
* feat: add `wasi-0.3.0` draft

Followed the example of `wasi-http` and `wasi-clocks` duplicating the
package in a subdirectory

- Remove `would-block` error code
- Replace `wasi:io/error.error` usage by `error-context`
- Replace `wasi:io/streams.input-stream` return values by `stream<u8>`
  in return position
- Replace `wasi:io/streams.output-stream` return values by `stream<u8>`
  in parameter position
     - Guests should be able to rely on `stream.new` to construct
       streams
- Merge `read{,via-stream}` into a singular `read`. Both functions take
  an offset as a parameter and since they now return `stream<u8>`,
  callers can limit the amount of bytes read by using the `stream<u8>`
  directly, therefore functionality of both is identical
- Merge `write{,via-stream}` into a singular `write`. Both functions take
  an offset and `stream<u8>` as a parameter.

It is assumed that `error-context` returned by writes to the stream and
reads from the stream are sufficient for error handling.

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor: avoid introspecting `error-context`

This seems to be better aligned with latest specification on error context

https://github.com/WebAssembly/component-model/blob/cbdd15d9033446558571824af52a78022aaa3f58/design/mvp/Explainer.md#error-context-type

> A consequence of this, however, is that components *must not* depend on the
> contents of `error-context` values for behavioral correctness. In particular,
> case analysis of the contents of an `error-context` should not determine
> *error recovery*; explicit `result` or `variant` types must be used in the
> function return type instead (e.g.,
> `(func (result (tuple (stream u8) (future $my-error)))`).

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* chore: bump `@since` to `0.3.0`

WebAssembly/wasi-filesystem#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor(0.3): simplify error handling

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* refactor(0.3): asyncify `read-directory`

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* feat: update wit-deps to 0.5.0

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

* drop `-draft` version suffix

This ensures that e.g.:

```
wit-bindgen markdown wit-0.3.0-draft -w imports --html-in-md
```

works with wit-bindgen 0.37

refs:
WebAssembly/wasi-sockets@3abda6e

refs:
WebAssembly/wasi-sockets#111 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>

---------

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
yoshuawuyts pushed a commit to yoshuawuyts/WASI that referenced this pull request Nov 25, 2025
@rvolosatovs
chore: bump @since to 0.3.0
11f3bd4 
WebAssembly/wasi-filesystem#164 (comment)

Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sunfishcode sunfishcode Awaiting requested review from sunfishcode

1 more reviewer

@ricochet ricochet ricochet left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@rvolosatovs rvolosatovs

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rvolosatovs @sunfishcode @ricochet