PicoBot/src/tools/registry.rs
oudecheng cea4bd3cfb feat: 子代理支持数据驱动的工具过滤(白名单+黑名单),删除内置 explore
SUBAGENT.md frontmatter 新增 denied_tools 黑名单字段,启用已有的 allowed_tools 白名单;新增 ToolRegistry::only 白名单方法;抽取 build_subagent_tools_registry(白名单→黑名单→depth 兜底);安全修复:resume 在 def 失踪时拒绝恢复而非降级为完整工具集(避免权限提升);depth 阈值改为引用 max_nesting_depth 配置;SubagentWithStatus 暴露工具字段供前端只读展示;删除内置 explore 子代理及专属 explore_max_execution_secs 配置(全栈清理);新增 23 个测试覆盖过滤矩阵、frontmatter 解析、状态投影
2026-07-09 14:42:38 +08:00

191 lines
5.6 KiB
Rust

use std::collections::HashMap;
use std::sync::{Arc, RwLock};
use crate::domain::tools::{Tool, ToolFunction};
use super::traits::Tool as ToolTrait;
pub struct ToolRegistry {
tools: RwLock<HashMap<String, Arc<dyn ToolTrait>>>,
}
impl ToolRegistry {
pub fn new() -> Self {
Self {
tools: RwLock::new(HashMap::new()),
}
}
pub fn register<T: ToolTrait + 'static>(&self, tool: T) {
self.tools
.write()
.expect("ToolRegistry lock poisoned")
.insert(tool.name().to_string(), Arc::new(tool));
}
pub fn get(&self, name: &str) -> Option<Arc<dyn ToolTrait>> {
self.tools
.read()
.expect("ToolRegistry lock poisoned")
.get(name)
.cloned()
}
/// Get all registered tools.
/// Used for concurrent tool execution when we need to look up tools by name.
pub fn get_all(&self) -> Vec<Arc<dyn ToolTrait>> {
self.tools
.read()
.expect("ToolRegistry lock poisoned")
.values()
.cloned()
.collect()
}
pub fn get_definitions(&self) -> Vec<Tool> {
self.tools
.read()
.expect("ToolRegistry lock poisoned")
.values()
.map(|tool| Tool {
tool_type: "function".to_string(),
function: ToolFunction {
name: tool.name().to_string(),
description: tool.description().to_string(),
parameters: tool.parameters_schema(),
},
})
.collect()
}
pub fn has_tools(&self) -> bool {
!self.tools
.read()
.expect("ToolRegistry lock poisoned")
.is_empty()
}
pub fn tool_names(&self) -> Vec<String> {
self.tools
.read()
.expect("ToolRegistry lock poisoned")
.keys()
.cloned()
.collect()
}
/// 创建一个排除指定工具的新 registry 副本
pub fn without(&self, exclude: &[&str]) -> Self {
let exclude_set: std::collections::HashSet<&str> = exclude.iter().copied().collect();
let tools = self.tools.read().expect("ToolRegistry lock poisoned");
let filtered: HashMap<String, Arc<dyn ToolTrait>> = tools
.iter()
.filter(|(name, _)| !exclude_set.contains(name.as_str()))
.map(|(k, v)| (k.clone(), v.clone()))
.collect();
let new_registry = ToolRegistry::new();
*new_registry.tools.write().expect("ToolRegistry lock poisoned") = filtered;
new_registry
}
/// 创建一个仅包含指定工具的新 registry 副本(白名单)。
/// include 中不存在于当前 registry 的名称会被静默跳过(取交集语义)。
pub fn only(&self, include: &[&str]) -> Self {
let include_set: std::collections::HashSet<&str> = include.iter().copied().collect();
let tools = self.tools.read().expect("ToolRegistry lock poisoned");
let filtered: HashMap<String, Arc<dyn ToolTrait>> = tools
.iter()
.filter(|(name, _)| include_set.contains(name.as_str()))
.map(|(k, v)| (k.clone(), v.clone()))
.collect();
let new_registry = ToolRegistry::new();
*new_registry.tools.write().expect("ToolRegistry lock poisoned") = filtered;
new_registry
}
}
impl Default for ToolRegistry {
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::tools::traits::ToolResult;
use async_trait::async_trait;
/// 仅用于测试的占位工具,按构造名注册
struct FakeTool {
tool_name: String,
}
#[async_trait]
impl ToolTrait for FakeTool {
fn name(&self) -> &str {
&self.tool_name
}
fn description(&self) -> &str {
"fake"
}
fn parameters_schema(&self) -> serde_json::Value {
serde_json::json!({})
}
async fn execute(&self, _args: serde_json::Value) -> anyhow::Result<ToolResult> {
Ok(ToolResult {
success: true,
output: String::new(),
error: None,
})
}
}
fn registry_with(names: &[&str]) -> ToolRegistry {
let reg = ToolRegistry::new();
for n in names {
reg.register(FakeTool {
tool_name: n.to_string(),
});
}
reg
}
fn sorted_names(reg: &ToolRegistry) -> Vec<String> {
let mut v = reg.tool_names();
v.sort();
v
}
#[test]
fn only_keeps_listed_tools() {
let reg = registry_with(&["read", "edit", "write", "bash"]);
let filtered = reg.only(&["read", "bash"]);
assert_eq!(sorted_names(&filtered), vec!["bash", "read"]);
}
#[test]
fn only_silently_skips_missing_names() {
let reg = registry_with(&["read", "edit"]);
let filtered = reg.only(&["read", "nonexistent", "glob"]);
assert_eq!(sorted_names(&filtered), vec!["read"]);
}
#[test]
fn only_with_empty_include_returns_empty() {
let reg = registry_with(&["read", "edit"]);
let filtered = reg.only(&[]);
assert!(filtered.tool_names().is_empty());
}
#[test]
fn only_does_not_mutate_source() {
let reg = registry_with(&["read", "edit", "write"]);
let _ = reg.only(&["read"]);
// 源 registry 不受影响
let mut v = reg.tool_names();
v.sort();
assert_eq!(v, vec!["edit", "read", "write"]);
}
}