-
-
Notifications
You must be signed in to change notification settings - Fork 935
/
request-as-event-emitter.ts
367 lines (305 loc) · 12.1 KB
/
request-as-event-emitter.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
import {format, UrlObject} from 'url';
import {promisify} from 'util';
import EventEmitter = require('events');
import {Transform as TransformStream} from 'stream';
import http = require('http');
import https = require('https');
import CacheableRequest = require('cacheable-request');
import toReadableStream = require('to-readable-stream');
import is from '@sindresorhus/is';
import timer, {Timings} from '@szmarczak/http-timer';
import ResponseLike = require('responselike');
import timedOut, {TimeoutError as TimedOutTimeoutError} from './utils/timed-out';
import getBodySize from './utils/get-body-size';
import isFormData from './utils/is-form-data';
import getResponse from './get-response';
import {uploadProgress} from './progress';
import {CacheError, UnsupportedProtocolError, MaxRedirectsError, RequestError, TimeoutError} from './errors';
import urlToOptions from './utils/url-to-options';
import {RequestFunction, NormalizedOptions, Response, AgentByProtocol} from './utils/types';
import dynamicRequire from './utils/dynamic-require';
const URLGlobal: typeof URL = typeof URL === 'undefined' ? require('url').URL : URL;
const URLSearchParamsGlobal: typeof URLSearchParams = typeof URLSearchParams === 'undefined' ? require('url').URLSearchParams : URLSearchParams;
export type GetMethodRedirectCodes = 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308;
export type AllMethodRedirectCodes = 300 | 303 | 307 | 308;
export type WithoutBody = 'GET' | 'HEAD';
const getMethodRedirectCodes: ReadonlySet<GetMethodRedirectCodes> = new Set([300, 301, 302, 303, 304, 305, 307, 308]);
const allMethodRedirectCodes: ReadonlySet<AllMethodRedirectCodes> = new Set([300, 303, 307, 308]);
const withoutBody: ReadonlySet<WithoutBody> = new Set(['GET', 'HEAD']);
export interface RequestAsEventEmitter extends EventEmitter {
retry: <T extends Error>(error: T) => boolean;
abort: () => void;
}
export default (options: NormalizedOptions, input?: TransformStream) => {
const emitter = new EventEmitter() as RequestAsEventEmitter;
const redirects = [] as string[];
let currentRequest: http.ClientRequest;
let requestUrl: string;
let redirectString: string;
let uploadBodySize: number | undefined;
let retryCount = 0;
let shouldAbort = false;
const setCookie = options.cookieJar ? promisify(options.cookieJar.setCookie.bind(options.cookieJar)) : null;
const getCookieString = options.cookieJar ? promisify(options.cookieJar.getCookieString.bind(options.cookieJar)) : null;
const agents = is.object(options.agent) ? options.agent : null;
const emitError = async (error: Error): Promise<void> => {
try {
for (const hook of options.hooks.beforeError) {
// eslint-disable-next-line no-await-in-loop
error = await hook(error);
}
emitter.emit('error', error);
} catch (error2) {
emitter.emit('error', error2);
}
};
const get = async (options: NormalizedOptions): Promise<void> => {
const currentUrl = redirectString || requestUrl;
if (options.protocol !== 'http:' && options.protocol !== 'https:') {
throw new UnsupportedProtocolError(options);
}
decodeURI(currentUrl);
let requestFn: RequestFunction;
if (is.function_(options.request)) {
requestFn = options.request;
} else {
requestFn = options.protocol === 'https:' ? https.request : http.request;
}
if (agents) {
const protocolName = options.protocol === 'https:' ? 'https' : 'http';
options.agent = (agents as AgentByProtocol)[protocolName] || options.agent;
}
/* istanbul ignore next: electron.net is broken */
// No point in typing process.versions correctly, as
// process.version.electron is used only once, right here.
if (options.useElectronNet && (process.versions as any).electron) {
const electron = dynamicRequire(module, 'electron'); // Trick webpack
requestFn = (electron as any).net.request || (electron as any).remote.net.request;
}
if (options.cookieJar) {
const cookieString = await getCookieString!(currentUrl);
if (is.nonEmptyString(cookieString)) {
options.headers.cookie = cookieString;
}
}
let timings: Timings;
const handleResponse = async (response: http.ServerResponse | ResponseLike): Promise<void> => {
try {
/* istanbul ignore next: fixes https://github.com/electron/electron/blob/cbb460d47628a7a146adf4419ed48550a98b2923/lib/browser/api/net.js#L59-L65 */
if (options.useElectronNet) {
response = new Proxy(response, {
get: (target, name) => {
if (name === 'trailers' || name === 'rawTrailers') {
return [];
}
const value = (target as any)[name];
return is.function_(value) ? value.bind(target) : value;
}
});
}
const {statusCode} = response;
const typedResponse = response as Response;
typedResponse.statusMessage = typedResponse.statusMessage || http.STATUS_CODES[statusCode];
typedResponse.url = currentUrl;
typedResponse.requestUrl = requestUrl;
typedResponse.retryCount = retryCount;
typedResponse.timings = timings;
typedResponse.redirectUrls = redirects;
typedResponse.request = {options};
typedResponse.isFromCache = typedResponse.fromCache || false;
delete typedResponse.fromCache;
const rawCookies = typedResponse.headers['set-cookie'];
if (options.cookieJar && rawCookies) {
await Promise.all(rawCookies.map((rawCookie: string) => setCookie!(rawCookie, typedResponse.url!)));
}
if (options.followRedirect && 'location' in typedResponse.headers) {
if (allMethodRedirectCodes.has(statusCode as AllMethodRedirectCodes) || (getMethodRedirectCodes.has(statusCode as GetMethodRedirectCodes) && (options.method === 'GET' || options.method === 'HEAD'))) {
typedResponse.resume(); // We're being redirected, we don't care about the response.
if (statusCode === 303) {
// Server responded with "see other", indicating that the resource exists at another location,
// and the client should request it from that location via GET or HEAD.
options.method = 'GET';
}
if (redirects.length >= 10) {
throw new MaxRedirectsError(typedResponse, options);
}
// Handles invalid URLs. See https://github.com/sindresorhus/got/issues/604
const redirectBuffer = Buffer.from(typedResponse.headers.location!, 'binary').toString();
const redirectURL = new URLGlobal(redirectBuffer, currentUrl);
redirectString = redirectURL.toString();
redirects.push(redirectString);
const redirectOptions = {
...options,
port: undefined,
auth: undefined,
...urlToOptions(redirectURL)
};
for (const hook of options.hooks.beforeRedirect) {
// eslint-disable-next-line no-await-in-loop
await hook(redirectOptions, typedResponse);
}
emitter.emit('redirect', response, redirectOptions);
await get(redirectOptions);
return;
}
}
getResponse(typedResponse, options, emitter);
} catch (error) {
emitError(error);
}
};
const handleRequest = (request: http.ClientRequest): void => {
if (shouldAbort) {
request.abort();
return;
}
currentRequest = request;
request.on('error', error => {
if (request.aborted || error.message === 'socket hang up') {
return;
}
if (error instanceof TimedOutTimeoutError) {
error = new TimeoutError(error, timings, options);
} else {
error = new RequestError(error, options);
}
if (emitter.retry(error) === false) {
emitError(error);
}
});
timings = timer(request);
uploadProgress(request, emitter, uploadBodySize);
if (options.gotTimeout) {
timedOut(request, options.gotTimeout, options);
}
emitter.emit('request', request);
const uploadComplete = (): void => {
request.emit('upload-complete');
};
try {
if (is.nodeStream(options.body)) {
options.body.once('end', uploadComplete);
options.body.pipe(request);
options.body = undefined;
} else if (options.body) {
request.end(options.body, uploadComplete);
} else if (input && (options.method === 'POST' || options.method === 'PUT' || options.method === 'PATCH')) {
input.once('end', uploadComplete);
input.pipe(request);
} else {
request.end(uploadComplete);
}
} catch (error) {
emitError(new RequestError(error, options));
}
};
if (options.cache) {
const cacheableRequest = new CacheableRequest(requestFn, options.cache);
const cacheRequest = cacheableRequest(options as https.RequestOptions, handleResponse);
cacheRequest.once('error', error => {
if (error instanceof CacheableRequest.RequestError) {
emitError(new RequestError(error, options));
} else {
emitError(new CacheError(error, options));
}
});
cacheRequest.once('request', handleRequest);
} else {
// Catches errors thrown by calling requestFn(...)
try {
// @ts-ignore TS complains that URLSearchParams is not the same as URLSearchParams
handleRequest(requestFn(options as any as URL, handleResponse));
} catch (error) {
emitError(new RequestError(error, options));
}
}
};
emitter.retry = (error): boolean => {
let backoff: number;
try {
backoff = options.retry.retries(++retryCount, error);
} catch (error2) {
emitError(error2);
return false;
}
if (backoff) {
const retry = async (options: NormalizedOptions): Promise<void> => {
try {
for (const hook of options.hooks.beforeRetry) {
// eslint-disable-next-line no-await-in-loop
await hook(options, error, retryCount);
}
await get(options);
} catch (error) {
emitError(error);
}
};
setTimeout(retry, backoff, {...options, forceRefresh: true});
return true;
}
return false;
};
emitter.abort = () => {
if (currentRequest) {
currentRequest.abort();
} else {
shouldAbort = true;
}
};
setImmediate(async () => {
try {
for (const hook of options.hooks.beforeRequest) {
// eslint-disable-next-line no-await-in-loop
await hook(options);
}
// Serialize body
const {body, headers} = options;
const isForm = !is.nullOrUndefined(options.form);
const isJSON = !is.nullOrUndefined(options.json);
const isBody = !is.nullOrUndefined(body);
if ((isBody || isForm || isJSON) && withoutBody.has(options.method as WithoutBody)) {
throw new TypeError(`The \`${options.method}\` method cannot be used with a body`);
}
if (isBody) {
if (isForm || isJSON) {
throw new TypeError('The `body` option cannot be used with the `json` option or `form` option');
}
if (is.object(body) && isFormData(body)) {
// Special case for https://github.com/form-data/form-data
headers['content-type'] = headers['content-type'] || `multipart/form-data; boundary=${body.getBoundary()}`;
} else if (!is.nodeStream(body) && !is.string(body) && !is.buffer(body)) {
throw new TypeError('The `body` option must be a stream.Readable, string, Buffer, Object or Array');
}
} else if (isForm) {
if (!is.object(options.form)) {
throw new TypeError('The `form` option must be an Object');
}
headers['content-type'] = headers['content-type'] || 'application/x-www-form-urlencoded';
options.body = (new URLSearchParamsGlobal(options.form as Record<string, string>)).toString();
} else if (isJSON) {
headers['content-type'] = headers['content-type'] || 'application/json';
options.body = JSON.stringify(options.json);
}
// Convert buffer to stream to receive upload progress events (#322)
if (is.buffer(body)) {
options.body = toReadableStream(body);
uploadBodySize = body.length;
} else {
uploadBodySize = await getBodySize(options);
}
if (is.undefined(headers['content-length']) && is.undefined(headers['transfer-encoding'])) {
if ((uploadBodySize! > 0 || options.method === 'PUT') && !is.undefined(uploadBodySize)) {
headers['content-length'] = String(uploadBodySize);
}
}
if (!options.stream && options.responseType === 'json' && is.undefined(headers.accept)) {
options.headers.accept = 'application/json';
}
requestUrl = options.href || (new URLGlobal(options.path, format(options as UrlObject))).toString();
await get(options);
} catch (error) {
emitError(error);
}
});
return emitter;
};