renovate/lib/util/http/host-rules.ts
2021-10-06 07:43:32 +02:00

95 lines
2.5 KiB
TypeScript

import {
GITHUB_API_USING_HOST_TYPES,
GITLAB_API_USING_HOST_TYPES,
PlatformId,
} from '../../constants';
import { logger } from '../../logger';
import { hasProxy } from '../../proxy';
import type { HostRule } from '../../types';
import * as hostRules from '../host-rules';
import type { GotOptions } from './types';
function findMatchingRules(options: GotOptions, url: string): HostRule {
const { hostType } = options;
let res = hostRules.find({ hostType, url });
if (res.token || res.username || res.password) {
// do not fallback if we already have auth infos
return res;
}
// Fallback to `github` hostType
if (
GITHUB_API_USING_HOST_TYPES.includes(hostType) &&
hostType !== PlatformId.Github
) {
res = {
...hostRules.find({
hostType: PlatformId.Github,
url,
}),
...res,
};
}
// Fallback to `gitlab` hostType
if (
GITLAB_API_USING_HOST_TYPES.includes(hostType) &&
hostType !== PlatformId.Gitlab
) {
res = {
...hostRules.find({
hostType: PlatformId.Gitlab,
url,
}),
...res,
};
}
return res;
}
// Apply host rules to requests
export function applyHostRules(url: string, inOptions: GotOptions): GotOptions {
const options: GotOptions = { ...inOptions };
const foundRules = findMatchingRules(options, url);
const { username, password, token, enabled, authType } = foundRules;
if (options.noAuth) {
logger.trace({ url }, `Authorization disabled`);
} else if (
options.headers?.authorization ||
options.password ||
options.token
) {
logger.trace({ url }, `Authorization already set`);
} else if (password !== undefined) {
logger.trace({ url }, `Applying Basic authentication`);
options.username = username;
options.password = password;
} else if (token) {
logger.trace({ url }, `Applying Bearer authentication`);
options.token = token;
options.context = { ...options.context, authType };
} else if (enabled === false) {
options.enabled = false;
}
// Apply optional params
['abortOnError', 'abortIgnoreStatusCodes', 'timeout'].forEach((param) => {
if (foundRules[param]) {
options[param] = foundRules[param];
}
});
if (!hasProxy() && foundRules.enableHttp2 === true) {
options.http2 = true;
}
return options;
}
export function getRequestLimit(url: string): number | null {
const hostRule = hostRules.find({
url,
});
const limit = hostRule.concurrentRequestLimit;
return typeof limit === 'number' && limit > 0 ? limit : null;
}