rrq 0.11.1

RRQ orchestrator CLI and worker runtime.
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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use uuid::Uuid;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum JobStatus {
    Pending,
    Active,
    Completed,
    Failed,
    Retrying,
    Cancelled,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Job {
    pub id: String,
    pub function_name: String,
    #[serde(default)]
    pub job_params: serde_json::Map<String, Value>,

    pub enqueue_time: DateTime<Utc>,
    #[serde(default)]
    pub start_time: Option<DateTime<Utc>>,

    pub status: JobStatus,
    pub current_retries: i64,
    #[serde(default)]
    pub next_scheduled_run_time: Option<DateTime<Utc>>,

    pub max_retries: i64,
    #[serde(default)]
    pub job_timeout_seconds: Option<i64>,
    #[serde(default)]
    pub result_ttl_seconds: Option<i64>,

    #[serde(default)]
    pub job_unique_key: Option<String>,

    #[serde(default)]
    pub completion_time: Option<DateTime<Utc>>,
    #[serde(default)]
    pub result: Option<Value>,
    #[serde(default)]
    pub last_error: Option<String>,

    #[serde(default)]
    pub queue_name: Option<String>,
    #[serde(default)]
    pub dlq_name: Option<String>,
    #[serde(default)]
    pub worker_id: Option<String>,

    #[serde(default)]
    pub trace_context: Option<std::collections::HashMap<String, String>>,
    #[serde(default)]
    pub correlation_context: Option<std::collections::HashMap<String, String>>,
}

impl Job {
    pub fn new_id() -> String {
        Uuid::new_v4().to_string()
    }
}

impl JobStatus {
    pub fn as_str(&self) -> &'static str {
        match self {
            JobStatus::Pending => "PENDING",
            JobStatus::Active => "ACTIVE",
            JobStatus::Completed => "COMPLETED",
            JobStatus::Failed => "FAILED",
            JobStatus::Retrying => "RETRYING",
            JobStatus::Cancelled => "CANCELLED",
        }
    }

    pub fn parse(value: &str) -> Option<Self> {
        match value {
            "PENDING" => Some(JobStatus::Pending),
            "ACTIVE" => Some(JobStatus::Active),
            "COMPLETED" => Some(JobStatus::Completed),
            "FAILED" => Some(JobStatus::Failed),
            "RETRYING" => Some(JobStatus::Retrying),
            "CANCELLED" => Some(JobStatus::Cancelled),
            _ => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn job_status_round_trip() {
        let statuses = [
            JobStatus::Pending,
            JobStatus::Active,
            JobStatus::Completed,
            JobStatus::Failed,
            JobStatus::Retrying,
            JobStatus::Cancelled,
        ];
        for status in statuses {
            let text = status.as_str();
            assert_eq!(JobStatus::parse(text), Some(status));
        }
        assert_eq!(JobStatus::parse("NOPE"), None);
    }

    #[test]
    fn job_new_id_is_uuid() {
        let id = Job::new_id();
        assert!(uuid::Uuid::parse_str(&id).is_ok());
    }
}