Add WASI example for CI. (#411)

langyo · web-flow · commit 399dabb84c84 · 2023-12-06T21:44:38.000+05:00
* 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
diff --git a/.github/workflows/tests.yml b/.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
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -77,6 +77,7 @@ members = [
     "examples/markdown",
     "examples/clock",
     "examples/file-hash",
+    "examples/history-wasi",
     "examples/prime",
 ]
 
diff --git a/crates/history/Cargo.toml b/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"]
 
diff --git a/crates/history/src/any.rs b/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)
diff --git a/crates/history/src/lib.rs b/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;
 
diff --git a/crates/history/src/state.rs b/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;
diff --git a/examples/history-wasi/Cargo.toml b/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"] }
diff --git a/examples/history-wasi/README.md b/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
+```
diff --git a/examples/history-wasi/src/main.rs b/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");
+}

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,7 @@ members = [`
`77`	`77`	`"examples/markdown",`
`78`	`78`	`"examples/clock",`
`79`	`79`	`"examples/file-hash",`
	`80`	`+ "examples/history-wasi",`
`80`	`81`	`"examples/prime",`
`81`	`82`	`]`
`82`	`83`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`use std::borrow::Cow;`
`2`	`2`
	`3`	`+#[cfg(not(target_os = "wasi"))]`
`3`	`4`	`use crate::browser::BrowserHistory;`
	`5`	`+#[cfg(not(target_os = "wasi"))]`
`4`	`6`	`use crate::hash::HashHistory;`
`5`	`7`	`use crate::history::History;`
`6`	`8`	`use crate::listener::HistoryListener;`
`@@ -13,8 +15,10 @@ use crate::{error::HistoryResult, query::ToQuery};`
`13`	`15`	`#[derive(Clone, PartialEq, Debug)]`
`14`	`16`	`pub enum AnyHistory {`
`15`	`17`	`/// A Browser History.`
	`18`	`+ #[cfg(not(target_os = "wasi"))]`
`16`	`19`	`Browser(BrowserHistory),`
`17`	`20`	`/// A Hash History`
	`21`	`+ #[cfg(not(target_os = "wasi"))]`
`18`	`22`	`Hash(HashHistory),`
`19`	`23`	`/// A Memory History`
`20`	`24`	`Memory(MemoryHistory),`
`@@ -23,31 +27,39 @@ pub enum AnyHistory {`
`23`	`27`	`impl History for AnyHistory {`
`24`	`28`	`fn len(&self) -> usize {`
`25`	`29`	`match self {`
	`30`	`+ #[cfg(not(target_os = "wasi"))]`
`26`	`31`	`Self::Browser(m) => m.len(),`
	`32`	`+ #[cfg(not(target_os = "wasi"))]`
`27`	`33`	`Self::Hash(m) => m.len(),`
`28`	`34`	`Self::Memory(m) => m.len(),`
`29`	`35`	`}`
`30`	`36`	`}`
`31`	`37`
`32`	`38`	`fn go(&self, delta: isize) {`
`33`	`39`	`match self {`
	`40`	`+ #[cfg(not(target_os = "wasi"))]`
`34`	`41`	`Self::Browser(m) => m.go(delta),`
	`42`	`+ #[cfg(not(target_os = "wasi"))]`
`35`	`43`	`Self::Hash(m) => m.go(delta),`
`36`	`44`	`Self::Memory(m) => m.go(delta),`
`37`	`45`	`}`
`38`	`46`	`}`
`39`	`47`
`40`	`48`	`fn push<'a>(&self, route: impl Into<Cow<'a, str>>) {`
`41`	`49`	`match self {`
	`50`	`+ #[cfg(not(target_os = "wasi"))]`
`42`	`51`	`Self::Browser(m) => m.push(route),`
	`52`	`+ #[cfg(not(target_os = "wasi"))]`
`43`	`53`	`Self::Hash(m) => m.push(route),`
`44`	`54`	`Self::Memory(m) => m.push(route),`
`45`	`55`	`}`
`46`	`56`	`}`
`47`	`57`
`48`	`58`	`fn replace<'a>(&self, route: impl Into<Cow<'a, str>>) {`
`49`	`59`	`match self {`
	`60`	`+ #[cfg(not(target_os = "wasi"))]`
`50`	`61`	`Self::Browser(m) => m.replace(route),`
	`62`	`+ #[cfg(not(target_os = "wasi"))]`
`51`	`63`	`Self::Hash(m) => m.replace(route),`
`52`	`64`	`Self::Memory(m) => m.replace(route),`
`53`	`65`	`}`
`@@ -58,7 +70,9 @@ impl History for AnyHistory {`
`58`	`70`	`T: 'static,`
`59`	`71`	`{`
`60`	`72`	`match self {`
	`73`	`+ #[cfg(not(target_os = "wasi"))]`
`61`	`74`	`Self::Browser(m) => m.push_with_state(route, state),`
	`75`	`+ #[cfg(not(target_os = "wasi"))]`
`62`	`76`	`Self::Hash(m) => m.push_with_state(route, state),`
`63`	`77`	`Self::Memory(m) => m.push_with_state(route, state),`
`64`	`78`	`}`
`@@ -69,7 +83,9 @@ impl History for AnyHistory {`
`69`	`83`	`T: 'static,`
`70`	`84`	`{`
`71`	`85`	`match self {`
	`86`	`+ #[cfg(not(target_os = "wasi"))]`
