wfe-core 1.10.0

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

//! Built-in control-flow primitives for workflow definitions.
//!
//! These steps implement [`StepBody`](crate::traits::step::StepBody) and can be
//! composed via the builder API to create loops, conditionals, parallel branches,
//! and more without writing custom code.
//!
//! | Primitive | Builder method | Description |
//! |-----------|---------------|-------------|
//! | [`DecideStep`](crate::primitives::DecideStep) | — (used by `if_do`) | Return an outcome value for routing |
//! | [`DelayStep`](crate::primitives::DelayStep) | `StepBuilder::delay` | Sleep for a duration |
//! | [`EndStep`](crate::primitives::EndStep) | `StepBuilder::end_workflow` | Terminate the workflow |
//! | [`ForEachStep`](crate::primitives::ForEachStep) | `StepBuilder::for_each` | Iterate over a collection |
//! | [`IfStep`](crate::primitives::IfStep) | `StepBuilder::if_do` | Conditional branch |
//! | [`PollEndpointStep`](crate::primitives::PollEndpointStep) | — | Poll an HTTP endpoint until success |
//! | [`RecurStep`](crate::primitives::RecurStep) | — | Schedule a recurring workflow |
//! | [`SagaContainerStep`](crate::primitives::SagaContainerStep) | `StepBuilder::saga` | Saga with compensation steps |
//! | [`ScheduleStep`](crate::primitives::ScheduleStep) | — | Schedule a command for later execution |
//! | [`SequenceStep`](crate::primitives::SequenceStep) | — | Run a child workflow as a step |
//! | [`SubWorkflowStep`](crate::primitives::SubWorkflowStep) | `StepBuilder::add_child` | Embed a child workflow |
//! | [`WaitForStep`](crate::primitives::WaitForStep) | `StepBuilder::wait_for` | Block until an event arrives |
//! | [`WhileStep`](crate::primitives::WhileStep) | `StepBuilder::while_do` | Loop while a condition holds |

pub mod decide;
pub mod delay;
pub mod end_step;
pub mod foreach_step;
pub mod if_step;
pub mod poll_endpoint;
pub mod recur;
pub mod saga_container;
pub mod schedule;
pub mod sequence;
pub mod sub_workflow;
pub mod wait_for;
pub mod while_step;

pub use decide::DecideStep;
pub use delay::DelayStep;
pub use end_step::EndStep;
pub use foreach_step::ForEachStep;
pub use if_step::IfStep;
pub use poll_endpoint::PollEndpointStep;
pub use recur::RecurStep;
pub use saga_container::SagaContainerStep;
pub use schedule::ScheduleStep;
pub use sequence::SequenceStep;
pub use sub_workflow::SubWorkflowStep;
pub use wait_for::WaitForStep;
pub use while_step::WhileStep;

#[cfg(test)]
mod test_helpers {
    use crate::models::{ExecutionPointer, WorkflowInstance, WorkflowStep};
    use crate::traits::step::StepExecutionContext;
    use tokio_util::sync::CancellationToken;

/// Make context.
    pub fn make_context<'a>(
        pointer: &'a ExecutionPointer,
        step: &'a WorkflowStep,
        workflow: &'a WorkflowInstance,
    ) -> StepExecutionContext<'a> {
        StepExecutionContext {
            definition: None,
            item: None,
            execution_pointer: pointer,
            persistence_data: pointer.persistence_data.as_ref(),
            step,
            workflow,
            cancellation_token: CancellationToken::new(),
            host_context: None,
            log_sink: None,
            artifact_store: None,
            artifact_volume: None,
            artifact_package: None,
            persistence: None,
        }
    }

/// Default workflow.
    pub fn default_workflow() -> WorkflowInstance {
        WorkflowInstance::new("test-workflow", 1, serde_json::json!({}))
    }

/// Default step.
    pub fn default_step() -> WorkflowStep {
        WorkflowStep::new(0, "TestStep")
    }
}