fang 0.11.0

Background job processing library 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
use chrono::{DateTime, Utc};
use sha2::Digest;
use sha2::Sha256;
use {
    chrono::Duration, sqlx::any::AnyQueryResult, sqlx::Database, sqlx::Encode, sqlx::Executor,
    sqlx::FromRow, sqlx::IntoArguments, sqlx::Pool, sqlx::Type,
};

use std::fmt::Debug;
use typed_builder::TypedBuilder;
use uuid::Uuid;

#[cfg(feature = "asynk-postgres")]
mod postgres;
#[cfg(feature = "asynk-postgres")]
use self::postgres::BackendSqlXPg;

#[cfg(feature = "asynk-sqlite")]
mod sqlite;
#[cfg(feature = "asynk-sqlite")]
use self::sqlite::BackendSqlXSQLite;
#[cfg(feature = "asynk-mysql")]
mod mysql;
#[cfg(feature = "asynk-mysql")]
use self::mysql::BackendSqlXMySQL;

#[derive(Debug, Clone)]
pub(crate) enum BackendSqlX {
    #[cfg(feature = "asynk-postgres")]
    Pg,

    #[cfg(feature = "asynk-sqlite")]
    Sqlite,

    #[cfg(feature = "asynk-mysql")]
    MySql,
}

#[derive(TypedBuilder, Clone)]
pub(crate) struct QueryParams<'a> {
    #[builder(default, setter(strip_option))]
    uuid: Option<&'a Uuid>,
    #[builder(default, setter(strip_option))]
    metadata: Option<&'a serde_json::Value>,
    #[builder(default, setter(strip_option))]
    task_type: Option<&'a str>,
    #[builder(default, setter(strip_option))]
    scheduled_at: Option<&'a DateTime<Utc>>,
    #[builder(default, setter(strip_option))]
    state: Option<FangTaskState>,
    #[builder(default, setter(strip_option))]
    error_message: Option<&'a str>,
    #[builder(default, setter(strip_option))]
    runnable: Option<&'a dyn AsyncRunnable>,
    #[builder(default, setter(strip_option))]
    backoff_seconds: Option<u32>,
    #[builder(default, setter(strip_option))]
    task: Option<&'a Task>,
}

pub(crate) enum Res {
    Bigint(u64),
    Task(Task),
}

impl Res {
    pub(crate) fn unwrap_u64(self) -> u64 {
        match self {
            Res::Bigint(val) => val,
            _ => panic!("Can not unwrap a u64"),
        }
    }

    pub(crate) fn unwrap_task(self) -> Task {
        match self {
            Res::Task(task) => task,
            _ => panic!("Can not unwrap a task"),
        }
    }
}

impl BackendSqlX {
    pub(crate) async fn execute_query(
        &self,
        _query: SqlXQuery,
        _pool: &InternalPool,
        _params: QueryParams<'_>,
    ) -> Result<Res, AsyncQueueError> {
        match *self {
            #[cfg(feature = "asynk-postgres")]
            BackendSqlX::Pg => {
                BackendSqlXPg::execute_query(_query, _pool.unwrap_pg_pool(), _params).await
            }
            #[cfg(feature = "asynk-sqlite")]
            BackendSqlX::Sqlite => {
                BackendSqlXSQLite::execute_query(_query, _pool.unwrap_sqlite_pool(), _params).await
            }
            #[cfg(feature = "asynk-mysql")]
            BackendSqlX::MySql => {
                BackendSqlXMySQL::execute_query(_query, _pool.unwrap_mysql_pool(), _params).await
            }
        }
    }

    // I think it is useful to have this method, although it is not used
    pub(crate) fn _name(&self) -> &str {
        match *self {
            #[cfg(feature = "asynk-postgres")]
            BackendSqlX::Pg => BackendSqlXPg::_name(),
            #[cfg(feature = "asynk-sqlite")]
            BackendSqlX::Sqlite => BackendSqlXSQLite::_name(),
            #[cfg(feature = "asynk-mysql")]
            BackendSqlX::MySql => BackendSqlXMySQL::_name(),
        }
    }
}

#[derive(Debug, Clone)]
pub(crate) enum SqlXQuery {
    InsertTask,
    UpdateTaskState,
    FailTask,
    RemoveAllTask,
    RemoveAllScheduledTask,
    RemoveTask,
    RemoveTaskByMetadata,
    RemoveTaskType,
    FetchTaskType,
    FindTaskById,
    RetryTask,
    InsertTaskIfNotExists,
}

use crate::AsyncQueueError;
use crate::AsyncRunnable;
use crate::FangTaskState;
use crate::InternalPool;
use crate::Task;

pub(crate) fn calculate_hash(json: &str) -> String {
    let mut hasher = Sha256::new();
    hasher.update(json.as_bytes());
    let result = hasher.finalize();
    hex::encode(result)
}

