fips-core 0.3.58

Reusable FIPS mesh, endpoint, transport, and protocol library
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
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
use super::*;

#[test]
fn endpoint_event_batch_scope_emits_one_batch_and_keeps_immediate_delivery_outside_scope() {
    let mut node = Node::new(Config::new()).expect("node");
    let mut endpoint_io = node.attach_endpoint_data_io(8).expect("endpoint io");
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    node.deliver_endpoint_event_message(EndpointDataDelivery::new(source, b"single".to_vec()))
        .expect("single endpoint event");
    match endpoint_io.event_rx.try_recv().expect("single event") {
        NodeEndpointEvent::Data {
            source_peer,
            payload,
            ..
        } => {
            assert_eq!(source_peer, source);
            assert_eq!(payload, b"single");
        }
        event => panic!("expected single endpoint event, got {event:?}"),
    }

    node.begin_endpoint_event_batch();
    node.deliver_endpoint_event_message(EndpointDataDelivery::new(source, b"first".to_vec()))
        .expect("first batched endpoint event");
    node.deliver_endpoint_event_message(EndpointDataDelivery::new(source, b"second".to_vec()))
        .expect("second batched endpoint event");
    assert!(
        endpoint_io.event_rx.try_recv().is_err(),
        "batch scope should not flush before finish"
    );

    node.finish_endpoint_event_batch();
    match endpoint_io.event_rx.try_recv().expect("batched event") {
        NodeEndpointEvent::DataBatch { messages, .. } => {
            assert_eq!(messages.len(), 2);
            assert_eq!(messages[0].source_peer, source);
            assert_eq!(messages[0].payload, b"first");
            assert_eq!(messages[1].source_peer, source);
            assert_eq!(messages[1].payload, b"second");
        }
        event => panic!("expected endpoint event batch, got {event:?}"),
    }
}

#[test]
fn endpoint_event_runtime_owns_attach_batch_and_backlog() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());
    let mut runtime = EndpointEventRuntime::default();

    assert!(!runtime.is_attached());
    runtime
        .deliver_endpoint_data(EndpointDataDelivery::new(source, b"detached".to_vec()))
        .expect("detached endpoint runtime delivery should be a no-op");
    assert!(
        event_rx.try_recv().is_err(),
        "detached runtime must not enqueue endpoint events"
    );
    assert_eq!(event_tx.queued_messages(), 0);

    runtime.attach(event_tx.clone());
    runtime.begin_batch();
    runtime
        .deliver_endpoint_data(EndpointDataDelivery::new(source, b"first".to_vec()))
        .expect("first batched endpoint event");
    runtime
        .deliver_endpoint_data(EndpointDataDelivery::new(source, b"second".to_vec()))
        .expect("second batched endpoint event");
    assert!(
        event_rx.try_recv().is_err(),
        "runtime batch scope should not flush before finish"
    );

    runtime.finish_batch();
    assert_eq!(event_tx.queued_messages(), 2);
    match event_rx.try_recv().expect("batched event") {
        NodeEndpointEvent::DataBatch { messages, .. } => {
            assert_eq!(messages.len(), 2);
            assert_eq!(messages[0].source_peer, source);
            assert_eq!(messages[0].payload, b"first");
            assert_eq!(messages[1].source_peer, source);
            assert_eq!(messages[1].payload, b"second");
        }
        event => panic!("expected endpoint event batch, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
}

#[test]
fn endpoint_event_queue_owns_backlog_message_count() {
    let mut node = Node::new(Config::new()).expect("node");
    let mut endpoint_io = node.attach_endpoint_data_io(8).expect("endpoint io");
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    assert_eq!(endpoint_io.event_tx.queued_messages(), 0);
    assert_eq!(endpoint_io.event_tx.bulk_queued_messages(), 0);
    node.deliver_endpoint_event_message(EndpointDataDelivery::new(source, b"single".to_vec()))
        .expect("single endpoint event");
    assert_eq!(endpoint_io.event_tx.queued_messages(), 1);
    assert_eq!(
        endpoint_io.event_tx.bulk_queued_messages(),
        0,
        "priority-sized events must not consume the bulk message budget"
    );

    node.begin_endpoint_event_batch();
    node.deliver_endpoint_event_message(EndpointDataDelivery::new(
        source,
        vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1],
    ))
    .expect("first batched endpoint event");
    node.deliver_endpoint_event_message(EndpointDataDelivery::new(
        source,
        vec![0xbb; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2],
    ))
    .expect("second batched endpoint event");
    node.finish_endpoint_event_batch();
    assert_eq!(
        endpoint_io.event_tx.queued_messages(),
        3,
        "backlog count should account for batch payloads, not channel items"
    );
    assert_eq!(endpoint_io.event_tx.bulk_queued_messages(), 2);

    endpoint_io.event_rx.try_recv().expect("single event");
    assert_eq!(endpoint_io.event_tx.queued_messages(), 2);
    assert_eq!(endpoint_io.event_tx.bulk_queued_messages(), 2);
    endpoint_io.event_rx.try_recv().expect("batched event");
    assert_eq!(endpoint_io.event_tx.queued_messages(), 0);
    assert_eq!(endpoint_io.event_tx.bulk_queued_messages(), 0);
}

