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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
//! Per-peer bandwidth management with token-bucket rate limiting and fairness scheduling.
//!
//! This module provides production-grade per-peer bandwidth tracking and enforcement:
//! - Token-bucket based rate limiting for upload and download directions
//! - Configurable burst sizes for bursty traffic tolerance
//! - Sliding-window usage snapshots for real-time rate computation
//! - Fairness scheduling policies (Max-Min, Weighted Fair, Unrestricted)
//! - Top-K upload/download peer ranking
//! - Idle peer eviction to bound memory
//! - Global aggregate statistics
//!
//! # Example
//!
//! ```rust
//! use ipfrs_network::peer_bandwidth_manager::{
//! BandwidthManagerConfig, BandwidthLimit, BandwidthDirection, PeerBandwidthManager,
//! };
//!
//! let config = BandwidthManagerConfig::default();
//! let mut mgr = PeerBandwidthManager::new(config);
//! mgr.register_peer("peer-1".to_string(), 0);
//!
//! // Try to consume 512 bytes for upload
//! let allowed = mgr.try_consume("peer-1", 512, BandwidthDirection::Upload, 0);
//! assert!(allowed);
//!
//! // Record an unconditional transfer
//! mgr.record_transfer("peer-1", 512, 256, 1_000);
//!
//! // Query usage
//! if let Some(usage) = mgr.peer_usage("peer-1", 5_000) {
//! println!("upload rate: {:.1} bps", usage.upload_rate_bps);
//! }
//! ```
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, VecDeque};
// ---------------------------------------------------------------------------
// BandwidthDirection
// ---------------------------------------------------------------------------
/// Direction of bandwidth consumption for rate-limiting purposes.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum BandwidthDirection {
/// Bytes being sent to remote peers.
Upload,
/// Bytes being received from remote peers.
Download,
/// Both upload and download simultaneously.
Both,
}
// ---------------------------------------------------------------------------
// BandwidthLimit
// ---------------------------------------------------------------------------
/// Token-bucket parameters for a single bandwidth direction.
///
/// A token bucket refills at `bytes_per_second` tokens per second and can
/// hold at most `burst_bytes` tokens (the bucket capacity). A transfer of N
/// bytes is allowed when at least N tokens are available.
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
pub struct BandwidthLimit {
/// Sustained rate in bytes per second.
pub bytes_per_second: u64,
/// Maximum burst size in bytes. Tokens accumulate up to this cap.
pub burst_bytes: u64,
}
impl BandwidthLimit {
/// Construct a new [`BandwidthLimit`].
pub fn new(bytes_per_second: u64, burst_bytes: u64) -> Self {
Self {
bytes_per_second,
burst_bytes,
}
}
/// Returns `true` when the limit is effectively "unlimited" (rate == 0).
pub fn is_unlimited(&self) -> bool {
self.bytes_per_second == 0
}
}
impl Default for BandwidthLimit {
fn default() -> Self {
// 1 MB/s sustained, 2 MB burst.
Self {
bytes_per_second: 1_048_576,
burst_bytes: 2_097_152,
}
}
}
// ---------------------------------------------------------------------------
// PeerBandwidthState
// ---------------------------------------------------------------------------
/// Token-bucket state for a single peer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeerBandwidthState {
/// Stable identifier for the peer.
pub peer_id: String,
/// Current upload token count (fractional tokens are kept for precision).
pub upload_tokens: f64,
/// Current download token count.
pub download_tokens: f64,
/// Rate/burst configuration for the upload direction.
pub upload_limit: BandwidthLimit,
/// Rate/burst configuration for the download direction.
pub download_limit: BandwidthLimit,
/// Cumulative bytes sent to this peer (unconditional accounting).
pub total_bytes_sent: u64,
/// Cumulative bytes received from this peer.
pub total_bytes_recv: u64,
/// Millisecond timestamp of the last token refill.
pub last_refill_ms: u64,
}
impl PeerBandwidthState {
/// Create a new state initialised with full token buckets.
pub fn new(
peer_id: String,
upload_limit: BandwidthLimit,
download_limit: BandwidthLimit,
now_ms: u64,
) -> Self {
Self {
peer_id,
upload_tokens: upload_limit.burst_bytes as f64,
download_tokens: download_limit.burst_bytes as f64,
upload_limit,
download_limit,
total_bytes_sent: 0,
total_bytes_recv: 0,
last_refill_ms: now_ms,
}
}
}
// ---------------------------------------------------------------------------
// BandwidthUsage
// ---------------------------------------------------------------------------
/// Computed bandwidth usage for a peer within the configured time window.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BandwidthUsage {
/// Peer identifier.
pub peer_id: String,
/// Total bytes sent within the window.
pub bytes_sent: u64,
/// Total bytes received within the window.
pub bytes_recv: u64,
/// Upload rate in bytes per second derived from window samples.
pub upload_rate_bps: f64,
/// Download rate in bytes per second.
pub download_rate_bps: f64,
/// Window duration in milliseconds over which rates were computed.
pub window_ms: u64,
}
// ---------------------------------------------------------------------------
// FairnessPolicy
// ---------------------------------------------------------------------------
/// Scheduling policy used by [`PeerBandwidthManager::apply_fairness`].
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub enum FairnessPolicy {
/// Max-Min fairness: every peer receives an equal share of the total
/// available tokens. Each peer's current token count is clamped to
/// `total_tokens / num_peers`.
MaxMinFairness,
/// Weighted fair queuing: each peer's tokens are scaled by its normalised
/// weight relative to all registered peers.
WeightedFair {
/// Per-peer weights. Peers absent from the map are assigned weight 1.0.
weights: HashMap<String, f64>,
},
/// No fairness enforcement; tokens accumulate freely up to the burst cap.
#[default]
Unrestricted,
}
// ---------------------------------------------------------------------------
// BandwidthManagerConfig
// ---------------------------------------------------------------------------
/// Configuration for [`PeerBandwidthManager`].
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BandwidthManagerConfig {
/// Default upload limit applied when a peer is first registered.
pub default_upload_limit: BandwidthLimit,
/// Default download limit applied when a peer is first registered.
pub default_download_limit: BandwidthLimit,
/// Maximum number of peers tracked simultaneously. When the limit is
/// reached the oldest registered peer is evicted to make room.
pub max_peers: usize,
/// Policy used by [`PeerBandwidthManager::apply_fairness`].
pub fairness_policy: FairnessPolicy,
/// Rolling window in milliseconds used for rate computation.
pub usage_window_ms: u64,
}
impl Default for BandwidthManagerConfig {
fn default() -> Self {
Self {
default_upload_limit: BandwidthLimit {
bytes_per_second: 1_048_576, // 1 MB/s
burst_bytes: 2_097_152, // 2 MB
},
default_download_limit: BandwidthLimit {
bytes_per_second: 2_097_152, // 2 MB/s
burst_bytes: 4_194_304, // 4 MB
},
max_peers: 1_000,
fairness_policy: FairnessPolicy::Unrestricted,
usage_window_ms: 5_000,
}
}
}
// ---------------------------------------------------------------------------
// BandwidthManagerStats
// ---------------------------------------------------------------------------
/// Aggregate statistics for the entire [`PeerBandwidthManager`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BandwidthManagerStats {
/// Number of currently registered peers.
pub registered_peers: usize,
/// Total bytes sent across all peers since manager creation.
pub total_bytes_sent: u64,
/// Total bytes received across all peers since manager creation.
pub total_bytes_recv: u64,
/// Average upload rate across all peers (bytes per second).
pub avg_upload_rate_bps: f64,
/// Average download rate across all peers (bytes per second).
pub avg_download_rate_bps: f64,
}
// ---------------------------------------------------------------------------
// PeerBandwidthManager
// ---------------------------------------------------------------------------
/// Manages per-peer bandwidth state, rate limiting, and fairness scheduling.
///
/// All timestamps are provided by the caller as milliseconds since an
/// arbitrary epoch (e.g. `SystemTime::UNIX_EPOCH` or `Instant`-derived).
/// This makes the manager fully testable without real-time dependencies.
pub struct PeerBandwidthManager {
/// Manager configuration.
pub config: BandwidthManagerConfig,
/// Per-peer token-bucket state keyed by peer ID.
pub peers: HashMap<String, PeerBandwidthState>,
/// Sliding-window snapshots per peer: `(timestamp_ms, bytes_sent, bytes_recv)`.
pub usage_snapshots: HashMap<String, VecDeque<(u64, u64, u64)>>,
/// Total bytes sent across all peers since manager creation.
pub total_bytes_sent: u64,
/// Total bytes received across all peers since manager creation.
pub total_bytes_recv: u64,
/// Registration order (FIFO) used for eviction when `max_peers` is reached.
registration_order: VecDeque<String>,
}
impl PeerBandwidthManager {
// -----------------------------------------------------------------------
// Construction
// -----------------------------------------------------------------------
/// Create a new manager with the given configuration.
pub fn new(config: BandwidthManagerConfig) -> Self {
Self {
peers: HashMap::new(),
usage_snapshots: HashMap::new(),
total_bytes_sent: 0,
total_bytes_recv: 0,
registration_order: VecDeque::new(),
config,
}
}
// -----------------------------------------------------------------------
// Peer registration
// -----------------------------------------------------------------------
/// Register a peer with the default limits from the manager configuration.
///
/// If the peer is already registered, the call is a no-op.
/// If `max_peers` would be exceeded, the oldest registered peer is evicted.
pub fn register_peer(&mut self, peer_id: String, now: u64) {
if self.peers.contains_key(&peer_id) {
return;
}
// Evict oldest peer if we're at capacity.
if self.peers.len() >= self.config.max_peers {
if let Some(oldest) = self.registration_order.pop_front() {
self.peers.remove(&oldest);
self.usage_snapshots.remove(&oldest);
}
}
let state = PeerBandwidthState::new(
peer_id.clone(),
self.config.default_upload_limit,
self.config.default_download_limit,
now,
);
self.peers.insert(peer_id.clone(), state);
self.usage_snapshots
.insert(peer_id.clone(), VecDeque::new());
self.registration_order.push_back(peer_id);
}
/// Override the upload and download limits for an already-registered peer.
///
/// Returns `true` on success, `false` if the peer is not registered.
pub fn set_peer_limits(
&mut self,
peer_id: &str,
upload: BandwidthLimit,
download: BandwidthLimit,
) -> bool {
if let Some(state) = self.peers.get_mut(peer_id) {
state.upload_limit = upload;
state.download_limit = download;
// Re-clamp existing tokens so they don't exceed the new burst caps.
state.upload_tokens = state.upload_tokens.min(upload.burst_bytes as f64);
state.download_tokens = state.download_tokens.min(download.burst_bytes as f64);
true
} else {
false
}
}
/// Remove a peer from the manager.
///
/// Returns `true` if the peer existed and was removed.
pub fn remove_peer(&mut self, peer_id: &str) -> bool {
if self.peers.remove(peer_id).is_some() {
self.usage_snapshots.remove(peer_id);
self.registration_order.retain(|id| id != peer_id);
true
} else {
false
}
}
// -----------------------------------------------------------------------
// Token-bucket helpers
// -----------------------------------------------------------------------
/// Refill the token buckets for `state` based on elapsed time since the
/// last refill.
///
/// `elapsed_s = (now_ms - last_refill_ms) / 1000.0`
///
/// New tokens are calculated as `elapsed_s * bytes_per_second` and added
/// to the current token count, clamped to `burst_bytes`.
pub fn refill_tokens(state: &mut PeerBandwidthState, now: u64) {
if now <= state.last_refill_ms {
return;
}
let elapsed_ms = now - state.last_refill_ms;
let elapsed_s = elapsed_ms as f64 / 1_000.0;
if !state.upload_limit.is_unlimited() {
let new_up = state.upload_limit.bytes_per_second as f64 * elapsed_s;
state.upload_tokens =
(state.upload_tokens + new_up).min(state.upload_limit.burst_bytes as f64);
}
if !state.download_limit.is_unlimited() {
let new_dn = state.download_limit.bytes_per_second as f64 * elapsed_s;
state.download_tokens =
(state.download_tokens + new_dn).min(state.download_limit.burst_bytes as f64);
}
state.last_refill_ms = now;
}
/// Attempt to consume `bytes` from the appropriate token bucket(s).
///
/// Tokens are refilled before checking.
/// Returns `true` if the transfer is permitted, `false` if there are
/// insufficient tokens.
pub fn try_consume(
&mut self,
peer_id: &str,
bytes: u64,
direction: BandwidthDirection,
now: u64,
) -> bool {
let state = match self.peers.get_mut(peer_id) {
Some(s) => s,
None => return false,
};
Self::refill_tokens(state, now);
let bytes_f = bytes as f64;
match direction {
BandwidthDirection::Upload => {
if state.upload_limit.is_unlimited() || state.upload_tokens >= bytes_f {
if !state.upload_limit.is_unlimited() {
state.upload_tokens -= bytes_f;
}
true
} else {
false
}
}
BandwidthDirection::Download => {
if state.download_limit.is_unlimited() || state.download_tokens >= bytes_f {
if !state.download_limit.is_unlimited() {
state.download_tokens -= bytes_f;
}
true
} else {
false
}
}
BandwidthDirection::Both => {
let up_ok = state.upload_limit.is_unlimited() || state.upload_tokens >= bytes_f;
let dn_ok = state.download_limit.is_unlimited() || state.download_tokens >= bytes_f;
if up_ok && dn_ok {
if !state.upload_limit.is_unlimited() {
state.upload_tokens -= bytes_f;
}
if !state.download_limit.is_unlimited() {
state.download_tokens -= bytes_f;
}
true
} else {
false
}
}
}
}
// -----------------------------------------------------------------------
// Accounting
// -----------------------------------------------------------------------
/// Record an unconditional transfer for a peer (no token consumption).
///
/// The snapshot is pushed to the sliding window and the manager-wide
/// totals are updated. Snapshots older than `usage_window_ms` are
/// dropped.
pub fn record_transfer(&mut self, peer_id: &str, bytes_sent: u64, bytes_recv: u64, now: u64) {
// Update per-peer cumulative totals.
if let Some(state) = self.peers.get_mut(peer_id) {
state.total_bytes_sent = state.total_bytes_sent.saturating_add(bytes_sent);
state.total_bytes_recv = state.total_bytes_recv.saturating_add(bytes_recv);
}
// Push snapshot and prune stale entries.
if let Some(snapshots) = self.usage_snapshots.get_mut(peer_id) {
snapshots.push_back((now, bytes_sent, bytes_recv));
let window = self.config.usage_window_ms;
let cutoff = now.saturating_sub(window);
while snapshots
.front()
.map(|(ts, _, _)| *ts < cutoff)
.unwrap_or(false)
{
snapshots.pop_front();
}
}
// Update global totals.
self.total_bytes_sent = self.total_bytes_sent.saturating_add(bytes_sent);
self.total_bytes_recv = self.total_bytes_recv.saturating_add(bytes_recv);
}
// -----------------------------------------------------------------------
// Usage queries
// -----------------------------------------------------------------------
/// Compute [`BandwidthUsage`] for a peer by summing all snapshots within
/// the configured window ending at `now`.
///
/// Returns `None` if the peer is not registered.
pub fn peer_usage(&self, peer_id: &str, now: u64) -> Option<BandwidthUsage> {
if !self.peers.contains_key(peer_id) {
return None;
}
let snapshots = self.usage_snapshots.get(peer_id)?;
let window = self.config.usage_window_ms;
let cutoff = now.saturating_sub(window);
let mut bytes_sent: u64 = 0;
let mut bytes_recv: u64 = 0;
for (ts, sent, recv) in snapshots.iter() {
if *ts >= cutoff {
bytes_sent = bytes_sent.saturating_add(*sent);
bytes_recv = bytes_recv.saturating_add(*recv);
}
}
let window_s = window as f64 / 1_000.0;
let upload_rate_bps = if window_s > 0.0 {
bytes_sent as f64 / window_s
} else {
0.0
};
let download_rate_bps = if window_s > 0.0 {
bytes_recv as f64 / window_s
} else {
0.0
};
Some(BandwidthUsage {
peer_id: peer_id.to_string(),
bytes_sent,
bytes_recv,
upload_rate_bps,
download_rate_bps,
window_ms: window,
})
}
/// Return the top-`k` peers by upload rate, descending.
pub fn top_uploaders(&self, k: usize, now: u64) -> Vec<BandwidthUsage> {
let mut usages: Vec<BandwidthUsage> = self
.peers
.keys()
.filter_map(|id| self.peer_usage(id, now))
.collect();
usages.sort_by(|a, b| {
b.upload_rate_bps
.partial_cmp(&a.upload_rate_bps)
.unwrap_or(std::cmp::Ordering::Equal)
});
usages.truncate(k);
usages
}
/// Return the top-`k` peers by download rate, descending.
pub fn top_downloaders(&self, k: usize, now: u64) -> Vec<BandwidthUsage> {
let mut usages: Vec<BandwidthUsage> = self
.peers
.keys()
.filter_map(|id| self.peer_usage(id, now))
.collect();
usages.sort_by(|a, b| {
b.download_rate_bps
.partial_cmp(&a.download_rate_bps)
.unwrap_or(std::cmp::Ordering::Equal)
});
usages.truncate(k);
usages
}
// -----------------------------------------------------------------------
// Fairness scheduling
// -----------------------------------------------------------------------
/// Apply the configured fairness policy to all registered peers.
///
/// - [`FairnessPolicy::MaxMinFairness`]: Compute the sum of all peers'
/// upload tokens and divide evenly; clamp each peer's token count to
/// that fair share. The same applies to download tokens.
/// - [`FairnessPolicy::WeightedFair`]: Scale each peer's tokens by its
/// normalised weight (peer_weight / sum_weights), then clamp to burst.
/// - [`FairnessPolicy::Unrestricted`][]: No-op.
pub fn apply_fairness(&mut self, now: u64) {
// Refill all peers first so fairness acts on up-to-date token counts.
let peer_ids: Vec<String> = self.peers.keys().cloned().collect();
for id in &peer_ids {
if let Some(state) = self.peers.get_mut(id) {
Self::refill_tokens(state, now);
}
}
let n = self.peers.len();
if n == 0 {
return;
}
match &self.config.fairness_policy.clone() {
FairnessPolicy::Unrestricted => {}
FairnessPolicy::MaxMinFairness => {
let total_upload: f64 = self.peers.values().map(|s| s.upload_tokens).sum();
let total_download: f64 = self.peers.values().map(|s| s.download_tokens).sum();
let fair_up = total_upload / n as f64;
let fair_dn = total_download / n as f64;
for state in self.peers.values_mut() {
state.upload_tokens = state
.upload_tokens
.min(fair_up)
.min(state.upload_limit.burst_bytes as f64);
state.download_tokens = state
.download_tokens
.min(fair_dn)
.min(state.download_limit.burst_bytes as f64);
}
}
FairnessPolicy::WeightedFair { weights } => {
// Collect (id, weight) pairs; default weight is 1.0 for absent entries.
let weighted: Vec<(String, f64)> = peer_ids
.iter()
.map(|id| {
let w = weights.get(id).copied().unwrap_or(1.0).max(0.0);
(id.clone(), w)
})
.collect();
let total_weight: f64 = weighted.iter().map(|(_, w)| w).sum();
if total_weight <= 0.0 {
return;
}
for (id, weight) in &weighted {
let norm = weight / total_weight;
if let Some(state) = self.peers.get_mut(id) {
state.upload_tokens =
(state.upload_tokens * norm).min(state.upload_limit.burst_bytes as f64);
state.download_tokens = (state.download_tokens * norm)
.min(state.download_limit.burst_bytes as f64);
}
}
}
}
}
// -----------------------------------------------------------------------
// Maintenance
// -----------------------------------------------------------------------
/// Remove peers that have no snapshot newer than `now - idle_threshold_ms`.
///
/// Returns the number of peers evicted.
pub fn evict_idle_peers(&mut self, now: u64, idle_threshold_ms: u64) -> usize {
let cutoff = now.saturating_sub(idle_threshold_ms);
let idle: Vec<String> = self
.usage_snapshots
.iter()
.filter(|(_, snaps)| {
// A peer is idle if there are no snapshots at or after the cutoff.
!snaps.iter().any(|(ts, _, _)| *ts >= cutoff)
})
.map(|(id, _)| id.clone())
.collect();
let count = idle.len();
for id in &idle {
self.peers.remove(id);
self.usage_snapshots.remove(id);
self.registration_order.retain(|r| r != id);
}
count
}
// -----------------------------------------------------------------------
// Statistics
// -----------------------------------------------------------------------
/// Collect aggregate statistics for the manager.
///
/// Average rates are computed from the usage window of each registered
/// peer at the current moment (passing `now = 0` gives a snapshot of
/// accumulated counters without rate computation).
pub fn manager_stats(&self) -> BandwidthManagerStats {
// Use a synthetic "now" far in the future so all snapshots fall within
// the window when called without a real timestamp.
let n = self.peers.len();
let (sum_up, sum_dn) = if n > 0 {
// We cannot call peer_usage here without a sensible `now`, so we
// compute rates from the raw snapshot totals using the window.
let window_s = self.config.usage_window_ms as f64 / 1_000.0;
let mut up = 0.0f64;
let mut dn = 0.0f64;
for snaps in self.usage_snapshots.values() {
let sent: u64 = snaps.iter().map(|(_, s, _)| s).sum();
let recv: u64 = snaps.iter().map(|(_, _, r)| r).sum();
if window_s > 0.0 {
up += sent as f64 / window_s;
dn += recv as f64 / window_s;
}
}
(up, dn)
} else {
(0.0, 0.0)
};
let avg_up = if n > 0 { sum_up / n as f64 } else { 0.0 };
let avg_dn = if n > 0 { sum_dn / n as f64 } else { 0.0 };
BandwidthManagerStats {
registered_peers: n,
total_bytes_sent: self.total_bytes_sent,
total_bytes_recv: self.total_bytes_recv,
avg_upload_rate_bps: avg_up,
avg_download_rate_bps: avg_dn,
}
}
}
// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------
#[cfg(test)]
mod tests {
use super::{
BandwidthDirection, BandwidthLimit, BandwidthManagerConfig, BandwidthUsage, FairnessPolicy,
PeerBandwidthManager, PeerBandwidthState,
};
use std::collections::HashMap;
// -----------------------------------------------------------------------
// Helpers
// -----------------------------------------------------------------------
/// Build a manager with a 5-second window.
fn make_manager() -> PeerBandwidthManager {
PeerBandwidthManager::new(BandwidthManagerConfig::default())
}
/// Build a manager with a very low default upload/download limit (1 KB/s, 2 KB burst).
fn make_tight_manager() -> PeerBandwidthManager {
let config = BandwidthManagerConfig {
default_upload_limit: BandwidthLimit {
bytes_per_second: 1_024,
burst_bytes: 2_048,
},
default_download_limit: BandwidthLimit {
bytes_per_second: 1_024,
burst_bytes: 2_048,
},
..Default::default()
};
PeerBandwidthManager::new(config)
}
// -----------------------------------------------------------------------
// register_peer
// -----------------------------------------------------------------------
#[test]
fn test_register_peer_basic() {
let mut mgr = make_manager();
mgr.register_peer("alice".to_string(), 0);
assert!(mgr.peers.contains_key("alice"));
}
#[test]
fn test_register_peer_idempotent() {
let mut mgr = make_manager();
mgr.register_peer("alice".to_string(), 0);
mgr.register_peer("alice".to_string(), 1_000);
// Should still be exactly one entry.
assert_eq!(mgr.peers.len(), 1);
}
#[test]
fn test_register_peer_initial_tokens_full() {
let mut mgr = make_tight_manager();
mgr.register_peer("peer-a".to_string(), 0);
let state = mgr.peers.get("peer-a").expect("peer not found");
assert_eq!(state.upload_tokens, 2_048.0);
assert_eq!(state.download_tokens, 2_048.0);
}
#[test]
fn test_register_peer_evicts_oldest_when_full() {
let config = BandwidthManagerConfig {
max_peers: 2,
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
mgr.register_peer("p1".to_string(), 0);
mgr.register_peer("p2".to_string(), 0);
mgr.register_peer("p3".to_string(), 0);
// p1 should have been evicted.
assert!(!mgr.peers.contains_key("p1"));
assert!(mgr.peers.contains_key("p2"));
assert!(mgr.peers.contains_key("p3"));
}
// -----------------------------------------------------------------------
// remove_peer
// -----------------------------------------------------------------------
#[test]
fn test_remove_peer_existing() {
let mut mgr = make_manager();
mgr.register_peer("bob".to_string(), 0);
assert!(mgr.remove_peer("bob"));
assert!(!mgr.peers.contains_key("bob"));
}
#[test]
fn test_remove_peer_nonexistent() {
let mut mgr = make_manager();
assert!(!mgr.remove_peer("ghost"));
}
#[test]
fn test_remove_peer_clears_snapshots() {
let mut mgr = make_manager();
mgr.register_peer("carol".to_string(), 0);
mgr.record_transfer("carol", 100, 200, 1_000);
mgr.remove_peer("carol");
assert!(!mgr.usage_snapshots.contains_key("carol"));
}
// -----------------------------------------------------------------------
// set_peer_limits
// -----------------------------------------------------------------------
#[test]
fn test_set_peer_limits_success() {
let mut mgr = make_tight_manager();
mgr.register_peer("dave".to_string(), 0);
let new_up = BandwidthLimit::new(4_096, 8_192);
let new_dn = BandwidthLimit::new(4_096, 8_192);
assert!(mgr.set_peer_limits("dave", new_up, new_dn));
let state = mgr.peers.get("dave").expect("peer not found");
assert_eq!(state.upload_limit.bytes_per_second, 4_096);
}
#[test]
fn test_set_peer_limits_nonexistent() {
let mut mgr = make_manager();
let limit = BandwidthLimit::default();
assert!(!mgr.set_peer_limits("nobody", limit, limit));
}
#[test]
fn test_set_peer_limits_clamps_tokens() {
let mut mgr = make_tight_manager();
mgr.register_peer("eve".to_string(), 0);
// Reduce burst to 512 bytes; existing tokens (2048) must be clamped.
let tight = BandwidthLimit::new(1_024, 512);
mgr.set_peer_limits("eve", tight, tight);
let state = mgr.peers.get("eve").expect("peer not found");
assert!(state.upload_tokens <= 512.0);
assert!(state.download_tokens <= 512.0);
}
// -----------------------------------------------------------------------
// refill_tokens
// -----------------------------------------------------------------------
#[test]
fn test_refill_tokens_adds_correct_amount() {
let limit = BandwidthLimit::new(1_000, 10_000);
let mut state = PeerBandwidthState::new("p".to_string(), limit, limit, 0);
// Drain tokens completely.
state.upload_tokens = 0.0;
state.download_tokens = 0.0;
// Refill after 1 second.
PeerBandwidthManager::refill_tokens(&mut state, 1_000);
assert!((state.upload_tokens - 1_000.0).abs() < 1.0);
assert!((state.download_tokens - 1_000.0).abs() < 1.0);
}
#[test]
fn test_refill_tokens_clamps_to_burst() {
let limit = BandwidthLimit::new(10_000, 5_000);
let mut state = PeerBandwidthState::new("p".to_string(), limit, limit, 0);
state.upload_tokens = 0.0;
state.download_tokens = 0.0;
// 1 second refill would add 10_000 tokens but burst is 5_000.
PeerBandwidthManager::refill_tokens(&mut state, 1_000);
assert_eq!(state.upload_tokens, 5_000.0);
assert_eq!(state.download_tokens, 5_000.0);
}
#[test]
fn test_refill_tokens_noop_when_time_not_advanced() {
let limit = BandwidthLimit::new(1_000, 10_000);
let mut state = PeerBandwidthState::new("p".to_string(), limit, limit, 1_000);
state.upload_tokens = 500.0;
PeerBandwidthManager::refill_tokens(&mut state, 1_000); // same timestamp
assert_eq!(state.upload_tokens, 500.0);
}
// -----------------------------------------------------------------------
// try_consume
// -----------------------------------------------------------------------
#[test]
fn test_try_consume_upload_allowed() {
let mut mgr = make_tight_manager();
mgr.register_peer("frank".to_string(), 0);
assert!(mgr.try_consume("frank", 1_000, BandwidthDirection::Upload, 0));
}
#[test]
fn test_try_consume_upload_denied_insufficient_tokens() {
let mut mgr = make_tight_manager();
mgr.register_peer("grace".to_string(), 0);
// Drain entire burst.
assert!(mgr.try_consume("grace", 2_048, BandwidthDirection::Upload, 0));
// Next request should be denied.
assert!(!mgr.try_consume("grace", 1, BandwidthDirection::Upload, 0));
}
#[test]
fn test_try_consume_download_allowed() {
let mut mgr = make_tight_manager();
mgr.register_peer("hank".to_string(), 0);
assert!(mgr.try_consume("hank", 1_024, BandwidthDirection::Download, 0));
}
#[test]
fn test_try_consume_both_directions() {
let mut mgr = make_tight_manager();
mgr.register_peer("ivan".to_string(), 0);
assert!(mgr.try_consume("ivan", 1_000, BandwidthDirection::Both, 0));
let state = mgr.peers.get("ivan").expect("peer not found");
assert!((state.upload_tokens - 1_048.0).abs() < 2.0);
assert!((state.download_tokens - 1_048.0).abs() < 2.0);
}
#[test]
fn test_try_consume_both_denied_if_one_direction_insufficient() {
let mut mgr = make_tight_manager();
mgr.register_peer("judy".to_string(), 0);
// Drain upload only.
assert!(mgr.try_consume("judy", 2_048, BandwidthDirection::Upload, 0));
// Both should now fail because upload is empty.
assert!(!mgr.try_consume("judy", 100, BandwidthDirection::Both, 0));
}
#[test]
fn test_try_consume_unknown_peer_returns_false() {
let mut mgr = make_manager();
assert!(!mgr.try_consume("unknown", 1, BandwidthDirection::Upload, 0));
}
#[test]
fn test_try_consume_refills_before_check() {
let mut mgr = make_tight_manager();
mgr.register_peer("karl".to_string(), 0);
// Drain all upload tokens.
assert!(mgr.try_consume("karl", 2_048, BandwidthDirection::Upload, 0));
// Advance 2 seconds — should gain 2_048 tokens (2 * 1024), capped at burst.
assert!(mgr.try_consume("karl", 2_048, BandwidthDirection::Upload, 2_000));
}
// -----------------------------------------------------------------------
// record_transfer
// -----------------------------------------------------------------------
#[test]
fn test_record_transfer_updates_global_totals() {
let mut mgr = make_manager();
mgr.register_peer("liam".to_string(), 0);
mgr.record_transfer("liam", 1_000, 500, 1_000);
assert_eq!(mgr.total_bytes_sent, 1_000);
assert_eq!(mgr.total_bytes_recv, 500);
}
#[test]
fn test_record_transfer_updates_peer_totals() {
let mut mgr = make_manager();
mgr.register_peer("mia".to_string(), 0);
mgr.record_transfer("mia", 300, 150, 1_000);
mgr.record_transfer("mia", 200, 100, 2_000);
let state = mgr.peers.get("mia").expect("peer not found");
assert_eq!(state.total_bytes_sent, 500);
assert_eq!(state.total_bytes_recv, 250);
}
#[test]
fn test_record_transfer_pushes_snapshot() {
let mut mgr = make_manager();
mgr.register_peer("noah".to_string(), 0);
mgr.record_transfer("noah", 100, 50, 1_000);
let snaps = mgr.usage_snapshots.get("noah").expect("no snapshots");
assert_eq!(snaps.len(), 1);
}
#[test]
fn test_record_transfer_prunes_old_snapshots() {
let mut mgr = make_manager(); // 5_000 ms window
mgr.register_peer("olivia".to_string(), 0);
mgr.record_transfer("olivia", 100, 50, 0);
mgr.record_transfer("olivia", 100, 50, 4_999);
// Snapshot at t=0 should be pruned when we record at t=5001 (window cutoff = 1).
mgr.record_transfer("olivia", 100, 50, 5_001);
let snaps = mgr.usage_snapshots.get("olivia").expect("no snapshots");
// t=0 is before cutoff (5001-5000=1), t=4999 is before cutoff too, t=5001 is ok.
for (ts, _, _) in snaps.iter() {
assert!(*ts >= 5_001u64.saturating_sub(5_000));
}
}
#[test]
fn test_record_transfer_noop_for_unknown_peer_global_counts_still_updated() {
let mut mgr = make_manager();
// No peer registered — global counts should still go up.
mgr.record_transfer("unknown", 999, 111, 1_000);
assert_eq!(mgr.total_bytes_sent, 999);
assert_eq!(mgr.total_bytes_recv, 111);
}
// -----------------------------------------------------------------------
// peer_usage
// -----------------------------------------------------------------------
#[test]
fn test_peer_usage_returns_none_for_unregistered() {
let mgr = make_manager();
assert!(mgr.peer_usage("ghost", 5_000).is_none());
}
#[test]
fn test_peer_usage_empty_snapshots() {
let mut mgr = make_manager();
mgr.register_peer("petra".to_string(), 0);
let usage = mgr.peer_usage("petra", 5_000).expect("should return usage");
assert_eq!(usage.bytes_sent, 0);
assert_eq!(usage.bytes_recv, 0);
assert_eq!(usage.upload_rate_bps, 0.0);
}
#[test]
fn test_peer_usage_rate_calculation() {
let mut mgr = make_manager(); // 5_000 ms window
mgr.register_peer("quinn".to_string(), 0);
// 5_000 bytes sent within the 5-second window → 1_000 B/s
mgr.record_transfer("quinn", 5_000, 0, 1_000);
let usage = mgr.peer_usage("quinn", 6_000).expect("should return usage");
// All snapshots within the 5 s window → rate ≈ 5000/5 = 1000 B/s.
assert!((usage.upload_rate_bps - 1_000.0).abs() < 1.0);
}
#[test]
fn test_peer_usage_excludes_old_snapshots() {
let mut mgr = make_manager(); // 5_000 ms window
mgr.register_peer("rachel".to_string(), 0);
// Record at t=0 (old) and t=5_001 (current).
mgr.record_transfer("rachel", 10_000, 0, 0);
mgr.record_transfer("rachel", 1_000, 0, 5_001);
let usage = mgr
.peer_usage("rachel", 10_001)
.expect("should return usage");
// Only the snapshot at t=5_001 is within window [10_001-5000, 10_001] = [5_001, 10_001].
assert_eq!(usage.bytes_sent, 1_000);
}
#[test]
fn test_peer_usage_window_ms_matches_config() {
let mut mgr = make_manager();
mgr.register_peer("sam".to_string(), 0);
let usage = mgr.peer_usage("sam", 0).expect("should return usage");
assert_eq!(usage.window_ms, 5_000);
}
// -----------------------------------------------------------------------
// top_uploaders / top_downloaders
// -----------------------------------------------------------------------
#[test]
fn test_top_uploaders_ordering() {
let mut mgr = make_manager();
for id in &["a", "b", "c"] {
mgr.register_peer(id.to_string(), 0);
}
mgr.record_transfer("a", 300, 0, 1_000);
mgr.record_transfer("b", 100, 0, 1_000);
mgr.record_transfer("c", 200, 0, 1_000);
let top = mgr.top_uploaders(3, 5_000);
assert_eq!(top[0].peer_id, "a");
assert_eq!(top[1].peer_id, "c");
assert_eq!(top[2].peer_id, "b");
}
#[test]
fn test_top_uploaders_k_limits_results() {
let mut mgr = make_manager();
for i in 0..5u32 {
let id = format!("peer-{i}");
mgr.register_peer(id.clone(), 0);
mgr.record_transfer(&id, (i + 1) as u64 * 100, 0, 1_000);
}
let top = mgr.top_uploaders(2, 5_000);
assert_eq!(top.len(), 2);
}
#[test]
fn test_top_downloaders_ordering() {
let mut mgr = make_manager();
for id in &["x", "y", "z"] {
mgr.register_peer(id.to_string(), 0);
}
mgr.record_transfer("x", 0, 500, 1_000);
mgr.record_transfer("y", 0, 200, 1_000);
mgr.record_transfer("z", 0, 800, 1_000);
let top = mgr.top_downloaders(3, 5_000);
assert_eq!(top[0].peer_id, "z");
assert_eq!(top[1].peer_id, "x");
assert_eq!(top[2].peer_id, "y");
}
#[test]
fn test_top_downloaders_returns_all_if_k_exceeds_peers() {
let mut mgr = make_manager();
mgr.register_peer("only".to_string(), 0);
mgr.record_transfer("only", 0, 100, 1_000);
let top = mgr.top_downloaders(10, 5_000);
assert_eq!(top.len(), 1);
}
// -----------------------------------------------------------------------
// apply_fairness — MaxMinFairness
// -----------------------------------------------------------------------
#[test]
fn test_fairness_maxmin_equalises_tokens() {
let config = BandwidthManagerConfig {
fairness_policy: FairnessPolicy::MaxMinFairness,
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
mgr.register_peer("p1".to_string(), 0);
mgr.register_peer("p2".to_string(), 0);
// Give p1 twice the tokens of p2.
mgr.peers.get_mut("p1").expect("p1").upload_tokens = 2_000.0;
mgr.peers.get_mut("p2").expect("p2").upload_tokens = 1_000.0;
mgr.apply_fairness(0);
let fair_share = 3_000.0 / 2.0; // total / n = 1500
let t1 = mgr.peers.get("p1").expect("p1").upload_tokens;
let t2 = mgr.peers.get("p2").expect("p2").upload_tokens;
// Both should be clamped to at most fair_share.
assert!(t1 <= fair_share + 0.01);
assert!(t2 <= fair_share + 0.01);
}
#[test]
fn test_fairness_maxmin_noop_when_no_peers() {
let config = BandwidthManagerConfig {
fairness_policy: FairnessPolicy::MaxMinFairness,
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
// Should not panic.
mgr.apply_fairness(0);
}
// -----------------------------------------------------------------------
// apply_fairness — WeightedFair
// -----------------------------------------------------------------------
#[test]
fn test_fairness_weighted_scales_tokens() {
let mut weights = HashMap::new();
weights.insert("heavy".to_string(), 3.0);
weights.insert("light".to_string(), 1.0);
let config = BandwidthManagerConfig {
fairness_policy: FairnessPolicy::WeightedFair { weights },
default_upload_limit: BandwidthLimit {
bytes_per_second: 100_000,
burst_bytes: 1_000_000,
},
default_download_limit: BandwidthLimit {
bytes_per_second: 100_000,
burst_bytes: 1_000_000,
},
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
mgr.register_peer("heavy".to_string(), 0);
mgr.register_peer("light".to_string(), 0);
// Set equal starting tokens.
mgr.peers.get_mut("heavy").expect("heavy").upload_tokens = 1_000_000.0;
mgr.peers.get_mut("light").expect("light").upload_tokens = 1_000_000.0;
mgr.apply_fairness(0);
let heavy_tokens = mgr.peers.get("heavy").expect("heavy").upload_tokens;
let light_tokens = mgr.peers.get("light").expect("light").upload_tokens;
// heavy has 3/4 weight, light has 1/4 weight.
// heavy_tokens should be greater than light_tokens.
assert!(
heavy_tokens > light_tokens,
"heavy={heavy_tokens} light={light_tokens}"
);
}
#[test]
fn test_fairness_unrestricted_noop() {
let mut mgr = make_manager(); // Unrestricted policy
mgr.register_peer("q1".to_string(), 0);
mgr.peers.get_mut("q1").expect("q1").upload_tokens = 777.0;
mgr.apply_fairness(0);
// Tokens should not change (only possible refill from elapsed=0).
let tokens = mgr.peers.get("q1").expect("q1").upload_tokens;
// After refill with elapsed=0 tokens remain unchanged.
assert!(tokens >= 777.0);
}
// -----------------------------------------------------------------------
// evict_idle_peers
// -----------------------------------------------------------------------
#[test]
fn test_evict_idle_peers_removes_stale() {
let mut mgr = make_manager();
mgr.register_peer("active".to_string(), 0);
mgr.register_peer("idle".to_string(), 0);
mgr.record_transfer("active", 100, 0, 10_000);
// "idle" has no snapshots.
let evicted = mgr.evict_idle_peers(10_000, 5_000);
assert_eq!(evicted, 1);
assert!(!mgr.peers.contains_key("idle"));
assert!(mgr.peers.contains_key("active"));
}
#[test]
fn test_evict_idle_peers_returns_zero_when_all_active() {
let mut mgr = make_manager();
mgr.register_peer("p1".to_string(), 0);
mgr.record_transfer("p1", 1, 0, 5_000);
let evicted = mgr.evict_idle_peers(5_000, 5_000);
assert_eq!(evicted, 0);
}
#[test]
fn test_evict_idle_peers_clears_snapshots() {
let mut mgr = make_manager();
mgr.register_peer("stale".to_string(), 0);
// Record a very old snapshot.
mgr.record_transfer("stale", 100, 0, 0);
// Evict with threshold 5000 at now=10_000 — cutoff = 5000; snapshot at 0 < 5000.
let evicted = mgr.evict_idle_peers(10_000, 5_000);
assert_eq!(evicted, 1);
assert!(!mgr.usage_snapshots.contains_key("stale"));
}
// -----------------------------------------------------------------------
// manager_stats
// -----------------------------------------------------------------------
#[test]
fn test_manager_stats_registered_peers() {
let mut mgr = make_manager();
mgr.register_peer("s1".to_string(), 0);
mgr.register_peer("s2".to_string(), 0);
let stats = mgr.manager_stats();
assert_eq!(stats.registered_peers, 2);
}
#[test]
fn test_manager_stats_global_byte_counts() {
let mut mgr = make_manager();
mgr.register_peer("t1".to_string(), 0);
mgr.record_transfer("t1", 1_000, 500, 1_000);
let stats = mgr.manager_stats();
assert_eq!(stats.total_bytes_sent, 1_000);
assert_eq!(stats.total_bytes_recv, 500);
}
#[test]
fn test_manager_stats_avg_rates() {
let mut mgr = make_manager(); // 5_000 ms window
mgr.register_peer("u1".to_string(), 0);
mgr.register_peer("u2".to_string(), 0);
mgr.record_transfer("u1", 5_000, 0, 1_000);
mgr.record_transfer("u2", 10_000, 0, 1_000);
let stats = mgr.manager_stats();
// avg = (5000/5 + 10000/5) / 2 = (1000 + 2000) / 2 = 1500 B/s
assert!((stats.avg_upload_rate_bps - 1_500.0).abs() < 1.0);
}
#[test]
fn test_manager_stats_empty() {
let mgr = make_manager();
let stats = mgr.manager_stats();
assert_eq!(stats.registered_peers, 0);
assert_eq!(stats.total_bytes_sent, 0);
assert_eq!(stats.total_bytes_recv, 0);
assert_eq!(stats.avg_upload_rate_bps, 0.0);
}
// -----------------------------------------------------------------------
// BandwidthLimit helpers
// -----------------------------------------------------------------------
#[test]
fn test_bandwidth_limit_is_unlimited() {
let unlimited = BandwidthLimit::new(0, 0);
assert!(unlimited.is_unlimited());
}
#[test]
fn test_bandwidth_limit_is_not_unlimited() {
let limited = BandwidthLimit::new(1_000, 2_000);
assert!(!limited.is_unlimited());
}
#[test]
fn test_bandwidth_limit_default_values() {
let limit = BandwidthLimit::default();
assert_eq!(limit.bytes_per_second, 1_048_576);
assert_eq!(limit.burst_bytes, 2_097_152);
}
// -----------------------------------------------------------------------
// BandwidthManagerConfig default
// -----------------------------------------------------------------------
#[test]
fn test_config_default_values() {
let config = BandwidthManagerConfig::default();
assert_eq!(config.max_peers, 1_000);
assert_eq!(config.usage_window_ms, 5_000);
assert_eq!(config.default_upload_limit.bytes_per_second, 1_048_576);
assert_eq!(config.default_download_limit.bytes_per_second, 2_097_152);
}
// -----------------------------------------------------------------------
// BandwidthUsage struct fields
// -----------------------------------------------------------------------
#[test]
fn test_bandwidth_usage_fields() {
let usage = BandwidthUsage {
peer_id: "test".to_string(),
bytes_sent: 1_000,
bytes_recv: 500,
upload_rate_bps: 200.0,
download_rate_bps: 100.0,
window_ms: 5_000,
};
assert_eq!(usage.peer_id, "test");
assert_eq!(usage.bytes_sent, 1_000);
assert_eq!(usage.bytes_recv, 500);
assert!((usage.upload_rate_bps - 200.0).abs() < f64::EPSILON);
}
// -----------------------------------------------------------------------
// Edge cases
// -----------------------------------------------------------------------
#[test]
fn test_unlimited_upload_always_allowed() {
let config = BandwidthManagerConfig {
default_upload_limit: BandwidthLimit::new(0, 0), // unlimited
default_download_limit: BandwidthLimit::new(1_024, 2_048),
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
mgr.register_peer("unlimited".to_string(), 0);
// Should always pass, even for huge transfers.
assert!(mgr.try_consume("unlimited", u64::MAX / 2, BandwidthDirection::Upload, 0));
}
#[test]
fn test_saturating_add_prevents_overflow() {
let mut mgr = make_manager();
mgr.register_peer("big".to_string(), 0);
mgr.record_transfer("big", u64::MAX - 10, 0, 1_000);
mgr.record_transfer("big", 100, 0, 2_000);
// Should not panic due to overflow.
assert_eq!(mgr.total_bytes_sent, u64::MAX);
}
#[test]
fn test_multiple_peers_independent_token_buckets() {
let mut mgr = make_tight_manager();
mgr.register_peer("p1".to_string(), 0);
mgr.register_peer("p2".to_string(), 0);
// Drain p1 upload entirely.
assert!(mgr.try_consume("p1", 2_048, BandwidthDirection::Upload, 0));
// p2 should still have full tokens.
assert!(mgr.try_consume("p2", 2_048, BandwidthDirection::Upload, 0));
}
#[test]
fn test_top_uploaders_empty_manager() {
let mgr = make_manager();
let top = mgr.top_uploaders(5, 0);
assert!(top.is_empty());
}
#[test]
fn test_top_downloaders_empty_manager() {
let mgr = make_manager();
let top = mgr.top_downloaders(5, 0);
assert!(top.is_empty());
}
#[test]
fn test_registration_order_maintained_for_eviction() {
let config = BandwidthManagerConfig {
max_peers: 3,
..Default::default()
};
let mut mgr = PeerBandwidthManager::new(config);
for id in &["r1", "r2", "r3", "r4", "r5"] {
mgr.register_peer(id.to_string(), 0);
}
// r1, r2, r3 should have been evicted in order as r4, r5 were added.
assert!(!mgr.peers.contains_key("r1"));
assert!(!mgr.peers.contains_key("r2"));
assert!(mgr.peers.contains_key("r3"));
assert!(mgr.peers.contains_key("r4"));
assert!(mgr.peers.contains_key("r5"));
}
#[test]
fn test_try_consume_after_refill_succeeds() {
let mut mgr = make_tight_manager();
mgr.register_peer("walter".to_string(), 0);
// Exhaust all upload tokens at t=0.
assert!(mgr.try_consume("walter", 2_048, BandwidthDirection::Upload, 0));
// At t=1 the bucket refills by exactly 1_024 bytes (1 second at 1_024 B/s).
// Try consuming 1_024 bytes — should succeed.
assert!(mgr.try_consume("walter", 1_024, BandwidthDirection::Upload, 1_000));
}
}