pgqrs 0.15.2

A high-performance PostgreSQL-backed job queue for Rust applications
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
//! Builder for dequeue operations with worker selection and visibility timeouts.

use crate::error::{Error, Result};
use crate::store::Store;
use crate::types::QueueMessage;
use crate::workers::Consumer;
use std::future::Future;
use std::time::Duration as StdDuration;
use tokio::time::{interval_at, Instant, MissedTickBehavior};

struct Poller {
    consumer: Consumer,
    batch_size: usize,
    vt_offset_seconds: Option<u32>,
    at: Option<chrono::DateTime<chrono::Utc>>,
    poll_interval: Option<StdDuration>,
}

impl Poller {
    async fn check_terminal_status(&self) -> Result<()> {
        match self.consumer.status().await? {
            crate::types::WorkerStatus::Interrupted => {
                self.consumer.suspend().await?;
                Err(Error::Suspended {
                    reason: "worker interrupted".to_string(),
                })
            }
            crate::types::WorkerStatus::Suspended => Err(Error::Suspended {
                reason: "worker suspended".to_string(),
            }),
            _ => Ok(()),
        }
    }

    async fn dequeue_n(&self, batch_size: usize) -> Result<Vec<QueueMessage>> {
        self.check_terminal_status().await?;

        if let Some(at) = self.at {
            let vt = self.vt_offset_seconds.unwrap_or(5);
            self.consumer.dequeue_at(batch_size, vt, at).await
        } else if let Some(vt_offset) = self.vt_offset_seconds {
            self.consumer
                .dequeue_many_with_delay(batch_size, vt_offset)
                .await
        } else {
            self.consumer.dequeue_many(batch_size).await
        }
    }

    async fn fetch_one(&self) -> Result<Option<QueueMessage>> {
        let mut msgs = self.dequeue_n(1).await?;
        Ok(msgs.pop())
    }

    async fn fetch_all(&self) -> Result<Vec<QueueMessage>> {
        self.dequeue_n(self.batch_size).await
    }

    async fn poll_messages(&mut self) -> Result<Vec<QueueMessage>> {
        if self.batch_size == 0 {
            return Err(Error::ValidationFailed {
                reason: "batch size must be >= 1 for poll".to_string(),
            });
        }

        // Consumer-only states: Ready -> Polling
        if let Err(e) = self.consumer.poll().await {
            if matches!(
                &e,
                Error::InvalidStateTransition { from, to, .. }
                    if (from == "interrupted" || from == "suspended") && to == "polling"
            ) {
                self.check_terminal_status().await?;
            }
            return Err(e);
        }

        let config = self.consumer.store().config();

        let poll_interval = self
            .poll_interval
            .unwrap_or_else(|| StdDuration::from_millis(config.poll_interval_ms));
        let heartbeat_interval = StdDuration::from_secs(config.heartbeat_interval);

        let now = Instant::now();
        let mut poll_interval = interval_at(now + poll_interval, poll_interval);
        poll_interval.set_missed_tick_behavior(MissedTickBehavior::Skip);
        let mut heartbeat_interval = interval_at(now + heartbeat_interval, heartbeat_interval);
        heartbeat_interval.set_missed_tick_behavior(MissedTickBehavior::Skip);

        loop {
            let messages = self.fetch_all().await?;
            if !messages.is_empty() {
                return Ok(messages);
            }

            tokio::select! {
                _ = poll_interval.tick() => {
                    self.check_terminal_status().await?;
                }
                _ = heartbeat_interval.tick() => {
                    // Heartbeat implies liveness checks too.
                    self.consumer.heartbeat().await?;
                    self.check_terminal_status().await?;
                }
            }
        }
    }

    async fn handle_one<F, Fut>(&mut self, handler: F) -> Result<()>
    where
        F: Fn(QueueMessage) -> Fut + Send + Sync,
        Fut: Future<Output = Result<()>> + Send,
    {
        let mut messages = self.poll_messages().await?;
        let msg = messages
            .pop()
            .expect("poll_messages returns at least one message");
        let msg_id = msg.id;

        match handler(msg).await {
            Ok(_) => {
                self.consumer.archive(msg_id).await?;
                Ok(())
            }
            Err(e) => {
                #[cfg(any(test, feature = "test-utils"))]
                if matches!(e, crate::error::Error::TestCrash) {
                    return Err(e);
                }
                self.consumer.release_messages(&[msg_id]).await?;
                Err(e)
            }
        }
    }