#[test]
fn endpoint_event_dequeue_counts_preserve_message_and_lane_counts() {
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    let event = NodeEndpointEvent::Data {
        source_peer: source,
        payload: vec![0x11; ENDPOINT_EVENT_PRIORITY_MAX_LEN],
        queued_at: None,
    };
    assert_eq!(
        event.dequeue_counts(),
        EndpointEventDequeueCounts {
            total: 1,
            priority: 1,
            bulk: 0,
        }
    );

    let event = NodeEndpointEvent::DataBatch {
        messages: vec![
            EndpointDataDelivery::new(source, vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
            EndpointDataDelivery::new(source, vec![0x11; 32]),
            EndpointDataDelivery::new(source, vec![0xbb; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2]),
        ],
        queued_at: None,
    };
    assert_eq!(
        event.dequeue_counts(),
        EndpointEventDequeueCounts {
            total: 3,
            priority: 1,
            bulk: 2,
        }
    );
}

#[test]
fn release_endpoint_event_messages_subtracts_exact_count() {
    let counter = AtomicUsize::new(5);

    release_endpoint_event_messages(&counter, 0);
    assert_eq!(counter.load(Relaxed), 5);

    release_endpoint_event_messages(&counter, 3);
    assert_eq!(counter.load(Relaxed), 2);
}

#[test]
fn endpoint_event_queue_splits_mixed_batch_into_priority_and_bulk_lanes() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
                EndpointDataDelivery::new(source, vec![0x11; 32]),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("mixed endpoint event batch should enqueue");

    match event_rx.try_recv().expect("priority event") {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload[0], 0x11),
        event => panic!("expected priority data event, got {event:?}"),
    }
    match event_rx.try_recv().expect("bulk event") {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload[0], 0xaa),
        event => panic!("expected bulk data event, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
}

