Files
shields/services/gitlab/gitlab-languages-count.service.js
chris48s 10bf39632a migrate examples to openApi part 26; affects [gitlab] (#9752)
* replace failing 'other' test with a mock

* update pipeline/coverage 'not found' tests

* migrate gitlab from examples to openApi

* eat own tail
2023-12-30 17:38:31 +00:00

74 lines
1.9 KiB
JavaScript

import Joi from 'joi'
import { pathParam, queryParam } from '../index.js'
import { optionalUrl } from '../validators.js'
import { metric } from '../text-formatters.js'
import { description, httpErrorsFor } from './gitlab-helper.js'
import GitLabBase from './gitlab-base.js'
/*
We're expecting a response like { "Ruby": 67.13, "JavaScript": 19.66 }
The keys could be anything and {} is a valid response (e.g: for an empty project)
*/
const schema = Joi.object().pattern(/./, Joi.number().min(0).max(100))
const queryParamSchema = Joi.object({
gitlab_url: optionalUrl,
}).required()
export default class GitlabLanguageCount extends GitLabBase {
static category = 'analysis'
static route = {
base: 'gitlab/languages/count',
pattern: ':project+',
queryParamSchema,
}
static openApi = {
'/gitlab/languages/count/{project}': {
get: {
summary: 'GitLab Language Count',
description,
parameters: [
pathParam({
name: 'project',
example: 'gitlab-org/gitlab',
}),
queryParam({
name: 'gitlab_url',
example: 'https://gitlab.com',
}),
],
},
},
}
static defaultBadgeData = { label: 'languages' }
static render({ languagesCount }) {
return {
message: metric(languagesCount),
color: 'blue',
}
}
async fetch({ project, baseUrl }) {
// https://docs.gitlab.com/ee/api/projects.html#languages
return super.fetch({
schema,
url: `${baseUrl}/api/v4/projects/${encodeURIComponent(
project,
)}/languages`,
httpErrors: httpErrorsFor('project not found'),
})
}
async handle({ project }, { gitlab_url: baseUrl = 'https://gitlab.com' }) {
const data = await this.fetch({
project,
baseUrl,
})
return this.constructor.render({ languagesCount: Object.keys(data).length })
}
}