Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: better manager types #15708

Merged
merged 6 commits into from
May 24, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 10 additions & 6 deletions lib/config/index.ts
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
import { logger } from '../logger';
import { get, getLanguageList, getManagerList } from '../modules/manager';
import * as options from './options';
import type { AllConfig, RenovateConfig, RenovateConfigStage } from './types';
import type {
AllConfig,
ManagerConfig,
RenovateConfig,
RenovateConfigStage,
} from './types';
import { mergeChildConfig } from './utils';

export { mergeChildConfig };

export function getManagerConfig(
config: RenovateConfig,
manager: string
): RenovateConfig {
let managerConfig: RenovateConfig = {
): ManagerConfig {
let managerConfig: ManagerConfig = {
...config,
language: null,
manager: null,
manager,
};
const language = get(manager, 'language');
if (language) {
// TODO: fix types #7154
managerConfig = mergeChildConfig(managerConfig, config[language] as any);
managerConfig.language = language;
}
// TODO: fix types #7154
managerConfig = mergeChildConfig(managerConfig, config[manager] as any);
for (const i of getLanguageList().concat(getManagerList())) {
delete managerConfig[i];
}
managerConfig.language = language;
managerConfig.manager = manager;
return managerConfig;
}

Expand Down
12 changes: 12 additions & 0 deletions lib/config/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { LogLevel } from 'bunyan';
import type { Range } from 'semver';
import type { ExtractConfig } from '../modules/manager/types';
import type { HostRule } from '../types';
import type { GitNoVerifyOption } from '../util/git/types';

Expand Down Expand Up @@ -429,6 +430,17 @@ export interface MigratedRenovateConfig extends RenovateConfig {
gradle?: RenovateConfig;
}

export interface ManagerConfig extends RenovateConfig {
manager: string;
language: string | null;
rarkins marked this conversation as resolved.
Show resolved Hide resolved
}

export interface WorkerExtractConfig extends ExtractConfig {
manager: string;
enabled?: boolean;
fileList: string[];
}

export interface ValidationResult {
errors: ValidationMessage[];
warnings: ValidationMessage[];
Expand Down
12 changes: 9 additions & 3 deletions lib/modules/manager/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,12 @@ describe('modules/manager/index', () => {
defaultConfig: {},
supportedDatasources: [],
});
expect(manager.extractPackageFile('unknown', null)).toBeNull();
expect(manager.extractPackageFile('dummy', null)).toBeNull();
expect(
manager.extractPackageFile('unknown', null, 'filename', {})
).toBeNull();
expect(
manager.extractPackageFile('dummy', null, 'filename', {})
).toBeNull();
});

it('returns non-null', () => {
Expand All @@ -120,7 +124,9 @@ describe('modules/manager/index', () => {
extractPackageFile: () => Promise.resolve({ deps: [] }),
});

expect(manager.extractPackageFile('dummy', null)).not.toBeNull();
expect(
manager.extractPackageFile('dummy', null, 'filename', {})
).not.toBeNull();
});

