graphile_worker_lifecycle_hooks 0.3.2

Lifecycle hooks for graphile_worker, a high performance Rust/PostgreSQL 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
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

use std::sync::Arc;
use std::time::Duration;

use chrono::{DateTime, Utc};
use graphile_worker_crontab_types::Crontab;
use graphile_worker_database::Database;
use graphile_worker_extensions::ReadOnlyExtensions;
use graphile_worker_job::Job;
use graphile_worker_job_spec::JobSpec;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ShutdownReason {
    Signal,
    Error,
    Graceful,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LocalQueueMode {
    Starting,
    Polling,
    Waiting,
    TtlExpired,
    Released,
}

#[derive(Clone)]
pub struct WorkerInitContext {
    pub database: Database,
    pub schema: String,
    pub concurrency: usize,
}

#[derive(Clone)]
pub struct WorkerStartContext {
    pub database: Database,
    pub worker_id: String,
    pub extensions: ReadOnlyExtensions,
}

#[derive(Clone)]
pub struct WorkerShutdownContext {
    pub database: Database,
    pub worker_id: String,
    pub reason: ShutdownReason,
}

#[derive(Clone)]
pub struct JobFetchContext {
    pub job: Arc<Job>,
    pub worker_id: String,
}

#[derive(Clone)]
pub struct JobStartContext {
    pub job: Arc<Job>,
    pub worker_id: String,
}

#[derive(Clone)]
pub struct JobCompleteContext {
    pub job: Arc<Job>,
    pub worker_id: String,
    pub duration: Duration,
}

#[derive(Clone)]
pub struct JobFailContext {
    pub job: Arc<Job>,
    pub worker_id: String,
    pub error: String,
    pub will_retry: bool,
}

#[derive(Clone)]
pub struct JobPermanentlyFailContext {
    pub job: Arc<Job>,
    pub worker_id: String,
    pub error: String,
}

#[derive(Clone)]
pub struct BeforeJobRunContext {
    pub job: Arc<Job>,
    pub worker_id: String,
    pub payload: serde_json::Value,
}

#[derive(Clone)]
pub struct AfterJobRunContext {
    pub job: Arc<Job>,
    pub worker_id: String,
    pub result: Result<(), String>,
    pub duration: Duration,
}

#[derive(Clone)]
pub struct CronTickContext {
    pub timestamp: DateTime<Utc>,
    pub crontabs: Vec<Crontab>,
}

#[derive(Clone)]
pub struct CronJobScheduledContext {
    pub crontab: Crontab,
    pub scheduled_at: DateTime<Utc>,
}

#[derive(Clone)]
pub struct BeforeJobScheduleContext {
    pub identifier: String,
    pub payload: serde_json::Value,
    pub spec: JobSpec,
}

#[derive(Debug, Clone)]
pub struct LocalQueueInitContext {
    pub worker_id: String,
}

#[derive(Debug, Clone)]
pub struct LocalQueueSetModeContext {
    pub worker_id: String,
    pub old_mode: LocalQueueMode,
    pub new_mode: LocalQueueMode,
}

#[derive(Debug, Clone)]
pub struct LocalQueueGetJobsCompleteContext {
    pub worker_id: String,
    pub jobs_count: usize,
}

#[derive(Debug, Clone)]
pub struct LocalQueueReturnJobsContext {
    pub worker_id: String,
    pub jobs_count: usize,
}

#[derive(Debug, Clone)]
pub struct LocalQueueRefetchDelayStartContext {
    pub worker_id: String,
    pub duration: Duration,
    pub threshold: usize,
    pub abort_threshold: usize,
}

#[derive(Debug, Clone)]
pub struct LocalQueueRefetchDelayAbortContext {
    pub worker_id: String,
    pub count: usize,
    pub abort_threshold: usize,
}

#[derive(Debug, Clone)]
pub struct LocalQueueRefetchDelayExpiredContext {
    pub worker_id: String,
}