Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: replace PR "Request Changes" with a "API CHANGES REQUESTED" comment #163

Merged
merged 3 commits into from
Aug 13, 2024
Merged

feat: replace PR "Request Changes" with a "API CHANGES REQUESTED" comment #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e141b2c
Treat PR approvals as API LGTMs
itsananderson Jul 19, 2024
bbfded5
Undo change to status message (to fix tests)
itsananderson Jul 19, 2024
4b41553
Stop using PR approval/changes and instead only use comment strings
itsananderson Aug 9, 2024
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
49 changes: 45 additions & 4 deletions spec/api-review-state.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ describe('api review', () => {
data: [
{
user: { id: 1, login: 'ckerr' },
body: 'Fix this please!',
body: 'API CHANGES REQUESTED',
state: 'CHANGES_REQUESTED',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use the Request Changes feature in GitHub, but it will only have an impact on API review if you also include API CHANGES REQUESTED in your comment.

},
{
Expand All @@ -188,6 +188,11 @@ describe('api review', () => {
body: 'API DECLINED',
state: 'COMMENTED',
},
{
user: { id: 5, login: 'itsananderson' },
body: 'API CHANGES REQUESTED',
state: 'COMMENTED',
},
],
});

Expand All @@ -197,6 +202,7 @@ describe('api review', () => {
{ login: 'jkleinsc' },
{ login: 'nornagon' },
{ login: 'ckerr' },
{ login: 'itsananderson' },
],
});

Expand All @@ -212,6 +218,7 @@ describe('api review', () => {
#### Requested Changes

* @ckerr
* @itsananderson
#### Declined

* @jkleinsc
Expand All @@ -226,7 +233,7 @@ describe('api review', () => {
expect(users).toEqual({
approved: ['codebytere', 'nornagon'],
declined: ['jkleinsc'],
requestedChanges: ['ckerr'],
requestedChanges: ['ckerr', 'itsananderson'],
});
});

Expand All @@ -250,8 +257,8 @@ describe('api review', () => {
},
{
user: { id: 2, login: 'jkleinsc' },
body: 'This test is failing!!',
state: 'CHANGES_REQUESTED',
body: 'API CHANGES REQUESTED',
state: 'COMMENTED',
submitted_at: '2020-12-10T01:24:55Z',
},
],
Expand All @@ -269,6 +276,40 @@ describe('api review', () => {
});
});

it('should correctly parse user approvals when a reviewer requests changes and then approves', async () => {
const { pull_request } = loadFixture(
'api-review-state/pull_request.requested_review_label.json',
);

moctokit.pulls.listReviews.mockReturnValue({
data: [
{
user: { id: 2, login: 'marshallofsound' },
body: 'API CHANGES REQUESTED',
state: 'COMMENTED',
submitted_at: '2020-12-09T01:24:55Z',
},
{
user: { id: 2, login: 'marshallofsound' },
body: 'API LGTM',
state: 'COMMENTED',
submitted_at: '2020-12-10T01:24:55Z',
},
],
});

moctokit.teams.listMembersInOrg.mockReturnValue({
data: [{ login: 'marshallofsound' }],
});

const users = await addOrUpdateAPIReviewCheck(moctokit, pull_request);
expect(users).toEqual({
approved: ['marshallofsound'],
declined: [],
requestedChanges: [],
});
});

it(`should correctly update api review check for ${REVIEW_LABELS.APPROVED} label`, async () => {
const { pull_request } = loadFixture(
'api-review-state/pull_request.approved_review_label.json',
Expand Down
11 changes: 6 additions & 5 deletions src/api-review-state.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,15 @@ export async function addOrUpdateAPIReviewCheck(octokit: Context['octokit'], pr:

const lgtm = /API LGTM/i;
const decline = /API DECLINED/i;
const changesRequested = /API CHANGES REQUESTED/i;

// Combine reviews/comments and filter by recency.
const filtered = ([...comments, ...reviews] as CommentOrReview[]).reduce((items, item) => {
if (!item?.body || !item.user) return items;

const changeRequest = item.state === REVIEW_STATUS.CHANGES_REQUESTED;
const reviewComment = lgtm.test(item.body) || decline.test(item.body);
if (!reviewComment && !changeRequest) return items;
const reviewComment =
lgtm.test(item.body) || decline.test(item.body) || changesRequested.test(item.body);
if (!reviewComment) return items;

const prev = items[item.user.id];
if (!prev) {
Expand Down Expand Up @@ -209,13 +210,13 @@ export async function addOrUpdateAPIReviewCheck(octokit: Context['octokit'], pr:
const approved = allReviews.filter((r) => r.body?.match(lgtm)).map((r) => r.user?.login);
const declined = allReviews.filter((r) => r.body?.match(decline)).map((r) => r.user?.login);
const requestedChanges = allReviews
.filter((r) => r.state === REVIEW_STATUS.CHANGES_REQUESTED)
.filter((r) => r.body?.match(changesRequested))
.map((r) => r.user?.login);

log(
'addOrUpdateAPIReviewCheck',
LogLevel.INFO,
`PR ${pr.number} has ${approved.length} API LGTMs, ${declined.length} API DECLINEDs, and ${requestedChanges.length} change requests`,
`PR ${pr.number} has ${approved.length} API LGTMs, ${declined.length} API DECLINEDs, and ${requestedChanges.length} API CHANGES REQUESTED`,
);

const users = { approved, declined, requestedChanges };
Expand Down