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
use crate::error::Result;
use crate::{Job, SchemaConfig};
use chrono::{DateTime, Utc};
use postgres::{self, transaction::Transaction, GenericConnection};
use serde::Serialize;
use serde_json::value;

/// Represents a job queue stored in the database. Because the queue is stored
/// in the database, the queue should be considered to have internal mutability
///
/// # Examples
///
/// ```no_run
/// use dbq::{Queue, SchemaConfig};
/// use postgres::{Connection, TlsMode};
/// use serde_json::value::Value;
///
/// let q = Queue::new(SchemaConfig::default(), "de_lancie_q".to_string());
///
/// let conn = Connection::connect("postgres://user@localhost".to_string(), TlsMode::None)
///     .unwrap();
/// q.enqueue("send_email", Value::String("example@example.com".to_string()), 3, &conn);
/// q.enqueue("send_sms", Value::String("+1-555-555-5555".to_string()), 3, &conn);
/// ```
#[derive(Clone, Debug)]
pub struct Queue {
    schema_config: SchemaConfig,
    name: String,
}

impl Queue {
    #[inline]
    pub fn new(schema_config: SchemaConfig, name: String) -> Queue {
        Queue {
            schema_config,
            name,
        }
    }

    /// Add a new job to the queue
    pub fn enqueue<A: Serialize, C: GenericConnection>(
        &self,
        class: &str,
        args: A,
        max_attempts: u32,
        conn: &C,
    ) -> Result<u64> {
        let args_json = value::to_value(args)?;
        let rows = conn.query(
            &format!(
                "insert into {} (class, args, queue, max_attempts)
                values ($1, $2, $3, $4) returning id",
                self.schema_config.queue_table()
            ),
            &[&class, &args_json, &self.name, &(max_attempts as i32)],
        )?;
        let id: i64 = rows.get(0).get(0);
        Ok(id as u64)
    }

    /// Claim a job so that it can be run
    pub(crate) fn reserve(&self, tx: &Transaction) -> Result<Option<Job>> {
        let query = &format!(
            r#"select
                id, queue, args, class, max_attempts, created_at, run_next_at,
                last_failed_at, last_error, error_count
            from {}
            where queue = $1 and run_next_at < now()
            order by id
            limit 1
            for update skip locked"#,
            self.schema_config.queue_table()
        );
        let rows = tx.query(query, &[&self.name])?;
        if rows.is_empty() {
            return Ok(None);
        }
        let row = rows.get(0);
        let id: i64 = row.get(0);
        let max_attempts: i32 = row.get(4);
        let error_count: i32 = row.get(9);
        Ok(Some(Job {
            id: id as u64,
            queue: row.get(1),
            args: row.get(2),
            class: row.get(3),
            max_attempts: max_attempts as u32,
            created_at: row.get(5),
            run_next_at: row.get(6),
            last_failed_at: row.get(7),
            last_error: row.get(8),
            error_count: error_count as u32,
        }))
    }

    /// Complete a job successfully
    pub(crate) fn complete<C: GenericConnection>(
        &self,
        job: &Job,
        conn: &C,
    ) -> Result<bool> {
        let id = job.id as i64;
        let res = conn.execute(
            &format!(
                "delete from {} where id = $1 and queue = $2",
                self.schema_config.queue_table()
            ),
            &[&id, &self.name],
        )?;
        Ok(res > 0)
    }

    /// Record the failed run attempt
    pub(crate) fn mark_error<C: GenericConnection>(
        &self,
        job: &Job,
        err_msg: &str,
        run_next_at: DateTime<Utc>,
        conn: &C,
    ) -> Result<bool> {
        let id = job.id as i64;
        let error_count = (job.error_count + 1) as i32;
        let res = conn.execute(
            &format!(
                r#"update {}
                set
                    last_failed_at = now(),
                    last_error = $3,
                    error_count = $4,
                    run_next_at = $5
                where id = $1 and queue = $2"#,
                self.schema_config.queue_table()
            ),
            &[&id, &self.name, &err_msg, &error_count, &run_next_at],
        )?;
        Ok(res > 0)
    }

