14892e3943
* allow serviceData to override cacheSeconds with a longer value * prevent [endpoint] json cacheSeconds property exceeding service default * allow ShieldsRuntimeError to specify a cacheSeconds property By default error responses use the cacheLength of the service class throwing the error. This allows error to tell the handling layer the maxAge that should be set on the error badge response. * add customExceptions param This 1. allows us to specify custom properties to pass to the exception constructor if we throw any of the standard got errors e.g: `ETIMEDOUT`, `ECONNRESET`, etc 2. uses a custom `cacheSeconds` property (if set on the exception) to set the response maxAge * customExceptions --> systemErrors * errorMessages --> httpErrors
69 lines
1.7 KiB
JavaScript
69 lines
1.7 KiB
JavaScript
import Joi from 'joi'
|
|
import { optionalUrl } from '../validators.js'
|
|
import { metric } from '../text-formatters.js'
|
|
import { documentation, 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 examples = [
|
|
{
|
|
title: 'GitLab language count',
|
|
namedParams: {
|
|
project: 'gitlab-org/gitlab',
|
|
},
|
|
queryParams: { gitlab_url: 'https://gitlab.com' },
|
|
staticPreview: {
|
|
label: 'languages',
|
|
message: '5',
|
|
},
|
|
documentation,
|
|
},
|
|
]
|
|
|
|
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 })
|
|
}
|
|
}
|