fix(prlint): a review label doesn't appear when a PR is approved if there are too many comments by go-to-k · Pull Request #31290 · aws/aws-cdk

go-to-k · 2024-09-02T17:45:40Z

Issue # (if applicable)

Closes #31294 .

Reason for this change

I've reviewed and approved this PR as a Trusted Community Reviewer.

But it doesn't get the pr/needs-maintainer-review label. It seems to be in CHANGES_REQUESTED state and communityApproved is also false in the job PR Linter / validate-pr. (Please see this comment in the PR.)

I checked the prlint's log in the GitHub Actions output, and it appears that there is too much history (such as comments) to get all the latest data.

List reviews for a pull request in GitHub API can get 30 items per page, however, prlint is not implemented to handle pagination.

  private async assessNeedsReview(
    pr: Pick<GitHubPr, 'mergeable_state' | 'draft' | 'labels' | 'number'>,
  ): Promise<void> {
    const reviews = await this.client.pulls.listReviews(this.prParams);

Therefore, when there are more than 30 comments or change requests, the review label is no longer displayed.

Description of changes

Use pagination for listReviews in the octokit library.

https://github.com/octokit/octokit.js?tab=readme-ov-file#pagination

before

await this.client.pulls.listReviews(this.prParams);

after

await this.client.paginate(this.client.pulls.listReviews, this.prParams);

Description of how you validated changes

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

This reverts commit cd09453.

This reverts commit 0c5f016.

go-to-k · 2024-09-03T06:50:27Z

Exemption Request:

This PR only changes the call handling regarding the external API (GitHub API via octokit), and the handling is mocked in unit tests. So I can't test in the unit tests. The no regression is confirmed by the fact that existing tests pass.

https://github.com/aws/aws-cdk/blob/v2.155.0/tools/%40aws-cdk/prlint/test/lint.test.ts#L7-L9

https://github.com/aws/aws-cdk/blob/v2.155.0/tools/%40aws-cdk/prlint/test/lint.test.ts#L1207

It also appears that a PR that have introduced pagination in prlint in the past have not added testing in the same way.

go-to-k · 2024-09-03T06:52:53Z

tools/@aws-cdk/prlint/lint.ts

  ): Promise<void> {
-    const reviews = await this.client.pulls.listReviews(this.prParams);
-    console.log(JSON.stringify(reviews.data));
+    const reviewsData = await this.client.paginate(this.client.pulls.listReviews, this.prParams);


ref:

https://github.com/octokit/octokit.js?tab=readme-ov-file#pagination

https://github.com/aws/aws-cdk/pull/22555/files

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

kaizencc

Thanks @go-to-k!

mergify · 2024-09-03T20:23:36Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2024-09-03T20:54:52Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 5d99b88
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-09-03T20:55:09Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2024-09-03T20:55:26Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

wip

7b4de34

aws-cdk-automation requested a review from a team September 2, 2024 17:45

github-actions bot added distinguished-contributor [Pilot] contributed 50+ PRs to the CDK p2 labels Sep 2, 2024

aws-cdk-automation previously requested changes Sep 2, 2024

View reviewed changes

go-to-k mentioned this pull request Sep 2, 2024

feat(ecs-patterns): add containerCpu and containerMemoryLimitMiB property to ApplicationLoadBalancedFargateService #30920

Merged

1 task

rm comments

1f2a37b

go-to-k changed the title ~~fix(prlint): review labels don't appear when a PR is approved if there are too many comments~~ fix(prlint): a review label doesn't appear when a PR is approved if there are too many comments Sep 3, 2024

github-actions bot added the bug This issue is a bug. label Sep 3, 2024

go-to-k added 4 commits September 3, 2024 15:32

test debug

cd09453

Revert "test debug"

6c295af

This reverts commit cd09453.

debug 2

0c5f016

Revert "debug 2"

6aa7b60

This reverts commit 0c5f016.

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Sep 3, 2024

go-to-k marked this pull request as ready for review September 3, 2024 06:52

go-to-k commented Sep 3, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 3, 2024

kaizencc added pr-linter/exempt-test The PR linter will not require test changes pr-linter/exempt-integ-test The PR linter will not require integ test changes and removed pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. labels Sep 3, 2024

kaizencc approved these changes Sep 3, 2024

View reviewed changes

Merge branch 'main' into prlint-pagination

5d99b88

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 3, 2024

mergify bot merged commit 1c63070 into aws:main Sep 3, 2024

github-actions bot locked as resolved and limited conversation to collaborators Sep 3, 2024

go-to-k deleted the prlint-pagination branch September 4, 2024 02:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(prlint): a review label doesn't appear when a PR is approved if there are too many comments#31290

fix(prlint): a review label doesn't appear when a PR is approved if there are too many comments#31290
mergify[bot] merged 7 commits intoaws:mainfrom
go-to-k:prlint-pagination

go-to-k commented Sep 2, 2024 •

edited

Loading

Uh oh!

aws-cdk-automation left a comment

Uh oh!

go-to-k commented Sep 3, 2024

Uh oh!

go-to-k Sep 3, 2024

Uh oh!

kaizencc left a comment

Uh oh!

mergify bot commented Sep 3, 2024

Uh oh!

aws-cdk-automation commented Sep 3, 2024

Uh oh!

mergify bot commented Sep 3, 2024

Uh oh!

github-actions bot commented Sep 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

go-to-k commented Sep 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

go-to-k commented Sep 3, 2024

Uh oh!

go-to-k Sep 3, 2024

Choose a reason for hiding this comment

Uh oh!

kaizencc left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Sep 3, 2024

Uh oh!

aws-cdk-automation commented Sep 3, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Sep 3, 2024

Uh oh!

github-actions bot commented Sep 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

go-to-k commented Sep 2, 2024 •

edited

Loading