folk-plugin-jobs 0.3.3

Queue consumer plugin for Folk — pulls jobs from memory or Redis and dispatches to PHP workers
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 std::fmt;
use std::time::Duration;

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum DriverKind {
    Memory,
    Redis,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum BackoffStrategy {
    /// delay * 2^retries
    Exponential,
    /// delay * (retries + 1)
    Linear,
    /// constant delay
    Fixed,
}

impl BackoffStrategy {
    pub fn delay(&self, base: Duration, attempt: u32) -> Duration {
        match self {
            Self::Exponential => base.saturating_mul(1u32 << attempt.min(10)),
            Self::Linear => base.saturating_mul(attempt + 1),
            Self::Fixed => base,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct QueueConfig {
    pub name: String,
    pub concurrency: usize,
    pub max_retries: u32,

    /// Base retry delay (e.g. "1s"). Default: 1s
    #[serde(with = "humantime_serde")]
    pub retry_delay: Duration,

    /// Backoff strategy: exponential | linear | fixed. Default: exponential
    pub retry_backoff: BackoffStrategy,

    /// Job execution timeout (e.g. "60s"). 0 = no timeout. Default: 60s
    #[serde(with = "humantime_serde")]
    pub job_timeout: Duration,

    /// Queue name for failed jobs after max retries. None = discard.
    pub dead_letter_queue: Option<String>,

    /// Queue priority (lower = higher priority). Default: 10
    pub priority: u32,
}

impl Default for QueueConfig {
    fn default() -> Self {
        Self {
            name: "default".into(),
            concurrency: 4,
            max_retries: 3,
            retry_delay: Duration::from_secs(1),
            retry_backoff: BackoffStrategy::Exponential,
            job_timeout: Duration::from_secs(60),
            dead_letter_queue: None,
            priority: 10,
        }
    }
}

#[derive(Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct JobsConfig {
    pub driver: DriverKind,
    pub host: String,
    pub port: u16,
    pub password: String,
    pub db: u32,
    pub queues: Vec<QueueConfig>,
}

impl fmt::Debug for JobsConfig {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("JobsConfig")
            .field("driver", &self.driver)
            .field("host", &self.host)
            .field("port", &self.port)
            .field("password", &"[REDACTED]")
            .field("db", &self.db)
            .field("queues", &self.queues)
            .finish()
    }
}

impl JobsConfig {
    /// Build a Redis connection URL from the unified fields.
    pub fn redis_url(&self) -> String {
        let auth = if self.password.is_empty() {
            String::new()
        } else {
            format!(":{}@", self.password)
        };
        format!("redis://{}{}:{}/{}", auth, self.host, self.port, self.db)
    }
}

impl Default for JobsConfig {
    fn default() -> Self {
        Self {
            driver: DriverKind::Memory,
            host: "127.0.0.1".into(),
            port: 6379,
            password: String::new(),
            db: 0,
            queues: vec![QueueConfig::default()],
        }
    }
}