More observable Wasm (#75)

Author: expede

Cargo.lock

@@ -32,15 +32,16 @@ authors = [
 [workspace.dependencies]
 # Internal crates
 automerge_sedimentree_wasm = { version = "0.5.0", path = "automerge_sedimentree_wasm" }
+automerge_subduction_wasm = { version = "0.3.1", path = "automerge_subduction_wasm", default-features = false }
 bijou64 = { version = "0.1.0", path = "bijou64", default-features = false }
 sedimentree_core = { version = "0.5.0", path = "sedimentree_core", default-features = false }
 sedimentree_fs_storage = { version = "0.5.0", path = "sedimentree_fs_storage" }
-sedimentree_wasm = { version = "0.5.0", path = "sedimentree_wasm", default-features = false }
+sedimentree_wasm = { version = "0.5.1", path = "sedimentree_wasm", default-features = false }
 subduction_core = { version = "0.5.0", path = "subduction_core", default-features = false }
 subduction_crypto = { version = "0.2.0", path = "subduction_crypto", default-features = false }
 subduction_http_longpoll = { version = "0.3.0", path = "subduction_http_longpoll", default-features = false }
 subduction_iroh = { version = "0.2.0", path = "subduction_iroh" }
-subduction_wasm = { version = "0.5.0", path = "subduction_wasm", default-features = false }
+subduction_wasm = { version = "0.5.1", path = "subduction_wasm", default-features = false }
 subduction_websocket = { version = "0.5.0", path = "subduction_websocket", default-features = false }
 
 # External crates
@@ -164,6 +165,22 @@ opt-level = 3
 [profile.release.package.tokio]
 opt-level = 3
 
+# Wasm crates: preserve Wasm name section for readable stack traces in
+# production. Only strips DWARF debug info, not function names (~5-15%
+# larger than strip="symbols", but panics show real function names
+# instead of wasm-function[4616]).
+[profile.release.package.sedimentree_wasm]
+strip = "debuginfo"
+
+[profile.release.package.subduction_wasm]
+strip = "debuginfo"
+
+[profile.release.package.automerge_sedimentree_wasm]
+strip = "debuginfo"
+
+[profile.release.package.automerge_subduction_wasm]
+strip = "debuginfo"
+
 # Benchmarks inherit from release, but the workspace release profile is tuned
 # for Wasm (opt-level="z", strip="symbols"). Override for accurate benchmarks
 # with debug info sufficient for flamegraphs.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "automerge_subduction_wasm"
-version = "0.3.0"
+version = "0.3.1"
 description = "Wasm bindings for syncing Automerge documents via Subduction"
 categories = ["web-programming"]
 keywords = ["automerge", "sedimentree", "wasm"]
@@ -33,8 +33,12 @@ wasm_refgen = { workspace = true }
 getrandom_03 = { package = "getrandom", version = "0.3", features = ["wasm_js"] }
 
 [features]
-default = ["console_error_panic_hook", "std", "wasm-tracing"]
+default = ["console_error_panic_hook", "standalone", "std", "wasm-tracing"]
 console_error_panic_hook = ["dep:console_error_panic_hook"]
+# Enable the #[wasm_bindgen(start)] entry point. Disable when using
+# this crate as a dependency of another cdylib crate that defines
+# its own start function (wasm-bindgen allows only one per module).
+standalone = []
 std = [
   "automerge_sedimentree_wasm/std",
   "subduction_wasm/std",

automerge_subduction_wasm/Cargo.toml

@@ -254,7 +254,13 @@ pub fn set_panic_hook() {
     }
 }
 
-/// Entry point called when the wasm module is instantiated.
+/// Entry point called when the Wasm module is instantiated.
+///
+/// Only compiled when the `standalone` feature is active. Downstream cdylib
+/// crates that define their own `#[wasm_bindgen(start)]` should depend on
+/// `automerge_subduction_wasm` with `default-features = false` and call
+/// [`set_panic_hook`] from their own start function.
+#[cfg(feature = "standalone")]
 #[wasm_bindgen(start)]
 pub fn start() {
     set_panic_hook();

automerge_subduction_wasm/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "sedimentree_wasm"
-version = "0.5.0"
+version = "0.5.1"
 description = "Wasm/JavaScript bindings for Sedimentree (browser and Node.js)"
 categories = ["web-programming"]
 keywords = ["sedimentree", "wasm"]

flake.lock

@@ -152,18 +152,27 @@ impl core::fmt::Debug for JsStorage {
 }
 
 /// Parse a JS array of digests.
-fn parse_digest_array<T: Encode + Decode>(js_value: &JsValue) -> Set<Digest<T>> {
+///
+/// Returns an error if any element cannot be cast to a `Digest`.
+fn parse_digest_array<T: Encode + Decode>(
+    js_value: &JsValue,
+) -> Result<Set<Digest<T>>, JsStorageError> {
     let array = js_sys::Array::from(js_value);
     let mut result = Set::new();
 
     for i in 0..array.length() {
         let item = array.get(i);
-        let js_digest: JsDigest = JsCast::unchecked_into(item);
+        let js_digest: JsDigest =
+            item.dyn_into()
+                .map_err(|value| JsStorageError::UnexpectedJsType {
+                    expected: "Digest",
+                    value,
+                })?;
         let digest: Digest<T> = WasmDigest::from(&js_digest).into();
         result.insert(digest);
     }
 
-    result
+    Ok(result)
 }
 
 impl Storage<Local> for JsStorage {
@@ -265,7 +274,13 @@ impl Storage<Local> for JsStorage {
                 return Ok(None);
             }
 
-            let commit_with_blob: JsCommitWithBlob = js_value.unchecked_into();
+            let commit_with_blob: JsCommitWithBlob =
+                js_value
+                    .dyn_into()
+                    .map_err(|value| JsStorageError::UnexpectedJsType {
+                        expected: "CommitWithBlob",
+                        value,
+                    })?;
             let wasm_commit: WasmCommitWithBlob = (&commit_with_blob).into();
             let signed: Signed<LooseCommit> = wasm_commit.signed().into();
             let blob = Blob::new(wasm_commit.blob().to_vec());
@@ -286,7 +301,7 @@ impl Storage<Local> for JsStorage {
             let js_value = JsFuture::from(js_promise)
                 .await
                 .map_err(JsStorageError::JsError)?;
-            Ok(parse_digest_array(&js_value))
+            parse_digest_array(&js_value)
         })
     }
 
@@ -307,7 +322,12 @@ impl Storage<Local> for JsStorage {
 
             for i in 0..array.length() {
                 let item = array.get(i);
-                let commit_with_blob: JsCommitWithBlob = item.unchecked_into();
+                let commit_with_blob: JsCommitWithBlob =
+                    item.dyn_into()
+                        .map_err(|value| JsStorageError::UnexpectedJsType {
+                            expected: "CommitWithBlob",
+                            value,
+                        })?;
                 let wasm_commit: WasmCommitWithBlob = (&commit_with_blob).into();
                 let signed: Signed<LooseCommit> = wasm_commit.signed().into();
                 let blob = Blob::new(wasm_commit.blob().to_vec());
@@ -397,7 +417,13 @@ impl Storage<Local> for JsStorage {
                 return Ok(None);
             }
 
-            let fragment_with_blob: JsFragmentWithBlob = js_value.unchecked_into();
+            let fragment_with_blob: JsFragmentWithBlob =
+                js_value
+                    .dyn_into()
+                    .map_err(|value| JsStorageError::UnexpectedJsType {
+                        expected: "FragmentWithBlob",
+                        value,
+                    })?;
             let wasm_fragment: WasmFragmentWithBlob = (&fragment_with_blob).into();
             let signed: Signed<Fragment> = wasm_fragment.signed().into();
             let blob = Blob::new(wasm_fragment.blob().to_vec());
@@ -418,7 +444,7 @@ impl Storage<Local> for JsStorage {
             let js_value = JsFuture::from(js_promise)
                 .await
                 .map_err(JsStorageError::JsError)?;
-            Ok(parse_digest_array(&js_value))
+            parse_digest_array(&js_value)
         })
     }
 
@@ -439,7 +465,12 @@ impl Storage<Local> for JsStorage {
 
             for i in 0..array.length() {
                 let item = array.get(i);
-                let fragment_with_blob: JsFragmentWithBlob = item.unchecked_into();
+                let fragment_with_blob: JsFragmentWithBlob =
+                    item.dyn_into()
+                        .map_err(|value| JsStorageError::UnexpectedJsType {
+                            expected: "FragmentWithBlob",
+                            value,
+                        })?;
                 let wasm_fragment: WasmFragmentWithBlob = (&fragment_with_blob).into();
                 let signed: Signed<Fragment> = wasm_fragment.signed().into();
                 let blob = Blob::new(wasm_fragment.blob().to_vec());
@@ -550,6 +581,15 @@ pub enum JsStorageError {
     /// The `JsValue` could not be converted into an array of `SedimentreeId`s.
     #[error("Value was not an array of SedimentreeIds: {0:?}")]
     NotSedimentreeIdArray(#[from] WasmConvertJsValueToSedimentreeIdArrayError),
+
+    /// A JS value could not be cast to the expected type.
+    #[error("JS type cast failed: expected {expected}, got {value:?}")]
+    UnexpectedJsType {
+        /// The type name that was expected.
+        expected: &'static str,
+        /// The actual JS value received.
+        value: JsValue,
+    },
 }
 
 impl From<JsStorageError> for JsValue {

sedimentree_wasm/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "subduction_wasm"
-version = "0.5.0"
+version = "0.5.1"
 description = "Wasm/JavaScript bindings for Subduction (browser and Node.js)"
 categories = ["web-programming"]
 keywords = ["subduction", "websocket"]
@@ -80,9 +80,12 @@ getrandom_03 = { package = "getrandom", version = "0.3", features = ["wasm_js"]
 wasm-bindgen-test = "0.2"
 
 [features]
-default = []
-# Enable for better panic messages in dev builds (adds ~30KB due to std)
+default = ["console_error_panic_hook", "standalone"]
 console_error_panic_hook = ["dep:console_error_panic_hook"]
+# Enable the #[wasm_bindgen(start)] entry point. Disable when using
+# subduction_wasm as a dependency of another cdylib crate that defines
+# its own start function (wasm-bindgen allows only one per module).
+standalone = []
 # IndexedDB storage backend
 idb = ["sedimentree_wasm/idb"]
 std = [

sedimentree_wasm/src/storage.rs

@@ -137,7 +137,13 @@ impl Connection<Local> for JsConnection {
             let js_value = JsFuture::from(self.js_recv())
                 .await
                 .map_err(JsConnectionError::Recv)?;
-            let js_msg: JsMessage = JsCast::unchecked_into(js_value);
+            let js_msg: JsMessage =
+                js_value
+                    .dyn_into()
+                    .map_err(|value| JsConnectionError::UnexpectedJsType {
+                        expected: "Message",
+                        value,
+                    })?;
             let wasm_msg = WasmMessage::from(&js_msg);
             Ok(wasm_msg.into())
         }
@@ -149,8 +155,11 @@ impl Connection<Local> for JsConnection {
             #[allow(clippy::expect_used)]
             let js_value = JsFuture::from(self.js_next_request_id())
                 .await
-                .expect("nextRequestId should not fail");
-            let js_req_id: JsRequestId = js_value.unchecked_into();
+                .expect("JsConnection.nextRequestId() promise rejected");
+            #[allow(clippy::expect_used)]
+            let js_req_id: JsRequestId = js_value
+                .dyn_into()
+                .expect("JsConnection.nextRequestId() did not return a RequestId");
             let wasm_req_id = WasmRequestId::from(&js_req_id);
             wasm_req_id.into()
         }
@@ -169,7 +178,13 @@ impl Connection<Local> for JsConnection {
             let js_value = JsFuture::from(self.js_call(wasm_req, timeout_ms))
                 .await
                 .map_err(JsConnectionError::Call)?;
-            let js_resp: JsBatchSyncResponse = JsCast::unchecked_into(js_value);
+            let js_resp: JsBatchSyncResponse =
+                js_value
+                    .dyn_into()
+                    .map_err(|value| JsConnectionError::UnexpectedJsType {
+                        expected: "BatchSyncResponse",
+                        value,
+                    })?;
             let wasm_resp = WasmBatchSyncResponse::from(&js_resp);
             Ok(wasm_resp.into())
         }
@@ -195,6 +210,15 @@ pub enum JsConnectionError {
     /// An error that occurred during a synchronous call.
     #[error("Call error")]
     Call(JsValue),
+
+    /// A JS value could not be cast to the expected type.
+    #[error("JS type cast failed: expected {expected}, got {value:?}")]
+    UnexpectedJsType {
+        /// The type name that was expected.
+        expected: &'static str,
+        /// The actual JS value received.
+        value: JsValue,
+    },
 }
 
 impl From<JsConnectionError> for JsValue {

subduction_wasm/Cargo.toml

@@ -9,6 +9,29 @@ extern crate std;
 
 extern crate alloc;
 
+/// Install the console error panic hook so that panics produce readable
+/// error messages in the browser console.
+///
+/// Called automatically when the `standalone` feature is enabled.
+/// When `subduction_wasm` is used as a dependency of another cdylib crate,
+/// call this from that crate's own start function instead.
+pub fn set_panic_hook() {
+    #[cfg(feature = "console_error_panic_hook")]
+    console_error_panic_hook::set_once();
+}
+
+/// Entry point called when the Wasm module is instantiated.
+///
+/// Only compiled when the `standalone` feature is active. Downstream cdylib
+/// crates that define their own `#[wasm_bindgen(start)]` should depend on
+/// `subduction_wasm` with `default-features = false` and call
+/// [`set_panic_hook`] from their own start function.
+#[cfg(feature = "standalone")]
+#[wasm_bindgen::prelude::wasm_bindgen(start)]
+pub fn start() {
+    set_panic_hook();
+}
+
 pub mod connection;
 pub mod connection_id;
 pub mod error;