Merge pull request #80 from holochain/0.3-make-close-on-drop-clone-safe

0.3 make close on drop clone safe

CHANGELOG.md

@@ -9,6 +9,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 ### Removed
 
+## 2024-05-28: v0.5.0-rc.4
+### Fixed
+- The app websocket was closing connections when cloned versions of itself were dropped.
+
 ## 2024-05-28: v0.5.0-rc.3
 ### Fixed
 - Dropping admin or app connections will now close the connection.

Cargo.toml

@@ -9,7 +9,7 @@ name = "holochain_client"
 readme = "README.md"
 repository = "https://github.com/holochain/holochain-client-rust"
 resolver = "2"
-version = "0.5.0-rc.3"
+version = "0.5.0-rc.4"
 
 [workspace]
 members = ["fixture/zomes/foo"]

src/app_websocket_inner.rs

@@ -10,12 +10,14 @@ use std::{net::ToSocketAddrs, sync::Arc};
 use tokio::sync::Mutex;
 use tokio::task::AbortHandle;
 
+struct AbortOnDropHandle(AbortHandle);
+
 /// The core functionality for an app websocket.
 #[derive(Clone)]
 pub(crate) struct AppWebsocketInner {
     tx: WebsocketSender,
     event_emitter: Arc<Mutex<EventEmitter>>,
-    abort_handle: Arc<AbortHandle>,
+    _abort_handle: Arc<AbortOnDropHandle>,
 }
 
 impl AppWebsocketInner {
@@ -51,7 +53,7 @@ impl AppWebsocketInner {
         Ok(Self {
             tx,
             event_emitter: mutex,
-            abort_handle: Arc::new(poll_handle.abort_handle()),
+            _abort_handle: Arc::new(AbortOnDropHandle(poll_handle.abort_handle())),
         })
     }
 
@@ -96,8 +98,8 @@ impl AppWebsocketInner {
     }
 }
 
-impl Drop for AppWebsocketInner {
+impl Drop for AbortOnDropHandle {
     fn drop(&mut self) {
-        self.abort_handle.abort();
+        self.0.abort();
     }
 }

tests/app.rs

@@ -186,3 +186,57 @@ async fn handle_signal() {
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct TestString(pub String);
+
+#[tokio::test(flavor = "multi_thread")]
+async fn close_on_drop_is_clone_safe() {
+    let conductor = SweetConductor::from_standard_config().await;
+
+    // Connect admin client
+    let admin_port = conductor.get_arbitrary_admin_websocket_port().unwrap();
+    let admin_ws = AdminWebsocket::connect((Ipv4Addr::LOCALHOST, admin_port))
+        .await
+        .unwrap();
+
+    // Set up the test app
+    let app_id: InstalledAppId = "test-app".into();
+    let agent_key = admin_ws.generate_agent_pub_key().await.unwrap();
+    let app_info = admin_ws
+        .install_app(InstallAppPayload {
+            agent_key: agent_key.clone(),
+            installed_app_id: Some(app_id.clone()),
+            membrane_proofs: HashMap::new(),
+            network_seed: None,
+            source: AppBundleSource::Path(PathBuf::from("./fixture/test.happ")),
+        })
+        .await
+        .unwrap();
+    admin_ws.enable_app(app_id.clone()).await.unwrap();
+
+    // Connect app client
+    let app_ws_port = admin_ws
+        .attach_app_interface(0, AllowedOrigins::Any, None)
+        .await
+        .unwrap();
+    let token_issued = admin_ws
+        .issue_app_auth_token(app_id.clone().into())
+        .await
+        .unwrap();
+    let signer = ClientAgentSigner::default().into();
+    let app_ws = AppWebsocket::connect(
+        (Ipv4Addr::LOCALHOST, app_ws_port),
+        token_issued.token,
+        signer,
+    )
+    .await
+    .unwrap();
+
+    {
+        let app_ws_2 = app_ws.clone();
+        let app_info_2 = app_ws_2.app_info().await.unwrap().unwrap();
+        assert_eq!(app_info.installed_app_id, app_info_2.installed_app_id);
+    }
+
+    // Should still work after dropping the first app_ws
+    let app_info_3 = app_ws.app_info().await.unwrap().unwrap();
+    assert_eq!(app_info.installed_app_id, app_info_3.installed_app_id);
+}