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
// Authors: Robert Lopez
// License: MIT (See `LICENSE.md`)

pub use lapin;
mod test;

use lapin::{
    options::{
        BasicAckOptions, BasicGetOptions, BasicNackOptions, BasicPublishOptions,
        BasicRecoverAsyncOptions, ExchangeDeclareOptions, QueueBindOptions, QueueDeclareOptions,
        QueueDeleteOptions, QueuePurgeOptions,
    },
    types::{FieldTable, MessageCount},
    BasicProperties, Channel, Connection, ConnectionProperties, Error, ExchangeKind,
};
use std::collections::HashMap;

/// Result for getting a single message from a `Queue`
pub struct GetMessageResult {
    pub message: Vec<u8>,
    pub delivery_tag: u64,
}

/// Represents a single `Queue`
#[derive(Clone)]
pub struct Queue {
    pub name: String,
    pub channel: Channel,
    pub exchange: String,
    pub routing_key: String,
}

impl Queue {
    /// Construct a `Queue`
    ///
    /// Exchange is: `"{name}_exchange"`
    ///
    /// Routing key is: `"{name}_routing_key"`
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let channel: Channel = ...;
    ///
    /// let queue = Queue::new(
    ///     "my_queue",
    ///     channel,
    ///     None,
    ///     None,
    /// ).await?;
    /// ```
    pub async fn new(
        name: &str,
        channel: Channel,
        options: Option<QueueDeclareOptions>,
        arguments: Option<FieldTable>,
    ) -> Result<Self, Error> {
        channel
            .queue_declare(
                name,
                options.unwrap_or_default(),
                arguments.unwrap_or_default(),
            )
            .await?;

        let exchange = format!("{}_exchange", name);
        let routing_key = format!("{}_routing_key", name);

        channel
            .exchange_declare(
                &exchange,
                ExchangeKind::Direct,
                ExchangeDeclareOptions {
                    durable: true,
                    ..Default::default()
                },
                FieldTable::default(),
            )
            .await?;

        channel
            .queue_bind(
                name,
                &exchange,
                &routing_key,
                QueueBindOptions::default(),
                FieldTable::default(),
            )
            .await?;

        Ok(Self {
            name: name.to_string(),
            channel,
            exchange,
            routing_key,
        })
    }

    /// Purge the `Queue`, returns the amount of
    /// messages deleted.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// let deleted_count: MessageCount = queue.purge(false).await?;
    /// ```
    pub async fn purge(&self, no_wait: bool) -> Result<MessageCount, Error> {
        self.channel
            .queue_purge(&self.name, QueuePurgeOptions { nowait: no_wait })
            .await
    }

    /// Recover the `Queue`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// queue.recover(false).await?;
    /// ```
    pub async fn recover(&self, requeue: bool) -> Result<(), Error> {
        self.channel
            .basic_recover_async(BasicRecoverAsyncOptions { requeue })
            .await
    }

    /// Delete the `Queue`, returns the amount of
    /// messages deleted.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// let deleted_count: MessageCount = queue.purge(None).await?;
    /// ```
    pub async fn delete(&self, options: Option<QueueDeleteOptions>) -> Result<MessageCount, Error> {
        self.channel
            .queue_delete(&self.name, options.unwrap_or_default())
            .await
    }

    /// Publish a `message` to the `Queue`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// let message = b"1337".to_vec();
    ///
    /// queue.publish_message(message, None).await?;
    /// ```
    pub async fn publish_message(
        &self,
        message: Vec<u8>,
        properties: Option<BasicProperties>,
    ) -> Result<(), Error> {
        self.channel
            .basic_publish(
                &self.exchange,
                &self.routing_key,
                BasicPublishOptions {
                    mandatory: false,
                    immediate: false,
                },
                &message,
                properties.unwrap_or_default(),
            )
            .await?
            .await?;

        Ok(())
    }

    /// Get a single message from the `Queue`.
    ///
    /// Returns `None` if there was no messages.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// while let Some(
    ///     GetMessageResult {
    ///        message,
    ///        delivery_tag,
    ///     }
    /// ) = queue.get_message.await? {
    ///     ...
    /// }
    /// ```
    pub async fn get_message(&self) -> Result<Option<GetMessageResult>, Error> {
        if let Some(delivery) = self
            .channel
            .basic_get(&self.name, BasicGetOptions { no_ack: false })
            .await?
        {
            return Ok(Some(GetMessageResult {
                message: delivery.data.to_vec(),
                delivery_tag: delivery.delivery_tag,
            }));
        }

        Ok(None)
    }

    /// Acknowledge a gotten message.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// while let Some(
    ///     GetMessageResult {
    ///        message,
    ///        delivery_tag,
    ///     }
    /// ) = queue.get_message.await? {
    ///     queue.acknowledge_message(delivery_tag).await?;
    /// }
    /// ```
    pub async fn acknowledge_message(&self, delivery_tag: u64) -> Result<(), Error> {
        self.channel
            .basic_ack(delivery_tag, BasicAckOptions { multiple: false })
            .await
    }

