Remove the HTTPTransport from the client building ...

Adding a blank transport removes our auto-discovery of the
proxy configurations. Removing it for the base level tests
appears to allow for automatic proxy configuration discovery

Author: jschaff

biothings_client/client/asynchronous.py

@@ -107,8 +107,7 @@ async def _build_http_client(self, cache_db: Union[str, Path] = None) -> None:
         :return: None
         """
         if not self.http_client_setup:
-            http_transport = httpx.AsyncHTTPTransport()
-            self.http_client = httpx.AsyncClient(transport=http_transport)
+            self.http_client = httpx.AsyncClient()
             self.http_client_setup = True
             self.http_cache_client_setup = False
 

biothings_client/client/base.py

@@ -105,8 +105,7 @@ def _build_http_client(self, cache_db: Union[str, Path] = None) -> None:
         to set the values for the http_client property
         """
         if not self.http_client_setup:
-            http_transport = httpx.HTTPTransport()
-            self.http_client = httpx.Client(transport=http_transport)
+            self.http_client = httpx.Client()
             self.http_client_setup = True
             self.http_cache_client_setup = False
 

tests/conftest.py

@@ -2,6 +2,8 @@
 Fixtures for the biothings_client testing
 """
 
+import os
+
 import pytest
 
 from biothings_client import get_client, get_async_client
@@ -111,3 +113,12 @@ def async_geneset_client() -> AsyncMyGenesetInfo:
     client = "geneset"
     geneset_client = get_async_client(client)
     return geneset_client
+
+
+@pytest.fixture(scope="function")
+def mock_client_proxy_configuration() -> None:
+    os.environ["HTTP_PROXY"] = "http://fakehttpproxyhost:6374"
+    os.environ["HTTPS_PROXY"] = "http://fakehttpsproxyhost:6375"
+    yield
+    os.environ.pop("HTTP_PROXY", None)
+    os.environ.pop("HTTPS_PROXY", None)

tests/test_async.py

@@ -4,6 +4,7 @@
 
 from typing import List
 
+import httpx
 import pytest
 
 import biothings_client
@@ -82,3 +83,35 @@ async def test_url_protocol(client_name: str):
     # Transform back to HTTPS
     client_instance.use_https()
     client_instance.url.startswith(https_protocol)
+
+
+@pytest.mark.asyncio
+async def test_async_client_proxy_discovery(mock_client_proxy_configuration):
+    """
+    Tests for verifying that we properly auto-discover the
+    proxy configuration from the environment using the built-in
+    methods provided by HTTPX
+
+    Brought to light by user issues on VPN
+    https://github.com/biothings/mygene.py/issues/26#issuecomment-2588065562
+    """
+    client_name = "gene"
+    gene_client = biothings_client.get_async_client(client_name)
+    await gene_client._build_http_client()
+    for url_pattern, http_transport in gene_client.http_client._mounts.items():
+        assert isinstance(url_pattern, httpx._utils.URLPattern)
+        assert isinstance(http_transport, httpx.AsyncHTTPTransport)
+
+        if url_pattern.pattern == "https://":
+            proxy_url = http_transport._pool._proxy_url
+            assert proxy_url.scheme == b"http"
+            assert proxy_url.host == b"fakehttpsproxyhost"
+            assert proxy_url.port == 6375
+            assert proxy_url.target == b"/"
+
+        elif url_pattern.pattern == "http://":
+            proxy_url = http_transport._pool._proxy_url
+            assert proxy_url.scheme == b"http"
+            assert proxy_url.host == b"fakehttpproxyhost"
+            assert proxy_url.port == 6374
+            assert proxy_url.target == b"/"

tests/test_sync.py

@@ -4,6 +4,7 @@
 
 from typing import List
 
+import httpx
 import pytest
 
 import biothings_client
@@ -79,3 +80,34 @@ def test_url_protocol(client_name: str):
     # Transform back to HTTPS
     client_instance.use_https()
     client_instance.url.startswith(https_protocol)
+
+
+def test_client_proxy_discovery(mock_client_proxy_configuration):
+    """
+    Tests for verifying that we properly auto-discover the
+    proxy configuration from the environment using the built-in
+    methods provided by HTTPX
+
+    Brought to light by user issues on VPN
+    https://github.com/biothings/mygene.py/issues/26#issuecomment-2588065562
+    """
+    client_name = "gene"
+    gene_client = biothings_client.get_client(client_name)
+    gene_client._build_http_client()
+    for url_pattern, http_transport in gene_client.http_client._mounts.items():
+        assert isinstance(url_pattern, httpx._utils.URLPattern)
+        assert isinstance(http_transport, httpx.HTTPTransport)
+
+        if url_pattern.pattern == "https://":
+            proxy_url = http_transport._pool._proxy_url
+            assert proxy_url.scheme == b"http"
+            assert proxy_url.host == b"fakehttpsproxyhost"
+            assert proxy_url.port == 6375
+            assert proxy_url.target == b"/"
+
+        elif url_pattern.pattern == "http://":
+            proxy_url = http_transport._pool._proxy_url
+            assert proxy_url.scheme == b"http"
+            assert proxy_url.host == b"fakehttpproxyhost"
+            assert proxy_url.port == 6374
+            assert proxy_url.target == b"/"