awa-worker 0.5.3-alpha.0

Worker runtime for the Awa job queue
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

use awa_model::JobRow;
use chrono::{DateTime, Utc};
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::time::Duration;

/// Typed lifecycle event for a specific job argument type.
#[derive(Debug, Clone)]
pub enum JobEvent<T> {
    /// Job completed successfully.
    Completed {
        args: T,
        job: JobRow,
        duration: Duration,
    },
    /// Job failed but will be retried later.
    Retried {
        args: T,
        job: JobRow,
        error: String,
        attempt: i16,
        next_run_at: DateTime<Utc>,
    },
    /// Job exhausted its retry budget and moved to `failed`.
    Exhausted {
        args: T,
        job: JobRow,
        error: String,
        attempt: i16,
    },
    /// Job was cancelled by the handler.
    Cancelled {
        args: T,
        job: JobRow,
        reason: String,
    },
}

impl<T> JobEvent<T> {
    /// The job snapshot associated with this event.
    pub fn job(&self) -> &JobRow {
        match self {
            JobEvent::Completed { job, .. }
            | JobEvent::Retried { job, .. }
            | JobEvent::Exhausted { job, .. }
            | JobEvent::Cancelled { job, .. } => job,
        }
    }
}

/// Untyped lifecycle event keyed only by job kind.
#[derive(Debug, Clone)]
pub enum UntypedJobEvent {
    /// Job completed successfully.
    Completed { job: JobRow, duration: Duration },
    /// Job failed but will be retried later.
    Retried {
        job: JobRow,
        error: String,
        attempt: i16,
        next_run_at: DateTime<Utc>,
    },
    /// Job exhausted its retry budget and moved to `failed`.
    Exhausted {
        job: JobRow,
        error: String,
        attempt: i16,
    },
    /// Job was cancelled by the handler.
    Cancelled { job: JobRow, reason: String },
}

impl UntypedJobEvent {
    /// The job snapshot associated with this event.
    pub fn job(&self) -> &JobRow {
        match self {
            UntypedJobEvent::Completed { job, .. }
            | UntypedJobEvent::Retried { job, .. }
            | UntypedJobEvent::Exhausted { job, .. }
            | UntypedJobEvent::Cancelled { job, .. } => job,
        }
    }

    pub(crate) fn into_typed<T>(self, args: T) -> JobEvent<T> {
        match self {
            UntypedJobEvent::Completed { job, duration } => JobEvent::Completed {
                args,
                job,
                duration,
            },
            UntypedJobEvent::Retried {
                job,
                error,
                attempt,
                next_run_at,
            } => JobEvent::Retried {
                args,
                job,
                error,
                attempt,
                next_run_at,
            },
            UntypedJobEvent::Exhausted {
                job,
                error,
                attempt,
            } => JobEvent::Exhausted {
                args,
                job,
                error,
                attempt,
            },
            UntypedJobEvent::Cancelled { job, reason } => JobEvent::Cancelled { args, job, reason },
        }
    }
}

pub(crate) type BoxedLifecycleFuture = Pin<Box<dyn Future<Output = ()> + Send + 'static>>;
pub(crate) type BoxedUntypedEventHandler =
    Arc<dyn Fn(UntypedJobEvent) -> BoxedLifecycleFuture + Send + Sync + 'static>;