Add wasm flag

Author: geofflittle

.github/workflows/rust-tests.yml

@@ -88,3 +88,18 @@ jobs:
 
       - name: test
         run: cargo test
+
+  build-wasm:
+    name: Build for WASM
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+      with:
+        targets: wasm32-unknown-unknown
+
+    - name: Build for wasm32
+      run: cargo build --target wasm32-unknown-unknown --no-default-features --features "storage-inmemory"

Cargo.lock

@@ -20,20 +20,24 @@ resolver = "2"
 [features]
 default = ["sync", "bundled", "storage"]
 
+# (private) Support for the sync API
+sync-api = []
 # Support for all sync solutions
-sync = ["server-sync", "server-gcp", "server-aws", "server-local"]
+sync = ["sync-api", "server-sync", "server-gcp", "server-aws", "server-local"]
 # Support for sync to a server
-server-sync = ["encryption", "dep:ureq", "dep:url"]
+server-sync = ["sync-api", "encryption", "dep:ureq", "dep:url"]
 # Support for sync to GCP
-server-gcp = ["cloud", "encryption", "dep:google-cloud-storage"]
+server-gcp = ["sync-api", "cloud", "encryption", "dep:google-cloud-storage"]
 # Support for sync to AWS
-server-aws = ["cloud", "encryption", "dep:aws-sdk-s3", "dep:aws-config", "dep:aws-credential-types"]
+server-aws = ["sync-api", "cloud", "encryption", "dep:aws-sdk-s3", "dep:aws-config", "dep:aws-credential-types"]
 # Suppport for sync to another SQLite database on the same machine
-server-local = ["storage-sqlite"]
+server-local = ["sync-api", "storage-sqlite"]
 # Support for all task storage backends
 storage = ["storage-sqlite"]
 # Support for SQLite task storage
 storage-sqlite = ["dep:rusqlite", "dep:tokio-rusqlite"]
+# Support for the in-memory storage backend (WASM-compatible)
+storage-inmemory = []
 # (private) Support for sync protocol encryption
 encryption = ["dep:ring"]
 # (private) Generic support for cloud sync
@@ -62,16 +66,26 @@ serde_json = "^1.0"
 serde = { version = "^1.0.147", features = ["derive"] }
 strum = "0.27"
 strum_macros = "0.27"
-tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
 thiserror = "2.0"
 ureq = { version = "^2.12.1", features = ["tls"], optional = true }
 uuid = { version = "^1.16.0", features = ["serde", "v4"] }
 url = { version = "2", optional = true }
 async-trait = "0.1.89"
 tokio-rusqlite = { version = "0.6.0", optional = true }
+# Use only WASM-compatible features by default
+tokio = { version = "1", features = ["macros"] }
+
+# For non-WASM targets, enable the multi-threaded runtime
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+tokio = { version = "1", features = ["rt-multi-thread"] }
+
+# For WASM targets, enable the single-threaded runtime and WASM-friendly uuid features
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+tokio = { version = "1", features = ["rt"] }
+uuid = { version = "^1.16.0", features = ["js"] }
 
 [dev-dependencies]
 proptest = "^1.7.0"
 tempfile = "3"
 rstest = "0.26"
-pretty_assertions = "1"
+pretty_assertions = "1"

Cargo.toml

