Rename misleading run_threaded to run_background on wasm32

Renamed the `run_threaded` method on `wasm32` to better reflect its
behavior of spawning a background task.

The generated `DbConnection` methods `run_threaded`, `run_background`,
and `advance_one_message_blocking` now include runtime panics with a
clear error feedback when called on unsupported targets.

Author: thlsrms

crates/codegen/src/rust.rs

@@ -1210,6 +1210,7 @@ impl __sdk::InModule for RemoteTables {{
 ///
 /// - [`DbConnection::frame_tick`].
 /// - [`DbConnection::run_threaded`].
+/// - [`DbConnection::run_background`].
 /// - [`DbConnection::run_async`].
 /// - [`DbConnection::advance_one_message`].
 /// - [`DbConnection::advance_one_message_blocking`].
@@ -1309,8 +1310,19 @@ impl DbConnection {{
     /// This is a low-level primitive exposed for power users who need significant control over scheduling.
     /// Most applications should call [`Self::run_threaded`] to spawn a thread
     /// which advances the connection automatically.
+    ///
+    /// # Panics
+    /// At runtime if called on any `wasm32` target.
     pub fn advance_one_message_blocking(&self) -> __sdk::Result<()> {{
-        self.imp.advance_one_message_blocking()
+        #[cfg(target_arch = \"wasm32\")]
+        {{
+            panic!(\"`DbConnection::advance_one_message_blocking` is not supported on WebAssembly (wasm32); \\
+            prefer using `advance_one_message` or `advance_one_message_async` instead\");
+        }}
+        #[cfg(not(target_arch = \"wasm32\"))]
+        {{
+            self.imp.advance_one_message_blocking()
+        }}
     }}
 
     /// Process one WebSocket message, `await`ing until one is received.
@@ -1334,14 +1346,35 @@ impl DbConnection {{
     }}
 
     /// Spawn a thread which processes WebSocket messages as they are received.
-    #[cfg(not(target_arch = \"wasm32\"))]
+    ///
+    /// # Panics
+    /// At runtime if called on any `wasm32` target.
     pub fn run_threaded(&self) -> std::thread::JoinHandle<()> {{
-        self.imp.run_threaded()
+        #[cfg(target_arch = \"wasm32\")]
+        {{
+            panic!(\"`DbConnection::run_threaded` is not supported on WebAssembly (wasm32); \\
+            prefer using `DbConnection::run_background` instead\");
+        }}
+        #[cfg(not(target_arch = \"wasm32\"))]
+        {{
+            self.imp.run_threaded()
+        }}
     }}
 
-    #[cfg(target_arch = \"wasm32\")]
-    pub fn run_threaded(&self) {{
-        self.imp.run_threaded()
+    /// Spawn a task which processes WebSocket messages as they are received.
+    ///
+    /// # Panics
+    /// At runtime if called on any non-`wasm32` target.
+    pub fn run_background(&self) {{
+        #[cfg(not(target_arch = \"wasm32\"))]
+        {{
+            panic!(\"`DbConnection::run_background` is only supported on WebAssembly (wasm32); \\
+            prefer using `DbConnection::run_threaded` instead\");
+        }}
+        #[cfg(target_arch = \"wasm32\")]
+        {{
+            self.imp.run_background()
+        }}
     }}
 
     /// Run an `async` loop which processes WebSocket messages when polled.

crates/codegen/tests/snapshots/codegen__codegen_rust.snap

@@ -1753,6 +1753,7 @@ impl __sdk::InModule for RemoteTables {
 ///
 /// - [`DbConnection::frame_tick`].
 /// - [`DbConnection::run_threaded`].
+/// - [`DbConnection::run_background`].
 /// - [`DbConnection::run_async`].
 /// - [`DbConnection::advance_one_message`].
 /// - [`DbConnection::advance_one_message_blocking`].
@@ -1852,8 +1853,19 @@ impl DbConnection {
     /// This is a low-level primitive exposed for power users who need significant control over scheduling.
     /// Most applications should call [`Self::run_threaded`] to spawn a thread
     /// which advances the connection automatically.
+    ///
+    /// # Panics
+    /// At runtime if called on any `wasm32` target.
     pub fn advance_one_message_blocking(&self) -> __sdk::Result<()> {
-        self.imp.advance_one_message_blocking()
+        #[cfg(target_arch = "wasm32")]
+        {
+            panic!("`DbConnection::advance_one_message_blocking` is not supported on WebAssembly (wasm32); \
+            prefer using `advance_one_message` or `advance_one_message_async` instead");
+        }
+        #[cfg(not(target_arch = "wasm32"))]
+        {
+            self.imp.advance_one_message_blocking()
+        }
     }
 
     /// Process one WebSocket message, `await`ing until one is received.
@@ -1877,14 +1889,35 @@ impl DbConnection {
     }
 
     /// Spawn a thread which processes WebSocket messages as they are received.
-    #[cfg(not(target_arch = "wasm32"))]
+    ///
+    /// # Panics
+    /// At runtime if called on any `wasm32` target.
     pub fn run_threaded(&self) -> std::thread::JoinHandle<()> {
-        self.imp.run_threaded()
+        #[cfg(target_arch = "wasm32")]
+        {
+            panic!("`DbConnection::run_threaded` is not supported on WebAssembly (wasm32); \
+            prefer using `DbConnection::run_background` instead");
+        }
+        #[cfg(not(target_arch = "wasm32"))]
+        {
+            self.imp.run_threaded()
+        }
     }
 
-    #[cfg(target_arch = "wasm32")]
-    pub fn run_threaded(&self) {
-        self.imp.run_threaded()
+    /// Spawn a task which processes WebSocket messages as they are received.
+    ///
+    /// # Panics
+    /// At runtime if called on any non-`wasm32` target.
+    pub fn run_background(&self) {
+        #[cfg(not(target_arch = "wasm32"))]
+        {
+            panic!("`DbConnection::run_background` is only supported on WebAssembly (wasm32); \
+            prefer using `DbConnection::run_threaded` instead");
+        }
+        #[cfg(target_arch = "wasm32")]
+        {
+            self.imp.run_background()
+        }
     }
 
     /// Run an `async` loop which processes WebSocket messages when polled.

crates/sdk/src/db_connection.rs

@@ -585,7 +585,6 @@ 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(feature = "web"))]
     pub fn run_threaded(&self) -> std::thread::JoinHandle<()> {
         let this = self.clone();
         std::thread::spawn(move || loop {
@@ -597,8 +596,11 @@ impl<M: SpacetimeModule> DbContextImpl<M> {
         })
     }
 
+    /// Spawn a background task which does [`Self::advance_one_message_async`] in a loop.
+    ///
+    /// Called by the autogenerated `DbConnection` method of the same name.
     #[cfg(feature = "web")]
-    pub fn run_threaded(&self) {
+    pub fn run_background(&self) {
         let this = self.clone();
         wasm_bindgen_futures::spawn_local(async move {
             loop {
@@ -857,6 +859,7 @@ You must explicitly advance the connection by calling any one of:
 
 - `DbConnection::frame_tick`.
 - `DbConnection::run_threaded`.
+- `DbConnection::run_background`.
 - `DbConnection::run_async`.
 - `DbConnection::advance_one_message`.
 - `DbConnection::advance_one_message_blocking`.