probabilistic-rs 0.6.3

Probabilistic data structures in Rust
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
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
use probabilistic_rs::ebloom::{
    config::ExpiringFilterConfigBuilder,
    filter::ExpiringBloomFilter,
    traits::{ExpiringBloomFilterOps, ExpiringBloomFilterStats},
};
use std::{
    collections::HashSet,
    sync::{Arc, Mutex},
    thread,
    time::Duration,
};

// Helper function to create a basic test filter
fn create_test_filter(
    capacity_per_level: usize,
    num_levels: usize,
    fpr: f64,
) -> ExpiringBloomFilter {
    let config = ExpiringFilterConfigBuilder::default()
        .capacity_per_level(capacity_per_level)
        .target_fpr(fpr)
        .num_levels(num_levels)
        .level_duration(Duration::from_secs(60)) // 1 minute default
        .build()
        .expect("Failed to build test config");

    ExpiringBloomFilter::new(config).expect("Failed to create test filter")
}

// Helper function to create filter with short expiration for testing
fn create_short_expiry_filter(
    capacity_per_level: usize,
    num_levels: usize,
    duration_ms: u64,
) -> ExpiringBloomFilter {
    let config = ExpiringFilterConfigBuilder::default()
        .capacity_per_level(capacity_per_level)
        .target_fpr(0.01)
        .num_levels(num_levels)
        .level_duration(Duration::from_millis(duration_ms))
        .build()
        .expect("Failed to build test config");

    ExpiringBloomFilter::new(config).expect("Failed to create test filter")
}

// Helper function to generate consistent test data
fn generate_test_items(count: usize) -> Vec<Vec<u8>> {
    (0..count)
        .map(|i| format!("test_item_{:06}", i).into_bytes())
        .collect()
}

#[cfg(test)]
mod basic_operations_tests {
    use super::*;

    #[test]
    fn test_insert_and_contains() {
        let filter = create_test_filter(1000, 3, 0.01);

        let item1 = b"hello";
        let item2 = b"world";
        let item3 = b"rust";

        filter.insert(item1).unwrap();
        filter.insert(item2).unwrap();

        assert!(filter.contains(item1).unwrap());
        assert!(filter.contains(item2).unwrap());
        assert!(!filter.contains(item3).unwrap());
    }

    #[test]
    fn test_multiple_insertions() {
        let filter = create_test_filter(1000, 3, 0.01);
        let test_items = generate_test_items(10);

        // Insert all items
        for item in &test_items {
            filter.insert(item).expect("Insert should succeed");
        }

        // All inserted items should be found (no false negatives)
        for item in &test_items {
            assert!(
                filter.contains(item).expect("Contains should succeed"),
                "No false negatives allowed"
            );
        }

        // Verify total insert count across all levels
        assert_eq!(
            filter.total_insert_count(),
            test_items.len() as u64,
            "Total insert count should match"
        );
    }

    #[test]
    fn test_clear() {
        let filter = create_test_filter(1000, 3, 0.01);

        let item1 = b"hello";
        let item2 = b"world";

        filter.insert(item1).unwrap();
        filter.insert(item2).unwrap();

        assert!(filter.contains(item1).unwrap());
        assert!(filter.contains(item2).unwrap());

        filter.clear().unwrap();

        assert!(!filter.contains(item1).unwrap());
        assert!(!filter.contains(item2).unwrap());
        assert_eq!(filter.total_insert_count(), 0u64);
    }

    #[test]
    fn test_duplicate_insertions() {
        let filter = create_test_filter(1000, 3, 0.01);
        let item = b"duplicate_test";

        // Insert same item multiple times
        for _ in 0..5 {
            filter.insert(item).expect("Insert should succeed");
        }

        // Item should still be found
        assert!(filter.contains(item).expect("Contains should succeed"));

        // Insert count increases even for duplicates (bloom filter behavior)
        assert_eq!(filter.total_insert_count(), 5u64);
    }

    #[test]
    fn test_empty_filter_behavior() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Empty filter should not contain any items
        assert!(!filter.contains(b"test").unwrap());
        assert_eq!(filter.total_insert_count(), 0u64);