@@ -20,3 +20,12 @@ The Rust API, as defined in [the docs](https://docs.rs/taskchampion/latest/taskc
 
 The Rust API follows semantic versioning.
 As this is still in the `0.x` phase, so breaking changes may occur but will be indicated with a change to the minor version.
+
+## Building for WebAssembly (WASM)
+When compiling this crate for a WebAssembly target (e.g., wasm32-unknown-unknown), you must disable the default features, as they include dependencies not compatible with WASM. Instead, select only the features you need that are WASM-compatible.
+
+For example, to build with in-memory storage, use the following command:
+
+```bash
+cargo build --target wasm32-unknown-unknown --no-default-features --features "storage-inmemory"
+```

README.md

@@ -74,11 +74,10 @@ impl From<ureq::Error> for Error {
 
 pub(crate) type Result<T> = std::result::Result<T, Error>;
 
-#[cfg(test)]
+#[cfg(all(test, feature = "server-sync"))]
 mod test {
     use super::*;
 
-    #[cfg(feature = "server-sync")]
     #[test]
     fn ureq_error_status() {
         let err = ureq::Error::Status(

src/errors.rs

@@ -19,7 +19,9 @@ pub use depmap::DependencyMap;
 pub use errors::Error;
 pub use operation::{Operation, Operations};
 pub use replica::Replica;
-pub use server::{Server, ServerConfig};
+pub use server::Server;
+#[cfg(feature = "sync-api")]
+pub use server::ServerConfig;
 pub use task::{utc_timestamp, Annotation, Status, Tag, Task, TaskData};
 pub use workingset::WorkingSet;
 

src/lib.rs

@@ -1,4 +1,6 @@
+#[cfg(feature = "sync-api")]
 use super::types::Server;
+#[cfg(feature = "sync-api")]
 use crate::errors::Result;
 #[cfg(feature = "server-aws")]
 pub use crate::server::cloud::aws::AwsCredentials;
@@ -12,17 +14,18 @@ use crate::server::cloud::CloudServer;
 use crate::server::local::LocalServer;
 #[cfg(feature = "server-sync")]
 use crate::server::sync::SyncServer;
-use std::{
-    path::PathBuf,
-    sync::{Arc, Mutex},
-};
+#[cfg(feature = "server-local")]
+use std::path::PathBuf;
+#[cfg(feature = "sync-api")]
+use std::sync::{Arc, Mutex};
 #[cfg(feature = "server-sync")]
 use uuid::Uuid;
 
 /// The configuration for a replica's access to a sync server.
 ///
 /// This enum is non-exhaustive, as users should only be constructing required
 /// variants, not matching on it.
+#[cfg(feature = "sync-api")]
 #[non_exhaustive]
 pub enum ServerConfig {
     /// A local task database, for situations with a single replica.
@@ -96,6 +99,7 @@ pub enum ServerConfig {
     },
 }
 
+#[cfg(feature = "sync-api")]
 impl ServerConfig {
     /// Get a server based on this configuration
     pub fn into_server(self) -> Result<Arc<Mutex<dyn Server + Send>>> {

src/server/config.rs

@@ -28,6 +28,7 @@ mod sync;
 #[cfg(feature = "cloud")]
 mod cloud;
 
+#[cfg(feature = "sync-api")]
 pub use config::*;
 pub use types::*;
 

src/server/mod.rs

@@ -1,10 +1,11 @@
+#![cfg(feature = "server-local")]
+
 use chrono::Utc;
 use pretty_assertions::assert_eq;
 use taskchampion::{storage::InMemoryStorage, Operations, Replica, ServerConfig, Status, Uuid};
 use tempfile::TempDir;
 
 #[tokio::test]
-#[cfg(feature = "server-local")]
 async fn cross_sync() -> anyhow::Result<()> {
     // set up two replicas, and demonstrate replication between them
     let mut rep1 = Replica::new(InMemoryStorage::new());

tests/cross-sync.rs

@@ -1,6 +1,7 @@
+#![cfg(feature = "storage-sqlite")]
+
 use pretty_assertions::assert_eq;
 use proptest::prelude::*;
-#[cfg(feature = "storage-sqlite")]
 use taskchampion::{storage::InMemoryStorage, Operations, Replica, ServerConfig, TaskData, Uuid};
 use tempfile::TempDir;
 
@@ -27,7 +28,6 @@ fn actions() -> impl Strategy<Value = Vec<(Action, u8)>> {
 
 proptest! {
 #[test]
-#[cfg(feature = "storage-sqlite")]
 /// Check that various sequences of operations on mulitple db's do not get the db's into an
 /// incompatible state.  The main concern here is that there might be a sequence of operations
 /// that results in a task being in different states in different replicas. Different tasks