-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy patherrors.ts
More file actions
154 lines (131 loc) · 3.77 KB
/
Copy patherrors.ts
File metadata and controls
154 lines (131 loc) · 3.77 KB
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
import { type AxiosError, type AxiosResponse, isAxiosError } from "axios";
export interface FieldError {
field: string;
detail: string;
}
type FieldErrors = Record<FieldError["field"], FieldError["detail"]>;
export interface ApiErrorResponse {
message: string;
detail?: string;
validations?: FieldError[];
}
export type ApiError = AxiosError<ApiErrorResponse> & {
response: AxiosResponse<ApiErrorResponse>;
};
export const isApiError = (err: unknown): err is ApiError => {
return (
isAxiosError(err) &&
err.response !== undefined &&
isApiErrorResponse(err.response.data)
);
};
/** @public Exported for use by external consumers (e.g., VS Code extension). */
export const isApiErrorResponse = (err: unknown): err is ApiErrorResponse => {
return (
typeof err === "object" &&
err !== null &&
"message" in err &&
typeof err.message === "string" &&
(!("detail" in err) ||
err.detail === undefined ||
typeof err.detail === "string") &&
(!("validations" in err) ||
err.validations === undefined ||
Array.isArray(err.validations))
);
};
export const hasApiFieldErrors = (error: ApiError): boolean =>
Array.isArray(error.response.data.validations);
export const isApiValidationError = (error: unknown): error is ApiError => {
return isApiError(error) && hasApiFieldErrors(error);
};
export const hasError = (error: unknown) =>
error !== undefined && error !== null;
export const mapApiErrorToFieldErrors = (
apiErrorResponse: ApiErrorResponse,
): FieldErrors => {
const result: FieldErrors = {};
if (apiErrorResponse.validations) {
for (const error of apiErrorResponse.validations) {
result[error.field] = error.detail || "Invalid value";
}
}
return result;
};
/**
*
* @param error
* @param defaultMessage
* @returns error's message if ApiError or Error, else defaultMessage
*/
export const getErrorMessage = (
error: unknown,
defaultMessage: string,
): string => {
// if error is API error
// 404s result in the default message being returned
if (isApiError(error) && error.response.data.message) {
return error.response.data.message;
}
if (isApiErrorResponse(error)) {
return error.message;
}
// if error is a non-empty string
if (error && typeof error === "string") {
return error;
}
return defaultMessage;
};
/**
*
* @param error
* @returns a combined validation error message if the error is an ApiError
* and contains validation messages for different form fields.
*/
export const getValidationErrorMessage = (error: unknown): string => {
const validationErrors =
isApiError(error) && error.response.data.validations
? error.response.data.validations
: [];
return validationErrors.map((error) => error.detail).join("\n");
};
export const getErrorDetail = (error: unknown): string | undefined => {
if (error instanceof DetailedError) {
return error.detail;
}
// APIErrors that are empty still benefit from checking the developer
// console if no detail is provided. So only use the detail field if
// it is not empty.
if (isApiError(error) && error.response.data.detail) {
return error.response.data.detail;
}
if (isApiErrorResponse(error) && error.detail) {
return error.detail;
}
if (
isApiValidationError(error) &&
// Ensure that the validations array is not `[]` (empty array).
Array.isArray(error.response.data.validations) &&
error.response.data.validations.length > 0
) {
return getValidationErrorMessage(error);
}
if (error instanceof Error) {
return "Please check the developer console for more details.";
}
return undefined;
};
export const getErrorStatus = (error: unknown): number | undefined => {
if (isApiError(error)) {
return error.status;
}
return undefined;
};
export class DetailedError extends Error {
constructor(
message: string,
public detail?: string,
) {
super(message);
}
}