chore: fire shutdown signal on anvil node handle drop

crates/anvil/src/lib.rs

@@ -253,32 +253,32 @@ pub async fn try_spawn(mut config: NodeConfig) -> io::Result<(EthApi, NodeHandle
 
 type IpcTask = JoinHandle<()>;
 
-/// A handle to the spawned node and server tasks
+/// A handle to the spawned node and server tasks.
 ///
 /// This future will resolve if either the node or server task resolve/fail.
 pub struct NodeHandle {
     config: NodeConfig,
-    /// The address of the running rpc server
+    /// The address of the running rpc server.
     addresses: Vec<SocketAddr>,
-    /// Join handle for the Node Service
+    /// Join handle for the Node Service.
     pub node_service: JoinHandle<Result<(), NodeError>>,
     /// Join handles (one per socket) for the Anvil server.
     pub servers: Vec<JoinHandle<Result<(), NodeError>>>,
-    // The future that joins the ipc server, if any
+    /// The future that joins the ipc server, if any.
     ipc_task: Option<IpcTask>,
     /// A signal that fires the shutdown, fired on drop.
     _signal: Option<Signal>,
-    /// A task manager that can be used to spawn additional tasks
+    /// A task manager that can be used to spawn additional tasks.
     task_manager: TaskManager,
 }
 
 impl NodeHandle {
-    /// The [NodeConfig] the node was launched with
+    /// The [NodeConfig] the node was launched with.
     pub fn config(&self) -> &NodeConfig {
         &self.config
     }
 
-    /// Prints the launch info
+    /// Prints the launch info.
     pub(crate) fn print(&self, fork: Option<&ClientFork>) {
         self.config.print(fork);
         if !self.config.silent {
@@ -296,25 +296,25 @@ impl NodeHandle {
         }
     }
 
-    /// The address of the launched server
+    /// The address of the launched server.
     ///
     /// **N.B.** this may not necessarily be the same `host + port` as configured in the
-    /// `NodeConfig`, if port was set to 0, then the OS auto picks an available port
+    /// `NodeConfig`, if port was set to 0, then the OS auto picks an available port.
     pub fn socket_address(&self) -> &SocketAddr {
         &self.addresses[0]
     }
 
-    /// Returns the http endpoint
+    /// Returns the http endpoint.
     pub fn http_endpoint(&self) -> String {
         format!("http://{}", self.socket_address())
     }
 
-    /// Returns the websocket endpoint
+    /// Returns the websocket endpoint.
     pub fn ws_endpoint(&self) -> String {
         format!("ws://{}", self.socket_address())
     }
 
-    /// Returns the path of the launched ipc server, if any
+    /// Returns the path of the launched ipc server, if any.
     pub fn ipc_path(&self) -> Option<String> {
         self.config.get_ipc_path()
     }
@@ -334,44 +334,51 @@ impl NodeHandle {
         ProviderBuilder::new(&self.config.get_ipc_path()?).build().ok()
     }
 
-    /// Signer accounts that can sign messages/transactions from the EVM node
+    /// Signer accounts that can sign messages/transactions from the EVM node.
     pub fn dev_accounts(&self) -> impl Iterator<Item = Address> + '_ {
         self.config.signer_accounts.iter().map(|wallet| wallet.address())
     }
 
-    /// Signer accounts that can sign messages/transactions from the EVM node
+    /// Signer accounts that can sign messages/transactions from the EVM node.
     pub fn dev_wallets(&self) -> impl Iterator<Item = PrivateKeySigner> + '_ {
         self.config.signer_accounts.iter().cloned()
     }
 
-    /// Accounts that will be initialised with `genesis_balance` in the genesis block
+    /// Accounts that will be initialised with `genesis_balance` in the genesis block.
     pub fn genesis_accounts(&self) -> impl Iterator<Item = Address> + '_ {
         self.config.genesis_accounts.iter().map(|w| w.address())
     }
 
-    /// Native token balance of every genesis account in the genesis block
+    /// Native token balance of every genesis account in the genesis block.
     pub fn genesis_balance(&self) -> U256 {
         self.config.genesis_balance
     }
 
-    /// Default gas price for all txs
+    /// Default gas price for all txs.
     pub fn gas_price(&self) -> u128 {
         self.config.get_gas_price()
     }
 
-    /// Returns the shutdown signal
+    /// Returns the shutdown signal.
     pub fn shutdown_signal(&self) -> &Option<Signal> {
         &self._signal
     }
 
-    /// Returns mutable access to the shutdown signal
+    /// Returns mutable access to the shutdown signal.
     ///
-    /// This can be used to extract the Signal
+    /// This can be used to extract the Signal.
     pub fn shutdown_signal_mut(&mut self) -> &mut Option<Signal> {
         &mut self._signal
     }
 
-    /// Returns the task manager that can be used to spawn new tasks
+    /// Fires shutdown signal.
+    ///
+    /// Called by long-running tests to make sure anvil instance is terminated.
+    pub fn fire_shutdown_signal(&mut self) {
+        self._signal.take().map(|signal| signal.fire());
+    }
+
+    /// Returns the task manager that can be used to spawn new tasks.
     ///
     /// ```
     /// use anvil::NodeHandle;

crates/anvil/tests/it/anvil_api.rs

@@ -793,7 +793,5 @@ async fn test_reorg() {
         .await;
     assert!(res.is_err());
 
-    if let Some(signal) = handle.shutdown_signal_mut().take() {
-        signal.fire().unwrap();
-    }
+    handle.fire_shutdown_signal();
 }

crates/anvil/tests/it/gas.rs

@@ -201,7 +201,5 @@ async fn test_can_use_fee_history() {
         assert_eq!(latest_fee_history_fee, next_base_fee);
     }
 
-    if let Some(signal) = handle.shutdown_signal_mut().take() {
-        signal.fire().unwrap();
-    }
+    handle.fire_shutdown_signal();
 }

crates/anvil/tests/it/proof.rs

@@ -131,7 +131,5 @@ async fn can_get_random_account_proofs() {
             .unwrap_or_else(|_| panic!("Failed to get proof for {acc:?}"));
     }
 
-    if let Some(signal) = handle.shutdown_signal_mut().take() {
-        signal.fire().unwrap();
-    }
+    handle.fire_shutdown_signal();
 }

crates/anvil/tests/it/traces.rs

@@ -860,7 +860,5 @@ async fn test_trace_filter() {
     let traces = api.trace_filter(tracer).await.unwrap();
     assert_eq!(traces.len(), 5);
 
-    if let Some(signal) = handle.shutdown_signal_mut().take() {
-        signal.fire().unwrap();
-    }
+    handle.fire_shutdown_signal();
 }