-
Notifications
You must be signed in to change notification settings - Fork 13
/
errors.ts
478 lines (396 loc) · 12.7 KB
/
errors.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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
import { Logger } from './logger-interface';
import STATUS_CODES from './status-codes';
import { AnyObject } from './interfaces';
import { getFirst } from './arrays';
import { isFunction } from './functions';
import { getTypeOf, isPlainObject } from './deps';
import { tryParseJSON } from './json';
import * as s from './strings';
/**
* A custom Error class with additional properties,
* like statusCode and fatalError
*/
export class TSError extends Error {
/**
* An descriptive error code that specifies the error type, this follows more
* node convention
*/
code: string;
/**
* A HTTP status code for easy use
*/
statusCode: number;
/**
* Used to indicate the an error is fatal
*/
fatalError: boolean;
/**
* Used sometimes to indicate whether an error is retryable
*
* If this is not set then it is better not to assume either way
*/
retryable?: boolean;
/**
* Additional context metadata
*/
context: TSErrorContext;
static [Symbol.hasInstance](_instance: unknown): boolean {
if (_instance == null || typeof _instance !== 'object') return false;
const instance = _instance as Record<string, unknown>;
if (instance.message == null || instance.stack == null) return false;
if (instance.statusCode == null) return false;
if (typeof instance.getCause !== 'function') return false;
return true;
}
constructor(input: unknown, config: TSErrorConfig = {}) {
const { fatalError = false } = config;
const {
message, statusCode, context, code
} = parseErrorInfo(input, config);
super(message);
this.fatalError = fatalError;
this.statusCode = statusCode;
this.context = context;
this.code = code;
if (isTSError(input)) {
this.fatalError = !!input.fatalError;
this.retryable = input.retryable;
}
if (!this.fatalError && config.retryable != null) {
this.retryable = config.retryable;
}
Object.defineProperty(this, 'name', {
value: this.constructor.name,
});
if (Error?.captureStackTrace) {
Error.captureStackTrace(this, TSError);
} else {
const value = Error(message).stack;
if (value) {
Object.defineProperty(this, 'stack', {
value,
writable: true,
configurable: true
});
}
}
}
getCause(): any {
return this.context._cause;
}
}
export interface TSErrorConfig {
/**
* An descriptive error code that specifies the error type, this follows more
* node convention
*/
code?: string;
/**
* A HTTP status code for easy use
*/
statusCode?: number;
/**
* Used to indicate the an error is fatal
*/
fatalError?: boolean;
/**
* Used sometimes to indicate whether an error is retryable
*/
retryable?: boolean;
/**
* Prefix the error message with a reason
*/
reason?: string;
/**
* Override the message when given an error
*/
message?: string;
/**
* Attach any context metadata to the error
*/
context?: AnyObject;
defaultStatusCode?: number;
defaultErrorMsg?: string;
}
export interface TSErrorContext extends AnyObject {
/** ISO Date string */
_createdAt: string;
_cause: any;
/**
* Used to indicate the error message is safe to log and send to the user
*/
safe?: boolean;
}
type ErrorInfo = {
message: string;
stack?: string;
context: TSErrorContext;
statusCode: number;
code: string;
};
const DEFAULT_STATUS_CODE = 500;
const DEFAULT_ERR_MSG = STATUS_CODES[DEFAULT_STATUS_CODE] as string;
/**
* Use following the chain of caused by stack of an error.
* Don't use this when logging the error, only when sending it
* */
export function getFullErrorStack(err: unknown): string {
return `${parseError(err, true)}${getCauseStack(err)}`;
}
function getCauseStack(err: any) {
if (!err || !isFunction(err.getCause)) return '';
const cause = err.getCause();
if (!cause) return '';
return `\nCaused by: ${getFullErrorStack(cause)}`;
}
/** parse error for info */
export function parseErrorInfo(input: unknown, config: TSErrorConfig = {}): ErrorInfo {
const { defaultErrorMsg, defaultStatusCode = DEFAULT_STATUS_CODE } = config;
const statusCode = getErrorStatusCode(input, config, defaultStatusCode);
if (isElasticsearchError(input)) {
const esErrorInfo = _parseESErrorInfo(input);
if (esErrorInfo) {
const updatedContext = Object.assign({}, esErrorInfo.context, config.context);
return {
message: config.message
|| prefixErrorMsg(
esErrorInfo.message,
config.reason,
defaultErrorMsg
),
context: createErrorContext(input, { ...config, context: updatedContext }),
statusCode,
code: esErrorInfo.code,
};
}
}
const context = createErrorContext(input, config);
let stack: string | undefined;
const message = config.message || prefixErrorMsg(input, config.reason, defaultErrorMsg);
if (input && (input as any).stack) {
stack = (input as any).stack;
}
let code: string;
if (config.code && s.isString(config.code)) {
code = toStatusErrorCode(config.code);
} else if (input && (input as any).code && s.isString((input as any).code)) {
code = toStatusErrorCode((input as any).code);
} else {
const httpMsg = STATUS_CODES[statusCode] as string;
code = toStatusErrorCode(httpMsg);
}
return {
stack,
message,
context,
statusCode,
code,
};
}
/**
* Safely log an error (with the error first Logger syntax)
*/
export function logError(logger: Logger, err: unknown, ...messages: any[]): void {
if (typeof err === 'string') {
logger.error(new TSError(err), ...messages);
return;
}
if (isError(err)) {
logger.error(err, ...messages);
return;
}
// make sure we don't lose the stack
logger.error(new TSError(err), ...messages, `invalid message format ${getTypeOf(err)} error`);
}
function createErrorContext(input: any, config: TSErrorConfig = {}) {
const context = Object.assign({}, input && input.context, config && config.context);
Object.defineProperties(context, {
_createdAt: {
value: new Date().toISOString(),
enumerable: false,
},
_cause: {
value: input,
enumerable: false,
},
});
// don't propogate safe
if (context.safe && !(config.context && config.context.safe)) {
context.safe = false;
}
return context;
}
/** parse input to get error message or stack */
export function parseError(input: unknown, withStack = false): string {
const result = parseErrorInfo(input);
if (withStack && result.stack) return result.stack;
return result.message;
}
function _cleanErrorMsg(input: string): string {
return s.truncate(input.trim(), 3000);
}
function _parseESErrorInfo(
input: ElasticsearchError
): { message: string; context: Record<string, any>; code: string } | null {
const bodyError = input && input.body && input.body.error;
const name = (input && input.name) || 'ElasticSearchError';
const rootCause = bodyError && bodyError.root_cause && getFirst(bodyError.root_cause);
let type: string | undefined;
let reason: string | undefined;
let index: string | undefined;
[input, bodyError, rootCause].forEach((obj) => {
if (obj == null) return;
if (!isPlainObject(obj)) return;
if (obj.type) type = obj.type;
if (obj.reason) reason = obj.reason;
if (obj.index) index = obj.index;
});
const metadata = input.toJSON();
if (metadata.response) {
const response = tryParseJSON(metadata.response);
metadata.response = response;
} else if (input.body) {
metadata.response = input.body as any;
}
if (!index && metadata.response) {
index = (metadata.response as any).index || (metadata.response as any)._index;
}
const message = `Elasticsearch Error: ${_normalizeESError(metadata.msg)}`;
const code = toStatusErrorCode(reason ? `${name} ${reason}` : name);
return {
message,
context: {
metadata,
type,
reason,
index,
},
code,
};
}
export function toStatusErrorCode(input: string | undefined): string {
if (!s.isString(input)) return 'UNKNOWN_ERROR';
return input
.trim()
.toUpperCase()
.replace(/\W+/g, '_');
}
function _normalizeESError(message?: string) {
if (!message) return '';
const msg = message.toLowerCase();
if (msg.includes('document missing')) {
return 'Not Found';
}
if (msg.includes('document already exists')) {
return 'Document Already Exists (version conflict)';
}
if (msg.includes('version conflict')) {
return 'Document Out-of-Date (version conflict)';
}
if (msg.indexOf('unknown error') === 0) {
return 'Unknown Elasticsearch Error, Cluster may be Unavailable';
}
return message;
}
export function prefixErrorMsg(
input: unknown, prefix?: string, defaultMsg = 'Unknown Error'
): string {
if (!prefix) {
if (isError(input)) {
return _cleanErrorMsg(input.message || defaultMsg);
}
return _cleanErrorMsg(s.toString(input) || defaultMsg);
}
return _cleanErrorMsg(`${prefix}, caused by ${s.toString(input || defaultMsg)}`);
}
export function isFatalError(err: unknown): boolean {
return !!(err && (err as any).fatalError);
}
export function isRetryableError(err: unknown): boolean {
return !!(err && (err as any).retryable === true && !(err as any).fatalError);
}
/** Check if an input has an error compatible api */
export function isError(err: unknown): err is Error {
return err && (err as any).stack && (err as any).message;
}
/** Check is a TSError */
export function isTSError(err: unknown): err is TSError {
if (err instanceof TSError) return true;
if (!isError(err)) return false;
return (err as any).statusCode != null;
}
/** Check is a elasticsearch error */
export function isElasticsearchError(err: unknown): err is ElasticsearchError {
return !!(err && isFunction((err as any).toJSON));
}
export interface ElasticsearchError extends Error {
body?: {
error?: {
type?: string;
reason?: string;
index?: string;
root_cause?: [
{
type?: string;
reason?: string;
index?: string;
}
];
};
};
status?: number;
type?: string;
reason?: string;
index?: string;
toJSON(): {
msg?: string;
statusCode?: number;
response?: string;
};
}
function coerceStatusCode(input: any): number | null {
return STATUS_CODES[input] != null ? input : null;
}
export function getErrorStatusCode(
err: unknown,
config: TSErrorConfig = {},
defaultCode = DEFAULT_STATUS_CODE
): number {
const metadata = isElasticsearchError(err) ? err.toJSON() : {};
for (const key of ['statusCode', 'status', 'code']) {
for (const obj of [config, err, metadata]) {
if (!obj || s.isString(obj)) continue;
const statusCode = coerceStatusCode((obj as any)[key]);
if (statusCode != null) {
return statusCode;
}
}
}
return defaultCode;
}
export function stripErrorMessage(
error: unknown,
reason: string = DEFAULT_ERR_MSG,
requireSafe = false
): string {
const { message, context, statusCode } = parseErrorInfo(error, {
defaultErrorMsg: reason,
context: error && (error as any).context,
});
const messages = s.parseList(message.split('caused by'));
const firstErr = getFirst(messages);
if (!firstErr) return reason;
const msg = firstErr
.replace(/^\s*,\s*/, '')
.replace(/\s*,\s*$/, '')
.replace(/TSError/g, 'Error')
.trim();
if (requireSafe) {
if (context && context.safe) return msg;
if (statusCode === 403) return 'Access Denied';
if (statusCode === 404) return 'Not Found';
return reason;
}
if (firstErr.includes(reason)) return msg;
return `${reason}: ${msg}`;
}