Overall wasm refactoring & improvements

Author: encounter

Cargo.lock

@@ -23,7 +23,7 @@ mips = ["any-arch", "rabbitizer"]
 ppc = ["any-arch", "cwdemangle", "cwextab", "ppc750cl"]
 x86 = ["any-arch", "cpp_demangle", "iced-x86", "msvc-demangler"]
 arm = ["any-arch", "cpp_demangle", "unarm", "arm-attr"]
-wasm = ["serde_json"]
+wasm = ["serde_json", "console_error_panic_hook", "console_log"]
 
 [dependencies]
 anyhow = "1.0.82"
@@ -40,6 +40,9 @@ serde = { version = "1", features = ["derive"] }
 similar = { version = "2.5.0", default-features = false }
 strum = { version = "0.26.2", features = ["derive"] }
 wasm-bindgen = "0.2.93"
+tsify-next = { version = "0.5.4", default-features = false, features = ["js"] }
+console_log = { version = "1.0.0", optional = true }
+console_error_panic_hook = { version = "0.1.7", optional = true }
 
 # config
 globset = { version = "0.4.14", features = ["serde1"], optional = true }

objdiff-core/Cargo.toml

@@ -1,53 +1,78 @@
-use anyhow::Context;
 use prost::Message;
 use wasm_bindgen::prelude::*;
 
 use crate::{bindings::diff::DiffResult, diff, obj};
 
