lilqueue 0.1.0

A small storage-agnostic async job queue runner
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

use async_trait::async_trait;

pub type BoxError = Box<dyn std::error::Error + Send + Sync + 'static>;
pub type QueueResult<T> = Result<T, BoxError>;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NewJob {
    pub job_type: String,
    pub payload: String,
    pub available_at: i64,
    pub max_attempts: u32,
    pub enqueued_at: i64,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ClaimedJob<C> {
    pub id: i64,
    pub payload: String,
    pub attempts: u32,
    pub max_attempts: u32,
    pub claim: C,
}

/// Enqueue-only queue capability.
#[async_trait]
pub trait JobQueue: Clone + Send + Sync + 'static {
    async fn enqueue(&self, job: NewJob) -> QueueResult<i64>;

    async fn next_wakeup_at(&self, _job_type: &str) -> QueueResult<Option<i64>> {
        Ok(None)
    }
}

/// Claim-and-complete queue capability.
///
/// `claim` must atomically make the returned job unavailable to other workers.
/// Any lock token, lease timeout, or backend-specific state belongs in `Claim`.
#[async_trait]
pub trait LockableQueue: JobQueue {
    type Claim: Send + Sync + 'static;

    async fn claim(&self, job_type: &str) -> QueueResult<Option<ClaimedJob<Self::Claim>>>;

    async fn complete(&self, job: ClaimedJob<Self::Claim>) -> QueueResult<()>;
}

/// Retry-and-fail queue capability used by `JobProcessor` workers.
#[async_trait]
pub trait RetryableQueue: LockableQueue {
    async fn retry(
        &self,
        job: ClaimedJob<Self::Claim>,
        next_run_at: i64,
        error: String,
    ) -> QueueResult<()>;

    async fn fail(&self, job: ClaimedJob<Self::Claim>, error: String) -> QueueResult<()>;
}