ironflow 0.5.0

Event-sourced workflow engine for durable, long-running processes
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

//! Timer test workflow for testing timer scheduling and cancellation mechanics.
//!
//! Tests framework timer functionality:
//! - Scheduling timers with `Timer::after()` and named keys
//! - Cancelling timers before they fire
//! - Timer-triggered inputs

use std::borrow::Cow;

use async_trait::async_trait;
use ironflow::{Decision, EffectContext, EffectHandler, HasWorkflowId, NonEmpty, Timer, Workflow};
use serde::{Deserialize, Serialize};
use time::OffsetDateTime;

pub struct TimerTestWorkflow;

#[derive(Debug, Clone, Default, Serialize)]
pub struct TimerTestState {
    pub started: bool,
    pub completed: bool,
    pub timed_out: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize, HasWorkflowId)]
#[serde(tag = "type")]
#[workflow_id(id)]
pub enum TimerTestInput {
    /// Start workflow and schedule a timer.
    Start {
        id: String,
        /// Timer duration in seconds.
        timeout_secs: u64,
        /// Optional timer key for cancellation.
        timer_key: Option<String>,
    },
    /// Complete workflow (optionally cancel timer).
    Complete {
        id: String,
        /// Timer key to cancel (if any).
        cancel_timer_key: Option<String>,
    },
    /// Timer fired (routed from timer worker).
    Timeout { id: String },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum TimerTestEvent {
    Started,
    Completed,
    TimedOut,
    TimerCancelled { key: String },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum TimerTestEffect {
    /// Side effect that routes completion back.
    Process,
}

impl Workflow for TimerTestWorkflow {
    type State = TimerTestState;
    type Input = TimerTestInput;
    type Event = TimerTestEvent;
    type Effect = TimerTestEffect;
    type Rejection = Cow<'static, str>;

    const TYPE: &'static str = "timer_test";

    fn evolve(mut state: Self::State, event: Self::Event) -> Self::State {
        match event {
            TimerTestEvent::Started => state.started = true,
            TimerTestEvent::Completed => state.completed = true,
            TimerTestEvent::TimedOut => state.timed_out = true,
            TimerTestEvent::TimerCancelled { .. } => {}
        }
        state
    }

    fn decide(
        _now: OffsetDateTime,
        _state: &Self::State,
        input: &Self::Input,
    ) -> Decision<Self::Event, Self::Effect, Self::Input, Self::Rejection> {
        match input {
            TimerTestInput::Start {
                id,
                timeout_secs,
                timer_key,
            } => {
                let mut timer = Timer::after(
                    std::time::Duration::from_secs(*timeout_secs),
                    TimerTestInput::Timeout { id: id.clone() },
                );
                if let Some(key) = timer_key {
                    timer = timer.with_key(key);
                }
                Decision::accept(TimerTestEvent::Started)
                    .with_effect(TimerTestEffect::Process)
                    .with_timer(timer)
            }
            TimerTestInput::Complete {
                cancel_timer_key, ..
            } => {
                if let Some(key) = cancel_timer_key {
                    let events = NonEmpty::collect(vec![
                        TimerTestEvent::Completed,
                        TimerTestEvent::TimerCancelled { key: key.clone() },
                    ])
                    .expect("non-empty");
                    Decision::accept_events(events).cancel_timer(key)
                } else {
                    Decision::accept(TimerTestEvent::Completed)
                }
            }
            TimerTestInput::Timeout { .. } => Decision::accept(TimerTestEvent::TimedOut),
        }
    }
}

/// Handler that routes completion back to workflow.
#[derive(Default)]
pub struct TimerTestHandler;

#[async_trait]
impl EffectHandler for TimerTestHandler {
    type Workflow = TimerTestWorkflow;
    type Error = std::convert::Infallible;

    async fn handle(
        &self,
        _effect: &TimerTestEffect,
        ctx: &EffectContext,
    ) -> Result<Option<TimerTestInput>, Self::Error> {
        Ok(Some(TimerTestInput::Complete {
            id: ctx.workflow.workflow_id().to_string(),
            cancel_timer_key: Some("timeout".into()),
        }))
    }
}