        // Clear on empty filter should work
        filter
            .clear()
            .expect("Clear should succeed on empty filter");
        assert_eq!(filter.total_insert_count(), 0u64);
    }
}

#[cfg(test)]
mod multi_level_behavior_tests {
    use super::*;

    #[test]
    fn test_current_level_tracking() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Initially on level 0
        assert_eq!(filter.get_active_level(), 0);
    }

    #[tokio::test]
    async fn test_items_found_across_levels() {
        let filter = create_short_expiry_filter(1000, 3, 100);

        // Insert in level 0
        filter.insert(b"item1").unwrap();
        assert!(filter.contains(b"item1").unwrap());

        // Wait for rotation
        thread::sleep(Duration::from_millis(150));
        filter.cleanup_expired_levels().await.unwrap();

        // Item should still be found in rotated level
        // (contains checks ALL levels)
        assert!(filter.contains(b"item1").unwrap());
    }

    #[tokio::test]
    async fn test_level_rotation_mechanics() {
        let filter = create_short_expiry_filter(1000, 3, 100);

        let initial_level = filter.get_active_level();

        // Wait for expiration and rotate
        thread::sleep(Duration::from_millis(150));
        filter.cleanup_expired_levels().await.unwrap();

        // Current level should have changed
        let new_level = filter.get_active_level();
        assert_ne!(initial_level, new_level);
    }

    #[tokio::test]
    async fn test_expiration_after_all_levels() {
        let filter = create_short_expiry_filter(100, 2, 100); // 2 levels, 100ms each

        filter.insert(b"expire_me").unwrap();
        assert!(filter.contains(b"expire_me").unwrap());

        // Rotate once - item moves to level 1
        thread::sleep(Duration::from_millis(150));
        filter.cleanup_expired_levels().await.unwrap();
        assert!(
            filter.contains(b"expire_me").unwrap(),
            "Should still be in level 1"
        );

        // Rotate again - item should be gone
        thread::sleep(Duration::from_millis(150));
        filter.cleanup_expired_levels().await.unwrap();

        // Item might still appear due to false positive, but that's expected
        // The key is that the levels rotated correctly
    }

    #[test]
    fn test_level_expiration_check() {
        let filter = create_short_expiry_filter(1000, 3, 100);

        // Level should not be expired immediately
        assert!(!filter.is_level_expired(0).unwrap());

        // After duration, should be expired
        thread::sleep(Duration::from_millis(150));
        assert!(filter.is_level_expired(0).unwrap());
    }
}

#[cfg(test)]
mod configuration_and_stats_tests {
    use super::*;

    #[test]
    fn test_config_validation_valid() {
        let config = ExpiringFilterConfigBuilder::default()
            .capacity_per_level(1000_usize)
            .target_fpr(0.01)
            .num_levels(3_usize)
            .level_duration(Duration::from_secs(60))
            .build();

        assert!(config.is_ok(), "Valid config should build successfully");
    }

    #[test]
    fn test_stats_accuracy() {
        let filter = create_test_filter(1000, 3, 0.01);

        assert_eq!(filter.capacity_per_level(), 1000);
        assert_eq!(filter.target_fpr(), 0.01);
        assert_eq!(filter.num_levels(), 3);
        assert_eq!(filter.active_levels(), 3);
        assert_eq!(filter.total_insert_count(), 0u64);

        // Insert some items
        for i in 0..10 {
            filter.insert(format!("item{}", i).as_bytes()).unwrap();
        }

        assert_eq!(filter.total_insert_count(), 10);
    }

    #[test]
    fn test_different_config_combinations() {
        // Small capacity, few levels
        let filter1 = create_test_filter(100, 2, 0.01);
        assert_eq!(filter1.num_levels(), 2);

        // Large capacity, many levels
        let filter2 = create_test_filter(10000, 5, 0.001);
        assert_eq!(filter2.num_levels(), 5);
        assert_eq!(filter2.target_fpr(), 0.001);
    }
}

#[cfg(test)]
mod edge_cases_and_error_conditions {
    use super::*;

