Support websocket proxies configured via environment variables

CHANGES/4648.bugfix

@@ -0,0 +1 @@
+Fix issue with proxy configured by environment variables for websockets.

CONTRIBUTORS.txt

@@ -175,6 +175,7 @@ Manuel Miranda
 Marat Sharafutdinov
 Marco Paolini
 Mariano Anaya
+Mariusz Masztalerczuk
 Martijn Pieters
 Martin Melka
 Martin Richard

aiohttp/helpers.py

@@ -229,15 +229,16 @@ class ProxyInfo:
 
 def proxies_from_env() -> Dict[str, ProxyInfo]:
     proxy_urls = {k: URL(v) for k, v in getproxies().items()
-                  if k in ('http', 'https')}
+                  if k in ('http', 'https', 'ws', 'wss')}
     netrc_obj = netrc_from_env()
     stripped = {k: strip_auth_from_url(v) for k, v in proxy_urls.items()}
     ret = {}
     for proto, val in stripped.items():
         proxy, auth = val
-        if proxy.scheme == 'https':
+        if proxy.scheme in ('https', 'ws', 'wss'):
             client_logger.warning(
-                "HTTPS proxies %s are not supported, ignoring", proxy)
+                "%s proxies %s are not supported, ignoring",
+                proxy.scheme.upper(), proxy)
             continue
         if netrc_obj and auth is None:
             auth_from_netrc = None

docs/client_advanced.rst

@@ -527,8 +527,8 @@ Contrary to the ``requests`` library, it won't read environment
 variables by default. But you can do so by passing
 ``trust_env=True`` into :class:`aiohttp.ClientSession`
 constructor for extracting proxy configuration from
-*HTTP_PROXY* or *HTTPS_PROXY* *environment variables* (both are case
-insensitive)::
+*HTTP_PROXY*, *HTTPS_PROXY*, *WS_PROXY* or *WSS_PROXY* *environment 
+variables* (both are case insensitive)::
 
    async with aiohttp.ClientSession(trust_env=True) as session:
        async with session.get("http://python.org") as resp:

tests/test_helpers.py

@@ -423,6 +423,15 @@ def test_proxies_from_env_http(mocker) -> None:
     assert ret['http'].proxy_auth is None
 
 
+def test_proxies_from_env_http_proxy_for_ws_proto(mocker) -> None:
+    url = URL('http://aiohttp.io/path')
+    mocker.patch.dict(os.environ, {'ws_proxy': str(url)})
+    ret = helpers.proxies_from_env()
+    assert ret.keys() == {'ws'}
+    assert ret['ws'].proxy == url
+    assert ret['ws'].proxy_auth is None
+
+
 def test_proxies_from_env_http_proxy_for_https_proto(mocker) -> None:
     url = URL('http://aiohttp.io/path')
     mocker.patch.dict(os.environ, {'https_proxy': str(url)})
@@ -431,14 +440,38 @@ def test_proxies_from_env_http_proxy_for_https_proto(mocker) -> None:
     assert ret['https'].proxy == url
     assert ret['https'].proxy_auth is None
 
+def test_proxies_from_env_http_proxy_for_wss_proto(mocker) -> None:
+    url = URL('http://aiohttp.io/path')
+    mocker.patch.dict(os.environ, {'wss_proxy': str(url)})
+    ret = helpers.proxies_from_env()
+    assert ret.keys() == {'wss'}
+    assert ret['wss'].proxy == url
+    assert ret['wss'].proxy_auth is None
+
 
 def test_proxies_from_env_https_proxy_skipped(mocker) -> None:
     url = URL('https://aiohttp.io/path')
     mocker.patch.dict(os.environ, {'https_proxy': str(url)})
     log = mocker.patch('aiohttp.log.client_logger.warning')
     assert helpers.proxies_from_env() == {}
-    log.assert_called_with('HTTPS proxies %s are not supported, ignoring',
-                           URL('https://aiohttp.io/path'))
+    log.assert_called_with('%s proxies %s are not supported, ignoring',
+                           'HTTPS', URL('https://aiohttp.io/path'))
+
+def test_proxies_from_env_ws_proxy_skipped(mocker) -> None:
+    url = URL('ws://aiohttp.io/path')
+    mocker.patch.dict(os.environ, {'wss_proxy': str(url)})
+    log = mocker.patch('aiohttp.log.client_logger.warning')
+    assert helpers.proxies_from_env() == {}
+    log.assert_called_with('%s proxies %s are not supported, ignoring',
+                           'WS', URL('ws://aiohttp.io/path'))
+
+def test_proxies_from_env_wss_proxy_skipped(mocker) -> None:
+    url = URL('wss://aiohttp.io/path')
+    mocker.patch.dict(os.environ, {'wss_proxy': str(url)})
+    log = mocker.patch('aiohttp.log.client_logger.warning')
+    assert helpers.proxies_from_env() == {}
+    log.assert_called_with('%s proxies %s are not supported, ignoring',
+                           'WSS', URL('wss://aiohttp.io/path'))
 
 
 def test_proxies_from_env_http_with_auth(mocker) -> None: