mirror of
https://github.com/badges/shields.git
synced 2025-04-18 19:44:04 +03:00
615 lines
18 KiB
JavaScript
615 lines
18 KiB
JavaScript
/**
|
|
* @module
|
|
*/
|
|
|
|
import path from 'path'
|
|
import url, { fileURLToPath } from 'url'
|
|
import { bootstrap } from 'global-agent'
|
|
import cloudflareMiddleware from 'cloudflare-middleware'
|
|
import Camp from '@shields_io/camp'
|
|
import originalJoi from 'joi'
|
|
import makeBadge from '../../badge-maker/lib/make-badge.js'
|
|
import GithubConstellation from '../../services/github/github-constellation.js'
|
|
import LibrariesIoConstellation from '../../services/librariesio/librariesio-constellation.js'
|
|
import { loadServiceClasses } from '../base-service/loader.js'
|
|
import { makeSend } from '../base-service/legacy-result-sender.js'
|
|
import { handleRequest } from '../base-service/legacy-request-handler.js'
|
|
import { clearResourceCache } from '../base-service/resource-cache.js'
|
|
import { rasterRedirectUrl } from '../badge-urls/make-badge-url.js'
|
|
import { fileSize, nonNegativeInteger } from '../../services/validators.js'
|
|
import log from './log.js'
|
|
import PrometheusMetrics from './prometheus-metrics.js'
|
|
import InfluxMetrics from './influx-metrics.js'
|
|
const { URL } = url
|
|
|
|
const Joi = originalJoi
|
|
.extend(base => ({
|
|
type: 'arrayFromString',
|
|
base: base.array(),
|
|
coerce: (value, state, options) => ({
|
|
value: typeof value === 'string' ? value.split(' ') : value,
|
|
}),
|
|
}))
|
|
.extend(base => ({
|
|
type: 'string',
|
|
base: base.string(),
|
|
messages: {
|
|
'string.origin':
|
|
'needs to be an origin string, e.g. https://host.domain with optional port and no trailing slash',
|
|
},
|
|
rules: {
|
|
origin: {
|
|
validate(value, helpers) {
|
|
let origin
|
|
try {
|
|
;({ origin } = new URL(value))
|
|
} catch (e) {}
|
|
if (origin !== undefined && origin === value) {
|
|
return value
|
|
} else {
|
|
return helpers.error('string.origin')
|
|
}
|
|
},
|
|
},
|
|
},
|
|
}))
|
|
|
|
const optionalUrl = Joi.string().uri({ scheme: ['http', 'https'] })
|
|
const requiredUrl = optionalUrl.required()
|
|
const origins = Joi.arrayFromString().items(Joi.string().origin())
|
|
const defaultService = Joi.object({ authorizedOrigins: origins }).default({
|
|
authorizedOrigins: [],
|
|
})
|
|
|
|
const publicConfigSchema = Joi.object({
|
|
bind: {
|
|
port: Joi.alternatives().try(
|
|
Joi.number().port(),
|
|
Joi.string().pattern(/^\\\\\.\\pipe\\.+$/),
|
|
),
|
|
address: Joi.alternatives().try(
|
|
Joi.string().ip().required(),
|
|
Joi.string().hostname().required(),
|
|
),
|
|
},
|
|
metrics: {
|
|
prometheus: {
|
|
enabled: Joi.boolean().required(),
|
|
endpointEnabled: Joi.boolean().required(),
|
|
},
|
|
influx: {
|
|
enabled: Joi.boolean().required(),
|
|
url: Joi.string()
|
|
.uri()
|
|
.when('enabled', { is: true, then: Joi.required() }),
|
|
timeoutMilliseconds: Joi.number()
|
|
.integer()
|
|
.min(1)
|
|
.when('enabled', { is: true, then: Joi.required() }),
|
|
intervalSeconds: Joi.number().integer().min(1).when('enabled', {
|
|
is: true,
|
|
then: Joi.required(),
|
|
}),
|
|
instanceIdFrom: Joi.string()
|
|
.equal('hostname', 'env-var', 'random')
|
|
.when('enabled', { is: true, then: Joi.required() }),
|
|
instanceIdEnvVarName: Joi.string().when('instanceIdFrom', {
|
|
is: 'env-var',
|
|
then: Joi.required(),
|
|
}),
|
|
envLabel: Joi.string().when('enabled', {
|
|
is: true,
|
|
then: Joi.required(),
|
|
}),
|
|
hostnameAliases: Joi.object(),
|
|
},
|
|
},
|
|
ssl: {
|
|
isSecure: Joi.boolean().required(),
|
|
key: Joi.string(),
|
|
cert: Joi.string(),
|
|
},
|
|
redirectUrl: optionalUrl,
|
|
rasterUrl: optionalUrl,
|
|
cors: {
|
|
// This doesn't actually do anything
|
|
// TODO: maybe remove in future?
|
|
// https://github.com/badges/shields/pull/8311#discussion_r945337530
|
|
allowedOrigin: Joi.array().items(optionalUrl).required(),
|
|
},
|
|
services: Joi.object({
|
|
bitbucketServer: defaultService,
|
|
drone: defaultService,
|
|
github: {
|
|
baseUri: requiredUrl,
|
|
debug: {
|
|
enabled: Joi.boolean().required(),
|
|
intervalSeconds: Joi.number().integer().min(1).required(),
|
|
},
|
|
restApiVersion: Joi.date().raw().required(),
|
|
},
|
|
gitea: defaultService,
|
|
gitlab: defaultService,
|
|
jira: defaultService,
|
|
jenkins: Joi.object({
|
|
authorizedOrigins: origins,
|
|
requireStrictSsl: Joi.boolean(),
|
|
requireStrictSslToAuthenticate: Joi.boolean(),
|
|
}).default({ authorizedOrigins: [] }),
|
|
nexus: defaultService,
|
|
npm: defaultService,
|
|
obs: defaultService,
|
|
pypi: {
|
|
baseUri: requiredUrl,
|
|
},
|
|
sonar: defaultService,
|
|
teamcity: defaultService,
|
|
weblate: defaultService,
|
|
trace: Joi.boolean().required(),
|
|
}).required(),
|
|
cacheHeaders: { defaultCacheLengthSeconds: nonNegativeInteger },
|
|
handleInternalErrors: Joi.boolean().required(),
|
|
fetchLimit: fileSize,
|
|
userAgentBase: Joi.string().required(),
|
|
requestTimeoutSeconds: nonNegativeInteger,
|
|
requestTimeoutMaxAgeSeconds: nonNegativeInteger,
|
|
documentRoot: Joi.string().default(
|
|
path.resolve(
|
|
path.dirname(fileURLToPath(import.meta.url)),
|
|
'..',
|
|
'..',
|
|
'public',
|
|
),
|
|
),
|
|
requireCloudflare: Joi.boolean().required(),
|
|
}).required()
|
|
|
|
const privateConfigSchema = Joi.object({
|
|
azure_devops_token: Joi.string(),
|
|
curseforge_api_key: Joi.string(),
|
|
discord_bot_token: Joi.string(),
|
|
dockerhub_username: Joi.string(),
|
|
dockerhub_pat: Joi.string(),
|
|
drone_token: Joi.string(),
|
|
gh_client_id: Joi.string(),
|
|
gh_client_secret: Joi.string(),
|
|
gh_token: Joi.string(),
|
|
gitea_token: Joi.string(),
|
|
gitlab_token: Joi.string(),
|
|
jenkins_user: Joi.string(),
|
|
jenkins_pass: Joi.string(),
|
|
jira_user: Joi.string(),
|
|
jira_pass: Joi.string(),
|
|
bitbucket_username: Joi.string(),
|
|
bitbucket_password: Joi.string(),
|
|
bitbucket_server_username: Joi.string(),
|
|
bitbucket_server_password: Joi.string(),
|
|
librariesio_tokens: Joi.arrayFromString().items(Joi.string()),
|
|
nexus_user: Joi.string(),
|
|
nexus_pass: Joi.string(),
|
|
npm_token: Joi.string(),
|
|
obs_user: Joi.string(),
|
|
obs_pass: Joi.string(),
|
|
redis_url: Joi.string().uri({ scheme: ['redis', 'rediss'] }),
|
|
opencollective_token: Joi.string(),
|
|
pepy_key: Joi.string(),
|
|
postgres_url: Joi.string().uri({ scheme: 'postgresql' }),
|
|
reddit_client_id: Joi.string(),
|
|
reddit_client_secret: Joi.string(),
|
|
sentry_dsn: Joi.string(),
|
|
sl_insight_userUuid: Joi.string(),
|
|
sl_insight_apiToken: Joi.string(),
|
|
sonarqube_token: Joi.string(),
|
|
stackapps_api_key: Joi.string(),
|
|
teamcity_user: Joi.string(),
|
|
teamcity_pass: Joi.string(),
|
|
twitch_client_id: Joi.string(),
|
|
twitch_client_secret: Joi.string(),
|
|
influx_username: Joi.string(),
|
|
influx_password: Joi.string(),
|
|
weblate_api_key: Joi.string(),
|
|
youtube_api_key: Joi.string(),
|
|
}).required()
|
|
const privateMetricsInfluxConfigSchema = privateConfigSchema.append({
|
|
influx_username: Joi.string().required(),
|
|
influx_password: Joi.string().required(),
|
|
})
|
|
|
|
function addHandlerAtIndex(camp, index, handlerFn) {
|
|
camp.stack.splice(index, 0, handlerFn)
|
|
}
|
|
|
|
function isOnHeroku() {
|
|
return !!process.env.DYNO
|
|
}
|
|
|
|
function isOnFly() {
|
|
return !!process.env.FLY_APP_NAME
|
|
}
|
|
|
|
/**
|
|
* The Server is based on the web framework Scoutcamp. It creates
|
|
* an http server, sets up helpers for token persistence and monitoring.
|
|
* Then it loads all the services, injecting dependencies as it
|
|
* asks each one to register its route with Scoutcamp.
|
|
*/
|
|
class Server {
|
|
/**
|
|
* Badge Server Constructor
|
|
*
|
|
* @param {object} config Configuration object read from config yaml files
|
|
* by https://www.npmjs.com/package/config and validated against
|
|
* publicConfigSchema and privateConfigSchema
|
|
* @see https://github.com/badges/shields/blob/master/doc/production-hosting.md#configuration
|
|
* @see https://github.com/badges/shields/blob/master/doc/server-secrets.md
|
|
*/
|
|
constructor(config) {
|
|
const publicConfig = Joi.attempt(config.public, publicConfigSchema)
|
|
const privateConfig = this.validatePrivateConfig(
|
|
config.private,
|
|
privateConfigSchema,
|
|
)
|
|
// We want to require an username and a password for the influx metrics
|
|
// only if the influx metrics are enabled. The private config schema
|
|
// and the public config schema are two separate schemas so we have to run
|
|
// validation manually.
|
|
if (publicConfig.metrics.influx && publicConfig.metrics.influx.enabled) {
|
|
this.validatePrivateConfig(
|
|
config.private,
|
|
privateMetricsInfluxConfigSchema,
|
|
)
|
|
}
|
|
this.config = {
|
|
public: publicConfig,
|
|
private: privateConfig,
|
|
}
|
|
|
|
this.githubConstellation = new GithubConstellation({
|
|
service: publicConfig.services.github,
|
|
private: privateConfig,
|
|
})
|
|
|
|
this.librariesioConstellation = new LibrariesIoConstellation({
|
|
private: privateConfig,
|
|
})
|
|
|
|
if (publicConfig.metrics.prometheus.enabled) {
|
|
this.metricInstance = new PrometheusMetrics()
|
|
if (publicConfig.metrics.influx.enabled) {
|
|
this.influxMetrics = new InfluxMetrics(
|
|
this.metricInstance,
|
|
Object.assign({}, publicConfig.metrics.influx, {
|
|
username: privateConfig.influx_username,
|
|
password: privateConfig.influx_password,
|
|
}),
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
validatePrivateConfig(privateConfig, privateConfigSchema) {
|
|
try {
|
|
return Joi.attempt(privateConfig, privateConfigSchema)
|
|
} catch (e) {
|
|
const badPaths = e.details.map(({ path }) => path)
|
|
throw Error(
|
|
`Private configuration is invalid. Check these paths: ${badPaths.join(
|
|
',',
|
|
)}`,
|
|
)
|
|
}
|
|
}
|
|
|
|
get port() {
|
|
const {
|
|
port,
|
|
ssl: { isSecure },
|
|
} = this.config.public
|
|
return port || (isSecure ? 443 : 80)
|
|
}
|
|
|
|
get baseUrl() {
|
|
const {
|
|
bind: { address, port },
|
|
ssl: { isSecure },
|
|
} = this.config.public
|
|
|
|
return url.format({
|
|
protocol: isSecure ? 'https' : 'http',
|
|
hostname: address,
|
|
port,
|
|
pathname: '/',
|
|
})
|
|
}
|
|
|
|
// See https://www.viget.com/articles/heroku-cloudflare-the-right-way/
|
|
requireCloudflare() {
|
|
// Set `req.ip`, which is expected by `cloudflareMiddleware()`. This is set
|
|
// by Express but not Scoutcamp.
|
|
addHandlerAtIndex(this.camp, 0, function (req, res, next) {
|
|
if (isOnHeroku()) {
|
|
// On Heroku, `req.socket.remoteAddress` is the Heroku router. However,
|
|
// the router ensures that the last item in the `X-Forwarded-For` header
|
|
// is the real origin.
|
|
// https://stackoverflow.com/a/18517550/893113
|
|
req.ip = req.headers['x-forwarded-for'].split(', ').pop()
|
|
} else if (isOnFly()) {
|
|
// On Fly we can use the Fly-Client-IP header
|
|
// https://fly.io/docs/reference/runtime-environment/#request-headers
|
|
req.ip = req.headers['fly-client-ip']
|
|
? req.headers['fly-client-ip']
|
|
: req.socket.remoteAddress
|
|
} else {
|
|
req.ip = req.socket.remoteAddress
|
|
}
|
|
next()
|
|
})
|
|
addHandlerAtIndex(this.camp, 1, cloudflareMiddleware())
|
|
}
|
|
|
|
/**
|
|
* Set up Scoutcamp routes for 404/not found responses
|
|
*/
|
|
registerErrorHandlers() {
|
|
const { camp, config } = this
|
|
const {
|
|
public: { rasterUrl },
|
|
} = config
|
|
|
|
camp.route(/\.(gif|jpg)$/, (query, match, end, request) => {
|
|
const [, format] = match
|
|
makeSend(
|
|
'svg',
|
|
request.res,
|
|
end,
|
|
)(
|
|
makeBadge({
|
|
label: '410',
|
|
message: `${format} no longer available`,
|
|
color: 'lightgray',
|
|
format: 'svg',
|
|
}),
|
|
)
|
|
})
|
|
|
|
if (!rasterUrl) {
|
|
camp.route(
|
|
/^\/((?!img|assets\/)).*\.png$/,
|
|
(query, match, end, request) => {
|
|
makeSend(
|
|
'svg',
|
|
request.res,
|
|
end,
|
|
)(
|
|
makeBadge({
|
|
label: '404',
|
|
message: 'raster badges not available',
|
|
color: 'lightgray',
|
|
format: 'svg',
|
|
}),
|
|
)
|
|
},
|
|
)
|
|
}
|
|
|
|
camp.notfound(/(\.svg|\.json|)$/, (query, match, end, request) => {
|
|
const [, extension] = match
|
|
const format = (extension || '.svg').replace(/^\./, '')
|
|
|
|
makeSend(
|
|
format,
|
|
request.res,
|
|
end,
|
|
)(
|
|
makeBadge({
|
|
label: '404',
|
|
message: 'badge not found',
|
|
color: 'red',
|
|
format,
|
|
}),
|
|
)
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Set up a couple of redirects:
|
|
* One for the raster badges.
|
|
* Another to redirect the base URL /
|
|
* (we use this to redirect {@link https://img.shields.io/}
|
|
* to {@link https://shields.io/} )
|
|
*/
|
|
registerRedirects() {
|
|
const { config, camp } = this
|
|
const {
|
|
public: { rasterUrl, redirectUrl },
|
|
} = config
|
|
|
|
if (rasterUrl) {
|
|
// Redirect to the raster server for raster versions of modern badges.
|
|
camp.route(
|
|
/^\/((?!img|assets\/)).*\.png$/,
|
|
(queryParams, match, end, ask) => {
|
|
ask.res.statusCode = 301
|
|
ask.res.setHeader(
|
|
'Location',
|
|
rasterRedirectUrl({ rasterUrl }, ask.req.url),
|
|
)
|
|
|
|
const cacheDuration = (30 * 24 * 3600) | 0 // 30 days.
|
|
ask.res.setHeader('Cache-Control', `max-age=${cacheDuration}`)
|
|
|
|
ask.res.end()
|
|
},
|
|
)
|
|
}
|
|
|
|
if (redirectUrl) {
|
|
camp.route(/^\/$/, (data, match, end, ask) => {
|
|
ask.res.statusCode = 302
|
|
ask.res.setHeader('Location', redirectUrl)
|
|
ask.res.end()
|
|
})
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Iterate all the service classes defined in /services,
|
|
* load each service and register a Scoutcamp route for each service.
|
|
*/
|
|
async registerServices() {
|
|
const { config, camp, metricInstance } = this
|
|
const { apiProvider: githubApiProvider } = this.githubConstellation
|
|
const { apiProvider: librariesIoApiProvider } =
|
|
this.librariesioConstellation
|
|
;(await loadServiceClasses()).forEach(serviceClass =>
|
|
serviceClass.register(
|
|
{
|
|
camp,
|
|
handleRequest,
|
|
githubApiProvider,
|
|
librariesIoApiProvider,
|
|
metricInstance,
|
|
},
|
|
{
|
|
handleInternalErrors: config.public.handleInternalErrors,
|
|
cacheHeaders: config.public.cacheHeaders,
|
|
rasterUrl: config.public.rasterUrl,
|
|
private: config.private,
|
|
public: config.public,
|
|
},
|
|
),
|
|
)
|
|
}
|
|
|
|
bootstrapAgent() {
|
|
/*
|
|
Bootstrap global agent.
|
|
This allows self-hosting users to configure a proxy with
|
|
HTTP_PROXY, HTTPS_PROXY, NO_PROXY variables
|
|
*/
|
|
if (!('GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE' in process.env)) {
|
|
process.env.GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE = ''
|
|
}
|
|
|
|
const proxyPrefix = process.env.GLOBAL_AGENT_ENVIRONMENT_VARIABLE_NAMESPACE
|
|
const HTTP_PROXY = process.env[`${proxyPrefix}HTTP_PROXY`] || null
|
|
const HTTPS_PROXY = process.env[`${proxyPrefix}HTTPS_PROXY`] || null
|
|
|
|
if (HTTP_PROXY || HTTPS_PROXY) {
|
|
bootstrap()
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Start the HTTP server:
|
|
* Bootstrap Scoutcamp,
|
|
* Register handlers,
|
|
* Start listening for requests on this.baseUrl()
|
|
*/
|
|
async start() {
|
|
const {
|
|
bind: { port, address: hostname },
|
|
ssl: { isSecure: secure, cert, key },
|
|
requireCloudflare,
|
|
} = this.config.public
|
|
|
|
this.bootstrapAgent()
|
|
|
|
log.log(`Server is starting up: ${this.baseUrl}`)
|
|
|
|
const camp = (this.camp = Camp.create({
|
|
documentRoot: this.config.public.documentRoot,
|
|
port,
|
|
hostname,
|
|
secure,
|
|
staticMaxAge: 300,
|
|
cert,
|
|
key,
|
|
}))
|
|
|
|
if (requireCloudflare) {
|
|
this.requireCloudflare()
|
|
}
|
|
|
|
const { githubConstellation, metricInstance } = this
|
|
await githubConstellation.initialize(camp)
|
|
if (metricInstance) {
|
|
if (this.config.public.metrics.prometheus.endpointEnabled) {
|
|
metricInstance.registerMetricsEndpoint(camp)
|
|
}
|
|
if (this.influxMetrics) {
|
|
this.influxMetrics.startPushingMetrics()
|
|
}
|
|
}
|
|
|
|
camp.handle((req, res, next) => {
|
|
// https://github.com/badges/shields/issues/3273
|
|
res.setHeader('Access-Control-Allow-Origin', '*')
|
|
// https://github.com/badges/shields/issues/10419
|
|
res.setHeader('Cross-Origin-Resource-Policy', 'cross-origin')
|
|
|
|
next()
|
|
})
|
|
|
|
this.registerErrorHandlers()
|
|
this.registerRedirects()
|
|
await this.registerServices()
|
|
|
|
camp.timeout = this.config.public.requestTimeoutSeconds * 1000
|
|
if (this.config.public.requestTimeoutSeconds > 0) {
|
|
camp.on('timeout', socket => {
|
|
const maxAge = this.config.public.requestTimeoutMaxAgeSeconds
|
|
socket.write('HTTP/1.1 408 Request Timeout\r\n')
|
|
socket.write('Content-Type: text/html; charset=UTF-8\r\n')
|
|
socket.write('Content-Encoding: UTF-8\r\n')
|
|
socket.write(`Cache-Control: max-age=${maxAge}, s-maxage=${maxAge}\r\n`)
|
|
socket.write('Connection: close\r\n\r\n')
|
|
socket.write('Request Timeout')
|
|
socket.end()
|
|
})
|
|
}
|
|
camp.listenAsConfigured()
|
|
|
|
await new Promise(resolve => camp.on('listening', () => resolve()))
|
|
}
|
|
|
|
static resetGlobalState() {
|
|
// This state should be migrated to instance state. When possible, do not add new
|
|
// global state.
|
|
clearResourceCache()
|
|
}
|
|
|
|
reset() {
|
|
this.constructor.resetGlobalState()
|
|
}
|
|
|
|
/**
|
|
* Stop the HTTP server and clean up helpers
|
|
*/
|
|
async stop() {
|
|
if (this.camp) {
|
|
await new Promise(resolve => this.camp.close(resolve))
|
|
this.camp = undefined
|
|
}
|
|
|
|
if (this.cleanupMonitor) {
|
|
this.cleanupMonitor()
|
|
this.cleanupMonitor = undefined
|
|
}
|
|
|
|
if (this.githubConstellation) {
|
|
await this.githubConstellation.stop()
|
|
this.githubConstellation = undefined
|
|
}
|
|
|
|
if (this.metricInstance) {
|
|
if (this.influxMetrics) {
|
|
this.influxMetrics.stopPushingMetrics()
|
|
}
|
|
this.metricInstance.stop()
|
|
}
|
|
}
|
|
}
|
|
|
|
export default Server
|