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

use super::AsyncQueueable;
use crate::asynk::AsyncRunnable;
use crate::FangError;
use crate::Scheduled;
use async_trait::async_trait;
use chrono::DateTime;
use chrono::Utc;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
pub(crate) struct AsyncTask {
    pub number: u16,
}

#[typetag::serde]
#[async_trait]
impl AsyncRunnable for AsyncTask {
    async fn run(&self, _queueable: &dyn AsyncQueueable) -> Result<(), FangError> {
        Ok(())
    }
}

#[derive(Serialize, Deserialize)]
pub(crate) struct AsyncUniqTask {
    pub number: u16,
}

#[typetag::serde]
#[async_trait]
impl AsyncRunnable for AsyncUniqTask {
    async fn run(&self, _queueable: &dyn AsyncQueueable) -> Result<(), FangError> {
        Ok(())
    }

    fn uniq(&self) -> bool {
        true
    }
}

#[derive(Serialize, Deserialize)]
pub(crate) struct AsyncTaskSchedule {
    pub number: u16,
    pub datetime: String,
}

#[typetag::serde]
#[async_trait]
impl AsyncRunnable for AsyncTaskSchedule {
    async fn run(&self, _queueable: &dyn AsyncQueueable) -> Result<(), FangError> {
        Ok(())
    }

    fn cron(&self) -> Option<Scheduled> {
        let datetime = self.datetime.parse::<DateTime<Utc>>().ok()?;
        Some(Scheduled::ScheduleOnce(datetime))
    }
}

/// This macro creates a module with tests for a `Queueable` type.
///
/// Arguments:
/// + `$mod`: Name for the module
/// + `$q`: Full path to type that implements `AsyncQueueable`
/// + `$e`: An expression that returns a value of `$q` suitable for testing.
///   + Multiple values returned by `$e` must be able to be interacted with concurrently without interfering with each other.
macro_rules! test_asynk_queue {
    ($mod:ident, $q:ty, $e:expr) => {
        mod $mod {
            use chrono::Duration;
            use chrono::SubsecRound;
            use chrono::Utc;
            use $crate::async_queue::async_queue_tests::{
                AsyncTask, AsyncTaskSchedule, AsyncUniqTask,
            };
            use $crate::asynk::async_queue::AsyncQueueable;
            use $crate::FangTaskState;

            #[tokio::test]
            async fn insert_task_creates_new_task() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);
            }

            #[tokio::test]
            async fn update_task_state_test() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();
                let id = task.id;

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let finished_task = test
                    .update_task_state(&task, FangTaskState::Finished)
                    .await
                    .unwrap();

                assert_eq!(id, finished_task.id);
                assert_eq!(FangTaskState::Finished, finished_task.state);
            }

            #[tokio::test]
            async fn failed_task_test() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();
                let id = task.id;

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let failed_task = test.fail_task(&task, "Some error").await.unwrap();

                assert_eq!(id, failed_task.id);
                assert_eq!(Some("Some error"), failed_task.error_message.as_deref());
                assert_eq!(FangTaskState::Failed, failed_task.state);
            }

            #[tokio::test]
            async fn remove_all_tasks_test() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let task = test.insert_task(&AsyncTask { number: 2 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(2), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let result = test.remove_all_tasks().await.unwrap();
                assert_eq!(2, result);
            }

            #[tokio::test]
            async fn schedule_task_test() {
                let test: $q = $e.await;

                let datetime = (Utc::now() + Duration::seconds(7)).round_subsecs(0);

                let task = &AsyncTaskSchedule {
                    number: 1,
                    datetime: datetime.to_string(),
                };

                let task = test.schedule_task(task).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTaskSchedule"), type_task);
                assert_eq!(task.scheduled_at, datetime);
            }

            #[tokio::test]
            async fn remove_all_scheduled_tasks_test() {
                let test: $q = $e.await;

                let datetime = (Utc::now() + Duration::seconds(7)).round_subsecs(0);

                let task1 = &AsyncTaskSchedule {
                    number: 1,
                    datetime: datetime.to_string(),
                };

                let task2 = &AsyncTaskSchedule {
                    number: 2,
                    datetime: datetime.to_string(),
                };

                test.schedule_task(task1).await.unwrap();
                test.schedule_task(task2).await.unwrap();

                let number = test.remove_all_scheduled_tasks().await.unwrap();

                assert_eq!(2, number);
            }

            #[tokio::test]
            async fn fetch_and_touch_test() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let task = test.insert_task(&AsyncTask { number: 2 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(2), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let task = test.fetch_and_touch_task(None).await.unwrap().unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let task = test.fetch_and_touch_task(None).await.unwrap().unwrap();
                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(2), number);
                assert_eq!(Some("AsyncTask"), type_task);
            }

            #[tokio::test]
            async fn remove_tasks_type_test() {
                let test: $q = $e.await;

                let task = test.insert_task(&AsyncTask { number: 1 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let task = test.insert_task(&AsyncTask { number: 2 }).await.unwrap();

                let metadata = task.metadata.as_object().unwrap();

                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(2), number);
                assert_eq!(Some("AsyncTask"), type_task);

                let result = test.remove_tasks_type("mytype").await.unwrap();

                assert_eq!(0, result);

                let result = test.remove_tasks_type("common").await.unwrap();
                assert_eq!(2, result);
            }

            #[tokio::test]
            async fn remove_tasks_by_metadata() {
                //console_subscriber::init();
                let test: $q = $e.await;

                let task = test
                    .insert_task(&AsyncUniqTask { number: 1 })
                    .await
                    .unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(1), number);
                assert_eq!(Some("AsyncUniqTask"), type_task);

                let task = test
                    .insert_task(&AsyncUniqTask { number: 2 })
                    .await
                    .unwrap();

                let metadata = task.metadata.as_object().unwrap();
                let number = metadata["number"].as_u64();
                let type_task = metadata["type"].as_str();

                assert_eq!(Some(2), number);
                assert_eq!(Some("AsyncUniqTask"), type_task);

                let result = test
                    .remove_task_by_metadata(&AsyncUniqTask { number: 0 })
                    .await
                    .unwrap();
                assert_eq!(0, result);

                let result = test
                    .remove_task_by_metadata(&AsyncUniqTask { number: 1 })
                    .await
                    .unwrap();
                assert_eq!(1, result);
            }
        }
    };
}

pub(crate) use test_asynk_queue;