routing 0.4.0

A secured storage DHT
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

// Copyright 2015 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement, version 1.0.  This, along with the
// Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

use lru_time_cache::LruCache;
use std::collections::BTreeSet;
use messages::RoutingMessage;
use NameType;

type Set<K> = BTreeSet<K>;
pub type Bytes = Vec<u8>;

pub struct MessageAccumulator {
    //                                       +-> Who sent it
    //                                       |
    requests: LruCache<RoutingMessage, Set<NameType>>,
}

impl MessageAccumulator {

    pub fn with_expiry_duration(duration: ::time::Duration) -> MessageAccumulator {
        MessageAccumulator { requests: LruCache::with_expiry_duration(duration) }
    }

    pub fn add_message(&mut self,
                       threshold: usize,
                       claimant: NameType,
                       message: RoutingMessage)
                       -> Option<RoutingMessage> {
        {
            if threshold <= 1 {
                return Some(message);
            }

            let claimants = self.requests.entry(message.clone())
                                         .or_insert_with(||Set::new());

            claimants.insert(claimant);

            if claimants.len() < threshold {
                return None;
            }

            debug!("Returning message, {:?}, from accumulator", message);
            Some(message)

        }.map(|message| {
            let _ = self.requests.remove(&message);
            message
        })
    }
}

#[cfg(test)]
mod test {
    #[test]
    fn add_with_fixed_threshold() {
        use ::test_utils::random_trait::Random;

        let threshold = 3usize;
        let id = ::id::Id::new();
        let routing_message = ::test_utils::messages_util::arbitrary_routing_message(
            &id.signing_public_key(), &id.signing_private_key());
        let mut accumulator = ::message_accumulator::MessageAccumulator::with_expiry_duration(
            ::time::Duration::minutes(10));
        for _ in 0..threshold - 1 {
            assert!(accumulator.add_message(threshold.clone(), ::NameType::generate_random(),
                routing_message.clone()).is_none());
        }
        assert_eq!(accumulator.add_message(threshold.clone(), ::NameType::generate_random(),
            routing_message.clone()), Some(routing_message.clone()));

        // assert that the accumulator has been cleared; repeat with the same message
        for _ in 0..threshold - 1 {
            assert!(accumulator.add_message(threshold.clone(), ::NameType::generate_random(),
                routing_message.clone()).is_none());
        }
        assert_eq!(accumulator.add_message(threshold.clone(), ::NameType::generate_random(),
            routing_message.clone()), Some(routing_message));
    }

    #[test]
    fn add_repeat_claimants() {
        use ::test_utils::random_trait::Random;

        let threshold = 3usize;
        let id = ::id::Id::new();
        let routing_message = ::test_utils::messages_util::arbitrary_routing_message(
            &id.signing_public_key(), &id.signing_private_key());
        let mut accumulator = ::message_accumulator::MessageAccumulator::with_expiry_duration(
            ::time::Duration::minutes(10));
        for _ in 0..threshold - 1 {
            let claimant = ::NameType::generate_random();
            assert!(accumulator.add_message(threshold.clone(), claimant.clone(),
                routing_message.clone()).is_none());
            assert!(accumulator.add_message(threshold.clone(), claimant.clone(),
                routing_message.clone()).is_none());
        }
        let claimant = ::NameType::generate_random();
        assert_eq!(accumulator.add_message(threshold.clone(), claimant.clone(),
            routing_message.clone()), Some(routing_message.clone()));
        assert!(accumulator.add_message(threshold.clone(), claimant.clone(),
            routing_message.clone()).is_none());
    }

    #[test]
    fn add_multiple_messages() {
        use ::test_utils::random_trait::Random;

        let threshold = 3usize;
        let id = ::id::Id::new();
        let routing_message1 = ::test_utils::messages_util::arbitrary_routing_message(
            &id.signing_public_key(), &id.signing_private_key());
        let routing_message2 = ::test_utils::messages_util::arbitrary_routing_message(
            &id.signing_public_key(), &id.signing_private_key());
        let mut accumulator = ::message_accumulator::MessageAccumulator::with_expiry_duration(
            ::time::Duration::minutes(10));
        for _ in 0..threshold - 1 {
            let claimant = ::NameType::generate_random();
            assert!(accumulator.add_message(threshold.clone(), claimant.clone(),
                routing_message1.clone()).is_none());
            assert!(accumulator.add_message(threshold.clone(), claimant.clone(),
                routing_message2.clone()).is_none());
        }
        let claimant = ::NameType::generate_random();
        assert_eq!(accumulator.add_message(threshold.clone(), claimant.clone(),
            routing_message1.clone()), Some(routing_message1.clone()));
        assert!(accumulator.add_message(threshold.clone() + 1, claimant.clone(),
            routing_message2.clone()).is_none());
        // lower threshold again
        assert_eq!(accumulator.add_message(threshold.clone(), ::NameType::generate_random(),
            routing_message2.clone()), Some(routing_message2.clone()));
    }
}