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

Add [Coderabbit] PR Stats service and tests #10749

Merged
merged 14 commits into from
Dec 29, 2024
Merged

Add [Coderabbit] PR Stats service and tests #10749

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1dbee22
Add Coderabbit PR Stats service and tests
aravindputrevu Dec 16, 2024
32658fc
Refactor CoderabbitStats service to track reviews instead of PRs
aravindputrevu Dec 19, 2024
50bbe67
Enhance CodeRabbitStats service and tests
aravindputrevu Dec 20, 2024
31b95a8
Merge branch 'master' into coderabbit-badge
aravindputrevu Dec 20, 2024
34fa95b
Update services/coderabbit/coderabbit-stats.tester.js
aravindputrevu Dec 21, 2024
12568cf
Addressed codereview comments, changed tests.
aravindputrevu Dec 23, 2024
ab0cb2c
Merge branch 'master' into coderabbit-badge
aravindputrevu Dec 23, 2024
74d955f
Fix label casing in CodeRabbitStats service and tests
aravindputrevu Dec 23, 2024
4921f70
Update services/coderabbit/coderabbit-stats.service.js
aravindputrevu Dec 23, 2024
2d02098
Merge branch 'master' into coderabbit-badge
aravindputrevu Dec 23, 2024
b2b13e1
Update CodeRabbitStats service and tests to improve error messaging
aravindputrevu Dec 23, 2024
dd192e0
Added github, gitlab, bitbucket to provider.
aravindputrevu Dec 24, 2024
3e4fcf2
Changing names to match the service name, removing unneeded test.
aravindputrevu Dec 29, 2024
8470c88
Merge branch 'master' into coderabbit-badge
aravindputrevu Dec 29, 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
68 changes: 68 additions & 0 deletions services/coderabbit/coderabbit-stats.service.js
View file
Open in desktop
jNullj marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
import Joi from 'joi'
import { BaseJsonService, pathParams } from '../index.js'

const schema = Joi.object({
reviews: Joi.number().required(),
}).required()

class CodeRabbitStats extends BaseJsonService {
static category = 'analysis'
static route = {
base: 'coderabbit',
pattern: 'stats/:provider/:org/:repo',
chris48s marked this conversation as resolved.
Show resolved Hide resolved
}

static openApi = {
'/coderabbit/stats/{provider}/{org}/{repo}': {
get: {
summary: 'CodeRabbit Pull Request Reviews',
description:
'By default, this badge pulls the number of PRs reviewed by [CodeRabbit](https://coderabbit.ai), AI code review tool',
chris48s marked this conversation as resolved.
Show resolved Hide resolved
parameters: pathParams(
{
name: 'provider',
example: 'github, gitlab, bitbucket',
description: 'Version Control Provider (e.g., github)',
Copy link
Member

Choose a reason for hiding this comment

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

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].

Screenshot at 2024-12-23 18-12-35

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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

Screenshot at 2024-12-23 20-21-57

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

},
{
name: 'org',
example: 'coderabbitai',
description: 'Organization or User name',
},
{
name: 'repo',
example: 'ast-grep-essentials',
description: 'Repository name',
},
),
},
},
}

static defaultBadgeData = {
label: 'CodeRabbit Reviews',
}

static render({ reviews }) {
return {
message: `${reviews}`,
}
aravindputrevu marked this conversation as resolved.
Show resolved Hide resolved
}

async fetch({ provider, org, repo }) {
return this._requestJson({
schema,
url: `https://api.coderabbit.ai/stats/${provider}/${org}/${repo}`,
httpErrors: {
404: 'repo not found',
},
chris48s marked this conversation as resolved.
Show resolved Hide resolved
})
}

async handle({ provider, org, repo }) {
const data = await this.fetch({ provider, org, repo })
return this.constructor.render(data)
}
}

export default CodeRabbitStats
46 changes: 46 additions & 0 deletions services/coderabbit/coderabbit-stats.tester.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { createServiceTester } from '../tester.js'

export const t = await createServiceTester()

t.create('live CodeRabbitStats')
.get('/stats/github/coderabbitai/ast-grep-essentials.json')
.expectBadge({
label: 'CodeRabbit Reviews',
message: /^\d+$/,
aravindputrevu marked this conversation as resolved.
Show resolved Hide resolved
})

t.create('CodeRabbitStats valid repo')
.get('/stats/github/coderabbitai/ast-grep-essentials.json')
.intercept(nock =>
nock('https://api.coderabbit.ai')
.get('/stats/github/coderabbitai/ast-grep-essentials')
.reply(200, { reviews: 101 }),
)
.expectBadge({
label: 'CodeRabbit Reviews',
message: '101',
})

t.create('CodeRabbitStats repo not found')
chris48s marked this conversation as resolved.
Show resolved Hide resolved
.get('/stats/github/not-valid/not-found.json')
.intercept(nock =>
nock('https://api.coderabbit.ai')
.get('/stats/github/not-valid/not-found')
.reply(404, 'repo not found'),
)
.expectBadge({
label: 'CodeRabbit Reviews',
message: 'repo not found',
})

t.create('CodeRabbitStats server error')
.get('/stats/github/coderabbitai/error-repo.json')
.intercept(nock =>
nock('https://api.coderabbit.ai')
.get('/stats/github/coderabbitai/error-repo')
.reply(500, 'Internal Server Error'),
)
.expectBadge({
label: 'CodeRabbit Reviews',
message: 'inaccessible',
})
Loading