/
utils.ts
256 lines (218 loc) · 6.24 KB
/
utils.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
import { Stream } from 'node:stream';
import is from '@sindresorhus/is';
import bunyan from 'bunyan';
import fs from 'fs-extra';
import { RequestError as HttpError } from 'got';
import { redactedFields, sanitize } from '../util/sanitize';
import type { BunyanRecord, BunyanStream } from './types';
const excludeProps = ['pid', 'time', 'v', 'hostname'];
export class ProblemStream extends Stream {
private _problems: BunyanRecord[] = [];
readable: boolean;
writable: boolean;
constructor() {
super();
this.readable = false;
this.writable = true;
}
write(data: BunyanRecord): boolean {
const problem = { ...data };
for (const prop of excludeProps) {
delete problem[prop];
}
this._problems.push(problem);
return true;
}
getProblems(): BunyanRecord[] {
return this._problems;
}
clearProblems(): void {
this._problems = [];
}
}
const contentFields = [
'content',
'contents',
'packageLockParsed',
'yarnLockParsed',
];
export default function prepareError(err: Error): Record<string, unknown> {
const response: Record<string, unknown> = {
...err,
};
// Required as message is non-enumerable
if (!response.message && err.message) {
response.message = err.message;
}
// Required as stack is non-enumerable
if (!response.stack && err.stack) {
response.stack = err.stack;
}
// handle got error
if (err instanceof HttpError) {
const options: Record<string, unknown> = {
headers: structuredClone(err.options.headers),
url: err.options.url?.toString(),
hostType: err.options.context.hostType,
};
response.options = options;
options.username = err.options.username;
options.password = err.options.password;
options.method = err.options.method;
options.http2 = err.options.http2;
// istanbul ignore else
if (err.response) {
response.response = {
statusCode: err.response?.statusCode,
statusMessage: err.response?.statusMessage,
body:
// istanbul ignore if: not easily testable
err.name === 'TimeoutError'
? undefined
: structuredClone(err.response.body),
headers: structuredClone(err.response.headers),
httpVersion: err.response.httpVersion,
retryCount: err.response.retryCount,
};
}
}
return response;
}
type NestedValue = unknown[] | object;
function isNested(value: unknown): value is NestedValue {
return is.array(value) || is.object(value);
}
export function sanitizeValue(
value: unknown,
seen = new WeakMap<NestedValue, unknown>()
): any {
if (is.string(value)) {
return sanitize(sanitizeUrls(value));
}
if (is.date(value)) {
return value;
}
if (is.function_(value)) {
return '[function]';
}
if (is.buffer(value)) {
return '[content]';
}
if (is.error(value)) {
const err = prepareError(value);
return sanitizeValue(err, seen);
}
if (is.array(value)) {
const length = value.length;
const arrayResult = Array(length);
seen.set(value, arrayResult);
for (let idx = 0; idx < length; idx += 1) {
const val = value[idx];
arrayResult[idx] =
isNested(val) && seen.has(val)
? seen.get(val)
: sanitizeValue(val, seen);
}
return arrayResult;
}
if (is.object(value)) {
const objectResult: Record<string, any> = {};
seen.set(value, objectResult);
for (const [key, val] of Object.entries<any>(value)) {
let curValue: any;
if (!val) {
curValue = val;
} else if (redactedFields.includes(key)) {
curValue = '***********';
} else if (contentFields.includes(key)) {
curValue = '[content]';
} else if (key === 'secrets') {
curValue = {};
Object.keys(val).forEach((secretKey) => {
curValue[secretKey] = '***********';
});
} else {
curValue = seen.has(val) ? seen.get(val) : sanitizeValue(val, seen);
}
objectResult[key] = curValue;
}
return objectResult;
}
return value;
}
export function withSanitizer(streamConfig: bunyan.Stream): bunyan.Stream {
if (streamConfig.type === 'rotating-file') {
throw new Error("Rotating files aren't supported");
}
const stream = streamConfig.stream as BunyanStream;
if (stream?.writable) {
const write = (
chunk: BunyanRecord,
enc: BufferEncoding,
cb: (err?: Error | null) => void
): void => {
const raw = sanitizeValue(chunk);
const result =
streamConfig.type === 'raw'
? raw
: JSON.stringify(raw, bunyan.safeCycles()).replace(/\n?$/, '\n'); // TODO #12874
stream.write(result, enc, cb);
};
return {
...streamConfig,
type: 'raw',
stream: { write },
} as bunyan.Stream;
}
if (streamConfig.path) {
const fileStream = fs.createWriteStream(streamConfig.path, {
flags: 'a',
encoding: 'utf8',
});
return withSanitizer({ ...streamConfig, stream: fileStream });
}
throw new Error("Missing 'stream' or 'path' for bunyan stream");
}
/**
* A function that terminates exeution if the log level that was entered is
* not a valid value for the Bunyan logger.
* @param logLevelToCheck
* @returns returns undefined when the logLevelToCheck is valid. Else it stops execution.
*/
export function validateLogLevel(logLevelToCheck: string | undefined): void {
const allowedValues: bunyan.LogLevel[] = [
'trace',
'debug',
'info',
'warn',
'error',
'fatal',
];
if (
is.undefined(logLevelToCheck) ||
(is.string(logLevelToCheck) &&
allowedValues.includes(logLevelToCheck as bunyan.LogLevel))
) {
// log level is in the allowed values or its undefined
return;
}
const logger = bunyan.createLogger({
name: 'renovate',
streams: [
{
level: 'fatal',
stream: process.stdout,
},
],
});
logger.fatal(`${logLevelToCheck} is not a valid log level. terminating...`);
process.exit(1);
}
// Can't use `util/regex` because of circular reference to logger
const urlRe = /[a-z]{3,9}:\/\/[^@/]+@[a-z0-9.-]+/gi;
const urlCredRe = /\/\/[^@]+@/g;
export function sanitizeUrls(text: string): string {
return text.replace(urlRe, (url) => {
return url.replace(urlCredRe, '//**redacted**@');
});
}