1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
use std::{sync::Weak, time::Duration};
use tokio::{
sync::Mutex,
time::{Instant, MissedTickBehavior},
};
use crate::TunnelType;
use super::{check::Check, error::Error};
/// Sleep time used when checking if an established connection is still working.
const REGULAR_LOOP_SLEEP: Duration = Duration::from_secs(1);
/// Reset the checker if the last check occurred this long ago
const SUSPEND_TIMEOUT: Duration = Duration::from_secs(6);
pub struct Monitor {
connectivity_check: Check,
}
impl Monitor {
pub fn init(connectivity_check: Check) -> Self {
Self { connectivity_check }
}
pub async fn run(
mut self,
tunnel_handle: Weak<Mutex<Option<TunnelType>>>,
) -> Result<(), Error> {
let mut last_check = Instant::now();
let mut interval = tokio::time::interval(REGULAR_LOOP_SLEEP);
interval.set_missed_tick_behavior(MissedTickBehavior::Delay);
loop {
if self.connectivity_check.should_shut_down() {
return Ok(());
}
let now = Instant::now();
let time_slept = now - last_check;
last_check = now;
if time_slept >= SUSPEND_TIMEOUT {
self.connectivity_check.reset(now).await;
} else if !self.tunnel_exists_and_is_connected(&tunnel_handle).await? {
return Ok(());
}
interval.tick().await;
}
}
async fn tunnel_exists_and_is_connected(
&mut self,
tunnel_handle: &Weak<Mutex<Option<TunnelType>>>,
) -> Result<bool, Error> {
let Some(tunnel) = tunnel_handle.upgrade() else {
// Tunnel closed
return Ok(false);
};
let lock = tunnel.lock().await;
let Some(tunnel) = lock.as_ref() else {
// Tunnel closed
return Ok(false);
};
self.connectivity_check
.check_connectivity(Instant::now(), tunnel.as_ref())
.await
}
}
#[cfg(test)]
mod test {
use super::*;
use std::{
sync::{
Arc,
atomic::{AtomicBool, Ordering},
},
time::Duration,
};
use tokio::sync::{Mutex, mpsc};
use crate::connectivity::{constants::*, mock::*};
#[tokio::test(start_paused = true)]
/// Verify that the connectivity monitor doesn't fail if the tunnel constantly sends traffic,
/// and it shuts down properly.
async fn test_wait_loop() {
let (result_tx, mut result_rx) = mpsc::channel(1);
let tunnel = MockTunnel::always_incrementing().boxed();
let pinger = MockPinger::default();
let (mut checker, stop_tx) = {
let now = Instant::now();
let start = now.checked_sub(Duration::from_secs(1)).unwrap();
mock_checker(start, Box::new(pinger))
};
tokio::spawn(async move {
let start_result = checker.establish_connectivity(tunnel.as_ref()).await;
result_tx.send(start_result).await.unwrap();
// Pointer dance
let tunnel = Arc::new(Mutex::new(Some(tunnel)));
let _tunnel = Arc::downgrade(&tunnel);
let result = Monitor::init(checker).run(_tunnel).await.map(|_| true);
result_tx.send(result).await.unwrap();
});
tokio::time::sleep(Duration::from_secs(1)).await;
assert!(result_rx.try_recv().unwrap().unwrap());
stop_tx.close();
tokio::time::sleep(Duration::from_secs(2)).await;
assert!(result_rx.try_recv().unwrap().is_ok());
}
#[tokio::test(start_paused = true)]
/// Verify that the connectivity monitor detects the tunnel timing out after no longer than
/// `BYTES_RX_TIMEOUT` and `PING_TIMEOUT` combined.
async fn test_wait_loop_timeout() {
let stop_bytes_rx = Arc::new(AtomicBool::new(false));
let stop_bytes_rx_inner = stop_bytes_rx.clone();
let mut map = StatsMap::new();
map.insert([0u8; 32], Stats::default());
let tunnel_stats = std::sync::Mutex::new(map);
let pinger = MockPinger::default();
let tunnel = MockTunnel::new(move || {
let mut tunnel_stats = tunnel_stats.lock().unwrap();
if !stop_bytes_rx_inner.load(Ordering::SeqCst) {
for traffic in tunnel_stats.values_mut() {
traffic.rx_bytes += 1;
}
}
for traffic in tunnel_stats.values_mut() {
traffic.tx_bytes += 1;
}
Ok(tunnel_stats.clone())
})
.boxed();
let (result_tx, mut result_rx) = mpsc::channel(1);
tokio::spawn(async move {
let (mut checker, _cancellation_token) = {
let now = Instant::now();
let start = now.checked_sub(Duration::from_secs(1)).unwrap();
mock_checker(start, Box::new(pinger))
};
let start_result = checker.establish_connectivity(tunnel.as_ref()).await;
result_tx.send(start_result).await.unwrap();
// Pointer dance
let _tunnel = Arc::new(Mutex::new(Some(tunnel)));
let tunnel = Arc::downgrade(&_tunnel);
let end_result = Monitor::init(checker).run(tunnel).await.map(|_| true);
result_tx
.send(end_result)
.await
.expect("Failed to send result");
});
assert!(
tokio::time::timeout(Duration::from_secs(1), result_rx.recv())
.await
.unwrap()
.unwrap()
.unwrap()
);
stop_bytes_rx.store(true, Ordering::SeqCst);
assert!(
tokio::time::timeout(
BYTES_RX_TIMEOUT + PING_TIMEOUT + Duration::from_secs(2),
result_rx.recv()
)
.await
.unwrap()
.unwrap()
.is_ok()
);
}
}
|
