Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@

</div>

## Optional diagnostic log

TaskFlow diagnostics are off by default. From the affected repository, ask the TaskFlow agent to enable diagnostics, or run `bash <installed-taskflow>/hooks/diagnostic-log enable` to enable them and `bash <installed-taskflow>/hooks/diagnostic-log disable` to stop recording. Export to a new local file with `bash <installed-taskflow>/hooks/diagnostic-log export /path/to/new-file.jsonl`; the export is never uploaded. Export requires a filesystem supporting hard links. Only fixed event categories, result categories and UTC timestamps are stored; no prompts, commands, paths, code, personal data, tool output or arbitrary capability names are recorded. Recording stops when the log reaches approximately 1 MiB; asynchronous events can be lost. For a few fixed skill names, a shell command is classified as a mention without retaining the command; a mention does not prove a read succeeded. Hosts expose different events; missing records do not establish that a capability was not used or why the model chose it.


> [!IMPORTANT]
> **TaskFlow is a workflow convention, not an Agent.** It does not select tools or take decisions itself. It may coordinate with host/harness hooks (Claude Code, Codex CLI, CodeBuddy, dsh, and Trae) for bounded bookkeeping and context summaries; hooks never write core documents and never approve. It gives humans and Agents a shared, inspectable place to record what a task means and how it changed.

Expand Down
5 changes: 5 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@

</div>

## 可选诊断日志

TaskFlow 诊断日志默认关闭。在相关仓库中请 TaskFlow Agent 启用诊断日志,或运行 `bash <已安装的 TaskFlow 路径>/hooks/diagnostic-log enable` 启用,运行 `bash <已安装的 TaskFlow 路径>/hooks/diagnostic-log disable` 停止记录;使用 `bash <已安装的 TaskFlow 路径>/hooks/diagnostic-log export /path/to/new-file.jsonl` 导出到新的本地文件,导出不会自动上传;导出目标所在文件系统须支持硬链接。日志只保存固定事件类别、结果类别和 UTC 时间,不记录提示词、命令、路径、代码、个人信息、工具输出或任意能力名称。日志达到约 1 MiB 后停止写入;记录异步执行,事件可能丢失。对于少数固定技能名,只从 shell 命令中提取“被提及”的固定类别,不保存命令;被提及不代表读取成功。各宿主可提供的事件不同;缺少记录不能证明未使用能力,也不能解释模型选择原因。


> [!IMPORTANT]
> **TaskFlow 是流程约定,不是 Agent。** 它不选择工具、也不替 Agent 决策。它可与宿主/工具链 hook(Claude Code、Codex CLI、CodeBuddy、dsh 与 Trae)协作做有边界的记账和上下文摘要;hook 绝不写核心文档、绝不代为批准。它为人和 Agent 提供一个共同的、可检查的地方,记录任务是什么以及它如何变化。

Expand Down
123 changes: 123 additions & 0 deletions TaskFlowDocs/achieved/2026-11-13-diagnostic-logs/plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Plan — TaskFlow 脱敏诊断日志与导出
> Task version: v1
> Status: completed

## Spec Pointers

- `spec.md`

## Reference Pointers

- [Reinforce] `CODE_STYLE.md` — 代码风格、隐私及兼容约束。

## Related Tasks

- 关联 `fix/taskflow-capability-outcomes` 分支的 `TaskFlowDocs/2026-11-12-capability-outcomes/` v1(尚未合入 main):日志为后续正式安装排查提供独立交付;不宣称完成原任务的行为验收。

## Skills / Tools Used

- [PRD] Declared `agent-skills:spec-driven-development` — purpose: 形成可验收的需求和隐私边界;outcome: 区分可观测事件、未知原因和导出;incorporated: PRD 要求及验收。
- [Spec] Declared `agent-skills:spec-driven-development` — purpose: 设计事件和数据边界;outcome: 允许列表、重新校验、失败语义;incorporated: Spec。
- [Plan] Declared `agent-skills:planning-and-task-breakdown` — purpose: 设计依赖顺序及可验证步骤;outcome: 拆分事件核实、实现和独立验收;incorporated: Steps。
- [Test] Declared `agent-skills:security-and-hardening` — purpose: 考虑敏感输入和信任边界;outcome: 密钥、代码、恶意记录及失败场景;incorporated: 测试要求。
- `agent-skills:observability-and-instrumentation` — purpose: 设计可回答的问题;outcome: 事件、结果与宿主可见性分开;incorporated: Spec。

## Preconditions

