broccoli_queue 0.4.6

Broccoli is a simple, fast, and reliable job queue for Rust.
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
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
use std::sync::RwLock;

use redis::AsyncCommands;

use crate::{
    brokers::broker::{Broker, BrokerConfig, InternalBrokerMessage, MetadataTypes},
    error::BroccoliError,
    queue::{ConsumeOptions, PublishOptions},
};

use super::utils::OptionalInternalBrokerMessage;

pub(crate) type RedisPool = bb8_redis::bb8::Pool<bb8_redis::RedisConnectionManager>;

#[derive(Default)]
/// A message broker implementation for Redis.
pub struct RedisBroker {
    pub(crate) redis_pool: Option<RwLock<RedisPool>>,
    pub(crate) broker_url: String,
    pub(crate) config: Option<BrokerConfig>,
}

/// Implementation of the `Broker` trait for `RedisBroker`.
#[async_trait::async_trait]
impl Broker for RedisBroker {
    /// Connects to the Redis broker using the provided URL.
    ///
    /// # Arguments
    /// * `broker_url` - The URL of the Redis broker.
    ///
    /// # Returns
    /// A `Result` indicating success or failure.
    async fn connect(&mut self, broker_url: &str) -> Result<(), BroccoliError> {
        let redis_manager = bb8_redis::RedisConnectionManager::new(broker_url)
            .map_err(|e| BroccoliError::Broker(format!("Failed to create redis manager: {e:?}")))?;

        let redis_pool = bb8_redis::bb8::Pool::builder()
            .max_size(
                self.config
                    .as_ref()
                    .map_or(10, |config| config.pool_connections.unwrap_or(10))
                    .into(),
            )
            .connection_timeout(std::time::Duration::from_secs(2))
            .build(redis_manager)
            .await
            .map_err(|e| BroccoliError::Broker(format!("Failed to create redis pool: {e:?}")))?;

        self.redis_pool = Some(RwLock::new(redis_pool));
        self.broker_url = broker_url.to_string();
        Ok(())
    }

    /// Publishes a message to the specified queue.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    /// * `message` - The message to be published.
    ///
    /// # Returns
    /// A `Result` indicating success or failure.
    async fn publish(
        &self,
        queue_name: &str,
        disambiguator: Option<String>,
        messages: &[InternalBrokerMessage],
        publish_options: Option<PublishOptions>,
    ) -> Result<Vec<InternalBrokerMessage>, BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;

        for msg in messages {
            let attempts = msg.attempts.to_string();

            let priority = i64::from(
                publish_options
                    .clone()
                    .unwrap_or_default()
                    .priority
                    .unwrap_or(5),
            );

            if !(1..=5).contains(&priority) {
                return Err(BroccoliError::Broker(
                    "Priority must be between 1 and 5".to_string(),
                ));
            }

            let priority_str = priority.to_string();
            let mut items: Vec<(&str, &str)> = vec![
                ("task_id", &msg.task_id),
                ("payload", &msg.payload),
                ("attempts", &attempts),
                ("priority", &priority_str),
            ];

            if let Some(ref disambiguator) = disambiguator {
                items.push(("disambiguator", disambiguator));
            }

            let mut score = time::OffsetDateTime::now_utc().unix_timestamp_nanos() as i64;

            redis_connection
                .hset_multiple::<&str, &str, &str, String>(&msg.task_id.to_string(), &items)
                .await?;

            if let Some(ref publish_options) = publish_options {
                if let Some(delay) = publish_options.delay {
                    if self
                        .config
                        .as_ref()
                        .is_some_and(|c| c.enable_scheduling.unwrap_or(false))
                    {
                        score += (delay.as_seconds_f32() * 1_000_000_000.0) as i64;
                    }
                }

                if let Some(timestamp) = publish_options.scheduled_at {
                    if self
                        .config
                        .as_ref()
                        .is_some_and(|c| c.enable_scheduling.unwrap_or(false))
                    {
                        score = timestamp.unix_timestamp_nanos() as i64;
                    }
                }

                if let Some(ttl) = publish_options.ttl {
                    redis_connection
                        .pexpire::<&str, String>(
                            &msg.task_id.to_string(),
                            (ttl.as_seconds_f64() * 1000.0) as i64,
                        )
                        .await?;
                }
            }

            let script = redis::Script::new(
                r#"
                local base_queue_name = KEYS[1]
                local task_id = ARGV[1]
                local score = tonumber(ARGV[2])
                local priority = tonumber(ARGV[3])
                local disambiguator = ARGV[4]

                local queue_name = base_queue_name
                if disambiguator ~= '' then
                    queue_name = string.format("%s_%s_queue", base_queue_name, disambiguator)
                end

                redis.call('ZADD', queue_name, priority * score, task_id)

                if disambiguator ~= '' then
                    local fairness_set = string.format("%s_fairness_set", base_queue_name)
                    local fairness_round_robin = string.format("%s_fairness_round_robin", base_queue_name)
                    local exists_in_tracking_set = redis.call('SISMEMBER', fairness_set, disambiguator)

                    if exists_in_tracking_set == 0 then
                        redis.call('SADD', fairness_set, disambiguator)
                        redis.call('RPUSH', fairness_round_robin, disambiguator)
                    end
                end
            "#,
            );

            let disambiguator_str = disambiguator.clone().unwrap_or_default();

            script
                .key(queue_name)
                .arg(&msg.task_id)
                .arg(score)
                .arg(priority)
                .arg(&disambiguator_str)
                .invoke_async::<()>(&mut redis_connection)
                .await?;
        }