    /// Move a job to "dead letters" storage so it is not retried
    pub(crate) fn fail<C: GenericConnection>(
        &self,
        job: &Job,
        err_msg: &str,
        conn: &C,
    ) -> Result<bool> {
        let id = job.id as i64;
        let error_count = (job.error_count + 1) as i32;
        let res = conn.execute(
            &format!(
                r#"insert into {} (
                    id, class, args, queue, max_attempts, created_at, last_failed_at, last_error,
                    error_count
                )
                select id, class, args, queue, max_attempts, created_at, now(), $3, $4
                from {}
                where id = $1 and queue = $2"#,
                self.schema_config.dead_letters_table(), self.schema_config.queue_table()),
            &[&id, &self.name, &err_msg, &error_count],
        )?;
        if res == 0 {
            return Ok(false);
        }
        self.complete(&job, conn)
    }

    /// Length of the queue
    pub fn len<C: GenericConnection>(&self, conn: &C) -> Result<usize> {
        let res = conn.query(
            &format!(
                "select count(*) from {} where queue = $1",
                self.schema_config.queue_table()
            ),
            &[&self.name],
        )?;
        let count: i64 = res.get(0).get(0);
        Ok(count as usize)
    }

    /// Find a job in the queue by its job ID
    pub fn lookup_in_queue<C: GenericConnection>(
        &self,
        job_id: u64,
        conn: &C,
    ) -> Result<Option<Job>> {
        let query = &format!(
            r#"select
                id, queue, args, class, max_attempts, created_at, run_next_at,
                last_failed_at, last_error, error_count
            from {}
            where id = $1 and queue = $2"#,
            self.schema_config.queue_table()
        );
        let rows = conn.query(query, &[&(job_id as i64), &self.name])?;
        if rows.is_empty() {
            return Ok(None);
        }
        let row = rows.get(0);
        let id: i64 = row.get(0);
        let max_attempts: i32 = row.get(4);
        let error_count: i32 = row.get(9);
        Ok(Some(Job {
            id: id as u64,
            queue: row.get(1),
            args: row.get(2),
            class: row.get(3),
            max_attempts: max_attempts as u32,
            created_at: row.get(5),
            run_next_at: Some(row.get(6)),
            last_failed_at: row.get(7),
            last_error: row.get(8),
            error_count: error_count as u32,
        }))
    }

    /// Find a job in the queue's "dead letter" storage by its job ID
    pub fn lookup_in_dead_letters<C: GenericConnection>(
        &self,
        job_id: u64,
        conn: &C,
    ) -> Result<Option<Job>> {
        let query = &format!(
            r#"select
                id, queue, args, class, max_attempts, created_at,
                last_failed_at, last_error, error_count
            from {}
            where id = $1 and queue = $2"#,
            self.schema_config.dead_letters_table()
        );
        let rows = conn.query(query, &[&(job_id as i64), &self.name])?;
        if rows.is_empty() {
            return Ok(None);
        }
        let row = rows.get(0);
        let id: i64 = row.get(0);
        let max_attempts: i32 = row.get(4);
        let error_count: i32 = row.get(8);
        Ok(Some(Job {
            id: id as u64,
            queue: row.get(1),
            args: row.get(2),
            class: row.get(3),
            max_attempts: max_attempts as u32,
            created_at: row.get(5),
            run_next_at: None,
            last_failed_at: row.get(6),
            last_error: row.get(7),
            error_count: error_count as u32,
        }))
    }

    /// Delete all jobs from the queue. Calling this function may block until
    /// all running jobs in the queue finish
    pub fn clear<C: GenericConnection>(&self, conn: &C) -> Result<()> {
        conn.execute(
            &format!(
                "delete from {} where queue = $1",
                self.schema_config.queue_table()
            ),
            &[&self.name],
        )?;
        Ok(())
    }
}