Skip to content

Commit e5c5b9e

Browse files
author
Avishagp
committed
fix: no_proxy issue
1 parent e5dee92 commit e5c5b9e

File tree

3 files changed

+162
-42
lines changed

3 files changed

+162
-42
lines changed

‎lib/needle.js

+14-39
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,20 @@
55
// MIT Licensed
66
//////////////////////////////////////////
77

8-
var fs = require('fs'),
9-
http = require('http'),
10-
https = require('https'),
11-
url = require('url'),
12-
stream = require('stream'),
13-
debug = require('debug')('needle'),
14-
stringify = require('./querystring').build,
15-
multipart = require('./multipart'),
16-
auth = require('./auth'),
17-
cookies = require('./cookies'),
18-
parsers = require('./parsers'),
19-
decoder = require('./decoder');
8+
var fs = require('fs'),
9+
http = require('http'),
10+
https = require('https'),
11+
url = require('url'),
12+
stream = require('stream'),
13+
debug = require('debug')('needle'),
14+
stringify = require('./querystring').build,
15+
multipart = require('./multipart'),
16+
auth = require('./auth'),
17+
cookies = require('./cookies'),
18+
parsers = require('./parsers'),
19+
decoder = require('./decoder'),
20+
should_proxy_to = require('./proxy').should_proxy_to,
21+
get_env_var = require('./proxy').get_env_var;
2022