- 使用项目内工作树 `D:/WorkSpace/Agent/TaskFlow/.worktrees/capability-outcomes`,分支 `fix/taskflow-capability-outcomes`。
- 已确认默认关闭、指定本地导出和允许列表;不记录用户内容,不阻塞运行。
- 项目规则 `CONTRIBUTING.md`、`CODE_STYLE.md`;任务事实以当前文档为准。

## Plan Review

- Verdict: sound — 方案覆盖已确认需求;具体宿主支持必须先验证。
- Coverage: Step 1 核实事件及隐私契约;Step 2 实现启停、异步记录与导出;Step 3 覆盖安全、非阻塞和宿主结果;Step 4 审查、提交和交付。
- Verifiability: 每项行为均由导出内容、可控阻塞测试和宿主事件检查;无法观察的原因不宣称已知。
- Layer ownership: 宿主决定可见事件,TaskFlow 负责允许列表、非阻塞采集与安全导出,用户负责正式安装后的实际场景测试。

## Approval

- Status: approved
- Approved by: user
- Approved at: 2026-11-13 13:29 +0800
- Approved version: v1
- Approved scope: PRD / Spec / Plan

## Steps

### Step 1 — 核实宿主事件与数据边界

- Goal: 确认可记录事件、异步机制和具体隐私边界。
- Dependencies: v1 方案获批。
- Files: 宿主 hook 配置与运行时说明。
- Implementation checklist:
- [x] 核对宿主事件、异步语义及覆盖限制,确定固定事件与能力分类。
- Acceptance: 每个字段均有来源和允许范围,不能推断的事实明确标未知。
- Verification: 接线与受控事件对照。
- Rollback: 只更正任务记录。
- Status: done

### Step 2 — 实现诊断与导出

- Goal: 实现默认关闭、非阻塞记录和安全的本地导出。
- Dependencies: Step 1。
- Files: `hooks/`、宿主配置、TaskFlow skill、README。
- Implementation checklist:
- [x] 实现用户启停、异步固定枚举记录和安全导出;更新用户说明。
- Acceptance: 不写用户内容;导出仅写指定新文件;不自动上传。
- Verification: 功能与格式测试。
- Rollback: 回退本步骤提交,不删除用户日志。
- Status: done

### Step 3 — 安全、非阻塞与真实宿主验证

- Goal: 验证泄露防护、日志故障和实际事件路径。
- Dependencies: Step 2。
- Files: 现有测试与项目内临时夹具。
- Implementation checklist:
- [x] 测试敏感输入、恶意记录、默认关闭、导出失败、并发和受控阻塞。
- [x] 运行适用 smoke、离线评估和至少一个受授权真实宿主场景,记录覆盖边界。
- Acceptance: 隐私和非阻塞测试通过,测试材料及宿主限制可审计。
- Verification: 命令、结果及脱敏证据。
- Rollback: 按授权清理本次测试夹具,保留用户数据。
- Status: done

### Step 4 — 审查与交付

- Goal: 审查差异,提交版本回退点,为用户 PR 与发布准备结果。
- Dependencies: Step 3。
- Files: 变更及任务记录。
- Implementation checklist:
- [x] 完成审查、Git 提交、记录验证与限制。
- Acceptance: 代码、说明和测试一致;不擅自推送、合并或发布。
- Verification: `git diff --check`、Git 状态与提交检查。
- Rollback: 按提交回退。
- Status: done

## Checkpoints

## Verification / Review

- Windows 与 WSL 的 `hooks/test-diagnostic-log` 通过:默认关闭、后台入口、合成密钥和代码不落盘、恶意记录过滤、并发格式、固定技能及命令中提及的分类、禁覆盖和人为延迟的 Git/存储检查。事件记录采用异步旁路;合成阻塞测试验证入口在等待上限前返回,不证明所有文件系统和宿主都无延迟。
- 在 WSL 的 Windows 挂载目录复现并发追加丢失少量事件;保留记录格式完整,日志为尽力记录而非完整审计。达到约 1 MiB 停止追加,文档已说明。
- 独立 PR 分支的 Windows 完整 smoke(包括诊断测试入口、双 shell 配置和开放 stdin)通过;分支上的 WSL 诊断测试通过。`python evals/runner.py` PASS (6);WSL Python 运行技能校验通过。Windows 默认 Python 缺 PyYAML,未安装依赖。
- 创建并临时安装本地测试插件,随后通过正式 CLI 移除插件和市场,核实缓存副本及市场均不存在,官方更新保留;第二轮真实宿主测试后再次移除插件与市场,精确删除其 11 个 hook 状态并以 TOML 结构对比确认其他配置不变。当前 computer-use 技能禁止操作 Codex CLI 和安全权限界面,无法自动信任测试 hook;用户手动信任指定诊断 hook 后,在受监控合成仓库运行 `codex exec --json --sandbox read-only`,会话和答复完成、退出 0,未观察到工具调用;项目日志出现 session 和 prompt 两条事件,用户指定本地路径的 JSONL 导出仅含五个允许字段。此次未覆盖真实宿主的工具调用事件或其他宿主,不能推断其行为。Linux 全量 smoke 的首次夹具准备因 Windows Git 工作树路径不适用于 WSL 失败;第二次复制时误排除诊断脚本而失败。修正后暴露旧的固定命令数量断言和两个脚本清单未更新;补充逐宿主逐事件接线断言及清单后,在私有 tmpfs 中重跑得到 `ALL SMOKE PASSED`。
- 自审:日志仅输出固定枚举与生成的时间,导出重新校验、通过硬链接发布而不覆盖现有目标;不支持硬链接的目标文件系统将返回失败。提及分类仅表示工具输入含固定技能名,不证明成功读取或采用;不记录原命令。