afterEach(() => {
Expand Down
4 changes: 2 additions & 2 deletions lib/modules/manager/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ export async function extractAllPackageFiles(
export function extractPackageFile(
manager: string,
content: string,
fileName?: string,
config?: ExtractConfig
fileName: string,
config: ExtractConfig
): Result<PackageFile | null> {
if (!managers.has(manager)) {
return null;
Expand Down
2 changes: 0 additions & 2 deletions lib/modules/manager/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,8 @@ export interface ManagerData<T> {
}

export interface ExtractConfig {
constraints?: Record<string, string>;
registryUrls?: string[];
endpoint?: string;
gradle?: { timeout?: number };
aliases?: Record<string, string>;
npmrc?: string;
npmrcMerge?: boolean;
Expand Down
14 changes: 9 additions & 5 deletions lib/workers/repository/extract/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import is from '@sindresorhus/is';
import { getManagerConfig, mergeChildConfig } from '../../../config';
import type { RenovateConfig } from '../../../config/types';
import type {
ManagerConfig,
RenovateConfig,
WorkerExtractConfig,
} from '../../../config/types';
import { logger } from '../../../logger';
import { getManagerList } from '../../../modules/manager';
import type { PackageFile } from '../../../modules/manager/types';
Expand All @@ -18,13 +22,13 @@ export async function extractAllDependencies(
config.enabledManagers.includes(manager)
);
}
const extractList: RenovateConfig[] = [];
const extractList: WorkerExtractConfig[] = [];
const fileList = await getFileList();

const tryConfig = (extractConfig: RenovateConfig): void => {
const matchingFileList = getMatchingFiles(extractConfig, fileList);
const tryConfig = (managerConfig: ManagerConfig): void => {
const matchingFileList = getMatchingFiles(managerConfig, fileList);
if (matchingFileList.length) {
extractList.push({ ...extractConfig, fileList: matchingFileList });
extractList.push({ ...managerConfig, fileList: matchingFileList });
}
};

Expand Down
10 changes: 7 additions & 3 deletions lib/workers/repository/extract/manager-files.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,24 @@ describe('workers/repository/extract/manager-files', () => {
});

it('returns empty of manager is disabled', async () => {
const managerConfig = { manager: 'travis', enabled: false };
const managerConfig = { manager: 'travis', enabled: false, fileList: [] };
const res = await getManagerPackageFiles(managerConfig);
expect(res).toHaveLength(0);
});

it('returns empty of manager is not enabled', async () => {
config.enabledManagers = ['npm'];
const managerConfig = { manager: 'docker', enabled: true };
const managerConfig = { manager: 'docker', enabled: true, fileList: [] };
const res = await getManagerPackageFiles(managerConfig);
expect(res).toHaveLength(0);
});

it('skips files if null content returned', async () => {
const managerConfig = { manager: 'npm', enabled: true };
const managerConfig = {
manager: 'npm',
fileList: [],
enabled: true,
};
fileMatch.getMatchingFiles.mockReturnValue(['package.json']);
const res = await getManagerPackageFiles(managerConfig);
expect(res).toHaveLength(0);
Expand Down
4 changes: 2 additions & 2 deletions lib/workers/repository/extract/manager-files.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import is from '@sindresorhus/is';
import type { RenovateConfig } from '../../../config/types';
import type { WorkerExtractConfig } from '../../../config/types';
import { logger } from '../../../logger';
import {
extractAllPackageFiles,
Expand All @@ -10,7 +10,7 @@ import type { PackageFile } from '../../../modules/manager/types';
import { readLocalFile } from '../../../util/fs';

export async function getManagerPackageFiles(
config: RenovateConfig
config: WorkerExtractConfig
): Promise<PackageFile[]> {
const { enabled, manager, fileList } = config;
logger.trace(`getPackageFiles(${manager})`);
Expand Down
7 changes: 7 additions & 0 deletions lib/workers/repository/onboarding/pr/pr-list.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,10 @@ describe('workers/repository/onboarding/pr/pr-list', () => {
prTitle: 'Lock file maintenance',
schedule: ['before 5am'],
branchName: 'renovate/lock-file-maintenance',
manager: 'some-manager',
upgrades: [
{
manager: 'some-manager',
updateType: 'lockFileMaintenance',
} as never,
],
Expand Down Expand Up @@ -62,15 +64,18 @@ describe('workers/repository/onboarding/pr/pr-list', () => {
prTitle: 'Pin dependencies',
baseBranch: 'some-other',
branchName: 'renovate/pin-dependencies',
manager: 'some-manager',
upgrades: [
{
manager: 'some-manager',
updateType: 'pin',
sourceUrl: 'https://a',
depName: 'a',
depType: 'devDependencies',
newValue: '1.1.0',
},
{
manager: 'some-manager',
updateType: 'pin',
depName: 'b',
newValue: '1.5.3',
Expand All @@ -80,8 +85,10 @@ describe('workers/repository/onboarding/pr/pr-list', () => {
{
prTitle: 'Update a to v2',
branchName: 'renovate/a-2.x',
manager: 'some-manager',
upgrades: [
{
manager: 'some-manager',
sourceUrl: 'https://a',
depName: 'a',
currentValue: '^1.0.0',
Expand Down
5 changes: 4 additions & 1 deletion lib/workers/repository/process/extract-update.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ const branchify = mocked(_branchify);
const repositoryCache = mocked(_repositoryCache);

branchify.branchifyUpgrades.mockResolvedValueOnce({
branches: [{ branchName: 'some-branch', upgrades: [] }],
branches: [
{ manager: 'some-manager', branchName: 'some-branch', upgrades: [] },
],
branchList: ['branchName'],
});

Expand All @@ -37,6 +39,7 @@ describe('workers/repository/process/extract-update', () => {
branches: [
{
branchName: 'some-branch',
manager: 'some-manager',
upgrades: [],
},
],
Expand Down
1 change: 1 addition & 0 deletions lib/workers/repository/update/branch/artifacts.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ describe('workers/repository/update/branch/artifacts', () => {
jest.resetAllMocks();
config = {
...getConfig(),
manager: 'some-manager',
branchName: 'renovate/pin',
upgrades: [],
artifactErrors: [{ lockFile: 'some' }],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ describe('workers/repository/update/branch/execute-post-upgrade-commands', () =>
it('handles an artifact which is a directory', async () => {
const commands: BranchUpgradeConfig[] = [
{
manager: 'some-manager',
branchName: 'main',
postUpgradeTasks: {
executionMode: 'update',
Expand All @@ -20,6 +21,7 @@ describe('workers/repository/update/branch/execute-post-upgrade-commands', () =>
},
];
const config: BranchConfig = {
manager: 'some-manager',
updatedPackageFiles: [],
updatedArtifacts: [
{ type: 'addition', path: 'some-existing-dir', contents: '' },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ export default async function executePostUpgradeCommands(

const branchUpgradeCommands: BranchUpgradeConfig[] = [
{
manager: config.manager,
depName: config.upgrades.map(({ depName }) => depName).join(' '),
branchName: config.branchName,
postUpgradeTasks:
Expand Down
6 changes: 6 additions & 0 deletions lib/workers/repository/update/branch/reuse.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ describe('workers/repository/update/branch/reuse', () => {

beforeEach(() => {
config = {
manager: 'some-manager',
branchName: 'renovate/some-branch',
rebaseLabel: 'rebase',
rebaseWhen: 'behind-base-branch',
Expand Down Expand Up @@ -50,16 +51,19 @@ describe('workers/repository/update/branch/reuse', () => {
it('returns false if does not need rebasing but has upgrades that need lockfile maintenance along with upgrades that do not', async () => {
config.upgrades = [
{
manager: 'some-manager',
packageFile: 'package.json',
rangeStrategy: 'replace',
branchName: 'current',
},
{
manager: 'some-manager',
packageFile: 'package.json',
rangeStrategy: 'update-lockfile',
branchName: 'current',
},
{
manager: 'some-manager',
packageFile: 'package.json',
rangeStrategy: 'in-range-only',
branchName: 'current',
Expand All @@ -75,11 +79,13 @@ describe('workers/repository/update/branch/reuse', () => {
it('returns true if does not need rebasing and lockfile update is on different packages', async () => {
config.upgrades = [
{
manager: 'some-manager',
packageFile: 'package.json',
rangeStrategy: 'replace',
branchName: 'current',
},
{
manager: 'some-manager',
packageFile: 'subpackage/package.json',
rangeStrategy: 'update-lockfile',
branchName: 'current',
Expand Down
6 changes: 6 additions & 0 deletions lib/workers/repository/update/pr/body/changelogs.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ describe('workers/repository/update/pr/body/changelogs', () => {

it('returns empty string when there is no release notes', () => {
const res = getChangelogs({
manager: 'some-manager',
branchName: 'some-branch',
upgrades: [],
hasReleaseNotes: false,
Expand All @@ -33,26 +34,31 @@ describe('workers/repository/update/pr/body/changelogs', () => {

const res = getChangelogs({
branchName: 'some-branch',
manager: 'some-manager',
upgrades: [
{
manager: 'some-manager',
depName: 'dep-1',
repoName: 'some/repo',
branchName: 'some-branch',
hasReleaseNotes: true,
},
{
manager: 'some-manager',
depName: 'dep-2',
repoName: 'some/repo',
branchName: 'some-branch',
hasReleaseNotes: true,
},
{
manager: 'some-manager',
depName: 'dep-3',
repoName: 'some/repo',
branchName: 'some-branch',
hasReleaseNotes: true,
},
{
manager: 'some-manager',
depName: 'dep-4',
repoName: 'other/repo',
branchName: 'some-branch',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const checks = mocked(_checks);
describe('workers/repository/update/pr/body/config-description', () => {
describe('getPrConfigDescription', () => {
const config: BranchConfig = {
manager: 'some-manager',
branchName: 'some-branch',
upgrades: [],
};
Expand Down
15 changes: 13 additions & 2 deletions lib/workers/repository/update/pr/body/footer.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,24 @@ describe('workers/repository/update/pr/body/footer', () => {
});

it('renders empty footer', () => {
expect(getPrFooter({ branchName: 'branch', upgrades: [] })).toBe('');
expect(
getPrFooter({
manager: 'some-manager',
branchName: 'branch',
upgrades: [],
})
).toBe('');
});

it('renders prFooter', () => {
template.compile.mockImplementation((x) => x);
expect(
getPrFooter({ branchName: 'branch', upgrades: [], prFooter: 'FOOTER' })
getPrFooter({
manager: 'some-manager',
branchName: 'branch',
upgrades: [],
prFooter: 'FOOTER',
})
).toMatchInlineSnapshot(`
"
---
Expand Down