-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
merge.ts
320 lines (309 loc) · 10.7 KB
/
merge.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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
import is from '@sindresorhus/is';
import jsonValidator from 'json-dup-key-validator';
import JSON5 from 'json5';
import upath from 'upath';
import { mergeChildConfig } from '../../../config';
import { configFileNames } from '../../../config/app-strings';
import { decryptConfig } from '../../../config/decrypt';
import { migrateAndValidate } from '../../../config/migrate-validate';
import { migrateConfig } from '../../../config/migration';
import * as presets from '../../../config/presets';
import { applySecretsToConfig } from '../../../config/secrets';
import type { RenovateConfig } from '../../../config/types';
import {
CONFIG_VALIDATION,
REPOSITORY_CHANGED,
} from '../../../constants/error-messages';
import { logger } from '../../../logger';
import * as npmApi from '../../../modules/datasource/npm';
import { platform } from '../../../modules/platform';
import { scm } from '../../../modules/platform/scm';
import { ExternalHostError } from '../../../types/errors/external-host-error';
import { getCache } from '../../../util/cache/repository';
import { readLocalFile } from '../../../util/fs';
import * as hostRules from '../../../util/host-rules';
import * as queue from '../../../util/http/queue';
import * as throttle from '../../../util/http/throttle';
import {
getOnboardingConfigFromCache,
getOnboardingFileNameFromCache,
setOnboardingConfigDetails,
} from '../onboarding/branch/onboarding-branch-cache';
import { OnboardingState } from '../onboarding/common';
import type { RepoFileConfig } from './types';
async function detectConfigFile(): Promise<string | null> {
const fileList = await scm.getFileList();
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;
}
export async function detectRepoFileConfig(): Promise<RepoFileConfig> {
const cache = getCache();
let { configFileName } = cache;
if (configFileName) {
let configFileRaw: string | null;
try {
configFileRaw = await platform.getRawFile(configFileName);
} catch (err) {
// istanbul ignore if
if (err instanceof ExternalHostError) {
throw err;
}
configFileRaw = null;
}
if (configFileRaw) {
let configFileParsed = JSON5.parse(configFileRaw);
if (configFileName !== 'package.json') {
return { configFileName, configFileRaw, configFileParsed };
}
configFileParsed = configFileParsed.renovate;
return { configFileName, configFileParsed }; // don't return raw 'package.json'
} else {
logger.debug('Existing config file no longer exists');
delete cache.configFileName;
}
}
if (OnboardingState.onboardingCacheValid) {
configFileName = getOnboardingFileNameFromCache();
} else {
configFileName = (await detectConfigFile()) ?? undefined;
}
if (!configFileName) {
logger.debug('No renovate config file found');
return {};
}
cache.configFileName = configFileName;
logger.debug(`Found ${configFileName} config file`);
// TODO #22198
let configFileParsed: any;
let configFileRaw: string | undefined | null;
if (OnboardingState.onboardingCacheValid) {
const cachedConfig = getOnboardingConfigFromCache();
const parsedConfig = cachedConfig ? JSON.parse(cachedConfig) : undefined;
if (parsedConfig) {
setOnboardingConfigDetails(configFileName, JSON.stringify(parsedConfig));
return { configFileName, configFileRaw, configFileParsed: parsedConfig };
}
}
if (configFileName === 'package.json') {
// We already know it parses
configFileParsed = JSON.parse(
// TODO #22198
(await readLocalFile('package.json', 'utf8'))!
).renovate;
if (is.string(configFileParsed)) {
logger.debug('Massaging string renovate config to extends array');
configFileParsed = { extends: [configFileParsed] };
}
logger.debug({ config: configFileParsed }, 'package.json>renovate config');
} else {
configFileRaw = await readLocalFile(configFileName, 'utf8');
// istanbul ignore if
if (!is.string(configFileRaw)) {
logger.warn({ configFileName }, 'Null contents when reading config file');
throw new Error(REPOSITORY_CHANGED);
}
// istanbul ignore if
if (!configFileRaw.length) {
configFileRaw = '{}';
}
const fileType = upath.extname(configFileName);
if (fileType === '.json5') {
try {
configFileParsed = JSON5.parse(configFileRaw);
} catch (err) /* istanbul ignore next */ {
logger.debug(
{ renovateConfig: configFileRaw },
'Error parsing renovate config renovate.json5'
);
const validationError = 'Invalid JSON5 (parsing failed)';
const validationMessage = `JSON5.parse error: \`${err.message.replaceAll(
'`',
"'"
)}\``;
return {
configFileName,
configFileParseError: { validationError, validationMessage },
};
}
} else {
let allowDuplicateKeys = true;
let jsonValidationError = jsonValidator.validate(
configFileRaw,
allowDuplicateKeys
);
if (jsonValidationError) {
const validationError = 'Invalid JSON (parsing failed)';
const validationMessage = jsonValidationError;
return {
configFileName,
configFileParseError: { validationError, validationMessage },
};
}
allowDuplicateKeys = false;
jsonValidationError = jsonValidator.validate(
configFileRaw,
allowDuplicateKeys
);
if (jsonValidationError) {
const validationError = 'Duplicate keys in JSON';
const validationMessage = JSON.stringify(jsonValidationError);
return {
configFileName,
configFileParseError: { validationError, validationMessage },
};
}
try {
configFileParsed = JSON5.parse(configFileRaw);
} catch (err) /* istanbul ignore next */ {
logger.debug(
{ renovateConfig: configFileRaw },
'Error parsing renovate config'
);
const validationError = 'Invalid JSON (parsing failed)';
const validationMessage = `JSON.parse error: \`${err.message.replaceAll(
'`',
"'"
)}\``;
return {
configFileName,
configFileParseError: { validationError, validationMessage },
};
}
}
logger.debug(
{ fileName: configFileName, config: configFileParsed },
'Repository config'
);
}
setOnboardingConfigDetails(configFileName, JSON.stringify(configFileParsed));
return { configFileName, configFileRaw, configFileParsed };
}
export function checkForRepoConfigError(repoConfig: RepoFileConfig): void {
if (!repoConfig.configFileParseError) {
return;
}
const error = new Error(CONFIG_VALIDATION);
error.validationSource = repoConfig.configFileName;
error.validationError = repoConfig.configFileParseError.validationError;
error.validationMessage = repoConfig.configFileParseError.validationMessage;
throw error;
}
// Check for repository config
export async function mergeRenovateConfig(
config: RenovateConfig
): Promise<RenovateConfig> {
let returnConfig = { ...config };
let repoConfig: RepoFileConfig = {};
if (config.requireConfig !== 'ignored') {
repoConfig = await detectRepoFileConfig();
}
const configFileParsed = repoConfig?.configFileParsed || {};
if (is.nonEmptyArray(returnConfig.extends)) {
configFileParsed.extends = [
...returnConfig.extends,
...(configFileParsed.extends || []),
];
delete returnConfig.extends;
}
checkForRepoConfigError(repoConfig);
const migratedConfig = await migrateAndValidate(config, configFileParsed);
if (migratedConfig.errors?.length) {
const error = new Error(CONFIG_VALIDATION);
error.validationSource = repoConfig.configFileName;
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 ?? []),
...migratedConfig.warnings,
];
}
delete migratedConfig.errors;
delete migratedConfig.warnings;
// TODO #22198
const repository = config.repository!;
// Decrypt before resolving in case we need npm authentication for any presets
const decryptedConfig = await decryptConfig(migratedConfig, repository);
// istanbul ignore if
if (is.string(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
let resolvedConfig = await decryptConfig(
await presets.resolveConfigPresets(
decryptedConfig,
config,
config.ignorePresets
),
repository
);
logger.trace({ config: resolvedConfig }, 'resolved config');
const migrationResult = migrateConfig(resolvedConfig);
if (migrationResult.isMigrated) {
logger.debug('Resolved config needs migrating');
logger.trace({ config: resolvedConfig }, 'resolved config after migrating');
resolvedConfig = migrationResult.migratedConfig;
}
// istanbul ignore if
if (is.string(resolvedConfig.npmrc)) {
logger.debug(
'Ignoring any .npmrc files in repository due to configured npmrc'
);
npmApi.setNpmrc(resolvedConfig.npmrc);
}
resolvedConfig = applySecretsToConfig(
resolvedConfig,
mergeChildConfig(config.secrets ?? {}, resolvedConfig.secrets ?? {})
);
// 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'
);
}
}
// host rules can change concurrency
queue.clear();
throttle.clear();
delete resolvedConfig.hostRules;
}
returnConfig = mergeChildConfig(returnConfig, resolvedConfig);
returnConfig = await presets.resolveConfigPresets(returnConfig, config);
returnConfig.renovateJsonPresent = true;
// istanbul ignore if
if (returnConfig.ignorePaths?.length) {
logger.debug(
{ ignorePaths: returnConfig.ignorePaths },
`Found repo ignorePaths`
);
}
return returnConfig;
}