feat(review-pr): add rate-anomaly safeguard for review requests #13
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| // Copyright The Docker Agent Action authors | ||
|
Collaborator
There was a problem hiding this comment. suggestion (non-blocking): the coverage of
a mistake in any of these ships silently. describe('main()', () => {
it('fails open and emits anomalous=false when token is missing', async () => {
vi.stubEnv('GITHUB_TOKEN', '');
vi.stubEnv('GH_TOKEN', '');
vi.stubEnv('RATE_PR_NUMBER', '5');
// call main(), assert core.setOutput called with ('anomalous', 'false')
});
it('emits all four outputs on a successful run', async () => {
vi.stubEnv('GITHUB_TOKEN', 'tok');
vi.stubEnv('GITHUB_REPOSITORY', 'docker/repo');
vi.stubEnv('RATE_PR_NUMBER', '5');
// mock detectRateAnomaly, assert window + threshold outputs are set
});
});
Collaborator
There was a problem hiding this comment. quick follow-up: CI caught two issues in the new commit. unit test failure ( lint error ( const submittedAt = (r as ReviewLike).submitted_at;
!(submittedAt) || Date.parse(submittedAt) < windowStartMs,lint error ( |
||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| vi.mock('@actions/core'); | ||
|
|
||
| const { mockPaginate, mockListComments, mockListReviewComments, MockOctokit } = vi.hoisted(() => { | ||
| const mockListComments = { endpoint: 'issues.listComments' }; | ||
| const mockListReviewComments = { endpoint: 'pulls.listReviewComments' }; | ||
| const mockPaginate = vi.fn(); | ||
|
|
||
| class MockOctokit { | ||
| paginate = mockPaginate; | ||
| rest = { | ||
| issues: { listComments: mockListComments }, | ||
| pulls: { listReviewComments: mockListReviewComments }, | ||
| }; | ||
| } | ||
| return { mockPaginate, mockListComments, mockListReviewComments, MockOctokit }; | ||
| }); | ||
|
|
||
| vi.mock('@octokit/rest', () => ({ Octokit: MockOctokit })); | ||
|
|
||
| import { detectRateAnomaly } from '../index.js'; | ||
|
|
||
| const NOW = Date.parse('2026-06-24T10:10:00.000Z'); | ||
| const within = (secAgo: number) => new Date(NOW - secAgo * 1000).toISOString(); | ||
|
|
||
| const BOT = 'docker-agent'; | ||
| const REVIEW_MARKER = '<!-- docker-agent-review -->'; | ||
| const REPLY_MARKER = '<!-- docker-agent-review-reply -->'; | ||
|
|
||
| function agentComment(secAgo: number, marker = REVIEW_MARKER) { | ||
| return { user: { login: BOT }, body: `Review body ${marker}`, created_at: within(secAgo) }; | ||
| } | ||
|
|
||
| // Route paginate() to the right dataset based on which endpoint it was given. | ||
| function routePaginate(issue: unknown[], review: unknown[]) { | ||
| mockPaginate.mockImplementation((endpoint: unknown) => { | ||
| if (endpoint === mockListReviewComments) return Promise.resolve(review); | ||
| return Promise.resolve(issue); | ||
| }); | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| }); | ||
|
|
||
| describe('detectRateAnomaly', () => { | ||
| const base = { | ||
| owner: 'docker', | ||
| repo: 'repo', | ||
| prNumber: 5, | ||
| windowSeconds: 600, | ||
| threshold: 3, | ||
| botLogin: BOT, | ||
| nowMs: NOW, | ||
| }; | ||
|
|
||
| it('counts agent review + reply comments within the window across both comment types', async () => { | ||
| routePaginate( | ||
| [agentComment(60), agentComment(120, REPLY_MARKER)], | ||
| [agentComment(30), agentComment(90)], | ||
| ); | ||
|
|
||
| const r = await detectRateAnomaly('tok', base); | ||
|
|
||
| expect(r.count).toBe(4); | ||
| expect(r.anomalous).toBe(true); | ||
| expect(r.threshold).toBe(3); | ||
| }); | ||
|
|
||
| it('is not anomalous below the threshold', async () => { | ||
| routePaginate([agentComment(60)], [agentComment(30)]); | ||
| const r = await detectRateAnomaly('tok', base); | ||
| expect(r.count).toBe(2); | ||
| expect(r.anomalous).toBe(false); | ||
| }); | ||
|
|
||
| it('ignores comments outside the window (created before windowStart)', async () => { | ||
| routePaginate( | ||
| [agentComment(60), agentComment(2000 /* 33min ago, outside 600s */)], | ||
| [agentComment(30)], | ||
| ); | ||
| const r = await detectRateAnomaly('tok', base); | ||
| expect(r.count).toBe(2); | ||
| }); | ||
|
|
||
| it('ignores comments from other users', async () => { | ||
| routePaginate( | ||
| [{ user: { login: 'mallory' }, body: `spam ${REVIEW_MARKER}`, created_at: within(10) }], | ||
| [], | ||
| ); | ||
| const r = await detectRateAnomaly('tok', base); | ||
| expect(r.count).toBe(0); | ||
| expect(r.anomalous).toBe(false); | ||
| }); | ||
|
|
||
| it('ignores agent comments that lack a review marker (e.g. ordinary chatter)', async () => { | ||
| routePaginate( | ||
| [{ user: { login: BOT }, body: 'just a plain comment', created_at: within(10) }], | ||
| [], | ||
| ); | ||
| const r = await detectRateAnomaly('tok', base); | ||
| expect(r.count).toBe(0); | ||
| }); | ||
|
|
||
| it('counts legacy cagent markers during the migration window', async () => { | ||
| routePaginate( | ||
| [{ user: { login: BOT }, body: 'old <!-- cagent-review -->', created_at: within(10) }], | ||
| [], | ||
| ); | ||
| const r = await detectRateAnomaly('tok', { ...base, threshold: 1 }); | ||
| expect(r.count).toBe(1); | ||
| expect(r.anomalous).toBe(true); | ||
| }); | ||
|
|
||
| it('passes a since timestamp derived from the window to the API', async () => { | ||
| routePaginate([], []); | ||
| await detectRateAnomaly('tok', base); | ||
| const issueCall = mockPaginate.mock.calls.find((c) => c[0] === mockListComments); | ||
| expect(issueCall?.[1]).toMatchObject({ | ||
| owner: 'docker', | ||
| repo: 'repo', | ||
| issue_number: 5, | ||
| since: new Date(NOW - 600 * 1000).toISOString(), | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This actually already exists, but doesn't use GH's
concurrency, and only 1 review-per-PR can run within a window of time: https://github.com/docker/docker-agent-action/blob/main/review-pr/action.yml#L142-L146There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct that a per-PR collapse already exists via the cache lock. The new
concurrency:group is additive rather than equivalent: it is keyed per (PR + trigger intent), queues instead of skipping, applies before a runner spins up, and has no race window (the lock has a documented one). The trigger workflow also usescancel-in-progressto drop superseded context-capture runs. If relying on the lock plus the rate-limit check is preferred, the group can be dropped; it is left in place for now as a cheap, race-free pre-resource layer.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
makes sense, thanks for the explanation!