feat(2.0, nodejs): Silently request to stop background syncing when `…

…WalletMethodHandler` is dropped (#1793) * feat(nodejs): Silently stop background syncing when Wallet is dropped * fmt * chore: Also call request_stop_background_syncing when destroyed manually
iotaledger · Jan 10, 2024 · 7dfc8e3 · 7dfc8e3
1 parent 2576174
commit 7dfc8e3
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 9 deletions.
diff --git a/bindings/nodejs/src/wallet.rs b/bindings/nodejs/src/wallet.rs
@@ -1,7 +1,10 @@
 // Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-use std::sync::Arc;
+use std::{
+    ops::{Deref, DerefMut},
+    sync::Arc,
+};
 
 use iota_sdk_bindings_core::{
     call_wallet_method as rust_call_wallet_method,
@@ -16,26 +19,58 @@ use crate::{
     build_js_error, client::ClientMethodHandler, destroyed_err, secret_manager::SecretManagerMethodHandler, NodejsError,
 };
 
-pub type WalletMethodHandler = Arc<RwLock<Option<Wallet>>>;
+pub struct WalletMethodHandlerInner(Option<Wallet>);
+
+impl Drop for WalletMethodHandlerInner {
+    fn drop(&mut self) {
+        log::debug!("drop WalletMethodHandlerInner");
+        // Request to stop the background syncing silently if this wallet hasn't been destroyed yet
+        if let Some(wallet) = self.0.take() {
+            wallet.request_stop_background_syncing();
+        }
+    }
+}
+
+impl Deref for WalletMethodHandlerInner {
+    type Target = Option<Wallet>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for WalletMethodHandlerInner {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+pub type WalletMethodHandler = Arc<RwLock<WalletMethodHandlerInner>>;
 
 #[napi(js_name = "createWallet")]
 pub async fn create_wallet(options: String) -> Result<External<WalletMethodHandler>> {
     let wallet_options = serde_json::from_str::<WalletOptions>(&options).map_err(NodejsError::new)?;
     let wallet = wallet_options.build().await.map_err(NodejsError::new)?;
 
-    Ok(External::new(Arc::new(RwLock::new(Some(wallet)))))
+    Ok(External::new(Arc::new(RwLock::new(WalletMethodHandlerInner(Some(
+        wallet,
+    ))))))
 }
 
 #[napi(js_name = "destroyWallet")]
 pub async fn destroy_wallet(wallet: External<WalletMethodHandler>) {
-    *wallet.as_ref().write().await = None;
+    let mut wallet = wallet.as_ref().write().await;
+    if let Some(wallet) = &**wallet {
+        wallet.request_stop_background_syncing();
+    }
+    **wallet = None;
 }
 
 #[napi(js_name = "callWalletMethod")]
 pub async fn call_wallet_method(wallet: External<WalletMethodHandler>, method: String) -> Result<String> {
     let method = serde_json::from_str::<WalletMethod>(&method).map_err(NodejsError::new)?;
 
-    match &*wallet.as_ref().read().await {
+    match &**wallet.as_ref().read().await {
         Some(wallet) => {
             let response = rust_call_wallet_method(wallet, method).await;
             match response {
@@ -58,7 +93,7 @@ pub async fn listen_wallet(
         validated_event_types.push(WalletEventType::try_from(event_type).map_err(NodejsError::new)?);
     }
 
-    match &*wallet.as_ref().read().await {
+    match &**wallet.as_ref().read().await {
         Some(wallet) => {
             wallet
                 .listen(validated_event_types, move |event_data| {
@@ -78,7 +113,7 @@ pub async fn listen_wallet(
 
 #[napi(js_name = "getClient")]
 pub async fn get_client(wallet: External<WalletMethodHandler>) -> Result<External<ClientMethodHandler>> {
-    if let Some(wallet) = &*wallet.as_ref().read().await {
+    if let Some(wallet) = &**wallet.as_ref().read().await {
         Ok(External::new(Arc::new(RwLock::new(Some(wallet.client().clone())))))
     } else {
         Err(destroyed_err("Wallet"))
@@ -87,7 +122,7 @@ pub async fn get_client(wallet: External<WalletMethodHandler>) -> Result<Externa
 
 #[napi(js_name = "getSecretManager")]
 pub async fn get_secret_manager(wallet: External<WalletMethodHandler>) -> Result<External<SecretManagerMethodHandler>> {
-    if let Some(wallet) = &*wallet.as_ref().read().await {
+    if let Some(wallet) = &**wallet.as_ref().read().await {
         Ok(External::new(wallet.get_secret_manager().clone()))
     } else {
         Err(destroyed_err("Wallet"))

diff --git a/sdk/src/wallet/core/operations/background_syncing.rs b/sdk/src/wallet/core/operations/background_syncing.rs
@@ -72,6 +72,12 @@ where
         Ok(())
     }
 
+    /// Request to stop the background syncing of the wallet
+    pub fn request_stop_background_syncing(&self) {
+        log::debug!("[request_stop_background_syncing]");
+        self.background_syncing_status.store(2, Ordering::Relaxed);
+    }
+
     /// Stop the background syncing of the wallet
     pub async fn stop_background_syncing(&self) -> crate::wallet::Result<()> {
         log::debug!("[stop_background_syncing]");
@@ -80,7 +86,7 @@ where
             return Ok(());
         }
         // send stop request
-        self.background_syncing_status.store(2, Ordering::Relaxed);
+        self.request_stop_background_syncing();
         // wait until it stopped
         while self.background_syncing_status.load(Ordering::Relaxed) != 0 {
             #[cfg(target_family = "wasm")]