重构: df-core改名df-types(类型库语义准+全workspace机械改名54处)

This commit is contained in:
2026-06-17 02:44:34 +08:00
parent a19f535134
commit 4be15912cd
40 changed files with 90 additions and 90 deletions

View File

@@ -0,0 +1,11 @@
[package]
name = "df-types"
version = "0.1.0"
edition = "2021"
[dependencies]
serde = { workspace = true }
serde_json = { workspace = true }
thiserror = { workspace = true }
chrono = { workspace = true }
uuid = { workspace = true }

View File

@@ -0,0 +1,49 @@
//! 统一错误类型定义
use thiserror::Error;
/// 统一错误类型
#[derive(Debug, Error)]
pub enum Error {
#[error("未找到: {0}")]
NotFound(String),
#[error("已存在: {0}")]
AlreadyExists(String),
#[error("验证失败: {0}")]
Validation(String),
#[error("状态错误: 当前状态 {current}, 期望 {expected}")]
InvalidState {
current: String,
expected: String,
},
#[error("工作流错误: {0}")]
Workflow(String),
#[error("执行错误: {0}")]
Execution(String),
#[error("存储错误: {0}")]
Storage(String),
#[error("插件错误: {0}")]
Plugin(String),
#[error("AI 提供者错误: {0}")]
AiProvider(String),
#[error("配置错误: {0}")]
Config(String),
#[error("IO 错误: {0}")]
Io(#[from] std::io::Error),
#[error("序列化错误: {0}")]
Serialization(#[from] serde_json::Error),
}
/// 统一 Result 别名
pub type Result<T> = std::result::Result<T, Error>;

View File

@@ -0,0 +1,105 @@
//! 工作流事件定义
use serde::{Deserialize, Serialize};
use crate::types::NodeId;
/// 人工审批选择类型(F-260615-01)
/// - Single: 单选(decision 单值),缺省值,向后兼容现有调用方
/// - Multiple: 多选(decisions 数组)
///
/// serde rename_all="snake_case" → "single"/"multiple"
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
#[serde(rename_all = "snake_case")]
pub enum SelectType {
#[default]
Single,
Multiple,
}
/// 人工审批响应
///
/// 兼容字段(decision 单值):仅 select_type=Single 时使用;
/// 新字段 decisions 数组:Single 时长度=1,Multiple 时长度≥1。
/// 旧调用方仍可只填 decision,HumanNode 下游兼容两者。
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HumanApprovalResponse {
pub execution_id: String,
pub node_id: NodeId,
pub decision: String,
#[serde(default)]
pub decisions: Vec<String>,
pub comment: Option<String>,
}
/// 工作流事件
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum WorkflowEvent {
/// 节点开始执行
NodeStarted {
node_id: NodeId,
},
/// 节点执行进度更新
NodeProgress {
node_id: NodeId,
progress: f32,
message: String,
},
/// 节点产生输出
NodeOutput {
node_id: NodeId,
output: String,
},
/// 节点执行完成
NodeCompleted {
node_id: NodeId,
duration_ms: u64,
},
/// 节点执行失败
NodeFailed {
node_id: NodeId,
error: String,
},
/// 节点执行被取消(如 HumanNode 人工审批取消:set_cancelled 后节点返回 Err,
/// 状态保 Cancelled 终态)。语义有别于 NodeFailed(失败):取消是用户主动行为,
/// 前端按取消归「取消」展示,不应归类「失败」。
NodeCancelled {
node_id: NodeId,
},
/// 工作流暂停(等待外部输入)
WorkflowPaused {
reason: String,
waiting_node: NodeId,
},
/// 工作流执行完成
WorkflowCompleted {
total_duration_ms: u64,
},
/// 工作流执行失败
WorkflowFailed {
error: String,
failed_node: NodeId,
},
/// 人工审批请求
HumanApprovalRequest {
execution_id: String,
node_id: NodeId,
title: String,
description: String,
options: Vec<String>,
/// F-260615-01: 选择类型,缺省 Single(向后兼容)
#[serde(default)]
select_type: SelectType,
},
/// 人工审批响应
HumanApprovalResponse {
execution_id: String,
node_id: NodeId,
decision: String,
/// F-260615-01: 多选结果(Single 模式长度=1,Multiple 模式长度≥1)
#[serde(default)]
decisions: Vec<String>,
comment: Option<String>,
},
}

View File

@@ -0,0 +1,8 @@
//! df-types: 核心类型定义,所有 crate 的基础依赖
pub mod error;
pub mod events;
pub mod types;
// 顶层 re-export:常用时间工具(跨 crate 调用方用 df_types::now_millis,避免 types:: 前缀)
pub use types::now_millis;

View File

@@ -0,0 +1,432 @@
//! 核心类型定义ID 别名、状态枚举、优先级等
use serde::{Deserialize, Serialize};
// ============================================================
// ID 类型别名
// ============================================================
/// 想法 ID
pub type IdeaId = String;
/// 项目 ID
pub type ProjectId = String;
/// 任务 ID
pub type TaskId = String;
/// 工作流 ID
pub type WorkflowId = String;
/// 节点 ID
pub type NodeId = String;
/// 发布 ID
pub type ReleaseId = String;
/// 分支 ID
pub type BranchId = String;
/// 插件 ID
pub type PluginId = String;
/// 执行 ID
pub type ExecutionId = String;
/// 决策 ID
pub type DecisionId = String;
// ============================================================
// 时间工具
// ============================================================
/// 当前 Unix 时间戳(毫秒)
///
/// 统一时间获取入口,避免 commands 层与 df-storage 层各写一份 SystemTime 调用(DRY)。
/// 需要字符串形式的调用方自行 `.to_string()`。
pub fn now_millis() -> i64 {
std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_millis() as i64
}
// ============================================================
// 状态枚举
// ============================================================
/// 想法状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum IdeaStatus {
/// 草稿
Draft,
/// 待评估
PendingReview,
/// 已批准
Approved,
/// 已拒绝
Rejected,
/// 已转为项目
Promoted,
/// 已归档
Archived,
}
impl IdeaStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
IdeaStatus::Draft => "draft",
IdeaStatus::PendingReview => "pending_review",
IdeaStatus::Approved => "approved",
IdeaStatus::Rejected => "rejected",
IdeaStatus::Promoted => "promoted",
IdeaStatus::Archived => "archived",
}
}
}
impl Default for IdeaStatus {
fn default() -> Self {
IdeaStatus::Draft
}
}
/// 项目状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ProjectStatus {
/// 规划中
Planning,
/// 开发中
InProgress,
/// 测试中
Testing,
/// 发布中
Releasing,
/// 已完成
Completed,
/// 已暂停
Paused,
/// 已取消
Cancelled,
}
impl ProjectStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
ProjectStatus::Planning => "planning",
ProjectStatus::InProgress => "in_progress",
ProjectStatus::Testing => "testing",
ProjectStatus::Releasing => "releasing",
ProjectStatus::Completed => "completed",
ProjectStatus::Paused => "paused",
ProjectStatus::Cancelled => "cancelled",
}
}
}
impl Default for ProjectStatus {
fn default() -> Self {
ProjectStatus::Planning
}
}
/// 任务状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TaskStatus {
/// 待开始
Todo,
/// 进行中
InProgress,
/// 代码审查中
InReview,
/// 测试中
Testing,
/// 已完成
Done,
/// 已阻塞
Blocked,
/// 已取消
Cancelled,
}
impl TaskStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
TaskStatus::Todo => "todo",
TaskStatus::InProgress => "in_progress",
TaskStatus::InReview => "in_review",
TaskStatus::Testing => "testing",
TaskStatus::Done => "done",
TaskStatus::Blocked => "blocked",
TaskStatus::Cancelled => "cancelled",
}
}
/// 校验字符串是否为合法的 TaskStatus 存储值(小写 snake_case
/// 用于落库前拦截拼写错误(如 "in-progess"、"in progress"、大小写错等),
/// 防止任意字符串静默落库导致按枚举查询全漏、任务"消失"。
pub fn is_valid(s: &str) -> bool {
matches!(
s,
"todo" | "in_progress" | "in_review" | "testing" | "done" | "blocked" | "cancelled"
)
}
/// 合法 status 值列表,用于错误提示。
pub fn valid_values() -> &'static [&'static str] {
&[
"todo",
"in_progress",
"in_review",
"testing",
"done",
"blocked",
"cancelled",
]
}
}
impl Default for TaskStatus {
fn default() -> Self {
TaskStatus::Todo
}
}
/// 工作流状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowStatus {
/// 待执行
Pending,
/// 运行中
Running,
/// 已暂停(等待人工输入等)
Paused,
/// 已完成
Completed,
/// 已失败
Failed,
/// 已取消
Cancelled,
}
impl WorkflowStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
WorkflowStatus::Pending => "pending",
WorkflowStatus::Running => "running",
WorkflowStatus::Paused => "paused",
WorkflowStatus::Completed => "completed",
WorkflowStatus::Failed => "failed",
WorkflowStatus::Cancelled => "cancelled",
}
}
}
impl Default for WorkflowStatus {
fn default() -> Self {
WorkflowStatus::Pending
}
}
/// 节点状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum NodeStatus {
/// 待执行
Pending,
/// 运行中
Running,
/// 已完成
Completed,
/// 已失败
Failed,
/// 已跳过
Skipped,
/// 等待中(如等待人工操作)
Waiting,
/// 已取消
Cancelled,
}
impl NodeStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
NodeStatus::Pending => "pending",
NodeStatus::Running => "running",
NodeStatus::Completed => "completed",
NodeStatus::Failed => "failed",
NodeStatus::Skipped => "skipped",
NodeStatus::Waiting => "waiting",
NodeStatus::Cancelled => "cancelled",
}
}
}
impl Default for NodeStatus {
fn default() -> Self {
NodeStatus::Pending
}
}
/// 分支状态
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum BranchStatus {
/// 活跃中
Active,
/// 已合并
Merged,
/// 已废弃
Abandoned,
}
impl BranchStatus {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
BranchStatus::Active => "active",
BranchStatus::Merged => "merged",
BranchStatus::Abandoned => "abandoned",
}
}
}
impl Default for BranchStatus {
fn default() -> Self {
BranchStatus::Active
}
}
/// 优先级
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Priority {
/// 低
Low = 0,
/// 中
Medium = 1,
/// 高
High = 2,
/// 紧急
Critical = 3,
}
impl Priority {
/// 返回数据库存储用的小写字符串
pub fn as_str(&self) -> &'static str {
match self {
Priority::Low => "low",
Priority::Medium => "medium",
Priority::High => "high",
Priority::Critical => "critical",
}
}
}
impl Default for Priority {
fn default() -> Self {
Priority::Medium
}
}
// ============================================================
// 辅助函数
// ============================================================
/// 生成新的 UUID v4 字符串
pub fn new_id() -> String {
uuid::Uuid::new_v4().to_string()
}
#[cfg(test)]
mod tests {
use super::TaskStatus;
// 合法值:覆盖全部枚举变体(与 as_str 一致)
#[test]
fn is_valid_accepts_all_variants() {
assert!(TaskStatus::is_valid("todo"));
assert!(TaskStatus::is_valid("in_progress"));
assert!(TaskStatus::is_valid("in_review"));
assert!(TaskStatus::is_valid("testing"));
assert!(TaskStatus::is_valid("done"));
assert!(TaskStatus::is_valid("blocked"));
assert!(TaskStatus::is_valid("cancelled"));
}
// as_str 与 is_valid 必须自洽:每个变体的存储值都应被 is_valid 接受
#[test]
fn is_valid_consistent_with_as_str() {
let all = [
TaskStatus::Todo,
TaskStatus::InProgress,
TaskStatus::InReview,
TaskStatus::Testing,
TaskStatus::Done,
TaskStatus::Blocked,
TaskStatus::Cancelled,
];
for v in all {
assert!(
TaskStatus::is_valid(v.as_str()),
"as_str({:?}) = {:?} 未被 is_valid 接受",
v,
v.as_str()
);
}
}
// 拼写错误(典型回归场景)
#[test]
fn is_valid_rejects_typos() {
assert!(!TaskStatus::is_valid("in-progess")); // 漏 r + 连字符
assert!(!TaskStatus::is_valid("in-progress")); // 连字符非下划线
assert!(!TaskStatus::is_valid("in progress")); // 空格
assert!(!TaskStatus::is_valid("inprogres")); // 漏 s
assert!(!TaskStatus::is_valid("tod")); // 截断
assert!(!TaskStatus::is_valid("don")); // 截断
assert!(!TaskStatus::is_valid("canceled")); // 美式拼写(单 l
assert!(!TaskStatus::is_valid("complete")); // 近义词
assert!(!TaskStatus::is_valid("pending")); // 近义词
}
// 大小写敏感
#[test]
fn is_valid_case_sensitive() {
assert!(!TaskStatus::is_valid("Todo"));
assert!(!TaskStatus::is_valid("TODO"));
assert!(!TaskStatus::is_valid("InProgress"));
assert!(!TaskStatus::is_valid("IN_PROGRESS"));
assert!(!TaskStatus::is_valid("Done"));
}
// 边界:空串、空白、前后空格、带前后缀
#[test]
fn is_valid_rejects_empty_and_whitespace() {
assert!(!TaskStatus::is_valid(""));
assert!(!TaskStatus::is_valid(" "));
assert!(!TaskStatus::is_valid(" todo")); // 前导空格
assert!(!TaskStatus::is_valid("todo ")); // 尾随空格
assert!(!TaskStatus::is_valid(" todo ")); // 两端空格
assert!(!TaskStatus::is_valid("todo\n")); // 换行
}
// 边界:非 ASCII / 注入尝试
#[test]
fn is_valid_rejects_garbage() {
assert!(!TaskStatus::is_valid("'; DROP TABLE tasks;--"));
assert!(!TaskStatus::is_valid("待开始")); // 中文近义
assert!(!TaskStatus::is_valid("todo;done"));
assert!(!TaskStatus::is_valid("todo,done"));
}
// valid_values 必须与 is_valid 自洽(防清单漏项)
#[test]
fn valid_values_all_pass_is_valid() {
for &v in TaskStatus::valid_values() {
assert!(TaskStatus::is_valid(v), "valid_values 含 {:?} 但 is_valid 拒绝", v);
}
// 数量应等于枚举变体数
assert_eq!(TaskStatus::valid_values().len(), 7);
}
}