Merge pull request #16 from topheman/feat/add-go-support

Add Go Language Support for WebAssembly Component Model Plugins

Author: topheman

.github/workflows/rust-host.yml

@@ -27,6 +27,24 @@ jobs:
           override: true
       - uses: cargo-bins/cargo-binstall@main
       - uses: extractions/setup-just@v3
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.25'
+      - name: Install TinyGo Compiler
+        run: |
+          if [ "${{ runner.arch }}" = "X64" ]; then
+            wget https://github.com/tinygo-org/tinygo/releases/download/v0.39.0/tinygo_0.39.0_amd64.deb
+            sudo dpkg -i tinygo_0.39.0_amd64.deb
+          else
+            wget https://github.com/tinygo-org/tinygo/releases/download/v0.39.0/tinygo_0.39.0_armhf.deb
+            sudo dpkg -i tinygo_0.39.0_armhf.deb
+          fi
+          export PATH=$PATH:/usr/local/bin
+      - name: Check TinyGo Compiler
+        run: tinygo version
+      - name: Install wkg
+        run: cargo binstall wkg
+
       - name: Install cargo-component
         run: cargo binstall cargo-component@0.21.1
       - name: Install wasm-tools

.github/workflows/web-host.yml

@@ -30,6 +30,23 @@ jobs:
           node-version-file: .nvmrc
       - uses: cargo-bins/cargo-binstall@main
       - uses: extractions/setup-just@v3
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '1.25'
+      - name: Install TinyGo Compiler
+        run: |
+          if [ "${{ runner.arch }}" = "X64" ]; then
+            wget https://github.com/tinygo-org/tinygo/releases/download/v0.39.0/tinygo_0.39.0_amd64.deb
+            sudo dpkg -i tinygo_0.39.0_amd64.deb
+          else
+            wget https://github.com/tinygo-org/tinygo/releases/download/v0.39.0/tinygo_0.39.0_armhf.deb
+            sudo dpkg -i tinygo_0.39.0_armhf.deb
+          fi
+          export PATH=$PATH:/usr/local/bin
+      - name: Check TinyGo Compiler
+        run: tinygo version
+      - name: Install wkg
+        run: cargo binstall wkg
       - name: Install cargo-component
         run: cargo binstall cargo-component@0.21.1
       - name: Install wasm-tools

README.md

@@ -23,7 +23,7 @@ There are two kinds of hosts:
 Those hosts then run the same codebase which is compiled to WebAssembly:
 
 - the REPL logic
