store.py 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063
  1. """
  2. 文件系统 Trace 存储实现。
  3. Runner、Trace API 和 Sub-Agent 共享 .trace/ 目录中的血缘、消息与 Goal 数据;
  4. Recursive 资源预算还在根 Trace 目录内维护独立的用量快照。
  5. 目录结构:
  6. .trace/{trace_id}/
  7. ├── meta.json # Trace 元数据
  8. ├── goal.json # GoalTree(扁平 JSON,通过 parent_id 构建层级)
  9. ├── resource_usage.json # Recursive 根 Trace 的树级资源用量
  10. ├── messages/ # Messages(每条独立文件)
  11. │ ├── {message_id}.json
  12. │ └── ...
  13. └── events.jsonl # 事件流(WebSocket 续传)
  14. Sub-Trace 是完全独立的 Trace,有自己的目录:
  15. .trace/{parent_id}@{mode}-{timestamp}-{seq}/
  16. ├── meta.json # parent_trace_id 指向父 Trace
  17. ├── goal.json
  18. ├── messages/
  19. └── events.jsonl
  20. """
  21. import json
  22. import logging
  23. import os
  24. import tempfile
  25. from datetime import datetime
  26. from pathlib import Path
  27. from typing import Dict, List, Optional, Any
  28. from .models import Trace, Message
  29. from .goal_models import GoalTree, Goal, GoalStats
  30. logger = logging.getLogger(__name__)
  31. class FileSystemTraceStore:
  32. """按 Trace 分目录持久化数据的 TraceStore 默认实现。
  33. 它实现 protocols.TraceStore,由 Runner、API、Goal 工具和 ResourceBudgetController 共用。"""
  34. def __init__(self, base_path: str = ".trace"):
  35. self.base_path = Path(base_path)
  36. self.base_path.mkdir(exist_ok=True)
  37. def _get_trace_dir(self, trace_id: str) -> Path:
  38. """获取 trace 目录"""
  39. return self.base_path / trace_id
  40. def _get_meta_file(self, trace_id: str) -> Path:
  41. """获取 meta.json 文件路径"""
  42. return self._get_trace_dir(trace_id) / "meta.json"
  43. def _get_goal_file(self, trace_id: str) -> Path:
  44. """获取 goal.json 文件路径"""
  45. return self._get_trace_dir(trace_id) / "goal.json"
  46. def _get_messages_dir(self, trace_id: str) -> Path:
  47. """获取 messages 目录"""
  48. return self._get_trace_dir(trace_id) / "messages"
  49. def _get_message_file(self, trace_id: str, message_id: str) -> Path:
  50. """获取 message 文件路径"""
  51. return self._get_messages_dir(trace_id) / f"{message_id}.json"
  52. def _get_events_file(self, trace_id: str) -> Path:
  53. """获取 events.jsonl 文件路径"""
  54. return self._get_trace_dir(trace_id) / "events.jsonl"
  55. def _get_model_usage_file(self, trace_id: str) -> Path:
  56. """获取 model_usage.json 文件路径"""
  57. return self._get_trace_dir(trace_id) / "model_usage.json"
  58. def _get_resource_usage_file(self, root_trace_id: str) -> Path:
  59. """获取根 Trace 的 resource_usage.json 文件路径。"""
  60. return self._get_trace_dir(root_trace_id) / "resource_usage.json"
  61. # ===== Trace 操作 =====
  62. async def create_trace(self, trace: Trace) -> str:
  63. """创建新的 Trace"""
  64. trace_dir = self._get_trace_dir(trace.trace_id)
  65. trace_dir.mkdir(exist_ok=True)
  66. # 创建 messages 目录
  67. messages_dir = self._get_messages_dir(trace.trace_id)
  68. messages_dir.mkdir(exist_ok=True)
  69. # 写入 meta.json
  70. meta_file = self._get_meta_file(trace.trace_id)
  71. meta_file.write_text(json.dumps(trace.to_dict(), indent=2, ensure_ascii=False), encoding="utf-8")
  72. # 创建空的 events.jsonl
  73. events_file = self._get_events_file(trace.trace_id)
  74. events_file.touch()
  75. return trace.trace_id
  76. async def get_trace(self, trace_id: str) -> Optional[Trace]:
  77. """获取 Trace"""
  78. meta_file = self._get_meta_file(trace_id)
  79. if not meta_file.exists():
  80. return None
  81. data = json.loads(meta_file.read_text(encoding="utf-8"))
  82. # 解析 datetime 字段
  83. if data.get("created_at"):
  84. data["created_at"] = datetime.fromisoformat(data["created_at"])
  85. if data.get("completed_at"):
  86. data["completed_at"] = datetime.fromisoformat(data["completed_at"])
  87. return Trace.from_dict(data)
  88. async def update_trace(self, trace_id: str, **updates) -> None:
  89. """更新 Trace"""
  90. trace = await self.get_trace(trace_id)
  91. if not trace:
  92. return
  93. # 更新字段
  94. for key, value in updates.items():
  95. if hasattr(trace, key):
  96. setattr(trace, key, value)
  97. # 写回文件
  98. meta_file = self._get_meta_file(trace_id)
  99. meta_file.write_text(json.dumps(trace.to_dict(), indent=2, ensure_ascii=False), encoding="utf-8")
  100. async def list_traces(
  101. self,
  102. mode: Optional[str] = None,
  103. agent_type: Optional[str] = None,
  104. uid: Optional[str] = None,
  105. status: Optional[str] = None,
  106. limit: int = 50,
  107. parent_trace_id: Optional[str] = None,
  108. created_by_tool: Optional[str] = None,
  109. ) -> List[Trace]:
  110. """扫描 meta.json 并在截断前完成所有过滤。
  111. Sub-Agent Spawn Guard 依赖父 Trace 和 created_by_tool 条件,避免 Validator 混入六孩子配额。"""
  112. traces = []
  113. if not self.base_path.exists():
  114. return []
  115. for trace_dir in self.base_path.iterdir():
  116. if not trace_dir.is_dir():
  117. continue
  118. meta_file = trace_dir / "meta.json"
  119. if not meta_file.exists():
  120. continue
  121. try:
  122. data = json.loads(meta_file.read_text(encoding="utf-8"))
  123. # 过滤
  124. if mode and data.get("mode") != mode:
  125. continue
  126. if agent_type and data.get("agent_type") != agent_type:
  127. continue
  128. if uid and data.get("uid") != uid:
  129. continue
  130. if status and data.get("status") != status:
  131. continue
  132. if parent_trace_id and data.get("parent_trace_id") != parent_trace_id:
  133. continue
  134. if created_by_tool and data.get("context", {}).get("created_by_tool") != created_by_tool:
  135. continue
  136. # 解析 datetime
  137. if data.get("created_at"):
  138. data["created_at"] = datetime.fromisoformat(data["created_at"])
  139. if data.get("completed_at"):
  140. data["completed_at"] = datetime.fromisoformat(data["completed_at"])
  141. traces.append(Trace.from_dict(data))
  142. except Exception:
  143. continue
  144. # 排序(最新的在前)
  145. traces.sort(key=lambda t: t.created_at, reverse=True)
  146. return traces[:limit]
  147. # ===== Recursive 树级资源用量 =====
  148. async def get_resource_usage(
  149. self,
  150. root_trace_id: str,
  151. ) -> Optional[Dict[str, Any]]:
  152. """读取根 Trace 的树级用量快照。
  153. ResourceBudgetController 在进程内锁中调用;文件缺失由上层按 fail closed 处理。"""
  154. usage_file = self._get_resource_usage_file(root_trace_id)
  155. if not usage_file.exists():
  156. return None
  157. data = json.loads(usage_file.read_text(encoding="utf-8"))
  158. if not isinstance(data, dict):
  159. raise ValueError("resource_usage.json must contain an object")
  160. return data
  161. async def replace_resource_usage(
  162. self,
  163. root_trace_id: str,
  164. usage: Dict[str, Any],
  165. ) -> None:
  166. """通过同目录临时文件 + os.replace 原子替换用量快照。
  167. ResourceBudgetController 在 Agent/LLM 预留和 Token/成本登记后调用,避免单进程留下半写入文件。"""
  168. trace_dir = self._get_trace_dir(root_trace_id)
  169. trace_dir.mkdir(exist_ok=True)
  170. usage_file = self._get_resource_usage_file(root_trace_id)
  171. temp_path: Optional[str] = None
  172. try:
  173. with tempfile.NamedTemporaryFile(
  174. mode="w",
  175. encoding="utf-8",
  176. dir=trace_dir,
  177. prefix=".resource_usage.",
  178. suffix=".tmp",
  179. delete=False,
  180. ) as temp_file:
  181. temp_path = temp_file.name
  182. json.dump(usage, temp_file, indent=2, ensure_ascii=False)
  183. temp_file.flush()
  184. os.fsync(temp_file.fileno())
  185. os.replace(temp_path, usage_file)
  186. temp_path = None
  187. finally:
  188. if temp_path is not None:
  189. try:
  190. os.unlink(temp_path)
  191. except FileNotFoundError:
  192. pass
  193. # ===== GoalTree 操作 =====
  194. async def get_goal_tree(self, trace_id: str) -> Optional[GoalTree]:
  195. """获取 GoalTree"""
  196. goal_file = self._get_goal_file(trace_id)
  197. if not goal_file.exists():
  198. return None
  199. try:
  200. data = json.loads(goal_file.read_text(encoding="utf-8"))
  201. return GoalTree.from_dict(data)
  202. except Exception:
  203. return None
  204. async def update_goal_tree(self, trace_id: str, tree: GoalTree) -> None:
  205. """更新完整 GoalTree"""
  206. goal_file = self._get_goal_file(trace_id)
  207. goal_file.write_text(json.dumps(tree.to_dict(), indent=2, ensure_ascii=False), encoding="utf-8")
  208. async def add_goal(self, trace_id: str, goal: Goal) -> None:
  209. """添加 Goal 到 GoalTree"""
  210. tree = await self.get_goal_tree(trace_id)
  211. if not tree:
  212. return
  213. tree.goals.append(goal)
  214. await self.update_goal_tree(trace_id, tree)
  215. # 推送 goal_added 事件
  216. event_data = {
  217. "goal": goal.to_dict(),
  218. "parent_id": goal.parent_id
  219. }
  220. await self.append_event(trace_id, "goal_added", event_data)
  221. # 打印详细的 goal 信息
  222. desc_preview = goal.description[:80] + "..." if len(goal.description) > 80 else goal.description
  223. print(f"[Goal Added] ID={goal.id}, Parent={goal.parent_id or 'root'}")
  224. print(f" 📝 {desc_preview}")
  225. if goal.reason:
  226. reason_preview = goal.reason[:60] + "..." if len(goal.reason) > 60 else goal.reason
  227. print(f" 💡 {reason_preview}")
  228. async def update_goal(
  229. self,
  230. trace_id: str,
  231. goal_id: str,
  232. *,
  233. cascade_completion: bool = True,
  234. **updates,
  235. ) -> None:
  236. """更新 Goal 并推送 goal_updated 事件。
  237. goal_tool、Sub-Agent 和审核工具调用它;Recursive 传入 cascade_completion=False,防止存储层代替父级完成。"""
  238. tree = await self.get_goal_tree(trace_id)
  239. if not tree:
  240. return
  241. goal = tree.find(goal_id)
  242. if not goal:
  243. return
  244. # 更新字段
  245. for key, value in updates.items():
  246. if hasattr(goal, key):
  247. # 特殊处理 stats 字段(可能是 dict)
  248. if key in ["self_stats", "cumulative_stats"] and isinstance(value, dict):
  249. value = GoalStats.from_dict(value)
  250. setattr(goal, key, value)
  251. await self.update_goal_tree(trace_id, tree)
  252. # 推送 goal_updated 事件
  253. # 如果状态变为 completed,检查是否需要级联完成父 Goal
  254. affected_goals = [{"goal_id": goal_id, "updates": updates}]
  255. if cascade_completion and updates.get("status") == "completed":
  256. # 检查级联完成:如果所有兄弟 Goal 都完成,父 Goal 也完成
  257. cascade_completed = await self._check_cascade_completion(trace_id, goal)
  258. affected_goals.extend(cascade_completed)
  259. await self.append_event(trace_id, "goal_updated", {
  260. "goal_id": goal_id,
  261. "updates": updates,
  262. "affected_goals": affected_goals
  263. })
  264. print(f"[DEBUG] Pushed goal_updated event: goal_id={goal_id}, updates={updates}, affected={len(affected_goals)}")
  265. # Goal 完成时触发知识评估
  266. if updates.get("status") in ["completed", "abandoned"]:
  267. pending = await self.get_pending_knowledge_entries(trace_id)
  268. if pending:
  269. # 在trace.context中设置标志,由runner主循环检查
  270. trace = await self.get_trace(trace_id)
  271. if trace:
  272. if not trace.context:
  273. trace.context = {}
  274. trace.context["pending_knowledge_eval"] = True
  275. trace.context["knowledge_eval_trigger"] = "goal_completion"
  276. await self.update_trace(trace_id, context=trace.context)
  277. logger.info(f"[Knowledge Eval] Goal {goal_id} 完成,设置评估标志,待评估知识: {len(pending)} 条")
  278. async def _check_cascade_completion(
  279. self,
  280. trace_id: str,
  281. completed_goal: Goal
  282. ) -> List[Dict[str, Any]]:
  283. """
  284. Legacy 的 Goal 级联完成:所有子 Goal 都 completed 或 abandoned 时自动完成父 Goal。
  285. update_goal() 只在 cascade_completion=True 时调用;Recursive 审核流明确禁用该路径。
  286. Args:
  287. trace_id: Trace ID
  288. completed_goal: 刚完成的 Goal
  289. Returns:
  290. 受影响的父 Goals 列表(自动完成的)
  291. """
  292. if not completed_goal.parent_id:
  293. return []
  294. tree = await self.get_goal_tree(trace_id)
  295. if not tree:
  296. return []
  297. affected = []
  298. parent = tree.find(completed_goal.parent_id)
  299. if not parent:
  300. return []
  301. # 获取父 Goal 的所有子 Goal
  302. children = tree.get_children(parent.id)
  303. # 检查是否所有子 Goal 都已完成(排除 abandoned)
  304. all_completed = all(
  305. child.status in ["completed", "abandoned"]
  306. for child in children
  307. )
  308. if all_completed and parent.status != "completed":
  309. # 自动完成父 Goal
  310. parent.status = "completed"
  311. if not parent.summary:
  312. # 生成自动摘要
  313. completed_count = sum(1 for c in children if c.status == "completed")
  314. parent.summary = f"所有子目标已完成 ({completed_count}/{len(children)})"
  315. await self.update_goal_tree(trace_id, tree)
  316. affected.append({
  317. "goal_id": parent.id,
  318. "status": "completed",
  319. "summary": parent.summary,
  320. "cumulative_stats": parent.cumulative_stats.to_dict()
  321. })
  322. # 递归检查祖父 Goal
  323. grandparent_affected = await self._check_cascade_completion(trace_id, parent)
  324. affected.extend(grandparent_affected)
  325. return affected
  326. # ===== Message 操作 =====
  327. async def add_message(self, message: Message) -> str:
  328. """
  329. 添加 Message
  330. 自动更新关联 Goal 的 stats(self_stats 和祖先的 cumulative_stats)
  331. """
  332. trace_id = message.trace_id
  333. # 1. 写入 message 文件
  334. messages_dir = self._get_messages_dir(trace_id)
  335. message_file = messages_dir / f"{message.message_id}.json"
  336. message_file.write_text(json.dumps(message.to_dict(), indent=2, ensure_ascii=False), encoding="utf-8")
  337. # 2. 更新 trace 统计
  338. trace = await self.get_trace(trace_id)
  339. if trace:
  340. trace.total_messages += 1
  341. trace.last_sequence = max(trace.last_sequence, message.sequence)
  342. # 累计 tokens(完整版)
  343. if message.prompt_tokens:
  344. trace.total_prompt_tokens += message.prompt_tokens
  345. if message.completion_tokens:
  346. trace.total_completion_tokens += message.completion_tokens
  347. if message.reasoning_tokens:
  348. trace.total_reasoning_tokens += message.reasoning_tokens
  349. if message.cache_creation_tokens:
  350. trace.total_cache_creation_tokens += message.cache_creation_tokens
  351. if message.cache_read_tokens:
  352. trace.total_cache_read_tokens += message.cache_read_tokens
  353. # 向后兼容:也更新 total_tokens
  354. if message.tokens:
  355. trace.total_tokens += message.tokens
  356. elif message.prompt_tokens or message.completion_tokens:
  357. trace.total_tokens += (message.prompt_tokens or 0) + (message.completion_tokens or 0)
  358. if message.cost:
  359. trace.total_cost += message.cost
  360. if message.duration_ms:
  361. trace.total_duration_ms += message.duration_ms
  362. # 更新 Trace
  363. await self.update_trace(
  364. trace_id,
  365. total_messages=trace.total_messages,
  366. last_sequence=trace.last_sequence,
  367. total_tokens=trace.total_tokens,
  368. total_prompt_tokens=trace.total_prompt_tokens,
  369. total_completion_tokens=trace.total_completion_tokens,
  370. total_reasoning_tokens=trace.total_reasoning_tokens,
  371. total_cache_creation_tokens=trace.total_cache_creation_tokens,
  372. total_cache_read_tokens=trace.total_cache_read_tokens,
  373. total_cost=trace.total_cost,
  374. total_duration_ms=trace.total_duration_ms
  375. )
  376. # 3. 更新 Goal stats
  377. await self._update_goal_stats(trace_id, message)
  378. # 4. 追加 message_added 事件
  379. affected_goals = await self._get_affected_goals(trace_id, message)
  380. event_id = await self.append_event(trace_id, "message_added", {
  381. "message": message.to_dict(),
  382. "affected_goals": affected_goals
  383. })
  384. if event_id:
  385. try:
  386. from . import websocket as trace_ws
  387. await trace_ws.broadcast_message_added(
  388. trace_id=trace_id,
  389. event_id=event_id,
  390. message_dict=message.to_dict(),
  391. affected_goals=affected_goals,
  392. )
  393. except Exception:
  394. logger.exception("Failed to broadcast message_added (trace_id=%s, event_id=%s)", trace_id, event_id)
  395. return message.message_id
  396. async def _update_goal_stats(self, trace_id: str, message: Message) -> None:
  397. """更新 Goal 的 self_stats 和祖先的 cumulative_stats"""
  398. tree = await self.get_goal_tree(trace_id)
  399. if not tree:
  400. return
  401. # 找到关联的 Goal
  402. goal = tree.find(message.goal_id)
  403. if not goal:
  404. return
  405. # 更新自身 self_stats
  406. goal.self_stats.message_count += 1
  407. if message.tokens:
  408. goal.self_stats.total_tokens += message.tokens
  409. if message.cost:
  410. goal.self_stats.total_cost += message.cost
  411. # TODO: 更新 preview(工具调用摘要)
  412. # 更新自身 cumulative_stats
  413. goal.cumulative_stats.message_count += 1
  414. if message.tokens:
  415. goal.cumulative_stats.total_tokens += message.tokens
  416. if message.cost:
  417. goal.cumulative_stats.total_cost += message.cost
  418. # 沿祖先链向上更新 cumulative_stats
  419. current_goal = goal
  420. while current_goal.parent_id:
  421. parent = tree.find(current_goal.parent_id)
  422. if not parent:
  423. break
  424. parent.cumulative_stats.message_count += 1
  425. if message.tokens:
  426. parent.cumulative_stats.total_tokens += message.tokens
  427. if message.cost:
  428. parent.cumulative_stats.total_cost += message.cost
  429. current_goal = parent
  430. # 保存更新后的 tree
  431. await self.update_goal_tree(trace_id, tree)
  432. async def _get_affected_goals(self, trace_id: str, message: Message) -> List[Dict[str, Any]]:
  433. """获取受影响的 Goals(自身 + 所有祖先)"""
  434. tree = await self.get_goal_tree(trace_id)
  435. if not tree:
  436. return []
  437. goal = tree.find(message.goal_id)
  438. if not goal:
  439. return []
  440. affected = []
  441. # 添加自身(包含 self_stats 和 cumulative_stats)
  442. affected.append({
  443. "goal_id": goal.id,
  444. "self_stats": goal.self_stats.to_dict(),
  445. "cumulative_stats": goal.cumulative_stats.to_dict()
  446. })
  447. # 添加所有祖先(仅 cumulative_stats)
  448. current_goal = goal
  449. while current_goal.parent_id:
  450. parent = tree.find(current_goal.parent_id)
  451. if not parent:
  452. break
  453. affected.append({
  454. "goal_id": parent.id,
  455. "cumulative_stats": parent.cumulative_stats.to_dict()
  456. })
  457. current_goal = parent
  458. return affected
  459. return affected
  460. async def get_message(self, message_id: str) -> Optional[Message]:
  461. """获取 Message(扫描所有 trace)"""
  462. for trace_dir in self.base_path.iterdir():
  463. if not trace_dir.is_dir():
  464. continue
  465. # 检查 messages 目录
  466. message_file = trace_dir / "messages" / f"{message_id}.json"
  467. if message_file.exists():
  468. try:
  469. data = json.loads(message_file.read_text(encoding="utf-8"))
  470. return Message.from_dict(data)
  471. except Exception:
  472. pass
  473. return None
  474. async def get_trace_messages(
  475. self,
  476. trace_id: str,
  477. ) -> List[Message]:
  478. """获取 Trace 的所有 Messages(包含所有分支,按 sequence 排序)"""
  479. messages_dir = self._get_messages_dir(trace_id)
  480. if not messages_dir.exists():
  481. return []
  482. messages = []
  483. for message_file in messages_dir.glob("*.json"):
  484. try:
  485. data = json.loads(message_file.read_text(encoding="utf-8"))
  486. msg = Message.from_dict(data)
  487. messages.append(msg)
  488. except Exception:
  489. continue
  490. # 按 sequence 排序
  491. messages.sort(key=lambda m: m.sequence)
  492. return messages
  493. async def get_main_path_messages(
  494. self,
  495. trace_id: str,
  496. head_sequence: int
  497. ) -> List[Message]:
  498. """
  499. 获取从 head_sequence 沿 parent_sequence 链回溯到 root 的完整路径
  500. 此函数是通用的路径追溯函数,返回从指定 head 到 root 的完整消息链。
  501. 只要 trace.head_sequence 管理正确(指向主路径),此函数自然返回主路径消息。
  502. 侧分支消息通过 parent_sequence 链自然被跳过(因为主路径的 parent 不指向侧分支)。
  503. Returns:
  504. 按 sequence 正序排列的路径 Message 列表
  505. """
  506. # 加载所有消息,建立 sequence -> Message 索引
  507. all_messages = await self.get_trace_messages(trace_id)
  508. messages_by_seq = {m.sequence: m for m in all_messages}
  509. # 从 head 沿 parent chain 回溯
  510. path = []
  511. seq = head_sequence
  512. while seq is not None:
  513. msg = messages_by_seq.get(seq)
  514. if not msg:
  515. break
  516. path.append(msg)
  517. seq = msg.parent_sequence
  518. # 反转为正序(root → head)
  519. path.reverse()
  520. return path
  521. async def get_messages_by_goal(
  522. self,
  523. trace_id: str,
  524. goal_id: str
  525. ) -> List[Message]:
  526. """获取指定 Goal 关联的所有 Messages"""
  527. all_messages = await self.get_trace_messages(trace_id)
  528. return [m for m in all_messages if m.goal_id == goal_id]
  529. async def update_message(self, message_id: str, **updates) -> None:
  530. """更新 Message 字段"""
  531. message = await self.get_message(message_id)
  532. if not message:
  533. return
  534. # 更新字段
  535. for key, value in updates.items():
  536. if hasattr(message, key):
  537. setattr(message, key, value)
  538. # 确定文件路径
  539. messages_dir = self._get_messages_dir(message.trace_id)
  540. message_file = messages_dir / f"{message_id}.json"
  541. message_file.write_text(json.dumps(message.to_dict(), indent=2, ensure_ascii=False), encoding="utf-8")
  542. async def abandon_messages_after(self, trace_id: str, cutoff_sequence: int) -> List[str]:
  543. """
  544. 将 sequence > cutoff_sequence 的 active messages 标记为 abandoned。
  545. 返回被 abandon 的 message_id 列表。
  546. """
  547. all_messages = await self.get_trace_messages(trace_id)
  548. abandoned_ids = []
  549. now = datetime.now()
  550. for msg in all_messages:
  551. if msg.sequence > cutoff_sequence and msg.status == "active":
  552. msg.status = "abandoned"
  553. msg.abandoned_at = now
  554. # 直接写回文件
  555. message_file = self._get_messages_dir(trace_id) / f"{msg.message_id}.json"
  556. message_file.write_text(
  557. json.dumps(msg.to_dict(), indent=2, ensure_ascii=False),
  558. encoding="utf-8"
  559. )
  560. abandoned_ids.append(msg.message_id)
  561. return abandoned_ids
  562. # ===== 模型使用追踪 =====
  563. async def record_model_usage(
  564. self,
  565. trace_id: str,
  566. sequence: int,
  567. role: str,
  568. model: str,
  569. prompt_tokens: int,
  570. completion_tokens: int,
  571. cache_read_tokens: int = 0,
  572. tool_name: Optional[str] = None,
  573. ) -> None:
  574. """
  575. 记录模型使用情况到 model_usage.json
  576. Args:
  577. trace_id: Trace ID
  578. sequence: 消息序号
  579. role: 角色(assistant/tool)
  580. model: 模型名称
  581. prompt_tokens: 输入tokens
  582. completion_tokens: 输出tokens
  583. cache_read_tokens: 缓存读取tokens
  584. tool_name: 工具名称(role=tool时)
  585. """
  586. usage_file = self._get_model_usage_file(trace_id)
  587. # 读取现有数据
  588. if usage_file.exists():
  589. data = json.loads(usage_file.read_text(encoding="utf-8"))
  590. else:
  591. data = {
  592. "summary": {
  593. "total_models": 0,
  594. "total_tokens": 0,
  595. "total_cache_read_tokens": 0,
  596. "agent_tokens": 0,
  597. "tool_tokens": 0,
  598. },
  599. "models": [],
  600. "timeline": [],
  601. }
  602. # 更新summary
  603. total_tokens = prompt_tokens + completion_tokens
  604. data["summary"]["total_tokens"] += total_tokens
  605. data["summary"]["total_cache_read_tokens"] += cache_read_tokens
  606. if role == "assistant":
  607. data["summary"]["agent_tokens"] += total_tokens
  608. source = "agent"
  609. else:
  610. data["summary"]["tool_tokens"] += total_tokens
  611. source = f"tool:{tool_name}" if tool_name else "tool"
  612. # 更新models列表
  613. model_entry = None
  614. for m in data["models"]:
  615. if m["model"] == model and m["source"] == source:
  616. model_entry = m
  617. break
  618. if model_entry:
  619. model_entry["prompt_tokens"] += prompt_tokens
  620. model_entry["completion_tokens"] += completion_tokens
  621. model_entry["total_tokens"] += total_tokens
  622. model_entry["cache_read_tokens"] += cache_read_tokens
  623. model_entry["call_count"] += 1
  624. else:
  625. data["models"].append({
  626. "model": model,
  627. "source": source,
  628. "prompt_tokens": prompt_tokens,
  629. "completion_tokens": completion_tokens,
  630. "total_tokens": total_tokens,
  631. "cache_read_tokens": cache_read_tokens,
  632. "call_count": 1,
  633. })
  634. data["summary"]["total_models"] = len(data["models"])
  635. # 添加到timeline
  636. timeline_entry = {
  637. "sequence": sequence,
  638. "role": role,
  639. "model": model,
  640. "prompt_tokens": prompt_tokens,
  641. "completion_tokens": completion_tokens,
  642. }
  643. if cache_read_tokens > 0:
  644. timeline_entry["cache_read_tokens"] = cache_read_tokens
  645. if tool_name:
  646. timeline_entry["tool_name"] = tool_name
  647. data["timeline"].append(timeline_entry)
  648. # 写回文件
  649. usage_file.write_text(json.dumps(data, indent=2, ensure_ascii=False), encoding="utf-8")
  650. # ===== 事件流操作(用于 WebSocket 断线续传)=====
  651. async def get_events(
  652. self,
  653. trace_id: str,
  654. since_event_id: int = 0
  655. ) -> List[Dict[str, Any]]:
  656. """获取事件流"""
  657. events_file = self._get_events_file(trace_id)
  658. if not events_file.exists():
  659. return []
  660. events = []
  661. with events_file.open('r', encoding='utf-8') as f:
  662. for line in f:
  663. try:
  664. event = json.loads(line.strip())
  665. if event.get("event_id", 0) > since_event_id:
  666. events.append(event)
  667. except Exception:
  668. continue
  669. return events
  670. async def append_event(
  671. self,
  672. trace_id: str,
  673. event_type: str,
  674. payload: Dict[str, Any]
  675. ) -> int:
  676. """追加事件,返回 event_id"""
  677. # 获取 trace 并递增 event_id
  678. trace = await self.get_trace(trace_id)
  679. if not trace:
  680. return 0
  681. trace.last_event_id += 1
  682. event_id = trace.last_event_id
  683. # 更新 trace 的 last_event_id
  684. await self.update_trace(trace_id, last_event_id=event_id)
  685. # 创建事件
  686. event = {
  687. "event_id": event_id,
  688. "event": event_type,
  689. "ts": datetime.now().isoformat(),
  690. **payload
  691. }
  692. # 追加到 events.jsonl
  693. events_file = self._get_events_file(trace_id)
  694. with events_file.open('a', encoding='utf-8') as f:
  695. f.write(json.dumps(event, ensure_ascii=False) + '\n')
  696. return event_id
  697. # ===== Cognition Log 管理 =====
  698. def _get_cognition_log_file(self, trace_id: str) -> Path:
  699. """获取 cognition_log.json 文件路径"""
  700. return self._get_trace_dir(trace_id) / "cognition_log.json"
  701. def _get_knowledge_log_file(self, trace_id: str) -> Path:
  702. """兼容旧接口:优先使用 cognition_log,回退到 knowledge_log"""
  703. cognition_file = self._get_cognition_log_file(trace_id)
  704. if cognition_file.exists():
  705. return cognition_file
  706. legacy_file = self._get_trace_dir(trace_id) / "knowledge_log.json"
  707. if legacy_file.exists():
  708. return legacy_file
  709. return cognition_file # 新建时用 cognition_log
  710. async def get_cognition_log(self, trace_id: str) -> Dict[str, Any]:
  711. """读取认知日志"""
  712. log_file = self._get_cognition_log_file(trace_id)
  713. if log_file.exists():
  714. return json.loads(log_file.read_text(encoding="utf-8"))
  715. # 兼容旧格式:如果只有 knowledge_log.json,读取并转换
  716. legacy_file = self._get_trace_dir(trace_id) / "knowledge_log.json"
  717. if legacy_file.exists():
  718. return json.loads(legacy_file.read_text(encoding="utf-8"))
  719. return {"trace_id": trace_id, "events": []}
  720. async def get_knowledge_log(self, trace_id: str) -> Dict[str, Any]:
  721. """兼容旧接口"""
  722. log = await self.get_cognition_log(trace_id)
  723. # 旧格式用 entries,新格式用 events
  724. if "entries" not in log and "events" in log:
  725. log["entries"] = log["events"]
  726. return log
  727. async def append_cognition_event(
  728. self,
  729. trace_id: str,
  730. event: Dict[str, Any],
  731. ) -> None:
  732. """追加认知事件到 cognition_log.json。
  733. 所有事件共有字段:
  734. type: str 事件类型(见下表)
  735. timestamp: str ISO 格式时间戳(框架自动写入)
  736. 已定义的事件类型及典型字段:
  737. type="query" — 知识注入查询(goal focus 时触发)
  738. sequence, goal_id, query, response, source_ids, sources
  739. type="evaluation" — 知识评估(Goal 完成/压缩前/任务结束触发)
  740. knowledge_id, eval_result{relevance, utility, notes}, trigger_event
  741. type="extraction_pending" — 反思侧分支暂存的待审核提取(Phase 1.2+)
  742. extraction_id, sequence, goal_id, branch_id, payload
  743. (payload 字段与 knowledge_save 参数一一对应)
  744. type="extraction_reviewed" — 人工审核决策(CLI / HTTP API 写入)
  745. extraction_id, decision("approve"/"edit"/"discard"), edited_payload?
  746. type="extraction_committed" — 已上传到 KnowHub
  747. extraction_id, knowledge_id
  748. type="reflection" — Dream 的 per-trace 反思摘要(Phase 2.4 / 3.1)
  749. sequence_range: [start, end] 本次反思覆盖的消息区间
  750. summary: str LLM 生成的反思摘要
  751. consumed_at: 可选, ISO 时间戳 当跨 trace 整合已消化此反思时写入
  752. 其他字段可按需附加,不做强校验(演进友好)。
  753. """
  754. log = await self.get_cognition_log(trace_id)
  755. if "events" not in log:
  756. log["events"] = log.pop("entries", [])
  757. event["timestamp"] = datetime.now().isoformat()
  758. log["events"].append(event)
  759. log_file = self._get_cognition_log_file(trace_id)
  760. log_file.write_text(json.dumps(log, indent=2, ensure_ascii=False), encoding="utf-8")
  761. async def append_knowledge_entry(
  762. self,
  763. trace_id: str,
  764. knowledge_id: str,
  765. goal_id: str,
  766. injected_at_sequence: int,
  767. task: str,
  768. content: str
  769. ) -> None:
  770. """兼容旧接口:追加知识注入记录(转换为 query 事件)"""
  771. await self.append_cognition_event(
  772. trace_id=trace_id,
  773. event={
  774. "type": "query",
  775. "sequence": injected_at_sequence,
  776. "goal_id": goal_id,
  777. "query": task,
  778. "response": "",
  779. "source_ids": [knowledge_id],
  780. "sources": [{"id": knowledge_id, "task": task, "content": content[:500]}],
  781. }
  782. )
  783. async def update_knowledge_evaluation(
  784. self,
  785. trace_id: str,
  786. knowledge_id: str,
  787. eval_result: Dict[str, Any],
  788. trigger_event: str
  789. ) -> None:
  790. """更新知识评估结果(兼容旧格式 + 新 cognition_log 格式)
  791. 旧格式:更新 entries[] 中匹配 knowledge_id 的条目的 eval_result
  792. 新格式:追加 evaluation 事件到 events[]
  793. """
  794. log = await self.get_cognition_log(trace_id)
  795. events = log.get("events", log.get("entries", []))
  796. # 旧格式兼容:直接更新 entries 中的 eval_result 字段
  797. if "entries" in log:
  798. matching = [
  799. (i, e) for i, e in enumerate(log["entries"])
  800. if e.get("knowledge_id") == knowledge_id and e.get("eval_result") is None
  801. ]
  802. if matching:
  803. matching.sort(key=lambda x: x[1].get("injected_at_sequence", 0), reverse=True)
  804. _, entry = matching[0]
  805. entry["eval_result"] = eval_result
  806. entry["evaluated_at"] = datetime.now().isoformat()
  807. entry["evaluated_at_trigger"] = trigger_event
  808. log_file = self._get_knowledge_log_file(trace_id)
  809. log_file.write_text(json.dumps(log, indent=2, ensure_ascii=False), encoding="utf-8")
  810. return
  811. # 新格式:追加 evaluation 事件
  812. # 找到包含该 knowledge_id 的最近 query 事件
  813. query_events = [
  814. e for e in events
  815. if e.get("type") == "query" and knowledge_id in e.get("source_ids", [])
  816. ]
  817. query_sequence = query_events[-1]["sequence"] if query_events else None
  818. await self.append_cognition_event(
  819. trace_id=trace_id,
  820. event={
  821. "type": "evaluation",
  822. "sequence": max((e.get("sequence", 0) for e in events), default=0) + 1,
  823. "query_sequence": query_sequence,
  824. "trigger": trigger_event,
  825. "assessments": [
  826. {"source_id": knowledge_id, "status": eval_result.get("eval_status", ""), "reason": eval_result.get("reason", "")}
  827. ],
  828. }
  829. )
  830. async def get_pending_knowledge_entries(self, trace_id: str) -> List[Dict[str, Any]]:
  831. """获取所有待评估的知识条目(兼容旧格式 + 新格式)"""
  832. log = await self.get_cognition_log(trace_id)
  833. # 旧格式
  834. if "entries" in log:
  835. return [e for e in log["entries"] if e.get("eval_result") is None]
  836. # 新格式:找没有对应 evaluation 事件的 query 事件
  837. events = log.get("events", [])
  838. query_events = [e for e in events if e.get("type") == "query"]
  839. eval_events = [e for e in events if e.get("type") == "evaluation"]
  840. # 已评估的 query sequences
  841. evaluated_sequences = {e.get("query_sequence") for e in eval_events}
  842. pending = []
  843. for qe in query_events:
  844. if qe.get("sequence") not in evaluated_sequences:
  845. # 转为旧格式兼容(runner 中的评估逻辑期望此格式)
  846. for source in qe.get("sources", []):
  847. pending.append({
  848. "knowledge_id": source.get("id", ""),
  849. "goal_id": qe.get("goal_id", ""),
  850. "injected_at_sequence": qe.get("sequence", 0),
  851. "task": source.get("task", ""),
  852. "content": source.get("content", ""),
  853. "query_sequence": qe.get("sequence"),
  854. })
  855. return pending
  856. async def update_user_feedback(
  857. self,
  858. trace_id: str,
  859. knowledge_id: str,
  860. user_feedback: Dict[str, Any]
  861. ) -> None:
  862. """记录用户对知识的反馈(confirm/override)"""
  863. log = await self.get_cognition_log(trace_id)
  864. # 旧格式
  865. if "entries" in log:
  866. matching = [
  867. (i, e) for i, e in enumerate(log["entries"])
  868. if e.get("knowledge_id") == knowledge_id
  869. ]
  870. if matching:
  871. matching.sort(key=lambda x: x[1].get("injected_at_sequence", 0), reverse=True)
  872. _, entry = matching[0]
  873. entry["user_feedback"] = user_feedback
  874. log_file = self._get_knowledge_log_file(trace_id)
  875. log_file.write_text(json.dumps(log, indent=2, ensure_ascii=False), encoding="utf-8")
  876. return
  877. # 新格式:追加 user_feedback 事件(或直接记录在 evaluation 上)
  878. await self.append_cognition_event(
  879. trace_id=trace_id,
  880. event={
  881. "type": "user_feedback",
  882. "knowledge_id": knowledge_id,
  883. "feedback": user_feedback,
  884. }
  885. )