swc-project / swc

Rust-based platform for the Web
https://swc.rs
Apache License 2.0
31.17k stars 1.23k forks source link

Wasm plugins are not backward compatible #5060

Open kwonoj opened 2 years ago

kwonoj commented 2 years ago

Describe the feature

This is by far the biggest blocker for the official release for the plugin feature. (I thought I filed this already somehow).

The main issue in here is reducing chances of breaking changes for the plugin. There are 3 possible cases which causes diverge between plugins to the host for serialization / deserialization, namely

Each time this happens, the plugin will not be able to run on the newer versions of swc include those changes. These kind of breaking change itself is unavoidable unfortunately, but also we may be able to reduce the chances of it or at least avoid it happening unexpectedly.

We'll attempt to follow versioned struct approach suggested by underlying serialization mechanism (https://github.com/rkyv/rkyv/blob/master/examples/backwards_compat/src/main.rs) with compiler flags. When we need a possible breaking changes it'll be guarded by flags, providing backward compatibility as much as it can. Still worth mentioning this only applies to adding part - removing, or renaming is a clear breaking change we can't avoid to request plugin bumps up with the latest changes. At least, we hope those kind of operation won't happen that frequently.

Babel plugin or link to the feature description

No response

Additional context

https://github.com/swc-project/swc/discussions/3540

thesayyn commented 5 months ago

FWIW, capn solves this is really good way, there's not really a good way to solve this problem other than inventing a clever encoding mechanism like this.

RobinClowers commented 3 months ago

I'm just trying out SWC and this issue is pretty painful for my team. I was excited to find https://github.com/pmndrs/swc-jotai, but then discovered they are pretty far behind on the core version, so to get everything working, I would have to manually downgrade things until I find a set of versions that work together.