/
config.ts
191 lines (187 loc) · 6.68 KB
/
config.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
import path from 'path';
import jsonValidator from 'json-dup-key-validator';
import JSON5 from 'json5';
import { RenovateConfig, mergeChildConfig } from '../../../config';
import { configFileNames } from '../../../config/app-strings';
import { decryptConfig } from '../../../config/decrypt';
import { migrateAndValidate } from '../../../config/migrate-validate';
import * as presets from '../../../config/presets';
import { CONFIG_VALIDATION } from '../../../constants/error-messages';
import * as npmApi from '../../../datasource/npm';
import { logger } from '../../../logger';
import { platform } from '../../../platform';
import { ExternalHostError } from '../../../types/errors/external-host-error';
import { readLocalFile } from '../../../util/fs';
import * as hostRules from '../../../util/host-rules';
import { flattenPackageRules } from './flatten';
// Check for repository config
export async function mergeRenovateConfig(
config: RenovateConfig
): Promise<RenovateConfig> {
let returnConfig = { ...config };
const fileList = await platform.getFileList();
async function detectConfigFile(): Promise<string | null> {
for (const fileName of configFileNames) {
if (fileName === 'package.json') {
try {
const pJson = JSON.parse(await readLocalFile('package.json', 'utf8'));
if (pJson.renovate) {
logger.debug('Using package.json for global renovate config');
return 'package.json';
}
} catch (err) {
// Do nothing
}
} else if (fileList.includes(fileName)) {
return fileName;
}
}
return null;
}
const configFile = await detectConfigFile();
if (!configFile) {
logger.debug('No renovate config file found');
return returnConfig;
}
logger.debug(`Found ${configFile} config file`);
let renovateJson;
if (configFile === 'package.json') {
// We already know it parses
renovateJson = JSON.parse(await readLocalFile('package.json', 'utf8'))
.renovate;
logger.debug({ config: renovateJson }, 'package.json>renovate config');
} else {
let renovateConfig = await readLocalFile(configFile, 'utf8');
// istanbul ignore if
if (renovateConfig === null) {
logger.warn('Fetching renovate config returns null');
throw new ExternalHostError(
Error('Fetching renovate config returns null'),
config.platform
);
}
// istanbul ignore if
if (!renovateConfig.length) {
renovateConfig = '{}';
}
const fileType = path.extname(configFile);
if (fileType === '.json5') {
try {
renovateJson = JSON5.parse(renovateConfig);
} catch (err) /* istanbul ignore next */ {
logger.debug(
{ renovateConfig },
'Error parsing renovate config renovate.json5'
);
const error = new Error(CONFIG_VALIDATION);
error.configFile = configFile;
error.validationError = 'Invalid JSON5 (parsing failed)';
error.validationMessage = 'JSON5.parse error: ' + err.message;
throw error;
}
} else {
let allowDuplicateKeys = true;
let jsonValidationError = jsonValidator.validate(
renovateConfig,
allowDuplicateKeys
);
if (jsonValidationError) {
const error = new Error(CONFIG_VALIDATION);
error.configFile = configFile;
error.validationError = 'Invalid JSON (parsing failed)';
error.validationMessage = jsonValidationError;
throw error;
}
allowDuplicateKeys = false;
jsonValidationError = jsonValidator.validate(
renovateConfig,
allowDuplicateKeys
);
if (jsonValidationError) {
const error = new Error(CONFIG_VALIDATION);
error.configFile = configFile;
error.validationError = 'Duplicate keys in JSON';
error.validationMessage = JSON.stringify(jsonValidationError);
throw error;
}
try {
renovateJson = JSON.parse(renovateConfig);
} catch (err) /* istanbul ignore next */ {
logger.debug({ renovateConfig }, 'Error parsing renovate config');
const error = new Error(CONFIG_VALIDATION);
error.configFile = configFile;
error.validationError = 'Invalid JSON (parsing failed)';
error.validationMessage = 'JSON.parse error: ' + err.message;
throw error;
}
}
logger.debug({ configFile, config: renovateJson }, 'Repository config');
}
const migratedConfig = await migrateAndValidate(config, renovateJson);
if (migratedConfig.errors.length) {
const error = new Error(CONFIG_VALIDATION);
error.configFile = configFile;
error.validationError =
'The renovate configuration file contains some invalid settings';
error.validationMessage = migratedConfig.errors
.map((e) => e.message)
.join(', ');
throw error;
}
if (migratedConfig.warnings) {
returnConfig.warnings = returnConfig.warnings.concat(
migratedConfig.warnings
);
}
delete migratedConfig.errors;
delete migratedConfig.warnings;
logger.debug({ config: migratedConfig }, 'migrated config');
// Decrypt before resolving in case we need npm authentication for any presets
const decryptedConfig = decryptConfig(migratedConfig, config.privateKey);
// istanbul ignore if
if (decryptedConfig.npmrc) {
logger.debug('Found npmrc in decrypted config - setting');
npmApi.setNpmrc(decryptedConfig.npmrc);
}
// Decrypt after resolving in case the preset contains npm authentication instead
const resolvedConfig = decryptConfig(
await presets.resolveConfigPresets(decryptedConfig, config),
config.privateKey
);
delete resolvedConfig.privateKey;
logger.trace({ config: resolvedConfig }, 'resolved config');
// istanbul ignore if
if (resolvedConfig.npmrc) {
logger.debug(
'Ignoring any .npmrc files in repository due to configured npmrc'
);
npmApi.setNpmrc(resolvedConfig.npmrc);
resolvedConfig.ignoreNpmrcFile = true;
}
// istanbul ignore if
if (resolvedConfig.hostRules) {
logger.debug('Setting hostRules from config');
for (const rule of resolvedConfig.hostRules) {
try {
hostRules.add(rule);
} catch (err) {
logger.warn(
{ err, config: rule },
'Error setting hostRule from config'
);
}
}
delete resolvedConfig.hostRules;
}
returnConfig = mergeChildConfig(returnConfig, resolvedConfig);
returnConfig.renovateJsonPresent = true;
returnConfig.packageRules = flattenPackageRules(returnConfig.packageRules);
// istanbul ignore if
if (returnConfig.ignorePaths && returnConfig.ignorePaths.length) {
logger.debug(
{ ignorePaths: returnConfig.ignorePaths },
`Found repo ignorePaths`
);
}
return returnConfig;
}