pgqrs 0.15.3

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
use crate::config::Config;
use crate::error::{Error, Result};
use crate::store::dblock::DbLock;
use crate::store::ConcurrencyModel;
use crate::store::{
    DbStateTable, DbTables, MessageTable, QueueTable, RunRecordTable, SerializedLock,
    StepRecordTable, Store, Tables, WorkerTable, WorkflowTable,
};

use async_trait::async_trait;
use sqlx::sqlite::{SqlitePool, SqlitePoolOptions};

use std::sync::Arc;

pub(crate) mod dialect;
pub mod tables;

use self::tables::db_state::SqliteDbState;
use self::tables::messages::SqliteMessageTable;
use self::tables::queues::SqliteQueueTable;
use self::tables::runs::SqliteRunRecordTable;
use self::tables::steps::SqliteStepRecordTable;
use self::tables::workers::SqliteWorkerTable;
use self::tables::workflows::SqliteWorkflowTable;

#[derive(Debug, Clone)]
pub struct SqliteTables {
    pool: SqlitePool,
    config: Config,
    queues: Arc<SqliteQueueTable>,
    messages: Arc<SqliteMessageTable>,
    workers: Arc<SqliteWorkerTable>,
    db_state: Arc<SqliteDbState>,
    workflows: Arc<SqliteWorkflowTable>,
    workflow_runs: Arc<SqliteRunRecordTable>,
    workflow_steps: Arc<SqliteStepRecordTable>,
}

impl SqliteTables {
    pub(crate) async fn new(dsn: &str, config: &Config) -> Result<Self> {
        let journal_mode = if config.sqlite.use_wal {
            "WAL"
        } else {
            "DELETE"
        };
        let journal_mode_pragma = format!("PRAGMA journal_mode={}", journal_mode);
        let pool = SqlitePoolOptions::new()
            .max_connections(4)
            .after_connect(move |conn, _meta| {
                let journal_mode_pragma = journal_mode_pragma.clone();
                Box::pin(async move {
                    sqlx::query(&journal_mode_pragma)
                        .execute(&mut *conn)
                        .await?;
                    sqlx::query("PRAGMA busy_timeout=5000")
                        .execute(&mut *conn)
                        .await?;
                    sqlx::query("PRAGMA foreign_keys=ON")
                        .execute(&mut *conn)
                        .await?;
                    Ok(())
                })
            })
            .connect(dsn)
            .await
            .map_err(Error::Database)?;

        Ok(Self {
            pool: pool.clone(),
            config: config.clone(),
            queues: Arc::new(SqliteQueueTable::new(pool.clone())),
            messages: Arc::new(SqliteMessageTable::new(pool.clone())),
            workers: Arc::new(SqliteWorkerTable::new(pool.clone())),
            db_state: Arc::new(SqliteDbState::new(pool.clone())),
            workflows: Arc::new(SqliteWorkflowTable::new(pool.clone())),
            workflow_runs: Arc::new(SqliteRunRecordTable::new(pool.clone())),
            workflow_steps: Arc::new(SqliteStepRecordTable::new(pool)),
        })
    }
}

#[derive(Clone)]
pub struct SqliteStore {
    db: SerializedLock<SqliteTables>,
    tables: Tables<SerializedLock<SqliteTables>>,
}

impl std::fmt::Debug for SqliteStore {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("SqliteStore").finish()
    }
}

impl SqliteStore {
    /// Create a new SQLite store with default optimizations.
    pub async fn new(dsn: &str, config: &Config) -> Result<Self> {
        let db = SerializedLock::new(SqliteTables::new(dsn, config).await?);
        let tables = Tables::new(db.clone());
        Ok(Self { db, tables })
    }

    fn any_store(&self) -> crate::store::AnyStore {
        crate::store::AnyStore::Sqlite(self.clone())
    }
}

pub use crate::store::sqlite_utils::format_timestamp as format_sqlite_timestamp;
pub use crate::store::sqlite_utils::parse_timestamp as parse_sqlite_timestamp;

#[async_trait]
impl DbTables for SqliteTables {
    async fn execute_raw(&self, sql: &str) -> Result<()> {
        sqlx::query(sql)
            .execute(&self.pool)
            .await
            .map_err(|e| Error::QueryFailed {
                query: sql.to_string(),
                source: Box::new(e),
                context: "Failed to execute raw SQL".into(),
            })?;
        Ok(())
    }

    async fn execute_raw_with_i64(&self, sql: &str, param: i64) -> Result<()> {
        sqlx::query(sql).bind(param).execute(&self.pool).await?;
        Ok(())
    }

