bytecodealliance / bytecodealliance/component-docs
What changes to WIT are "compatible" and which are not?
- Dominant language
- Rust
- Stars
- 137
- Forks
- 88
- Avg merge
- 5d 12h
- Merged PRs (30d)
- 4
Description
Suppose I have a WIT definition, and some old WebAssembly components built/defined using the old definition, and then I want to make a change to my interface without requiring the component to be modified or rebuilt. Or perhaps I want to do the same in the reverse direction—make a change to my WASM component that remains backward-compatible with a host using an older WIT.
What changes to the WIT could be considered "compatible", if any, and which are not?
In essence, I'm looking for guidance similar to what Protobuf offers in their [Updating a Message Type](https://protobuf.dev/programming-guides/proto3/#updating) documentation.
A few example questions/scenarios I can think of: are the following compatible in one or both directions (old host/new guest vs. new guest/old host)?
1. Removing an argument to a function
2. Adding a new optional argument to a function
3. Adding a new optional field to a struct
4. Removing a field from a struct
5. Adding a new case to a variant
6. Removing a case from a variant
Contributor guide
Assessment
This issue has not been assessed yet.