fabro/lib/components/fabro-workflow/src/handler/mod.rs
2026-07-23 17:59:34 -04:00

417 lines
12 KiB
Rust

pub mod agent;
pub mod command;
pub mod conditional;
pub mod exit;
pub mod fan_in;
pub mod human;
pub mod llm;
pub mod manager_loop;
pub mod parallel;
pub mod prompt;
pub mod start;
pub mod structured_output;
pub mod wait;
use std::any::Any;
use std::collections::HashMap;
use std::path::Path;
use std::sync::Arc;
use async_trait::async_trait;
use fabro_graphviz::graph::{Graph, Node, shape_to_handler_type};
use fabro_interview::Interviewer;
use crate::context::Context;
use crate::error::Error;
use crate::event::Emitter;
use crate::outcome::{Outcome, OutcomeExt};
pub use crate::services::{EngineServices, RunServices};
/// The handler interface for node execution.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NodeTimeoutPolicy {
/// The workflow executor wraps the whole handler future in the node
/// timeout.
ExecutorEnforced,
/// The handler consumes the node timeout and is responsible for surfacing
/// timeout-specific outcome and events.
HandlerManaged,
}
#[async_trait]
pub trait Handler: Send + Sync {
async fn execute(
&self,
node: &Node,
context: &Context,
graph: &Graph,
run_dir: &Path,
services: &EngineServices,
) -> Result<Outcome, Error>;
/// Produce a simulated result for dry-run mode.
/// Override for handlers that need custom context updates.
async fn simulate(
&self,
node: &Node,
_context: &Context,
_graph: &Graph,
_run_dir: &Path,
_services: &EngineServices,
) -> Result<Outcome, Error> {
Ok(Outcome::simulated(&node.id))
}
/// Determines whether an error should be retried.
/// Default implementation retries transient errors only.
fn should_retry(&self, err: &Error) -> bool {
err.is_retryable()
}
fn node_timeout_policy(&self, _node: &Node) -> NodeTimeoutPolicy {
NodeTimeoutPolicy::ExecutorEnforced
}
async fn shutdown(&self, _emitter: &Arc<Emitter>) {}
}
/// Extract a human-readable message from a panic payload.
pub(crate) fn format_panic_message(payload: &Box<dyn Any + Send>) -> String {
if let Some(s) = payload.downcast_ref::<&str>() {
format!("handler panicked: {s}")
} else if let Some(s) = payload.downcast_ref::<String>() {
format!("handler panicked: {s}")
} else {
"handler panicked".to_string()
}
}
/// Route to [`Handler::simulate`] when `services.dry_run` is true, otherwise
/// [`Handler::execute`].
pub async fn dispatch_handler(
handler: &dyn Handler,
node: &Node,
context: &Context,
graph: &Graph,
run_dir: &Path,
services: &EngineServices,
) -> Result<Outcome, Error> {
if services.dry_run {
handler
.simulate(node, context, graph, run_dir, services)
.await
} else {
handler
.execute(node, context, graph, run_dir, services)
.await
}
}
/// Maps handler type strings to handler implementations.
pub struct HandlerRegistry {
handlers: HashMap<String, Box<dyn Handler>>,
default_handler: Box<dyn Handler>,
}
impl HandlerRegistry {
#[must_use]
pub fn new(default_handler: Box<dyn Handler>) -> Self {
Self {
handlers: HashMap::new(),
default_handler,
}
}
/// Register a handler for a given type string.
pub fn register(&mut self, type_string: impl Into<String>, handler: Box<dyn Handler>) {
self.handlers.insert(type_string.into(), handler);
}
/// Resolve which handler should execute for a given node.
/// Priority: explicit type -> shape-based -> default.
#[must_use]
pub fn resolve(&self, node: &Node) -> &dyn Handler {
// 1. Explicit type attribute
if let Some(node_type) = node.node_type() {
if let Some(handler) = self.handlers.get(node_type) {
return handler.as_ref();
}
}
// 2. Shape-based resolution
if let Some(handler_type) = shape_to_handler_type(node.shape()) {
if let Some(handler) = self.handlers.get(handler_type) {
return handler.as_ref();
}
}
// 3. Default
self.default_handler.as_ref()
}
pub async fn shutdown_all(&self, emitter: &Arc<Emitter>) {
self.default_handler.shutdown(emitter).await;
for handler in self.handlers.values() {
handler.shutdown(emitter).await;
}
}
}
/// Build a [`HandlerRegistry`] with all built-in handler types registered.
///
/// The `make_backend` closure is called for each handler that needs a backend
/// (default, `"agent"`, `"prompt"`, and `"parallel.fan_in"`).
#[must_use]
pub fn default_registry(
interviewer: Arc<dyn Interviewer>,
make_backend: impl Fn() -> Option<Box<dyn agent::CodergenBackend>>,
) -> HandlerRegistry {
let mut registry = HandlerRegistry::new(Box::new(agent::AgentHandler::new(make_backend())));
registry.register("start", Box::new(start::StartHandler));
registry.register("exit", Box::new(exit::ExitHandler));
registry.register("agent", Box::new(agent::AgentHandler::new(make_backend())));
registry.register(
"prompt",
Box::new(prompt::PromptHandler::new(make_backend())),
);
registry.register("conditional", Box::new(conditional::ConditionalHandler));
registry.register("human", Box::new(human::HumanHandler::new(interviewer)));
registry.register("command", Box::new(command::CommandHandler));
registry.register("tool", Box::new(command::CommandHandler));
registry.register("parallel", Box::new(parallel::ParallelHandler));
registry.register(
"parallel.fan_in",
Box::new(fan_in::FanInHandler::new(make_backend())),
);
registry.register(
"stack.manager_loop",
Box::new(manager_loop::SubWorkflowHandler),
);
registry.register("wait", Box::new(wait::WaitHandler));
registry
}
#[cfg(test)]
mod tests {
use fabro_graphviz::graph::AttrValue;
use fabro_interview::AutoApproveInterviewer;
use super::*;
use crate::handler::agent::CodergenBackend;
struct TestHandler {
_name: String,
}
#[async_trait]
impl Handler for TestHandler {
async fn execute(
&self,
_node: &Node,
_context: &Context,
_graph: &Graph,
_run_dir: &Path,
_services: &EngineServices,
) -> Result<Outcome, Error> {
Ok(Outcome::success())
}
}
#[test]
fn resolve_by_explicit_type() {
let mut registry = HandlerRegistry::new(Box::new(TestHandler {
_name: "default".to_string(),
}));
registry.register(
"human",
Box::new(TestHandler {
_name: "human".to_string(),
}),
);
let mut node = Node::new("gate");
node.attrs
.insert("type".to_string(), AttrValue::String("human".to_string()));
let handler = registry.resolve(&node);
// We can verify it returns the right handler by checking it doesn't panic
// and returns a valid reference
let _ = handler;
}
#[test]
fn resolve_by_shape() {
let mut registry = HandlerRegistry::new(Box::new(TestHandler {
_name: "default".to_string(),
}));
registry.register(
"start",
Box::new(TestHandler {
_name: "start".to_string(),
}),
);
let mut node = Node::new("entry");
node.attrs.insert(
"shape".to_string(),
AttrValue::String("Mdiamond".to_string()),
);
let handler = registry.resolve(&node);
let _ = handler;
}
#[test]
fn resolve_falls_back_to_default() {
let registry = HandlerRegistry::new(Box::new(TestHandler {
_name: "default".to_string(),
}));
let node = Node::new("work");
let handler = registry.resolve(&node);
let _ = handler;
}
#[test]
fn default_should_retry_uses_is_retryable() {
let handler = TestHandler {
_name: "test".to_string(),
};
assert!(handler.should_retry(&Error::handler("timeout".to_string())));
assert!(!handler.should_retry(&Error::Parse("bad".to_string())));
}
#[test]
fn timeout_policy_defaults_to_executor_enforced() {
let handler = TestHandler {
_name: "test".to_string(),
};
let node = Node::new("work");
assert_eq!(
handler.node_timeout_policy(&node),
NodeTimeoutPolicy::ExecutorEnforced
);
}
#[test]
fn built_in_handlers_that_consume_node_timeout_manage_it_themselves() {
let node = Node::new("work");
let human = human::HumanHandler::new(Arc::new(AutoApproveInterviewer::engine()));
let acp = llm::AgentAcpBackend::new();
assert_eq!(
human.node_timeout_policy(&node),
NodeTimeoutPolicy::HandlerManaged
);
assert_eq!(
command::CommandHandler.node_timeout_policy(&node),
NodeTimeoutPolicy::HandlerManaged
);
assert_eq!(
acp.node_timeout_policy(&node),
NodeTimeoutPolicy::HandlerManaged
);
}
#[test]
fn agent_handler_delegates_timeout_policy_to_backend() {
let node = Node::new("work");
let handler = agent::AgentHandler::new(Some(Box::new(llm::AgentAcpBackend::new())));
assert_eq!(
handler.node_timeout_policy(&node),
NodeTimeoutPolicy::HandlerManaged
);
}
struct NeverRetryHandler;
#[async_trait]
impl Handler for NeverRetryHandler {
async fn execute(
&self,
_node: &Node,
_context: &Context,
_graph: &Graph,
_run_dir: &Path,
_services: &EngineServices,
) -> Result<Outcome, Error> {
Ok(Outcome::success())
}
fn should_retry(&self, _err: &Error) -> bool {
false
}
}
#[test]
fn custom_should_retry_override() {
let handler = NeverRetryHandler;
assert!(!handler.should_retry(&Error::handler("timeout".to_string())));
assert!(!handler.should_retry(&Error::Io("connection reset".to_string())));
}
#[test]
fn register_replaces_existing() {
let mut registry = HandlerRegistry::new(Box::new(TestHandler {
_name: "default".to_string(),
}));
registry.register(
"start",
Box::new(TestHandler {
_name: "first".to_string(),
}),
);
registry.register(
"start",
Box::new(TestHandler {
_name: "second".to_string(),
}),
);
// Should not panic
let mut node = Node::new("s");
node.attrs.insert(
"shape".to_string(),
AttrValue::String("Mdiamond".to_string()),
);
let handler = registry.resolve(&node);
let _ = handler;
}
#[tokio::test]
async fn dispatch_handler_routes_to_simulate_when_dry_run() {
let handler = TestHandler {
_name: "test".to_string(),
};
let node = Node::new("my_node");
let context = Context::new();
let graph = Graph::new("test");
let run_dir = std::path::Path::new("/tmp/test");
let mut services = EngineServices::test_default();
services.dry_run = true;
let outcome = dispatch_handler(&handler, &node, &context, &graph, run_dir, &services)
.await
.unwrap();
assert_eq!(outcome.status, crate::outcome::StageOutcome::Succeeded);
assert_eq!(outcome.notes.as_deref(), Some("[Simulated] my_node"));
}
#[tokio::test]
async fn dispatch_handler_routes_to_execute_when_not_dry_run() {
let handler = TestHandler {
_name: "test".to_string(),
};
let node = Node::new("my_node");
let context = Context::new();
let graph = Graph::new("test");
let run_dir = std::path::Path::new("/tmp/test");
let mut services = EngineServices::test_default();
services.dry_run = false;
let outcome = dispatch_handler(&handler, &node, &context, &graph, run_dir, &services)
.await
.unwrap();
assert_eq!(outcome.status, crate::outcome::StageOutcome::Succeeded);
// execute() returns success with no notes
assert!(outcome.notes.is_none());
}
}