Add WASI example for CI. (#411)

* feat: Support WASI target.

* fix: More friendly error message for wasi target.

* fix: Use target_os instead of feature.

* feat: Add an example for gloo-history on WASI.

* fix: Avoid to use web-sys when target os is WASI.

* fix: Exclude WASI example to avoid web-sys.

* ci: Use static download instead of install bash.

* ci: Use CLI's flag instead of exclude example.
bytecodealliance/wasmtime#4312

.github/workflows/tests.yml

@@ -3,7 +3,7 @@ name: Tests
 on:
   pull_request:
   push:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   native_tests:
@@ -119,14 +119,52 @@ jobs:
             wasm-pack test --node crates/$x --no-default-features
           done
 
+  test-history-wasi:
+    name: Test gloo-history WASI
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        rust-version: [1.64, stable, nightly]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust-version }}
+          target: wasm32-wasi
+
+      - name: Install wasmtime
+        run: |
+          wget https://github.com/bytecodealliance/wasmtime/releases/download/v15.0.1/wasmtime-v15.0.1-x86_64-linux.tar.xz
+          tar xf wasmtime-v15.0.1-x86_64-linux.tar.xz
+          mv wasmtime-v15.0.1-x86_64-linux/wasmtime ~/wasmtime
+          rm -rf wasmtime-v15.0.1-x86_64-linux.tar.xz wasmtime-v15.0.1-x86_64-linux
+          chmod +x ~/wasmtime
+
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: cargo-${{ runner.os }}-node-tests-${{ hashFiles('**/Cargo.toml') }}
+          restore-keys: |
+            cargo-${{ runner.os }}-node-tests-
+            cargo-${{ runner.os }}-
+
+      - name: Build and run example history-wasi
+        run: |
+          cargo build --package example-history-wasi --target wasm32-wasi
+          ~/wasmtime --trap-unknown-imports target/wasm32-wasi/debug/example-history-wasi.wasm
+
   test-worker:
     name: Test gloo-worker
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         # example: [ markdown, prime ]
-        example: [ markdown ]
+        example: [markdown]
         rust-version: [1.64, stable, nightly]
     steps:
       - uses: actions/checkout@v4
@@ -167,7 +205,6 @@ jobs:
         run: |
           wasm-pack test --headless --chrome --firefox  examples/${{ matrix.example }}
 
-
   test-net:
     strategy:
       fail-fast: false
@@ -208,9 +245,9 @@ jobs:
 
       - name: Run browser tests
         env:
-          HTTPBIN_URL: "http://localhost:8080"
-          WS_ECHO_SERVER_URL: "ws://localhost:8081"
-          SSE_ECHO_SERVER_URL: "http://localhost:8081/.sse"
+          HTTPBIN_URL: 'http://localhost:8080'
+          WS_ECHO_SERVER_URL: 'ws://localhost:8081'
+          SSE_ECHO_SERVER_URL: 'http://localhost:8081/.sse'
         run: |
           cd crates/net
           wasm-pack test --chrome --firefox --headless --all-features
@@ -222,7 +259,7 @@ jobs:
 
       - name: Run native tests
         env:
-          HTTPBIN_URL: "http://localhost:8080"
-          WS_ECHO_SERVER_URL: "ws://localhost:8081"
-          SSE_ECHO_SERVER_URL: "http://localhost:8081/.sse"
+          HTTPBIN_URL: 'http://localhost:8080'
+          WS_ECHO_SERVER_URL: 'ws://localhost:8081'
+          SSE_ECHO_SERVER_URL: 'http://localhost:8081/.sse'
         run: cargo test -p gloo-net --all-features

Cargo.toml

@@ -77,6 +77,7 @@ members = [
     "examples/markdown",
     "examples/clock",
     "examples/file-hash",
+    "examples/history-wasi",
     "examples/prime",
 ]
 

crates/history/Cargo.toml

@@ -12,15 +12,17 @@ categories = ["api-bindings", "history", "wasm"]
 rust-version = "1.64"
 
 [dependencies]
-wasm-bindgen = "0.2"
 gloo-utils = { version = "0.2.0", path = "../utils" }
 gloo-events = { version = "0.2.0", path = "../events" }
 serde = { version = "1", features = ["derive"] }
 serde-wasm-bindgen = "0.6.0"
 serde_urlencoded = { version = "0.7", optional = true }
 thiserror = { version = "1.0", optional = true }
 
-[dependencies.web-sys]
+[target.'cfg(not(target_os = "wasi"))'.dependencies]
+wasm-bindgen = "0.2"
+
+[target.'cfg(not(target_os = "wasi"))'.dependencies.web-sys]
 version = "0.3"
 features = ["History", "Window", "Location", "Url"]
 

crates/history/src/any.rs

@@ -1,6 +1,8 @@
 use std::borrow::Cow;
 
+#[cfg(not(target_os = "wasi"))]
 use crate::browser::BrowserHistory;
+#[cfg(not(target_os = "wasi"))]
 use crate::hash::HashHistory;
 use crate::history::History;
 use crate::listener::HistoryListener;