- 原关联分支代码提交 `7218bfa`、检查记录提交 `67617a5`;日志独立 PR 分支分别移植为 `cdac9fc`、`29915f9`,并保留真实宿主验收与归档提交。

- PR 模板 `.github/pull_request_template.md`:Summary 说明默认关闭、脱敏导出及宿主限制;TaskFlow traceability 指向本归档、日志范围和 `hkwuks/TaskFlow` 的 `main`;Verification 填入独立分支复测、技能校验、diff 检查和 Hooks 工作流;Review boundaries 核对敏感信息、无关变更、目标及限制。Hooks 只由 PR 或 main push 触发,须先创建 PR 才能取得该 PR 的 CI 结果,结果未到时保持待完成并回填。

- PR 首次 Windows CI 因测试使用 PowerShell 字符串管道,环境编码在 JSON 前插入 BOM,导致 SessionStart 的输入解析失败;改用 `cmd` 的空 stdin,继续检查两种 shell 中的实际 hook 命令。Linux 和 macOS CI 已通过;修复后的 CI 须重新通过。

## Change Log

- 2026-11-13:用户确定默认关闭、本地指定路径导出、仅允许列表元数据;日志不阻塞被观察代码。
- 2026-11-13:实现固定类别的命令提及识别,只保存枚举,不保存命令;与已批准范围一致,属于工作修订。
- 2026-11-13:为单独交付已验收日志,从已核实的 main 分出 PR 分支,移植必要的 Windows hook 启动修复与日志提交;另一任务和其待办继续留在原分支。

## Follow-ups

## Version History

- v1 — planning。
52 changes: 52 additions & 0 deletions TaskFlowDocs/achieved/2026-11-13-diagnostic-logs/prd.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# TaskFlow 脱敏诊断日志与导出
> Task version: v1
> Status: completed

## Goal

为正式安装后的能力引导调查提供用户可控的诊断日志和本地导出。

## Task Kind

- Kind: capability

## Background / Confirmed Facts

能力引导任务发现,Codex 的事件接线只能观察宿主提供的部分事件;通过 shell 读取技能不一定有可识别的技能调用事件。事件、模型决策和产物贡献不能互相等同。

## Requirements

- 日志默认关闭,由用户主动开启和关闭;不自动上传。
- 严格允许列表:仅可记录预定义的事件类型、结果、时间和经过允许列表筛选的能力标识;不记录提示词、命令、路径、代码、个人信息、密钥、工具输入输出或自由文本。
- 日志写入或其故障不得阻塞被观察代码;明确丢失或不可观察的边界。
- 用户可导出至指定本地文件;导出时再次校验允许的格式和字段,不读取或打包其他文件。
- 区分 hook 到达、宿主可观察的调用事件及失败,不臆测模型内部原因或技能实际贡献。

## Acceptance Criteria

- 默认关闭不产生诊断记录;启用、停用、导出在正式安装的使用方式中可操作且有说明。
- 合成输入中嵌入代码、路径、令牌、个人信息及恶意字段后,本地日志和导出均不包含这些内容;未知字段、标识或记录不会原样落盘或导出。
- 日志存储不可用、写入阻塞或后台进程失败时,受观察工作仍能完成;使用真实可控阻塞场景验证。
- 真实或受控宿主事件验证 hook 到达和可观察调用;未被宿主暴露的行为明确标记为未知,而非未调用。
- 导出只写用户指定目标,不自动发送网络;覆盖、失败和敏感数据边界有测试。

## External Facts

- Depends on external facts: no
- Why not: 已有接线与能力范围见 `hooks/hooks-codex.json`、`hooks/capability-evidence`;实现不依赖其他宿主未验证的承诺。

## In Scope

