graphile_worker_admin_api 0.1.0

Shared Graphile Worker admin API contracts and queries
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

use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct MaintenanceRequest {
    pub action: MaintenanceAction,
    #[serde(default)]
    pub cleanup_tasks: Vec<CleanupTaskName>,
    #[serde(default)]
    pub worker_ids: Vec<String>,
    #[serde(default)]
    pub dry_run: bool,
    pub sweep_threshold_secs: Option<u64>,
    pub recovery_delay_secs: Option<u64>,
}

#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum MaintenanceAction {
    Migrate,
    Cleanup,
    ForceUnlock,
    SweepStaleWorkers,
}

#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum CleanupTaskName {
    DeletePermanentlyFailedJobs,
    GcTaskIdentifiers,
    GcJobQueues,
}

impl CleanupTaskName {
    pub fn all() -> Vec<Self> {
        vec![
            Self::DeletePermanentlyFailedJobs,
            Self::GcTaskIdentifiers,
            Self::GcJobQueues,
        ]
    }
}

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

    #[test]
    fn cleanup_task_name_all_lists_every_cleanup_task() {
        let tasks = CleanupTaskName::all();

        assert_eq!(tasks.len(), 3);
        assert!(matches!(
            tasks.as_slice(),
            [
                CleanupTaskName::DeletePermanentlyFailedJobs,
                CleanupTaskName::GcTaskIdentifiers,
                CleanupTaskName::GcJobQueues
            ]
        ));
    }

    #[test]
    fn maintenance_request_deserializes_defaults() {
        let request: MaintenanceRequest =
            serde_json::from_value(serde_json::json!({ "action": "cleanup" })).unwrap();

        assert!(matches!(request.action, MaintenanceAction::Cleanup));
        assert!(request.cleanup_tasks.is_empty());
        assert!(request.worker_ids.is_empty());
        assert!(!request.dry_run);
        assert!(request.sweep_threshold_secs.is_none());
        assert!(request.recovery_delay_secs.is_none());
    }
}