workers 0.1.0

A robust async PostgreSQL-backed background job processing system
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

use crate::BackgroundJob;
use std::collections::HashMap;
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;

type RunTaskFnReturn = Pin<Box<dyn Future<Output = anyhow::Result<()>> + Send>>;
type RunTaskFn<Context> = dyn Fn(Context, serde_json::Value) -> RunTaskFnReturn + Send + Sync;

#[derive(Clone)]
pub(crate) struct JobRegistry<Context> {
    entries: HashMap<String, Arc<RunTaskFn<Context>>>,
}

impl<Context> std::fmt::Debug for JobRegistry<Context> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("JobRegistry")
            .field("job_types", &self.entries.keys().collect::<Vec<_>>())
            .finish()
    }
}

impl<Context> Default for JobRegistry<Context> {
    fn default() -> Self {
        Self {
            entries: HashMap::new(),
        }
    }
}

impl<Context: Clone + Send + Sync + 'static> JobRegistry<Context> {
    pub(crate) fn register<J: BackgroundJob<Context = Context>>(&mut self) {
        self.entries
            .insert(J::JOB_NAME.to_string(), Arc::new(runnable::<J>));
    }

    pub(crate) fn get(&self, key: &str) -> Option<&Arc<RunTaskFn<Context>>> {
        self.entries.get(key)
    }

    /// Returns a list of all registered job types.
    pub(crate) fn job_types(&self) -> Vec<String> {
        self.entries.keys().cloned().collect()
    }
}

fn runnable<J: BackgroundJob>(ctx: J::Context, payload: serde_json::Value) -> RunTaskFnReturn {
    Box::pin(async move {
        let job: J = serde_json::from_value(payload)?;
        job.run(ctx).await
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::BackgroundJob;
    use serde::{Deserialize, Serialize};

    #[test]
    fn test_job_types() {
        #[derive(Serialize, Deserialize)]
        struct TestJob;

        impl BackgroundJob for TestJob {
            const JOB_NAME: &'static str = "test";
            type Context = ();
            async fn run(&self, _: Self::Context) -> anyhow::Result<()> {
                Ok(())
            }
        }

        let mut registry = JobRegistry::default();
        registry.register::<TestJob>();
        assert_eq!(registry.job_types(), vec!["test"]);
    }
}