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.

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

Update docs/stabilization of wasm proposals #9434

Merged

Conversation

alexcrichton
Copy link
Member

This commit updates our documentation and documented status of various WebAssembly proposals. The goal of this commit it to explicitly list all requirements for each WebAssembly proposal in a way such that enabling a feature requires actively checking this table and performing effort to fill in. This is intended to mitigate GHSA-q8hx-mm92-4wvg where it was found that we were accidentally not fuzzing tail calls but had enabled it by default.

This shuffles around some documentation, modernizes a bit, and notably tries to list out a green checkbox or red X for the status of various proposals. Notes for "holes" in the "on by default matrix" are also added.

This commit updates our documentation and documented status of various
WebAssembly proposals. The goal of this commit it to explicitly list all
requirements for each WebAssembly proposal in a way such that enabling a
feature requires actively checking this table and performing effort to
fill in. This is intended to mitigate GHSA-q8hx-mm92-4wvg where it was
found that we were accidentally not fuzzing tail calls but had enabled
it by default.

This shuffles around some documentation, modernizes a bit, and notably
tries to list out a green checkbox or red X for the status of various
proposals. Notes for "holes" in the "on by default matrix" are also
added.
@alexcrichton alexcrichton requested review from a team as code owners October 9, 2024 20:04
@alexcrichton alexcrichton requested review from elliottt and removed request for a team October 9, 2024 20:04
Copy link
Member

@elliottt elliottt left a comment

Choose a reason for hiding this comment

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

This looks good to me!

I wonder if there's a good place for documentation about determining when fuzzing is good enough. Perhaps something as simple as manually injecting todo!() into new implementations so that running the fuzzer locally will panic when exercising the new behavior?

@github-actions github-actions bot added wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime wasmtime:docs Issues related to Wasmtime's documentation labels Oct 9, 2024
Copy link

github-actions bot commented Oct 9, 2024

Label Messager: wasmtime:config

It looks like you are changing Wasmtime's configuration options. Make sure to
complete this check list:

  • If you added a new Config method, you wrote extensive documentation for
    it.

    Our documentation should be of the following form:

    Short, simple summary sentence.
    
    More details. These details can be multiple paragraphs. There should be
    information about not just the method, but its parameters and results as
    well.
    
    Is this method fallible? If so, when can it return an error?
    
    Can this method panic? If so, when does it panic?
    
    # Example
    
    Optional example here.
    
  • If you added a new Config method, or modified an existing one, you
    ensured that this configuration is exercised by the fuzz targets.

    For example, if you expose a new strategy for allocating the next instance
    slot inside the pooling allocator, you should ensure that at least one of our
    fuzz targets exercises that new strategy.

    Often, all that is required of you is to ensure that there is a knob for this
    configuration option in wasmtime_fuzzing::Config (or one
    of its nested structs).

    Rarely, this may require authoring a new fuzz target to specifically test this
    configuration. See our docs on fuzzing for more details.

  • If you are enabling a configuration option by default, make sure that it
    has been fuzzed for at least two weeks before turning it on by default.


To modify this label's message, edit the .github/label-messager/wasmtime-config.md file.

To add new label messages or remove existing label messages, edit the
.github/label-messager.json configuration file.

Learn more.

@alexcrichton
Copy link
Member Author

We had a bunch of discussion today about this as well, but at least by my read there were no firm conclusions. I'm going to try to document better The One Location in fuzzing where proposals are enabled/disabled but beyond that while there was also discussion in the meeting about automatically probing coverage for fuzzers we didn't reach a firm conclusion about how best to do this.

In the meantime I'm going to go ahead and merge this and I'll follow-up with more minor improvements too.

@alexcrichton alexcrichton added this pull request to the merge queue Oct 10, 2024
Merged via the queue into bytecodealliance:main with commit a8998e7 Oct 10, 2024
39 checks passed
@alexcrichton alexcrichton deleted the update-docs-around-features branch October 10, 2024 20:35
@cfallin
Copy link
Member

cfallin commented Oct 10, 2024

We had a bunch of discussion today about this as well, but at least by my read there were no firm conclusions.

Thanks for bringing this up in discussion (and these changes!). To further the discussions around testing our fuzzing, I filed #9449 just now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wasmtime:api Related to the API of the `wasmtime` crate itself wasmtime:config Issues related to the configuration of Wasmtime wasmtime:docs Issues related to Wasmtime's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants