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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
//! Human approval gate for [`WorkflowContext`].
use chrono::{TimeDelta, Utc};
use serde_json::{json, to_value};
use tracing::info;
use ironflow_store::models::{NewStep, StepKind, StepStatus, StepUpdate, step_trace_id};
use crate::config::{ApprovalConfig, Approvers};
use crate::context::WorkflowContext;
use crate::context::lifecycle::check_replay_identity;
use crate::error::EngineError;
use crate::executor::ApprovalOutcome;
use crate::notify::{WorkflowApprovalRequiredEvent, WorkflowEvent};
use crate::plan::lock_plan;
impl WorkflowContext {
/// Create a human approval gate.
///
/// On first execution, records an approval step and returns
/// [`EngineError::ApprovalRequired`] to suspend the run. The engine
/// transitions the run to `AwaitingApproval`.
///
/// On resume (after a human approved via the API), the approval step
/// is replayed: it is marked as `Completed` and execution continues
/// past it. Multiple approval gates in the same handler work -- each
/// one pauses and resumes independently.
///
/// When the config carries an SLA
/// ([`ApprovalConfig::with_deadline`](crate::config::ApprovalConfig::with_deadline),
/// or the legacy `with_timeout_seconds`), the deadline is persisted on the
/// step so the API server's escalator can apply the configured
/// [`EscalationPolicy`](crate::config::EscalationPolicy) when it fires. The
/// timer is cleared as soon as the gate resolves.
///
/// A [`StepInterceptor`](crate::executor::StepInterceptor) wired into the
/// context resolves the gate inline instead of suspending: the step is
/// recorded, then completed or rejected without waiting for a human. This
/// is what [`crate::testing::TestEngine`] uses to run gated handlers end to
/// end.
///
/// When the config carries [`Approvers`]
/// ([`ApprovalConfig::requiring`]),
/// they are recorded on the step as an
/// [`ApprovalRequirement`](crate::config::ApprovalRequirement) when the gate
/// opens. That record stays the source of truth on replay and resume: the
/// approvers the handler computes on a later execution are ignored. A config
/// without approvers stores no requirement.
///
/// # Errors
///
/// Returns [`EngineError::ApprovalRequired`] to pause the run on
/// first execution. Returns [`EngineError::ApprovalRejected`] when an
/// interceptor refuses the gate. Returns [`EngineError::ReplayDivergence`]
/// when the step recorded at this position has a different name or kind.
/// Returns other [`EngineError`] variants on store failures.
///
/// # Examples
///
/// ```no_run
/// use ironflow_engine::context::WorkflowContext;
/// use ironflow_engine::config::{ApprovalConfig, Approvers};
/// use ironflow_engine::error::EngineError;
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct Payment {
/// amount: u64,
/// }
///
/// # async fn example(ctx: &mut WorkflowContext) -> Result<(), EngineError> {
/// let payment: Payment = ctx.input().await?;
/// let approvers = match payment.amount {
/// a if a > 10_000 => Approvers::at_least(2).from_groups(["finance"]).because("amount > 10k"),
/// _ => Approvers::any(),
/// };
/// ctx.approval("payment-gate", ApprovalConfig::new("Release the payment?").requiring(approvers))
/// .await?;
/// // Execution continues here after approval
/// # Ok(())
/// # }
/// ```
pub async fn approval(
&mut self,
name: &str,
config: ApprovalConfig,
) -> Result<(), EngineError> {
// Plan mode: record the gate and continue. Planning must never suspend,
// so this comes before the `ApprovalRequired` path below.
if let Some(plan) = self.plan().cloned() {
self.position += 1;
let mut recorder = lock_plan(&plan);
if recorder.record(name, StepKind::Approval, &self.workflow_name, None) {
recorder.set_last(vec![name.to_string()]);
}
return Ok(());
}
let position = self.position;
self.position += 1;
// Replay: if this approval step exists from a prior execution,
// the run was approved -- mark it completed (if not already) and continue.
if let Some(existing) = self.replay_steps.get(&position) {
check_replay_identity(existing, position, name, &StepKind::Approval)?;
if existing.status.state == StepStatus::AwaitingApproval {
self.store
.update_step(
existing.id,
StepUpdate {
status: Some(StepStatus::Completed),
completed_at: Some(Utc::now()),
// An approved gate must never be escalated afterwards.
clear_approval_deadline: true,
..StepUpdate::default()
},
)
.await?;
}
self.last_step_ids = vec![existing.id];
info!(
run_id = %self.run_id,
step = %name,
position,
"approval step replayed (approved)"
);
return Ok(());
}
// Carried over: a human already approved this gate in an earlier
// attempt. Record a fresh step in the current attempt so that each
// attempt keeps a complete, self-contained DAG, and continue.
if let Some(&granted_in) = self.granted_approvals.get(&position) {
let trace_id = step_trace_id(self.run_id, name, position);
let step = self
.store
.create_step(NewStep {
run_id: self.run_id,
trace_id,
name: name.to_string(),
kind: StepKind::Approval,
position,
input: Some(to_value(&config)?),
is_error_handler: false,
})
.await?;
let now = Utc::now();
self.start_step(step.id, now).await?;
self.store
.update_step(
step.id,
StepUpdate {
status: Some(StepStatus::Completed),
output: Some(json!({"approved_in_attempt": granted_in})),
completed_at: Some(now),
..StepUpdate::default()
},
)
.await?;
self.last_step_ids = vec![step.id];
info!(
run_id = %self.run_id,
step = %name,
position,
granted_in_attempt = granted_in,
attempt = self.attempt,
"approval carried over from a previous attempt"
);
return Ok(());
}
// The approvers are recorded only when the gate opens, never on replay
// or carry-over: the stored requirement is the source of truth from here.
let requirement = config.approvers().map(Approvers::to_requirement);
if let Some(requirement) = &requirement {
info!(
run_id = %self.run_id,
step = %name,
reason = ?requirement.reason,
required_approvers = requirement.required_approvers,
approver_groups = ?requirement.approver_groups,
"approval requirement recorded"
);
}
// An interceptor resolves the gate inline: the run neither suspends nor
// waits for a human.
if let Some(interceptor) = self.interceptor.clone()
&& let Some(outcome) = interceptor.intercept_approval(name, &config)
{
let trace_id = step_trace_id(self.run_id, name, position);
let step = self
.store
.create_step(NewStep {
run_id: self.run_id,
trace_id,
name: name.to_string(),
kind: StepKind::Approval,
position,
input: Some(to_value(&config)?),
is_error_handler: false,
})
.await?;
let now = Utc::now();
self.start_step(step.id, now).await?;
self.last_step_ids = vec![step.id];
return match outcome {
ApprovalOutcome::Approved => {
self.store
.update_step(
step.id,
StepUpdate {
status: Some(StepStatus::Completed),
output: Some(json!({"approved_by": "step-interceptor"})),
completed_at: Some(now),
approval_requirement: requirement.clone(),
..StepUpdate::default()
},
)
.await?;
info!(
run_id = %self.run_id,
step = %name,
position,
"approval granted by the step interceptor"
);
Ok(())
}
ApprovalOutcome::Rejected { reason } => {
// The step FSM only reaches Rejected from AwaitingApproval.
self.store
.update_step(
step.id,
StepUpdate {
status: Some(StepStatus::AwaitingApproval),
approval_requirement: requirement.clone(),
..StepUpdate::default()
},
)
.await?;
self.store
.update_step(
step.id,
StepUpdate {
status: Some(StepStatus::Rejected),
error: Some(reason.clone()),
completed_at: Some(Utc::now()),
..StepUpdate::default()
},
)
.await?;
info!(
run_id = %self.run_id,
step = %name,
position,
%reason,
"approval rejected by the step interceptor"
);
Err(EngineError::ApprovalRejected {
run_id: self.run_id,
step_id: step.id,
reason,
})
}
};
}
// First execution: create the approval step and suspend.
let trace_id = step_trace_id(self.run_id, name, position);
let step = self
.store
.create_step(NewStep {
run_id: self.run_id,
trace_id,
name: name.to_string(),
kind: StepKind::Approval,
position,
input: Some(to_value(&config)?),
is_error_handler: false,
})
.await?;
self.start_step(step.id, Utc::now()).await?;
// Transition the step to AwaitingApproval so it reflects the suspended
// state on the dashboard, and arm the SLA timer in the same update. The
// deadline lives in the store, so it survives an API or worker restart.
let deadline_at = config
.effective_deadline_secs()
.map(|secs| Utc::now() + TimeDelta::seconds(secs as i64));
self.store
.update_step(
step.id,
StepUpdate {
status: Some(StepStatus::AwaitingApproval),
approval_deadline_at: deadline_at,
approval_stage: Some(0),
approval_assignee: config.assignee().cloned(),
approval_requirement: requirement,
..StepUpdate::default()
},
)
.await?;
self.last_step_ids = vec![step.id];
if let Some(ref bus) = self.event_bus {
bus.publish(
self.run_id,
WorkflowEvent::ApprovalRequired(WorkflowApprovalRequiredEvent {
step_name: name.to_string(),
step_index: position,
approval_id: step.id,
}),
);
}
Err(EngineError::ApprovalRequired {
run_id: self.run_id,
step_id: step.id,
message: config.message().to_string(),
})
}
}