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
//! Provides the [`Task`] trait as well as options for configuring tasks.
use async_trait::async_trait;
use chrono::{DateTime, NaiveDateTime, Utc};
use rand::distributions::{Distribution, Uniform};
use serde::{Deserialize, Serialize};
use std::time::{SystemTime, UNIX_EPOCH};
use crate::error::TaskError;
mod async_result;
mod options;
mod request;
mod signature;
pub use async_result::AsyncResult;
pub use options::TaskOptions;
pub use request::Request;
pub use signature::Signature;
/// The return type for a task.
pub type TaskResult<R> = Result<R, TaskError>;
#[doc(hidden)]
pub trait AsTaskResult {
type Returns: Send + Sync + std::fmt::Debug;
}
impl<R> AsTaskResult for TaskResult<R>
where
R: Send + Sync + std::fmt::Debug,
{
type Returns = R;
}
/// A `Task` represents a unit of work that a `Celery` app can produce or consume.
///
/// The recommended way to create tasks is through the [`task`](../attr.task.html) attribute macro, not by directly implementing
/// this trait. For more information see the [tasks chapter](https://rusty-celery.github.io/guide/defining-tasks.html)
/// in the Rusty Celery Book.
#[async_trait]
pub trait Task: Send + Sync + std::marker::Sized {
/// The name of the task. When a task is registered it will be registered with this name.
const NAME: &'static str;
/// For compatability with Python tasks. This keeps track of the order
/// of arguments for the task so that the task can be called from Python with
/// positional arguments.
const ARGS: &'static [&'static str];
/// Default task options.
const DEFAULTS: TaskOptions = TaskOptions {
time_limit: None,
hard_time_limit: None,
max_retries: None,
min_retry_delay: None,
max_retry_delay: None,
retry_for_unexpected: None,
acks_late: None,
content_type: None,
};
/// The parameters of the task.
type Params: Clone + Send + Sync + Serialize + for<'de> Deserialize<'de>;
/// The return type of the task.
type Returns: Send + Sync + std::fmt::Debug;
/// Used to initialize a task instance from a request.
fn from_request(request: Request<Self>, options: TaskOptions) -> Self;
/// Get a reference to the request used to create this task instance.
fn request(&self) -> &Request<Self>;
/// Get a reference to the task's configuration options.
///
/// This is a product of both app-level task options and the options configured specifically
/// for the given task. Options specified at the *task*-level take priority over options
/// specified at the app level. So, if the task was defined like this:
///
/// ```rust
/// # use celery::prelude::*;
/// #[celery::task(time_limit = 3)]
/// fn add(x: i32, y: i32) -> TaskResult<i32> {
/// Ok(x + y)
/// }
/// ```
///
/// But the `Celery` app was built with a `task_time_limit` of 5, then
/// `Task::options().time_limit` would be `Some(3)`.
fn options(&self) -> &TaskOptions;
/// This function defines how a task executes.
async fn run(&self, params: Self::Params) -> TaskResult<Self::Returns>;
/// Callback that will run after a task fails.
#[allow(unused_variables)]
async fn on_failure(&self, err: &TaskError) {}
/// Callback that will run after a task completes successfully.
#[allow(unused_variables)]
async fn on_success(&self, returned: &Self::Returns) {}
/// Returns the registered name of the task.
fn name(&self) -> &'static str {
Self::NAME
}
/// This can be called from within a task function to trigger a retry in `countdown` seconds.
fn retry_with_countdown(&self, countdown: u32) -> TaskResult<Self::Returns> {
let eta = match SystemTime::now().duration_since(UNIX_EPOCH) {
Ok(now) => {
let now_secs = now.as_secs() as u32;
let now_millis = now.subsec_millis();
let eta_secs = now_secs + countdown;
Some(DateTime::<Utc>::from_naive_utc_and_offset(
NaiveDateTime::from_timestamp_opt(eta_secs as i64, now_millis * 1000)
.ok_or_else(|| {
TaskError::UnexpectedError(format!(
"Invalid countdown seconds {countdown}",
))
})?,
Utc,
))
}
Err(_) => None,
};
Err(TaskError::Retry(eta))
}
/// This can be called from within a task function to trigger a retry at the specified `eta`.
fn retry_with_eta(&self, eta: DateTime<Utc>) -> TaskResult<Self::Returns> {
Err(TaskError::Retry(Some(eta)))
}
/// Get a future ETA at which time the task should be retried. By default this
/// uses a capped exponential backoff strategy.
fn retry_eta(&self) -> Option<DateTime<Utc>> {
let retries = self.request().retries;
let delay_secs = std::cmp::min(
2u32.checked_pow(retries)
.unwrap_or_else(|| self.max_retry_delay()),
self.max_retry_delay(),
);
let delay_secs = std::cmp::max(delay_secs, self.min_retry_delay());
let between = Uniform::from(0..1000);
let mut rng = rand::thread_rng();
let delay_millis = between.sample(&mut rng);
match SystemTime::now().duration_since(UNIX_EPOCH) {
Ok(now) => {
let now_secs = now.as_secs() as u32;
let now_millis = now.subsec_millis();
let eta_secs = now_secs + delay_secs;
let eta_millis = now_millis + delay_millis;
NaiveDateTime::from_timestamp_opt(eta_secs as i64, eta_millis * 1000)
.map(|eta| DateTime::<Utc>::from_naive_utc_and_offset(eta, Utc))
}
Err(_) => None,
}
}
fn retry_for_unexpected(&self) -> bool {
Self::DEFAULTS
.retry_for_unexpected
.or(self.options().retry_for_unexpected)
.unwrap_or(true)
}
fn time_limit(&self) -> Option<u32> {
self.request().time_limit.or_else(|| {
// Take min or `time_limit` and `hard_time_limit`.
let time_limit = Self::DEFAULTS.time_limit.or(self.options().time_limit);
let hard_time_limit = Self::DEFAULTS
.hard_time_limit
.or(self.options().hard_time_limit);
match (time_limit, hard_time_limit) {
(Some(t1), Some(t2)) => Some(std::cmp::min(t1, t2)),
(Some(t1), None) => Some(t1),
(None, Some(t2)) => Some(t2),
_ => None,
}
})
}
fn max_retries(&self) -> Option<u32> {
Self::DEFAULTS.max_retries.or(self.options().max_retries)
}
fn min_retry_delay(&self) -> u32 {
Self::DEFAULTS
.min_retry_delay
.or(self.options().min_retry_delay)
.unwrap_or(0)
}
fn max_retry_delay(&self) -> u32 {
Self::DEFAULTS
.max_retry_delay
.or(self.options().max_retry_delay)
.unwrap_or(3600)
}
fn acks_late(&self) -> bool {
Self::DEFAULTS
.acks_late
.or(self.options().acks_late)
.unwrap_or(false)
}
}
#[derive(Clone, Debug)]
pub(crate) enum TaskEvent {
StatusChange(TaskStatus),
}
#[derive(Clone, Debug)]
pub(crate) enum TaskStatus {
Pending,
Finished,
}
/// Extension methods for `Result` types within a task body.
///
/// These methods can be used to convert a `Result<T, E>` to a `Result<T, TaskError>` with the
/// appropriate [`TaskError`] variant. The trait has a blanket implementation for any error type that implements
/// [`std::error::Error`](https://doc.rust-lang.org/std/error/trait.Error.html).
///
/// # Examples
///
/// ```rust
/// # use celery::prelude::*;
/// fn do_some_io() -> Result<(), std::io::Error> {
/// unimplemented!()
/// }
///
/// #[celery::task]
/// fn fallible_io_task() -> TaskResult<()> {
/// do_some_io().with_expected_err(|| "IO error")?;
/// Ok(())
/// }
/// ```
pub trait TaskResultExt<T, E, F, C> {
/// Convert the error type to a [`TaskError::ExpectedError`].
fn with_expected_err(self, f: F) -> Result<T, TaskError>;
/// Convert the error type to a [`TaskError::UnexpectedError`].
fn with_unexpected_err(self, f: F) -> Result<T, TaskError>;
}
impl<T, E, F, C> TaskResultExt<T, E, F, C> for Result<T, E>
where
E: std::error::Error,
F: FnOnce() -> C,
C: std::fmt::Display + Send + Sync + 'static,
{
fn with_expected_err(self, f: F) -> Result<T, TaskError> {
self.map_err(|e| TaskError::ExpectedError(format!("{} ➥ Cause: {:?}", f(), e)))
}
fn with_unexpected_err(self, f: F) -> Result<T, TaskError> {
self.map_err(|e| TaskError::UnexpectedError(format!("{} ➥ Cause: {:?}", f(), e)))
}
}