roadster 0.8.1

A "Batteries Included" web framework for rust designed to get you moving fast.
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
122
123

// Todo: Not sure if this should be public yet.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, bon::Builder, Eq, PartialEq)]
#[non_exhaustive]
#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
pub(crate) struct Job {
    pub(crate) metadata: JobMetadata,
    pub(crate) args: serde_json::Value,
}

// Todo: Not sure if this should be public yet.
#[serde_with::skip_serializing_none]
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, bon::Builder, Eq, PartialEq)]
#[non_exhaustive]
#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
pub(crate) struct JobMetadata {
    #[builder(into, default = JobId::Uuid(uuid::Uuid::now_v7()))]
    pub(crate) id: JobId,
    #[builder(into)]
    pub(crate) worker_name: String,
}

// Todo: Not sure if this should be public yet.
#[derive(
    Debug, Copy, Clone, derive_more::Display, serde::Serialize, serde::Deserialize, Eq, PartialEq,
)]
#[serde(untagged)]
#[non_exhaustive]
#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
pub(crate) enum JobId {
    Uuid(uuid::Uuid),
    Hash(u64),
}

#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
impl From<uuid::Uuid> for JobId {
    fn from(value: uuid::Uuid) -> Self {
        Self::Uuid(value)
    }
}

#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
impl From<u64> for JobId {
    fn from(value: u64) -> Self {
        Self::Hash(value)
    }
}

// Todo: Not sure if this should be public yet.
#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
pub(crate) fn periodic_hash<H: std::hash::Hasher>(
    hasher: &mut H,
    worker_name: &str,
    schedule: &cron::Schedule,
    value: &serde_json::Value,
) {
    use std::hash::Hash;

    worker_name.hash(hasher);
    schedule.to_string().hash(hasher);
    value.hash(hasher);
}

#[cfg(test)]
#[cfg(any(feature = "worker-sidekiq", feature = "worker-pg"))]
mod tests {
    use crate::testing::snapshot::TestCase;
    use crate::worker::job::{Job, JobMetadata};
    use cron::Schedule;
    use insta::{assert_json_snapshot, assert_snapshot};
    use rstest::{fixture, rstest};
    use std::hash::DefaultHasher;
    use std::hash::Hasher;
    use std::str::FromStr;

    #[fixture]
    fn case() -> TestCase {
        Default::default()
    }

    #[rstest]
    #[case("a", Schedule::from_str("* * * * * *").unwrap(), serde_json::json!({"foo": "bar"}))]
    #[case("b", Schedule::from_str("*/10 * * * * *").unwrap(), serde_json::json!({"foo": "baz"}))]
    #[cfg_attr(coverage_nightly, coverage(off))]
    fn periodic_hash(
        _case: TestCase,
        #[case] name: &str,
        #[case] schedule: Schedule,
        #[case] value: serde_json::Value,
    ) {
        let mut hasher = DefaultHasher::new();
        super::periodic_hash(&mut hasher, name, &schedule, &value);
        assert_snapshot!(hasher.finish());
    }

    #[test]
    #[cfg_attr(coverage_nightly, coverage(off))]
    fn job_ser_and_deser() {
        let job = Job::builder()
            .args(serde_json::json!({"foo": "bar"}))
            .metadata(JobMetadata::builder().worker_name("foo").build())
            .build();

        let ser = serde_json::to_value(&job).unwrap();

        let job_deser: Job = serde_json::from_value(ser).unwrap();

        assert_eq!(job, job_deser);
    }

    #[test]
    #[cfg_attr(coverage_nightly, coverage(off))]
    fn job_serde() {
        let _case = TestCase::new();

        let job = Job::builder()
            .args(serde_json::json!({"foo": "bar"}))
            .metadata(JobMetadata::builder().worker_name("foo").build())
            .build();

        assert_json_snapshot!(job);
    }
}