    #[test]
    fn test_empty_item_insertion() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Empty item should be insertable
        filter
            .insert(b"")
            .expect("Empty item insertion should succeed");
        assert!(
            filter
                .contains(b"")
                .expect("Contains should work for empty item")
        );
    }

    #[test]
    fn test_binary_data_handling() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Test with binary data (null bytes, etc.)
        let binary_data: Vec<u8> = vec![0, 1, 255, 128, 0, 0, 42];
        filter
            .insert(&binary_data)
            .expect("Binary data insertion should succeed");
        assert!(
            filter
                .contains(&binary_data)
                .expect("Binary data lookup should succeed")
        );
    }

    #[test]
    fn test_large_item_insertion() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Test with large item (1MB)
        let large_item = vec![b'x'; 1024 * 1024];
        filter
            .insert(&large_item)
            .expect("Large item insertion should succeed");
        assert!(
            filter
                .contains(&large_item)
                .expect("Large item lookup should succeed")
        );
    }

    #[test]
    fn test_capacity_stress_test() {
        let capacity = 100;
        let filter = create_test_filter(capacity, 3, 0.01);
        let test_items = generate_test_items(capacity * 2); // Insert 2x capacity

        // Should handle over-capacity gracefully (bloom filters don't have hard limits)
        for item in &test_items {
            filter
                .insert(item)
                .expect("Insert should succeed even over capacity");
        }

        // No false negatives (all inserted items should be found)
        for item in &test_items {
            assert!(
                filter.contains(item).expect("Contains should succeed"),
                "No false negatives even when over capacity"
            );
        }
    }
}

#[cfg(test)]
mod behavioral_guarantees_tests {
    use super::*;

    #[test]
    fn test_no_false_negatives_guarantee() {
        let filter = create_test_filter(1000, 3, 0.01);
        let test_items = generate_test_items(100);

        // Insert all items
        for item in &test_items {
            filter.insert(item).unwrap();
        }

        // Verify no false negatives
        for item in &test_items {
            assert!(
                filter.contains(item).unwrap(),
                "Bloom filters must never have false negatives"
            );
        }
    }

    #[test]
    fn test_deterministic_behavior() {
        let filter1 = create_test_filter(1000, 3, 0.01);
        let filter2 = create_test_filter(1000, 3, 0.01);

        let test_item = b"deterministic_test";

        // Same operations on both filters
        filter1.insert(test_item).unwrap();
        filter2.insert(test_item).unwrap();

        // Both should give same results
        assert_eq!(
            filter1.contains(test_item).unwrap(),
            filter2.contains(test_item).unwrap()
        );
    }

    #[test]
    fn test_false_positive_rate_reasonable() {
        let filter = create_test_filter(1000, 3, 0.01);
        let inserted_items = generate_test_items(500);
        let test_items = generate_test_items(1000);

        // Insert first half
        for item in &inserted_items {
            filter.insert(item).unwrap();
        }

        // Check false positives on items NOT inserted
        let mut false_positives = 0;
        for item in test_items.iter().skip(500) {
            if filter.contains(item).unwrap() {
                false_positives += 1;
            }
        }

        let false_positive_rate = false_positives as f64 / 500.0;

        // FPR should be somewhat close to target (allowing for multi-level increase)
        // Multi-level can increase FPR, so we allow up to 5x the target FPR
        assert!(
            false_positive_rate < 0.05,
            "False positive rate too high: {}",
            false_positive_rate
        );
    }
}

#[cfg(test)]
mod thread_safety_tests {
    use super::*;

    #[test]
    fn test_concurrent_reads() {
        let filter = Arc::new(create_test_filter(10000, 3, 0.01));
        let test_items = generate_test_items(100);

        // Insert items first
        for item in &test_items {
            filter.insert(item).unwrap();
        }

        // Spawn multiple reader threads
        let mut handles = vec![];
        for _ in 0..10 {
            let filter_clone = Arc::clone(&filter);
            let items_clone = test_items.clone();

            let handle = thread::spawn(move || {
                for item in &items_clone {
                    assert!(filter_clone.contains(item).unwrap());
                }
            });
            handles.push(handle);
        }

        // Wait for all threads
        for handle in handles {
            handle.join().expect("Thread should complete successfully");
        }
    }

