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

use crate::task::{CurrentTask, TaskHash};
use crate::BackoffMode;
use async_trait::async_trait;
use serde::{de::DeserializeOwned, ser::Serialize};
use std::fmt::Debug;

/// The [`BackgroundTask`] trait is used to define the behaviour of a task. You must implement this
/// trait for all tasks you want to execute.
///
/// The [`BackgroundTask::TASK_NAME`] attribute must be unique for the whole application. This
/// attribute is critical for reconstructing the task back from the database.
///
/// The [`BackgroundTask::AppData`] can be used to argument the task with application specific
/// contextual information. This is useful for example to pass a database connection pool to the
/// task or other application configuration.
///
/// The [`BackgroundTask::run`] method is the main method of the task. It is executed by the
/// the task queue workers.
///
///
/// # Example
/// ```
/// use async_trait::async_trait;
/// use backie::{BackgroundTask, CurrentTask};
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Serialize, Deserialize)]
/// pub struct MyTask {}
///
/// #[async_trait]
/// impl BackgroundTask for MyTask {
///     const TASK_NAME: &'static str = "my_task_unique_name";
///     type AppData = ();
///     type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
///
///     async fn run(&self, task: CurrentTask, context: Self::AppData) -> Result<(), Self::Error> {
///         // Do something
///         Ok(())
///     }
/// }
/// ```
#[async_trait]
pub trait BackgroundTask: Serialize + DeserializeOwned + Sync + Send + 'static {
    /// Unique name of the task.
    ///
    /// This MUST be unique for the whole application.
    const TASK_NAME: &'static str;

    /// Task queue where this task will be executed.
    ///
    /// Used to route to which workers are going to be executing this task. It uses the default
    /// task queue if not changed.
    const QUEUE: &'static str = "default";

    /// Number of retries for tasks.
    ///
    /// By default, it is set to 3.
    const MAX_RETRIES: i32 = 3;

    /// Backoff mode for tasks.
    const BACKOFF_MODE: BackoffMode = BackoffMode::ExponentialBackoff;

    /// The application data provided to this task at runtime.
    type AppData: Clone + Send + 'static;

    /// An application custom error type.
    type Error: Debug + Send + 'static;

    /// Execute the task. This method should define its logic
    async fn run(&self, task: CurrentTask, context: Self::AppData) -> Result<(), Self::Error>;

    /// If set to true, no new tasks with the same metadata will be inserted
    /// By default it is set to false.
    fn uniq(&self) -> Option<TaskHash> {
        None
    }
}