2123
//////////////////////////////////////////
2224
// variabilia
@@ -127,17 +129,6 @@ Object.keys(aliased.options).map(function(k) {
127129
//////////////////////////////////////////
128130
// helpers
129131

130-
function get_env_var(keys, try_lower) {
131-
var val, i = -1, env = process.env;
132-
while (!val && i < keys.length-1) {
133-
val = env[keys[++i]];
134-
if (!val && try_lower) {
135-
val = env[keys[i].toLowerCase()];
136-
}
137-
}
138-
return val;
139-
}
140-
141132
function keys_by_type(type) {
142133
return Object.keys(defaults).map(function(el) {
143134
if (defaults[el] !== null && defaults[el].constructor == type)
@@ -190,22 +181,6 @@ function host_and_ports_match(url1, url2) {
190181
== String(b.port || (b.protocol == 'https:' ? 443 : 80));
191182
}
192183

193-
// returns false if a no_proxy host matches given url
194-
function should_proxy_to(url) {
195-
var no_proxy = get_env_var(['NO_PROXY'], true);
196-
if (!no_proxy) return true;
197-
198-
var host, hosts = no_proxy.split(',');
199-
for (var i in hosts) {
200-
host = hosts[i];
201-
if (host_and_ports_match(host, url)) {
202-
return false;
203-
}
204-
}
205-
206-
return true;
207-
}
208-
209184
function pump_streams(streams, cb) {
210185
if (stream.pipeline)
211186
return stream.pipeline.apply(null, streams.concat(cb));

‎lib/proxy.js

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
function get_env_var(keys, try_lower) {
2+
var val, i = -1, env = process.env;
3+
while (!val && i < keys.length-1) {
4+
val = env[keys[++i]];
5+
if (!val && try_lower) {
6+
val = env[keys[i].toLowerCase()];
7+
}
8+
}
9+
return val;
10+
}
11+
12+
// returns false if a no_proxy host matches given url
13+
function should_proxy_to(uri) {
14+
const noProxy = get_env_var(["NO_PROXY"], true);
15+
if (!noProxy) {
16+
return true;
17+
}
18+
19+
var urlMatchedNoProxyPattern = false;
20+
const requestUrl = new URL(uri);
21+
const patternList = noProxy.split(/[\s,]+/);
22+
23+
// iterate over all NO_PROXY patterns and determine whether the given URL matches any of them
24+
for (const pattern of patternList) {
25+
if(pattern.trim().length == 0) {
26+
continue;
27+
}
28+
29+
// replace leading dot by asterisk, escape dots and finally replace asterisk by .*
30+
const preparedPattern = pattern.replace(/^\./, "*").replace(/[.]/g, '\\$&').replace(/\*/g, '.*')
31+
const regex = new RegExp(preparedPattern)
32+
const isRegexExists = uri.match(regex);
33+
if (isRegexExists) {
34+
const matches = (isRegexExists.length > 0);
35+
if (matches) {
36+
// hostname + port of the request URL match a given NO_PROXY pattern
37+
urlMatchedNoProxyPattern = true;
38+
break;
39+
}
40+
}
41+
}
42+
43+
return !urlMatchedNoProxyPattern;
44+
}
45+
46+
module.exports.should_proxy_to = should_proxy_to;
47+
module.exports.get_env_var = get_env_var;

‎test/proxy_spec.js

+101-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ var helpers = require('./helpers'),
22
should = require('should'),
33
sinon = require('sinon'),
44
http = require('http'),
5-
needle = require('./../');
5+
needle = require('./../'),
6+
should_proxy_to = require('./../lib/proxy').should_proxy_to;
67

78
var port = 7707;
89
var url = 'localhost:' + port;
@@ -137,9 +138,9 @@ describe('proxy option', function() {
137138
}))
138139
})
139140

140-
it('proxies request if matching host in list but different port', function(done) {
141+
it('does not proxy request if matching host in list and just has a different port', function(done) {
141142
process.env.NO_PROXY = 'localhost';
142-
send_request({ proxy: nonexisting_host + ':123/done' }, proxied(nonexisting_host, '123', function() {
143+
send_request({ proxy: nonexisting_host + ':123/done' }, not_proxied(function() {
143144
delete process.env.NO_PROXY;
144145
done();
145146
}))
@@ -152,6 +153,103 @@ describe('proxy option', function() {
152153
done();
153154
}))
154155
})
156+
157+
describe('should_proxy_to()', function() {
158+
159+
const noProxy = ".ic1.mycorp,localhost,127.0.0.1,*.mycorp.org";
160+
const noProxyWithPorts = " ,.mycorp.org:1234,.ic1.mycorp,localhost,127.0.0.1";
161+
const URI = "http://registry.random.opr.mycorp.org";
162+
const URIWithPort = "http://registry.random.opr.mycorp.org:9874";
163+
const URIWithPort1234 = "http://registry.random.opr.mycorp.org:1234";
164+
const URIlocalhost = "http://localhost";
165+
const URIip = "http://127.0.0.1";
166+
167+
it("shall return true if NO_PROXY is undefined", function(done) {
168+
process.env.NO_PROXY = undefined;
169+
should_proxy_to(URI).should.true()
170+
delete process.env.NO_PROXY;
171+
done();
172+
});
173+
174+
it("shall return true if NO_PROXY is empty", function(done) {
175+
process.env.NO_PROXY = "";
176+
should_proxy_to(URI).should.true()
177+
delete process.env.NO_PROXY;
178+
done();
179+
});
180+
181+
it("shall return false if NO_PROXY is a wildcard", function(done) {
182+
process.env.NO_PROXY = "*";
183+
should_proxy_to(URI).should.false()
184+
delete process.env.NO_PROXY;
185+
done();
186+
});
187+
188+
it("shall return true if the host matches and the ports don't (URI doesn't have port specified)", function(done) {
189+
process.env.NO_PROXY = noProxyWithPorts;
190+
should_proxy_to(URI).should.true()
191+
delete process.env.NO_PROXY;
192+
done();
193+
});
194+
195+
it("shall return true if the host matches and the ports don't (both have a port specified but just different values)", function(done) {
196+
process.env.NO_PROXY = noProxyWithPorts;
197+
should_proxy_to(URIWithPort).should.true()
198+
delete process.env.NO_PROXY;
199+
done();
200+
});
201+
202+
it("shall return false if the host matches and the ports don't (no_proxy pattern doesn't have a port)", function(done) {
203+
process.env.NO_PROXY = noProxy;
204+
should_proxy_to(URIWithPort).should.false()
205+
delete process.env.NO_PROXY;
206+
done();
207+
});
208+
209+
it("shall return false if host matches", function(done) {
210+
process.env.NO_PROXY = noProxy;
211+
should_proxy_to(URI).should.false()
212+
delete process.env.NO_PROXY;
213+
done();
214+
});
215+
216+
it("shall return false if the host and port matches", function(done) {
217+
process.env.NO_PROXY = noProxyWithPorts;
218+
should_proxy_to(URIWithPort1234).should.false()
219+
delete process.env.NO_PROXY;
220+
done();
221+
});
222+
223+
it("shall return false if the host matches (localhost)", function(done) {
224+
process.env.NO_PROXY = noProxy;
225+
should_proxy_to(URIlocalhost).should.false()
226+
delete process.env.NO_PROXY;
227+
done();
228+
});
229+
230+
it("shall return false if the host matches (ip)", function(done) {
231+
process.env.NO_PROXY = noProxy;
232+
should_proxy_to(URIip).should.false()
233+
delete process.env.NO_PROXY;
234+
done();
235+
});
236+
237+
it("shall return false if the host matches (ip)", function(done) {
238+
process.env.NO_PROXY = noProxy.replace(/,g/, " ");
239+
should_proxy_to(URIip).should.false()
240+
delete process.env.NO_PROXY;
241+
done();
242+
});
243+
244+
it("shall return false if the host matches (ip)", function(done) {
245+
process.env.NO_PROXY = noProxy.replace(/,g/, " ");
246+
should_proxy_to(URIip).should.false()
247+
delete process.env.NO_PROXY;
248+
done();
249+
});
250+
251+
})
252+
155253
})
156254

157255
describe('and proxy url contains user:pass', function() {

0 commit comments

Comments
 (0)