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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
#![recursion_limit = "256"]
#![doc(
html_logo_url = "https://github.com/maidsafe/QA/raw/master/Images/maidsafe_logo.png",
html_favicon_url = "https://maidsafe.net/img/favicon.ico",
test(attr(deny(warnings)))
)]
#![forbid(
arithmetic_overflow,
mutable_transmutes,
no_mangle_const_items,
unknown_crate_types,
unsafe_code
)]
#![warn(
missing_debug_implementations,
missing_docs,
trivial_casts,
trivial_numeric_casts,
unreachable_pub,
unused_extern_crates,
unused_import_braces,
unused_qualifications,
unused_results,
clippy::unicode_not_nfc,
clippy::unwrap_used
)]
#[macro_use]
extern crate tracing;
mod detection;
pub use detection::IssueType;
use sn_interface::messaging::system::OperationId;
use std::{
collections::{BTreeMap, BTreeSet, VecDeque},
time::Instant,
};
use xor_name::XorName;
type NodeIdentifier = XorName;
pub(crate) type TimedTracker = BTreeMap<NodeIdentifier, VecDeque<Instant>>;
#[derive(Clone, Debug)]
pub struct DysfunctionDetection {
pub communication_issues: TimedTracker,
pub dkg_issues: TimedTracker,
pub probe_issues: TimedTracker,
pub knowledge_issues: TimedTracker,
pub unfulfilled_ops: BTreeMap<NodeIdentifier, Vec<(OperationId, Instant)>>,
nodes: Vec<XorName>,
}
impl DysfunctionDetection {
pub fn new(nodes: Vec<NodeIdentifier>) -> Self {
Self {
communication_issues: BTreeMap::new(),
dkg_issues: BTreeMap::new(),
probe_issues: BTreeMap::new(),
knowledge_issues: BTreeMap::new(),
unfulfilled_ops: BTreeMap::new(),
nodes,
}
}
pub fn track_issue(&mut self, node_id: NodeIdentifier, issue_type: IssueType) {
debug!("Adding a new issue to {node_id:?} the dysfunction tracker: {issue_type:?}");
match issue_type {
IssueType::Dkg => {
let queue = self.dkg_issues.entry(node_id).or_default();
queue.push_back(Instant::now());
}
IssueType::AeProbeMsg => {
let queue = self.probe_issues.entry(node_id).or_default();
queue.push_back(Instant::now());
}
IssueType::Communication => {
let queue = self.communication_issues.entry(node_id).or_default();
queue.push_back(Instant::now());
}
IssueType::Knowledge => {
let queue = self.knowledge_issues.entry(node_id).or_default();
queue.push_back(Instant::now());
}
IssueType::RequestOperation(op_id) => {
let queue = self.unfulfilled_ops.entry(node_id).or_default();
trace!("New issue has associated operation ID: {op_id:#?}");
queue.push((op_id, Instant::now()));
}
}
}
pub fn request_operation_fulfilled(
&mut self,
node_id: &NodeIdentifier,
operation_id: OperationId,
) -> bool {
trace!(
"Attempting to remove pending_operation {:?} op: {:?}",
node_id,
operation_id
);
let mut has_removed = false;
if let Some(v) = self.unfulfilled_ops.get_mut(node_id) {
v.retain(|(op_id, _)| {
if has_removed || op_id != &operation_id {
true
} else {
has_removed = true;
false
}
});
if has_removed {
trace!(
"Pending operation removed for node: {:?} op: {:?}",
node_id,
operation_id
);
} else {
trace!(
"No Pending operation found for node: {:?} op: {:?}",
node_id,
operation_id
);
}
}
has_removed
}
pub fn dkg_ack_fulfilled(&mut self, node_id: &NodeIdentifier) {
trace!("Attempting to remove logged dkg session for {:?}", node_id,);
if let Some(v) = self.dkg_issues.get_mut(node_id) {
let prev = v.pop_front();
if prev.is_some() {
trace!("Pending dkg session removed for node: {:?}", node_id,);
} else {
trace!("No Pending dkg session found for node: {:?}", node_id);
}
}
}
pub fn ae_update_msg_received(&mut self, node_id: &NodeIdentifier) {
trace!(
"Attempting to remove pending AEProbe response for {:?}",
node_id,
);
if let Some(v) = self.probe_issues.get_mut(node_id) {
let prev = v.pop_front();
if prev.is_some() {
trace!("Pending probe msg removed for node: {:?}", node_id,);
} else {
trace!("No Pending probe session found for node: {:?}", node_id);
}
}
}
pub fn get_unfulfilled_ops(&self, node: XorName) -> Vec<OperationId> {
if let Some(val) = self.unfulfilled_ops.get(&node) {
return val.clone().iter().map(|(op_id, _)| *op_id).collect();
}
Vec::new()
}
pub fn current_nodes(&self) -> &Vec<XorName> {
&self.nodes
}
pub fn add_new_node(&mut self, node: XorName) {
info!("Adding new node:{node} to DysfunctionDetection tracker");
self.nodes.push(node);
}
pub fn retain_members_only(&mut self, current_members: BTreeSet<XorName>) {
let nodes = self.current_nodes();
let nodes_being_removed = nodes
.iter()
.filter(|x| !current_members.contains(x))
.copied()
.collect::<Vec<XorName>>();
self.nodes.retain(|x| current_members.contains(x));
for node in &nodes_being_removed {
let _ = self.communication_issues.remove(node);
let _ = self.knowledge_issues.remove(node);
let _ = self.dkg_issues.remove(node);
let _ = self.probe_issues.remove(node);
let _ = self.unfulfilled_ops.remove(node);
}
}
}
pub(crate) fn get_mean_of(data: &[f32]) -> Option<f32> {
let sum: f32 = data.iter().sum();
let count = data.len();
if count > 0 {
Some(sum / count as f32)
} else {
None
}
}
fn std_deviation(data: &[f32]) -> Option<f32> {
match (get_mean_of(data), data.len()) {
(Some(data_mean), count) if count > 0 => {
let variance = data
.iter()
.map(|value| {
let diff = data_mean - *value;
diff * diff
})
.sum::<f32>()
/ count as f32;
Some(variance.sqrt())
}
_ => None,
}
}
#[cfg(test)]
mod tests {
use super::{DysfunctionDetection, IssueType};
use sn_interface::messaging::system::OperationId;
use eyre::Error;
use std::{collections::BTreeSet, sync::Once};
use xor_name::{rand::random as random_xorname, XorName};
type Result<T, E = Error> = std::result::Result<T, E>;
static INIT: Once = Once::new();
pub(crate) fn init_test_logger() {
INIT.call_once(|| {
tracing_subscriber::fmt::fmt()
.with_thread_names(true)
.with_ansi(false)
.with_env_filter(tracing_subscriber::EnvFilter::from_default_env())
.with_target(false)
.try_init()
.unwrap_or_else(|_| println!("Error initializing logger"));
});
}
#[tokio::test]
async fn retain_members_should_remove_other_nodes() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
let nodes_to_retain = nodes[5..10].iter().cloned().collect::<BTreeSet<XorName>>();
dysfunctional_detection.retain_members_only(nodes_to_retain.clone());
let current_nodes = dysfunctional_detection.current_nodes();
assert_eq!(current_nodes.len(), 5);
for member in current_nodes {
assert!(nodes_to_retain.contains(member));
}
Ok(())
}
#[tokio::test]
async fn retain_members_should_remove_issues_relating_to_nodes_not_retained() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
for node in nodes.iter().take(3) {
dysfunctional_detection.track_issue(*node, IssueType::Communication);
dysfunctional_detection.track_issue(*node, IssueType::Knowledge);
dysfunctional_detection
.track_issue(*node, IssueType::RequestOperation(OperationId([1; 32])));
}
dysfunctional_detection.track_issue(nodes[5], IssueType::Communication);
dysfunctional_detection.track_issue(nodes[6], IssueType::Knowledge);
dysfunctional_detection
.track_issue(nodes[7], IssueType::RequestOperation(OperationId([1; 32])));
let nodes_to_retain = nodes[5..10].iter().cloned().collect::<BTreeSet<XorName>>();
dysfunctional_detection.retain_members_only(nodes_to_retain);
assert_eq!(dysfunctional_detection.communication_issues.len(), 1);
assert_eq!(dysfunctional_detection.knowledge_issues.len(), 1);
assert_eq!(dysfunctional_detection.unfulfilled_ops.len(), 1);
Ok(())
}
#[tokio::test]
async fn track_issue_should_add_a_comm_issue() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
dysfunctional_detection.track_issue(nodes[0], IssueType::Communication);
assert_eq!(dysfunctional_detection.communication_issues.len(), 1);
assert_eq!(dysfunctional_detection.knowledge_issues.len(), 0);
assert_eq!(dysfunctional_detection.unfulfilled_ops.len(), 0);
Ok(())
}
#[tokio::test]
async fn track_issue_should_add_a_knowledge_issue() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
dysfunctional_detection.track_issue(nodes[0], IssueType::Knowledge);
assert_eq!(dysfunctional_detection.knowledge_issues.len(), 1);
assert_eq!(dysfunctional_detection.communication_issues.len(), 0);
assert_eq!(dysfunctional_detection.unfulfilled_ops.len(), 0);
Ok(())
}
#[tokio::test]
async fn track_issue_should_add_a_pending_op_issue() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
assert_eq!(dysfunctional_detection.unfulfilled_ops.len(), 1);
assert_eq!(dysfunctional_detection.knowledge_issues.len(), 0);
assert_eq!(dysfunctional_detection.communication_issues.len(), 0);
Ok(())
}
#[tokio::test]
async fn add_new_node_should_track_new_node() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes);
let new_adult = random_xorname();
dysfunctional_detection.add_new_node(new_adult);
let current_nodes = dysfunctional_detection.current_nodes();
assert_eq!(current_nodes.len(), 11);
Ok(())
}
#[tokio::test]
async fn get_unfulfilled_ops_should_return_op_ids() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([2; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([3; 32])));
let op_ids = dysfunctional_detection.get_unfulfilled_ops(nodes[0]);
assert_eq!(3, op_ids.len());
Ok(())
}
#[tokio::test]
async fn get_unfulfilled_ops_should_return_empty_list_for_node_with_no_ops() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([2; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([3; 32])));
let op_ids = dysfunctional_detection.get_unfulfilled_ops(nodes[1]);
assert_eq!(0, op_ids.len());
Ok(())
}
#[tokio::test]
async fn request_operation_fulfilled_should_remove_pending_op() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
let op_id = OperationId([2; 32]);
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([2; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([3; 32])));
let has_removed = dysfunctional_detection.request_operation_fulfilled(&nodes[0], op_id);
assert!(has_removed);
let op_ids = dysfunctional_detection.get_unfulfilled_ops(nodes[0]);
assert_eq!(2, op_ids.len());
assert_eq!(OperationId([1; 32]), op_ids[0]);
assert_eq!(OperationId([3; 32]), op_ids[1]);
Ok(())
}
#[tokio::test]
async fn request_operation_fulfilled_should_return_false_for_node_with_no_ops() -> Result<()> {
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
let op_id = OperationId([2; 32]);
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([2; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([3; 32])));
let has_removed = dysfunctional_detection.request_operation_fulfilled(&nodes[1], op_id);
assert!(!has_removed);
Ok(())
}
#[tokio::test]
async fn request_operation_fulfilled_should_return_false_when_op_id_not_tracked() -> Result<()>
{
let nodes = (0..10).map(|_| random_xorname()).collect::<Vec<XorName>>();
let mut dysfunctional_detection = DysfunctionDetection::new(nodes.clone());
let op_id = OperationId([4; 32]);
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([1; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([2; 32])));
dysfunctional_detection
.track_issue(nodes[0], IssueType::RequestOperation(OperationId([3; 32])));
let has_removed = dysfunctional_detection.request_operation_fulfilled(&nodes[1], op_id);
assert!(!has_removed);
let op_ids = dysfunctional_detection.get_unfulfilled_ops(nodes[0]);
assert_eq!(3, op_ids.len());
Ok(())
}
}