-
Notifications
You must be signed in to change notification settings - Fork 204
Expand file tree
/
Copy patherrors.ts
More file actions
198 lines (175 loc) · 5.26 KB
/
errors.ts
File metadata and controls
198 lines (175 loc) · 5.26 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
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
import { ErrorClassification } from './types';
/**
* Error types reported through the errorHandler in the client
*/
export enum ErrorType {
NetworkUnexpectedHTTPCode,
NetworkServerLimited,
NetworkServerRejected,
NetworkUnknown,
JsonUnableToSerialize,
JsonUnableToDeserialize,
JsonUnknown,
PluginError,
InitializationError,
ResetError,
FlushError,
}
/**
* Segment Error object for ErrorHandler option
*/
export class SegmentError extends Error {
type: ErrorType;
message: string;
innerError?: unknown;
constructor(type: ErrorType, message: string, innerError?: unknown) {
super(message);
Object.setPrototypeOf(this, SegmentError.prototype);
this.type = type;
this.message = message;
this.innerError = innerError;
}
}
/**
* Custom Error type for Segment HTTP Error responses
*/
export class NetworkError extends SegmentError {
statusCode: number;
type:
| ErrorType.NetworkServerLimited
| ErrorType.NetworkServerRejected
| ErrorType.NetworkUnexpectedHTTPCode
| ErrorType.NetworkUnknown;
constructor(statusCode: number, message: string, innerError?: unknown) {
let type: ErrorType;
if (statusCode === 429) {
type = ErrorType.NetworkServerLimited;
} else if (statusCode > 300 && statusCode < 400) {
type = ErrorType.NetworkUnexpectedHTTPCode;
} else if (statusCode >= 400) {
type = ErrorType.NetworkServerRejected;
} else {
type = ErrorType.NetworkUnknown;
}
super(type, message, innerError);
Object.setPrototypeOf(this, NetworkError.prototype);
this.statusCode = statusCode;
this.type = type;
}
}
/**
* Error type for JSON Serialization errors
*/
export class JSONError extends SegmentError {
constructor(
type: ErrorType.JsonUnableToDeserialize | ErrorType.JsonUnableToSerialize,
message: string,
innerError?: unknown
) {
super(type, message, innerError);
Object.setPrototypeOf(this, JSONError.prototype);
}
}
/**
* Utility method for handling HTTP fetch errors
* @param response Fetch Response
* @returns response if status OK, throws NetworkError for everything else
*/
export const checkResponseForErrors = (response: Response) => {
if (!response.ok) {
throw new NetworkError(response.status, response.statusText);
}
return response;
};
/**
* Converts a .fetch() error to a SegmentError object for reporting to the error handler
* @param error any JS error instance
* @returns a SegmentError object
*/
export const translateHTTPError = (error: unknown): SegmentError => {
// SegmentError already
if (error instanceof SegmentError) {
return error;
// JSON Deserialization Errors
} else if (error instanceof SyntaxError) {
return new JSONError(
ErrorType.JsonUnableToDeserialize,
error.message,
error
);
// HTTP Errors
} else {
const message =
error instanceof Error
? error.message
: typeof error === 'string'
? error
: 'Unknown error';
return new NetworkError(-1, message, error);
}
};
/**
* Classify an HTTP status code into rate_limit, transient, or permanent.
*
* Precedence:
* 1. statusCodeOverrides — explicit per-code overrides
* 2. 429 — rate limiting (if rateLimitEnabled !== false)
* 3. default4xxBehavior / default5xxBehavior — range defaults
* 4. Fallback — permanent (non-retryable)
*/
export const classifyError = (
statusCode: number,
config?: {
default4xxBehavior?: 'drop' | 'retry';
default5xxBehavior?: 'drop' | 'retry';
statusCodeOverrides?: Record<string, 'drop' | 'retry'>;
rateLimitEnabled?: boolean;
}
): ErrorClassification => {
const override = config?.statusCodeOverrides?.[statusCode.toString()];
if (override !== undefined) {
if (override === 'retry') {
return statusCode === 429
? new ErrorClassification('rate_limit')
: new ErrorClassification('transient');
}
return new ErrorClassification('permanent');
}
if (statusCode === 429 && config?.rateLimitEnabled !== false) {
return new ErrorClassification('rate_limit');
}
if (statusCode >= 400 && statusCode < 500) {
const behavior = config?.default4xxBehavior ?? 'drop';
return new ErrorClassification(
behavior === 'retry' ? 'transient' : 'permanent'
);
}
if (statusCode >= 500 && statusCode < 600) {
const behavior = config?.default5xxBehavior ?? 'retry';
return new ErrorClassification(
behavior === 'retry' ? 'transient' : 'permanent'
);
}
return new ErrorClassification('permanent');
};
/**
* Parse Retry-After header value (seconds or HTTP-date format).
* Returns delay in seconds clamped to maxRetryInterval, or undefined if invalid.
*/
export const parseRetryAfter = (
retryAfterValue: string | null,
maxRetryInterval = 300
): number | undefined => {
if (retryAfterValue === null || retryAfterValue === '') return undefined;
const asNumber = Number(retryAfterValue);
if (Number.isFinite(asNumber)) {
if (asNumber < 0) return undefined;
return Math.min(asNumber, maxRetryInterval);
}
const retryDate = new Date(retryAfterValue);
if (!isNaN(retryDate.getTime())) {
const secondsUntil = Math.ceil((retryDate.getTime() - Date.now()) / 1000);
return Math.min(Math.max(secondsUntil, 0), maxRetryInterval);
}
return undefined;
};