Add support for WASI p1 plugins to support Rust 1.91.0 (#1067)

* Add support for WASI p1 plugins to support Rust 1.91.0

* Permit StreamIO in P2 target

* Update flake.nix

* Add extern C to WASI p1 exports

* Add unsafe to export name

* Add documentation on stream IO API and WASI

* Fix whitespace

Author: jeffcharles

.cargo/config.toml

@@ -2,6 +2,10 @@
 # Cargo doesn't read directives in individual crates when invoking build
 # commands from the workspace root, hence adding it at the workspace root.
 # https://doc.rust-lang.org/cargo/reference/config.html
+[target.wasm32-wasip1]
+rustflags = ["-C", "target-feature=+simd128"]
+runner = "wasmtime --dir=."
+
 [target.wasm32-wasip2]
 rustflags = ["-C", "target-feature=+simd128"]
 runner = "wasmtime --dir=."

.github/workflows/build-assets.yml

@@ -31,12 +31,12 @@ jobs:
         uses: actions/upload-artifact@v5
         with:
           name: plugin
-          path: target/wasm32-wasip2/release/plugin.wasm
+          path: target/wasm32-wasip1/release/plugin.wasm
 
       - name: Wizen and archive wizened plugin
         run: |
-          cargo run --package=javy-plugin-processing target/wasm32-wasip2/release/plugin.wasm target/wasm32-wasip2/release/plugin_wizened.wasm
-          gzip -k -f target/wasm32-wasip2/release/plugin_wizened.wasm && mv target/wasm32-wasip2/release/plugin_wizened.wasm.gz plugin.wasm.gz
+          cargo run --package=javy-plugin-processing target/wasm32-wasip1/release/plugin.wasm target/wasm32-wasip1/release/plugin_wizened.wasm
+          gzip -k -f target/wasm32-wasip1/release/plugin_wizened.wasm && mv target/wasm32-wasip1/release/plugin_wizened.wasm.gz plugin.wasm.gz
 
       - name: Upload archived plugin to artifacts
         uses: actions/upload-artifact@v5
@@ -124,7 +124,7 @@ jobs:
       - uses: actions/download-artifact@v6
         with:
           name: plugin
-          path: target/wasm32-wasip2/release/
+          path: target/wasm32-wasip1/release/
 
       - name: Build CLI ${{ matrix.os }}
         run: cargo build --release --target ${{ matrix.target }} --package javy-cli

Cargo.lock

@@ -8,6 +8,7 @@ members = [
   "crates/plugin-processing",
   "crates/test-invalid-plugin",
   "crates/test-macros",
+  "crates/test-plugin-wasip1",
   "crates/test-plugin-wasip2",
   "crates/runner",
   "fuzz",
@@ -34,7 +35,6 @@ uuid = { version = "1.18", features = ["v4"] }
 serde = { version = "1.0", default-features = false }
 serde_json = "1.0"
 walrus = "0.24.3"
-wit-bindgen = "0.47.0"
 wasmparser = "0.240.0"
 
 [profile.release]

Cargo.toml

@@ -14,6 +14,16 @@ lint-wasi-targets: fmt-check
 	--exclude=javy-codegen \
 	--exclude=javy-plugin-processing \
 	--exclude=javy-runner \
+	--exclude=javy-test-plugin-wasip2
+	--exclude=javy-fuzz \
+	--target=wasm32-wasip1 --all-targets --all-features -- -D warnings
+	cargo clippy --workspace \
+	--exclude=javy-cli \
+	--exclude=javy-codegen \
+	--exclude=javy-plugin \
+	--exclude=javy-plugin-processing \
+	--exclude=javy-runner \
+	--exclude=javy-test-plugin-wasip1 \
 	--exclude=javy-fuzz \
 	--target=wasm32-wasip2 --all-targets --all-features -- -D warnings
 
@@ -24,6 +34,18 @@ test-wasi-targets:
 	--exclude=javy-plugin-processing \
 	--exclude=javy-runner \
 	--exclude=javy-fuzz \
+	--exclude=javy-test-plugin-wasip1 \
+	--exclude=javy-test-plugin-wasip2 \
+	--exclude=javy-test-invalid-plugin \
+	--target=wasm32-wasip1 --each-feature -- --nocapture
+	cargo hack test --workspace \
+	--exclude=javy-cli \
+	--exclude=javy-codegen \
+	--exclude=javy-plugin \
+	--exclude=javy-plugin-processing \
+	--exclude=javy-runner \
+	--exclude=javy-fuzz \
+	--exclude=javy-test-plugin-wasip1 \
 	--exclude=javy-test-plugin-wasip2 \
 	--exclude=javy-test-invalid-plugin \
 	--target=wasm32-wasip2 --each-feature -- --nocapture
@@ -37,6 +59,7 @@ lint-native-targets: fmt-check build-default-plugin
 	--exclude=javy-plugin-api \
 	--exclude=javy-plugin \
 	--exclude=javy-test-invalid-plugin \
+	--exclude=javy-test-plugin-wasip1 \
 	--exclude=javy-test-plugin-wasip2 \
 	--release --all-targets --all-features -- -D warnings
 
@@ -46,6 +69,7 @@ test-native-targets: build-default-plugin build-test-plugins
 	--exclude=javy-plugin-api \
 	--exclude=javy-plugin \
 	--exclude=javy-test-invalid-plugin \
+	--exclude=javy-test-plugin-wasip1 \
 	--exclude=javy-test-plugin-wasip2 \
 	--release --each-feature -- --nocapture
 
@@ -68,8 +92,12 @@ test-all: wasi-targets native-targets test-wpt
 target/release/javy: build-default-plugin
 	CARGO_PROFILE_RELEASE_LTO=off cargo build -p=javy-cli --release
 
-target/wasm32-wasip2/release/plugin.wasm:
-	cargo build -p=javy-plugin --target=wasm32-wasip2 --release
+target/wasm32-wasip1/release/plugin.wasm:
+	cargo build -p=javy-plugin --target=wasm32-wasip1 --release
+
+target/wasm32-wasip1/release/test_plugin.wasm:
+	cargo build -p=javy-test-plugin-wasip1 --target=wasm32-wasip1 --release
+	cargo run --package=javy-plugin-processing --release -- target/wasm32-wasip1/release/test_plugin.wasm target/wasm32-wasip1/release/test_plugin.wasm
 
 target/wasm32-wasip2/release/test_plugin.wasm:
 	cargo build -p=javy-test-plugin-wasip2 --target=wasm32-wasip2 --release
@@ -81,10 +109,10 @@ target/wasm32-unknown-unknown/release/test_invalid_plugin.wasm:
 cli: target/release/javy
 
 # Build the default plugin
-build-default-plugin: target/wasm32-wasip2/release/plugin.wasm
+build-default-plugin: target/wasm32-wasip1/release/plugin.wasm
 
 # Build auxiliary plugins, for testing
-build-test-plugins: target/wasm32-wasip2/release/plugin.wasm target/wasm32-wasip2/release/test_plugin.wasm target/wasm32-unknown-unknown/release/test_invalid_plugin.wasm
+build-test-plugins: build-default-plugin target/wasm32-wasip1/release/test_plugin.wasm target/wasm32-wasip2/release/test_plugin.wasm target/wasm32-unknown-unknown/release/test_invalid_plugin.wasm
 
 # === Misc ===
 clean:

Makefile

@@ -23,7 +23,6 @@ javy-plugin-processing = { path = "../plugin-processing" }
 
 [dev-dependencies]
 brotli = { workspace = true }
-wasmparser = { workspace = true }
 javy-runner = { path = "../runner/" }
 javy-test-macros = { path = "../test-macros/" }
 wasmtime-wasi = { workspace = true }

crates/cli/Cargo.toml

@@ -34,7 +34,7 @@ fn copy_plugin() -> Result<()> {
         .unwrap()
         .parent()
         .unwrap()
-        .join("target/wasm32-wasip2/release");
+        .join("target/wasm32-wasip1/release");
     let plugin_path = module_path.join("plugin.wasm");
     let plugin_wizened_path = module_path.join("plugin_wizened.wasm");
 

crates/cli/build.rs

@@ -53,10 +53,11 @@ impl<'a> UninitializedPlugin<'a> {
     }
 
     fn validate(plugin_bytes: &'a [u8]) -> Result<()> {
-        let plugin_bytes = match javy_plugin_processing::extract_core_module(plugin_bytes) {
-            Err(e) => bail!("Could not process plugin: {e}"),
-            Ok(plugin_bytes) => plugin_bytes,
-        };
+        let plugin_bytes =
+            match javy_plugin_processing::extract_core_module_if_necessary(plugin_bytes) {
+                Err(e) => bail!("Could not process plugin: {e}"),
+                Ok(plugin_bytes) => plugin_bytes,
+            };
         Plugin::validate(&plugin_bytes)
     }
 }
@@ -74,25 +75,25 @@ mod tests {
         let error = UninitializedPlugin::new(&[]).err().unwrap();
         assert_eq!(
             error.to_string(),
-            "Could not process plugin: Expected Wasm component, received unknown file type"
+            "Could not process plugin: Expected Wasm module or component, received unknown file type"
         );
         Ok(())
     }
 
     #[test]
-    fn test_validate_plugin_with_module() -> Result<()> {
+    fn test_validate_plugin_with_module_with_everything_missing() -> Result<()> {
         let mut module = walrus::Module::with_config(ModuleConfig::default());
         let plugin_bytes = module.emit_wasm();
         let error = UninitializedPlugin::new(&plugin_bytes).err().unwrap();
         assert_eq!(
             error.to_string(),
-            "Could not process plugin: Expected Wasm component, received Wasm module"
+            "Could not process plugin: missing export for function named `initialize-runtime`, missing export for function named `compile-src`, missing export for function named `invoke`, missing exported memory named `memory`, missing custom section named `import_namespace`"
         );
         Ok(())
     }
 
     #[test]
-    fn test_validate_plugin_with_everything_missing() -> Result<()> {
+    fn test_validate_plugin_with_component_with_everything_missing() -> Result<()> {
         let mut empty_module = walrus::Module::with_config(ModuleConfig::default());
         let plugin_bytes = encode_as_component(&empty_module.emit_wasm())?;
         let error = UninitializedPlugin::new(&plugin_bytes).err().unwrap();

crates/cli/src/plugin.rs

@@ -85,11 +85,43 @@ fn test_using_runtime_flag_with_dynamic_triggers_error(builder: &mut Builder) ->
     Ok(())
 }
 
+#[javy_cli_test(dyn = true)]
+fn test_using_wasip1_plugin_with_dynamic_works(builder: &mut Builder) -> Result<()> {
+    let plugin = Plugin::UserWasiP1;
+    let mut runner = builder
+        .plugin(plugin)
+        .preload(plugin.namespace().into(), plugin.path())
+        .input("plugin.js")
+        .build()?;
+
+    let result = runner.exec(vec![]);
+    assert!(result.is_ok(), "Expected ok but got {result:?}");
+
+    Ok(())
+}
+
+#[javy_cli_test(dyn = true)]
+fn test_using_wasip1_plugin_with_export_works(builder: &mut Builder) -> Result<()> {
+    let plugin = Plugin::UserWasiP1;
+    let mut runner = builder
+        .plugin(plugin)
+        .preload(plugin.namespace().into(), plugin.path())
+        .input("plugin-exports.js")
+        .wit("plugin-exports.wit")
+        .world("plugin")
+        .build()?;
+
+    let result = runner.exec_func("fn", vec![]);
+    assert!(result.is_ok(), "Expected ok but got {result:?}");
+
+    Ok(())
+}
+
 #[javy_cli_test(dyn = true)]
 fn test_using_wasip2_plugin_with_dynamic_works(builder: &mut Builder) -> Result<()> {
     let plugin = Plugin::UserWasiP2;
     let mut runner = builder
-        .plugin(Plugin::UserWasiP2)
+        .plugin(plugin)
         .preload(plugin.namespace().into(), plugin.path())
         .input("plugin.js")
         .build()?;
@@ -99,3 +131,20 @@ fn test_using_wasip2_plugin_with_dynamic_works(builder: &mut Builder) -> Result<
 
     Ok(())
 }
+
+#[javy_cli_test(dyn = true)]
+fn test_using_wasip2_plugin_with_export_works(builder: &mut Builder) -> Result<()> {
+    let plugin = Plugin::UserWasiP2;
+    let mut runner = builder
+        .plugin(plugin)
+        .preload(plugin.namespace().into(), plugin.path())
+        .input("plugin-exports.js")
+        .wit("plugin-exports.wit")
+        .world("plugin")
+        .build()?;
+
+    let result = runner.exec_func("fn", vec![]);
+    assert!(result.is_ok(), "Expected ok but got {result:?}");
+
+    Ok(())
+}