client: sort out shutdown procedure and harmonize with socks5-client (#2695)

* common/task: rename ShutdownNotifier to TaskManager

* nym-client: return boxed error

* nym-client: enable graceful shutdown

* nym-client: task wait on shutdown to instead exit on closed channel

* Fix build

* Fix unused

* changelog: update

mixnode/src/node/listener/connection_handler/mod.rs

@@ -5,7 +5,7 @@ use crate::node::listener::connection_handler::packet_processing::{
     MixProcessingResult, PacketProcessor,
 };
 use crate::node::packet_delayforwarder::PacketDelayForwardSender;
-use crate::node::ShutdownListener;
+use crate::node::TaskClient;
 use futures::StreamExt;
 use log::{error, info};
 use nymsphinx::forwarding::packet::MixPacket;
@@ -74,7 +74,7 @@ impl ConnectionHandler {
         self,
         conn: TcpStream,
         remote: SocketAddr,
-        mut shutdown: ShutdownListener,
+        mut shutdown: TaskClient,
     ) {
         debug!("Starting connection handler for {:?}", remote);
         let mut framed_conn = Framed::new(conn, SphinxCodec);

mixnode/src/node/listener/mod.rs

@@ -8,17 +8,17 @@ use std::process;
 use tokio::net::TcpListener;
 use tokio::task::JoinHandle;
 
-use super::ShutdownListener;
+use super::TaskClient;
 
 pub(crate) mod connection_handler;
 
 pub(crate) struct Listener {
     address: SocketAddr,
-    shutdown: ShutdownListener,
+    shutdown: TaskClient,
 }
 
 impl Listener {
-    pub(crate) fn new(address: SocketAddr, shutdown: ShutdownListener) -> Self {
+    pub(crate) fn new(address: SocketAddr, shutdown: TaskClient) -> Self {
         Listener { address, shutdown }
     }
 

mixnode/src/node/mod.rs

@@ -26,7 +26,7 @@ use rand::thread_rng;
 use std::net::SocketAddr;
 use std::process;
 use std::sync::Arc;
-use task::{wait_for_signal, ShutdownListener, ShutdownNotifier};
+use task::{wait_for_signal, TaskClient, TaskManager};
 use version_checker::parse_version;
 
 mod http;
@@ -153,7 +153,7 @@ impl MixNode {
 
     fn start_node_stats_controller(
         &self,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> (SharedNodeStats, node_statistics::UpdateSender) {
         info!("Starting node stats controller...");
         let controller = node_statistics::Controller::new(
@@ -171,7 +171,7 @@ impl MixNode {
         &self,
         node_stats_update_sender: node_statistics::UpdateSender,
         delay_forwarding_channel: PacketDelayForwardSender,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) {
         info!("Starting socket listener...");
 
@@ -191,7 +191,7 @@ impl MixNode {
     fn start_packet_delay_forwarder(
         &mut self,
         node_stats_update_sender: node_statistics::UpdateSender,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> PacketDelayForwardSender {
         info!("Starting packet delay-forwarder...");
 
@@ -215,7 +215,7 @@ impl MixNode {
         packet_sender
     }
 
-    fn start_verloc_measurements(&self, shutdown: ShutdownListener) -> AtomicVerlocResult {
+    fn start_verloc_measurements(&self, shutdown: TaskClient) -> AtomicVerlocResult {
         info!("Starting the round-trip-time measurer...");
 
         // this is a sanity check to make sure we didn't mess up with the minimum version at some point
@@ -288,7 +288,7 @@ impl MixNode {
             .map(|node| node.bond_information.mix_node.identity_key.clone())
     }
 
-    async fn wait_for_interrupt(&self, mut shutdown: ShutdownNotifier) {
+    async fn wait_for_interrupt(&self, mut shutdown: TaskManager) {
         wait_for_signal().await;
 
         log::info!("Sending shutdown");
@@ -315,7 +315,7 @@ impl MixNode {
             }
         }
 
-        let shutdown = ShutdownNotifier::default();
+        let shutdown = TaskManager::default();
 
         let (node_stats_pointer, node_stats_update_sender) =
             self.start_node_stats_controller(shutdown.subscribe());

mixnode/src/node/node_statistics.rs

@@ -9,7 +9,7 @@ use std::sync::Arc;
 use std::time::{Duration, SystemTime};
 use tokio::sync::{RwLock, RwLockReadGuard};
 
-use super::ShutdownListener;
+use super::TaskClient;
 
 // convenience aliases
 type PacketsMap = HashMap<String, u64>;
@@ -211,14 +211,14 @@ impl CurrentPacketData {
 struct UpdateHandler {
     current_data: CurrentPacketData,
     update_receiver: PacketDataReceiver,
-    shutdown: ShutdownListener,
+    shutdown: TaskClient,
 }
 
 impl UpdateHandler {
     fn new(
         current_data: CurrentPacketData,
         update_receiver: PacketDataReceiver,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> Self {
         UpdateHandler {
             current_data,
@@ -293,7 +293,7 @@ struct StatsUpdater {
     updating_delay: Duration,
     current_packet_data: CurrentPacketData,
     current_stats: SharedNodeStats,
-    shutdown: ShutdownListener,
+    shutdown: TaskClient,
 }
 
 impl StatsUpdater {
@@ -301,7 +301,7 @@ impl StatsUpdater {
         updating_delay: Duration,
         current_packet_data: CurrentPacketData,
         current_stats: SharedNodeStats,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> Self {
         StatsUpdater {
             updating_delay,
@@ -335,11 +335,11 @@ impl StatsUpdater {
 struct PacketStatsConsoleLogger {
     logging_delay: Duration,
     stats: SharedNodeStats,
-    shutdown: ShutdownListener,
+    shutdown: TaskClient,
 }
 
 impl PacketStatsConsoleLogger {
-    fn new(logging_delay: Duration, stats: SharedNodeStats, shutdown: ShutdownListener) -> Self {
+    fn new(logging_delay: Duration, stats: SharedNodeStats, shutdown: TaskClient) -> Self {
         PacketStatsConsoleLogger {
             logging_delay,
             stats,
@@ -451,7 +451,7 @@ impl Controller {
     pub(crate) fn new(
         logging_delay: Duration,
         stats_updating_delay: Duration,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> Self {
         let (sender, receiver) = mpsc::unbounded();
         let shared_packet_data = CurrentPacketData::new();
@@ -503,13 +503,13 @@ impl Controller {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use task::ShutdownNotifier;
+    use task::TaskManager;
 
     #[tokio::test]
     async fn node_stats_reported_are_received() {
         let logging_delay = Duration::from_millis(20);
         let stats_updating_delay = Duration::from_millis(10);
-        let shutdown = ShutdownNotifier::default();
+        let shutdown = TaskManager::default();
         let node_stats_controller =
             Controller::new(logging_delay, stats_updating_delay, shutdown.subscribe());
 

mixnode/src/node/packet_delayforwarder.rs

@@ -9,7 +9,7 @@ use nymsphinx::forwarding::packet::MixPacket;
 use std::io;
 use tokio::time::Instant;
 
-use super::ShutdownListener;
+use super::TaskClient;
 
 // Delay + MixPacket vs Instant + MixPacket
 
@@ -28,7 +28,7 @@ where
     packet_sender: PacketDelayForwardSender,
     packet_receiver: PacketDelayForwardReceiver,
     node_stats_update_sender: UpdateSender,
-    shutdown: ShutdownListener,
+    shutdown: TaskClient,
 }
 
 impl<C> DelayForwarder<C>
@@ -38,7 +38,7 @@ where
     pub(crate) fn new(
         client: C,
         node_stats_update_sender: UpdateSender,
-        shutdown: ShutdownListener,
+        shutdown: TaskClient,
     ) -> DelayForwarder<C> {
         let (packet_sender, packet_receiver) = mpsc::unbounded();
 
@@ -134,7 +134,7 @@ mod tests {
     use std::sync::{Arc, Mutex};
     use std::time::Duration;
 
-    use task::ShutdownNotifier;
+    use task::TaskManager;
 
     use nymsphinx::addressing::nodes::NymNodeRoutingAddress;
     use nymsphinx_params::packet_sizes::PacketSize;
@@ -205,7 +205,7 @@ mod tests {
         let node_stats_update_sender = UpdateSender::new(stats_sender);
         let client = TestClient::default();
         let client_packets_sent = client.packets_sent.clone();
-        let shutdown = ShutdownNotifier::default();
+        let shutdown = TaskManager::default();
         let mut delay_forwarder =
             DelayForwarder::new(client, node_stats_update_sender, shutdown.subscribe());
         let packet_sender = delay_forwarder.sender();