| 1 |
name: Droid Code Review |
| 2 |
|
| 3 |
on: |
| 4 |
issue_comment: |
| 5 |
types: [created] |
| 6 |
|
| 7 |
concurrency: |
| 8 |
group: droid-review-${{ github.event.issue.number }} |
| 9 |
cancel-in-progress: true |
| 10 |
|
| 11 |
permissions: |
| 12 |
pull-requests: write |
| 13 |
contents: read |
| 14 |
issues: write |
| 15 |
|
| 16 |
jobs: |
| 17 |
code-review: |
| 18 |
runs-on: ubuntu-latest |
| 19 |
timeout-minutes: 20 |
| 20 |
# Only run on PR comments that contain "@droid review" from authorized users |
| 21 |
if: | |
| 22 |
github.repository == 'rspamd/rspamd' && |
| 23 |
github.event.issue.pull_request && |
| 24 |
contains(github.event.comment.body, '@droid review') && |
| 25 |
( |
| 26 |
github.event.comment.user.login == 'vstakhov' || |
| 27 |
github.event.comment.user.login == 'moisseev' || |
| 28 |
github.event.comment.user.login == 'fatalbanana' |
| 29 |
) |
| 30 |
|
| 31 |
steps: |
| 32 |
- name: Acknowledge review start with reaction |
| 33 |
run: | |
| 34 |
gh api \ |
| 35 |
--method POST \ |
| 36 |
-H "Accept: application/vnd.github+json" \ |
| 37 |
/repos/${{ github.repository }}/issues/comments/${{ github.event.comment.id }}/reactions \ |
| 38 |
-f content='eyes' |
| 39 |
env: |
| 40 |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 41 |
|
| 42 |
- name: Checkout repository |
| 43 |
uses: actions/checkout@v4 |
| 44 |
with: |
| 45 |
fetch-depth: 0 |
| 46 |
|
| 47 |
- name: Checkout PR branch |
| 48 |
run: | |
| 49 |
gh pr checkout ${{ github.event.issue.number }} |
| 50 |
env: |
| 51 |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 52 |
|
| 53 |
- name: Install Droid CLI |
| 54 |
run: | |
| 55 |
curl -fsSL https://app.factory.ai/cli | sh |
| 56 |
echo "$HOME/.local/bin" >> $GITHUB_PATH |
| 57 |
"$HOME/.local/bin/droid" --version |
| 58 |
|
| 59 |
- name: Configure git identity |
| 60 |
run: | |
| 61 |
git config user.name "Droid Code Reviewer" |
| 62 |
git config user.email "[email protected]" |
| 63 |
|
| 64 |
- name: Perform automated code review |
| 65 |
env: |
| 66 |
FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }} |
| 67 |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 68 |
run: | |
| 69 |
set -euo pipefail |
| 70 |
cat > prompt.txt << 'EOF' |
| 71 |
You are a conservative automated code reviewer for the Rspamd mail filtering project. |
| 72 |
Your goal is high-precision, low-noise feedback: report only defects you are certain about. |
| 73 |
|
| 74 |
## Step 1 — Gather full context before writing any comment |
| 75 |
|
| 76 |
Fetch the complete PR context from: |
| 77 |
https://github.com/${{ github.repository }}/pull/${{ github.event.issue.number }} |
| 78 |
|
| 79 |
Read carefully: |
| 80 |
- PR title, description, and the author's stated intent |
| 81 |
- The complete unified diff with diff-position line numbers |
| 82 |
- All existing review threads, including every reply |
| 83 |
- Any maintainer explanations (vstakhov, moisseev, fatalbanana) |
| 84 |
|
| 85 |
Do NOT write any comment until you have read all existing threads. |
| 86 |
|
| 87 |
## Step 2 — Duplicate and dismissed-feedback filter (mandatory) |
| 88 |
|
| 89 |
Before drafting a comment, check: |
| 90 |
1. Has this exact issue already been raised in an existing thread? |
| 91 |
2. Has a maintainer replied to that thread with an explanation, marked it resolved, |
| 92 |
or indicated the behaviour is intentional or by design? |
| 93 |
|
| 94 |
If either condition is true, SKIP the issue entirely. Do not re-raise dismissed or |
| 95 |
accepted concerns under any circumstances, even if you still think there is a problem. |
| 96 |
|
| 97 |
## Step 3 — Defect qualification (only report findings that pass all criteria) |
| 98 |
|
| 99 |
Only report a finding if ALL of the following are true: |
| 100 |
- It is a concrete, demonstrable defect in the changed lines, or a pre-existing bug |
| 101 |
that the new code newly exposes or makes reachable |
| 102 |
- You can explain exactly why it is wrong (not merely unusual or unfamiliar) |
| 103 |
- It has a clear, identifiable impact: crash, data loss, memory leak, security |
| 104 |
vulnerability, silent incorrect behaviour, or definite API misuse |
| 105 |
- A specific, actionable fix exists |
| 106 |
|
| 107 |
Reject any finding that is: |
| 108 |
- A style, formatting, or naming preference (clang-format / luacheck own this) |
| 109 |
- A subjective architectural opinion |
| 110 |
- Speculative ("this might cause…" or "could potentially…") |
| 111 |
- About test coverage, documentation, or minor performance |
| 112 |
- Based on an assumption that has not been verified in the diff |
| 113 |
|
| 114 |
## Step 4 — Rspamd-specific rules to check (only on changed lines) |
| 115 |
|
| 116 |
### Memory management |
| 117 |
- C code must use rspamd_mempool or g_malloc/g_free — never raw malloc/free |
| 118 |
- Every allocation must have a matching free; check error-path cleanup |
| 119 |
- Verify no use-after-free when mempools are destroyed |
| 120 |
|
| 121 |
### C++ containers |
| 122 |
- Never use std::unordered_map or std::unordered_set — use ankerl::unordered_dense |
| 123 |
|
| 124 |
### Logging format strings |
| 125 |
- rspamd uses its own printf implementation (see src/libutil/printf.h for the |
| 126 |
full list of format specifiers) — it is NOT standard printf |
| 127 |
- Lua rspamd_logger uses %s for every argument type |
| 128 |
- Format strings must never come from untrusted input |
| 129 |
|
| 130 |
### Lua stack discipline |
| 131 |
- Every lua_push* must be balanced; check stack cleanup on all exit paths |
| 132 |
- Validate lua_check_* return values before dereferencing |
| 133 |
|
| 134 |
### Security (high-confidence only) |
| 135 |
- Buffer overflows with verifiable out-of-bounds access |
| 136 |
- Integer overflows in size/offset arithmetic feeding an allocation or copy |
| 137 |
- NULL pointer dereferences on unchecked return values |
| 138 |
- Confirmed command/SQL injection in external calls |
| 139 |
|
| 140 |
### Error handling |
| 141 |
- Unchecked return values from functions that can fail, where the failure is silently ignored |
| 142 |
|
| 143 |
## Step 5 — Comment format (strict) |
| 144 |
|
| 145 |
Each comment MUST contain exactly three parts: |
| 146 |
1. **Defect**: one sentence describing what is wrong and where |
| 147 |
2. **Impact**: one sentence stating the concrete consequence (crash / leak / wrong result / …) |
| 148 |
3. **Fix**: a specific code-level suggestion |
| 149 |
|
| 150 |
No emojis. No hedging language ("might", "could", "consider"). Plain technical prose. |
| 151 |
|
| 152 |
## Step 6 — Positioning rules |
| 153 |
|
| 154 |
- Inline comments MUST target a line that is part of the changed diff (added or context lines within the diff hunk). |
| 155 |
- If you cannot identify the exact changed line with certainty, do NOT post an inline comment. |
| 156 |
Post a single top-level summary comment for that finding instead. |
| 157 |
- When in doubt about positioning, always prefer a summary comment over a mispositioned inline comment. |
| 158 |
|
| 159 |
## Step 7 — Submission |
| 160 |
|
| 161 |
Use the GitHub CLI to submit. The PR number is ${{ github.event.issue.number }} and |
| 162 |
repository is ${{ github.repository }}. |
| 163 |
|
| 164 |
Commands: |
| 165 |
- Summary / approval only: |
| 166 |
gh pr review ${{ github.event.issue.number }} --comment --body "..." |
| 167 |
- Request changes with summary (no inline): |
| 168 |
gh pr review ${{ github.event.issue.number }} --request-changes --body "..." |
| 169 |
- Approve: |
| 170 |
gh pr review ${{ github.event.issue.number }} --approve --body "No actionable defects found." |
| 171 |
|
| 172 |
Limits: |
| 173 |
- Post at most 5 comments in total; choose the highest-severity findings. |
| 174 |
- If all findings are low-severity (no crash, leak, or security issue) and you have |
| 175 |
fewer than 2, post only an approval comment. |
| 176 |
- A single finding that involves a crash, memory leak, or security vulnerability is |
| 177 |
always worth reporting — do not suppress it. |
| 178 |
- Never post test or exploratory API calls — every comment is immediately visible. |
| 179 |
EOF |
| 180 |
|
| 181 |
# Run droid exec with the prompt |
| 182 |
echo "Running code review analysis and submitting results..." |
| 183 |
droid exec --auto high --model gpt-5.4 -f prompt.txt |
| 184 |
|
| 185 |
- name: Post failure notice |
| 186 |
if: ${{ failure() }} |
| 187 |
run: | |
| 188 |
gh pr comment ${{ github.event.issue.number }} --body "⚠️ Automated code review failed to complete. Check the [workflow run](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) for details." |
| 189 |
env: |
| 190 |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 191 |
|
| 192 |
- name: Dismiss previous change requests if approved |
| 193 |
if: ${{ success() }} |
| 194 |
run: | |
| 195 |
# Get all reviews for this PR |
| 196 |
REVIEWS=$(gh api "/repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}/reviews" --jq '.[] | select(.state == "CHANGES_REQUESTED" and .user.login == "github-actions[bot]") | .id') |
| 197 |
|
| 198 |
# Dismiss each change request review |
| 199 |
for REVIEW_ID in $REVIEWS; do |
| 200 |
echo "Dismissing review $REVIEW_ID" |
| 201 |
gh api \ |
| 202 |
--method PUT \ |
| 203 |
-H "Accept: application/vnd.github+json" \ |
| 204 |
"/repos/${{ github.repository }}/pulls/${{ github.event.issue.number }}/reviews/$REVIEW_ID/dismissals" \ |
| 205 |
-f message="Dismissed after new approval" || echo "Failed to dismiss review $REVIEW_ID (may already be dismissed)" |
| 206 |
done |
| 207 |
env: |
| 208 |
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 209 |
|
| 210 |
- name: Upload debug artifacts on failure |
| 211 |
if: ${{ failure() }} |
| 212 |
uses: actions/upload-artifact@v4 |
| 213 |
with: |
| 214 |
name: droid-review-debug-${{ github.run_id }} |
| 215 |
path: | |
| 216 |
prompt.txt |
| 217 |
${{ runner.home }}/.factory/logs/droid-log-single.log |
| 218 |
${{ runner.home }}/.factory/logs/console.log |
| 219 |
if-no-files-found: ignore |
| 220 |
retention-days: 7 |