        Ok(messages.to_vec())
    }

    /// Attempts to consume a message from the specified queue. Will not block if no message is available.
    /// This will check for scheduled messages first and then attempt to consume a message from the queue.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    ///
    /// # Returns
    /// A `Result` containing an `Some(String)` with the message if available or `None`
    /// if no message is avaiable, and a `BroccoliError` on failure.
    async fn try_consume(
        &self,
        queue_name: &str,
        options: Option<ConsumeOptions>,
    ) -> Result<Option<InternalBrokerMessage>, BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;
        let mut payload: OptionalInternalBrokerMessage = OptionalInternalBrokerMessage(None);

        while payload.0.is_none() {
            let task_id: Option<String> = self
                .get_task_id(queue_name, &mut redis_connection, options.clone())
                .await?;

            if task_id.is_none() {
                break;
            }

            payload = redis_connection
                .hgetall(&task_id)
                .await
                .map_err(|e| BroccoliError::Consume(format!("Failed to consume message: {e:?}")))?;
        }

        Ok(payload.0)
    }

    /// Consumes a message from the specified queue, blocking until a message is available.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    ///
    /// # Returns
    /// A `Result` containing the message as a `String`, or a `BroccoliError` on failure.
    async fn consume(
        &self,
        queue_name: &str,
        options: Option<ConsumeOptions>,
    ) -> Result<InternalBrokerMessage, BroccoliError> {
        self.ensure_pool()?;
        let mut message: Option<InternalBrokerMessage> = None;
        let sleep = options
            .clone()
            .unwrap_or_default()
            .consume_wait
            .unwrap_or(std::time::Duration::from_millis(500));

        while message.is_none() {
            message = self.try_consume(queue_name, options.clone()).await?;
            if message.is_none() {
                tokio::time::sleep(sleep).await;
            }
        }

        let message = message.ok_or_else(|| {
            BroccoliError::Consume("Failed to consume message: No message available".to_string())
        })?;

        Ok(message)
    }

    /// Acknowledges the processing of a message, removing it from the processing queue.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    /// * `message` - The message to be acknowledged.
    ///
    /// # Returns
    /// A `Result` indicating success or failure.
    async fn acknowledge(
        &self,
        queue_name: &str,
        message: InternalBrokerMessage,
    ) -> Result<(), BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;

        let processing_queue_name = message.disambiguator.as_ref().map_or_else(
            || format!("{queue_name}_processing"),
            |disambiguator| format!("{queue_name}_{disambiguator}_processing"),
        );

        redis_connection
            .lrem::<String, &str, String>(processing_queue_name, 1, &message.task_id)
            .await?;

        redis_connection
            .del::<&str, String>(&message.task_id)
            .await?;

        Ok(())
    }

    /// Rejects a message, re-queuing it or moving it to a failed queue if the retry limit is reached.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    /// * `message` - The message to be rejected.
    ///
    /// # Returns
    /// A `Result` indicating success or failure.
    async fn reject(
        &self,
        queue_name: &str,
        message: InternalBrokerMessage,
    ) -> Result<(), BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;

        let attempts = message.attempts + 1;

        let processing_queue_name = message.disambiguator.as_ref().map_or_else(
            || format!("{queue_name}_processing"),
            |disambiguator| format!("{queue_name}_{disambiguator}_processing"),
        );

        redis_connection
            .lrem::<String, &str, String>(processing_queue_name, 1, &message.task_id)
            .await?;

        if (attempts
            >= self
                .config
                .as_ref()
                .map_or(3, |config| config.retry_attempts.unwrap_or(3)))
            || !self
                .config
                .as_ref()
                .map_or(true, |config| config.retry_failed.unwrap_or(true))
        {
            let failed_queue_name = message.disambiguator.as_ref().map_or_else(
                || format!("{queue_name}_failed"),
                |disambiguator| format!("{queue_name}_{disambiguator}_failed"),
            );

            redis_connection
                .lpush::<String, &str, String>(failed_queue_name, &message.task_id)
                .await?;

            log::error!(
                "Message {} has reached max attempts and has been pushed to failed queue",
                message.task_id
            );

            return Ok(());
        }

        if self
            .config
            .as_ref()
            .map_or(true, |config| config.retry_failed.unwrap_or(true))
        {
            let priority = message
                .metadata
                .as_ref()
                .and_then(|m| m.get("priority"))
                .and_then(|v| match v {
                    MetadataTypes::String(priority) => Some(priority),
                    MetadataTypes::U64(_) => None,
                })
                .ok_or_else(|| BroccoliError::Acknowledge("Missing priority".to_string()))?
                .parse::<u8>()
                .map_err(|e| {
                    BroccoliError::Acknowledge(format!("Failed to parse priority: {e}"))
                })?;

            self.publish(
                queue_name,
                message.disambiguator.clone(),
                &[message.clone()],
                Some(PublishOptions {
                    priority: Some(priority),
                    ..Default::default()
                }),
            )
            .await?;

            redis_connection
                .hincr::<&str, &str, u8, String>(&message.task_id, "attempts", 1)
                .await?;
        }

        Ok(())
    }

    /// Cancels a message, removing it from the queue.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    /// * `message_id` - The ID of the message to be canceled.
    ///
    /// # Returns
    /// A `Result` indicating success or failure.
    async fn cancel(&self, queue_name: &str, message_id: String) -> Result<(), BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;

        redis_connection
            .zrem::<&str, &str, String>(queue_name, &message_id)
            .await?;

        redis_connection.del::<&str, String>(&message_id).await?;

        Ok(())
    }

    /// Returns the size of the queue(s).
    ///
    /// For fairness queues, returns a map with each disambiguator queue and its size.
    /// For unfair queues, returns a map with just the main queue name and its size.
    ///
    /// # Arguments
    /// * `queue_name` - The name of the queue.
    ///
    /// # Returns
    /// A `Result` containing a `HashMap<String, u64>` mapping queue names to their sizes.
    async fn size(&self, queue_name: &str) -> Result<std::collections::HashMap<String, u64>, BroccoliError> {
        let mut redis_connection = self.get_redis_connection().await?;
        let mut sizes = std::collections::HashMap::new();

        let fairness_set_name = format!("{queue_name}_fairness_set");

        // Check if fairness set exists and has members
        let disambiguators: Vec<String> = redis_connection
            .smembers(&fairness_set_name)
            .await
            .unwrap_or_default();

        if disambiguators.is_empty() {
            // Unfair queue - just check the main queue
            let size: u64 = redis_connection
                .zcard(queue_name)
                .await
                .map_err(|e| BroccoliError::Broker(format!("Failed to get queue size: {e:?}")))?;
            sizes.insert(queue_name.to_string(), size);
        } else {
            // Fairness queue - check each disambiguator queue
            for disambiguator in disambiguators {
                let sub_queue_name = format!("{queue_name}_{disambiguator}_queue");
                let size: u64 = redis_connection
                    .zcard(&sub_queue_name)
                    .await
                    .map_err(|e| {
                        BroccoliError::Broker(format!(
                            "Failed to get queue size for {sub_queue_name}: {e:?}"
                        ))
                    })?;
                sizes.insert(sub_queue_name, size);
            }
        }

        Ok(sizes)
    }
}