    async fn execute_raw_with_two_i64(&self, sql: &str, param1: i64, param2: i64) -> Result<()> {
        sqlx::query(sql)
            .bind(param1)
            .bind(param2)
            .execute(&self.pool)
            .await?;
        Ok(())
    }

    async fn query_int(&self, sql: &str) -> Result<i64> {
        use sqlx::Row;
        let row = sqlx::raw_sql(sql).fetch_one(&self.pool).await?;
        Ok(row.try_get(0)?)
    }

    async fn query_string(&self, sql: &str) -> Result<String> {
        use sqlx::Row;
        let row = sqlx::raw_sql(sql).fetch_one(&self.pool).await?;
        Ok(row.try_get(0)?)
    }

    async fn query_bool(&self, sql: &str) -> Result<bool> {
        use sqlx::Row;
        let row = sqlx::raw_sql(sql).fetch_one(&self.pool).await?;
        Ok(row.try_get(0)?)
    }

    fn config(&self) -> &Config {
        &self.config
    }

    fn concurrency_model(&self) -> ConcurrencyModel {
        ConcurrencyModel::SingleProcess
    }

    fn queues(&self) -> &dyn QueueTable {
        self.queues.as_ref()
    }

    fn messages(&self) -> &dyn MessageTable {
        self.messages.as_ref()
    }

    fn workers(&self) -> &dyn WorkerTable {
        self.workers.as_ref()
    }

    fn db_state(&self) -> &dyn DbStateTable {
        self.db_state.as_ref()
    }

    fn workflows(&self) -> &dyn WorkflowTable {
        self.workflows.as_ref()
    }

    fn workflow_runs(&self) -> &dyn RunRecordTable {
        self.workflow_runs.as_ref()
    }

    fn workflow_steps(&self) -> &dyn StepRecordTable {
        self.workflow_steps.as_ref()
    }

    async fn bootstrap(&self) -> Result<()> {
        sqlx::migrate!("migrations/sqlite")
            .run(&self.pool)
            .await
            .map_err(|e| crate::error::Error::Database(e.into()))?;
        Ok(())
    }
}

#[async_trait]
impl Store for SqliteStore {
    type Workers = Tables<SerializedLock<SqliteTables>>;

    async fn execute_raw(&self, sql: &str) -> Result<()> {
        let sql = sql.to_string();
        self.db
            .with_write(|db| Box::pin(async move { db.execute_raw(&sql).await }))
            .await
    }

    async fn execute_raw_with_i64(&self, sql: &str, param: i64) -> Result<()> {
        let sql = sql.to_string();
        self.db
            .with_write(|db| Box::pin(async move { db.execute_raw_with_i64(&sql, param).await }))
            .await
    }

    async fn execute_raw_with_two_i64(&self, sql: &str, param1: i64, param2: i64) -> Result<()> {
        let sql = sql.to_string();
        self.db
            .with_write(|db| {
                Box::pin(async move { db.execute_raw_with_two_i64(&sql, param1, param2).await })
            })
            .await
    }

    async fn query_int(&self, sql: &str) -> Result<i64> {
        let sql = sql.to_string();
        self.db
            .with_read(|db| Box::pin(async move { db.query_int(&sql).await }))
            .await
    }

    async fn query_string(&self, sql: &str) -> Result<String> {
        let sql = sql.to_string();
        self.db
            .with_read(|db| Box::pin(async move { db.query_string(&sql).await }))
            .await
    }

    async fn query_bool(&self, sql: &str) -> Result<bool> {
        let sql = sql.to_string();
        self.db
            .with_read(|db| Box::pin(async move { db.query_bool(&sql).await }))
            .await
    }

    fn config(&self) -> &Config {
        self.db.config()
    }

    fn queues(&self) -> &dyn QueueTable {
        &self.tables
    }

    fn messages(&self) -> &dyn MessageTable {
        &self.tables
    }

    fn workers(&self) -> &Self::Workers {
        &self.tables
    }

    fn db_state(&self) -> &dyn DbStateTable {
        &self.tables
    }

    fn workflows(&self) -> &dyn WorkflowTable {
        &self.tables
    }

    fn workflow_runs(&self) -> &dyn RunRecordTable {
        &self.tables
    }

    fn workflow_steps(&self) -> &dyn StepRecordTable {
        &self.tables
    }

    async fn bootstrap(&self) -> Result<()> {
        self.db
            .with_write(|db| Box::pin(async move { db.bootstrap().await }))
            .await
    }

    async fn admin(&self, name: &str) -> Result<crate::workers::Admin> {
        let worker_record = WorkerTable::register(&self.tables, None, name).await?;
        Ok(crate::workers::Admin::new(
            crate::store::AnyStore::Sqlite(self.clone()),
            worker_record,
        ))
    }