日志配置、脱敏事件记录、本地导出、测试和使用说明。

## Out of Scope

记录用户代码或完整会话;推断模型内部意图;自动上传;替代现有能力门禁或假定覆盖所有宿主事件。

## Risks / Deferred Items

异步记录可能丢失事件;默认关闭的时间段不可追溯;宿主未暴露的调用无法被日志证明。

## Open Questions

具体宿主可见事件及其失败语义以实现前逐项核实为准,不得虚构。
40 changes: 40 additions & 0 deletions TaskFlowDocs/achieved/2026-11-13-diagnostic-logs/spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Spec — TaskFlow 脱敏诊断日志与导出
> Task version: v1

## Objective and Success Criteria

以最小可观测元数据诊断真实宿主事件,并提供明确、可测试的隐私和非阻塞边界。

## Architecture Boundaries and Responsibilities

宿主负责实际投递事件,TaskFlow 仅记录接收到的已知事件;记录器不读取会话或其他日志,不推断模型思维。导出只处理本模块的结构化数据并重新校验。

## Project Structure / Affected Files

复用 `hooks/` 及各宿主现有事件接线;按实际需要补充日志命令、自动测试、TaskFlow skill 和中英文 README。不得修改用户 Agent 配置目录。

## Interfaces, Data Flow, and Contracts

提供用户可发现的启用、停用和导出命令。默认无配置视为关闭;启用状态与日志存放于任务工作区的本地 Git 元数据,不进入 Git 提交。事件进入记录器前必须降为固定枚举;未知值统一归为 unknown 或丢弃,绝不保存原值。能力标识只有硬编码允许值可写,其余使用类别或 unknown,不将任意宿主名字、路径或哈希作为安全替代。

记录采用结构化单行格式,字段和可取值均严格白名单;时间仅由记录器生成。绝不将原始输入、错误消息或命令参数写入。导出重新解析并重建允许字段,拒绝或跳过异常记录;目标已存在时不覆盖,失败不留下看似成功的导出。

## Invariants and Compatibility

日志记录是可选、异步且可丢失的旁路;日志输出的任何磁盘 IO 或等待不得发生在受观察执行路径。不得依赖新增的兼容代码或外部依赖。仅对实际宿主提供且验证的事件声称覆盖。

## Validation and Error Semantics

测试包含默认关闭、启停、导出与已有目标、结构化允许列表、带令牌和私人信息的输入、篡改的本地记录、并发、不可写存储和可控长时间阻塞的写入;验证被观察流程及时完成且输出未变。测量和记录受控真实宿主投递,明确无法证明 skill 内容已采纳或解释未观察到的调用。

## Code and Test Constraints

复用既有测试框架;不接触用户个人文件或凭据。运行适用 smoke、离线评估及 `git diff --check`,如宿主或环境不可用则保留未验证状态。

## Design Decisions and Alternatives

选择默认关闭、固定枚举、用户指定本地导出;较宽泛的正则脱敏不能保证未知密钥和代码安全,因此不将原始内容交给日志存储。诊断所需的细节与严格隐私冲突时保留隐私边界并公开可观察性限制。

## Open Questions

不同宿主的异步投递和事件字段需先以现有运行时实现及验证结果确定;不以静态配置代替真实宿主验证。
7 changes: 7 additions & 0 deletions TaskFlowDocs/todo.md
Original file line number Diff line number Diff line change
Expand Up @@ -1257,3 +1257,10 @@ has an issue number or URL.
- Task: `TaskFlowDocs/achieved/2026-10-31-external-facts/`
- Next action: None — completed and archived.

## 增加脱敏且不阻塞运行的 TaskFlow 诊断日志和用户导出能力,

- ID: TF-20261113-5681c7
- Status: done
- Goal: 增加脱敏且不阻塞运行的 TaskFlow 诊断日志和用户导出能力,用于正式安装后调查能力引导与调用问题
- Task: `TaskFlowDocs/achieved/2026-11-13-diagnostic-logs/`
- Next action: None — completed and archived.
3 changes: 3 additions & 0 deletions hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ taskflow/hooks/
├── merge-todo # the driver: merges TaskFlowDocs/todo.md by entry
├── summarize-state # derives the state summary (shared logic)
├── repository-docs-context # syncs index metadata and derives routes
├── diagnostic-event # launches the best-effort redacted event worker
├── diagnostic-log # enables, disables and exports diagnostic records
├── test-diagnostic-log # privacy, export and nonblocking fixture
├── capability-evidence # records observable capability invocations
├── external-evidence # records outside URLs from tool events
├── capability-gate # refuses a stage document's first body write
Expand Down
Loading
Loading