`72`	`87`	`Self::Browser(m) => m.replace_with_state(route, state),`
	`88`	`+ #[cfg(not(target_os = "wasi"))]`
`73`	`89`	`Self::Hash(m) => m.replace_with_state(route, state),`
`74`	`90`	`Self::Memory(m) => m.replace_with_state(route, state),`
`75`	`91`	`}`
`@@ -85,7 +101,9 @@ impl History for AnyHistory {`
`85`	`101`	`Q: ToQuery,`
`86`	`102`	`{`
`87`	`103`	`match self {`
	`104`	`+ #[cfg(not(target_os = "wasi"))]`
`88`	`105`	`Self::Browser(m) => m.push_with_query(route, query),`
	`106`	`+ #[cfg(not(target_os = "wasi"))]`
`89`	`107`	`Self::Hash(m) => m.push_with_query(route, query),`
`90`	`108`	`Self::Memory(m) => m.push_with_query(route, query),`
`91`	`109`	`}`
`@@ -100,7 +118,9 @@ impl History for AnyHistory {`
`100`	`118`	`Q: ToQuery,`
`101`	`119`	`{`
`102`	`120`	`match self {`
	`121`	`+ #[cfg(not(target_os = "wasi"))]`
`103`	`122`	`Self::Browser(m) => m.replace_with_query(route, query),`
	`123`	`+ #[cfg(not(target_os = "wasi"))]`
`104`	`124`	`Self::Hash(m) => m.replace_with_query(route, query),`
`105`	`125`	`Self::Memory(m) => m.replace_with_query(route, query),`
`106`	`126`	`}`
`@@ -118,7 +138,9 @@ impl History for AnyHistory {`
`118`	`138`	`T: 'static,`
`119`	`139`	`{`
`120`	`140`	`match self {`
	`141`	`+ #[cfg(not(target_os = "wasi"))]`
`121`	`142`	`Self::Browser(m) => m.push_with_query_and_state(route, query, state),`
	`143`	`+ #[cfg(not(target_os = "wasi"))]`
`122`	`144`	`Self::Hash(m) => m.push_with_query_and_state(route, query, state),`
`123`	`145`	`Self::Memory(m) => m.push_with_query_and_state(route, query, state),`
`124`	`146`	`}`
`@@ -136,7 +158,9 @@ impl History for AnyHistory {`
`136`	`158`	`T: 'static,`
`137`	`159`	`{`
`138`	`160`	`match self {`
	`161`	`+ #[cfg(not(target_os = "wasi"))]`
`139`	`162`	`Self::Browser(m) => m.replace_with_query_and_state(route, query, state),`
	`163`	`+ #[cfg(not(target_os = "wasi"))]`
`140`	`164`	`Self::Hash(m) => m.replace_with_query_and_state(route, query, state),`
`141`	`165`	`Self::Memory(m) => m.replace_with_query_and_state(route, query, state),`
`142`	`166`	`}`
`@@ -147,27 +171,33 @@ impl History for AnyHistory {`
`147`	`171`	`CB: Fn() + 'static,`
`148`	`172`	`{`
`149`	`173`	`match self {`
	`174`	`+ #[cfg(not(target_os = "wasi"))]`
`150`	`175`	`Self::Browser(m) => m.listen(callback),`
	`176`	`+ #[cfg(not(target_os = "wasi"))]`
`151`	`177`	`Self::Hash(m) => m.listen(callback),`
`152`	`178`	`Self::Memory(m) => m.listen(callback),`
`153`	`179`	`}`
`154`	`180`	`}`
`155`	`181`
`156`	`182`	`fn location(&self) -> Location {`
`157`	`183`	`match self {`
	`184`	`+ #[cfg(not(target_os = "wasi"))]`
`158`	`185`	`Self::Browser(m) => m.location(),`
	`186`	`+ #[cfg(not(target_os = "wasi"))]`
`159`	`187`	`Self::Hash(m) => m.location(),`
`160`	`188`	`Self::Memory(m) => m.location(),`
`161`	`189`	`}`
`162`	`190`	`}`
`163`	`191`	`}`
`164`	`192`
	`193`	`+#[cfg(not(target_os = "wasi"))]`
`165`	`194`	`impl From<BrowserHistory> for AnyHistory {`
`166`	`195`	`fn from(m: BrowserHistory) -> AnyHistory {`
`167`	`196`	`AnyHistory::Browser(m)`
`168`	`197`	`}`
`169`	`198`	`}`
`170`	`199`
	`200`	`+#[cfg(not(target_os = "wasi"))]`
`171`	`201`	`impl From<HashHistory> for AnyHistory {`
`172`	`202`	`fn from(m: HashHistory) -> AnyHistory {`
`173`	`203`	`AnyHistory::Hash(m)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+#![cfg(not(target_os = "wasi"))]`
	`2`	`+`
`1`	`3`	`use std::any::Any;`
`2`	`4`	`use std::collections::HashMap;`
`3`	`5`	`use std::rc::Rc;`