Add web feature flag to the rust sdk

Author: thlsrms

crates/sdk/Cargo.toml

@@ -7,6 +7,20 @@ description = "A Rust SDK for clients to interface with SpacetimeDB"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+default = []
+web = [
+    "dep:futures-util",
+    "dep:getrandom",
+    "dep:gloo-console",
+    "dep:gloo-storage",
+    "dep:rustls-pki-types",
+    "dep:tokio-tungstenite-wasm",
+    "dep:wasm-bindgen",
+    "dep:wasm-bindgen-futures",
+    "dep:web-sys",
+]
+
 [dependencies]
 spacetimedb-data-structures.workspace = true
 spacetimedb-sats.workspace = true
@@ -27,25 +41,25 @@ once_cell.workspace = true
 prometheus.workspace = true
 rand.workspace = true
 
+futures-util = { version = "0.3", default-features = false, features = ["sink", "std"], optional = true }
+getrandom = { version = "0.3.2", features = ["wasm_js"], optional = true }
+gloo-console = { version = "0.3.0", optional = true }
+gloo-storage = { version = "0.3.0", optional = true }
+rustls-pki-types = { version = "1.11.0", features = ["web"], optional = true }
+tokio-tungstenite-wasm = { version = "0.6.0", optional = true }
+wasm-bindgen = { version = "0.2.100", optional = true }
+wasm-bindgen-futures = { version = "0.4.45", optional = true }
+web-sys = { version = "0.3.77", features = [ "Document", "HtmlDocument", "Window" ], optional = true}
+
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 home.workspace = true
 tokio.workspace = true
 tokio-tungstenite.workspace = true
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
-futures-util = { version = "0.3", default-features = false, features = ["sink", "std"] }
-getrandom = { version = "0.3.2", features = ["wasm_js"]}
-gloo-console = "0.3.0"
-gloo-storage = "0.3.0"
-rustls-pki-types = { version = "1.11.0", features = ["web"] }
 tokio = { version = "1.37", default-features = false, features = [
     "rt", "macros", "sync", "io-util"
 ] }
-tokio-tungstenite-wasm = "0.6.0"
-tungstenite = { version = "0.26.2", features = ["rustls"] }
-wasm-bindgen = "0.2.100"
-wasm-bindgen-futures = "0.4.45"
-web-sys = { version = "0.3.77", features = [ "Document", "HtmlDocument", "Window" ] }
 
 [dev-dependencies]
 # for quickstart-chat and cursive-chat examples

crates/sdk/src/credentials.rs

@@ -8,7 +8,7 @@
 //! }
 //! ```
 
-#[cfg(not(target_arch = "wasm32"))]
+#[cfg(not(feature = "web"))]
 mod native_mod {
     use home::home_dir;
     use spacetimedb_lib::{bsatn, de::Deserialize, ser::Serialize};
@@ -153,7 +153,7 @@ mod native_mod {
     }
 }
 
-#[cfg(target_arch = "wasm32")]
+#[cfg(feature = "web")]
 mod web_mod {
     pub use gloo_storage::{LocalStorage, SessionStorage, Storage};
 
@@ -319,8 +319,8 @@ mod web_mod {
     }
 }
 
-#[cfg(not(target_arch = "wasm32"))]
+#[cfg(not(feature = "web"))]
 pub use native_mod::*;
 
-#[cfg(target_arch = "wasm32")]
+#[cfg(feature = "web")]
 pub use web_mod::*;

crates/sdk/src/db_connection.rs

@@ -41,7 +41,7 @@ use std::{
     sync::{atomic::AtomicU32, Arc, Mutex as StdMutex, OnceLock},
 };
 use tokio::runtime::{self, Runtime};
-#[cfg(not(target_arch = "wasm32"))]
+#[cfg(not(feature = "web"))]
 use tokio::sync::Mutex as TokioMutex;
 
 pub(crate) type SharedCell<T> = Arc<StdMutex<T>>;
@@ -65,9 +65,9 @@ pub struct DbContextImpl<M: SpacetimeModule> {
 
     /// Receiver channel for WebSocket messages,
     /// which are pre-parsed in the background by [`parse_loop`].
-    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg(not(feature = "web"))]
     recv: Arc<TokioMutex<mpsc::UnboundedReceiver<ParsedMessage<M>>>>,
-    #[cfg(target_arch = "wasm32")]
+    #[cfg(feature = "web")]
     recv: SharedCell<mpsc::UnboundedReceiver<ParsedMessage<M>>>,
 
     /// Channel into which operations which apparently mutate SDK state,
@@ -78,9 +78,9 @@ pub struct DbContextImpl<M: SpacetimeModule> {
 
     /// Receive end of `pending_mutations_send`,
     /// from which [Self::apply_pending_mutations] and friends read mutations.
-    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg(not(feature = "web"))]
     pending_mutations_recv: Arc<TokioMutex<mpsc::UnboundedReceiver<PendingMutation<M>>>>,
-    #[cfg(target_arch = "wasm32")]
+    #[cfg(feature = "web")]
     pending_mutations_recv: SharedCell<mpsc::UnboundedReceiver<PendingMutation<M>>>,
 
     /// This connection's `Identity`.
