runledger-core 0.1.0

Core contracts and types for the Runledger durable job and workflow 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
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
132
133
134
135
136
137
138
139
140
141
142
143
144

use std::fmt;

use super::dag_validation::WorkflowDagValidationError;

/// Error returned when building workflow enqueue payloads.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum WorkflowBuildError {
    BlankWorkflowType,
    EmptySteps,
    BlankStepKey {
        step_index: Option<usize>,
    },
    BlankStepJobType {
        step_key: String,
    },
    ExternalStepJobTypeNotAllowed {
        step_key: String,
    },
    ExternalStepQueueSettingsNotAllowed {
        step_key: String,
    },
    BlankDependencyStepKey {
        step_key: String,
    },
    DuplicateStepKey {
        step_key: String,
    },
    MissingDependency {
        step_key: String,
        prerequisite_step_key: String,
    },
    DuplicateDependency {
        step_key: String,
        prerequisite_step_key: String,
    },
    SelfDependency {
        step_key: String,
    },
    CycleDetected,
}

impl From<WorkflowDagValidationError> for WorkflowBuildError {
    fn from(error: WorkflowDagValidationError) -> Self {
        match error {
            WorkflowDagValidationError::EmptySteps => Self::EmptySteps,
            WorkflowDagValidationError::BlankWorkflowType => Self::BlankWorkflowType,
            WorkflowDagValidationError::BlankStepKey { step_index } => Self::BlankStepKey {
                step_index: Some(step_index),
            },
            WorkflowDagValidationError::BlankStepJobType { step_key } => {
                Self::BlankStepJobType { step_key }
            }
            WorkflowDagValidationError::ExternalStepJobTypeNotAllowed { step_key } => {
                Self::ExternalStepJobTypeNotAllowed { step_key }
            }
            WorkflowDagValidationError::ExternalStepQueueSettingsNotAllowed { step_key } => {
                Self::ExternalStepQueueSettingsNotAllowed { step_key }
            }
            WorkflowDagValidationError::BlankDependencyStepKey { step_key } => {
                Self::BlankDependencyStepKey { step_key }
            }
            WorkflowDagValidationError::DuplicateStepKey { step_key } => {
                Self::DuplicateStepKey { step_key }
            }
            WorkflowDagValidationError::MissingDependency {
                step_key,
                prerequisite_step_key,
            } => Self::MissingDependency {
                step_key,
                prerequisite_step_key,
            },
            WorkflowDagValidationError::SelfDependency { step_key } => {
                Self::SelfDependency { step_key }
            }
            WorkflowDagValidationError::DuplicateDependency {
                step_key,
                prerequisite_step_key,
            } => Self::DuplicateDependency {
                step_key,
                prerequisite_step_key,
            },
            WorkflowDagValidationError::CycleDetected => Self::CycleDetected,
        }
    }
}

impl fmt::Display for WorkflowBuildError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::BlankWorkflowType => write!(f, "workflow_type must be non-empty"),
            Self::EmptySteps => write!(f, "workflow must include at least one step"),
            Self::BlankStepKey {
                step_index: Some(step_index),
            } => {
                write!(f, "step key at index {step_index} must be non-empty")
            }
            Self::BlankStepKey { step_index: None } => {
                write!(f, "step key must be non-empty")
            }
            Self::BlankStepJobType { step_key } => {
                write!(f, "job_type for step '{step_key}' must be non-empty")
            }
            Self::ExternalStepJobTypeNotAllowed { step_key } => {
                write!(f, "external step '{step_key}' cannot define a job_type")
            }
            Self::ExternalStepQueueSettingsNotAllowed { step_key } => {
                write!(f, "external step '{step_key}' cannot define queue settings")
            }
            Self::BlankDependencyStepKey { step_key } => {
                write!(
                    f,
                    "dependency prerequisite step key for step '{step_key}' must be non-empty"
                )
            }
            Self::DuplicateStepKey { step_key } => {
                write!(f, "duplicate step key '{step_key}'")
            }
            Self::MissingDependency {
                step_key,
                prerequisite_step_key,
            } => {
                write!(
                    f,
                    "step '{step_key}' references missing prerequisite step '{prerequisite_step_key}'"
                )
            }
            Self::DuplicateDependency {
                step_key,
                prerequisite_step_key,
            } => {
                write!(
                    f,
                    "step '{step_key}' has duplicate dependency on '{prerequisite_step_key}'"
                )
            }
            Self::SelfDependency { step_key } => {
                write!(f, "step '{step_key}' cannot depend on itself")
            }
            Self::CycleDetected => write!(f, "workflow contains at least one dependency cycle"),
        }
    }
}

impl std::error::Error for WorkflowBuildError {}