ironflow-store 2.6.0

//! [`StepKind`] — the type of operation a step executes.

use serde::{Deserialize, Deserializer, Serialize, Serializer};

/// The type of operation a step executes.
///
/// Built-in kinds cover the four core operation types. The [`Custom`](StepKind::Custom)
/// variant allows user-defined operations (e.g. GitLab, Gmail, Slack) that
/// implement the `Operation` trait from `ironflow-engine`.
///
/// All variants serialize as a plain JSON string: built-in kinds produce their
/// snake_case name (`"shell"`, `"http"`, `"agent"`, `"workflow"`), and
/// [`Custom`](StepKind::Custom) produces its inner value directly (e.g. `"gitlab"`).
/// On deserialization, known strings map back to the built-in variant; anything
/// else becomes `Custom(value)`.
///
/// # Examples
///
/// ```
/// use ironflow_store::entities::StepKind;
///
/// let kind = StepKind::Shell;
/// assert_eq!(kind.to_string(), "Shell");
///
/// let custom = StepKind::Custom("gitlab".to_string());
/// assert_eq!(custom.to_string(), "Custom(gitlab)");
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum StepKind {
    /// A shell command.
    Shell,
    /// An HTTP request.
    Http,
    /// An AI agent invocation.
    Agent,
    /// A sub-workflow invocation.
    Workflow,
    /// A human approval gate.
    Approval,
    /// A user-defined operation (e.g. `"gitlab"`, `"gmail"`, `"slack"`).
    Custom(String),
}

impl Serialize for StepKind {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        let s = match self {
            StepKind::Shell => "shell",
            StepKind::Http => "http",
            StepKind::Agent => "agent",
            StepKind::Workflow => "workflow",
            StepKind::Approval => "approval",
            StepKind::Custom(name) => name.as_str(),
        };
        serializer.serialize_str(s)
    }
}

impl<'de> Deserialize<'de> for StepKind {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        let s = String::deserialize(deserializer)?;
        Ok(match s.as_str() {
            "shell" => StepKind::Shell,
            "http" => StepKind::Http,
            "agent" => StepKind::Agent,
            "workflow" => StepKind::Workflow,
            "approval" => StepKind::Approval,
            _ => StepKind::Custom(s),
        })
    }
}

impl std::fmt::Display for StepKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            StepKind::Shell => f.write_str("Shell"),
            StepKind::Http => f.write_str("Http"),
            StepKind::Agent => f.write_str("Agent"),
            StepKind::Workflow => f.write_str("Workflow"),
            StepKind::Approval => f.write_str("Approval"),
            StepKind::Custom(name) => write!(f, "Custom({name})"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display() {
        assert_eq!(StepKind::Shell.to_string(), "Shell");
        assert_eq!(StepKind::Http.to_string(), "Http");
        assert_eq!(StepKind::Agent.to_string(), "Agent");
        assert_eq!(StepKind::Workflow.to_string(), "Workflow");
        assert_eq!(
            StepKind::Custom("gitlab".to_string()).to_string(),
            "Custom(gitlab)"
        );
    }

    #[test]
    fn serde_roundtrip() {
        let kind = StepKind::Workflow;
        let json = serde_json::to_string(&kind).unwrap();
        assert_eq!(json, "\"workflow\"");
        let back: StepKind = serde_json::from_str(&json).unwrap();
        assert_eq!(back, StepKind::Workflow);
    }

    #[test]
    fn serde_roundtrip_custom() {
        let kind = StepKind::Custom("gitlab".to_string());
        let json = serde_json::to_string(&kind).unwrap();
        assert_eq!(json, "\"gitlab\"");
        let back: StepKind = serde_json::from_str(&json).unwrap();
        assert_eq!(back, kind);
    }

    #[test]
    fn deserialize_unknown_string_becomes_custom() {
        let back: StepKind = serde_json::from_str("\"slack\"").unwrap();
        assert_eq!(back, StepKind::Custom("slack".to_string()));
    }
}