Files
openfang/crates/openfang-kernel/src/triggers.rs
iven 92e5def702
Some checks failed
CI / Check / macos-latest (push) Has been cancelled
CI / Check / ubuntu-latest (push) Has been cancelled
CI / Check / windows-latest (push) Has been cancelled
CI / Test / macos-latest (push) Has been cancelled
CI / Test / ubuntu-latest (push) Has been cancelled
CI / Test / windows-latest (push) Has been cancelled
CI / Clippy (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Security Audit (push) Has been cancelled
CI / Secrets Scan (push) Has been cancelled
CI / Install Script Smoke Test (push) Has been cancelled
初始化提交
2026-03-01 16:24:24 +08:00

512 lines
16 KiB
Rust

//! Event-driven agent triggers — agents auto-activate when events match patterns.
//!
//! Agents register triggers that describe which events should wake them.
//! When a matching event arrives on the EventBus, the trigger system
//! sends the event content as a message to the subscribing agent.
use chrono::{DateTime, Utc};
use dashmap::DashMap;
use openfang_types::agent::AgentId;
use openfang_types::event::{Event, EventPayload, LifecycleEvent, SystemEvent};
use serde::{Deserialize, Serialize};
use tracing::{debug, info};
use uuid::Uuid;
/// Unique identifier for a trigger.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TriggerId(pub Uuid);
impl TriggerId {
pub fn new() -> Self {
Self(Uuid::new_v4())
}
}
impl Default for TriggerId {
fn default() -> Self {
Self::new()
}
}
impl std::fmt::Display for TriggerId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}
/// What kind of events a trigger matches on.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TriggerPattern {
/// Match any lifecycle event (agent spawned, started, terminated, etc.).
Lifecycle,
/// Match when a specific agent is spawned.
AgentSpawned { name_pattern: String },
/// Match when any agent is terminated.
AgentTerminated,
/// Match any system event.
System,
/// Match a specific system event by keyword.
SystemKeyword { keyword: String },
/// Match any memory update event.
MemoryUpdate,
/// Match memory updates for a specific key pattern.
MemoryKeyPattern { key_pattern: String },
/// Match all events (wildcard).
All,
/// Match custom events by content substring.
ContentMatch { substring: String },
}
/// A registered trigger definition.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Trigger {
/// Unique trigger ID.
pub id: TriggerId,
/// Which agent owns this trigger.
pub agent_id: AgentId,
/// The event pattern to match.
pub pattern: TriggerPattern,
/// Prompt template to send when triggered. Use `{{event}}` for event description.
pub prompt_template: String,
/// Whether this trigger is currently active.
pub enabled: bool,
/// When this trigger was created.
pub created_at: DateTime<Utc>,
/// How many times this trigger has fired.
pub fire_count: u64,
/// Maximum number of times this trigger can fire (0 = unlimited).
pub max_fires: u64,
}
/// The trigger engine manages event-to-agent routing.
pub struct TriggerEngine {
/// All registered triggers.
triggers: DashMap<TriggerId, Trigger>,
/// Index: agent_id → list of trigger IDs belonging to that agent.
agent_triggers: DashMap<AgentId, Vec<TriggerId>>,
}
impl TriggerEngine {
/// Create a new trigger engine.
pub fn new() -> Self {
Self {
triggers: DashMap::new(),
agent_triggers: DashMap::new(),
}
}
/// Register a new trigger.
pub fn register(
&self,
agent_id: AgentId,
pattern: TriggerPattern,
prompt_template: String,
max_fires: u64,
) -> TriggerId {
let trigger = Trigger {
id: TriggerId::new(),
agent_id,
pattern,
prompt_template,
enabled: true,
created_at: Utc::now(),
fire_count: 0,
max_fires,
};
let id = trigger.id;
self.triggers.insert(id, trigger);
self.agent_triggers.entry(agent_id).or_default().push(id);
info!(trigger_id = %id, agent_id = %agent_id, "Trigger registered");
id
}
/// Remove a trigger.
pub fn remove(&self, trigger_id: TriggerId) -> bool {
if let Some((_, trigger)) = self.triggers.remove(&trigger_id) {
if let Some(mut list) = self.agent_triggers.get_mut(&trigger.agent_id) {
list.retain(|id| *id != trigger_id);
}
true
} else {
false
}
}
/// Remove all triggers for an agent.
pub fn remove_agent_triggers(&self, agent_id: AgentId) {
if let Some((_, trigger_ids)) = self.agent_triggers.remove(&agent_id) {
for id in trigger_ids {
self.triggers.remove(&id);
}
}
}
/// Enable or disable a trigger. Returns true if the trigger was found.
pub fn set_enabled(&self, trigger_id: TriggerId, enabled: bool) -> bool {
if let Some(mut t) = self.triggers.get_mut(&trigger_id) {
t.enabled = enabled;
true
} else {
false
}
}
/// List all triggers for an agent.
pub fn list_agent_triggers(&self, agent_id: AgentId) -> Vec<Trigger> {
self.agent_triggers
.get(&agent_id)
.map(|ids| {
ids.iter()
.filter_map(|id| self.triggers.get(id).map(|t| t.clone()))
.collect()
})
.unwrap_or_default()
}
/// List all registered triggers.
pub fn list_all(&self) -> Vec<Trigger> {
self.triggers.iter().map(|e| e.value().clone()).collect()
}
/// Evaluate an event against all triggers. Returns a list of
/// (agent_id, message_to_send) pairs for matching triggers.
pub fn evaluate(&self, event: &Event) -> Vec<(AgentId, String)> {
let event_description = describe_event(event);
let mut matches = Vec::new();
for mut entry in self.triggers.iter_mut() {
let trigger = entry.value_mut();
if !trigger.enabled {
continue;
}
// Check max fires
if trigger.max_fires > 0 && trigger.fire_count >= trigger.max_fires {
trigger.enabled = false;
continue;
}
if matches_pattern(&trigger.pattern, event, &event_description) {
let message = trigger
.prompt_template
.replace("{{event}}", &event_description);
matches.push((trigger.agent_id, message));
trigger.fire_count += 1;
debug!(
trigger_id = %trigger.id,
agent_id = %trigger.agent_id,
fire_count = trigger.fire_count,
"Trigger fired"
);
}
}
matches
}
/// Get a trigger by ID.
pub fn get(&self, trigger_id: TriggerId) -> Option<Trigger> {
self.triggers.get(&trigger_id).map(|t| t.clone())
}
}
impl Default for TriggerEngine {
fn default() -> Self {
Self::new()
}
}
/// Check if an event matches a trigger pattern.
fn matches_pattern(pattern: &TriggerPattern, event: &Event, description: &str) -> bool {
match pattern {
TriggerPattern::All => true,
TriggerPattern::Lifecycle => {
matches!(event.payload, EventPayload::Lifecycle(_))
}
TriggerPattern::AgentSpawned { name_pattern } => {
if let EventPayload::Lifecycle(LifecycleEvent::Spawned { name, .. }) = &event.payload {
name.contains(name_pattern.as_str()) || name_pattern == "*"
} else {
false
}
}
TriggerPattern::AgentTerminated => matches!(
event.payload,
EventPayload::Lifecycle(LifecycleEvent::Terminated { .. })
| EventPayload::Lifecycle(LifecycleEvent::Crashed { .. })
),
TriggerPattern::System => {
matches!(event.payload, EventPayload::System(_))
}
TriggerPattern::SystemKeyword { keyword } => {
if let EventPayload::System(se) = &event.payload {
let se_str = format!("{:?}", se).to_lowercase();
se_str.contains(&keyword.to_lowercase())
} else {
false
}
}
TriggerPattern::MemoryUpdate => {
matches!(event.payload, EventPayload::MemoryUpdate(_))
}
TriggerPattern::MemoryKeyPattern { key_pattern } => {
if let EventPayload::MemoryUpdate(delta) = &event.payload {
delta.key.contains(key_pattern.as_str()) || key_pattern == "*"
} else {
false
}
}
TriggerPattern::ContentMatch { substring } => description
.to_lowercase()
.contains(&substring.to_lowercase()),
}
}
/// Create a human-readable description of an event for use in prompts.
fn describe_event(event: &Event) -> String {
match &event.payload {
EventPayload::Message(msg) => {
format!("Message from {:?}: {}", msg.role, msg.content)
}
EventPayload::ToolResult(tr) => {
format!(
"Tool '{}' {} ({}ms): {}",
tr.tool_id,
if tr.success { "succeeded" } else { "failed" },
tr.execution_time_ms,
&tr.content[..tr.content.len().min(200)]
)
}
EventPayload::MemoryUpdate(delta) => {
format!(
"Memory {:?} on key '{}' for agent {}",
delta.operation, delta.key, delta.agent_id
)
}
EventPayload::Lifecycle(le) => match le {
LifecycleEvent::Spawned { agent_id, name } => {
format!("Agent '{name}' (id: {agent_id}) was spawned")
}
LifecycleEvent::Started { agent_id } => {
format!("Agent {agent_id} started")
}
LifecycleEvent::Suspended { agent_id } => {
format!("Agent {agent_id} suspended")
}
LifecycleEvent::Resumed { agent_id } => {
format!("Agent {agent_id} resumed")
}
LifecycleEvent::Terminated { agent_id, reason } => {
format!("Agent {agent_id} terminated: {reason}")
}
LifecycleEvent::Crashed { agent_id, error } => {
format!("Agent {agent_id} crashed: {error}")
}
},
EventPayload::Network(ne) => {
format!("Network event: {:?}", ne)
}
EventPayload::System(se) => match se {
SystemEvent::KernelStarted => "Kernel started".to_string(),
SystemEvent::KernelStopping => "Kernel stopping".to_string(),
SystemEvent::QuotaWarning {
agent_id,
resource,
usage_percent,
} => format!("Quota warning: agent {agent_id}, {resource} at {usage_percent:.1}%"),
SystemEvent::HealthCheck { status } => {
format!("Health check: {status}")
}
SystemEvent::QuotaEnforced {
agent_id,
spent,
limit,
} => {
format!("Quota enforced: agent {agent_id}, spent ${spent:.4} / ${limit:.4}")
}
SystemEvent::ModelRouted {
agent_id,
complexity,
model,
} => {
format!("Model routed: agent {agent_id}, complexity={complexity}, model={model}")
}
SystemEvent::UserAction {
user_id,
action,
result,
} => {
format!("User action: {user_id} {action} -> {result}")
}
SystemEvent::HealthCheckFailed {
agent_id,
unresponsive_secs,
} => {
format!(
"Health check failed: agent {agent_id}, unresponsive for {unresponsive_secs}s"
)
}
},
EventPayload::Custom(data) => {
format!("Custom event ({} bytes)", data.len())
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use openfang_types::event::*;
#[test]
fn test_register_trigger() {
let engine = TriggerEngine::new();
let agent_id = AgentId::new();
let id = engine.register(
agent_id,
TriggerPattern::All,
"Event occurred: {{event}}".to_string(),
0,
);
assert!(engine.get(id).is_some());
}
#[test]
fn test_evaluate_lifecycle() {
let engine = TriggerEngine::new();
let watcher = AgentId::new();
engine.register(
watcher,
TriggerPattern::Lifecycle,
"Lifecycle: {{event}}".to_string(),
0,
);
let event = Event::new(
AgentId::new(),
EventTarget::Broadcast,
EventPayload::Lifecycle(LifecycleEvent::Spawned {
agent_id: AgentId::new(),
name: "new-agent".to_string(),
}),
);
let matches = engine.evaluate(&event);
assert_eq!(matches.len(), 1);
assert_eq!(matches[0].0, watcher);
assert!(matches[0].1.contains("new-agent"));
}
#[test]
fn test_evaluate_agent_spawned_pattern() {
let engine = TriggerEngine::new();
let watcher = AgentId::new();
engine.register(
watcher,
TriggerPattern::AgentSpawned {
name_pattern: "coder".to_string(),
},
"Coder spawned: {{event}}".to_string(),
0,
);
// This should match
let event = Event::new(
AgentId::new(),
EventTarget::Broadcast,
EventPayload::Lifecycle(LifecycleEvent::Spawned {
agent_id: AgentId::new(),
name: "coder".to_string(),
}),
);
assert_eq!(engine.evaluate(&event).len(), 1);
// This should NOT match
let event2 = Event::new(
AgentId::new(),
EventTarget::Broadcast,
EventPayload::Lifecycle(LifecycleEvent::Spawned {
agent_id: AgentId::new(),
name: "researcher".to_string(),
}),
);
assert_eq!(engine.evaluate(&event2).len(), 0);
}
#[test]
fn test_max_fires() {
let engine = TriggerEngine::new();
let agent_id = AgentId::new();
engine.register(
agent_id,
TriggerPattern::All,
"Event: {{event}}".to_string(),
2, // max 2 fires
);
let event = Event::new(
AgentId::new(),
EventTarget::Broadcast,
EventPayload::System(SystemEvent::HealthCheck {
status: "ok".to_string(),
}),
);
// First two should match
assert_eq!(engine.evaluate(&event).len(), 1);
assert_eq!(engine.evaluate(&event).len(), 1);
// Third should not
assert_eq!(engine.evaluate(&event).len(), 0);
}
#[test]
fn test_remove_trigger() {
let engine = TriggerEngine::new();
let agent_id = AgentId::new();
let id = engine.register(agent_id, TriggerPattern::All, "msg".to_string(), 0);
assert!(engine.remove(id));
assert!(engine.get(id).is_none());
}
#[test]
fn test_remove_agent_triggers() {
let engine = TriggerEngine::new();
let agent_id = AgentId::new();
engine.register(agent_id, TriggerPattern::All, "a".to_string(), 0);
engine.register(agent_id, TriggerPattern::System, "b".to_string(), 0);
assert_eq!(engine.list_agent_triggers(agent_id).len(), 2);
engine.remove_agent_triggers(agent_id);
assert_eq!(engine.list_agent_triggers(agent_id).len(), 0);
}
#[test]
fn test_content_match() {
let engine = TriggerEngine::new();
let agent_id = AgentId::new();
engine.register(
agent_id,
TriggerPattern::ContentMatch {
substring: "quota".to_string(),
},
"Alert: {{event}}".to_string(),
0,
);
let event = Event::new(
AgentId::new(),
EventTarget::System,
EventPayload::System(SystemEvent::QuotaWarning {
agent_id: AgentId::new(),
resource: "tokens".to_string(),
usage_percent: 85.0,
}),
);
assert_eq!(engine.evaluate(&event).len(), 1);
}
}