Skip to content

docs: 清掉 src/ 里残留的审计编号与失效引用,只留当前事实 - #17

Merged
leeefun merged 1 commit into
masterfrom
chore/comment-audit-tags
Oct 7, 2026
Merged

leeefun merged 1 commit into
masterfrom
chore/comment-audit-tags

Conversation

@leeefun

@leeefun leeefun commented Oct 7, 2026

Copy link
Copy Markdown
Owner

问题

评审指出两处残留:

  • src/ui/session.ts:(审计残余 G2) 这类审计编号已无意义。
  • src/rateLimit.ts:authLimitIpKey 的注释写「非生产路径若缺失则退化为固定串 ip:unknown」,但当前 authLimitKeys() 在没有 cf-connecting-ip 时直接返回空数组 ⇒ 实际不做不可归因的硬封锁,注释与调用语义不符。

同一类残留还有若干(评审未逐一列举),一并清掉。

改动(纯注释,行为不变)

  • 删审计编号:F1/F5/F6/F9/F11/F14/F33/P0-3/R2#8/R-03/G2/G6、审计残余 Gx、审计 P1-3、审计 §12.15④、日期括注。
  • 删指向已删除文档的引用:docs/ui-v2-design.md §6.2、后端能力评估 §3.1、§2.5(这些文件已不在工作树)。
  • 删已关闭 issue 引用:GitHub issue #3(对理解当前实现无价值)。
  • src/rateLimit.ts:authLimitIpKey 注释改为与调用语义一致的描述(缺头 ⇒ 不归入任何桶、不做不可归因封锁);authLimitKeys 去掉重复解释,指向前者。
  • src/ui/session.ts:删 G1 / G2 括注,保留「为什么这样写」的完整理由。

保留:仍然存在的 docs/protocol.md §N、docs/design.md §N 章节锚点,以及 RFC 章节号(如 RFC 9110 §14.2)——那些是当前有效的契约锚点,不是项目历史。

验证

  • tsc --noEmit 0 错;eslint 0 告警。
  • 全量 22/22·505 通过。
  • git diff 逐行核对为注释改动(无代码行变化)。

评审指出两处(session.ts 的「审计残余 G2」、rateLimit.ts 与调用语义不符的
ip:unknown 说明)。同一类残留还有若干,一并清掉:

- 删审计编号:F1/F5/F6/F9/F11/F14/F33/P0-3/R2#8/R-03/G2/G6、'审计残余 Gx'、日期括注。
- 删指向已删除文档的引用:docs/ui-v2-design.md §6.2、'后端能力评估 §3.x'、'§2.5'。
- 删已关闭 issue 引用:'GitHub issue #3'(对理解当前实现无价值)。
- rateLimit.ts:authLimitIpKey 的注释改为与 authLimitKeys 调用语义一致的描述
  (缺 cf-connecting-ip 时不归入任何桶、不做不可归因封锁),并去掉 authLimitKeys 里重复的解释。

保留:docs/protocol.md §N 与 docs/design.md §N 等**仍存在**的文档章节锚点、RFC 章节号。
纯注释改动,行为不变。
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-07T01:02:28.135086Z 9f080f3 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@leeefun
leeefun merged commit af2269c into master Oct 7, 2026
1 check passed
@leeefun
leeefun deleted the chore/comment-audit-tags branch October 7, 2026 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant