1use std::collections::HashMap;
10use std::fmt;
11use std::sync::Arc;
12use std::time::Instant;
13
14use chrono::{DateTime, TimeDelta, Utc};
15use rust_decimal::Decimal;
16use serde_json::Value;
17use tracing::{error, info, warn};
18use uuid::Uuid;
19
20#[cfg(feature = "prometheus")]
21use ironflow_core::metric_names::{
22 RUN_BUDGET_EXCEEDED_TOTAL, RUN_COST_USD, RUN_DURATION_SECONDS, RUNS_ACTIVE, RUNS_TOTAL,
23};
24use ironflow_core::provider::AgentProvider;
25use ironflow_store::error::StoreError;
26use ironflow_store::models::{
27 NewRun, Run, RunActor, RunCreation, RunFilter, RunStatus, RunUpdate, StepStatus, StepUpdate,
28 TriggerKind,
29};
30use ironflow_store::store::Store;
31#[cfg(feature = "prometheus")]
32use metrics::{counter, gauge, histogram};
33
34use crate::artifact::ArtifactSink;
35use crate::budget::{BudgetConfig, month_start};
36use crate::context::WorkflowContext;
37use crate::error::EngineError;
38use crate::executor::StepResult;
39use crate::guard::{WorkflowGuardConfig, new_shared_guard_state};
40use crate::handler::{WorkflowHandler, WorkflowInfo};
41use crate::log_sender::LogSender;
42use crate::notify::{Event, EventPublisher, EventSubscriber, WorkflowEventBus};
43use crate::retry_policy::{backoff_for_retry, is_run_retryable};
44use crate::schedule::CronSchedule;
45
46#[derive(Debug, Clone)]
65pub struct WorkflowResult {
66 pub run: Run,
68 pub steps: Vec<StepResult>,
70}
71
72#[derive(Debug, Clone, Default)]
91pub struct EnqueueOptions {
92 pub max_retries: u32,
94 pub labels: HashMap<String, String>,
96 pub scheduled_at: Option<DateTime<Utc>>,
99 pub max_cost_usd: Option<Decimal>,
103 pub created_by: Option<RunActor>,
106 pub idempotency_key: Option<String>,
112}
113
114pub struct Engine {
155 store: Arc<dyn Store>,
156 provider: Arc<dyn AgentProvider>,
157 handlers: HashMap<String, Arc<dyn WorkflowHandler>>,
158 event_publisher: EventPublisher,
159 log_sender: Option<LogSender>,
160 budget: BudgetConfig,
161 artifact_sink: Option<Arc<dyn ArtifactSink>>,
162 guard_config: Option<WorkflowGuardConfig>,
163 event_bus: Option<WorkflowEventBus>,
164}
165
166fn validate_category(handler_name: &str, category: &str) -> Result<(), EngineError> {
176 let reject = |reason: &str| {
177 Err(EngineError::InvalidWorkflow(format!(
178 "handler '{handler_name}' has invalid category '{category}': {reason}"
179 )))
180 };
181
182 if category.is_empty() {
183 return reject("empty category");
184 }
185 if category.starts_with('/') {
186 return reject("leading '/'");
187 }
188 if category.ends_with('/') {
189 return reject("trailing '/'");
190 }
191 for segment in category.split('/') {
192 if segment.is_empty() {
193 return reject("empty segment (double '/')");
194 }
195 if segment.trim().is_empty() {
196 return reject("whitespace-only segment");
197 }
198 }
199 Ok(())
200}
201
202impl Engine {
203 pub fn new(store: Arc<dyn Store>, provider: Arc<dyn AgentProvider>) -> Self {
219 Self {
220 store,
221 provider,
222 handlers: HashMap::new(),
223 event_publisher: EventPublisher::new(),
224 log_sender: None,
225 budget: BudgetConfig::new(),
226 artifact_sink: None,
227 guard_config: None,
228 event_bus: None,
229 }
230 }
231
232 pub fn with_budget_config(mut self, budget: BudgetConfig) -> Self {
253 self.budget = budget;
254 self
255 }
256
257 pub fn budget_config(&self) -> &BudgetConfig {
259 &self.budget
260 }
261
262 pub fn with_guard_config(mut self, config: WorkflowGuardConfig) -> Self {
284 self.guard_config = Some(config);
285 self
286 }
287
288 pub fn guard_config(&self) -> Option<&WorkflowGuardConfig> {
290 self.guard_config.as_ref()
291 }
292
293 pub fn set_log_sender(&mut self, sender: LogSender) {
299 self.log_sender = Some(sender);
300 }
301
302 pub fn set_artifact_sink(&mut self, sink: Arc<dyn ArtifactSink>) {
320 self.artifact_sink = Some(sink);
321 }
322
323 pub fn artifact_sink(&self) -> Option<&Arc<dyn ArtifactSink>> {
325 self.artifact_sink.as_ref()
326 }
327
328 pub fn set_event_bus(&mut self, bus: WorkflowEventBus) {
345 self.event_bus = Some(bus);
346 }
347
348 pub fn event_bus(&self) -> Option<&WorkflowEventBus> {
350 self.event_bus.as_ref()
351 }
352
353 pub fn store(&self) -> &Arc<dyn Store> {
355 &self.store
356 }
357
358 pub fn provider(&self) -> &Arc<dyn AgentProvider> {
360 &self.provider
361 }
362
363 fn build_context(&self, run: &Run) -> WorkflowContext {
372 let handlers = self.handlers.clone();
373 let resolver: crate::context::HandlerResolver =
374 Arc::new(move |name: &str| handlers.get(name).cloned());
375 let mut ctx = WorkflowContext::with_handler_resolver(
376 run.id,
377 run.workflow_name.clone(),
378 self.store.clone(),
379 self.provider.clone(),
380 resolver,
381 );
382 ctx.carry_over_run_totals(run.retry_count + 1, run.cost_usd, run.duration_ms);
383 ctx.set_max_cost_usd(run.max_cost_usd);
384 if let Some(ref sender) = self.log_sender {
385 ctx.set_log_sender(sender.clone());
386 }
387 if let Some(ref sink) = self.artifact_sink {
388 ctx.set_artifact_sink(sink.clone());
389 }
390 if let Some(ref bus) = self.event_bus {
391 ctx.set_event_bus(bus.clone());
392 }
393 ctx
394 }
395
396 fn build_context_with_guard(
402 &self,
403 run: &Run,
404 handler: &dyn WorkflowHandler,
405 ) -> WorkflowContext {
406 let mut ctx = self.build_context(run);
407 let guard_config = handler.guard_config().or_else(|| self.guard_config.clone());
408 if let Some(config) = guard_config {
409 ctx.set_guard(config, new_shared_guard_state());
410 }
411 ctx
412 }
413
414 async fn check_monthly_quota(&self, workflow_name: &str) -> Result<(), EngineError> {
425 let Some(limit) = self.budget.monthly_cost_limit_usd else {
426 return Ok(());
427 };
428
429 let stats = self
430 .store
431 .get_stats(RunFilter {
432 created_after: Some(month_start(Utc::now())),
433 ..RunFilter::default()
434 })
435 .await?;
436
437 if stats.total_cost_usd < limit {
438 return Ok(());
439 }
440
441 warn!(
442 workflow = %workflow_name,
443 limit_usd = %limit,
444 spent_usd = %stats.total_cost_usd,
445 "monthly cost quota exhausted, refusing new run"
446 );
447
448 #[cfg(feature = "prometheus")]
449 counter!(
450 RUN_BUDGET_EXCEEDED_TOTAL,
451 "workflow" => workflow_name.to_string(),
452 "scope" => "monthly",
453 )
454 .increment(1);
455
456 Err(EngineError::MonthlyBudgetExceeded {
457 limit_usd: limit,
458 spent_usd: stats.total_cost_usd,
459 })
460 }
461
462 pub fn register(&mut self, handler: impl WorkflowHandler + 'static) -> Result<(), EngineError> {
506 let name = handler.name().to_string();
507 if self.handlers.contains_key(&name) {
508 return Err(EngineError::InvalidWorkflow(format!(
509 "handler '{}' already registered",
510 name
511 )));
512 }
513 if let Some(category) = handler.category() {
514 validate_category(&name, category)?;
515 }
516 self.handlers.insert(name, Arc::new(handler));
517 Ok(())
518 }
519
520 pub fn register_boxed(&mut self, handler: Box<dyn WorkflowHandler>) -> Result<(), EngineError> {
527 let name = handler.name().to_string();
528 if self.handlers.contains_key(&name) {
529 return Err(EngineError::InvalidWorkflow(format!(
530 "handler '{}' already registered",
531 name
532 )));
533 }
534 if let Some(category) = handler.category() {
535 validate_category(&name, category)?;
536 }
537 self.handlers.insert(name, Arc::from(handler));
538 Ok(())
539 }
540
541 pub fn get_handler(&self, name: &str) -> Option<&Arc<dyn WorkflowHandler>> {
543 self.handlers.get(name)
544 }
545
546 pub fn handler_names(&self) -> Vec<&str> {
548 self.handlers.keys().map(|s| s.as_str()).collect()
549 }
550
551 pub fn handler_info(&self, name: &str) -> Option<WorkflowInfo> {
553 self.handlers.get(name).map(|h| h.describe())
554 }
555
556 pub fn scheduled_handlers(&self) -> Vec<(&str, &CronSchedule)> {
580 self.handlers
581 .iter()
582 .filter_map(|(name, handler)| handler.schedule().map(|sched| (name.as_str(), sched)))
583 .collect()
584 }
585
586 pub fn subscribe(
611 &mut self,
612 subscriber: impl EventSubscriber + 'static,
613 event_types: &[&'static str],
614 ) {
615 self.event_publisher.subscribe(subscriber, event_types);
616 }
617
618 pub fn event_publisher(&self) -> &EventPublisher {
623 &self.event_publisher
624 }
625
626 #[tracing::instrument(name = "engine.run_handler", skip_all, fields(workflow = %handler_name))]
656 pub async fn run_handler(
657 &self,
658 handler_name: &str,
659 trigger: TriggerKind,
660 payload: Value,
661 ) -> Result<WorkflowResult, EngineError> {
662 let handler = self
663 .handlers
664 .get(handler_name)
665 .ok_or_else(|| {
666 EngineError::InvalidWorkflow(format!("no handler registered: {handler_name}"))
667 })?
668 .clone();
669
670 self.check_monthly_quota(handler_name).await?;
671
672 let handler_version = handler.version().map(str::to_string);
673 let max_cost_usd = self
674 .budget
675 .resolve_run_cap(None, handler.default_max_cost_usd());
676 let run = self
677 .store
678 .create_run(NewRun {
679 created_by: None,
680 workflow_name: handler_name.to_string(),
681 trigger,
682 payload,
683 max_retries: 0,
684 handler_version,
685 labels: handler.default_labels(),
686 scheduled_at: None,
687 idempotency_key: None,
688 max_cost_usd,
689 })
690 .await?
691 .into_run();
692
693 let run_id = run.id;
694 info!(run_id = %run_id, handler_version = run.handler_version.as_deref().unwrap_or(""), "run created");
695
696 self.store
697 .update_run_status(run_id, RunStatus::Running)
698 .await?;
699
700 #[cfg(feature = "prometheus")]
701 gauge!(RUNS_ACTIVE, "workflow" => handler_name.to_string()).increment(1.0);
702
703 let run_start = Instant::now();
704 let mut ctx = self.build_context_with_guard(&run, handler.as_ref());
705
706 let result = handler.execute(&mut ctx).await;
707 self.finalize_run(run_id, handler_name, result, &ctx, run_start, run.labels)
708 .await
709 }
710
711 #[tracing::instrument(name = "engine.enqueue_handler", skip_all, fields(workflow = %handler_name))]
722 pub async fn enqueue_handler(
723 &self,
724 handler_name: &str,
725 trigger: TriggerKind,
726 payload: Value,
727 max_retries: u32,
728 ) -> Result<Run, EngineError> {
729 self.enqueue_handler_with_options(
730 handler_name,
731 trigger,
732 payload,
733 EnqueueOptions {
734 max_retries,
735 ..Default::default()
736 },
737 )
738 .await
739 .map(RunCreation::into_run)
740 }
741
742 #[tracing::instrument(name = "engine.enqueue_handler_with_options", skip_all, fields(workflow = %handler_name))]
787 pub async fn enqueue_handler_with_options(
788 &self,
789 handler_name: &str,
790 trigger: TriggerKind,
791 payload: Value,
792 options: EnqueueOptions,
793 ) -> Result<RunCreation, EngineError> {
794 let EnqueueOptions {
795 max_retries,
796 labels,
797 scheduled_at,
798 max_cost_usd,
799 created_by,
800 idempotency_key,
801 } = options;
802
803 let handler = self.handlers.get(handler_name).ok_or_else(|| {
804 EngineError::InvalidWorkflow(format!("no handler registered: {handler_name}"))
805 })?;
806
807 self.check_monthly_quota(handler_name).await?;
808
809 let handler_version = handler.version().map(str::to_string);
810 let mut merged_labels = handler.default_labels();
811 merged_labels.extend(labels);
812 let resolved_cap = self
813 .budget
814 .resolve_run_cap(max_cost_usd, handler.default_max_cost_usd());
815
816 let creation = self
817 .store
818 .create_run(NewRun {
819 workflow_name: handler_name.to_string(),
820 trigger,
821 payload,
822 max_retries,
823 handler_version,
824 labels: merged_labels,
825 scheduled_at,
826 created_by,
827 idempotency_key,
828 max_cost_usd: resolved_cap,
829 })
830 .await?;
831
832 match &creation {
833 RunCreation::Created(run) => info!(
834 run_id = %run.id,
835 workflow = %handler_name,
836 max_cost_usd = ?resolved_cap,
837 "handler run enqueued"
838 ),
839 RunCreation::Existing(run) => info!(
840 run_id = %run.id,
841 workflow = %handler_name,
842 "idempotent replay, nothing enqueued"
843 ),
844 }
845
846 Ok(creation)
847 }
848
849 #[tracing::instrument(name = "engine.execute_handler_run", skip_all, fields(run_id = %run_id))]
858 pub async fn execute_handler_run(&self, run_id: Uuid) -> Result<WorkflowResult, EngineError> {
859 let run = self
860 .store
861 .get_run(run_id)
862 .await?
863 .ok_or(EngineError::Store(StoreError::RunNotFound(run_id)))?;
864
865 let handler = self
866 .handlers
867 .get(&run.workflow_name)
868 .ok_or_else(|| {
869 EngineError::InvalidWorkflow(format!(
870 "no handler registered: {}",
871 run.workflow_name
872 ))
873 })?
874 .clone();
875
876 #[cfg(feature = "prometheus")]
877 gauge!(RUNS_ACTIVE, "workflow" => run.workflow_name.clone()).increment(1.0);
878
879 let run_start = Instant::now();
880 let mut ctx = self.build_context_with_guard(&run, handler.as_ref());
881
882 if run.retry_count > 0 {
885 ctx.load_replay_steps().await?;
886 }
887
888 let result = handler.execute(&mut ctx).await;
889 self.finalize_run(
890 run_id,
891 &run.workflow_name,
892 result,
893 &ctx,
894 run_start,
895 run.labels,
896 )
897 .await
898 }
899
900 #[tracing::instrument(name = "engine.execute_run", skip_all, fields(run_id = %run_id))]
908 pub async fn execute_run(&self, run_id: Uuid) -> Result<WorkflowResult, EngineError> {
909 self.execute_handler_run(run_id).await
910 }
911
912 #[tracing::instrument(name = "engine.resume_run", skip_all, fields(run_id = %run_id))]
926 pub async fn resume_run(&self, run_id: Uuid) -> Result<WorkflowResult, EngineError> {
927 let run = self
928 .store
929 .get_run(run_id)
930 .await?
931 .ok_or(EngineError::Store(StoreError::RunNotFound(run_id)))?;
932
933 let handler = self
934 .handlers
935 .get(&run.workflow_name)
936 .ok_or_else(|| {
937 EngineError::InvalidWorkflow(format!(
938 "no handler registered: {}",
939 run.workflow_name
940 ))
941 })?
942 .clone();
943
944 info!(run_id = %run_id, workflow = %run.workflow_name, "resuming run after approval");
945
946 let run_start = Instant::now();
947 let mut ctx = self.build_context_with_guard(&run, handler.as_ref());
948 ctx.load_replay_steps().await?;
949
950 let result = handler.execute(&mut ctx).await;
951 self.finalize_run(
952 run_id,
953 &run.workflow_name,
954 result,
955 &ctx,
956 run_start,
957 run.labels,
958 )
959 .await
960 }
961
962 pub async fn fail_or_schedule_retry(
1007 &self,
1008 run_id: Uuid,
1009 error: &str,
1010 retryable: bool,
1011 cost_usd: Option<Decimal>,
1012 duration_ms: Option<u64>,
1013 ) -> Result<RunStatus, EngineError> {
1014 let run = self
1015 .store
1016 .get_run(run_id)
1017 .await?
1018 .ok_or(EngineError::Store(StoreError::RunNotFound(run_id)))?;
1019
1020 let has_attempts_left = run.retry_count < run.max_retries;
1021 let update = if retryable && has_attempts_left {
1022 let backoff = backoff_for_retry(run.retry_count);
1023 let scheduled_at = Utc::now() + TimeDelta::milliseconds(backoff.as_millis() as i64);
1024
1025 info!(
1026 run_id = %run_id,
1027 workflow = %run.workflow_name,
1028 attempt = run.retry_count + 1,
1029 max_retries = run.max_retries,
1030 backoff_secs = backoff.as_secs(),
1031 scheduled_at = %scheduled_at,
1032 "run failed, scheduling retry"
1033 );
1034
1035 RunUpdate {
1036 status: Some(RunStatus::Retrying),
1037 error: Some(error.to_string()),
1038 increment_retry: true,
1039 cost_usd,
1040 duration_ms,
1041 scheduled_at: Some(scheduled_at),
1042 ..RunUpdate::default()
1043 }
1044 } else {
1045 RunUpdate {
1046 status: Some(RunStatus::Failed),
1047 error: Some(error.to_string()),
1048 cost_usd,
1049 duration_ms,
1050 completed_at: Some(Utc::now()),
1051 ..RunUpdate::default()
1052 }
1053 };
1054
1055 let status = update.status.unwrap_or(RunStatus::Failed);
1056 self.store.update_run(run_id, update).await?;
1057 self.fail_orphaned_steps(run_id, error).await?;
1058
1059 Ok(status)
1060 }
1061
1062 pub async fn fail_orphaned_steps(
1076 &self,
1077 run_id: Uuid,
1078 error_message: &str,
1079 ) -> Result<(), EngineError> {
1080 let steps = self.store.list_steps(run_id).await?;
1081 let now = Utc::now();
1082
1083 for step in steps {
1084 if step.status.state.is_terminal() {
1085 continue;
1086 }
1087
1088 let (target_status, error) = match step.status.state {
1089 StepStatus::Running | StepStatus::AwaitingApproval => {
1090 let err = if step.error.is_some() {
1091 None
1092 } else {
1093 Some(error_message.to_string())
1094 };
1095 (StepStatus::Failed, err)
1096 }
1097 StepStatus::Pending => (StepStatus::Skipped, None),
1098 _ => continue,
1099 };
1100
1101 if let Err(e) = self
1102 .store
1103 .update_step(
1104 step.id,
1105 StepUpdate {
1106 status: Some(target_status),
1107 error,
1108 completed_at: Some(now),
1109 ..StepUpdate::default()
1110 },
1111 )
1112 .await
1113 {
1114 warn!(
1115 run_id = %run_id,
1116 step_id = %step.id,
1117 step_name = %step.name,
1118 error = %e,
1119 "failed to cleanup orphaned step"
1120 );
1121 } else {
1122 info!(
1123 run_id = %run_id,
1124 step_id = %step.id,
1125 step_name = %step.name,
1126 from = %step.status.state,
1127 to = %target_status,
1128 "cleaned up orphaned step"
1129 );
1130 }
1131 }
1132
1133 Ok(())
1134 }
1135
1136 async fn finalize_run(
1142 &self,
1143 run_id: Uuid,
1144 workflow_name: &str,
1145 result: Result<(), EngineError>,
1146 ctx: &WorkflowContext,
1147 run_start: Instant,
1148 run_labels: HashMap<String, String>,
1149 ) -> Result<WorkflowResult, EngineError> {
1150 let total_duration = ctx.carried_duration_ms() + run_start.elapsed().as_millis() as u64;
1153 let completed_at = Utc::now();
1154
1155 let final_status;
1156 let final_run;
1157
1158 match result {
1159 Ok(()) => {
1160 final_status = if ctx.has_allowed_failure() {
1161 RunStatus::Warning
1162 } else {
1163 RunStatus::Completed
1164 };
1165 final_run = self
1166 .store
1167 .update_run_returning(
1168 run_id,
1169 RunUpdate {
1170 status: Some(final_status),
1171 cost_usd: Some(ctx.total_cost_usd()),
1172 duration_ms: Some(total_duration),
1173 completed_at: Some(completed_at),
1174 ..RunUpdate::default()
1175 },
1176 )
1177 .await?;
1178
1179 info!(
1180 run_id = %run_id,
1181 status = %final_status,
1182 cost_usd = %ctx.total_cost_usd(),
1183 duration_ms = total_duration,
1184 "run completed"
1185 );
1186 }
1187 Err(EngineError::ApprovalRequired {
1188 run_id: approval_run_id,
1189 step_id,
1190 ref message,
1191 }) => {
1192 final_status = RunStatus::AwaitingApproval;
1193 final_run = self
1194 .store
1195 .update_run_returning(
1196 run_id,
1197 RunUpdate {
1198 status: Some(RunStatus::AwaitingApproval),
1199 cost_usd: Some(ctx.total_cost_usd()),
1200 duration_ms: Some(total_duration),
1201 ..RunUpdate::default()
1202 },
1203 )
1204 .await?;
1205
1206 info!(
1207 run_id = %approval_run_id,
1208 step_id = %step_id,
1209 message = %message,
1210 "run awaiting approval"
1211 );
1212 }
1213 Err(err) => {
1214 let guardrail_stop = matches!(
1218 err,
1219 EngineError::RunBudgetExceeded { .. } | EngineError::WorkflowGuardRejected(_)
1220 );
1221
1222 final_status = if guardrail_stop {
1223 if let Err(store_err) = self
1224 .store
1225 .update_run(
1226 run_id,
1227 RunUpdate {
1228 status: Some(RunStatus::Cancelled),
1229 error: Some(err.to_string()),
1230 cost_usd: Some(ctx.total_cost_usd()),
1231 duration_ms: Some(total_duration),
1232 completed_at: Some(completed_at),
1233 ..RunUpdate::default()
1234 },
1235 )
1236 .await
1237 {
1238 error!(run_id = %run_id, store_error = %store_err, "failed to persist run cancellation");
1239 }
1240 if let Err(cleanup_err) = self
1241 .fail_orphaned_steps(run_id, "run stopped: guardrail limit reached")
1242 .await
1243 {
1244 error!(run_id = %run_id, store_error = %cleanup_err, "failed to cleanup orphaned steps");
1245 }
1246 RunStatus::Cancelled
1247 } else {
1248 self.fail_or_schedule_retry(
1249 run_id,
1250 &err.to_string(),
1251 is_run_retryable(&err),
1252 Some(ctx.total_cost_usd()),
1253 Some(total_duration),
1254 )
1255 .await
1256 .unwrap_or_else(|store_err| {
1257 error!(run_id = %run_id, store_error = %store_err, "failed to persist run failure");
1258 RunStatus::Failed
1259 })
1260 };
1261
1262 if matches!(err, EngineError::RunBudgetExceeded { .. }) {
1263 self.on_run_budget_exceeded(workflow_name, run_id, &err);
1264 }
1265
1266 error!(run_id = %run_id, status = %final_status, error = %err, "run stopped");
1267
1268 self.publish_run_status_changed(
1269 workflow_name,
1270 run_id,
1271 final_status,
1272 Some(err.to_string()),
1273 ctx,
1274 total_duration,
1275 run_labels,
1276 );
1277
1278 #[cfg(feature = "prometheus")]
1279 self.emit_run_metrics(workflow_name, final_status, total_duration, ctx);
1280
1281 return Err(err);
1282 }
1283 }
1284
1285 self.publish_run_status_changed(
1286 workflow_name,
1287 run_id,
1288 final_status,
1289 None,
1290 ctx,
1291 total_duration,
1292 run_labels,
1293 );
1294
1295 #[cfg(feature = "prometheus")]
1296 self.emit_run_metrics(workflow_name, final_status, total_duration, ctx);
1297
1298 Ok(WorkflowResult {
1299 run: final_run,
1300 steps: ctx.step_results().to_vec(),
1301 })
1302 }
1303
1304 #[cfg(feature = "prometheus")]
1306 fn emit_run_metrics(
1307 &self,
1308 workflow_name: &str,
1309 status: RunStatus,
1310 duration_ms: u64,
1311 ctx: &WorkflowContext,
1312 ) {
1313 let status_str = status.to_string();
1314 let wf = workflow_name.to_string();
1315
1316 counter!(RUNS_TOTAL, "workflow" => wf.clone(), "status" => status_str.clone()).increment(1);
1317 histogram!(RUN_DURATION_SECONDS, "workflow" => wf.clone(), "status" => status_str)
1318 .record(duration_ms as f64 / 1000.0);
1319 histogram!(RUN_COST_USD, "workflow" => wf.clone()).record(
1320 ctx.total_cost_usd()
1321 .to_string()
1322 .parse::<f64>()
1323 .unwrap_or(0.0),
1324 );
1325 gauge!(RUNS_ACTIVE, "workflow" => wf).decrement(1.0);
1326 }
1327
1328 fn on_run_budget_exceeded(&self, workflow_name: &str, run_id: Uuid, err: &EngineError) {
1334 let EngineError::RunBudgetExceeded {
1335 limit_usd,
1336 spent_usd,
1337 step_budget_usd,
1338 ..
1339 } = err
1340 else {
1341 return;
1342 };
1343
1344 #[cfg(feature = "prometheus")]
1345 counter!(
1346 RUN_BUDGET_EXCEEDED_TOTAL,
1347 "workflow" => workflow_name.to_string(),
1348 "scope" => "run",
1349 )
1350 .increment(1);
1351
1352 self.event_publisher.publish(Event::RunBudgetExceeded {
1353 run_id,
1354 workflow_name: workflow_name.to_string(),
1355 limit_usd: *limit_usd,
1356 spent_usd: *spent_usd,
1357 step_budget_usd: *step_budget_usd,
1358 at: Utc::now(),
1359 });
1360 }
1361
1362 #[allow(clippy::too_many_arguments)]
1367 fn publish_run_status_changed(
1368 &self,
1369 workflow_name: &str,
1370 run_id: Uuid,
1371 to: RunStatus,
1372 error: Option<String>,
1373 ctx: &WorkflowContext,
1374 duration_ms: u64,
1375 labels: HashMap<String, String>,
1376 ) {
1377 let now = Utc::now();
1378 let cost_usd = ctx.total_cost_usd();
1379 let wf = workflow_name.to_string();
1380
1381 self.event_publisher.publish(Event::RunStatusChanged {
1382 run_id,
1383 workflow_name: wf.clone(),
1384 from: RunStatus::Running,
1385 to,
1386 error: error.clone(),
1387 cost_usd,
1388 duration_ms,
1389 labels: labels.clone(),
1390 at: now,
1391 });
1392
1393 if to == RunStatus::Failed {
1394 self.event_publisher.publish(Event::RunFailed {
1395 run_id,
1396 workflow_name: wf,
1397 error,
1398 cost_usd,
1399 duration_ms,
1400 labels,
1401 at: now,
1402 });
1403 }
1404 }
1405}
1406
1407impl fmt::Debug for Engine {
1408 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1409 f.debug_struct("Engine")
1410 .field("handlers", &self.handlers.keys().collect::<Vec<_>>())
1411 .finish_non_exhaustive()
1412 }
1413}
1414
1415#[cfg(test)]
1416mod tests {
1417 use super::*;
1418 use crate::config::ShellConfig;
1419 use crate::handler::{HandlerFuture, WorkflowHandler};
1420 use ironflow_core::providers::claude::ClaudeCodeProvider;
1421 use ironflow_core::providers::record_replay::RecordReplayProvider;
1422 use ironflow_store::memory::InMemoryStore;
1423 use ironflow_store::models::StepStatus;
1424 use serde_json::json;
1425
1426 struct EchoWorkflow;
1428
1429 impl WorkflowHandler for EchoWorkflow {
1430 fn name(&self) -> &str {
1431 "echo-workflow"
1432 }
1433
1434 fn describe(&self) -> WorkflowInfo {
1435 WorkflowInfo {
1436 description: "A simple workflow that echoes hello".to_string(),
1437 source_code: None,
1438 sub_workflows: Vec::new(),
1439 category: None,
1440 version: self.version().map(str::to_string),
1441 compatible_versions: Vec::new(),
1442 input_schema: None,
1443 default_labels: HashMap::new(),
1444 schedule: self.schedule().cloned(),
1445 default_max_cost_usd: self.default_max_cost_usd(),
1446 }
1447 }
1448
1449 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
1450 Box::pin(async move {
1451 ctx.shell("greet", ShellConfig::new("echo hello")).await?;
1452 Ok(())
1453 })
1454 }
1455 }
1456
1457 struct FailingWorkflow;
1459
1460 impl WorkflowHandler for FailingWorkflow {
1461 fn name(&self) -> &str {
1462 "failing-workflow"
1463 }
1464
1465 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
1466 Box::pin(async move {
1467 ctx.shell("fail", ShellConfig::new("exit 1")).await?;
1468 Ok(())
1469 })
1470 }
1471 }
1472
1473 fn create_test_engine() -> Engine {
1474 let store = Arc::new(InMemoryStore::new());
1475 let inner = ClaudeCodeProvider::new();
1476 let provider: Arc<dyn AgentProvider> = Arc::new(RecordReplayProvider::replay(
1477 inner,
1478 "/tmp/ironflow-fixtures",
1479 ));
1480 Engine::new(store, provider)
1481 }
1482
1483 #[test]
1484 fn engine_new_creates_instance() {
1485 let engine = create_test_engine();
1486 assert_eq!(engine.handler_names().len(), 0);
1487 }
1488
1489 #[test]
1490 fn engine_register_handler() {
1491 let mut engine = create_test_engine();
1492 let result = engine.register(EchoWorkflow);
1493 assert!(result.is_ok());
1494 assert_eq!(engine.handler_names().len(), 1);
1495 assert!(engine.handler_names().contains(&"echo-workflow"));
1496 }
1497
1498 #[test]
1499 fn engine_register_duplicate_returns_error() {
1500 let mut engine = create_test_engine();
1501 engine.register(EchoWorkflow).unwrap();
1502 let result = engine.register(EchoWorkflow);
1503 assert!(result.is_err());
1504 }
1505
1506 #[test]
1507 fn engine_get_handler_found() {
1508 let mut engine = create_test_engine();
1509 engine.register(EchoWorkflow).unwrap();
1510 let handler = engine.get_handler("echo-workflow");
1511 assert!(handler.is_some());
1512 }
1513
1514 #[test]
1515 fn engine_get_handler_not_found() {
1516 let engine = create_test_engine();
1517 let handler = engine.get_handler("nonexistent");
1518 assert!(handler.is_none());
1519 }
1520
1521 #[test]
1522 fn engine_handler_names_lists_all() {
1523 let mut engine = create_test_engine();
1524 engine.register(EchoWorkflow).unwrap();
1525 engine.register(FailingWorkflow).unwrap();
1526 let names = engine.handler_names();
1527 assert_eq!(names.len(), 2);
1528 assert!(names.contains(&"echo-workflow"));
1529 assert!(names.contains(&"failing-workflow"));
1530 }
1531
1532 #[test]
1533 fn engine_handler_info_returns_description() {
1534 let mut engine = create_test_engine();
1535 engine.register(EchoWorkflow).unwrap();
1536 let info = engine.handler_info("echo-workflow");
1537 assert!(info.is_some());
1538 let info = info.unwrap();
1539 assert_eq!(info.description, "A simple workflow that echoes hello");
1540 }
1541
1542 struct CategorizedWorkflow;
1543
1544 impl WorkflowHandler for CategorizedWorkflow {
1545 fn name(&self) -> &str {
1546 "categorized"
1547 }
1548 fn category(&self) -> Option<&str> {
1549 Some("data/etl")
1550 }
1551 fn execute<'a>(
1552 &'a self,
1553 _ctx: &'a mut WorkflowContext,
1554 ) -> crate::handler::HandlerFuture<'a> {
1555 Box::pin(async move { Ok(()) })
1556 }
1557 }
1558
1559 #[test]
1560 fn engine_default_describe_propagates_category() {
1561 let mut engine = create_test_engine();
1562 engine.register(CategorizedWorkflow).unwrap();
1563 let info = engine.handler_info("categorized").unwrap();
1564 assert_eq!(info.category.as_deref(), Some("data/etl"));
1565 }
1566
1567 #[test]
1568 fn engine_default_describe_without_category() {
1569 let mut engine = create_test_engine();
1570 engine.register(EchoWorkflow).unwrap();
1571 let info = engine.handler_info("echo-workflow").unwrap();
1572 assert!(info.category.is_none());
1573 }
1574
1575 struct ScheduledWorkflow {
1580 schedule: CronSchedule,
1581 }
1582
1583 impl ScheduledWorkflow {
1584 fn new() -> Self {
1585 Self {
1586 schedule: CronSchedule::new("0 0 * * * *").unwrap(),
1587 }
1588 }
1589 }
1590
1591 impl WorkflowHandler for ScheduledWorkflow {
1592 fn name(&self) -> &str {
1593 "scheduled"
1594 }
1595 fn schedule(&self) -> Option<&CronSchedule> {
1596 Some(&self.schedule)
1597 }
1598 fn execute<'a>(
1599 &'a self,
1600 _ctx: &'a mut WorkflowContext,
1601 ) -> crate::handler::HandlerFuture<'a> {
1602 Box::pin(async move { Ok(()) })
1603 }
1604 }
1605
1606 #[test]
1607 fn engine_default_describe_propagates_schedule() {
1608 let mut engine = create_test_engine();
1609 engine.register(ScheduledWorkflow::new()).unwrap();
1610 let info = engine.handler_info("scheduled").unwrap();
1611 assert_eq!(
1612 info.schedule.as_ref().map(|s| s.as_str()),
1613 Some("0 0 * * * *")
1614 );
1615 }
1616
1617 #[test]
1618 fn engine_default_describe_without_schedule() {
1619 let mut engine = create_test_engine();
1620 engine.register(EchoWorkflow).unwrap();
1621 let info = engine.handler_info("echo-workflow").unwrap();
1622 assert!(info.schedule.is_none());
1623 }
1624
1625 #[test]
1626 fn scheduled_handlers_returns_only_scheduled() {
1627 let mut engine = create_test_engine();
1628 engine.register(EchoWorkflow).unwrap();
1629 engine.register(ScheduledWorkflow::new()).unwrap();
1630 engine.register(FailingWorkflow).unwrap();
1631
1632 let scheduled = engine.scheduled_handlers();
1633 assert_eq!(scheduled.len(), 1);
1634 assert_eq!(scheduled[0].0, "scheduled");
1635 assert_eq!(scheduled[0].1.as_str(), "0 0 * * * *");
1636 }
1637
1638 #[test]
1639 fn scheduled_handlers_empty_when_none_scheduled() {
1640 let mut engine = create_test_engine();
1641 engine.register(EchoWorkflow).unwrap();
1642 engine.register(FailingWorkflow).unwrap();
1643
1644 let scheduled = engine.scheduled_handlers();
1645 assert!(scheduled.is_empty());
1646 }
1647
1648 struct BadCategoryWorkflow(&'static str);
1649
1650 impl WorkflowHandler for BadCategoryWorkflow {
1651 fn name(&self) -> &str {
1652 "bad-category"
1653 }
1654 fn category(&self) -> Option<&str> {
1655 Some(self.0)
1656 }
1657 fn execute<'a>(
1658 &'a self,
1659 _ctx: &'a mut WorkflowContext,
1660 ) -> crate::handler::HandlerFuture<'a> {
1661 Box::pin(async move { Ok(()) })
1662 }
1663 }
1664
1665 #[test]
1666 fn engine_register_rejects_empty_category() {
1667 let mut engine = create_test_engine();
1668 let err = engine.register(BadCategoryWorkflow("")).unwrap_err();
1669 match err {
1670 EngineError::InvalidWorkflow(msg) => assert!(msg.contains("empty category")),
1671 other => panic!("expected InvalidWorkflow, got {other:?}"),
1672 }
1673 }
1674
1675 #[test]
1676 fn engine_register_rejects_leading_slash_category() {
1677 let mut engine = create_test_engine();
1678 let err = engine
1679 .register(BadCategoryWorkflow("/data/etl"))
1680 .unwrap_err();
1681 match err {
1682 EngineError::InvalidWorkflow(msg) => assert!(msg.contains("leading '/'")),
1683 other => panic!("expected InvalidWorkflow, got {other:?}"),
1684 }
1685 }
1686
1687 #[test]
1688 fn engine_register_rejects_trailing_slash_category() {
1689 let mut engine = create_test_engine();
1690 let err = engine
1691 .register(BadCategoryWorkflow("data/etl/"))
1692 .unwrap_err();
1693 match err {
1694 EngineError::InvalidWorkflow(msg) => assert!(msg.contains("trailing '/'")),
1695 other => panic!("expected InvalidWorkflow, got {other:?}"),
1696 }
1697 }
1698
1699 #[test]
1700 fn engine_register_rejects_double_slash_category() {
1701 let mut engine = create_test_engine();
1702 let err = engine
1703 .register(BadCategoryWorkflow("data//etl"))
1704 .unwrap_err();
1705 match err {
1706 EngineError::InvalidWorkflow(msg) => assert!(msg.contains("empty segment")),
1707 other => panic!("expected InvalidWorkflow, got {other:?}"),
1708 }
1709 }
1710
1711 #[test]
1712 fn engine_register_rejects_whitespace_only_segment_category() {
1713 let mut engine = create_test_engine();
1714 let err = engine
1715 .register(BadCategoryWorkflow("data/ /etl"))
1716 .unwrap_err();
1717 match err {
1718 EngineError::InvalidWorkflow(msg) => assert!(msg.contains("whitespace-only segment")),
1719 other => panic!("expected InvalidWorkflow, got {other:?}"),
1720 }
1721 }
1722
1723 #[test]
1724 fn engine_register_accepts_valid_nested_category() {
1725 let mut engine = create_test_engine();
1726 assert!(engine.register(CategorizedWorkflow).is_ok());
1727 }
1728
1729 #[tokio::test]
1730 async fn engine_unknown_workflow_returns_error() {
1731 let engine = create_test_engine();
1732 let result = engine
1733 .run_handler("unknown", TriggerKind::Manual, json!({}))
1734 .await;
1735 assert!(result.is_err());
1736 match result {
1737 Err(EngineError::InvalidWorkflow(msg)) => {
1738 assert!(msg.contains("no handler registered"));
1739 }
1740 _ => panic!("expected InvalidWorkflow error"),
1741 }
1742 }
1743
1744 #[tokio::test]
1745 async fn engine_enqueue_handler_creates_pending_run() {
1746 let mut engine = create_test_engine();
1747 engine.register(EchoWorkflow).unwrap();
1748
1749 let run = engine
1750 .enqueue_handler("echo-workflow", TriggerKind::Manual, json!({}), 0)
1751 .await
1752 .unwrap();
1753 assert_eq!(run.status.state, RunStatus::Pending);
1754 assert_eq!(run.workflow_name, "echo-workflow");
1755 }
1756
1757 #[tokio::test]
1758 async fn enqueue_handler_leaves_the_run_unattributed() {
1759 let mut engine = create_test_engine();
1760 engine.register(EchoWorkflow).unwrap();
1761
1762 let run = engine
1763 .enqueue_handler("echo-workflow", TriggerKind::Manual, json!({}), 0)
1764 .await
1765 .unwrap();
1766
1767 assert!(run.created_by.is_none());
1768 }
1769
1770 #[tokio::test]
1771 async fn enqueue_handler_with_options_records_the_author() {
1772 let mut engine = create_test_engine();
1773 engine.register(EchoWorkflow).unwrap();
1774 let actor = RunActor::User {
1775 user_id: Uuid::now_v7(),
1776 };
1777
1778 let run = engine
1779 .enqueue_handler_with_options(
1780 "echo-workflow",
1781 TriggerKind::Api,
1782 json!({}),
1783 EnqueueOptions {
1784 created_by: Some(actor.clone()),
1785 ..Default::default()
1786 },
1787 )
1788 .await
1789 .unwrap()
1790 .into_run();
1791
1792 assert_eq!(run.created_by, Some(actor));
1793 }
1794
1795 #[tokio::test]
1796 async fn enqueue_handler_with_options_accepts_no_author() {
1797 let mut engine = create_test_engine();
1798 engine.register(EchoWorkflow).unwrap();
1799
1800 let run = engine
1801 .enqueue_handler_with_options(
1802 "echo-workflow",
1803 TriggerKind::Cron {
1804 schedule: "0 * * * * *".to_string(),
1805 },
1806 json!({}),
1807 EnqueueOptions::default(),
1808 )
1809 .await
1810 .unwrap()
1811 .into_run();
1812
1813 assert!(run.created_by.is_none());
1814 }
1815
1816 #[tokio::test]
1817 async fn run_handler_leaves_the_run_unattributed() {
1818 let mut engine = create_test_engine();
1819 engine.register(EchoWorkflow).unwrap();
1820
1821 let run = engine
1822 .run_handler("echo-workflow", TriggerKind::Manual, json!({}))
1823 .await
1824 .unwrap()
1825 .run;
1826
1827 assert!(run.created_by.is_none());
1828 }
1829
1830 #[tokio::test]
1831 async fn engine_register_boxed() {
1832 let mut engine = create_test_engine();
1833 let handler: Box<dyn WorkflowHandler> = Box::new(EchoWorkflow);
1834 let result = engine.register_boxed(handler);
1835 assert!(result.is_ok());
1836 assert_eq!(engine.handler_names().len(), 1);
1837 }
1838
1839 #[tokio::test]
1840 async fn engine_store_and_provider_accessors() {
1841 let store = Arc::new(InMemoryStore::new());
1842 let inner = ClaudeCodeProvider::new();
1843 let provider: Arc<dyn AgentProvider> = Arc::new(RecordReplayProvider::replay(
1844 inner,
1845 "/tmp/ironflow-fixtures",
1846 ));
1847 let engine = Engine::new(store.clone(), provider.clone());
1848
1849 let _ = engine.store();
1851 let _ = engine.provider();
1852 }
1853
1854 use crate::operation::{Operation, OperationContext};
1859 use ironflow_core::error::OperationError;
1860 use ironflow_store::models::StepKind;
1861 use std::future::Future;
1862 use std::pin::Pin;
1863
1864 struct FakeGitlabOp {
1865 project_id: u64,
1866 title: String,
1867 }
1868
1869 impl Operation for FakeGitlabOp {
1870 fn kind(&self) -> &str {
1871 "gitlab"
1872 }
1873
1874 fn execute<'a>(
1875 &'a self,
1876 _ctx: &'a OperationContext,
1877 ) -> Pin<Box<dyn Future<Output = Result<Value, OperationError>> + Send + 'a>> {
1878 Box::pin(async move {
1879 Ok(json!({
1880 "issue_id": 42,
1881 "project_id": self.project_id,
1882 "title": self.title,
1883 }))
1884 })
1885 }
1886
1887 fn input(&self) -> Option<Value> {
1888 Some(json!({
1889 "project_id": self.project_id,
1890 "title": self.title,
1891 }))
1892 }
1893 }
1894
1895 struct FailingOp;
1896
1897 impl Operation for FailingOp {
1898 fn kind(&self) -> &str {
1899 "broken-service"
1900 }
1901
1902 fn execute<'a>(
1903 &'a self,
1904 _ctx: &'a OperationContext,
1905 ) -> Pin<Box<dyn Future<Output = Result<Value, OperationError>> + Send + 'a>> {
1906 Box::pin(async move {
1907 Err(OperationError::Http {
1908 status: None,
1909 message: "service unavailable".to_string(),
1910 })
1911 })
1912 }
1913 }
1914
1915 struct OperationWorkflow;
1916
1917 impl WorkflowHandler for OperationWorkflow {
1918 fn name(&self) -> &str {
1919 "operation-workflow"
1920 }
1921
1922 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
1923 Box::pin(async move {
1924 let op = FakeGitlabOp {
1925 project_id: 123,
1926 title: "Bug report".to_string(),
1927 };
1928 ctx.operation("create-issue", &op).await?;
1929 Ok(())
1930 })
1931 }
1932 }
1933
1934 struct FailingOperationWorkflow;
1935
1936 impl WorkflowHandler for FailingOperationWorkflow {
1937 fn name(&self) -> &str {
1938 "failing-operation-workflow"
1939 }
1940
1941 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
1942 Box::pin(async move {
1943 ctx.operation("broken-call", &FailingOp).await?;
1944 Ok(())
1945 })
1946 }
1947 }
1948
1949 struct MixedWorkflow;
1950
1951 impl WorkflowHandler for MixedWorkflow {
1952 fn name(&self) -> &str {
1953 "mixed-workflow"
1954 }
1955
1956 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
1957 Box::pin(async move {
1958 ctx.shell("build", ShellConfig::new("echo built")).await?;
1959 let op = FakeGitlabOp {
1960 project_id: 456,
1961 title: "Deploy done".to_string(),
1962 };
1963 let result = ctx.operation("notify-gitlab", &op).await?;
1964 assert_eq!(result.output["issue_id"], 42);
1965 Ok(())
1966 })
1967 }
1968 }
1969
1970 #[tokio::test]
1971 async fn operation_step_happy_path() {
1972 let mut engine = create_test_engine();
1973 engine.register(OperationWorkflow).unwrap();
1974
1975 let run = engine
1976 .run_handler("operation-workflow", TriggerKind::Manual, json!({}))
1977 .await
1978 .unwrap()
1979 .run;
1980
1981 assert_eq!(run.status.state, RunStatus::Completed);
1982
1983 let steps = engine.store().list_steps(run.id).await.unwrap();
1984
1985 assert_eq!(steps.len(), 1);
1986 assert_eq!(steps[0].name, "create-issue");
1987 assert_eq!(steps[0].kind, StepKind::Custom("gitlab".to_string()));
1988 assert_eq!(
1989 steps[0].status.state,
1990 ironflow_store::models::StepStatus::Completed
1991 );
1992
1993 let output = steps[0].output.as_ref().unwrap();
1994 assert_eq!(output["issue_id"], 42);
1995 assert_eq!(output["project_id"], 123);
1996
1997 let input = steps[0].input.as_ref().unwrap();
1998 assert_eq!(input["project_id"], 123);
1999 assert_eq!(input["title"], "Bug report");
2000 }
2001
2002 #[tokio::test]
2003 async fn operation_step_failure_marks_run_failed() {
2004 let mut engine = create_test_engine();
2005 engine.register(FailingOperationWorkflow).unwrap();
2006
2007 let result = engine
2008 .run_handler("failing-operation-workflow", TriggerKind::Manual, json!({}))
2009 .await;
2010
2011 assert!(result.is_err());
2012 }
2013
2014 #[tokio::test]
2015 async fn operation_mixed_with_shell_steps() {
2016 let mut engine = create_test_engine();
2017 engine.register(MixedWorkflow).unwrap();
2018
2019 let run = engine
2020 .run_handler("mixed-workflow", TriggerKind::Manual, json!({}))
2021 .await
2022 .unwrap()
2023 .run;
2024
2025 assert_eq!(run.status.state, RunStatus::Completed);
2026
2027 let steps = engine.store().list_steps(run.id).await.unwrap();
2028
2029 assert_eq!(steps.len(), 2);
2030 assert_eq!(steps[0].kind, StepKind::Shell);
2031 assert_eq!(steps[1].kind, StepKind::Custom("gitlab".to_string()));
2032 assert_eq!(steps[0].position, 0);
2033 assert_eq!(steps[1].position, 1);
2034 }
2035
2036 use crate::config::ApprovalConfig;
2041
2042 struct SingleApprovalWorkflow;
2043
2044 impl WorkflowHandler for SingleApprovalWorkflow {
2045 fn name(&self) -> &str {
2046 "single-approval"
2047 }
2048
2049 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
2050 Box::pin(async move {
2051 ctx.shell("build", ShellConfig::new("echo built")).await?;
2052 ctx.approval("gate", ApprovalConfig::new("OK?")).await?;
2053 ctx.shell("deploy", ShellConfig::new("echo deployed"))
2054 .await?;
2055 Ok(())
2056 })
2057 }
2058 }
2059
2060 struct DoubleApprovalWorkflow;
2061
2062 impl WorkflowHandler for DoubleApprovalWorkflow {
2063 fn name(&self) -> &str {
2064 "double-approval"
2065 }
2066
2067 fn execute<'a>(&'a self, ctx: &'a mut WorkflowContext) -> HandlerFuture<'a> {
2068 Box::pin(async move {
2069 ctx.shell("build", ShellConfig::new("echo built")).await?;
2070 ctx.approval("staging-gate", ApprovalConfig::new("Deploy staging?"))
2071 .await?;
2072 ctx.shell("deploy-staging", ShellConfig::new("echo staging"))
2073 .await?;
2074 ctx.approval("prod-gate", ApprovalConfig::new("Deploy prod?"))
2075 .await?;
2076 ctx.shell("deploy-prod", ShellConfig::new("echo prod"))
2077 .await?;
2078 Ok(())
2079 })
2080 }
2081 }
2082
2083 #[tokio::test]
2084 async fn approval_pauses_run() {
2085 let mut engine = create_test_engine();
2086 engine.register(SingleApprovalWorkflow).unwrap();
2087
2088 let run = engine
2089 .run_handler("single-approval", TriggerKind::Manual, json!({}))
2090 .await
2091 .unwrap()
2092 .run;
2093
2094 assert_eq!(run.status.state, RunStatus::AwaitingApproval);
2095
2096 let steps = engine.store().list_steps(run.id).await.unwrap();
2097 assert_eq!(steps.len(), 2); assert_eq!(steps[0].kind, StepKind::Shell);
2099 assert_eq!(steps[0].status.state, StepStatus::Completed);
2100 assert_eq!(steps[1].kind, StepKind::Approval);
2101 assert_eq!(steps[1].status.state, StepStatus::AwaitingApproval);
2102 }
2103
2104 #[tokio::test]
2105 async fn approval_resume_completes_run() {
2106 let mut engine = create_test_engine();
2107 engine.register(SingleApprovalWorkflow).unwrap();
2108
2109 let run = engine
2111 .run_handler("single-approval", TriggerKind::Manual, json!({}))
2112 .await
2113 .unwrap()
2114 .run;
2115 assert_eq!(run.status.state, RunStatus::AwaitingApproval);
2116
2117 engine
2119 .store()
2120 .update_run_status(run.id, RunStatus::Running)
2121 .await
2122 .unwrap();
2123
2124 let resumed = engine.resume_run(run.id).await.unwrap().run;
2126 assert_eq!(resumed.status.state, RunStatus::Completed);
2127
2128 let steps = engine.store().list_steps(run.id).await.unwrap();
2129 assert_eq!(steps.len(), 3); assert_eq!(steps[0].name, "build");
2131 assert_eq!(steps[0].status.state, StepStatus::Completed);
2132 assert_eq!(steps[1].name, "gate");
2133 assert_eq!(steps[1].kind, StepKind::Approval);
2134 assert_eq!(steps[1].status.state, StepStatus::Completed);
2135 assert_eq!(steps[2].name, "deploy");
2136 assert_eq!(steps[2].status.state, StepStatus::Completed);
2137 }
2138
2139 #[tokio::test]
2140 async fn double_approval_two_resumes() {
2141 let mut engine = create_test_engine();
2142 engine.register(DoubleApprovalWorkflow).unwrap();
2143
2144 let run = engine
2146 .run_handler("double-approval", TriggerKind::Manual, json!({}))
2147 .await
2148 .unwrap()
2149 .run;
2150 assert_eq!(run.status.state, RunStatus::AwaitingApproval);
2151
2152 let steps = engine.store().list_steps(run.id).await.unwrap();
2153 assert_eq!(steps.len(), 2); engine
2157 .store()
2158 .update_run_status(run.id, RunStatus::Running)
2159 .await
2160 .unwrap();
2161
2162 let resumed = engine.resume_run(run.id).await.unwrap().run;
2163 assert_eq!(resumed.status.state, RunStatus::AwaitingApproval);
2164
2165 let steps = engine.store().list_steps(run.id).await.unwrap();
2166 assert_eq!(steps.len(), 4); engine
2170 .store()
2171 .update_run_status(run.id, RunStatus::Running)
2172 .await
2173 .unwrap();
2174
2175 let final_run = engine.resume_run(run.id).await.unwrap().run;
2176 assert_eq!(final_run.status.state, RunStatus::Completed);
2177
2178 let steps = engine.store().list_steps(run.id).await.unwrap();
2179 assert_eq!(steps.len(), 5);
2180 assert_eq!(steps[0].name, "build");
2181 assert_eq!(steps[1].name, "staging-gate");
2182 assert_eq!(steps[2].name, "deploy-staging");
2183 assert_eq!(steps[3].name, "prod-gate");
2184 assert_eq!(steps[4].name, "deploy-prod");
2185
2186 for step in &steps {
2187 assert_eq!(step.status.state, StepStatus::Completed);
2188 }
2189 }
2190
2191 use ironflow_store::models::{NewStep, StepUpdate, step_trace_id};
2196
2197 async fn create_step_with_status(
2198 store: &Arc<dyn Store>,
2199 run_id: Uuid,
2200 name: &str,
2201 position: u32,
2202 status: StepStatus,
2203 ) -> ironflow_store::models::Step {
2204 let step = store
2205 .create_step(NewStep {
2206 run_id,
2207 trace_id: step_trace_id(run_id, name, position),
2208 name: name.to_string(),
2209 kind: StepKind::Shell,
2210 position,
2211 input: None,
2212 is_error_handler: false,
2213 })
2214 .await
2215 .unwrap();
2216
2217 match status {
2218 StepStatus::Pending => {}
2219 StepStatus::Running => {
2220 store
2221 .update_step(
2222 step.id,
2223 StepUpdate {
2224 status: Some(StepStatus::Running),
2225 ..StepUpdate::default()
2226 },
2227 )
2228 .await
2229 .unwrap();
2230 }
2231 StepStatus::Completed => {
2232 store
2233 .update_step(
2234 step.id,
2235 StepUpdate {
2236 status: Some(StepStatus::Running),
2237 ..StepUpdate::default()
2238 },
2239 )
2240 .await
2241 .unwrap();
2242 store
2243 .update_step(
2244 step.id,
2245 StepUpdate {
2246 status: Some(StepStatus::Completed),
2247 ..StepUpdate::default()
2248 },
2249 )
2250 .await
2251 .unwrap();
2252 }
2253 StepStatus::AwaitingApproval => {
2254 store
2255 .update_step(
2256 step.id,
2257 StepUpdate {
2258 status: Some(StepStatus::Running),
2259 ..StepUpdate::default()
2260 },
2261 )
2262 .await
2263 .unwrap();
2264 store
2265 .update_step(
2266 step.id,
2267 StepUpdate {
2268 status: Some(StepStatus::AwaitingApproval),
2269 ..StepUpdate::default()
2270 },
2271 )
2272 .await
2273 .unwrap();
2274 }
2275 _ => panic!("unsupported status for test helper: {status}"),
2276 }
2277
2278 store.get_step(step.id).await.unwrap().unwrap()
2279 }
2280
2281 #[tokio::test]
2282 async fn fail_orphaned_steps_marks_running_as_failed() {
2283 let engine = create_test_engine();
2284 let run = engine
2285 .store()
2286 .create_run(NewRun {
2287 created_by: None,
2288 workflow_name: "test".to_string(),
2289 trigger: TriggerKind::Manual,
2290 payload: json!({}),
2291 max_retries: 0,
2292 handler_version: None,
2293 labels: HashMap::new(),
2294 scheduled_at: None,
2295 idempotency_key: None,
2296 max_cost_usd: None,
2297 })
2298 .await
2299 .unwrap()
2300 .into_run();
2301
2302 let step = create_step_with_status(
2303 engine.store(),
2304 run.id,
2305 "running-step",
2306 0,
2307 StepStatus::Running,
2308 )
2309 .await;
2310
2311 engine
2312 .fail_orphaned_steps(run.id, "parent run timed out")
2313 .await
2314 .unwrap();
2315
2316 let updated = engine.store().get_step(step.id).await.unwrap().unwrap();
2317 assert_eq!(updated.status.state, StepStatus::Failed);
2318 assert_eq!(updated.error.as_deref(), Some("parent run timed out"));
2319 assert!(updated.completed_at.is_some());
2320 }
2321
2322 #[tokio::test]
2323 async fn fail_orphaned_steps_marks_pending_as_skipped() {
2324 let engine = create_test_engine();
2325 let run = engine
2326 .store()
2327 .create_run(NewRun {
2328 created_by: None,
2329 workflow_name: "test".to_string(),
2330 trigger: TriggerKind::Manual,
2331 payload: json!({}),
2332 max_retries: 0,
2333 handler_version: None,
2334 labels: HashMap::new(),
2335 scheduled_at: None,
2336 idempotency_key: None,
2337 max_cost_usd: None,
2338 })
2339 .await
2340 .unwrap()
2341 .into_run();
2342
2343 let step = create_step_with_status(
2344 engine.store(),
2345 run.id,
2346 "pending-step",
2347 0,
2348 StepStatus::Pending,
2349 )
2350 .await;
2351
2352 engine
2353 .fail_orphaned_steps(run.id, "parent run timed out")
2354 .await
2355 .unwrap();
2356
2357 let updated = engine.store().get_step(step.id).await.unwrap().unwrap();
2358 assert_eq!(updated.status.state, StepStatus::Skipped);
2359 assert!(updated.error.is_none());
2360 assert!(updated.completed_at.is_some());
2361 }
2362
2363 #[tokio::test]
2364 async fn fail_orphaned_steps_marks_awaiting_approval_as_failed() {
2365 let engine = create_test_engine();
2366 let run = engine
2367 .store()
2368 .create_run(NewRun {
2369 created_by: None,
2370 workflow_name: "test".to_string(),
2371 trigger: TriggerKind::Manual,
2372 payload: json!({}),
2373 max_retries: 0,
2374 handler_version: None,
2375 labels: HashMap::new(),
2376 scheduled_at: None,
2377 idempotency_key: None,
2378 max_cost_usd: None,
2379 })
2380 .await
2381 .unwrap()
2382 .into_run();
2383
2384 let step = create_step_with_status(
2385 engine.store(),
2386 run.id,
2387 "approval-step",
2388 0,
2389 StepStatus::AwaitingApproval,
2390 )
2391 .await;
2392
2393 engine
2394 .fail_orphaned_steps(run.id, "parent run timed out")
2395 .await
2396 .unwrap();
2397
2398 let updated = engine.store().get_step(step.id).await.unwrap().unwrap();
2399 assert_eq!(updated.status.state, StepStatus::Failed);
2400 assert_eq!(updated.error.as_deref(), Some("parent run timed out"));
2401 assert!(updated.completed_at.is_some());
2402 }
2403
2404 #[tokio::test]
2405 async fn fail_orphaned_steps_skips_terminal_steps() {
2406 let engine = create_test_engine();
2407 let run = engine
2408 .store()
2409 .create_run(NewRun {
2410 created_by: None,
2411 workflow_name: "test".to_string(),
2412 trigger: TriggerKind::Manual,
2413 payload: json!({}),
2414 max_retries: 0,
2415 handler_version: None,
2416 labels: HashMap::new(),
2417 scheduled_at: None,
2418 idempotency_key: None,
2419 max_cost_usd: None,
2420 })
2421 .await
2422 .unwrap()
2423 .into_run();
2424
2425 let completed_step =
2426 create_step_with_status(engine.store(), run.id, "done", 0, StepStatus::Completed).await;
2427 let running_step =
2428 create_step_with_status(engine.store(), run.id, "in-flight", 1, StepStatus::Running)
2429 .await;
2430
2431 engine
2432 .fail_orphaned_steps(run.id, "parent run timed out")
2433 .await
2434 .unwrap();
2435
2436 let completed = engine
2437 .store()
2438 .get_step(completed_step.id)
2439 .await
2440 .unwrap()
2441 .unwrap();
2442 assert_eq!(completed.status.state, StepStatus::Completed);
2443
2444 let failed = engine
2445 .store()
2446 .get_step(running_step.id)
2447 .await
2448 .unwrap()
2449 .unwrap();
2450 assert_eq!(failed.status.state, StepStatus::Failed);
2451 }
2452
2453 #[tokio::test]
2454 async fn fail_orphaned_steps_mixed_states() {
2455 let engine = create_test_engine();
2456 let run = engine
2457 .store()
2458 .create_run(NewRun {
2459 created_by: None,
2460 workflow_name: "test".to_string(),
2461 trigger: TriggerKind::Manual,
2462 payload: json!({}),
2463 max_retries: 0,
2464 handler_version: None,
2465 labels: HashMap::new(),
2466 scheduled_at: None,
2467 idempotency_key: None,
2468 max_cost_usd: None,
2469 })
2470 .await
2471 .unwrap()
2472 .into_run();
2473
2474 let s_completed =
2475 create_step_with_status(engine.store(), run.id, "step-1", 0, StepStatus::Completed)
2476 .await;
2477 let s_running =
2478 create_step_with_status(engine.store(), run.id, "step-2", 1, StepStatus::Running).await;
2479 let s_pending =
2480 create_step_with_status(engine.store(), run.id, "step-3", 2, StepStatus::Pending).await;
2481
2482 engine.fail_orphaned_steps(run.id, "timeout").await.unwrap();
2483
2484 let r_completed = engine
2485 .store()
2486 .get_step(s_completed.id)
2487 .await
2488 .unwrap()
2489 .unwrap();
2490 assert_eq!(r_completed.status.state, StepStatus::Completed);
2491
2492 let r_running = engine
2493 .store()
2494 .get_step(s_running.id)
2495 .await
2496 .unwrap()
2497 .unwrap();
2498 assert_eq!(r_running.status.state, StepStatus::Failed);
2499 assert_eq!(r_running.error.as_deref(), Some("timeout"));
2500
2501 let r_pending = engine
2502 .store()
2503 .get_step(s_pending.id)
2504 .await
2505 .unwrap()
2506 .unwrap();
2507 assert_eq!(r_pending.status.state, StepStatus::Skipped);
2508 assert!(r_pending.error.is_none());
2509 }
2510
2511 #[tokio::test]
2512 async fn fail_orphaned_steps_no_steps_is_noop() {
2513 let engine = create_test_engine();
2514 let run = engine
2515 .store()
2516 .create_run(NewRun {
2517 created_by: None,
2518 workflow_name: "test".to_string(),
2519 trigger: TriggerKind::Manual,
2520 payload: json!({}),
2521 max_retries: 0,
2522 handler_version: None,
2523 labels: HashMap::new(),
2524 scheduled_at: None,
2525 idempotency_key: None,
2526 max_cost_usd: None,
2527 })
2528 .await
2529 .unwrap()
2530 .into_run();
2531
2532 let result = engine.fail_orphaned_steps(run.id, "timeout").await;
2533 assert!(result.is_ok());
2534 }
2535
2536 #[tokio::test]
2537 async fn fail_orphaned_steps_preserves_existing_error() {
2538 let engine = create_test_engine();
2539 let run = engine
2540 .store()
2541 .create_run(NewRun {
2542 created_by: None,
2543 workflow_name: "test".to_string(),
2544 trigger: TriggerKind::Manual,
2545 payload: json!({}),
2546 max_retries: 0,
2547 handler_version: None,
2548 labels: HashMap::new(),
2549 scheduled_at: None,
2550 idempotency_key: None,
2551 max_cost_usd: None,
2552 })
2553 .await
2554 .unwrap()
2555 .into_run();
2556
2557 let step_with_error = create_step_with_status(
2558 engine.store(),
2559 run.id,
2560 "already-errored",
2561 0,
2562 StepStatus::Running,
2563 )
2564 .await;
2565
2566 engine
2567 .store()
2568 .update_step(
2569 step_with_error.id,
2570 StepUpdate {
2571 error: Some("real error from provider".to_string()),
2572 ..StepUpdate::default()
2573 },
2574 )
2575 .await
2576 .unwrap();
2577
2578 let step_no_error = create_step_with_status(
2579 engine.store(),
2580 run.id,
2581 "no-error-yet",
2582 1,
2583 StepStatus::Running,
2584 )
2585 .await;
2586
2587 engine
2588 .fail_orphaned_steps(run.id, "parent run failed")
2589 .await
2590 .unwrap();
2591
2592 let updated_with = engine
2593 .store()
2594 .get_step(step_with_error.id)
2595 .await
2596 .unwrap()
2597 .unwrap();
2598 assert_eq!(updated_with.status.state, StepStatus::Failed);
2599 assert_eq!(
2600 updated_with.error.as_deref(),
2601 Some("real error from provider"),
2602 );
2603
2604 let updated_without = engine
2605 .store()
2606 .get_step(step_no_error.id)
2607 .await
2608 .unwrap()
2609 .unwrap();
2610 assert_eq!(updated_without.status.state, StepStatus::Failed);
2611 assert_eq!(updated_without.error.as_deref(), Some("parent run failed"),);
2612 }
2613}