-
-
Notifications
You must be signed in to change notification settings - Fork 252
/
error.ts
416 lines (372 loc) · 11.3 KB
/
error.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
import { StatusCodes } from "http-status-codes";
import _ from "lodash";
import { AxiosError } from "axios";
import { ERROR_SEVERITY, ERROR_STATUS } from "./constants";
import { RespV3, RespV3ErrorResp } from "./types";
export type DendronErrorProps<TCode = StatusCodes | undefined> = {
/**
* Arbitrary payload
*/
payload?: any;
/**
* See {@link ERROR_SEVERITY}
*/
severity?: ERROR_SEVERITY;
/**
* Optional HTTP status code for error
*/
code?: TCode;
/**
* @deprecated - should only used in DendronServerError
* Custom status errors
*/
status?: string;
/**
* Inner Error object
*/
innerError?: Error;
} & Error;
type ServerErrorProps = {
/**
* Custom status errors
*/
status?: string;
/**
* Optional HTTP status code for error
*/
code?: StatusCodes;
};
export type IDendronError<TCode = StatusCodes | undefined> =
DendronErrorProps<TCode>;
export class DendronError<TCode = StatusCodes | undefined>
extends Error
implements IDendronError<TCode>
{
public status?: string;
public payload?: string;
public severity?: ERROR_SEVERITY;
public code?: TCode;
public innerError?: Error;
/** The output that may be displayed to a person if they encounter this error. */
public stringifyForHumanReading() {
return this.message;
}
/** Overload this to change how the `payload` is stringified. */
protected payloadStringify() {
return JSON.stringify(this.payload);
}
/** The output that may be saved into the local logs for the user. */
public stringifyForLogs() {
const { severity, code, message } = this;
const payload: { [key: string]: any } = {
severity,
code,
message,
};
if (this.innerError) {
payload.innerError = this.innerError;
}
if (this.payload) {
payload.payload = this.payloadStringify();
}
return JSON.stringify(payload);
}
/** The output that may be sent to Sentry, or other telemetry service.
*
* This function will eventually check that the output is stripped of PII,
* but for now that's the same as these.
*/
public stringifyForTelemetry() {
return this.stringifyForLogs();
}
/** If false, this error does not necessarily mean the operation failed. It should be possible to recover and resume. */
public get isFatal() {
return this.severity === ERROR_SEVERITY.FATAL;
}
static isDendronError(error: any): error is IDendronError {
return error?.message !== undefined;
}
static createPlainError(props: Omit<DendronErrorProps, "name">) {
return error2PlainObject({
...props,
// isComposite: false,
name: "DendronError",
});
}
static createFromStatus({
status,
...rest
}: { status: ERROR_STATUS } & Partial<DendronErrorProps>): DendronError {
return new DendronError({
name: "DendronError",
message: status,
status,
...rest,
});
}
constructor({
message,
status,
payload,
severity,
code,
innerError,
}: Omit<DendronErrorProps<TCode>, "name">) {
super(message);
this.name = "DendronError";
this.status = status || "unknown";
this.severity = severity;
this.message = message || "";
if (payload?.message && payload?.stack) {
this.payload = JSON.stringify({
msg: payload.message,
stack: payload.stack,
});
} else if (_.isString(payload)) {
this.payload = payload;
} else {
this.payload = JSON.stringify(payload || {});
}
this.code = code;
this.innerError = innerError;
if (innerError) {
this.stack = innerError.stack;
}
}
}
export class DendronCompositeError extends Error implements IDendronError {
public payload: DendronErrorProps[];
public severity?: ERROR_SEVERITY;
public errors: IDendronError[];
constructor(errors: IDendronError[]) {
super();
this.payload = errors.map((err) => error2PlainObject(err));
this.errors = errors;
const hasFatalError =
_.find(errors, (err) => err.severity === ERROR_SEVERITY.FATAL) !==
undefined;
const allMinorErrors =
_.filter(errors, (err) => err.severity !== ERROR_SEVERITY.MINOR)
.length === 0;
if (hasFatalError) {
// If there is even one fatal error, then the composite is also fatal
this.severity = ERROR_SEVERITY.FATAL;
} else if (allMinorErrors) {
// No fatal errors, and everything is a minor error.
// The composite can be safely marked as a minor error too.
this.severity = ERROR_SEVERITY.MINOR;
}
// sometimes a composite error can be of size one. unwrap and show regular error message in this case
if (this.errors.length === 1) {
this.message = this.errors[0].message;
} else if (this.errors.length > 1) {
const out = ["Multiple errors: "];
const messages = this.errors.map((err) => ` - ${err.message}`);
this.message = out.concat(messages).join("\n");
}
}
static isDendronCompositeError(
error: IDendronError
): error is DendronCompositeError {
if (error.payload && _.isString(error.payload)) {
try {
// Sometimes these sections get serialized when going across from engine to UI
error.payload = JSON.parse(error.payload);
} catch {
// Nothing, the payload wasn't a serialized object
}
}
return (
_.isArray(error.payload) &&
error.payload.every(DendronError.isDendronError)
);
}
}
/** If the error is a composite error, then returns the list of errors inside it.
*
* If it is a single error, then returns that single error in a list.
*
* If this was not a Dendron error, then returns an empty list.
*/
export function errorsList(error: any) {
if (DendronCompositeError.isDendronCompositeError(error))
return error.payload;
if (DendronError.isDendronError(error)) return [error];
return [];
}
export class DendronServerError
extends DendronError
implements IDendronError, ServerErrorProps
{
/**
* Optional HTTP status code for error
*/
public code?: StatusCodes;
/**
* Custom status errors
*/
public status?: string;
}
export class IllegalOperationError extends DendronError {}
export function stringifyError(err: Error) {
return JSON.stringify(err, Object.getOwnPropertyNames(err));
}
export const error2PlainObject = (err: IDendronError): DendronErrorProps => {
const out: Partial<DendronErrorProps> = {};
Object.getOwnPropertyNames(err).forEach((k) => {
// @ts-ignore
out[k] = err[k];
});
return out as DendronErrorProps;
};
export class ErrorMessages {
static formatShouldNeverOccurMsg(description?: string) {
return `${
description === undefined ? "" : description + " "
}This error should never occur! Please report a bug if you have encountered this.`;
}
}
/** Statically ensure that a code path is unreachable using a variable that has been exhaustively used.
*
* The use case for this function is that when using a switch or a chain of if/else if statements,
* this function allows you to ensure that after all possibilities have been already checked, no further
* possibilities remain. Importantly, this is done statically (i.e. during compilation), so if anyone
* revises the code in a way that adds expands the possibilities, a compiler error will warn them that
* they must revise this part of the code as well.
*
* An example of how this function may be used is below:
*
* ```ts
* type Names = "bar" | "baz";
*
* function foo(name: Names) {
* if (name === "bar") { ... }
* else if (name === "baz") { ... }
* else assertUnreachable(name);
* }
* ```
*
* Let's say someone changes the type Names to `type Names = "bar" | "baz" | "ham";`. Thanks to this
* assertion, the compiler will warn them that this branch is now reachable, and something is wrong.
*
* Here's another example:
*
* ```
* switch (msg.type) {
* case GraphViewMessageType.onSelect:
* // ...
* // ... all the cases
* default:
* assertUnreachable(msg.type);
* }
* ```
*
* Warning! Never use this function without a parameter. It won't actually do any type checks then.
*/
export function assertUnreachable(_never: never): never {
throw new DendronError({
message: ErrorMessages.formatShouldNeverOccurMsg(),
});
}
/**
* Helper function to raise invalid state
*/
export function assertInvalidState(msg: string): never {
throw new DendronError({
status: ERROR_STATUS.INVALID_STATE,
message: msg,
});
}
/** Utility class for helping to correctly construct common errors. */
export class ErrorFactory {
/**
* Not found
*/
static create404Error({ url }: { url: string }): DendronError {
return new DendronError({
message: `resource ${url} does not exist`,
severity: ERROR_SEVERITY.FATAL,
});
}
static createUnexpectedEventError({ event }: { event: any }): DendronError {
return new DendronError({
message: `unexpected event: '${this.safeStringify(event)}'`,
});
}
static createInvalidStateError({
message,
}: {
message: string;
}): DendronError {
return new DendronError({
status: ERROR_STATUS.INVALID_STATE,
message,
});
}
static createSchemaValidationError({
message,
}: {
message: string;
}): DendronError {
return new DendronError({
message,
// Setting severity as minor since Dendron could still be functional even
// if some particular schema is malformed.
severity: ERROR_SEVERITY.MINOR,
});
}
/** Stringify that will not throw if it fails to stringify
* (for example: due to circular references) */
static safeStringify(obj: any) {
try {
return JSON.stringify(obj);
} catch (exc: any) {
return `Failed to stringify the given object. Due to '${exc.message}'`;
}
}
/** Wraps the error in DendronError WHEN the instance is not already a DendronError. */
static wrapIfNeeded(err: any): DendronError {
if (err instanceof DendronError) {
// If its already a dendron error we don't need to wrap it.
return err;
} else if (err instanceof Error) {
// If its an instance of some other error we will wrap it and keep track
// of the inner error which was the cause.
return new DendronError({
message: err.message,
innerError: err,
});
} else {
// Hopefully we aren't reaching this branch but in case someone throws
// some object that does not inherit from Error we will attempt to
// safe stringify it into message and wrap as DendronError.
return new DendronError({
message: this.safeStringify(err),
});
}
}
}
export class ErrorUtils {
static isAxiosError(error: unknown): error is AxiosError {
return _.has(error, "isAxiosError");
}
static isDendronError(error: unknown): error is DendronError {
return _.get(error, "name", "") === "DendronError";
}
/**
* Given a RespV3, ensure it is an error resp.
*
* This helps typescript properly narrow down the type of the success resp's data as type T where it is called.
* Otherwise, because of how union types work, `data` will have the type T | undefined.
* @param args
* @returns
*/
static isErrorResp(resp: RespV3<any>): resp is RespV3ErrorResp {
return "error" in resp;
}
}
export function isTSError(err: any): err is Error {
return (
(err as Error).message !== undefined && (err as Error).name !== undefined
);
}