    async fn admin_ephemeral(&self) -> Result<crate::workers::Admin> {
        let worker_record = WorkerTable::register_ephemeral(&self.tables, None).await?;
        Ok(crate::workers::Admin::new(
            crate::store::AnyStore::Sqlite(self.clone()),
            worker_record,
        ))
    }

    async fn producer(
        &self,
        queue: &str,
        name: &str,
        config: &Config,
    ) -> Result<crate::workers::Producer> {
        let queue_info = QueueTable::get_by_name(&self.tables, queue).await?;
        let worker_record = WorkerTable::register(&self.tables, Some(queue_info.id), name).await?;

        Ok(crate::workers::Producer::new(
            self.any_store(),
            queue_info,
            worker_record,
            config.validation_config.clone(),
        ))
    }

    async fn consumer(&self, queue: &str, name: &str) -> Result<crate::workers::Consumer> {
        let queue_info = QueueTable::get_by_name(&self.tables, queue).await?;
        let worker_record = WorkerTable::register(&self.tables, Some(queue_info.id), name).await?;

        Ok(crate::workers::Consumer::new(
            self.any_store(),
            queue_info,
            worker_record,
        ))
    }

    async fn queue(&self, name: &str) -> Result<crate::types::QueueRecord> {
        let queue_exists = QueueTable::exists(&self.tables, name).await?;
        if queue_exists {
            return Err(crate::error::Error::QueueAlreadyExists {
                name: name.to_string(),
            });
        }

        QueueTable::insert(
            &self.tables,
            crate::types::NewQueueRecord {
                queue_name: name.to_string(),
            },
        )
        .await
    }

    async fn workflow(&self, name: &str) -> Result<crate::types::WorkflowRecord> {
        let queue_exists = QueueTable::exists(&self.tables, name).await?;
        if !queue_exists {
            let _queue = QueueTable::insert(
                &self.tables,
                crate::types::NewQueueRecord {
                    queue_name: name.to_string(),
                },
            )
            .await?;
        }

        let queue = QueueTable::get_by_name(&self.tables, name).await?;

        WorkflowTable::insert(
            &self.tables,
            crate::types::NewWorkflowRecord {
                name: name.to_string(),
                queue_id: queue.id,
            },
        )
        .await
        .map_err(|e| {
            if let crate::error::Error::QueryFailed { source, .. } = &e {
                if let Some(sqlx::Error::Database(db_err)) = source.downcast_ref::<sqlx::Error>() {
                    if matches!(db_err.code().as_deref(), Some("2067" | "1555" | "19")) {
                        return crate::error::Error::WorkflowAlreadyExists {
                            name: name.to_string(),
                        };
                    }
                }
            }
            e
        })
    }

    async fn run(&self, message: crate::types::QueueMessage) -> Result<crate::workers::Run> {
        match RunRecordTable::get_by_message_id(&self.tables, message.id).await {
            Ok(record) => {
                return Ok(crate::workers::Run::new(self.any_store(), record));
            }
            Err(crate::error::Error::NotFound { .. }) => {}
            Err(e) => return Err(e),
        }

        let queue = QueueTable::get(&self.tables, message.queue_id).await?;
        let workflow = WorkflowTable::get_by_name(&self.tables, &queue.queue_name).await?;

        let run_rec = RunRecordTable::insert(
            &self.tables,
            crate::types::NewRunRecord {
                workflow_id: workflow.id,
                message_id: message.id,
                input: Some(message.payload.clone()),
            },
        )
        .await?;

        Ok(crate::workers::Run::new(self.any_store(), run_rec))
    }

    fn concurrency_model(&self) -> ConcurrencyModel {
        self.db.concurrency_model()
    }

    fn backend_name(&self) -> &'static str {
        "sqlite"
    }

    async fn producer_ephemeral(
        &self,
        queue: &str,
        config: &Config,
    ) -> Result<crate::workers::Producer> {
        let queue_info = QueueTable::get_by_name(&self.tables, queue).await?;
        let worker_record =
            WorkerTable::register_ephemeral(&self.tables, Some(queue_info.id)).await?;

        Ok(crate::workers::Producer::new(
            self.any_store(),
            queue_info,
            worker_record,
            config.validation_config.clone(),
        ))
    }

    async fn consumer_ephemeral(&self, queue: &str) -> Result<crate::workers::Consumer> {
        let queue_info = QueueTable::get_by_name(&self.tables, queue).await?;
        let worker_record =
            WorkerTable::register_ephemeral(&self.tables, Some(queue_info.id)).await?;

        Ok(crate::workers::Consumer::new(
            self.any_store(),
            queue_info,
            worker_record,
        ))
    }
}