/
test.ts
486 lines (419 loc) · 11.6 KB
/
test.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
import assert from 'assert';
import * as fs from 'fs';
import * as net from 'net';
import * as tls from 'tls';
import * as http from 'http';
import * as https from 'https';
import { once } from 'events';
import { listen } from 'async-listen';
import { Agent, AgentConnectOpts, req, json } from '../src';
const sleep = (n: number) => new Promise((r) => setTimeout(r, n));
const sslOptions = {
key: fs.readFileSync(`${__dirname}/ssl-cert-snakeoil.key`),
cert: fs.readFileSync(`${__dirname}/ssl-cert-snakeoil.pem`),
};
describe('Agent (TypeScript)', () => {
describe('subclass', () => {
it('should be extendable (direct return)', () => {
class MyAgent extends Agent {
connect() {
return http.globalAgent;
}
}
const agent = new MyAgent();
assert(agent instanceof Agent);
assert(agent instanceof MyAgent);
});
it('should be extendable (async return)', () => {
class MyAgent extends Agent {
async connect() {
return http.globalAgent;
}
}
const agent = new MyAgent();
assert(agent instanceof Agent);
assert(agent instanceof MyAgent);
});
});
describe('"http" module', () => {
it('should work for basic HTTP requests', async () => {
let gotReq = false;
let gotCallback = false;
class MyAgent extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
) {
gotCallback = true;
assert(opts.secureEndpoint === false);
return net.connect(opts);
}
}
const agent = new MyAgent();
const server = http.createServer((req, res) => {
gotReq = true;
res.setHeader('X-Foo', 'bar');
res.setHeader('X-Url', req.url || '/');
res.end();
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
try {
const res = await req(`http://127.0.0.1:${port}/foo`, {
agent,
});
assert.equal('bar', res.headers['x-foo']);
assert.equal('/foo', res.headers['x-url']);
assert(gotReq);
assert(gotCallback);
} finally {
server.close();
}
});
it('should not send a port number for the default port', async () => {
class MyAgent extends Agent {
connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): net.Socket {
assert(opts.secureEndpoint === false);
assert.equal(this.defaultPort, port);
assert.equal(opts.port, port);
return net.connect(opts);
}
}
const agent = new MyAgent();
const server = http.createServer((req, res) => {
res.end(JSON.stringify(req.headers));
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
agent.defaultPort = port;
try {
const res = await req(`http://127.0.0.1:${port}/foo`, {
agent,
});
const body = await json(res);
assert.equal(body.host, '127.0.0.1');
} finally {
server.close();
}
});
it('should work after the first tick of the `http.ClientRequest` instance', async () => {
let gotReq = false;
let gotCallback = false;
class MyAgent extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): Promise<net.Socket> {
gotCallback = true;
assert(opts.secureEndpoint === false);
await sleep(10);
return net.connect(opts);
}
}
const agent = new MyAgent();
const server = http.createServer((req, res) => {
gotReq = true;
res.setHeader('X-Foo', 'bar');
res.setHeader('X-Url', req.url || '/');
res.end();
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
try {
const res = await req(`http://127.0.0.1:${port}/foo`, {
agent,
});
assert.equal('bar', res.headers['x-foo']);
assert.equal('/foo', res.headers['x-url']);
assert(gotReq);
assert(gotCallback);
} finally {
server.close();
}
});
it('should emit an "error" event on `http.ClientRequest` instance when callback throws sync', async () => {
let gotError = false;
let gotCallback = false;
class MyAgent extends Agent {
connect(): net.Socket {
gotCallback = true;
throw new Error('bad');
}
}
const agent = new MyAgent();
try {
await req('http://127.0.0.1/throws', { agent });
} catch (err: unknown) {
gotError = true;
assert.equal((err as Error).message, 'bad');
}
assert(gotError);
assert(gotCallback);
});
it('should emit an "error" event on `http.ClientRequest` instance when callback throws async', async () => {
let gotError = false;
let gotCallback = false;
class MyAgent extends Agent {
async connect(): Promise<net.Socket> {
gotCallback = true;
await sleep(10);
throw new Error('bad');
}
}
const agent = new MyAgent();
try {
await req('http://127.0.0.1/throws', { agent });
} catch (err: unknown) {
gotError = true;
assert.equal((err as Error).message, 'bad');
}
assert(gotError);
assert(gotCallback);
});
it('should support `keepAlive: true`', async () => {
let reqCount1 = 0;
let reqCount2 = 0;
let connectCount = 0;
class MyAgent extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
) {
connectCount++;
assert(opts.secureEndpoint === false);
return net.connect(opts);
}
}
const agent = new MyAgent({ keepAlive: true });
const server1 = http.createServer((req, res) => {
expect(req.headers.connection).toEqual('keep-alive');
reqCount1++;
res.end();
});
const addr1 = (await listen(server1)) as URL;
const server2 = http.createServer((req, res) => {
expect(req.headers.connection).toEqual('keep-alive');
reqCount2++;
res.end();
});
const addr2 = (await listen(server2)) as URL;
try {
const res = await req(new URL('/foo', addr1), { agent });
expect(reqCount1).toEqual(1);
expect(connectCount).toEqual(1);
expect(res.headers.connection).toEqual('keep-alive');
res.resume();
const s1 = res.socket;
await once(s1, 'free');
const res2 = await req(new URL('/another', addr1), { agent });
expect(reqCount1).toEqual(2);
expect(connectCount).toEqual(1);
expect(res2.headers.connection).toEqual('keep-alive');
assert(res2.socket === s1);
res2.resume();
await once(res2.socket, 'free');
// This is a different host, so a new socket should be used
const res3 = await req(new URL('/another', addr2), { agent });
expect(reqCount2).toEqual(1);
expect(connectCount).toEqual(2);
expect(res3.headers.connection).toEqual('keep-alive');
assert(res3.socket !== s1);
res3.resume();
await once(res3.socket, 'free');
} finally {
agent.destroy();
server1.close();
server2.close();
}
});
});
describe('"https" module', () => {
it('should work for basic HTTPS requests', async () => {
let gotReq = false;
let gotCallback = false;
class MyAgent extends Agent {
connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): net.Socket {
gotCallback = true;
assert(opts.secureEndpoint === true);
return tls.connect(opts);
}
}
const agent = new MyAgent();
const server = https.createServer(sslOptions, (req, res) => {
gotReq = true;
res.setHeader('X-Foo', 'bar');
res.setHeader('X-Url', req.url || '/');
res.end();
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
try {
const res = await req(`https://127.0.0.1:${port}/foo`, {
agent,
rejectUnauthorized: false,
});
assert.equal('bar', res.headers['x-foo']);
assert.equal('/foo', res.headers['x-url']);
assert(gotReq);
assert(gotCallback);
} finally {
server.close();
}
});
it('should work when returning another `agent-base`', async () => {
let gotReq = false;
let gotCallback1 = false;
let gotCallback2 = false;
class MyAgent1 extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): Promise<http.Agent> {
gotCallback1 = true;
assert.equal(opts.secureEndpoint, true);
return agent2;
}
}
class MyAgent2 extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): Promise<net.Socket> {
gotCallback2 = true;
assert.equal(opts.secureEndpoint, true);
return tls.connect(opts);
}
}
const agent1 = new MyAgent1();
const agent2 = new MyAgent2();
const server = https.createServer(sslOptions, (req, res) => {
gotReq = true;
res.setHeader('X-Foo', 'bar');
res.setHeader('X-Url', req.url || '/');
res.end();
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
try {
const res = await req(`https://127.0.0.1:${port}/foo`, {
agent: agent1,
rejectUnauthorized: false,
});
assert.equal('bar', res.headers['x-foo']);
assert.equal('/foo', res.headers['x-url']);
assert(gotReq);
assert(gotCallback1);
assert(gotCallback2);
} finally {
server.close();
}
});
it('should not send a port number for the default port', async () => {
let reqCount = 0;
class MyAgent extends Agent {
connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
): net.Socket {
assert(opts.secureEndpoint === true);
assert.equal(agent.defaultPort, port);
assert.equal(opts.port, port);
return tls.connect(opts);
}
}
const agent = new MyAgent();
const server = https.createServer(sslOptions, (req, res) => {
reqCount++;
res.end(JSON.stringify(req.headers));
});
await listen(server);
const addr = server.address();
if (!addr || typeof addr === 'string') {
throw new Error('Server did not bind to a port');
}
const { port } = addr;
agent.defaultPort = port;
try {
const res = await req(`https://127.0.0.1:${port}/foo`, {
agent,
rejectUnauthorized: false,
});
const body = await json(res);
assert.equal(body.host, '127.0.0.1');
assert.equal(reqCount, 1);
} finally {
server.close();
}
});
it('should support `keepAlive: true`', async () => {
let gotReq = false;
let connectCount = 0;
class MyAgent extends Agent {
async connect(
_req: http.ClientRequest,
opts: AgentConnectOpts
) {
connectCount++;
assert(opts.secureEndpoint === true);
return tls.connect(opts);
}
}
const agent = new MyAgent({ keepAlive: true });
const server = https.createServer(sslOptions, (req, res) => {
gotReq = true;
res.end();
});
const addr = (await listen(server)) as URL;
try {
const res = await req(new URL('/foo', addr), {
agent,
rejectUnauthorized: false,
});
assert(gotReq);
expect(connectCount).toEqual(1);
expect(res.headers.connection).toEqual('keep-alive');
res.resume();
const s1 = res.socket;
await once(s1, 'free');
const res2 = await req(new URL('/another', addr), {
agent,
rejectUnauthorized: false,
});
expect(connectCount).toEqual(1);
expect(res2.headers.connection).toEqual('keep-alive');
assert(res2.socket === s1);
res2.resume();
await once(res2.socket, 'free');
} finally {
agent.destroy();
server.close();
}
});
});
});