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
use crate::core::{
    db::Database,
    payload::{Dispatchable, Identifiable},
};

/// Interface for working with database as message queue
pub trait SimpleDispatcher<M>
where
    M: Dispatchable,
{
    /// Push message to queue
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::SimpleDispatcher;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push(message);
    /// ```
    fn push(&mut self, message: M);

    /// Get message from queue
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::SimpleDispatcher;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Identifiable;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push(message.clone());
    ///
    /// assert_eq!(db.peek().unwrap().id(), message.id());
    /// ```
    fn peek(&self) -> Option<&M>;

    /// Start GC cycle on queue
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::SimpleDispatcher;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::{Identifiable, Status};
    /// use std::thread::sleep;
    /// use std::time::Duration;
    ///
    /// let mut db = VecDatabase::default();
    ///
    /// // We need two test messages here: one without timeout, and one with 1 second timeout
    /// // GC condition varies between messages, but here we'll use timeout as an example
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// // Setting timeout to 0 and waiting 1-2 seconds turns message into garbage
    /// let mut garbage_message = MessageBuilder::default().body("I will be deleted").timeout(0).compose().unwrap();
    ///
    /// // We are going to reserve the message before adding it do database
    /// garbage_message.reserve();
    ///
    /// sleep(Duration::from_secs(2));
    ///
    /// db.push(message.clone());
    /// db.push(garbage_message);
    ///
    /// assert_eq!(db.size(), 2);
    ///
    /// db.gc();
    ///
    /// assert_eq!(db.size(), 1);
    /// assert_eq!(db.peek().unwrap().id(), message.id());
    /// ```
    fn gc(&mut self);

    /// Get queue size
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::SimpleDispatcher;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// assert_eq!(db.size(), 0);
    ///
    /// db.push(message.clone());
    ///
    /// assert_eq!(db.size(), 1);
    /// ```
    fn size(&self) -> usize;

    /// Clear all queue messages
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::SimpleDispatcher;
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// assert_eq!(db.size(), 0);
    ///
    /// db.push(message.clone());
    ///
    /// assert_eq!(db.size(), 1);
    ///
    /// db.clear();
    ///
    /// assert_eq!(db.size(), 0);
    /// ```
    fn clear(&mut self);
}

/// Interface for deleting messages from queue, where database position key is not the same, as message ID
///
/// It is preferable to use [`PositionBasedDelete`] instead of [`Delete`]
pub trait Delete<M>: SimpleDispatcher<M>
where
    M: Dispatchable,
{
    /// Delete message from queue
    ///
    /// Returns owned message if id is present in database
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::{SimpleDispatcher, Delete};
    /// use spartan_lib::core::db::VecDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Identifiable;
    ///
    /// let mut db = VecDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push(message.clone());
    ///
    /// assert_eq!(db.size(), 1);
    ///
    /// assert_eq!(db.delete(message.id()).unwrap().id(), message.id());
    ///
    /// assert_eq!(db.size(), 0);
    /// ```
    fn delete(&mut self, id: <M as Identifiable>::Id) -> Option<M>;
}

/// Interface for deleting messages from queue, where database position key is the same, as message ID
pub trait PositionBasedDelete<M>: SimpleDispatcher<M>
where
    M: Dispatchable,
{
    /// Delete message from queue
    ///
    /// Returns owned message if id is present in database
    ///
    /// ```
    /// use spartan_lib::core::dispatcher::{SimpleDispatcher, PositionBasedDelete};
    /// use spartan_lib::core::db::TreeDatabase;
    /// use spartan_lib::core::message::builder::MessageBuilder;
    /// use spartan_lib::core::payload::Identifiable;
    ///
    /// let mut db = TreeDatabase::default();
    /// let message = MessageBuilder::default().body("Hello, world").compose().unwrap();
    ///
    /// db.push(message.clone());
    ///
    /// assert_eq!(db.size(), 1);
    ///
    /// assert_eq!(db.delete(message.id()).unwrap().id(), message.id());
    ///
    /// assert_eq!(db.size(), 0);
    /// ```
    fn delete(&mut self, id: <M as Identifiable>::Id) -> Option<M>;
}

impl<T, M> SimpleDispatcher<M> for T
where
    T: Database<M>,
    M: Dispatchable,
{
    fn push(&mut self, message: M) {
        self.push_raw(message);
    }

    fn peek(&self) -> Option<&M> {
        self.get(self.position(|msg| msg.obtainable())?)
    }

    fn gc(&mut self) {
        self.retain(|msg| !msg.gc());
    }

    fn size(&self) -> usize {
        self.len()
    }

    fn clear(&mut self) {
        self.clear()
    }
}

impl<T, M> Delete<M> for T
where
    T: Database<M>,
    M: Dispatchable,
{
    fn delete(&mut self, id: <M as Identifiable>::Id) -> Option<M> {
        self.delete_pos(self.position(|msg| msg.id() == id)?)
    }
}

impl<T, M> PositionBasedDelete<M> for T
where
    T: Database<M, PositionKey = <M as Identifiable>::Id>,
    M: Dispatchable,
{
    fn delete(&mut self, id: <M as Identifiable>::Id) -> Option<M> {
        self.delete_pos(id)
    }
}