car-workflow 0.13.0

Declarative multi-stage workflow orchestration for Common Agent Runtime
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

//! Workflow execution result types.

use std::collections::HashMap;

use car_ir::ProposalResult;
use car_multi::AgentOutput;
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Overall workflow execution result.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WorkflowResult {
    pub workflow_id: String,
    pub workflow_name: String,
    pub status: WorkflowStatus,
    /// Results for each stage that executed (in execution order).
    pub stages: Vec<StageResult>,
    /// Compensation records (in compensation order, reverse of execution).
    pub compensations: Vec<CompensationResult>,
    pub duration_ms: f64,
    pub timestamp: DateTime<Utc>,
    /// Final workflow state snapshot.
    #[serde(default)]
    pub final_state: HashMap<String, Value>,
}

impl WorkflowResult {
    pub fn succeeded(&self) -> bool {
        self.status == WorkflowStatus::Completed
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowStatus {
    /// All stages completed successfully.
    Completed,
    /// A stage failed and no compensation was attempted.
    Failed,
    /// A stage failed and all compensations succeeded.
    Compensated,
    /// A stage failed and some compensations also failed.
    PartiallyCompensated,
}

/// Result of a single stage execution.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StageResult {
    pub stage_id: String,
    pub stage_name: String,
    pub status: StageStatus,
    pub output: StageOutput,
    pub duration_ms: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum StageStatus {
    Succeeded,
    Failed,
    Skipped,
    Compensated,
}

/// The typed output of a stage, depending on its step type.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum StageOutput {
    Pattern {
        outputs: Vec<AgentOutput>,
        final_answer: String,
    },
    Proposal {
        result: ProposalResult,
    },
    SubWorkflow {
        result: Box<WorkflowResult>,
    },
    Empty,
}

/// Record of a compensation attempt.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CompensationResult {
    pub for_stage_id: String,
    pub status: StageStatus,
    pub duration_ms: f64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}