forked from sindresorhus/got
/
arguments.ts
668 lines (543 loc) 路 15.8 KB
/
arguments.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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
import {parse, URL, URLSearchParams} from 'url';
import test from 'ava';
import {Handler} from 'express';
import {pEvent} from 'p-event';
import got, {Options, RequestError, StrictOptions} from '../source/index.js';
import withServer, {withBodyParsingServer} from './helpers/with-server.js';
import invalidUrl from './helpers/invalid-url.js';
const echoUrl: Handler = (request, response) => {
response.end(request.url);
};
test('`url` is required', async t => {
await t.throwsAsync(
// @ts-expect-error No argument on purpose.
got(),
{
instanceOf: RequestError,
message: 'Missing `url` property',
},
);
const firstError = await t.throwsAsync(got(''));
invalidUrl(t, firstError, '');
const secondError = await t.throwsAsync(got({url: ''}));
invalidUrl(t, secondError, '');
});
test('`url` should be utf-8 encoded', async t => {
await t.throwsAsync(
got('https://example.com/%D2%E0%EB%EB%E8%ED'),
{
instanceOf: RequestError,
message: 'URI malformed',
},
);
});
test('throws if no arguments provided', async t => {
// @ts-expect-error Error tests
await t.throwsAsync(got(), {
instanceOf: RequestError,
message: 'Missing `url` property',
});
});
test('throws if the url option is missing', async t => {
await t.throwsAsync(got({}), {
instanceOf: RequestError,
message: 'Missing `url` property',
});
});
test('throws an error if the protocol is not specified', async t => {
const error = await t.throwsAsync(got('example.com'));
invalidUrl(t, error, 'example.com');
});
test('properly encodes query string', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const path = '?test=http://example.com?foo=bar';
const {body} = await got(path);
t.is(body, '/?test=http://example.com?foo=bar');
});
test('options are optional', withServer, async (t, server, got) => {
server.get('/test', echoUrl);
t.is((await got('test')).body, '/test');
});
test('methods are normalized', withServer, async (t, server, got) => {
server.post('/test', echoUrl);
const instance = got.extend({
handlers: [
(options, next) => {
if (options.method === options.method.toUpperCase()) {
t.pass();
} else {
t.fail();
}
return next(options);
},
],
});
await instance('test', {method: 'post'});
});
test('throws an error when legacy URL is passed', withServer, async (t, server) => {
server.get('/test', echoUrl);
await t.throwsAsync(
// @ts-expect-error Error tests
got(parse(`${server.url}/test`)),
{
instanceOf: RequestError,
message: 'Expected value which is `predicate returns truthy for any value`, received values of types `Object`.',
},
);
await t.throwsAsync(
got({
protocol: 'http:',
hostname: 'localhost',
port: server.port,
} as any),
{
instanceOf: RequestError,
message: 'Unexpected option: protocol',
},
);
});
test('overrides `searchParams` from options', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const {body} = await got(
'?drop=this',
{
searchParams: {
test: 'wow',
},
},
);
t.is(body, '/?test=wow');
});
test('does not duplicate `searchParams`', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const instance = got.extend({
searchParams: new URLSearchParams({foo: '123'}),
});
const body = await instance('?bar=456').text();
t.is(body, '/?foo=123');
});
test('escapes `searchParams` parameter values', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const {body} = await got({
searchParams: {
test: 'it鈥檚 ok',
},
});
t.is(body, '/?test=it%E2%80%99s+ok');
});
test('the `searchParams` option can be a URLSearchParams', withServer, async (t, server, got) => {
server.get('/', echoUrl);
// eslint-disable-next-line unicorn/prevent-abbreviations
const searchParams = new URLSearchParams({test: 'wow'});
const {body} = await got({searchParams});
t.is(body, '/?test=wow');
});
test('ignores empty searchParams object', withServer, async (t, server, got) => {
server.get('/test', echoUrl);
t.is((await got('test', {searchParams: {}})).requestUrl.toString(), `${server.url}/test`);
});
test('throws when passing body with a non payload method', async t => {
await t.throwsAsync(got('https://example.com', {body: 'asdf'}), {
instanceOf: RequestError,
message: 'The `GET` method cannot be used with a body',
});
});
test('`allowGetBody` option', withServer, async (t, server, got) => {
server.get('/test', echoUrl);
await t.notThrowsAsync(got('test', {body: 'asdf', allowGetBody: true}));
});
test('WHATWG URL support', withServer, async (t, server) => {
server.get('/test', echoUrl);
const url = new URL(`${server.url}/test`);
await t.notThrowsAsync(got(url));
});
test('returns streams when using `isStream` option', withServer, async (t, server, got) => {
server.get('/stream', (_request, response) => {
response.end('ok');
});
const data = await pEvent(got('stream', {isStream: true}), 'data');
t.is(data.toString(), 'ok');
});
test('accepts `url` as an option', withServer, async (t, server, got) => {
server.get('/test', echoUrl);
await t.notThrowsAsync(got({url: 'test'}));
});
test('can omit `url` option if using `prefixUrl`', withServer, async (t, server, got) => {
server.get('/', echoUrl);
await t.notThrowsAsync(got({}));
});
test('throws when `options.hooks` is not an object', async t => {
await t.throwsAsync(
// @ts-expect-error Error tests
got('https://example.com', {hooks: 'not object'}),
{
instanceOf: RequestError,
message: 'Expected value which is `Object`, received value of type `string`.',
},
);
});
test('throws when known `options.hooks` value is not an array', async t => {
await t.throwsAsync(
// @ts-expect-error Error tests
got('https://example.com', {hooks: {beforeRequest: {}}}),
{
instanceOf: RequestError,
message: 'Expected value which is `predicate returns truthy for any value`, received values of types `Object`.',
},
);
});
test('throws when known `options.hooks` array item is not a function', async t => {
await t.throwsAsync(
// @ts-expect-error Error tests
got('https://example.com', {hooks: {beforeRequest: [{}]}}),
{
instanceOf: RequestError,
message: 'Expected value which is `Function`, received value of type `Object`.',
},
);
});
test('does not allow extra keys in `options.hooks`', withServer, async (t, server, got) => {
server.get('/test', echoUrl);
// @ts-expect-error Error tests
await t.throwsAsync(got('test', {hooks: {extra: []}}), {
instanceOf: RequestError,
message: 'Unexpected hook event: extra',
});
});
test('`prefixUrl` option works', withServer, async (t, server, got) => {
server.get('/test/foobar', echoUrl);
const instanceA = got.extend({prefixUrl: `${server.url}/test`});
const {body} = await instanceA('foobar');
t.is(body, '/test/foobar');
});
test('accepts WHATWG URL as the `prefixUrl` option', withServer, async (t, server, got) => {
server.get('/test/foobar', echoUrl);
const instanceA = got.extend({prefixUrl: new URL(`${server.url}/test`)});
const {body} = await instanceA('foobar');
t.is(body, '/test/foobar');
});
test('backslash in the end of `prefixUrl` option is optional', withServer, async (t, server) => {
server.get('/test/foobar', echoUrl);
const instanceA = got.extend({prefixUrl: `${server.url}/test/`});
const {body} = await instanceA('foobar');
t.is(body, '/test/foobar');
});
test('`prefixUrl` can be changed if the URL contains the old one', withServer, async (t, server) => {
server.get('/', echoUrl);
const instanceA = got.extend({
prefixUrl: `${server.url}/meh`,
handlers: [
(options, next) => {
options.prefixUrl = server.url;
return next(options);
},
],
});
const {body} = await instanceA('');
t.is(body, '/');
});
test('throws if the `searchParams` value is invalid', async t => {
await t.throwsAsync(got('https://example.com', {
searchParams: {
// @ts-expect-error Error tests
foo: [],
},
}),
{
instanceOf: RequestError,
message: 'Expected value which is `predicate returns truthy for any value`, received values of types `Array`.',
});
});
test.failing('`context` option is enumerable', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const context = {
foo: 'bar',
};
await got({
context,
hooks: {
beforeRequest: [
options => {
t.deepEqual(options.context, context);
t.true(Object.prototype.propertyIsEnumerable.call(options, 'context'));
},
],
},
});
});
test('`context` option is accessible when using hooks', withServer, async (t, server) => {
server.get('/', echoUrl);
const context = {
foo: 'bar',
};
await got(server.url, {
context,
hooks: {
beforeRequest: [
options => {
t.deepEqual(options.context, context);
t.false(Object.prototype.propertyIsEnumerable.call(options, 'context'));
},
],
},
});
});
test('`context` option is accessible when extending instances', t => {
const context = {
foo: 'bar',
};
const instance = got.extend({context});
t.deepEqual(instance.defaults.options.context, context);
t.false(Object.prototype.propertyIsEnumerable.call(instance.defaults.options, 'context'));
});
test('`context` option is shallow merged', t => {
const context = {
foo: 'bar',
};
const context2 = {
bar: 'baz',
};
const instance1 = got.extend({context});
t.deepEqual(instance1.defaults.options.context, context);
t.false(Object.prototype.propertyIsEnumerable.call(instance1.defaults.options, 'context'));
const instance2 = instance1.extend({context: context2});
t.deepEqual(instance2.defaults.options.context, {...context, ...context2});
});
test('throws if `options.encoding` is `null`', async t => {
await t.throwsAsync(got('https://example.com', {
// @ts-expect-error For testing purposes
encoding: null,
}), {
instanceOf: RequestError,
message: 'To get a Buffer, set `options.responseType` to `buffer` instead',
});
});
test('`url` option and input argument are mutually exclusive', async t => {
await t.throwsAsync(got('https://example.com', {
url: 'https://example.com',
}), {
instanceOf: RequestError,
message: 'The `url` option is mutually exclusive with the `input` argument',
});
});
test('throws a helpful error when passing `followRedirects`', async t => {
await t.throwsAsync(got('https://example.com', {
// @ts-expect-error For testing purposes
followRedirects: true,
}), {
instanceOf: RequestError,
message: 'The `followRedirects` option does not exist. Use `followRedirect` instead.',
});
});
test('merges `searchParams` instances', t => {
const instance = got.extend({
searchParams: new URLSearchParams('a=1'),
}, {
searchParams: new URLSearchParams('b=2'),
});
// eslint-disable-next-line unicorn/prevent-abbreviations
const searchParams = instance.defaults.options.searchParams as URLSearchParams;
t.is(searchParams.get('a'), '1');
t.is(searchParams.get('b'), '2');
});
test('throws a helpful error when passing `auth`', async t => {
await t.throwsAsync(got('https://example.com', {
// @ts-expect-error For testing purposes
auth: 'username:password',
}), {
instanceOf: RequestError,
message: 'Parameter `auth` is deprecated. Use `username` / `password` instead.',
});
});
test('throws on leading slashes', async t => {
await t.throwsAsync(got('/asdf', {prefixUrl: 'https://example.com'}), {
instanceOf: RequestError,
message: '`url` must not start with a slash',
});
});
test('throws on invalid `dnsCache` option', async t => {
await t.throwsAsync(got('https://example.com', {
// @ts-expect-error Error tests
dnsCache: 123,
}),
{
instanceOf: RequestError,
message: 'Expected value which is `predicate returns truthy for any value`, received values of types `number`.',
});
});
test('throws on invalid `agent` option', async t => {
await t.throwsAsync(got('https://example.com', {
agent: {
// @ts-expect-error Error tests
asdf: 123,
},
}), {
instanceOf: RequestError,
message: 'Unexpected agent option: asdf',
});
});
test('fallbacks to native http if `request(...)` returns undefined', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const {body} = await got('', {request: () => undefined});
t.is(body, '/');
});
test('strict options', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const options: StrictOptions = {};
const {body} = await got(options);
t.is(body, '/');
});
test('does not throw on frozen options', withServer, async (t, server, got) => {
server.get('/', echoUrl);
const options: StrictOptions = {};
Object.freeze(options);
const {body} = await got(options);
t.is(body, '/');
});
test('encodes query string included in input', t => {
const {url} = new Options({
url: new URL('https://example.com/?a=b c'),
});
t.is(url!.search, '?a=b%20c');
});
test('normalizes search params included in options', t => {
const {url} = new Options({
url: new URL('https://example.com'),
searchParams: 'a=b c',
});
t.is(url!.search, '?a=b+c');
});
test('reuse options while using init hook', withServer, async (t, server, got) => {
t.plan(2);
server.get('/', echoUrl);
const options = {
hooks: {
init: [
() => {
t.pass();
},
],
},
};
await got('', options);
await got('', options);
});
test('allowGetBody sends json payload', withBodyParsingServer, async (t, server, got) => {
server.get('/', (request, response) => {
if (request.body.hello !== 'world') {
response.statusCode = 400;
}
response.end();
});
const {statusCode} = await got({
allowGetBody: true,
json: {hello: 'world'},
retry: {
limit: 0,
},
throwHttpErrors: false,
});
t.is(statusCode, 200);
});
test('no URL pollution', withServer, async (t, server) => {
server.get('/ok', echoUrl);
const url = new URL(server.url);
const {body} = await got(url, {
hooks: {
beforeRequest: [
options => {
(options.url as URL).pathname = '/ok';
},
],
},
});
t.is(url.pathname, '/');
t.is(body, '/ok');
});
test('prefixUrl is properly replaced when extending', withServer, async (t, server) => {
server.get('/', (request, response) => {
response.end(request.url);
});
server.get('/other/path/', (request, response) => {
response.end(request.url);
});
const parent = got.extend({prefixUrl: server.url});
const child = parent.extend({prefixUrl: `${server.url}/other/path/`});
t.is(await child.get('').text(), '/other/path/');
});
test('throws on too large noise', t => {
/* eslint-disable no-new */
t.throws(() => {
new Options({
retry: {
noise: 101,
},
});
}, {
instanceOf: Error,
message: 'The maximum acceptable retry noise is +/- 100ms, got 101',
});
t.throws(() => {
new Options({
retry: {
noise: -101,
},
});
}, {
instanceOf: Error,
message: 'The maximum acceptable retry noise is +/- 100ms, got -101',
});
t.throws(() => {
new Options({
retry: {
noise: Number.POSITIVE_INFINITY,
},
});
}, {
instanceOf: Error,
message: 'The maximum acceptable retry noise is +/- 100ms, got Infinity',
});
t.throws(() => {
new Options({
retry: {
noise: Number.NEGATIVE_INFINITY,
},
});
}, {
instanceOf: Error,
message: 'The maximum acceptable retry noise is +/- 100ms, got -Infinity',
});
t.notThrows(() => {
new Options({
retry: {
noise: 0,
},
});
});
/* eslint-enable no-new */
});
test('options have url even if some are invalid', async t => {
const error = await t.throwsAsync<RequestError>(got('https://example.com', {
// @ts-expect-error Testing purposes
invalid: true,
}));
t.is((error.options.url as URL).href, 'https://example.com/');
t.true(error instanceof Error);
});
test('options have url even if some are invalid - got.extend', async t => {
const instance = got.extend({
handlers: [
(options, next) => {
t.is((options.url as URL).href, 'https://example.com/');
return next(options);
},
],
});
await t.throwsAsync(instance('https://example.com', {
// @ts-expect-error Testing purposes
invalid: true,
}),
{
instanceOf: Error,
});
});