wfe-core 1.9.2

Core traits, models, builder, and executor for the WFE workflow engine
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
124
125
126
127
128
129
130
131

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
/// Lifecycleevent.
pub struct LifecycleEvent {
    /// Event time utc.
    pub event_time_utc: DateTime<Utc>,
    /// Workflow instance id.
    pub workflow_instance_id: String,
    /// Workflow definition id.
    pub workflow_definition_id: String,
    /// Version.
    pub version: u32,
    /// Reference.
    pub reference: Option<String>,
    /// Event type.
    pub event_type: LifecycleEventType,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
/// Lifecycleeventtype.
pub enum LifecycleEventType {
    /// Started.
    Started,
    /// Resumed.
    Resumed,
    /// Suspended.
    Suspended,
    /// Completed.
    Completed,
    /// Terminated.
    Terminated,
    /// Error.
    Error {
        message: String,
    },
    /// Stepstarted.
    StepStarted {
        step_id: usize,
        step_name: Option<String>,
    },
    /// Stepcompleted.
    StepCompleted {
        step_id: usize,
        step_name: Option<String>,
    },
}

impl LifecycleEvent {
    pub fn new(
        workflow_instance_id: impl Into<String>,
        workflow_definition_id: impl Into<String>,
        version: u32,
        event_type: LifecycleEventType,
    ) -> Self {
        Self {
            event_time_utc: Utc::now(),
            workflow_instance_id: workflow_instance_id.into(),
            workflow_definition_id: workflow_definition_id.into(),
            version,
            reference: None,
            event_type,
        }
    }
}

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

    #[test]
    fn lifecycle_event_types_are_distinct() {
        assert_ne!(LifecycleEventType::Started, LifecycleEventType::Completed);
    }

    #[test]
    fn serde_round_trip_simple_variant() {
        let event = LifecycleEvent::new("wf-1", "def-1", 1, LifecycleEventType::Started);
        let json = serde_json::to_string(&event).unwrap();
        let deserialized: LifecycleEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(
            event.workflow_instance_id,
            deserialized.workflow_instance_id
        );
        assert_eq!(event.event_type, deserialized.event_type);
    }

    #[test]
    fn serde_round_trip_error_variant() {
        let event = LifecycleEvent::new(
            "wf-1",
            "def-1",
            1,
            LifecycleEventType::Error {
                message: "boom".into(),
            },
        );
        let json = serde_json::to_string(&event).unwrap();
        let deserialized: LifecycleEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(
            deserialized.event_type,
            LifecycleEventType::Error {
                message: "boom".into()
            }
        );
    }

    #[test]
    fn serde_round_trip_step_variant() {
        let event = LifecycleEvent::new(
            "wf-1",
            "def-1",
            1,
            LifecycleEventType::StepStarted {
                step_id: 3,
                step_name: Some("ProcessOrder".into()),
            },
        );
        let json = serde_json::to_string(&event).unwrap();
        let deserialized: LifecycleEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(
            deserialized.event_type,
            LifecycleEventType::StepStarted {
                step_id: 3,
                step_name: Some("ProcessOrder".into()),
            }
        );
    }
}