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
// Copyright 2019 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/

use crate::{
    ip::{
        sample::{SampleHashMap, SampleHashSet},
        util::SubnetType,
    },
    node_table::{NodeId, NodeTable},
    Node,
};
use rand::thread_rng;
use std::collections::{HashMap, HashSet};

/// Tag based node index, so as to filter nodes by tag in node database.
/// It support to sample nodes with special tag in O(1) time complexity.
#[derive(Default)]
pub struct NodeTagIndex {
    // map<tag_key, map<tag_value, map<subnet, set<node_id>>>>
    items: HashMap<
        String,
        HashMap<String, SampleHashMap<u32, SampleHashSet<NodeId>>>,
    >,
}

impl NodeTagIndex {
    /// Build the node tag based index for the specified node table.
    pub fn new_with_node_table(table: &NodeTable) -> Self {
        let mut result = NodeTagIndex::default();

        for id in table.all() {
            let node = table.get(&id).expect("node not found in table");
            for (k, v) in node.tags.iter() {
                let ip = node.endpoint.address.ip();
                let subnet = SubnetType::C.subnet(&ip);
                result.insert(id, subnet, k.clone(), v.clone());
            }
        }

        result
    }

    pub fn insert(
        &mut self, id: NodeId, subnet: u32, key: String, value: String,
    ) -> bool {
        self.items
            .entry(key)
            .or_insert_with(Default::default)
            .entry(value)
            .or_insert_with(Default::default)
            .get_mut_or_insert_with(subnet, Default::default)
            .insert(id)
    }

    pub fn remove(
        &mut self, id: &NodeId, subnet: u32, key: &String, value: &String,
    ) -> Option<()> {
        let tag_key_values = self.items.get_mut(key)?;
        let buckets = tag_key_values.get_mut(value)?;
        let nodes = buckets.get_mut(&subnet)?;

        if !nodes.remove(id) {
            return None;
        }

        if nodes.is_empty() {
            buckets.remove(&subnet);
        }

        if buckets.is_empty() {
            tag_key_values.remove(value);
        }

        if tag_key_values.is_empty() {
            self.items.remove(key);
        }

        Some(())
    }

    pub fn sample(
        &self, count: u32, key: &String, value: &String,
    ) -> Option<HashSet<NodeId>> {
        let buckets = self.items.get(key)?.get(value)?;

        let mut rng = thread_rng();
        let mut sampled = HashSet::new();

        for _ in 0..count {
            if let Some(bucket) = buckets.sample(&mut rng) {
                if let Some(id) = bucket.sample(&mut rng) {
                    sampled.insert(id);
                }
            }
        }

        Some(sampled)
    }

    pub fn add_node(&mut self, node: &Node) {
        if node.tags.is_empty() {
            return;
        }

        let ip = node.endpoint.address.ip();
        let subnet = SubnetType::C.subnet(&ip);

        for (key, value) in node.tags.iter() {
            self.insert(node.id.clone(), subnet, key.clone(), value.clone());
        }
    }

    pub fn remove_node(&mut self, node: &Node) {
        if node.tags.is_empty() {
            return;
        }

        let ip = node.endpoint.address.ip();
        let subnet = SubnetType::C.subnet(&ip);

        for (key, value) in node.tags.iter() {
            self.remove(&node.id, subnet, key, value);
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{ip::NodeTagIndex, node_table::NodeId};

    #[test]
    fn test_insert() {
        let mut index = NodeTagIndex::default();

        let n1 = NodeId::random();
        assert_eq!(
            index.insert(n1.clone(), 38, "k1".into(), "v1".into()),
            true
        );
        assert_eq!(
            index.insert(n1.clone(), 38, "k1".into(), "v1".into()),
            false
        );
        assert_eq!(
            index.insert(n1.clone(), 38, "k1".into(), "v2".into()),
            true
        );
        assert_eq!(
            index.insert(n1.clone(), 38, "k2".into(), "v1".into()),
            true
        );
        assert_eq!(
            index.insert(n1.clone(), 39, "k1".into(), "v1".into()),
            true
        );
        assert_eq!(
            index.insert(NodeId::random(), 38, "k1".into(), "v1".into()),
            true
        );
    }

    #[test]
    fn test_remove() {
        let mut index = NodeTagIndex::default();

        let n1 = NodeId::random();
        assert_eq!(
            index.insert(n1.clone(), 38, "k1".into(), "v1".into()),
            true
        );

        let n2 = NodeId::random();
        assert_eq!(index.remove(&n2, 38, &"k1".into(), &"v1".into()), None);
        assert_eq!(index.remove(&n1, 39, &"k1".into(), &"v1".into()), None);
        assert_eq!(index.remove(&n1, 38, &"k2".into(), &"v1".into()), None);
        assert_eq!(index.remove(&n1, 38, &"k1".into(), &"v2".into()), None);
        assert_eq!(index.remove(&n1, 38, &"k1".into(), &"v1".into()), Some(()));
    }

    #[test]
    fn test_sample() {
        let mut index = NodeTagIndex::default();

        // sample nothing on empty
        assert_eq!(index.sample(10, &"k1".into(), &"v1".into()), None);

        // add index and sampled 1 node.
        let n1 = NodeId::random();
        assert_eq!(
            index.insert(n1.clone(), 38, "k1".into(), "v1".into()),
            true
        );
        let sampled = index.sample(1, &"k1".into(), &"v1".into());
        assert_eq!(sampled.unwrap().into_iter().next(), Some(n1));
    }
}