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.

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

fix(pr_checker): do not count non-approving reviews #680

Merged
merged 1 commit into from
Mar 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 15 additions & 3 deletions lib/pr_checker.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@ const FAST_TRACK_RE = /^Fast-track has been requested by @(.+?)\. Please 👍 to
const FAST_TRACK_MIN_APPROVALS = 2;
const GIT_CONFIG_GUIDE_URL = 'https://github.com/nodejs/node/blob/99b1ada/doc/guides/contributing/pull-requests.md#step-1-fork';

// eslint-disable-next-line no-extend-native
Array.prototype.findLastIndex ??= function findLastIndex(fn) {
const reversedIndex = Reflect.apply(
Array.prototype.findIndex,
this.slice().reverse(),
arguments);
return reversedIndex === -1 ? -1 : this.length - reversedIndex - 1;
};

export default class PRChecker {
/**
* @param {{}} cli
Expand Down Expand Up @@ -520,11 +529,14 @@ export default class PRChecker {
} = this;
const { maxCommits } = argv;

if (reviews.length < 1) {
const reviewIndex = reviews.findLastIndex(
review => review.authorCanPushToRepository && review.state === 'APPROVED'
);

if (reviewIndex === -1) {
return false;
}

const reviewIndex = reviews.length - 1;
const reviewDate = reviews[reviewIndex].publishedAt;

const afterCommits = [];
Expand All @@ -537,7 +549,7 @@ export default class PRChecker {

const totalCommits = afterCommits.length;
if (totalCommits > 0) {
cli.warn('Commits were pushed since the last review:');
cli.warn('Commits were pushed since the last approving review:');
const sliceLength = maxCommits === 0 ? totalCommits : -maxCommits;
afterCommits.slice(sliceLength)
.forEach(commit => {
Expand Down
1 change: 1 addition & 0 deletions lib/queries/Reviews.gql
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ query Reviews($prid: Int!, $owner: String!, $repo: String!, $after: String) {
author {
login
}
authorCanPushToRepository
url
publishedAt
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-89923489",
"publishedAt": "2017-07-23T11:19:25Z"
}]
1 change: 1 addition & 0 deletions test/fixtures/multiple_commits_after_review_reviews.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-89923489",
"publishedAt": "2017-09-23T11:19:25Z"
}]
7 changes: 7 additions & 0 deletions test/fixtures/reviews_approved.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71480624",
"publishedAt": "2017-10-24T11:19:00Z"
},
Expand All @@ -13,6 +14,7 @@
"author": {
"login": "Baz"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71488392",
"publishedAt": "2017-10-24T11:50:52Z"
},
Expand All @@ -22,6 +24,7 @@
"author": {
"login": "Baz"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-714882992",
"publishedAt": "2017-10-24T12:30:52Z"
},
Expand All @@ -31,6 +34,7 @@
"author": {
"login": "Quux"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71817236",
"publishedAt": "2017-10-24T14:49:01Z"
},
Expand All @@ -40,6 +44,7 @@
"author": {
"login": "Baz"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71488236",
"publishedAt": "2017-10-24T14:49:02Z"
},
Expand All @@ -49,6 +54,7 @@
"author": {
"login": "Quo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71817236",
"publishedAt": "2017-10-24T19:09:52Z"
},
Expand All @@ -58,6 +64,7 @@
"author": {
"login": "bot"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71839232",
"publishedAt": "2017-10-28T19:21:52Z"
}]
6 changes: 6 additions & 0 deletions test/fixtures/reviews_requesting_changes.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71480624",
"publishedAt": "2017-10-24T11:19:25Z"
},
Expand All @@ -14,6 +15,7 @@
"author": {
"login": "Baz"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71488392",
"publishedAt": "2017-10-24T11:50:52Z"
},
Expand All @@ -23,6 +25,7 @@
"author": {
"login": "Baz"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-714882992",
"publishedAt": "2017-10-24T12:30:52Z"
},
Expand All @@ -32,6 +35,7 @@
"author": {
"login": "Quo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71817236",
"publishedAt": "2017-10-24T19:09:52Z"
},
Expand All @@ -41,6 +45,7 @@
"author": {
"login": "bot"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71839232",
"publishedAt": "2017-10-24T19:21:52Z"
},
Expand All @@ -50,6 +55,7 @@
"author": {
"login": "bar"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71482624",
"publishedAt": "2017-10-24T11:27:02Z"
}]
19 changes: 19 additions & 0 deletions test/fixtures/single_commit_after_review_reviews.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71480624",
"publishedAt": "2017-10-24T11:19:25Z"
},{
"bodyText": "Not sure about that last change",
"state": "COMMENTED",
"author": {
"login": "foo"
},
"authorCanPushToRepository": true,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71480625",
"publishedAt": "2017-10-26T11:19:25Z"
},{
"bodyText": "Good idea",
"state": "APPROVED",
"author": {
"login": "bar"
},
"authorCanPushToRepository": false,
"url": "https://github.com/nodejs/node/pull/16438#pullrequestreview-71480626",
"publishedAt": "2017-10-26T11:19:25Z"
}]
16 changes: 7 additions & 9 deletions test/unit/pr_checker.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2059,7 +2059,7 @@ describe('PRChecker', () => {

const expectedLogs = {
warn: [
['Commits were pushed since the last review:'],
['Commits were pushed since the last approving review:'],
['- src: fix issue with es-modules']
],
info: [],
Expand Down Expand Up @@ -2091,7 +2091,7 @@ describe('PRChecker', () => {

const expectedLogs = {
warn: [
['Commits were pushed since the last review:'],
['Commits were pushed since the last approving review:'],
['- src: add requested feature'],
['- nit: edit mistakes']
],
Expand Down Expand Up @@ -2122,7 +2122,7 @@ describe('PRChecker', () => {
const { commits, reviews } = moreThanThreeCommitsAfterReview;
const expectedLogs = {
warn: [
['Commits were pushed since the last review:'],
['Commits were pushed since the last approving review:'],
['- src: add requested feature'],
['- nit: edit mistakes'],
['- final: we should be good to go'],
Expand Down Expand Up @@ -2180,20 +2180,18 @@ describe('PRChecker', () => {
commits: simpleCommits,
collaborators,
authorIsNew: () => true,
getThread() {
return PRData.prototype.getThread.call(this);
}
getThread: PRData.prototype.getThread
}, {}, argv);

const status = checker.checkCommitsAfterReview();
assert.deepStrictEqual(status, true);
assert.strictEqual(status, true);
});

it('should log as expected if passed 1 as flag', () => {
const { commits, reviews } = moreThanThreeCommitsAfterReview;
const expectedLogs = {
warn: [
['Commits were pushed since the last review:'],
['Commits were pushed since the last approving review:'],
['- final: we should be good to go'],
['...(use `--max-commits 4` to see the full list of commits)']
],
Expand Down Expand Up @@ -2224,7 +2222,7 @@ describe('PRChecker', () => {
const { commits, reviews } = moreThanThreeCommitsAfterReview;
const expectedLogs = {
warn: [
['Commits were pushed since the last review:'],
['Commits were pushed since the last approving review:'],
['...(use `--max-commits 4` to see the full list of commits)']
],
info: [],
Expand Down