@@ -13,8 +15,10 @@ use crate::{error::HistoryResult, query::ToQuery};
 #[derive(Clone, PartialEq, Debug)]
 pub enum AnyHistory {
     /// A Browser History.
+    #[cfg(not(target_os = "wasi"))]
     Browser(BrowserHistory),
     /// A Hash History
+    #[cfg(not(target_os = "wasi"))]
     Hash(HashHistory),
     /// A Memory History
     Memory(MemoryHistory),
@@ -23,31 +27,39 @@ pub enum AnyHistory {
 impl History for AnyHistory {
     fn len(&self) -> usize {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.len(),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.len(),
             Self::Memory(m) => m.len(),
         }
     }
 
     fn go(&self, delta: isize) {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.go(delta),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.go(delta),
             Self::Memory(m) => m.go(delta),
         }
     }
 
     fn push<'a>(&self, route: impl Into<Cow<'a, str>>) {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.push(route),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.push(route),
             Self::Memory(m) => m.push(route),
         }
     }
 
     fn replace<'a>(&self, route: impl Into<Cow<'a, str>>) {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.replace(route),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.replace(route),
             Self::Memory(m) => m.replace(route),
         }
@@ -58,7 +70,9 @@ impl History for AnyHistory {
         T: 'static,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.push_with_state(route, state),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.push_with_state(route, state),
             Self::Memory(m) => m.push_with_state(route, state),
         }
@@ -69,7 +83,9 @@ impl History for AnyHistory {
         T: 'static,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.replace_with_state(route, state),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.replace_with_state(route, state),
             Self::Memory(m) => m.replace_with_state(route, state),
         }
@@ -85,7 +101,9 @@ impl History for AnyHistory {
         Q: ToQuery,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.push_with_query(route, query),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.push_with_query(route, query),
             Self::Memory(m) => m.push_with_query(route, query),
         }
@@ -100,7 +118,9 @@ impl History for AnyHistory {
         Q: ToQuery,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.replace_with_query(route, query),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.replace_with_query(route, query),
             Self::Memory(m) => m.replace_with_query(route, query),
         }
@@ -118,7 +138,9 @@ impl History for AnyHistory {
         T: 'static,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.push_with_query_and_state(route, query, state),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.push_with_query_and_state(route, query, state),
             Self::Memory(m) => m.push_with_query_and_state(route, query, state),
         }
@@ -136,7 +158,9 @@ impl History for AnyHistory {
         T: 'static,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.replace_with_query_and_state(route, query, state),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.replace_with_query_and_state(route, query, state),
             Self::Memory(m) => m.replace_with_query_and_state(route, query, state),
         }
@@ -147,27 +171,33 @@ impl History for AnyHistory {
         CB: Fn() + 'static,
     {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.listen(callback),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.listen(callback),
             Self::Memory(m) => m.listen(callback),
         }
     }
 
     fn location(&self) -> Location {
         match self {
+            #[cfg(not(target_os = "wasi"))]
             Self::Browser(m) => m.location(),
+            #[cfg(not(target_os = "wasi"))]
             Self::Hash(m) => m.location(),
             Self::Memory(m) => m.location(),
         }
     }
 }
 
+#[cfg(not(target_os = "wasi"))]
 impl From<BrowserHistory> for AnyHistory {
     fn from(m: BrowserHistory) -> AnyHistory {
         AnyHistory::Browser(m)
     }
 }
 
+#[cfg(not(target_os = "wasi"))]
 impl From<HashHistory> for AnyHistory {
     fn from(m: HashHistory) -> AnyHistory {
         AnyHistory::Hash(m)

crates/history/src/lib.rs

@@ -4,9 +4,11 @@
 #![deny(missing_docs, missing_debug_implementations)]
 
 mod any;
+#[cfg(not(target_os = "wasi"))]
 mod browser;
 #[cfg(feature = "query")]
 mod error;
+#[cfg(not(target_os = "wasi"))]
 mod hash;
 mod history;
 mod listener;
@@ -18,7 +20,9 @@ mod state;
 mod utils;
 
 pub use any::AnyHistory;
+#[cfg(not(target_os = "wasi"))]
 pub use browser::BrowserHistory;
+#[cfg(not(target_os = "wasi"))]
 pub use hash::HashHistory;
 pub use memory::MemoryHistory;
 

crates/history/src/state.rs

@@ -1,3 +1,5 @@
+#![cfg(not(target_os = "wasi"))]
+
 use std::any::Any;
 use std::collections::HashMap;
 use std::rc::Rc;

examples/history-wasi/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "example-history-wasi"
+version = "0.1.0"
+authors = ["Rust and WebAssembly Working Group"]
+edition = "2021"
+publish = false
+rust-version = "1.64"
+
+[dependencies]
+gloo = { path = "../..", default-features = false, features = ["history"] }

examples/history-wasi/README.md

@@ -0,0 +1,10 @@
+# History example on WASI
+
+This is a simple example showcasing the Gloo History on WASI.
+
+You can run this example with:
+
+```bash
+cargo build --manifest-path examples/history-wasi/Cargo.toml --target wasm32-wasi
+wasmtime examples/history-wasi/target/wasm32-wasi/debug/example-history-wasi.wasm
+```

examples/history-wasi/src/main.rs

@@ -0,0 +1,23 @@
+use gloo::history::{History, MemoryHistory};
+
+fn main() {
+    let history = MemoryHistory::new();
+    println!("Current path: {}", history.location().path());
+    assert_eq!(history.location().path(), "/");
+
+    history.push("/home");
+    println!("Current path: {}", history.location().path());
+    assert_eq!(history.location().path(), "/home");
+
+    history.push("/about");
+    println!("Current path: {}", history.location().path());
+    assert_eq!(history.location().path(), "/about");
+
+    history.push("/contact");
+    println!("Current path: {}", history.location().path());
+    assert_eq!(history.location().path(), "/contact");
+
+    history.go(-2);
+    println!("Current path: {}", history.location().path());
+    assert_eq!(history.location().path(), "/home");
+}