/
HttpRequester.ts
505 lines (449 loc) · 13.4 KB
/
HttpRequester.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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
import {
fetchEventSource,
EventStreamContentType,
} from 'fetch-event-source-hperrin';
export type HttpRequesterEventType = 'request' | 'response';
export type HttpRequesterRequestCallback = (
requester: HttpRequester,
url: string,
options: RequestInit
) => void;
export type HttpRequesterResponseCallback = (
requester: HttpRequester,
response: Response,
text: string
) => void;
export type HttpRequesterIteratorCallback = (
requester: HttpRequester,
url: string,
headers: Record<string, string>
) => void;
export type HttpRequesterRequestOptions = {
url: string;
data: { [k: string]: any };
dataType: string;
};
export interface AbortableAsyncIterator<T extends any = any>
extends AsyncIterable<T> {
abortController: AbortController;
}
export default class HttpRequester {
private fetch: WindowOrWorkerGlobalScope['fetch'];
private xsrfToken: string | null = null;
private requestCallbacks: HttpRequesterRequestCallback[] = [];
private responseCallbacks: HttpRequesterResponseCallback[] = [];
private iteratorCallbacks: HttpRequesterIteratorCallback[] = [];
static makeUrl(url: string, data: { [k: string]: any }) {
if (!data) {
return url;
}
for (let [key, value] of Object.entries(data)) {
url =
url +
(url.indexOf('?') !== -1 ? '&' : '?') +
encodeURIComponent(key) +
'=' +
encodeURIComponent(JSON.stringify(value));
}
return url;
}
constructor(ponyFetch?: WindowOrWorkerGlobalScope['fetch']) {
this.fetch = ponyFetch ? ponyFetch : (...args) => fetch(...args);
}
on<T extends HttpRequesterEventType>(
event: T,
callback: T extends 'request'
? HttpRequesterRequestCallback
: T extends 'response'
? HttpRequesterResponseCallback
: T extends 'iterator'
? HttpRequesterIteratorCallback
: never
) {
const prop = (event + 'Callbacks') as T extends 'request'
? 'requestCallbacks'
: T extends 'response'
? 'responseCallbacks'
: T extends 'iterator'
? 'iteratorCallbacks'
: never;
if (!(prop in this)) {
throw new Error('Invalid event type.');
}
// @ts-ignore: The callback should always be the right type here.
this[prop].push(callback);
return () => this.off(event, callback);
}
off<T extends HttpRequesterEventType>(
event: T,
callback: T extends 'request'
? HttpRequesterRequestCallback
: T extends 'response'
? HttpRequesterResponseCallback
: T extends 'iterator'
? HttpRequesterIteratorCallback
: never
) {
const prop = (event + 'Callbacks') as T extends 'request'
? 'requestCallbacks'
: T extends 'response'
? 'responseCallbacks'
: T extends 'iterator'
? 'iteratorCallbacks'
: never;
if (!(prop in this)) {
return false;
}
// @ts-ignore: The callback should always be the right type here.
const i = this[prop].indexOf(callback);
if (i > -1) {
// @ts-ignore: The callback should always be the right type here.
this[prop].splice(i, 1);
}
return true;
}
setXsrfToken(xsrfToken: string | null) {
this.xsrfToken = xsrfToken;
}
async GET(opt: HttpRequesterRequestOptions) {
return await this._httpRequest('GET', opt);
}
async POST(opt: HttpRequesterRequestOptions) {
return await this._httpRequest('POST', opt);
}
async POST_ITERATOR(opt: HttpRequesterRequestOptions) {
return await this._iteratorRequest('POST', opt);
}
async PUT(opt: HttpRequesterRequestOptions) {
return await this._httpRequest('PUT', opt);
}
async PATCH(opt: HttpRequesterRequestOptions) {
return await this._httpRequest('PATCH', opt);
}
async DELETE(opt: HttpRequesterRequestOptions) {
return await this._httpRequest('DELETE', opt);
}
async _httpRequest(
method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE',
opt: HttpRequesterRequestOptions
) {
const dataString = JSON.stringify(opt.data);
let url = opt.url;
if (method === 'GET') {
// TODO: what should this size be?
// && dataString.length < 1) {
url = HttpRequester.makeUrl(opt.url, opt.data);
}
const options: RequestInit = {
method,
headers: {},
credentials: 'include',
};
if (method !== 'GET' && opt.data) {
(options.headers as Record<string, string>)['Content-Type'] =
'application/json';
options.body = dataString;
}
for (let i = 0; i < this.requestCallbacks.length; i++) {
this.requestCallbacks[i] && this.requestCallbacks[i](this, url, options);
}
if (this.xsrfToken !== null) {
(options.headers as Record<string, string>)['X-Xsrf-Token'] =
this.xsrfToken;
}
const response = await this.fetch(url, options);
let text: string;
try {
text = await response.text();
} catch (e: any) {
throw new InvalidResponseError(
'Server response did not contain valid text body.'
);
}
if (!response.ok) {
let errObj;
try {
errObj = JSON.parse(text);
} catch (e: any) {
if (!(e instanceof SyntaxError)) {
throw e;
}
}
if (typeof errObj !== 'object') {
errObj = {
textStatus: response.statusText,
};
}
errObj.status = response.status;
throw response.status < 200
? new InformationalError(response, errObj)
: response.status < 300
? new SuccessError(response, errObj)
: response.status < 400
? new RedirectError(response, errObj)
: response.status < 500
? new ClientError(response, errObj)
: new ServerError(response, errObj);
}
for (let i = 0; i < this.responseCallbacks.length; i++) {
this.responseCallbacks[i] &&
this.responseCallbacks[i](this, response, text);
}
if (opt.dataType === 'json') {
if (!text.length) {
throw new InvalidResponseError('Server response was empty.');
}
try {
return JSON.parse(text);
} catch (e: any) {
if (!(e instanceof SyntaxError)) {
throw e;
}
throw new InvalidResponseError(
'Server response was invalid: ' + JSON.stringify(text)
);
}
} else {
return text;
}
}
async _iteratorRequest(
method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE',
opt: HttpRequesterRequestOptions
): Promise<AbortableAsyncIterator> {
const dataString = JSON.stringify(opt.data);
let url = opt.url;
if (method === 'GET') {
// TODO: what should this size be?
// && dataString.length < 1) {
url = HttpRequester.makeUrl(opt.url, opt.data);
}
const hasBody = method !== 'GET' && opt.data;
const headers: Record<string, string> = {};
if (hasBody) {
headers['Content-Type'] = 'application/json';
}
for (let i = 0; i < this.iteratorCallbacks.length; i++) {
this.iteratorCallbacks[i] &&
this.iteratorCallbacks[i](this, url, headers);
}
if (this.xsrfToken !== null) {
headers['X-Xsrf-Token'] = this.xsrfToken;
}
const responses: any[] = [];
let nextResponseResolve: (value: void) => void;
let nextResponseReadyPromise = new Promise<void>((res) => {
nextResponseResolve = res;
});
let responsesDone = false;
let serverResponse: Response;
const ctrl = new AbortController();
fetchEventSource(url, {
openWhenHidden: true,
fetch: this.fetch,
method,
headers,
credentials: 'include',
body: hasBody ? dataString : undefined,
signal: ctrl.signal,
async onopen(response) {
serverResponse = response;
if (response.ok) {
if (response.headers.get('content-type') === EventStreamContentType) {
throw new InvalidResponseError(
'Server response is not an event stream.'
);
}
// Response is ok, wait for messages.
return;
}
let text: string = '';
try {
text = await response.text();
} catch (e: any) {
// Ignore error here.
}
let errObj;
try {
errObj = JSON.parse(text);
} catch (e: any) {
if (!(e instanceof SyntaxError)) {
throw e;
}
}
if (typeof errObj !== 'object') {
errObj = {
textStatus: response.statusText,
};
}
errObj.status = response.status;
throw response.status < 200
? new InformationalError(response, errObj)
: response.status < 300
? new SuccessError(response, errObj)
: response.status < 400
? new RedirectError(response, errObj)
: response.status < 500
? new ClientError(response, errObj)
: new ServerError(response, errObj);
},
onmessage(event) {
if (event.event === 'next') {
let text = event.data;
if (opt.dataType === 'json') {
if (!text.length) {
responses.push(
new InvalidResponseError('Server response was empty.')
);
} else {
try {
responses.push(JSON.parse(text));
} catch (e: any) {
if (!(e instanceof SyntaxError)) {
responses.push(e);
} else {
responses.push(
new InvalidResponseError(
'Server response was invalid: ' + JSON.stringify(text)
)
);
}
}
}
} else {
responses.push(text);
}
} else if (event.event === 'error') {
let text = event.data;
let errObj;
try {
errObj = JSON.parse(text);
} catch (e: any) {
if (!(e instanceof SyntaxError)) {
throw e;
}
}
if (typeof errObj !== 'object') {
errObj = {
status: 500,
textStatus: 'Iterator Error',
};
}
responses.push(
errObj.status < 200
? new InformationalError(serverResponse, errObj)
: errObj.status < 300
? new SuccessError(serverResponse, errObj)
: errObj.status < 400
? new RedirectError(serverResponse, errObj)
: errObj.status < 500
? new ClientError(serverResponse, errObj)
: new ServerError(serverResponse, errObj)
);
} else if (event.event === 'finished') {
responsesDone = true;
} else if (event.event === 'ping') {
// Ignore keep-alive pings.
return;
}
const resolve = nextResponseResolve;
if (!responsesDone) {
nextResponseReadyPromise = new Promise<void>((res) => {
nextResponseResolve = res;
});
}
// Resolve the promise to continue any waiting iterator.
resolve();
},
onclose() {
responses.push(
new ConnectionClosedUnexpectedlyError(
'The connection to the server was closed unexpectedly.'
)
);
responsesDone = true;
nextResponseResolve();
},
onerror(err) {
// Rethrow to stop the operation.
throw err;
},
}).catch((err) => {
responses.push(
new ConnectionError('The connection could not be established: ' + err)
);
responsesDone = true;
nextResponseResolve();
});
const iterator: AbortableAsyncIterator = {
abortController: ctrl,
async *[Symbol.asyncIterator]() {
do {
await nextResponseReadyPromise;
while (responses.length) {
yield responses.shift();
}
} while (!responsesDone);
},
};
return iterator;
}
}
export class InvalidResponseError extends Error {
constructor(message: string) {
super(message);
this.name = 'InvalidResponseError';
}
}
export class ConnectionClosedUnexpectedlyError extends Error {
constructor(message: string) {
super(message);
this.name = 'ConnectionClosedUnexpectedlyError';
}
}
export class ConnectionError extends Error {
constructor(message: string) {
super(message);
this.name = 'ConnectionError';
}
}
export class HttpError extends Error {
status: number;
statusText: string;
constructor(
name: string,
response: Response,
errObj: { textStatus: string }
) {
super(errObj.textStatus);
this.name = name;
this.status = response.status;
this.statusText = response.statusText;
Object.assign(this, errObj);
}
}
export class InformationalError extends HttpError {
constructor(response: Response, errObj: { textStatus: string }) {
super('InformationalError', response, errObj);
}
}
export class SuccessError extends HttpError {
constructor(response: Response, errObj: { textStatus: string }) {
super('SuccessError', response, errObj);
}
}
export class RedirectError extends HttpError {
constructor(response: Response, errObj: { textStatus: string }) {
super('RedirectError', response, errObj);
}
}
export class ClientError extends HttpError {
constructor(response: Response, errObj: { textStatus: string }) {
super('ClientError', response, errObj);
}
}
export class ServerError extends HttpError {
constructor(response: Response, errObj: { textStatus: string }) {
super('ServerError', response, errObj);
}
}