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
131 lines
3.3 KiB
JavaScript
131 lines
3.3 KiB
JavaScript
import Joi from 'joi'
|
|
import { version as versionColor } from '../color-formatters.js'
|
|
import { optionalUrl } from '../validators.js'
|
|
import { latest } from '../version.js'
|
|
import { addv } from '../text-formatters.js'
|
|
import { NotFound } from '../index.js'
|
|
import { documentation, httpErrorsFor } from './gitlab-helper.js'
|
|
import GitLabBase from './gitlab-base.js'
|
|
|
|
const schema = Joi.array().items(
|
|
Joi.object({
|
|
name: Joi.string().required(),
|
|
})
|
|
)
|
|
|
|
const queryParamSchema = Joi.object({
|
|
gitlab_url: optionalUrl,
|
|
include_prereleases: Joi.equal(''),
|
|
sort: Joi.string().valid('date', 'semver').default('date'),
|
|
}).required()
|
|
|
|
const commonProps = {
|
|
namedParams: {
|
|
project: 'shields-ops-group/tag-test',
|
|
},
|
|
documentation,
|
|
}
|
|
|
|
export default class GitlabTag extends GitLabBase {
|
|
static category = 'version'
|
|
|
|
static route = {
|
|
base: 'gitlab/v/tag',
|
|
pattern: ':project+',
|
|
queryParamSchema,
|
|
}
|
|
|
|
static examples = [
|
|
{
|
|
title: 'GitLab tag (latest by date)',
|
|
...commonProps,
|
|
queryParams: { sort: 'date' },
|
|
staticPreview: this.render({ version: 'v2.0.0' }),
|
|
},
|
|
{
|
|
title: 'GitLab tag (latest by SemVer)',
|
|
...commonProps,
|
|
queryParams: { sort: 'semver' },
|
|
staticPreview: this.render({ version: 'v4.0.0' }),
|
|
},
|
|
{
|
|
title: 'GitLab tag (latest by SemVer pre-release)',
|
|
...commonProps,
|
|
queryParams: {
|
|
sort: 'semver',
|
|
include_prereleases: null,
|
|
},
|
|
staticPreview: this.render({ version: 'v5.0.0-beta.1', sort: 'semver' }),
|
|
},
|
|
{
|
|
title: 'GitLab tag (self-managed)',
|
|
namedParams: {
|
|
project: 'GNOME/librsvg',
|
|
},
|
|
documentation,
|
|
queryParams: {
|
|
sort: 'semver',
|
|
include_prereleases: null,
|
|
gitlab_url: 'https://gitlab.gnome.org',
|
|
},
|
|
staticPreview: this.render({ version: 'v2.51.4' }),
|
|
},
|
|
]
|
|
|
|
static defaultBadgeData = { label: 'tag' }
|
|
|
|
static render({ version, sort }) {
|
|
return {
|
|
message: addv(version),
|
|
color: sort === 'semver' ? versionColor(version) : 'blue',
|
|
}
|
|
}
|
|
|
|
async fetch({ project, baseUrl }) {
|
|
// https://docs.gitlab.com/ee/api/tags.html
|
|
// N.B. the documentation has contradictory information about default sort order.
|
|
// As of 2020-10-11 the default is by date, but we add the `order_by` query param
|
|
// explicitly in case that changes upstream.
|
|
return super.fetch({
|
|
schema,
|
|
url: `${baseUrl}/api/v4/projects/${encodeURIComponent(
|
|
project
|
|
)}/repository/tags`,
|
|
options: { searchParams: { order_by: 'updated' } },
|
|
httpErrors: httpErrorsFor('project not found'),
|
|
})
|
|
}
|
|
|
|
static transform({ tags, sort, includePrereleases }) {
|
|
if (tags.length === 0) {
|
|
throw new NotFound({ prettyMessage: 'no tags found' })
|
|
}
|
|
|
|
if (sort === 'date') {
|
|
return tags[0].name
|
|
}
|
|
|
|
return latest(
|
|
tags.map(t => t.name),
|
|
{ pre: includePrereleases }
|
|
)
|
|
}
|
|
|
|
async handle(
|
|
{ project },
|
|
{
|
|
gitlab_url: baseUrl = 'https://gitlab.com',
|
|
include_prereleases: pre,
|
|
sort,
|
|
}
|
|
) {
|
|
const tags = await this.fetch({ project, baseUrl })
|
|
const version = this.constructor.transform({
|
|
tags,
|
|
sort,
|
|
includePrereleases: pre !== undefined,
|
|
})
|
|
return this.constructor.render({ version, sort })
|
|
}
|
|
}
|