[py] Add debug logging for urllib response data (#10568)

symonk · diemol · web-flow · commit 86ee77273eba · 2022-04-20T22:37:17.000+02:00
* debug urllib response status, decoded data and headers

* use `python3.7` compliant f-strings

Co-authored-by: Diego Molina &lt;diemol@users.noreply.github.com&gt;
diff --git a/py/selenium/webdriver/remote/remote_connection.py b/py/selenium/webdriver/remote/remote_connection.py
@@ -347,34 +347,34 @@ def _request(self, method, url, body=None):
         LOGGER.debug(f"{method} {url} {body}")
         parsed_url = parse.urlparse(url)
         headers = self.get_remote_connection_headers(parsed_url, self.keep_alive)
-        resp = None
-        if body and method != 'POST' and method != 'PUT':
+        response = None
+        if body and method not in ("POST", "PUT"):
             body = None
 
         if self.keep_alive:
-            resp = self._conn.request(method, url, body=body, headers=headers)
-            statuscode = resp.status
+            response = self._conn.request(method, url, body=body, headers=headers)
+            statuscode = response.status
         else:
             conn = self._get_connection_manager()
             with conn as http:
-                resp = http.request(method, url, body=body, headers=headers)
-
-            statuscode = resp.status
-            if not hasattr(resp, 'getheader'):
-                if hasattr(resp.headers, 'getheader'):
-                    resp.getheader = lambda x: resp.headers.getheader(x)
-                elif hasattr(resp.headers, 'get'):
-                    resp.getheader = lambda x: resp.headers.get(x)
-
-        data = resp.data.decode('UTF-8')
+                response = http.request(method, url, body=body, headers=headers)
+
+            statuscode = response.status
+            if not hasattr(response, 'getheader'):
+                if hasattr(response.headers, 'getheader'):
+                    response.getheader = lambda x: response.headers.getheader(x)
+                elif hasattr(response.headers, 'get'):
+                    response.getheader = lambda x: response.headers.get(x)
+        data = response.data.decode('UTF-8')
+        LOGGER.debug(f"Remote response: status={response.status} | data={data} | headers={response.headers}")
         try:
             if 300 <= statuscode < 304:
-                return self._request('GET', resp.getheader('location'))
+                return self._request('GET', response.getheader('location'))
             if 399 < statuscode <= 500:
                 return {'status': statuscode, 'value': data}
             content_type = []
-            if resp.getheader('Content-Type'):
-                content_type = resp.getheader('Content-Type').split(';')
+            if response.getheader('Content-Type'):
+                content_type = response.getheader('Content-Type').split(';')
             if not any([x.startswith('image/png') for x in content_type]):
 
                 try:
@@ -386,7 +386,7 @@ def _request(self, method, url, body=None):
                         status = ErrorCode.UNKNOWN_ERROR
                     return {'status': status, 'value': data.strip()}
 
-                # Some of the drivers incorrectly return a response
+                # Some drivers incorrectly return a response
                 # with no 'value' field when they should return null.
                 if 'value' not in data:
                     data['value'] = None
@@ -396,7 +396,7 @@ def _request(self, method, url, body=None):
                 return data
         finally:
             LOGGER.debug("Finished Request")
-            resp.close()
+            response.close()
 
     def close(self):
         """
