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

[go-to-k]

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.

[go-to-k]

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]

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]

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]

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]

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]

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.