Don't send 'User-Agent' twice if header is binary

sethmlarson · sethmlarson · commit ebe70511b3a9 · 2020-11-11T10:54:32.000-06:00
diff --git a/src/urllib3/connection.py b/src/urllib3/connection.py
@@ -228,7 +228,7 @@ def request(self, method, url, body=None, headers=None):
         else:
             # Avoid modifying the headers passed into .request()
             headers = headers.copy()
-        if "user-agent" not in (k.lower() for k in headers):
+        if "user-agent" not in (six.ensure_str(k.lower()) for k in headers):
             headers["User-Agent"] = _get_default_user_agent()
         super(HTTPConnection, self).request(method, url, body=body, headers=headers)
 
diff --git a/test/with_dummyserver/test_connectionpool.py b/test/with_dummyserver/test_connectionpool.py
@@ -829,6 +829,29 @@ def test_default_user_agent_header(self):
             request_headers = json.loads(r.data.decode("utf8"))
             assert request_headers.get("User-Agent") == custom_ua2
 
+    @pytest.mark.parametrize(
+        "headers",
+        [
+            None,
+            {},
+            {"User-Agent": "key"},
+            {"user-agent": "key"},
+            {b"uSeR-AgEnT": b"key"},
+            {b"user-agent": "key"},
+        ],
+    )
+    @pytest.mark.parametrize("chunked", [True, False])
+    def test_user_agent_header_not_sent_twice(self, headers, chunked):
+        with HTTPConnectionPool(self.host, self.port) as pool:
+            r = pool.request("GET", "/headers", headers=headers, chunked=chunked)
+            request_headers = json.loads(r.data.decode("utf8"))
+
+            if not headers:
+                assert request_headers["User-Agent"].startswith("python-urllib3/")
+                assert "key" not in request_headers["User-Agent"]
+            else:
+                assert request_headers["User-Agent"] == "key"
+
     def test_no_user_agent_header(self):
         """ ConnectionPool can suppress sending a user agent header """
         custom_ua = "I'm not a web scraper, what are you talking about?"