    async fn execute_one<F, Fut>(&self, handler: F) -> Result<()>
    where
        F: Fn(QueueMessage) -> Fut + Send + Sync,
        Fut: Future<Output = Result<()>> + Send,
    {
        if let Some(msg) = self.fetch_one().await? {
            let msg_id = msg.id;

            match handler(msg).await {
                Ok(_) => {
                    self.consumer.archive(msg_id).await?;
                }
                Err(e) => {
                    #[cfg(any(test, feature = "test-utils"))]
                    if matches!(e, crate::error::Error::TestCrash) {
                        return Err(e);
                    }
                    self.consumer.release_messages(&[msg_id]).await?;
                    return Err(e);
                }
            }
        }
        Ok(())
    }

    async fn handle_batch<F, Fut>(&mut self, handler: F) -> Result<()>
    where
        F: Fn(Vec<QueueMessage>) -> Fut + Send + Sync,
        Fut: Future<Output = Result<()>> + Send,
    {
        let messages = self.poll_messages().await?;
        let msg_ids: Vec<i64> = messages.iter().map(|m| m.id).collect();

        match handler(messages).await {
            Ok(_) => {
                self.consumer.archive_many(msg_ids).await?;
                Ok(())
            }
            Err(e) => {
                self.consumer.release_messages(&msg_ids).await?;
                Err(e)
            }
        }
    }

    async fn execute_batch<F, Fut>(&self, handler: F) -> Result<()>
    where
        F: Fn(Vec<QueueMessage>) -> Fut + Send + Sync,
        Fut: Future<Output = Result<()>> + Send,
    {
        let messages = self.fetch_all().await?;
        if !messages.is_empty() {
            let msg_ids: Vec<i64> = messages.iter().map(|m| m.id).collect();

            match handler(messages).await {
                Ok(_) => {
                    self.consumer.archive_many(msg_ids).await?;
                }
                Err(e) => {
                    self.consumer.release_messages(&msg_ids).await?;
                    return Err(e);
                }
            }
        }
        Ok(())
    }

    async fn run_forever_one<F, Fut>(&mut self, handler: F) -> Result<()>
    where
        F: Fn(QueueMessage) -> Fut + Send + Sync + Clone,
        Fut: Future<Output = Result<()>> + Send,
    {
        loop {
            self.handle_one(handler.clone()).await?;
        }
    }

    async fn run_forever_batch<F, Fut>(&mut self, handler: F) -> Result<()>
    where
        F: Fn(Vec<QueueMessage>) -> Fut + Send + Sync + Clone,
        Fut: Future<Output = Result<()>> + Send,
    {
        loop {
            self.handle_batch(handler.clone()).await?;
        }
    }
}

/// Start a dequeue operation.
///
/// ```rust,no_run
/// # use pgqrs;
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let store = pgqrs::connect("postgresql://localhost/mydb").await?;
/// let messages = pgqrs::dequeue()
///     .from("tasks")
///     .batch(5)
///     .fetch_all(&store)
///     .await?;
/// # Ok(()) }
/// ```
pub fn dequeue() -> DequeueBuilder<'static> {
    DequeueBuilder::new()
}

/// Builder for dequeue operations with advanced options.
///
/// Supports:
/// - Ephemeral workers via `.from(queue)`.
/// - Managed workers via `.worker(&consumer)`.
/// - Visibility timeout tweaks via `.with_vt()`.
pub struct DequeueBuilder<'a> {
    queue: Option<String>,
    batch_size: usize,
    worker: Option<&'a Consumer>,
    vt_offset_seconds: Option<u32>,
    at: Option<chrono::DateTime<chrono::Utc>>,
    poll_interval: Option<StdDuration>,
}

impl<'a> Default for DequeueBuilder<'a> {
    fn default() -> Self {
        Self::new()
    }
}

impl<'a> DequeueBuilder<'a> {
    pub fn new() -> Self {
        Self {
            queue: None,
            batch_size: 1,
            worker: None,
            vt_offset_seconds: None,
            at: None,
            poll_interval: None,
        }
    }

    /// Specify queue (ephemeral worker mode).
    pub fn from(mut self, queue: &str) -> Self {
        self.queue = Some(queue.to_string());
        self
    }

    /// Set the batch size for dequeue.
    pub fn batch(mut self, size: usize) -> Self {
        self.batch_size = size;
        self
    }

    /// Use a managed consumer instead of an ephemeral one.
    pub fn worker(mut self, consumer: &'a Consumer) -> Self {
        self.worker = Some(consumer);
        self
    }

    /// Set visibility timeout using Duration (more ergonomic than seconds).
    pub fn with_vt(mut self, duration: std::time::Duration) -> Self {
        self.vt_offset_seconds = Some(duration.as_secs().min(u32::MAX as u64) as u32);
        self
    }

    /// Set the poll interval for long-lived polling loops.
    pub fn poll_interval(mut self, interval: StdDuration) -> Self {
        self.poll_interval = Some(interval);
        self
    }

    /// Set a custom reference time for the dequeue operation (useful for testing delays)
    pub fn at(mut self, time: chrono::DateTime<chrono::Utc>) -> Self {
        self.at = Some(time);
        self
    }