    #[test]
    fn test_single_writer_multiple_readers() {
        let filter = Arc::new(create_test_filter(10000, 3, 0.01));
        let test_items = generate_test_items(100);
        let inserted_items = Arc::new(Mutex::new(HashSet::new()));

        // Writer thread
        let filter_clone = Arc::clone(&filter);
        let items_clone = test_items.clone();
        let inserted_clone = Arc::clone(&inserted_items);

        let writer = thread::spawn(move || {
            for item in &items_clone {
                filter_clone.insert(item).unwrap();
                inserted_clone.lock().unwrap().insert(item.clone());
                thread::sleep(Duration::from_micros(100));
            }
        });

        // Reader threads
        let mut readers = vec![];
        for _ in 0..5 {
            let filter_clone = Arc::clone(&filter);
            let inserted_clone = Arc::clone(&inserted_items);

            let handle = thread::spawn(move || {
                for _ in 0..50 {
                    let items = inserted_clone.lock().unwrap().clone();
                    for item in items.iter() {
                        // No false negatives for inserted items
                        assert!(filter_clone.contains(item).unwrap());
                    }
                    thread::sleep(Duration::from_micros(200));
                }
            });
            readers.push(handle);
        }

        writer.join().expect("Writer should complete");
        for reader in readers {
            reader.join().expect("Reader should complete");
        }
    }
}

#[cfg(test)]
mod integration_tests {
    use super::*;

    #[tokio::test]
    async fn test_realistic_usage_scenario() {
        // Simulate a cache invalidation scenario
        let filter = create_short_expiry_filter(1000, 3, 200);

        // Phase 1: Add some cache keys
        for i in 0..50 {
            let key = format!("cache_key_{}", i);
            filter.insert(key.as_bytes()).unwrap();
        }

        // Verify all are present
        for i in 0..50 {
            let key = format!("cache_key_{}", i);
            assert!(filter.contains(key.as_bytes()).unwrap());
        }

        // Phase 2: Rotate levels
        thread::sleep(Duration::from_millis(250));
        filter.cleanup_expired_levels().await.unwrap();

        // Old keys should still be findable (in rotated level)
        for i in 0..50 {
            let key = format!("cache_key_{}", i);
            assert!(filter.contains(key.as_bytes()).unwrap());
        }

        // Phase 3: Add new keys
        for i in 50..100 {
            let key = format!("cache_key_{}", i);
            filter.insert(key.as_bytes()).unwrap();
        }

        // All keys should be present
        for i in 0..100 {
            let key = format!("cache_key_{}", i);
            assert!(filter.contains(key.as_bytes()).unwrap());
        }
    }

    #[tokio::test]
    async fn test_time_based_expiration_workflow() {
        let filter = create_short_expiry_filter(100, 3, 100); // 3 levels for better testing

        // Insert items at different times
        filter.insert(b"early_item").unwrap();

        thread::sleep(Duration::from_millis(110)); // Wait for rotation
        filter.cleanup_expired_levels().await.unwrap();

        // early_item should still be present (now in previous level)
        assert!(filter.contains(b"early_item").unwrap());

        // Insert new item in new current level
        filter.insert(b"mid_item").unwrap();

        thread::sleep(Duration::from_millis(110)); // Wait for another rotation
        filter.cleanup_expired_levels().await.unwrap();

        // Both should still be present (in different historical levels)
        assert!(filter.contains(b"early_item").unwrap());
        assert!(filter.contains(b"mid_item").unwrap());

        thread::sleep(Duration::from_millis(110)); // Third rotation
        filter.cleanup_expired_levels().await.unwrap();

        // early_item should be expired now (was in oldest level)
        // mid_item still present
        assert!(filter.contains(b"mid_item").unwrap());
    }

    #[test]
    fn test_mixed_operations() {
        let filter = create_test_filter(1000, 3, 0.01);

        // Mix of operations
        filter.insert(b"item1").unwrap();
        assert!(filter.contains(b"item1").unwrap());

        filter.insert(b"item2").unwrap();
        filter.insert(b"item3").unwrap();

        assert_eq!(filter.total_insert_count(), 3);

        filter.clear().unwrap();
        assert_eq!(filter.total_insert_count(), 0);

        filter.insert(b"new_item").unwrap();
        assert!(filter.contains(b"new_item").unwrap());
        assert_eq!(filter.total_insert_count(), 1);
    }
}