/
agents.ts
218 lines (191 loc) · 6.74 KB
/
agents.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
/*!
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as assert from 'assert';
import {describe, it, afterEach} from 'mocha';
import * as http from 'http';
import * as https from 'https';
import * as sinon from 'sinon';
import {getAgent, pool} from '../src/agents';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const HttpProxyAgent = require('http-proxy-agent');
// eslint-disable-next-line @typescript-eslint/no-var-requires
const HttpsProxyAgent = require('https-proxy-agent');
describe('agents', () => {
const httpUri = 'http://example.com';
const httpsUri = 'https://example.com';
const sandbox = sinon.createSandbox();
afterEach(() => {
sandbox.restore();
pool.clear();
});
describe('getAgent', () => {
const defaultOptions = {uri: httpUri};
it('should return undefined by default', () => {
const agent = getAgent(httpUri, defaultOptions);
assert.strictEqual(agent, undefined);
});
describe('proxy', () => {
const envVars = [
'http_proxy',
'https_proxy',
'HTTP_PROXY',
'HTTPS_PROXY',
];
describe('http', () => {
const uri = httpUri;
const proxy = 'http://hello.there:8080';
const proxyExpected = {
hostname: 'hello.there',
port: 8080,
protocol: 'http:',
};
it('should respect the proxy option', () => {
const options = Object.assign({proxy}, defaultOptions);
const agent = getAgent(uri, options);
assert(agent instanceof HttpProxyAgent);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const {proxy: proxyActual}: any = agent!;
assert.strictEqual(proxyActual.protocol, proxyExpected.protocol);
assert.strictEqual(proxyActual.hostname, proxyExpected.hostname);
assert.strictEqual(proxyActual.port, proxyExpected.port);
});
envVars.forEach(envVar => {
it(`should respect the ${envVar} env var`, () => {
process.env[envVar] = proxy;
const agent = getAgent(uri, defaultOptions);
assert(agent instanceof HttpProxyAgent);
delete process.env[envVar];
});
});
});
describe('https', () => {
const uri = httpsUri;
const proxy = 'https://hello.there:8080';
const proxyExpected = {
hostname: 'hello.there',
port: 8080,
protocol: 'https:',
};
it('should respect the proxy option', () => {
const options = Object.assign({proxy}, defaultOptions);
const agent = getAgent(uri, options);
assert(agent instanceof HttpsProxyAgent);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const {proxy: proxyActual}: any = agent!;
assert.strictEqual(proxyActual.protocol, proxyExpected.protocol);
assert.strictEqual(proxyActual.hostname, proxyExpected.hostname);
assert.strictEqual(proxyActual.port, proxyExpected.port);
});
envVars.forEach(envVar => {
it(`should respect the ${envVar} env var`, () => {
process.env[envVar] = proxy;
const agent = getAgent(uri, defaultOptions);
assert(agent instanceof HttpsProxyAgent);
delete process.env[envVar];
});
});
});
});
describe('forever', () => {
describe('http', () => {
const uri = httpUri;
const options = Object.assign({forever: true}, defaultOptions);
it('should return an http Agent', () => {
const agent = getAgent(uri, options)!;
assert(agent instanceof http.Agent);
});
it('should cache the agent', () => {
const agent1 = getAgent(uri, options);
const agent2 = getAgent(uri, options);
assert.strictEqual(agent1, agent2);
});
});
describe('https', () => {
const uri = httpsUri;
const options = Object.assign({forever: true}, defaultOptions);
it('should return an http Agent', () => {
const agent = getAgent(uri, options)!;
assert(agent instanceof https.Agent);
});
it('should cache the agent', () => {
const agent1 = getAgent(uri, options);
const agent2 = getAgent(uri, options);
assert.strictEqual(agent1, agent2);
});
});
});
describe('pool', () => {
describe('http', () => {
const uri = httpUri;
it('should pass AgentOptions from pool config when providing agent', () => {
const options = Object.assign(
{
forever: true,
pool: {
maxSockets: 1000,
},
},
defaultOptions
);
const agent = getAgent(uri, options);
assert.strictEqual(agent!.maxSockets, 1000);
});
it('should not set global AgentOptions from only pool config', () => {
const options = Object.assign(
{
pool: {
maxSockets: 1000,
},
},
defaultOptions
);
const agent = getAgent(uri, options);
assert.strictEqual(agent, undefined);
assert.notStrictEqual(http.globalAgent.maxSockets, 1000);
});
});
describe('https', () => {
const uri = httpsUri;
it('should pass AgentOptions from pool config when providing agent', () => {
const options = Object.assign(
{
forever: true,
pool: {
maxSockets: 1000,
},
},
defaultOptions
);
const agent = getAgent(uri, options);
assert.strictEqual(agent!.maxSockets, 1000);
});
it('should not set global AgentOptions from only pool config', () => {
const options = Object.assign(
{
pool: {
maxSockets: 1000,
},
},
defaultOptions
);
const agent = getAgent(uri, options);
assert.strictEqual(agent, undefined);
assert.notStrictEqual(https.globalAgent.maxSockets, 1000);
});
});
});
});
});