    /// Fetch one message (if available).
    pub async fn fetch_one<S: Store>(self, store: &S) -> Result<Option<QueueMessage>> {
        self.into_poller(store).await?.fetch_one().await
    }

    /// Fetch all messages (up to batch size).
    pub async fn fetch_all<S: Store>(self, store: &S) -> Result<Vec<QueueMessage>> {
        self.into_poller(store).await?.fetch_all().await
    }

    /// Poll until at least one message is available or interrupted.
    pub async fn poll<S>(self, store: &S) -> Result<Vec<QueueMessage>>
    where
        S: Store,
    {
        let mut poller = self.into_poller(store).await?;
        poller.poll_messages().await
    }

    // (polling implementation is in Poller)

    /// Set a handler for single-message processing.
    pub fn handle<F, Fut>(self, handler: F) -> DequeueHandlerBuilder<'a, F>
    where
        F: Fn(QueueMessage) -> Fut + Send + Sync + Clone + 'static,
        Fut: Future<Output = Result<()>> + Send,
    {
        DequeueHandlerBuilder {
            base: self,
            handler,
        }
    }

    /// Set handler for batch-message processing.
    /// Returns a DequeueBatchHandlerBuilder for execution.
    pub fn handle_batch<F, Fut>(self, handler: F) -> DequeueBatchHandlerBuilder<'a, F>
    where
        F: Fn(Vec<QueueMessage>) -> Fut + Send + Sync + Clone + 'static,
        Fut: Future<Output = Result<()>> + Send,
    {
        DequeueBatchHandlerBuilder {
            base: self,
            handler,
        }
    }

    /// Helper to resolve consumer (managed or ephemeral)
    async fn resolve_consumer<S: Store>(&self, store: &S) -> Result<Consumer> {
        if let Some(consumer) = self.worker {
            return Ok(consumer.clone());
        }

        let queue = self
            .queue
            .as_ref()
            .ok_or_else(|| crate::error::Error::ValidationFailed {
                reason: "Queue name is required. Use .from(\"queue-name\") or .worker(&consumer)"
                    .to_string(),
            })?;

        store.consumer_ephemeral(queue, store.config()).await
    }

    async fn into_poller<S: Store>(self, store: &S) -> Result<Poller> {
        let consumer = self.resolve_consumer(store).await?;
        Ok(Poller {
            consumer,
            batch_size: self.batch_size,
            vt_offset_seconds: self.vt_offset_seconds,
            at: self.at,
            poll_interval: self.poll_interval,
        })
    }
}

/// Builder for operations with a single-message handler.
pub struct DequeueHandlerBuilder<'a, F> {
    base: DequeueBuilder<'a>,
    handler: F,
}

impl<'a, F, Fut> DequeueHandlerBuilder<'a, F>
where
    F: Fn(QueueMessage) -> Fut + Send + Sync + Clone + 'static,
    Fut: Future<Output = Result<()>> + Send,
{
    fn validate_batch_size(&self) -> Result<()> {
        if self.base.batch_size != 1 {
            return Err(Error::ValidationFailed {
                reason: format!(
                    "single-message handlers require batch size = 1, got {}",
                    self.base.batch_size
                ),
            });
        }
        Ok(())
    }

    /// Execute the dequeue and handle operation.
    pub async fn execute<S: Store>(self, store: &S) -> Result<()> {
        self.validate_batch_size()?;
        self.base
            .into_poller(store)
            .await?
            .execute_one(self.handler)
            .await
    }

    /// Poll until a message is available or interrupted, then handle it.
    pub async fn poll<S>(self, store: &S) -> Result<()>
    where
        S: Store,
    {
        self.validate_batch_size()?;
        let mut poller = self.base.into_poller(store).await?;
        poller.run_forever_one(self.handler).await
    }
}

/// Builder for operations with a batch-message handler.
pub struct DequeueBatchHandlerBuilder<'a, F> {
    base: DequeueBuilder<'a>,
    handler: F,
}

impl<'a, F, Fut> DequeueBatchHandlerBuilder<'a, F>
where
    F: Fn(Vec<QueueMessage>) -> Fut + Send + Sync + Clone + 'static,
    Fut: Future<Output = Result<()>> + Send,
{
    /// Execute the dequeue and batch handle operation.
    pub async fn execute<S: Store>(self, store: &S) -> Result<()> {
        self.base
            .into_poller(store)
            .await?
            .execute_batch(self.handler)
            .await
    }

    /// Poll until at least one message is available or interrupted, then handle them.
    pub async fn poll<S>(self, store: &S) -> Result<()>
    where
        S: Store,
    {
        let mut poller = self.base.into_poller(store).await?;
        poller.run_forever_batch(self.handler).await
    }
}