iggy_common 0.10.0

Iggy is the persistent message streaming platform written in Rust, supporting QUIC, TCP and HTTP transport protocols, capable of processing millions of messages per second.
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

/* Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

use crate::IggyDuration;
use moka::future::{Cache, CacheBuilder};

#[derive(Debug)]
pub struct MessageDeduplicator {
    ttl: Option<IggyDuration>,
    max_entries: Option<u64>,
    cache: Cache<u128, bool>,
}

/// Create deep copy of the `MessageDeduplicator` instance.
/// Regular `Clone` cheap as it only creates thread-safe reference counted
/// pointers to the shared internal data structures.
impl Clone for MessageDeduplicator {
    fn clone(&self) -> Self {
        let builder = Cache::builder();
        let builder = Self::setup_cache_builder(builder, self.max_entries, self.ttl);
        let cache = builder.build();

        Self {
            ttl: self.ttl,
            max_entries: self.max_entries,
            cache,
        }
    }
}

impl MessageDeduplicator {
    fn setup_cache_builder(
        mut builder: CacheBuilder<u128, bool, Cache<u128, bool>>,
        max_entries: Option<u64>,
        ttl: Option<IggyDuration>,
    ) -> CacheBuilder<u128, bool, Cache<u128, bool>> {
        if let Some(max_entries) = max_entries {
            builder = builder.max_capacity(max_entries);
        }
        if let Some(ttl) = ttl {
            builder = builder.time_to_live(ttl.get_duration());
        }
        builder
    }

    /// Creates a new message deduplicator with the given max entries and time to live for each ID.
    pub fn new(max_entries: Option<u64>, ttl: Option<IggyDuration>) -> Self {
        let builder = Cache::builder();
        let builder = Self::setup_cache_builder(builder, max_entries, ttl);
        let cache = builder.build();

        Self {
            ttl,
            max_entries,
            cache,
        }
    }

    /// Checks if the given ID exists.
    pub fn exists(&self, id: u128) -> bool {
        self.cache.contains_key(&id)
    }

    /// Inserts the given ID.
    pub async fn insert(&self, id: u128) {
        self.cache.insert(id, true).await
    }

    /// Tries to insert the given ID, returns false if it already exists.
    pub async fn try_insert(&self, id: u128) -> bool {
        if self.exists(id) {
            false
        } else {
            self.insert(id).await;
            true
        }
    }
}

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

    #[tokio::test]
    async fn message_deduplicator_should_insert_only_unique_identifiers() {
        let max_entries = 1000;
        let ttl = "1s".parse::<IggyDuration>().unwrap();
        let deduplicator = MessageDeduplicator::new(Some(max_entries), Some(ttl));
        for i in 0..max_entries {
            let id = i as u128;
            assert!(deduplicator.try_insert(id).await);
            assert!(deduplicator.exists(id));
            assert!(!deduplicator.try_insert(id).await);
        }
    }

    #[tokio::test]
    async fn message_deduplicator_should_evict_identifiers_after_given_time_to_live() {
        let max_entries = 3;
        let ttl = "100ms".parse::<IggyDuration>().unwrap();
        let deduplicator = MessageDeduplicator::new(Some(max_entries), Some(ttl));
        for i in 0..max_entries {
            let id = i as u128;
            assert!(deduplicator.try_insert(id).await);
            assert!(deduplicator.exists(id));
            tokio::time::sleep(2 * ttl.get_duration()).await;
            assert!(!deduplicator.exists(id));
            assert!(deduplicator.try_insert(id).await);
        }
    }
}