HoneyryderChuck a78a3f0b7c proxy fixes: allow proxy connection errors to be retriable
when coupled with the retries plugin, the exception is raised inside send_request, which breaks the integration; in order to protect from it, the proxy plugin will protect from proxy connection errors (socket/timeout errors happening until tunnel established) and allow them to be retried, while ignoring other proxy errors; meanwhile, the naming of errors was simplified, and now there's an HTTPX::ProxyError replacing HTTPX::HTTPProxyError (which is a breaking change).
2025-07-18 17:48:23 +01:00

331 lines
12 KiB
Ruby

# frozen_string_literal: true
require "resolv"
module Requests
module Plugins
module Proxy
include ProxyHelper
using HTTPX::URIExtensions
RESOLVER = Resolv::DNS.new
def test_plugin_no_proxy_defined
http = HTTPX.plugin(:proxy)
uri = build_uri("/get")
res = http.with_proxy(uri: []).get(uri)
verify_error_response(res, HTTPX::ProxyError)
end
def test_plugin_http_http_proxy
return unless origin.start_with?("http://")
session = HTTPX.plugin(:proxy, fallback_protocol: "http/1.1").plugin(ProxyResponseDetector).with_proxy(uri: http_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_http_no_proxy
return unless origin.start_with?("http://")
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: http_proxy, no_proxy: [httpbin_no_proxy.host])
# proxy
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
# no proxy
no_proxy_uri = build_uri("/get", httpbin_no_proxy)
no_proxy_response = session.get(no_proxy_uri)
verify_status(no_proxy_response, 200)
verify_body_length(no_proxy_response)
assert !no_proxy_response.proxied?
end
def test_plugin_http_h2_proxy
return unless origin.start_with?("http://")
session = HTTPX.plugin(:proxy, fallback_protocol: "h2").plugin(ProxyResponseDetector).with_proxy(uri: http2_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_https_connect_http1_proxy
# return unless origin.start_with?("https://")
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: http_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
# TODO: uncomment when supporting H2 CONNECT
# def test_plugin_https_connect_h2_proxy
# return unless origin.start_with?("https://")
# session = HTTPX.plugin(:proxy, alpn_protocols: %w[h2]).with_proxy(uri: http2_proxy)
# uri = build_uri("/get")
# response = session.get(uri)
# verify_status(response, 200)
# verify_body_length(response)
# end
def test_plugin_http_next_proxy
session = HTTPX.plugin(SessionWithPool)
.plugin(:proxy)
.plugin(ProxyResponseDetector)
.with_proxy(uri: ["http://unavailable-proxy", *http_proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_http_proxy_auth_options
auth_proxy = URI(http_proxy.first)
return unless auth_proxy.user
user = auth_proxy.user
pass = auth_proxy.password
auth_proxy.user = nil
auth_proxy.password = nil
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(
uri: auth_proxy.to_s,
username: user,
password: pass
)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_http_proxy_auth_error
no_auth_proxy = URI(http_proxy.first)
return unless no_auth_proxy.user
no_auth_proxy.user = nil
no_auth_proxy.password = nil
session = HTTPX.plugin(:proxy).with_proxy(uri: no_auth_proxy.to_s)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 407)
end
def test_plugin_http_proxy_digest_auth
auth_proxy = URI(http_proxy.first)
return unless auth_proxy.user
user = auth_proxy.user
pass = auth_proxy.password
auth_proxy.user = nil
auth_proxy.password = nil
session = HTTPX.plugin(:proxy)
.plugin(ProxyResponseDetector)
.with_proxy_digest_auth(
uri: auth_proxy.to_s,
username: user,
password: pass
)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_http_proxy_connection_coalescing
return unless origin.start_with?("https://")
coalesced_origin = "https://#{ENV["HTTPBIN_COALESCING_HOST"]}"
HTTPX.plugin(:proxy).with_proxy(uri: http_proxy).plugin(SessionWithPool).wrap do |http|
response1 = http.get(origin)
verify_status(response1, 200)
response2 = http.get(coalesced_origin)
verify_status(response2, 200)
# introspection time
connections = http.connections
origins = connections.map(&:origins)
assert origins.any? { |orgs| orgs.sort == [origin, coalesced_origin].sort },
"connections for #{[origin, coalesced_origin]} didn't coalesce (expected connection with both origins (#{origins}))"
unsafe_origin = URI(origin)
unsafe_origin.scheme = "http"
response3 = http.get(unsafe_origin)
verify_status(response3, 200)
# introspection time
connections = http.connections
origins = connections.map(&:origins)
refute origins.any?([origin]),
"connection coalesced inexpectedly (expected connection with both origins (#{origins}))"
end
end if ENV.key?("HTTPBIN_COALESCING_HOST")
def test_plugin_http_proxy_redirect_305
return unless origin.start_with?("http://")
start_test_servlet(ProxyServer) do |proxy|
start_test_servlet(ProxyRedirectorServer, proxy.origin) do |server|
session = HTTPX.plugin(:follow_redirects)
.plugin(:proxy)
.plugin(ProxyResponseDetector)
uri = "#{server.origin}/"
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.body.to_s == proxy.origin.to_s
end
end
end
def test_plugin_socks4_proxy
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: socks4_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_socks4_proxy_ip
proxy = URI(socks4_proxy.first)
proxy.host = Resolv.getaddress(proxy.host)
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: [proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_socks4_proxy_error
proxy = URI(socks4_proxy.first)
proxy.user = nil
session = HTTPX.plugin(:proxy).with_proxy(uri: [proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_error_response(response, HTTPX::Socks4Error)
end
def test_plugin_socks4a_proxy
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: socks4a_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_socks5_proxy
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: socks5_proxy)
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
def test_plugin_socks5_ipv4_proxy
session = HTTPX.plugin(:proxy).plugin(ProxyResponseDetector).with_proxy(uri: socks5_proxy)
uri = URI(build_uri("/get"))
hostname = uri.host
ipv4 = RESOLVER.getresource(hostname, Resolv::DNS::Resource::IN::A).address.to_s
uri.hostname = ipv4
response = session.get(uri, headers: { "host" => uri.authority }, ssl: { hostname: hostname })
verify_status(response, 200)
verify_body_length(response)
assert response.proxied?
end
# TODO: enable when docker-compose supports ipv6 out of the box
# def test_plugin_socks5_ipv6_proxy
# session = HTTPX.plugin(:proxy).with_proxy(uri: socks5_proxy)
# uri = URI(build_uri("/get"))
# hostname = uri.host
# ipv6 = RESOLVER.getresource(hostname, Resolv::DNS::Resource::IN::AAAA).address.to_s
# uri.hostname = ipv6
# response = session.get(uri, headers: { "host" => uri.authority }, ssl: { hostname: hostname })
# verify_status(response, 200)
# verify_body_length(response)
# end
def test_plugin_socks5_proxy_negotiation_error
proxy = URI(socks5_proxy.first)
proxy.password = nil
session = HTTPX.plugin(:proxy).with_proxy(uri: [proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_error_response(response, /negotiation error/)
end
def test_plugin_socks5_proxy_authentication_error
proxy = URI(socks5_proxy.first)
proxy.password = "1"
session = HTTPX.plugin(:proxy).with_proxy(uri: [proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_error_response(response, /authentication error:/)
end
def test_plugin_socks5_proxy_none_error
start_test_servlet(Sock5WithNoneServer) do |server|
proxy = server.origin
session = HTTPX.plugin(:proxy).with_proxy(uri: [proxy])
uri = build_uri("/get")
response = session.get(uri)
verify_error_response(response, /no supported authorization methods/)
end
end
def test_plugin_ssh_proxy
session = HTTPX.plugin(:"proxy/ssh")
.with_proxy(uri: ssh_proxy,
username: "root",
auth_methods: %w[publickey],
host_key: "ssh-rsa",
keys: %w[test/support/ssh/ssh_host_ed25519_key])
uri = build_uri("/get")
response = session.get(uri)
verify_status(response, 200)
verify_body_length(response)
end if ENV.key?("HTTPX_SSH_PROXY") && RUBY_ENGINE == "ruby"
def test_plugin_retries_on_proxy_error
start_test_servlet(Sock5WithNoneServer) do |server|
proxy = server.origin
uri = build_uri("/get")
session = HTTPX.plugin(RequestInspector).plugin(:proxy).plugin(:retries).with_proxy(uri: [proxy])
res = session.get(uri)
verify_error_response(res, /no supported authorization methods/)
assert session.calls == 3, "expect request to be built 3 times (was #{session.calls})"
end
end
end
end
end