trait FangQueryable<DB>
where
    DB: Database,
    for<'r> Task: FromRow<'r, <DB as sqlx::Database>::Row>,
    for<'r> std::string::String: Encode<'r, DB> + Type<DB>,
    for<'r> &'r str: Encode<'r, DB> + Type<DB>,
    for<'r> i32: Encode<'r, DB> + Type<DB>,
    for<'r> DateTime<Utc>: Encode<'r, DB> + Type<DB>,
    for<'r> &'r Uuid: Encode<'r, DB> + Type<DB>,
    for<'r> &'r serde_json::Value: Encode<'r, DB> + Type<DB>,
    for<'r> &'r Pool<DB>: Executor<'r, Database = DB>,
    for<'r> <DB as Database>::Arguments<'r>: IntoArguments<'r, DB>,
    <DB as Database>::QueryResult: Into<AnyQueryResult>,
{
    async fn fetch_task_type(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        // Unwraps by QueryParams are safe because the responsibility is of the caller
        // and the caller is the library itself
        let task_type = params.task_type.unwrap();

        let now = Utc::now();

        let task: Task = sqlx::query_as(query)
            .bind(task_type)
            .bind(now)
            .fetch_one(pool)
            .await?;

        Ok(task)
    }

    async fn find_task_by_uniq_hash(
        query: &str,
        pool: &Pool<DB>,
        params: &QueryParams<'_>,
    ) -> Option<Task> {
        let metadata = params.metadata.unwrap();

        let uniq_hash = calculate_hash(&metadata.to_string());

        sqlx::query_as(query)
            .bind(uniq_hash)
            .fetch_one(pool)
            .await
            .ok()
    }

    async fn find_task_by_id(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let uuid = params.uuid.unwrap();

        let task: Task = sqlx::query_as(query).bind(uuid).fetch_one(pool).await?;

        Ok(task)
    }

    async fn retry_task(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let now = Utc::now();

        let scheduled_at = now + Duration::seconds(params.backoff_seconds.unwrap() as i64);

        let task = params.task.unwrap();
        let retries = task.retries + 1;

        let uuid = task.id;

        let error = params.error_message.unwrap();

        let failed_task: Task = sqlx::query_as(query)
            .bind(error)
            .bind(retries)
            .bind(scheduled_at)
            .bind(now)
            .bind(&uuid)
            .fetch_one(pool)
            .await?;

        Ok(failed_task)
    }

    async fn insert_task_uniq(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let uuid = Uuid::new_v4();

        let metadata = params.metadata.unwrap();

        let metadata_str = metadata.to_string();
        let scheduled_at = params.scheduled_at.unwrap();

        let task_type = params.task_type.unwrap();

        let uniq_hash = calculate_hash(&metadata_str);

        let task: Task = sqlx::query_as(query)
            .bind(&uuid)
            .bind(metadata)
            .bind(task_type)
            .bind(uniq_hash)
            .bind(scheduled_at)
            .fetch_one(pool)
            .await?;
        Ok(task)
    }

    async fn insert_task(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let uuid = Uuid::new_v4();

        let scheduled_at = params.scheduled_at.unwrap();

        let metadata = params.metadata.unwrap();
        let task_type = params.task_type.unwrap();

        let task: Task = sqlx::query_as(query)
            .bind(&uuid)
            .bind(metadata)
            .bind(task_type)
            .bind(scheduled_at)
            .fetch_one(pool)
            .await?;

        Ok(task)
    }

    async fn update_task_state(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let updated_at = Utc::now();

        let state_str: &str = params.state.unwrap().into();

        let uuid = params.uuid.unwrap();

        let task: Task = sqlx::query_as(query)
            .bind(state_str)
            .bind(updated_at)
            .bind(uuid)
            .fetch_one(pool)
            .await?;

        Ok(task)
    }

    async fn fail_task(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        let updated_at = Utc::now();

        let uuid = params.task.unwrap().id;

        let error_message = params.error_message.unwrap();

        let failed_task: Task = sqlx::query_as(query)
            .bind(<&str>::from(FangTaskState::Failed))
            .bind(error_message)
            .bind(updated_at)
            .bind(&uuid)
            .fetch_one(pool)
            .await?;

        Ok(failed_task)
    }

    async fn remove_all_task(query: &str, pool: &Pool<DB>) -> Result<u64, AsyncQueueError> {
        // This converts <DB>QueryResult to AnyQueryResult and then to u64
        // do not delete into() method and do not delete Into<AnyQueryResult> trait bound
        Ok(sqlx::query(query)
            .execute(pool)
            .await?
            .into()
            .rows_affected())
    }

    async fn remove_all_scheduled_tasks(
        query: &str,
        pool: &Pool<DB>,
    ) -> Result<u64, AsyncQueueError> {
        let now = Utc::now();

        // This converts <DB>QueryResult to AnyQueryResult and then to u64
        // do not delete into() method and do not delete Into<AnyQueryResult> trait bound

        Ok(sqlx::query(query)
            .bind(now)
            .execute(pool)
            .await?
            .into()
            .rows_affected())
    }

    async fn remove_task(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<u64, AsyncQueueError> {
        let uuid = params.uuid.unwrap();

        let result = sqlx::query(query)
            .bind(uuid)
            .execute(pool)
            .await?
            .into()
            .rows_affected();

        if result != 1 {
            Err(AsyncQueueError::ResultError {
                expected: 1,
                found: result,
            })
        } else {
            Ok(result)
        }
    }

    async fn remove_task_by_metadata(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<u64, AsyncQueueError> {
        let metadata = serde_json::to_value(params.runnable.unwrap())?;

        let uniq_hash = calculate_hash(&metadata.to_string());

        Ok(sqlx::query(query)
            .bind(uniq_hash)
            .execute(pool)
            .await?
            .into()
            .rows_affected())
    }

    async fn remove_task_type(
        query: &str,
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<u64, AsyncQueueError> {
        let task_type = params.task_type.unwrap();

        Ok(sqlx::query(query)
            .bind(task_type)
            .execute(pool)
            .await?
            .into()
            .rows_affected())
    }

    async fn insert_task_if_not_exists(
        queries: (&str, &str),
        pool: &Pool<DB>,
        params: QueryParams<'_>,
    ) -> Result<Task, AsyncQueueError> {
        match Self::find_task_by_uniq_hash(queries.0, pool, &params).await {
            Some(task) => Ok(task),
            None => Self::insert_task_uniq(queries.1, pool, params).await,
        }
    }
}