Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 6.4 KB

File metadata and controls

58 lines (33 loc) · 6.4 KB

Agent Note: 结果时刻的 applied-hunk diff 用于文件变更

Status: implemented Archived: 2026-07-27

English | 中文

问题

带标签的 render-intent 联合类型dsh-tool-fs 的 write/edit 在调用时刻提供 card:'diff',纯粹从工具参数推导:write ⇒ {oldText:null, newText:content}(整个新文件),edit ⇒ {oldText:old_string, newText:new_string}(裸替换片段)。UI 可以将其渲染为行内 diff,但这是一个无上下文的 diff:裸的 old_stringnew_string 没有周围行,而一次触及五个分散位置的 replace_all 仍然渲染为一对片段。

在对接 claude-agent-acp 自身的 ACP(Agent Client Protocol) bridge 时可以看到完整编辑器 diff 的样子:变更应用后,它发出第二个 tool_call_update,其 diff 是带 ±3 行上下文的 applied hunkreplace_all 的每个变更位置各一个 hunk),由工具的 structuredPatch 重建。这个结果时刻的 hunk 正是让 Zed 在文件中原位显示变更(而非浮动片段)的关键。我们的工具止步于调用时刻的片段;完成后的结果只携带纯文本「updated successfully」,没有 diff。

障碍在于一个 seam 边界:presentResult(args, result)args + 面向模型的 result{content, isError})的纯函数——它在实时流式输出和会话日志回放中都会运行,因此必须具备回放确定性且不能做 I/O。它看不到文件的前后内容,而 FsEditOutcome/FsWriteOutcome 只携带替换计数和版本号,没有文本。因此无法计算——甚至无法携带——applied hunk 给 presenter。

决策

添加一个持久化的、工具私有的展示通道,使工具的 execute 能附加一个结果时刻的渲染载荷并在回放中存活,并用它来携带 applied-hunk diff。

1. 规范工具输出上的可回放展示投影(core)

原始实现允许 execute 返回 { content, meta }规范工具输出契约取代了这种编写形态:每个工具如今返回一个由 schema 声明的 JSON 值,output.render(args, value) 从中派生面向模型的内容块,可选的 output.presentationMeta(args, value) 则派生可回放的 UI 数据。

presentationMeta 是工具自有的 JsonValue,core 会持久化它,但不解释其中的字段。Session.append 将它与事件的其余部分一并校验,回放再把存储的载荷传回 presentResult;因此展示无需 I/O 或重新计算即可复现。规范值本身只存在于执行期间,不会加入会话格式。

这仍是通用形态(「工具投影持久化的结果展示」),而非 fs 特有;任何工具都可以使用。

2. 工具计算 hunk;后端返回 before/after(fs)

按照 capability-seam 拆分,存储后端只返回存储事实,面向模型的工具拥有展示

  • dsh-fsFsEditOutcome 扩展为包含 { before: string; after: string },将 FsWriteOutcome 扩展为包含 { before: string | null; after: string }before: null 表示创建,或已存在但不可 diff 的二进制/非 UTF-8 文件)。本地后端在写入时已持有两份文本;它以原始 LF 规范化文本返回,不让任何 diff/UI 概念进入 seam
  • dsh-tool-fs 返回规范的变更前/后事实,并将上下文 hunk 投影为 meta: { diffs: FileDiff[] }。成功的变更以 diff 视图完成:创建或无变化的覆写回退到由参数推导的整文件 diff,而编辑使用 applied hunk。失败的变更不携带 diff 元数据,正常渲染其错误信息。

3. UI 传输层渲染 diff 结果视图

ToolResultView 包含 DiffResultView { card:'diff'; title?; diffs: FileDiff[] }。TUI 与 JSON-RPC/Web 消费方在同一个带标签的视图上做 switch,用 applied 结果 hunk 替换待定调用的无上下文片段。仅面向自动化的 ACP 桥接层不承载工具展示。

曾考虑的替代方案

手写或 vendor diff 算法。 上下文 hunk 有已知的边界情况,因此 dsh-tool-fs 使用带类型的 diff 包,并在一个模块中规范化 structuredPatch 输出。仓库的 vendor 策略适用于框架源码,而非每个叶子工具库。

后果

tool/result 事件携带工具私有的 meta 载荷;它属于磁盘格式词汇的一部分,由 Session.append 在运行时限制为 JSON。任何工具都可以投影持久化的结果展示,无需再改 core。diff 卡片在会话重载和快照回放时免费复现:它从日志中读回,从不重新计算。代价:覆写操作在内存中同时持有旧文本和新文本以计算仅用于 UI 的 hunk(TODO(overwrite-diff-bound)),且 dsh-tool-fs 引入了一个小型、知名的运行时依赖。

非目标

  • 实时增量 diff 流式输出。 hunk 在变更完成后一次性计算;没有逐键 diff。
  • 对二进制/非 UTF-8 覆写做 diff。 此类文件的 beforenull(没有文本 diff 基础);写入仍然成功,结果渲染整文件 diff(oldText: null)而非上下文 hunk。
  • 重命名/移动 diff。 仅限单个已解析路径的内容 diff。
  • 限制覆写 diff 基础的大小。 覆写操作将整个旧文件读入内存以计算上下文 hunk(加上已持有的新内容),因此非常大的文本覆写会为仅 UI 用途的 diff 分配两份文本。未来的改进可以设定预读上限,超过阈值时回退到整文件/无上下文 diff;在读取位置以 TODO(overwrite-diff-bound) 跟踪。

相关

  • 补全了带标签的 render-intent 联合类型中作为非目标列出的最后一项表示差异——该 Agent Note 的「非目标」一节已更新,记录 applied-hunk diff 在此处交付。
  • 基于文件系统 capability seam(before/after 是后端返回的存储事实)和事件溯源会话meta 载荷持久化在 tool/result 事件上,因此回放可复现卡片)。
  • meta 通道有意设计为通用的:未来的工具(结构化搜索、数据表结果)可以附加自己的持久化结果展示而无需再改 core。