renovate/lib/modules/platform/index.ts

93 lines
2.9 KiB
TypeScript

import URL from 'node:url';
import type { AllConfig } from '../../config/types';
import type { PlatformId } from '../../constants';
import { PLATFORM_NOT_FOUND } from '../../constants/error-messages';
import { logger } from '../../logger';
import type { HostRule } from '../../types';
import { setGitAuthor, setNoVerify, setPrivateKey } from '../../util/git';
import * as hostRules from '../../util/host-rules';
import platforms from './api';
import { setPlatformScmApi } from './scm';
import type { Platform } from './types';
export * from './types';
export const getPlatformList = (): string[] => Array.from(platforms.keys());
export const getPlatforms = (): Map<string, Platform> => platforms;
let _platform: Platform | undefined;
const handler: ProxyHandler<Platform> = {
get(_target: Platform, prop: keyof Platform) {
if (!_platform) {
throw new Error(PLATFORM_NOT_FOUND);
}
return _platform[prop];
},
};
export const platform = new Proxy<Platform>({} as any, handler);
export function setPlatformApi(name: PlatformId): void {
if (!platforms.has(name)) {
throw new Error(
`Init: Platform "${name}" not found. Must be one of: ${getPlatformList().join(
', ',
)}`,
);
}
_platform = platforms.get(name);
setPlatformScmApi(name);
}
export async function initPlatform(config: AllConfig): Promise<AllConfig> {
setPrivateKey(config.gitPrivateKey);
setNoVerify(config.gitNoVerify ?? []);
// TODO: `platform` (#22198)
setPlatformApi(config.platform!);
// TODO: types
const platformInfo = await platform.initPlatform(config);
const returnConfig: any = {
...config,
...platformInfo,
hostRules: [
...(platformInfo?.hostRules ?? []),
...(config.hostRules ?? []),
],
};
// istanbul ignore else
if (config?.gitAuthor) {
logger.debug(`Using configured gitAuthor (${config.gitAuthor})`);
returnConfig.gitAuthor = config.gitAuthor;
} else if (platformInfo?.gitAuthor) {
logger.debug(`Using platform gitAuthor: ${String(platformInfo.gitAuthor)}`);
returnConfig.gitAuthor = platformInfo.gitAuthor;
}
// This is done for validation and will be overridden later once repo config is incorporated
setGitAuthor(returnConfig.gitAuthor);
const platformRule: HostRule = {
// TODO: null check (#22198)
matchHost: URL.parse(returnConfig.endpoint).hostname!,
};
// There might have been platform-specific modifications to the token
if (returnConfig.token) {
config.token = returnConfig.token;
}
(
['token', 'username', 'password'] as ('token' | 'username' | 'password')[]
).forEach((field) => {
if (config[field]) {
// TODO: types #22198
platformRule[field] = config[field] as string;
delete returnConfig[field];
}
});
const typedPlatformRule = {
...platformRule,
hostType: returnConfig.platform,
};
returnConfig.hostRules.push(typedPlatformRule);
hostRules.add(typedPlatformRule);
return returnConfig;
}