Add [Coderabbit] PR Stats service and tests #10749

aravindputrevu · 2024-12-16T15:36:58Z

Implemented a new service CoderabbitStats to fetch and display pull request statistics from the CodeRabbit API.
Created a corresponding tester file to validate the service's functionality, including tests for valid repositories, repository not found, and server errors.
The service returns a badge with the number of PRs and appropriate error messages based on the API response.

This addition enhances the analysis capabilities of the application by integrating CodeRabbit statistics.

GitHub Issue - #10748

- Implemented a new service `CoderabbitStats` to fetch and display pull request statistics from the CodeRabbit API. - Created a corresponding tester file to validate the service's functionality, including tests for valid repositories, repository not found, and server errors. - The service returns a badge with the number of PRs and appropriate error messages based on the API response. This addition enhances the analysis capabilities of the application by integrating CodeRabbit statistics.

github-actions · 2024-12-16T15:38:05Z

	Messages
📖	✨ Thanks for your contribution to Shields, @aravindputrevu!

Generated by 🚫 dangerJS against 8470c88

jNullj

Thank you for the contribution.
I noticed you did not add any live tests (making real API calls to external service) and only mocked responses.
Please give a quick read to this section of our docs about tests, as mentioned its best to include at least one live test so we know our service is still live and up to date with upstream.

Note that when we call our badge, we are allowing it to communicate with an external service without mocking the response. We write tests which interact with external services, which is unusual practice in unit testing. We do this because one of the purposes of service tests is to notify us if a badge has broken due to an upstream API change. For this reason it is important for at least one test to call the live API without mocking the interaction

Is there a specific reason to avoid using live tests? If no could you add at least one live test, Its common for our project to have all calls to live services in tests unless we test internal functionality like data transformation of API response.

- Updated the service to fetch and display the number of reviews from the CodeRabbit API, changing the schema and badge labels accordingly. - Modified the tester file to reflect the new endpoint and expected responses, including regex for message validation. - Enhanced error handling in the service to return more descriptive error messages for invalid repositories and server errors. This change improves the accuracy of the statistics provided by the service, aligning it with the intended functionality of tracking reviews.

aravindputrevu · 2024-12-19T15:49:15Z

@jNullj I have made relevant changes as per your request, requesting you to see if it fits the guidelines.

services/coderabbit/coderabbit-stats.service.js

- Updated the CodeRabbitStats service to include OpenAPI documentation and improved error handling for repository not found scenarios. - Changed badge label from 'CodeRabbit' to 'CodeRabbit Reviews' for clarity. - Modified the tester file to reflect the new badge format and error messages, ensuring consistency with the service updates. - Adjusted regex patterns for message validation in tests. These changes improve the usability and accuracy of the CodeRabbit statistics service.

aravindputrevu · 2024-12-20T14:25:14Z

@chris48s I'm contributing a badge for the first time to shields.io.

Sorry for the trouble with obvious mistakes. I've read the contributor.md and tutorial.md, but I still missed a lot. Please re-review and let me know if things are out of place.

services/coderabbit/coderabbit-stats.service.js

services/coderabbit/coderabbit-stats.tester.js

Co-authored-by: jNullj <[email protected]>

chris48s

Latest draft is looking pretty good. There's a few more bits on this latest revision, but we're getting there. Thanks

services/coderabbit/coderabbit-stats.service.js

chris48s · 2024-12-23T18:13:24Z

services/coderabbit/coderabbit-stats.service.js

+            example: 'github, gitlab, bitbucket',
+            description: 'Version Control Provider (e.g., github)',


The example value should be a value that works, so "github" would be sensible value for example here. Basically if I copy and paste it into the builder, it should work.

We also don't need to double up examples in the description.

In the docs, if we want to communicate to the user that there is a closed set of valid values, we can give the user a dropdown to pick from. So if you look at something like the vcsType param on https://shields.io/badges/coveralls you get a dropdown for [github, bitbucket, gitlab].

Here's what that looks like in the code.

shields/services/coveralls/coveralls.service.js

Line 17 in 0cbc131

pattern: ':vcsType(github|bitbucket|gitlab)/:user/:repo+',

shields/services/coveralls/coveralls.service.js

Lines 26 to 30 in 0cbc131

pathParam({

name: 'vcsType',

example: 'github',

schema: { type: 'string', enum: this.getEnum('vcsType') },

}),

Lets do the same here.

I'm ok for the time-being it showing only GH. As GH has most usage, I'll be happy to update in the next revision with the upcoming badges.

Editing the text to only show GitHub.

OK. Are gitlab and bitbucket values that work today, or not?

If they are, lets make this

static route = { base: 'coderabbit', pattern: 'prs/:provider(github|bitbucket|gitlab)/:org/:repo', }

in the route and

{ name: 'provider', example: 'github', description: 'Version Control Provider', schema: { type: 'string', enum: this.getEnum('provider') }, }

in the Open API spec.

That will show it as

in the docs, and we're good to go.

Made this change as you mentioned. Thanks for the suggestion!

services/coderabbit/coderabbit-stats.service.js

Co-authored-by: chris48s <[email protected]>

- Changed example section in CodeRabbitStats service from 'github, gitlab, bitbucket' to 'github' as per review comment. - Updated error message for 404 response to 'provider or repo not found', to reflect the right code.

jNullj

Looks good, i run it and it seems to work as intended.
I have 2 more comments, I think that other then this 2 I could approve the PR.
Take note that we usually wait until all reviewers involved with the PR approve before merging the PR.

services/coderabbit/coderabbit-stats.tester.js

services/coderabbit/coderabbit-stats.service.js

jNullj

LGTM

github-actions · 2024-12-29T16:33:51Z

🚀 Updated review app: https://pr-10749-badges-shields.fly.dev

chris48s changed the title ~~Add Coderabbit PR Stats service and tests~~ Add [Coderabbit] PR Stats service and tests Dec 16, 2024

chris48s added the service-badge New or updated service badge label Dec 16, 2024

jNullj requested changes Dec 16, 2024

View reviewed changes

chris48s reviewed Dec 20, 2024

View reviewed changes

Merge branch 'master' into coderabbit-badge

31b95a8

jNullj requested changes Dec 21, 2024

View reviewed changes

services/coderabbit/coderabbit-stats.service.js Outdated Show resolved Hide resolved

services/coderabbit/coderabbit-stats.tester.js Outdated Show resolved Hide resolved

services/coderabbit/coderabbit-stats.tester.js Outdated Show resolved Hide resolved

aravindputrevu and others added 4 commits December 21, 2024 15:18

Update services/coderabbit/coderabbit-stats.tester.js

34fa95b

Co-authored-by: jNullj <[email protected]>

Addressed codereview comments, changed tests.

12568cf

Merge branch 'master' into coderabbit-badge

ab0cb2c

Fix label casing in CodeRabbitStats service and tests

74d955f

chris48s reviewed Dec 23, 2024

View reviewed changes

aravindputrevu and others added 4 commits December 23, 2024 19:32

Update services/coderabbit/coderabbit-stats.service.js

4921f70

Co-authored-by: chris48s <[email protected]>

Merge branch 'master' into coderabbit-badge

2d02098

Added github, gitlab, bitbucket to provider.

dd192e0

jNullj requested changes Dec 27, 2024

View reviewed changes

services/coderabbit/coderabbit-stats.tester.js Outdated Show resolved Hide resolved

services/coderabbit/coderabbit-stats.service.js Outdated Show resolved Hide resolved

aravindputrevu added 2 commits December 29, 2024 11:26

Changing names to match the service name, removing unneeded test.

3e4fcf2

Merge branch 'master' into coderabbit-badge

8470c88

jNullj approved these changes Dec 29, 2024

View reviewed changes

chris48s approved these changes Dec 29, 2024

View reviewed changes

chris48s added this pull request to the merge queue Dec 29, 2024

Merged via the queue into badges:master with commit cb30902 Dec 29, 2024
23 checks passed

chris48s mentioned this pull request Dec 31, 2024

use metric() in [coderabbit] badge #10779

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add [Coderabbit] PR Stats service and tests #10749

Add [Coderabbit] PR Stats service and tests #10749

aravindputrevu commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading

jNullj left a comment

aravindputrevu commented Dec 19, 2024

aravindputrevu commented Dec 20, 2024

chris48s left a comment

chris48s Dec 23, 2024

aravindputrevu Dec 23, 2024

chris48s Dec 23, 2024

aravindputrevu Dec 24, 2024

jNullj left a comment

jNullj left a comment

github-actions bot commented Dec 29, 2024

		example: 'github, gitlab, bitbucket',
		description: 'Version Control Provider (e.g., github)',

	pathParam({
	name: 'vcsType',
	example: 'github',
	schema: { type: 'string', enum: this.getEnum('vcsType') },
	}),

Add [Coderabbit] PR Stats service and tests #10749

Add [Coderabbit] PR Stats service and tests #10749

Conversation

aravindputrevu commented Dec 16, 2024 • edited Loading

github-actions bot commented Dec 16, 2024 • edited Loading

jNullj left a comment

Choose a reason for hiding this comment

aravindputrevu commented Dec 19, 2024

aravindputrevu commented Dec 20, 2024

chris48s left a comment

Choose a reason for hiding this comment

chris48s Dec 23, 2024

Choose a reason for hiding this comment

aravindputrevu Dec 23, 2024

Choose a reason for hiding this comment

chris48s Dec 23, 2024

Choose a reason for hiding this comment

aravindputrevu Dec 24, 2024

Choose a reason for hiding this comment

jNullj left a comment

Choose a reason for hiding this comment

jNullj left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 29, 2024

aravindputrevu commented Dec 16, 2024 •

edited

Loading

github-actions bot commented Dec 16, 2024 •

edited

Loading