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
|
/*
This file is part of GNU Taler
(C) 2021-2023 Taler Systems S.A.
GNU Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
import { HttpStatusCode } from "@gnu-taler/taler-util";
import { base64encode } from "./base64.js";
export enum ErrorType {
CLIENT,
SERVER,
TIMEOUT,
UNEXPECTED,
}
/**
*
* @param baseUrl URL where the service is located
* @param endpoint endpoint of the service to be called
* @param options auth, method and params
* @returns
*/
export async function defaultRequestHandler<T>(
baseUrl: string,
endpoint: string,
options: RequestOptions = {},
): Promise<HttpResponseOk<T>> {
const requestHeaders: Record<string, string> = {};
if (options.token) {
requestHeaders.Authorization = `Bearer ${options.token}`;
} else if (options.basicAuth) {
requestHeaders.Authorization = `Basic ${base64encode(
`${options.basicAuth.username}:${options.basicAuth.password}`,
)}`;
}
requestHeaders["Content-Type"] =
options.contentType === "json" ? "application/json" : "text/plain";
const requestMethod = options?.method ?? "GET";
const requestBody = options?.data;
const requestTimeout = options?.timeout ?? 5 * 1000;
const requestParams = options.params ?? {};
const _url = new URL(`${baseUrl}${endpoint}`);
Object.entries(requestParams).forEach(([key, value]) => {
_url.searchParams.set(key, String(value));
});
let payload: BodyInit | undefined = undefined;
if (requestBody != null) {
if (typeof requestBody === "string") {
payload = requestBody;
} else if (requestBody instanceof ArrayBuffer) {
payload = requestBody;
} else if (ArrayBuffer.isView(requestBody)) {
payload = requestBody;
} else if (typeof requestBody === "object") {
payload = JSON.stringify(requestBody);
} else {
throw Error("unsupported request body type");
}
}
const controller = new AbortController();
const timeoutId = setTimeout(() => {
controller.abort("HTTP_REQUEST_TIMEOUT");
}, requestTimeout);
let response;
try {
response = await fetch(_url.href, {
headers: requestHeaders,
method: requestMethod,
credentials: "omit",
mode: "cors",
body: payload,
signal: controller.signal,
});
} catch (ex) {
const info: RequestInfo = {
payload,
url: _url.href,
hasToken: !!options.token,
status: 0,
};
const error: HttpRequestTimeoutError = {
clientError: true,
isNotfound: false,
isUnauthorized: false,
error: undefined,
info,
type: ErrorType.TIMEOUT,
message: "Request timeout",
};
throw new RequestError(error);
}
if (timeoutId) {
clearTimeout(timeoutId);
}
const headerMap = new Headers();
response.headers.forEach((value, key) => {
headerMap.set(key, value);
});
if (response.ok) {
const result = await buildRequestOk<T>(
response,
_url.href,
payload,
!!options.token,
);
return result;
} else {
const error = await buildRequestFailed(
response,
_url.href,
payload,
!!options.token,
);
throw new RequestError(error);
}
}
export type HttpResponse<T, ErrorDetail> =
| HttpResponseOk<T>
| HttpResponseLoading<T>
| HttpError<ErrorDetail>;
export type HttpResponsePaginated<T, ErrorDetail> =
| HttpResponseOkPaginated<T>
| HttpResponseLoading<T>
| HttpError<ErrorDetail>;
export interface RequestInfo {
url: string;
hasToken: boolean;
payload: any;
status: number;
}
interface HttpResponseLoading<T> {
ok?: false;
loading: true;
clientError?: false;
serverError?: false;
data?: T;
}
export interface HttpResponseOk<T> {
ok: true;
loading?: false;
clientError?: false;
serverError?: false;
data: T;
info?: RequestInfo;
}
export type HttpResponseOkPaginated<T> = HttpResponseOk<T> & WithPagination;
export interface WithPagination {
loadMore: () => void;
loadMorePrev: () => void;
isReachingEnd?: boolean;
isReachingStart?: boolean;
}
export type HttpError<ErrorDetail> =
| HttpRequestTimeoutError
| HttpResponseClientError<ErrorDetail>
| HttpResponseServerError<ErrorDetail>
| HttpResponseUnexpectedError;
export interface HttpResponseServerError<ErrorDetail> {
ok?: false;
loading?: false;
/**
* @deprecated use status
*/
clientError?: false;
/**
* @deprecated use status
*/
serverError: true;
type: ErrorType.SERVER;
/**
* @deprecated use payload
*/
error: ErrorDetail;
payload: ErrorDetail;
status: HttpStatusCode;
message: string;
info?: RequestInfo;
}
interface HttpRequestTimeoutError {
ok?: false;
loading?: false;
/**
* @deprecated use type
*/
clientError: true;
/**
* @deprecated use type
*/
serverError?: false;
type: ErrorType.TIMEOUT;
info?: RequestInfo;
error: undefined;
isUnauthorized: false;
isNotfound: false;
message: string;
}
interface HttpResponseClientError<ErrorDetail> {
ok?: false;
loading?: false;
/**
* @deprecated use type
*/
clientError: true;
/**
* @deprecated use type
*/
serverError?: false;
type: ErrorType.CLIENT;
info?: RequestInfo;
/**
* @deprecated use status
*/
isUnauthorized: boolean;
/**
* @deprecated use status
*/
isNotfound: boolean;
status: HttpStatusCode;
/**
* @deprecated use payload
*/
error: ErrorDetail;
payload: ErrorDetail;
message: string;
}
interface HttpResponseUnexpectedError {
ok?: false;
loading?: false;
/**
* @deprecated use type
*/
clientError?: false;
/**
* @deprecated use type
*/
serverError?: false;
type: ErrorType.UNEXPECTED;
info?: RequestInfo;
status?: HttpStatusCode;
/**
* @deprecated use exception
*/
error: unknown;
exception: unknown;
message: string;
}
export class RequestError<ErrorDetail> extends Error {
/**
* @deprecated use cause
*/
info: HttpError<ErrorDetail>;
cause: HttpError<ErrorDetail>;
constructor(d: HttpError<ErrorDetail>) {
super(d.message);
this.info = d;
this.cause = d;
}
}
type Methods = "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
export interface RequestOptions {
method?: Methods;
token?: string;
basicAuth?: {
username: string;
password: string;
};
data?: any;
params?: unknown;
timeout?: number;
contentType?: "text" | "json";
}
async function buildRequestOk<T>(
response: Response,
url: string,
payload: any,
hasToken: boolean,
): Promise<HttpResponseOk<T>> {
const dataTxt = await response.text();
const data = dataTxt ? JSON.parse(dataTxt) : undefined;
return {
ok: true,
data,
info: {
payload,
url,
hasToken,
status: response.status,
},
};
}
async function buildRequestFailed<ErrorDetail>(
response: Response,
url: string,
payload: any,
hasToken: boolean,
): Promise<
| HttpResponseClientError<ErrorDetail>
| HttpResponseServerError<ErrorDetail>
| HttpResponseUnexpectedError
> {
const status = response?.status;
const info: RequestInfo = {
payload,
url,
hasToken,
status: status || 0,
};
try {
const dataTxt = await response.text();
const data = dataTxt ? JSON.parse(dataTxt) : undefined;
if (status && status >= 400 && status < 500) {
const error: HttpResponseClientError<ErrorDetail> = {
clientError: true,
isNotfound: status === 404,
isUnauthorized: status === 401,
type: ErrorType.CLIENT,
status,
info,
message: data?.hint,
error: data, // remove this
payload: data,
};
return error;
}
if (status && status >= 500 && status < 600) {
const error: HttpResponseServerError<ErrorDetail> = {
serverError: true,
type: ErrorType.SERVER,
status,
info,
message: `${data?.hint} (code ${data?.code})`,
error: data, //remove this
payload: data,
};
return error;
}
return {
info,
type: ErrorType.UNEXPECTED,
status,
error: {}, // remove this
exception: undefined,
message: "NOT DEFINED",
};
} catch (ex) {
const error: HttpResponseUnexpectedError = {
info,
status,
type: ErrorType.UNEXPECTED,
error: ex,
exception: ex,
message: "NOT DEFINED",
};
return error;
}
}
// export function isAxiosError<T>(
// error: AxiosError | any,
// ): error is AxiosError<T> {
// return error && error.isAxiosError;
// }
|