-#[wasm_bindgen]
-pub fn run_diff(
+fn parse_object(
+    data: Option<Box<[u8]>>,
+    config: &diff::DiffObjConfig,
+) -> Result<Option<obj::ObjInfo>, JsError> {
+    data.as_ref().map(|data| obj::read::parse(data, config)).transpose().to_js()
+}
+
+fn parse_and_run_diff(
     left: Option<Box<[u8]>>,
     right: Option<Box<[u8]>>,
     config: diff::DiffObjConfig,
-) -> Result<String, JsError> {
-    let target = left
-        .as_ref()
-        .map(|data| obj::read::parse(data, &config).context("Loading target"))
-        .transpose()
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let base = right
-        .as_ref()
-        .map(|data| obj::read::parse(data, &config).context("Loading base"))
-        .transpose()
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let result = diff::diff_objs(&config, target.as_ref(), base.as_ref(), None)
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let left = target.as_ref().and_then(|o| result.left.as_ref().map(|d| (o, d)));
-    let right = base.as_ref().and_then(|o| result.right.as_ref().map(|d| (o, d)));
-    let out = DiffResult::new(left, right);
-    serde_json::to_string(&out).map_err(|e| JsError::new(&e.to_string()))
+) -> Result<DiffResult, JsError> {
+    let target = parse_object(left, &config)?;
+    let base = parse_object(right, &config)?;
+    run_diff(target.as_ref(), base.as_ref(), config)
+}
+
+fn run_diff(
+    left: Option<&obj::ObjInfo>,
+    right: Option<&obj::ObjInfo>,
+    config: diff::DiffObjConfig,
+) -> Result<DiffResult, JsError> {
+    log::debug!("Running diff with config: {:?}", config);
+    let result = diff::diff_objs(&config, left, right, None).to_js()?;
+    let left = left.and_then(|o| result.left.as_ref().map(|d| (o, d)));
+    let right = right.and_then(|o| result.right.as_ref().map(|d| (o, d)));
+    Ok(DiffResult::new(left, right))
 }
 
+// #[wasm_bindgen]
+// pub fn run_diff_json(
+//     left: Option<Box<[u8]>>,
+//     right: Option<Box<[u8]>>,
+//     config: diff::DiffObjConfig,
+// ) -> Result<String, JsError> {
+//     let out = run_diff_opt_box(left, right, config)?;
+//     serde_json::to_string(&out).map_err(|e| JsError::new(&e.to_string()))
+// }
+
 #[wasm_bindgen]
 pub fn run_diff_proto(
     left: Option<Box<[u8]>>,
     right: Option<Box<[u8]>>,
     config: diff::DiffObjConfig,
 ) -> Result<Box<[u8]>, JsError> {
-    let target = left
-        .as_ref()
-        .map(|data| obj::read::parse(data, &config).context("Loading target"))
-        .transpose()
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let base = right
-        .as_ref()
-        .map(|data| obj::read::parse(data, &config).context("Loading base"))
-        .transpose()
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let result = diff::diff_objs(&config, target.as_ref(), base.as_ref(), None)
-        .map_err(|e| JsError::new(&e.to_string()))?;
-    let left = target.as_ref().and_then(|o| result.left.as_ref().map(|d| (o, d)));
-    let right = base.as_ref().and_then(|o| result.right.as_ref().map(|d| (o, d)));
-    let out = DiffResult::new(left, right);
+    let out = parse_and_run_diff(left, right, config)?;
     Ok(out.encode_to_vec().into_boxed_slice())
 }
+
+#[wasm_bindgen(start)]
+fn start() -> Result<(), JsError> {
+    console_error_panic_hook::set_once();
+    #[cfg(debug_assertions)]
+    console_log::init_with_level(log::Level::Debug).to_js()?;
+    #[cfg(not(debug_assertions))]
+    console_log::init_with_level(log::Level::Info).to_js()?;
+    Ok(())
+}
+
+#[inline]
+fn to_js_error(e: impl std::fmt::Display) -> JsError { JsError::new(&e.to_string()) }
+
+trait ToJsResult {
+    type Output;
+
+    fn to_js(self) -> Result<Self::Output, JsError>;
+}
+
+impl<T, E: std::fmt::Display> ToJsResult for Result<T, E> {
+    type Output = T;
+
+    fn to_js(self) -> Result<T, JsError> { self.map_err(to_js_error) }
+}

objdiff-core/src/bindings/wasm.rs

@@ -1,7 +1,6 @@
 use std::collections::HashSet;
 
 use anyhow::Result;
-use wasm_bindgen::prelude::wasm_bindgen;
 
 use crate::{
     diff::{
@@ -18,7 +17,6 @@ pub mod code;
 pub mod data;
 pub mod display;
 
-#[wasm_bindgen]
 #[derive(
     Debug,
     Copy,
@@ -30,6 +28,7 @@ pub mod display;
     serde::Serialize,
     strum::VariantArray,
     strum::EnumMessage,
+    tsify_next::Tsify,
 )]
 pub enum X86Formatter {
     #[default]
@@ -43,7 +42,6 @@ pub enum X86Formatter {
     Masm,
 }
 
-#[wasm_bindgen]
 #[derive(
     Debug,
     Copy,
@@ -55,6 +53,7 @@ pub enum X86Formatter {
     serde::Serialize,
     strum::VariantArray,
     strum::EnumMessage,
+    tsify_next::Tsify,
 )]
 pub enum MipsAbi {
     #[default]
@@ -68,7 +67,6 @@ pub enum MipsAbi {
     N64,
 }
 
-#[wasm_bindgen]
 #[derive(
     Debug,
     Copy,
@@ -80,6 +78,7 @@ pub enum MipsAbi {
     serde::Serialize,
     strum::VariantArray,
     strum::EnumMessage,
+    tsify_next::Tsify,
 )]
 pub enum MipsInstrCategory {
     #[default]
@@ -97,7 +96,6 @@ pub enum MipsInstrCategory {
     R5900,
 }
 
-#[wasm_bindgen]
 #[derive(
     Debug,
     Copy,
@@ -109,6 +107,7 @@ pub enum MipsInstrCategory {
     serde::Serialize,
     strum::VariantArray,
     strum::EnumMessage,
+    tsify_next::Tsify,
 )]
 pub enum ArmArchVersion {
     #[default]
@@ -122,7 +121,6 @@ pub enum ArmArchVersion {
     V6K,
 }
 
-#[wasm_bindgen]
 #[derive(
     Debug,
     Copy,
@@ -134,6 +132,7 @@ pub enum ArmArchVersion {
     serde::Serialize,
     strum::VariantArray,
     strum::EnumMessage,
+    tsify_next::Tsify,
 )]
 pub enum ArmR9Usage {
     #[default]
@@ -154,8 +153,8 @@ pub enum ArmR9Usage {
 #[inline]
 const fn default_true() -> bool { true }
 
-#[wasm_bindgen]
-#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
+#[derive(Debug, Clone, Eq, PartialEq, serde::Deserialize, serde::Serialize, tsify_next::Tsify)]
+#[tsify(from_wasm_abi)]
 #[serde(default)]
 pub struct DiffObjConfig {
     pub relax_reloc_diffs: bool,
@@ -207,9 +206,6 @@ impl DiffObjConfig {
     }
 }
 
-#[wasm_bindgen]
-pub fn default_diff_obj_config() -> DiffObjConfig { Default::default() }
-
 #[derive(Debug, Clone)]
 pub struct ObjSectionDiff {
     pub symbols: Vec<ObjSymbolDiff>,

objdiff-core/src/diff/mod.rs

@@ -7,5 +7,22 @@ export default [
     {languageOptions: {globals: globals.browser}},
     pluginJs.configs.recommended,
     ...tseslint.configs.recommended,
-    {rules: {"semi": [2, "always"]}},
+    {
+        rules: {
+            "semi": [2, "always"],
+            "@typescript-eslint/no-unused-vars": [
+                "error",
+                // https://typescript-eslint.io/rules/no-unused-vars/#benefits-over-typescript
+                {
+                    "args": "all",
+                    "argsIgnorePattern": "^_",
+                    "caughtErrors": "all",
+                    "caughtErrorsIgnorePattern": "^_",
+                    "destructuredArrayIgnorePattern": "^_",
+                    "varsIgnorePattern": "^_",
+                    "ignoreRestSiblings": true
+                },
+            ],
+        }
+    },
 ];