@@ -264,12 +264,12 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
 
     /// Apply all queued [`PendingMutation`]s.
     fn apply_pending_mutations(&self) -> crate::Result<()> {
-        #[cfg(not(target_arch = "wasm32"))]
+        #[cfg(not(feature = "web"))]
         while let Ok(Some(pending_mutation)) = self.pending_mutations_recv.blocking_lock().try_next() {
             self.apply_mutation(pending_mutation)?;
         }
 
-        #[cfg(target_arch = "wasm32")]
+        #[cfg(feature = "web")]
         while let Ok(Some(pending_mutation)) = self.pending_mutations_recv.lock().unwrap().try_next() {
             self.apply_mutation(pending_mutation)?;
         }
@@ -489,10 +489,10 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
         // model or not.
 
         let res = {
-            #[cfg(not(target_arch = "wasm32"))]
+            #[cfg(not(feature = "web"))]
             let mut recv = self.recv.blocking_lock();
 
-            #[cfg(target_arch = "wasm32")]
+            #[cfg(feature = "web")]
             let mut recv = self.recv.lock().unwrap();
 
             match recv.try_next() {
@@ -519,14 +519,14 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
         // We call this out as an incorrect and unsupported thing to do.
         #![allow(clippy::await_holding_lock)]
 
-        #[cfg(not(target_arch = "wasm32"))]
+        #[cfg(not(feature = "web"))]
         let mut pending_mutations = self.pending_mutations_recv.lock().await;
-        #[cfg(target_arch = "wasm32")]
+        #[cfg(feature = "web")]
         let mut pending_mutations = self.pending_mutations_recv.lock().unwrap();
 
-        #[cfg(not(target_arch = "wasm32"))]
+        #[cfg(not(feature = "web"))]
         let mut recv = self.recv.lock().await;
-        #[cfg(target_arch = "wasm32")]
+        #[cfg(feature = "web")]
         let mut recv = self.recv.lock().unwrap();
 
         // Always process pending mutations before WS messages, if they're available,
@@ -585,7 +585,7 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
     /// Spawn a thread which does [`Self::advance_one_message_blocking`] in a loop.
     ///
     /// Called by the autogenerated `DbConnection` method of the same name.
-    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg(not(feature = "web"))]
     pub fn run_threaded(&self) -> std::thread::JoinHandle<()> {
         let this = self.clone();
         std::thread::spawn(move || loop {
@@ -597,7 +597,7 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
         })
     }
 
-    #[cfg(target_arch = "wasm32")]
+    #[cfg(feature = "web")]
     pub fn run_threaded(&self) {
         let this = self.clone();
         wasm_bindgen_futures::spawn_local(async move {
@@ -865,21 +865,21 @@ You must explicitly advance the connection by calling any one of:
 Which of these methods you should call depends on the specific needs of your application,
 but you must call one of them, or else the connection will never progress.
 "]
-    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg(not(feature = "web"))]
     pub fn build(self) -> crate::Result<M::DbConnection> {
         let imp = self.build_impl()?;
         Ok(<M::DbConnection as DbConnection>::new(imp))
     }
 
-    #[cfg(target_arch = "wasm32")]
+    #[cfg(feature = "web")]
     pub async fn build(self) -> crate::Result<M::DbConnection> {
         let imp = self.build_impl().await?;
         Ok(<M::DbConnection as DbConnection>::new(imp))
     }
 
     /// Open a WebSocket connection, build an empty client cache, &c,
     /// to construct a [`DbContextImpl`].
-    #[cfg(not(target_arch = "wasm32"))]
+    #[cfg(not(feature = "web"))]
     fn build_impl(self) -> crate::Result<DbContextImpl<M>> {
         let (runtime, handle) = enter_or_create_runtime()?;
         let db_callbacks = DbCallbacks::default();
@@ -934,7 +934,7 @@ but you must call one of them, or else the connection will never progress.
         Ok(ctx_imp)
     }
 
-    #[cfg(target_arch = "wasm32")]
+    #[cfg(feature = "web")]
     pub async fn build_impl(self) -> crate::Result<DbContextImpl<M>> {
         let (runtime, handle) = enter_or_create_runtime()?;
         let db_callbacks = DbCallbacks::default();
@@ -1101,9 +1101,9 @@ Instead of registering multiple `on_disconnect` callbacks, register a single cal
 fn enter_or_create_runtime() -> crate::Result<(Option<Runtime>, runtime::Handle)> {
     match runtime::Handle::try_current() {
         Err(e) if e.is_missing_context() => {
-            #[cfg(not(target_arch = "wasm32"))]
+            #[cfg(not(feature = "web"))]
             let mut rt = tokio::runtime::Builder::new_multi_thread();
-            #[cfg(target_arch = "wasm32")]
+            #[cfg(feature = "web")]
             let mut rt = tokio::runtime::Builder::new_current_thread();
 
             let rt = rt
@@ -1135,7 +1135,7 @@ enum ParsedMessage<M: SpacetimeModule> {
     Error(crate::Error),
 }
 
-#[cfg(not(target_arch = "wasm32"))]
+#[cfg(not(feature = "web"))]
 fn spawn_parse_loop<M: SpacetimeModule>(
     raw_message_recv: mpsc::UnboundedReceiver<ws::ServerMessage<BsatnFormat>>,
     handle: &runtime::Handle,
@@ -1145,7 +1145,7 @@ fn spawn_parse_loop<M: SpacetimeModule>(
     (handle, parsed_message_recv)
 }
 
-#[cfg(target_arch = "wasm32")]
+#[cfg(feature = "web")]
 fn spawn_parse_loop<M: SpacetimeModule>(
     raw_message_recv: mpsc::UnboundedReceiver<ws::ServerMessage<BsatnFormat>>,
 ) -> mpsc::UnboundedReceiver<ParsedMessage<M>> {

crates/sdk/src/lib.rs

@@ -72,3 +72,9 @@ pub mod unstable {
     pub use crate::metrics::{ClientMetrics, CLIENT_METRICS};
     pub use spacetimedb_client_api_messages::websocket::CallReducerFlags;
 }
+
+#[cfg(all(not(target_arch = "wasm32"), feature = "web"))]
+compile_error!(
+    "The `web` feature can only be enabled when targeting `wasm32`. \
+     Remove `--features web` or switch your target to a wasm32 architecture."
+);