6.6 KiB

Raw Blame History

PR 代码审查完整工作流示例

场景：团队成员提交了一个 PR，需要进行代码审查。

前置条件

gitlink-cli 已安装并登录
用户拥有 PR 所在仓库的读取权限

工作流步骤

Step 1：获取 PR 上下文

# 查看 PR 列表，找到待审查的 PR
gitlink-cli pr +list --state open --format json

# 获取特定 PR 详情
gitlink-cli pr +view --id 42 --format json

输出示例：

{
  "ok": true,
  "data": {
    "id": 42,
    "title": "feat: add user authentication module",
    "body": "实现了基于 JWT 的用户认证模块，包含登录、注册、Token 刷新功能。",
    "state": "open",
    "author": "developer_a",
    "created_at": "2026-05-18T10:30:00+08:00",
    "source_branch": "feat/auth-module",
    "target_branch": "master"
  }
}

Step 2：获取变更文件

gitlink-cli pr +files --id 42 --format json

输出示例：

{
  "ok": true,
  "data": [
    { "filename": "src/auth/login.py", "status": "added", "additions": 120, "deletions": 0 },
    { "filename": "src/auth/token.py", "status": "added", "additions": 85, "deletions": 0 },
    { "filename": "src/config.py", "status": "modified", "additions": 5, "deletions": 2 },
    { "filename": "tests/test_auth.py", "status": "added", "additions": 200, "deletions": 0 },
    { "filename": "requirements.txt", "status": "modified", "additions": 3, "deletions": 0 }
  ]
}

Step 3：获取 Diff 内容

gitlink-cli pr +diff --id 42 --format json
gitlink-cli pr +reviews --id 42 --format json

Step 4：验证 Review 修改并逐文件审查

如果 PR 已有 Review，先把每条可执行意见映射到 Review 后的提交和当前代码，标记为 resolved、partially_resolved、unresolved、regressed、outdated 或 not_verifiable。代码发生变化本身不能证明意见已经解决。

对每个变更文件，分析代码质量。以下是审查结果示例：

## PR #42 代码审查报告

**Review 建议：** <span style="color:#B42318"><strong>修复安全阻断后再审</strong></span> **[action_required]**：认证实现存在硬编码凭据和 SQL 注入风险；依据：CR-42-001、CR-42-002 与精确代码位置；下一步：完成参数化查询、密钥外置和安全回归后复看。
**贡献价值：** <span style="color:#067647"><strong>认证能力具有实际价值</strong></span> **[passed]**：PR 提供登录和 Token 流程；依据：需求、模块 Diff 和主要使用路径；影响：形成可用的认证入口。
**Review 履约：** <span style="color:#175CD3"><strong>没有既有意见可核对</strong></span> **[not_applicable]**：本轮没有有效 Review；依据：Review 列表和当前 head；影响：直接审查完整实现。
**实现与逻辑：** <span style="color:#B42318"><strong>认证边界不安全</strong></span> **[failed]**：查询直接拼接输入且密码处理不正确；依据：`src/auth/login.py:42`、`src/auth/login.py:88`；下一步：参数化查询并使用安全哈希。
**测试：** <span style="color:#B54708"><strong>安全与边界用例不足</strong></span> **[partial]**：已有测试覆盖主要成功路径；依据：`tests/test_auth.py` 和测试清单；下一步：补注入、空值、超长输入和过期 Token。
**安全：** <span style="color:#B42318"><strong>存在两个阻断级风险</strong></span> **[failed]**：硬编码密钥和 SQL 注入可被直接触发；依据：`src/config.py:15`、`src/auth/login.py:42`；下一步：移除凭据并使用参数化 API。
**关键发现：** <span style="color:#B42318"><strong>2 项 blocking 必须先修复</strong></span> **[blocking]**：CR-42-001、CR-42-002 会影响数据和凭据安全；依据：代码证据和攻击路径；下一步：阻断合并直到安全测试通过。

### 🔴 Critical

1. **JWT Secret 硬编码** — `src/config.py:15`
   > `JWT_SECRET = "my-secret-key-123"` 硬编码在源码中，存在泄露风险。建议：
   > - 使用环境变量：`JWT_SECRET = os.getenv("JWT_SECRET")`
   > - 或使用配置文件（不提交到版本控制）

2. **SQL 注入风险** — `src/auth/login.py:42`
   > `cursor.execute(f"SELECT * FROM users WHERE username = '{username}'")` 直接拼接用户输入，存在 SQL 注入风险。建议使用参数化查询：
   > ```python
   > cursor.execute("SELECT * FROM users WHERE username = ?", (username,))
   > ```

### 🟡 Warning

1. **密码明文存储** — `src/auth/login.py:88`
   > 密码直接存储到数据库，建议使用 `bcrypt` 或 `argon2` 进行哈希处理。

2. **缺少输入验证** — `src/auth/login.py:15`
   > `login()` 函数没有对 `username` 和 `password` 进行长度和格式校验。建议：
   > ```python
   > if len(username) < 3 or len(username) > 50:
   >     raise ValueError("用户名长度应在 3-50 个字符之间")
   > ```

### 🔵 Suggestion

1. **Token 过期时间可配置** — `src/auth/token.py:30`
   > `ACCESS_TOKEN_EXPIRE_MINUTES = 30` 建议改为从环境变量读取，方便不同环境配置。

2. **测试可增加边界用例** — `tests/test_auth.py`
   > 现有测试覆盖了正常流程，建议补充：
   > - 空用户名/密码
   > - 超长输入
   > - Token 过期处理
   > - 并发登录场景

### ✅ Positive

- 完整的测试覆盖（200 行测试代码，覆盖主要功能路径）
- 清晰的模块划分（login / token 职责分离）
- 有类型注解，代码可读性好

Step 5：生成待人工审核的 Review 草稿

在 Markdown 报告中生成整体 Review 和必要的内联评论草稿，不调用 pr +review 或任何远端写接口。维护者审核、编辑并明确决定发布后，再在本次 Skill 之外执行提交。

Step 6：输出审查摘要

## 📋 审查摘要 — PR #42 feat: add user authentication module

| 指标 | 数据 |
|------|------|
| 审查文件数 | 5 |
| 变更行数 | +413 / -2 |
| Critical 问题 | 2 |
| Warning | 2 |
| Suggestion | 2 |

### 主要发现
1. **[Critical]** JWT Secret 硬编码在源码中
2. **[Critical]** SQL 查询存在注入风险
3. **[Warning]** 密码明文存储

### 总体评价
代码结构良好，测试覆盖完整。修复两个安全关键问题后即可合并。

完整命令速览

# 获取 PR 详情
gitlink-cli pr +view --id <id> --format json

# 获取变更文件
gitlink-cli pr +files --id <id> --format json

# 获取 Diff
gitlink-cli pr +diff --id <id> --format json

# 获取已有 Review，用于验证后续修改
gitlink-cli pr +reviews --id <id> --format json

本工作流只生成报告和 Review 草稿，不提交远端。

6.6 KiB Raw Blame History Unescape Escape