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
use crate::error::TaskError as Error;
use actix::prelude::*;
use chrono::prelude::*;
use log::{debug, info};
use redis::{aio::MultiplexedConnection, Client, Value};

const ACTIVE_JOBS_LIST: &str = "{queue}:active";
const CONSUMERS_SET: &str = "{queue}:consumers";
const DEAD_JOBS_SET: &str = "{queue}:deadjobs";
const INFLIGHT_JOB_SET: &str = "{queue}:inflight";
const JOB_DATA_HASH: &str = "{queue}:data";
const SCHEDULED_JOBS_SET: &str = "{queue}:scheduled";
const SIGNAL_LIST: &str = "{queue}:signal";

pub struct Queue {
    name: String,
    active_jobs_list: String,
    consumers_set: String,
    dead_jobs_set: String,
    inflight_jobs_prefix: String,
    job_data_hash: String,
    scheduled_jobs_set: String,
    signal_list: String,
}

impl Queue {
    pub fn new(name: &'static str) -> Self {
        Queue {
            name: name.to_string(),
            active_jobs_list: ACTIVE_JOBS_LIST.replace("{queue}", &name),
            consumers_set: CONSUMERS_SET.replace("{queue}", &name),
            dead_jobs_set: DEAD_JOBS_SET.replace("{queue}", &name),
            inflight_jobs_prefix: INFLIGHT_JOB_SET.replace("{queue}", &name),
            job_data_hash: JOB_DATA_HASH.replace("{queue}", &name),
            scheduled_jobs_set: SCHEDULED_JOBS_SET.replace("{queue}", &name),
            signal_list: SIGNAL_LIST.replace("{queue}", &name),
        }
    }

    pub fn get_name(&self) -> &String {
        &self.name
    }
}

/// Actix Scheduler queue actor.
pub struct QueueActor {
    conn: MultiplexedConnection,
    queue: Queue,
}

impl QueueActor {
    /// Create new Redis queue actor instance.
    pub async fn new(redis_url: &'static str, queue: Queue) -> Self {
        let client = Client::open(redis_url).unwrap(); // ?
        let (conn, call) = client.get_multiplexed_async_connection().await.unwrap();
        actix::spawn(call);
        QueueActor { conn, queue }
    }
}

/// Implementation actix Actor trait for Redis queue.
impl Actor for QueueActor {
    type Context = Context<Self>;

    fn started(&mut self, _: &mut Self::Context) {
        info!("QueueActor started");
    }
}

/// Actix message implements request Redis to ack job
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<bool>, Error>")]
pub struct AckJob {
    consumer_id: String,
    job_id: String,
}

/// Implementation of Actix Handler for Get message.
impl Handler<AckJob> for QueueActor {
    type Result = ResponseFuture<Result<Option<bool>, Error>>;

    fn handle(&mut self, msg: AckJob, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let ack_job = redis::Script::new(include_str!("lua/ack_job.lua"));
        let inflight_set = format!("{}:{}", &self.queue.inflight_jobs_prefix, &msg.consumer_id);
        let data_hash = format!("{}", &self.queue.job_data_hash);
        let fut = async move {
            ack_job
                .key(inflight_set)
                .key(data_hash)
                .arg(msg.job_id)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Status of pushing a job.
#[derive(Debug, PartialEq)]
pub enum JobStatus {
    /// Job sucessfully added
    Success(i64), //Timestamp
    /// Job already exists.
    Exists,
}

/// Actix message implements request Redis to schedule job
#[derive(Message, Debug)]
#[rtype(result = "Result<JobStatus, Error>")]
pub struct ScheduleJob {
    pub id: String,
    pub time: DateTime<Utc>,
    //interval: RunType
}

/// Implementation of Actix Handler for scheduling a message.
impl Handler<ScheduleJob> for QueueActor {
    type Result = ResponseFuture<Result<JobStatus, Error>>;

    fn handle(&mut self, msg: ScheduleJob, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let schedule_job = redis::Script::new(include_str!("lua/schedule_job.lua"));
        let scheduled_jobs_set = self.queue.scheduled_jobs_set.to_string();
        let job_data_hash = self.queue.job_data_hash.to_string();
        let fut = async move {
            schedule_job
                .key(job_data_hash)
                .key(scheduled_jobs_set)
                .arg(&msg.id)
                .arg(&msg.id)
                .arg(msg.time.timestamp())
                .invoke_async(&mut con)
                .await
                .map(|res: i8| {
                    if res > 0 {
                        JobStatus::Success(msg.time.timestamp())
                    } else {
                        JobStatus::Exists
                    }
                })
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to push job
#[derive(Message, Debug)]
#[rtype(result = "Result<JobStatus, Error>")]
pub struct PushJob {
    id: String,
    task: Vec<u8>,
}

impl PushJob {
    pub fn create(task: Vec<u8>) -> PushJob {
        let id = format!("{:?}", Utc::now().timestamp_millis());
        PushJob { id, task }
    }
}

/// Implementation of Actix Handler to push job.
impl Handler<PushJob> for QueueActor {
    type Result = ResponseFuture<Result<JobStatus, Error>>;

    fn handle(&mut self, msg: PushJob, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let push_job = redis::Script::new(include_str!("lua/push_job.lua"));
        let job_data_hash = self.queue.job_data_hash.to_string();
        let active_jobs_list = self.queue.active_jobs_list.to_string();
        let signal_list = self.queue.signal_list.to_string();
        let fut = async move {
            push_job
                .key(job_data_hash)
                .key(active_jobs_list)
                .key(signal_list)
                .arg(&msg.id)
                .arg(msg.task)
                .invoke_async(&mut con)
                .await
                .map(|res: i8| {
                    if res > 0 {
                        JobStatus::Success(Utc::now().timestamp())
                    } else {
                        JobStatus::Exists
                    }
                })
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request redis to fetch jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Vec<Value>, Error>")]
pub struct FetchJobs {
    pub count: i32,
    pub consumer_id: String,
}

/// Implementation of Actix Handler fetching jobs.
impl Handler<FetchJobs> for QueueActor {
    type Result = ResponseFuture<Result<Vec<Value>, Error>>;

    fn handle(&mut self, msg: FetchJobs, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let fetch_jobs = redis::Script::new(include_str!("lua/get_jobs.lua"));
        let consumers_set = self.queue.consumers_set.to_string();
        let active_jobs_list = self.queue.active_jobs_list.to_string();
        let job_data_hash = self.queue.job_data_hash.to_string();
        let inflight_set = format!("{}:{}", self.queue.inflight_jobs_prefix, &msg.consumer_id);
        let signal_list = self.queue.signal_list.to_string();
        let fut = async move {
            fetch_jobs
                .key(consumers_set)
                .key(active_jobs_list)
                .key(&inflight_set)
                .key(job_data_hash)
                .key(signal_list)
                .arg(msg.count)
                .arg(&inflight_set)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to Enqueue scheduled jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<i8, Error>")]
pub struct EnqueueJobs(pub i32);

/// Implementation of Actix Handler for enqueue scheduled jobs
impl Handler<EnqueueJobs> for QueueActor {
    type Result = ResponseFuture<Result<i8, Error>>;

    fn handle(&mut self, msg: EnqueueJobs, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let enqueue_jobs = redis::Script::new(include_str!("lua/enqueue_scheduled_jobs.lua"));
        let scheduled_jobs_set = self.queue.scheduled_jobs_set.to_string();
        let active_jobs_list = self.queue.active_jobs_list.to_string();
        let signal_list = self.queue.signal_list.to_string();
        let timestamp = Utc::now().timestamp();
        let fut = async move {
            enqueue_jobs
                .key(scheduled_jobs_set)
                .key(active_jobs_list)
                .key(signal_list)
                .arg(timestamp)
                .arg(msg.0)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to kill jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<i8>, Error>")]
pub struct KillJob {
    job_id: String,
    consumer_id: String,
    error: String,
}

/// Implementation of Actix Handler for killing jobs
impl Handler<KillJob> for QueueActor {
    type Result = ResponseFuture<Result<Option<i8>, Error>>;

    fn handle(&mut self, msg: KillJob, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let kill_job = redis::Script::new(include_str!("lua/kill_job.lua"));
        let death_timestamp = Utc::now().timestamp();
        let dead_set = self.queue.dead_jobs_set.to_string();
        let job_data_hash = self.queue.job_data_hash.to_string();
        let inflight_set = format!("{}:{}", &self.queue.inflight_jobs_prefix, &msg.consumer_id);
        let fut = async move {
            kill_job
                .key(inflight_set)
                .key(dead_set)
                .key(job_data_hash)
                .arg(msg.job_id)
                .arg(death_timestamp)
                .arg(msg.error)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to reenqueue active jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<bool>, Error>")]
pub struct ReenqueueActive {
    consumer_id: String,
    jobs: Vec<String>,
}

/// Implementation of Actix Handler for Reenqueueing active jobs
impl Handler<ReenqueueActive> for QueueActor {
    type Result = ResponseFuture<Result<Option<bool>, Error>>;

    fn handle(&mut self, msg: ReenqueueActive, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let reenqueue_jobs = redis::Script::new(include_str!("lua/reenqueue_active_jobs.lua"));
        let inflight_set = format!("{}:{}", &self.queue.inflight_jobs_prefix, &msg.consumer_id);
        let active_jobs_list = self.queue.active_jobs_list.to_string();
        let signal_list = self.queue.signal_list.to_string();
        let fut = async move {
            reenqueue_jobs
                .key(inflight_set)
                .key(active_jobs_list)
                .key(signal_list)
                .arg(msg.jobs)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to reenqueue orphaned jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<i8>, Error>")]
pub struct ReenqueueOrphaned {
    expired_before: i32, //DateTime<Utc>.timestamp()
    count: i32,
}

/// Implementation of Actix Handler for Reenqueueing active jobs
impl Handler<ReenqueueOrphaned> for QueueActor {
    type Result = ResponseFuture<Result<Option<i8>, Error>>;

    fn handle(&mut self, msg: ReenqueueOrphaned, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let reenqueue_jobs = redis::Script::new(include_str!("lua/reenqueue_orphaned_jobs.lua"));
        let active_jobs_list = self.queue.active_jobs_list.to_string();
        let signal_list = self.queue.signal_list.to_string();
        let consumers_set = self.queue.consumers_set.to_string();
        let fut = async move {
            reenqueue_jobs
                .key(consumers_set)
                .key(active_jobs_list)
                .key(signal_list)
                .arg(msg.expired_before)
                .arg(msg.count)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to kill jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<bool>, Error>")]
pub struct RegisterConsumer(pub String);

/// Implementation of Actix Handler for killing jobs
impl Handler<RegisterConsumer> for QueueActor {
    type Result = ResponseFuture<Result<Option<bool>, Error>>;

    fn handle(&mut self, msg: RegisterConsumer, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let register_consumer = redis::Script::new(include_str!("lua/register_consumer.lua"));
        let inflight_set = format!("{}:{}", &self.queue.inflight_jobs_prefix, &msg.0);
        let consumers_set = self.queue.consumers_set.to_string();
        let timestamp = Utc::now().timestamp();
        let fut = async move {
            register_consumer
                .key(consumers_set)
                .arg(timestamp)
                .arg(inflight_set)
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

/// Actix message implements request Redis to retry jobs
#[derive(Message, Debug)]
#[rtype(result = "Result<Option<i8>, Error>")]
pub struct RetryJob {
    job_id: String,
    retry_at: DateTime<Utc>,
    consumer_id: String,
}

/// Implementation of Actix Handler for retrying jobs
impl Handler<RetryJob> for QueueActor {
    type Result = ResponseFuture<Result<Option<i8>, Error>>;

    fn handle(&mut self, msg: RetryJob, _: &mut Self::Context) -> Self::Result {
        let mut con = self.conn.clone();
        let retry_jobs = redis::Script::new(include_str!("lua/retry_job.lua"));
        let inflight_set = format!("{}:{}", &self.queue.inflight_jobs_prefix, &msg.consumer_id);
        let scheduled_jobs_set = self.queue.scheduled_jobs_set.to_string();
        let job_data_hash = self.queue.job_data_hash.to_string();
        let fut = async move {
            retry_jobs
                .key(inflight_set)
                .key(scheduled_jobs_set)
                .key(job_data_hash)
                .arg(&msg.job_id)
                .arg(msg.retry_at.timestamp())
                .arg(&msg.job_id) // This needs to be new job data
                .invoke_async(&mut con)
                .await
                .map_err(Error::from)
        };
        Box::pin(fut)
    }
}

// To use actor with supervisor actor has to implement `Supervised` trait
impl actix::Supervised for QueueActor {
    fn restarting(&mut self, _: &mut Context<QueueActor>) {
        debug!("restarting");
    }
}