#[test]
fn endpoint_event_queue_keeps_single_lane_batches_grouped() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
                EndpointDataDelivery::new(source, vec![0xbb; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2]),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("bulk endpoint event batch should enqueue");
    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, b"first".to_vec()),
                EndpointDataDelivery::new(source, b"second".to_vec()),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("priority endpoint event batch should enqueue");

    match event_rx.try_recv().expect("priority batch") {
        NodeEndpointEvent::DataBatch { messages, .. } => {
            assert_eq!(messages.len(), 2);
            assert_eq!(messages[0].payload, b"first");
            assert_eq!(messages[1].payload, b"second");
        }
        event => panic!("expected priority endpoint event batch, got {event:?}"),
    }
    match event_rx.try_recv().expect("bulk batch") {
        NodeEndpointEvent::DataBatch { messages, .. } => {
            assert_eq!(messages.len(), 2);
            assert_eq!(messages[0].payload[0], 0xaa);
            assert_eq!(messages[1].payload[0], 0xbb);
        }
        event => panic!("expected bulk endpoint event batch, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
}

#[test]
fn endpoint_event_queue_drops_bulk_when_full_without_blocking_priority() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(1);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("first bulk endpoint event should enqueue");
    assert_eq!(event_tx.queued_messages(), 1);

    event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: vec![0xbb; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("full bulk endpoint lane should drop rather than fail");
    assert_eq!(
        event_tx.queued_messages(),
        1,
        "dropped bulk event should roll back queued message accounting"
    );

    event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: b"priority".to_vec(),
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("priority endpoint event should keep reserved progress");
    assert_eq!(event_tx.queued_messages(), 2);

    match event_rx.try_recv().expect("priority event") {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload, b"priority"),
        event => panic!("expected priority data event, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 1);

    match event_rx.try_recv().expect("first bulk event") {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload[0], 0xaa),
        event => panic!("expected bulk data event, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
    assert!(matches!(
        event_rx.try_recv(),
        Err(tokio::sync::mpsc::error::TryRecvError::Empty)
    ));
}

#[test]
fn endpoint_event_queue_dropped_bulk_batch_counts_as_success() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(2);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
                EndpointDataDelivery::new(source, vec![0xab; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2]),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("first bulk endpoint batch should enqueue");
    assert_eq!(event_tx.queued_messages(), 2);
    assert_eq!(event_tx.bulk_queued_messages(), 2);

    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, vec![0xba; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
                EndpointDataDelivery::new(source, vec![0xbb; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2]),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("full bulk endpoint lane should drop batch rather than fail");
    assert_eq!(
        event_tx.queued_messages(),
        2,
        "dropped bulk batch should roll back all message accounting"
    );
    assert_eq!(event_tx.bulk_queued_messages(), 2);

    match event_rx.try_recv().expect("first bulk batch") {
        NodeEndpointEvent::DataBatch { messages, .. } => {
            assert_eq!(messages.len(), 2);
            assert_eq!(messages[0].payload[0], 0xaa);
            assert_eq!(messages[1].payload[0], 0xab);
        }
        event => panic!("expected bulk endpoint event batch, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
    assert_eq!(event_tx.bulk_queued_messages(), 0);
    assert!(matches!(
        event_rx.try_recv(),
        Err(tokio::sync::mpsc::error::TryRecvError::Empty)
    ));
}

#[test]
fn endpoint_event_bulk_capacity_counts_messages_not_batches() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(1);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::DataBatch {
            messages: vec![
                EndpointDataDelivery::new(source, vec![0xaa; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 1]),
                EndpointDataDelivery::new(source, vec![0xab; ENDPOINT_EVENT_PRIORITY_MAX_LEN + 2]),
            ],
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("oversized bulk endpoint batch should drop rather than fail");
    assert_eq!(
        event_tx.queued_messages(),
        0,
        "one channel item may still contain more bulk messages than the message cap"
    );
    assert_eq!(event_tx.bulk_queued_messages(), 0);
    assert!(matches!(
        event_rx.try_recv(),
        Err(tokio::sync::mpsc::error::TryRecvError::Empty)
    ));

    event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: b"priority".to_vec(),
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("priority endpoint event should keep reserved progress");
    assert_eq!(event_tx.queued_messages(), 1);
    assert_eq!(event_tx.bulk_queued_messages(), 0);
    match event_rx.try_recv().expect("priority event") {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload, b"priority"),
        event => panic!("expected priority data event, got {event:?}"),
    }
}

#[test]
fn endpoint_event_queue_send_fails_after_receiver_drop() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);
    let source = PeerIdentity::from_pubkey_full(Identity::generate().pubkey_full());

    event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: b"queued".to_vec(),
            queued_at: crate::perf_profile::stamp(),
        })
        .expect("endpoint event should enqueue while receiver is alive");
    assert_eq!(event_tx.queued_messages(), 1);
    assert!(event_rx.try_recv().is_ok());

    drop(event_rx);
    assert_eq!(
        event_tx.queued_messages(),
        0,
        "receiver drop should discard any owned backlog"
    );

    let error = event_tx
        .send(NodeEndpointEvent::Data {
            source_peer: source,
            payload: b"after-drop".to_vec(),
            queued_at: crate::perf_profile::stamp(),
        })
        .expect_err("send should fail once endpoint event receiver is dropped");
    match error.0 {
        NodeEndpointEvent::Data { payload, .. } => assert_eq!(payload, b"after-drop"),
        event => panic!("expected failed data event, got {event:?}"),
    }
    assert_eq!(event_tx.queued_messages(), 0);
}

#[test]
fn endpoint_event_queue_closes_after_all_senders_drop() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);
    let event_tx_clone = event_tx.clone();

    drop(event_tx);
    assert!(
        matches!(
            event_rx.try_recv(),
            Err(tokio::sync::mpsc::error::TryRecvError::Empty)
        ),
        "receiver should stay open while a sender clone is alive"
    );

    drop(event_tx_clone);
    assert!(
        matches!(
            event_rx.try_recv(),
            Err(tokio::sync::mpsc::error::TryRecvError::Disconnected)
        ),
        "receiver should close once the final sender is dropped"
    );
    assert!(
        event_rx.blocking_recv().is_none(),
        "blocking receive should return after sender close"
    );
}

#[tokio::test]
async fn endpoint_event_queue_async_recv_closes_when_senders_drop() {
    let (event_tx, mut event_rx) = EndpointEventSender::channel(8);

    let waiter = tokio::spawn(async move { event_rx.recv().await });
    tokio::task::yield_now().await;
    drop(event_tx);

    let result = tokio::time::timeout(std::time::Duration::from_secs(1), waiter)
        .await
        .expect("async recv should wake after final sender drops")
        .expect("async recv task should not panic");
    assert!(result.is_none());
}