-- the plugins (made a few in rust, C and TypeScript)
+- the plugins (made a few in rust, C, Go, and TypeScript)
 
 Security model: the REPL cli implements a security model inspired by [deno](https://docs.deno.com/runtime/fundamentals/security/#permissions):
 
@@ -84,6 +84,7 @@ pluginlab\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm\
+  --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm\
   --allow-all
 ```
 
@@ -109,6 +110,7 @@ pluginlab\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm\
+  --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm\
   --allow-all
 [Host] Starting REPL host...
 [Host] Loading REPL logic from: https://topheman.github.io/webassembly-component-model-experiments/plugins/repl_logic_guest.wasm
@@ -119,6 +121,7 @@ pluginlab\
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm
+[Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm
 repl(0)> echo foo
 foo
 repl(0)> echo $ROOT/$USER
@@ -159,6 +162,7 @@ Go check [topheman.github.io/webassembly-component-model-experiments](https://to
 
 - Rust 1.87+
 - Node.js 22.6.0+ (needs `--experimental-strip-types` flag)
+- Go 1.25+
 - [just](https://github.com/casey/just?tab=readme-ov-file#installation)
 
 ### Setup
@@ -199,6 +203,17 @@ cargo binstall wasm-tools@1.235.0
 just dl-wasi-sdk
 ```
 
+#### Go tooling
+
+[From the WebAssembly Component Model section for Go tooling](https://component-model.bytecodealliance.org/language-support/go.html)
+
+- Install [TinyGo](https://tinygo.org/getting-started/install/)
+- Install [wasm-tools](https://github.com/bytecodealliance/wasm-tools) - same as C
+- Install [wkg](https://github.com/bytecodealliance/wasm-pkg-tools)
+  ```bash
+  cargo binstall wkg
+  ```
+
 ### pluginlab (rust) - REPL cli host
 
 #### Build
@@ -226,13 +241,14 @@ This will (see [justfile](./justfile)):
   --plugins ./target/wasm32-wasip1/debug/plugin_cat.wasm\
   --plugins ./target/wasm32-wasip1/debug/plugin_tee.wasm\
   --plugins ./c_modules/plugin-echo/plugin-echo-c.wasm\
+  --plugins ./go_modules/plugin-echo-go/plugin-echo-go.wasm\
   --allow-all
 ```
 
 This will run the `pluginlab` binary which will itself:
 
 - load and compile the `repl_logic_guest.wasm` file inside the embedded `wasmtime` engine injecting the [`host-api`](./crates/pluginlab/wit/host-api.wit) interface
-- load and compile the `plugin_*.wasm` files into the engine, injecting the [`plugin-api`](./crates/pluginlab/wit/plugin-api.wit) interface
+- load and compile the `plugin*.wasm` files passed via `--plugins` into the engine, injecting the [`plugin-api`](./crates/pluginlab/wit/plugin-api.wit) interface
 - launch the REPL loop executing the code from the `repl_logic_guest.wasm` file which will:
   - readline from the user
   - parse the command
@@ -336,7 +352,7 @@ To be sure that the preview server is up and running before running the tests, w
 
 ### plugins
 
-There are currently plugins implemented in 3 languages (most of them are in rust):
+There are currently plugins implemented in 3 languages (most of them are in rust), their toolchain is already setup in the project, you just have to write the plugin code and run `just build`.
 
 #### Rust
 
@@ -346,6 +362,10 @@ You can write plugins in rust in [`crates/plugin-*`](./crates).
 
 You can write plugins in C in [`c_modules/plugin-*`](./c_modules), thanks to `wit-bindgen` (based on [wit-bindgen](https://github.com/bytecodealliance/wit-bindgen)).
 
+#### Go
+
+You can write plugins in Go in [`go_modules/plugin-*`](./go_modules), thanks to [TinyGo Compiler](https://tinygo.org/getting-started/install/).
+
 #### TypeScript
 
 You can also write plugins in TypeScript in [`packages/plugin-*`](./packages), thanks to `jco componentize` (based on [componentize-js](https://github.com/bytecodealliance/componentize-js)).
@@ -383,14 +403,15 @@ When a git tag is pushed, a pre-release is prepared on github, linked to the tag
 
 ```sh
 pluginlab\
-  --repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/repl_logic_guest.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_greet.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_ls.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_echo.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_weather.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_cat.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_tee.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin-echo-c.wasm\
+  --repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/repl_logic_guest.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_greet.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_ls.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_echo.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_weather.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_cat.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_tee.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin-echo-c.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin-echo-go.wasm\
   --allow-all
 ```
 
@@ -444,3 +465,10 @@ cargo binstall cargo-component@0.21.1 wasm-tools@1.235.0 wasm-opt@116
 - [From the WebAssembly Component Model section for C tooling](https://component-model.bytecodealliance.org/language-support/c.html)
 - [WASI SDK](https://github.com/WebAssembly/wasi-sdk)
 - [WIT Bindgen](https://github.com/bytecodealliance/wit-bindgen)
+
+### Go tooling
+
+- [From the WebAssembly Component Model section for Go tooling](https://component-model.bytecodealliance.org/language-support/go.html)
+- [TinyGo Compiler](https://tinygo.org/getting-started/install/)
+- [wasm-tools](https://github.com/bytecodealliance/wasm-tools)
+- [wkg](https://github.com/bytecodealliance/wasm-pkg-tools)

crates/pluginlab/README.md

@@ -18,7 +18,7 @@ There are two kinds of hosts:
 Those hosts then run the same codebase which is compiled to WebAssembly:
 
 - the REPL logic
-- the plugins (made a few in rust, C and TypeScript)
+- the plugins (made a few in rust, C, Go, and TypeScript)
 
 Security model: the REPL cli implements a security model inspired by [deno](https://docs.deno.com/runtime/fundamentals/security/#permissions):
 
@@ -63,6 +63,7 @@ pluginlab\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm\
+  --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm\
   --allow-all
 ```
 
@@ -88,6 +89,7 @@ pluginlab\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm\
   --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm\
+  --plugins https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm\
   --allow-all
 [Host] Starting REPL host...
 [Host] Loading REPL logic from: https://topheman.github.io/webassembly-component-model-experiments/plugins/repl_logic_guest.wasm
@@ -96,6 +98,9 @@ pluginlab\
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_echo.wasm
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_weather.wasm
 [Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_cat.wasm
+[Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin_tee.wasm
+[Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-c.wasm
+[Host] Loading plugin: https://topheman.github.io/webassembly-component-model-experiments/plugins/plugin-echo-go.wasm
 repl(0)> echo foo
 foo
 repl(0)> echo $ROOT/$USER
@@ -135,14 +140,15 @@ The plugins are also versioned in [github releases](https://github.com/topheman/
     <summary>Example of running the CLI host with old versions of the plugins (if you have an old version of <code>pluginlab</code></summary>
     <pre>
 pluginlab\
-  --repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/repl_logic_guest.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_greet.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_ls.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_echo.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_weather.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_cat.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin_tee.wasm\
-  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.0/plugin-echo-c.wasm\
+  --repl-logic https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/repl_logic_guest.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_greet.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_ls.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_echo.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_weather.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_cat.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin_tee.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin-echo-c.wasm\
+  --plugins https://github.com/topheman/webassembly-component-model-experiments/releases/download/pluginlab@0.5.2/plugin-echo-go.wasm\
   --allow-all
     </pre>
 </summary>

crates/pluginlab/tests/e2e_go_plugins.rs

@@ -0,0 +1,62 @@
+mod utils;
+
+#[cfg(test)]
+mod e2e_go_plugins {
+
+    use crate::utils::*;
+
+    use rexpect::spawn;
+
+    const TEST_TIMEOUT: u64 = 10000;
+
+    /**
+     * Lets us change the target directory for the plugins and repl logic.
+     *
+     * See the justfile for examples where we switch to testing both plugins from the filesystem and from the HTTP server.
+     */
+    fn build_command(plugin_files: &[&str], repl_logic_file: &str) -> String {
+        let prefix =
+            std::env::var("WASM_TARGET_DIR").unwrap_or("target/wasm32-wasip1/debug".to_string());
+        let mut command = String::from("target/debug/pluginlab");
+        command.push_str(format!(" --repl-logic {}/{}", prefix, repl_logic_file).as_str());
+        plugin_files.iter().for_each(|file| {
+            command.push_str(format!(" --plugins {}", file).as_str());
+        });
+        println!("Running command: {}", command);
+        command
+    }
+
+    #[test]
+    fn test_echo_plugin() {
+        let project_root = find_project_root();
+        println!("Setting current directory to: {:?}", project_root);
+        std::env::set_current_dir(&project_root).unwrap();
+        let mut session = spawn(
+            &format!(
+                "{} --dir tmp/filesystem --allow-read",
+                &build_command(
+                    &["go_modules/plugin-echo/plugin-echo-go.wasm"],
+                    "repl_logic_guest.wasm"
+                )
+            ),
+            Some(TEST_TIMEOUT),
+        )
+        .expect("Can't launch pluginlab with plugin greet");
+
+        session
+            .exp_string("[Host] Starting REPL host...")
+            .expect("Didn't see startup message");
+        session
+            .exp_string("[Host] Loading plugin:")
+            .expect("Didn't see plugin loading message");
+        session
+            .exp_string("repl(0)>")
+            .expect("Didn't see REPL prompt");
+        session
+            .send_line("echogo hello")
+            .expect("Failed to send command");
+        session
+            .exp_string("hello\r\nrepl(0)>")
+            .expect("Didn't get expected output from echogo plugin");
+    }
+}

crates/pluginlab/wit/plugin-api.wit

@@ -28,6 +28,10 @@ interface host-state-plugin {
 }
 
 world plugin-api {
+  // The wasip2 target of TinyGo assumes that the component is targeting wasi:cli/command@0.2.0 world (part of wasi:cli),
+  // so it needs to include the imports from that world.
+  // It's only included for the versions of the wit files destined for TinyGo.
+  // include wasi:cli/imports@0.2.0; // SPECIFIC TinyGo - DO NOT CHANGE THIS LINE
   import http-client;
   import host-state-plugin;
   export plugin;

go_modules/.gitignore

@@ -0,0 +1 @@
+*.wasm

go_modules/plugin-echo/.gitignore

@@ -0,0 +1,2 @@
+internal
+*.wasm

go_modules/plugin-echo/go.mod

@@ -0,0 +1,21 @@
+module webassembly-repl/plugin-echo
+
+go 1.24
+
+tool go.bytecodealliance.org/cmd/wit-bindgen-go
+
+require (
+	github.com/coreos/go-semver v0.3.1 // indirect
+	github.com/docker/libtrust v0.0.0-20160708172513-aabc10ec26b7 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/regclient/regclient v0.8.3 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tetratelabs/wazero v1.9.0 // indirect
+	github.com/ulikunitz/xz v0.5.12 // indirect
+	github.com/urfave/cli/v3 v3.3.3 // indirect
+	go.bytecodealliance.org v0.7.0 // indirect
+	go.bytecodealliance.org/cm v0.3.0 // indirect
+	golang.org/x/mod v0.24.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+)