nntp-proxy 0.5.1

NNTP proxy server with per-command backend multiplexing, caching, metrics, and TUI dashboard
Documentation 
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

//! Tests for `ArticleAvailability` bitset semantics and retry logic.

use nntp_proxy::cache::ArticleAvailability;
use nntp_proxy::router::BackendCount;
use nntp_proxy::types::BackendId;

fn backend(index: usize) -> BackendId {
    BackendId::from_index(index)
}

fn count(count: usize) -> BackendCount {
    BackendCount::try_new(count).expect("test backend count fits availability bitmap")
}

fn availability_with_missing(backends: &[usize]) -> ArticleAvailability {
    let mut avail = ArticleAvailability::new();
    for backend_index in backends {
        avail.record_missing(backend(*backend_index));
    }
    avail
}

fn assert_should_try(avail: ArticleAvailability, cases: &[(usize, bool)]) {
    for (backend_index, should_try) in cases {
        assert_eq!(
            !avail.is_missing(backend(*backend_index)),
            *should_try,
            "backend {backend_index}"
        );
    }
}

#[test]
fn test_should_try_tracks_missing_backends() {
    let fresh = ArticleAvailability::new();
    assert_should_try(
        fresh,
        &[
            (0, true),
            (1, true),
            (2, true),
            (3, true),
            (4, true),
            (5, true),
            (6, true),
            (7, true),
        ],
    );

    let avail = availability_with_missing(&[0, 2, 4]);
    assert_should_try(
        avail,
        &[
            (0, false),
            (1, true),
            (2, false),
            (3, true),
            (4, false),
            (5, true),
        ],
    );
    assert!(!avail.all_exhausted(count(6)));
}

#[test]
fn test_record_missing_is_idempotent_and_encoded_as_bitset() {
    let mut avail = ArticleAvailability::new();
    assert_eq!(avail.missing_bits(), 0b0000_0000);

    avail.record_missing(backend(0));
    assert_eq!(avail.missing_bits(), 0b0000_0001);

    avail.record_missing(backend(1));
    assert_eq!(avail.missing_bits(), 0b0000_0011);

    avail.record_missing(backend(3));
    avail.record_missing(backend(3));
    assert_eq!(avail.missing_bits(), 0b0000_1011);
    assert!(avail.is_missing(backend(3)));

    avail.record_missing(backend(7));
    assert_eq!(avail.missing_bits(), 0b1000_1011);
}

#[test]
fn test_all_exhausted_for_backend_counts() {
    assert!(ArticleAvailability::new().all_exhausted(count(0)));

    let mut one = ArticleAvailability::new();
    assert!(!one.all_exhausted(count(1)));
    one.record_missing(backend(0));
    assert!(one.all_exhausted(count(1)));

    let mut two = ArticleAvailability::new();
    assert!(!two.all_exhausted(count(2)));
    two.record_missing(backend(0));
    assert!(!two.all_exhausted(count(2)));
    two.record_missing(backend(1));
    assert!(two.all_exhausted(count(2)));

    let mut eight = ArticleAvailability::new();
    for backend_index in 0..7 {
        eight.record_missing(backend(backend_index));
        assert!(!eight.all_exhausted(count(8)));
    }
    eight.record_missing(backend(7));
    assert!(eight.all_exhausted(count(8)));
}

#[test]
fn test_retry_loop_simulations() {
    let mut exhausted = ArticleAvailability::new();
    let mut attempts = Vec::new();
    for backend_index in [0, 1] {
        let backend = backend(backend_index);
        assert!(!exhausted.is_missing(backend));
        attempts.push(backend);
        exhausted.record_missing(backend);
    }
    assert!(exhausted.all_exhausted(count(2)));
    assert_eq!(attempts, vec![backend(0), backend(1)]);

    let mut found = ArticleAvailability::new();
    for backend_index in [0, 1] {
        let backend = backend(backend_index);
        assert!(!found.is_missing(backend));
        found.record_missing(backend);
    }
    assert!(!found.is_missing(backend(2)));
    assert!(!found.all_exhausted(count(4)));
    assert_should_try(found, &[(0, false), (1, false), (2, true), (3, true)]);
}

#[test]
fn test_round_robin_and_cached_availability_skip_missing_backends() {
    let avail = availability_with_missing(&[1, 3, 5]);

    let tried = [0, 1, 2, 3, 0]
        .into_iter()
        .map(backend)
        .filter(|&backend| !avail.is_missing(backend))
        .collect::<Vec<_>>();
    assert_eq!(tried, vec![backend(0), backend(2), backend(0)]);

    assert_should_try(
        avail,
        &[
            (0, true),
            (1, false),
            (2, true),
            (3, false),
            (4, true),
            (5, false),
        ],
    );
    assert_eq!(
        (0..6)
            .map(backend)
            .filter(|&backend| !avail.is_missing(backend))
            .collect::<Vec<_>>(),
        vec![backend(0), backend(2), backend(4)]
    );
}

#[test]
fn test_all_exhausted_supports_nine_backends() {
    let avail = availability_with_missing(&(0..8).collect::<Vec<_>>());
    assert!(!avail.all_exhausted(count(9)));
}

#[test]
fn test_backend_id_eight_is_supported() {
    let avail = availability_with_missing(&[8]);
    assert!(avail.is_missing(backend(8)));
}