    /// No Acknowledge a gotten message.
    ///
    /// Add `requeue` to `true`, to requeue
    /// the message.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let queue: Queue = ...;
    ///
    /// while let Some(
    ///     GetMessageResult {
    ///        message,
    ///        delivery_tag,
    ///     }
    /// ) = queue.get_message.await? {
    ///     ... Some issue processing the message
    ///
    ///     queue.no_acknowledge_message(true, delivery_tag).await?;
    /// }
    /// ```
    pub async fn no_acknowledge_message(
        &self,
        requeue: bool,
        delivery_tag: u64,
    ) -> Result<(), Error> {
        self.channel
            .basic_nack(
                delivery_tag,
                BasicNackOptions {
                    requeue,
                    multiple: false,
                },
            )
            .await
    }
}

/// Simplified RabbitMQ client
///
/// ---
/// Example Usage:
/// ```
///
/// let mut rabbit_mq = RabbitMQ::new("amqp://guest:guest@localhost:5672/%2f", None).await?;
///
/// rabbit_mq.register_queue("test_queue", None, None).await?;
///
/// rabbit_mq.publish_message("test_queue", b"1337".to_vec(), None).await?;
///
/// if let Some(test_queue) = rabbit_mq.get_queue("test_queue") {
///    while let Some(GetMessageResult {
///         message,
///        delivery_tag,
///     }) = test_queue.get_message().await? {
///     ...
/// }
/// ```
pub struct RabbitMQ {
    pub queues: HashMap<String, Queue>,
    pub connection: Connection,
}

impl RabbitMQ {
    /// Construct the `RabbitMQ` client.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let rabbit_mq = RabbitMQ::new("amqp://guest:guest@localhost:5672/", None).await?;
    /// ```
    pub async fn new(uri: &str, options: Option<ConnectionProperties>) -> Result<Self, Error> {
        let connection = Connection::connect(uri, options.unwrap_or_default()).await?;

        Ok(Self {
            queues: HashMap::new(),
            connection,
        })
    }

    /// Register a `Queue`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut rabbit_mq = ...;
    ///
    /// rabbit_mq.register_queue("my_queue", None, None).await?;
    /// ```
    pub async fn register_queue(
        &mut self,
        queue_name: &str,
        options: Option<QueueDeclareOptions>,
        arguments: Option<FieldTable>,
    ) -> Result<(), Error> {
        let channel = self.connection.create_channel().await?;

        let queue = Queue::new(queue_name, channel, options, arguments).await?;

        self.queues.insert(queue_name.to_string(), queue);

        Ok(())
    }

    /// Get a `&Queue`.
    ///
    /// Returns `None` if the `Queue` was not found.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut rabbit_mq = ...;
    ///
    /// let queue: Option<&Queue> = rabbit_mq.get_queue("my_queue").await?;
    /// ```
    pub fn get_queue(&self, queue_name: &str) -> Option<&Queue> {
        if let Some(queue) = self.queues.get(queue_name) {
            return Some(queue);
        }

        None
    }

    /// Publish a message to a `Queue`.
    ///
    /// Returns `None` if the `Queue` was not found.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut rabbit_mq = ...;
    ///
    /// let message = b"1337".to_vec();
    ///
    /// rabbit_mq.publish_message(
    ///     "my_queue",
    ///     &message,
    ///     None
    /// ).await?;
    /// ```
    pub async fn publish_message(
        &self,
        queue_name: &str,
        message: Vec<u8>,
        properties: Option<BasicProperties>,
    ) -> Result<Option<()>, Error> {
        if let Some(queue) = self.queues.get(queue_name) {
            queue.publish_message(message, properties).await?;

            return Ok(Some(()));
        }

        Ok(None)
    }

    /// Publish a batch messages to a `Queue`, unchecked.
    ///
    /// Meaning, does not handle errors, just attempts
    /// to post all messages in the list to the `Queue`.
    ///
    /// Returns `None` if the `Queue` was not found.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut rabbit_mq = ...;
    ///
    /// let messages = vec![
    ///     ...
    /// ];
    ///
    /// rabbit_mq.publish_messages_unchecked(
    ///     "my_queue",
    ///     messages,
    ///     None
    /// ).await;
    /// ```
    pub async fn publish_messages_unchecked(
        &self,
        queue_name: &str,
        messages: Vec<Vec<u8>>,
        properties: Option<BasicProperties>,
    ) -> Option<()> {
        if let Some(queue) = self.queues.get(queue_name) {
            for message in messages {
                let _ = queue.publish_message(message, properties.clone()).await;
            }

            return Some(());
        }

        None
    }
}