Merge pull request #36 from cloudblue/retry-on-timeout

retry on timeouts

Author: marcserrat

connect/client/mixins.py

@@ -11,7 +11,7 @@
 
 from httpx import HTTPError
 
-from requests.exceptions import RequestException
+from requests.exceptions import RequestException, Timeout
 
 from connect.client.exceptions import ClientError
 
@@ -70,16 +70,21 @@ def execute(self, method, path, **kwargs):
             status_code = self.response.status_code if self.response is not None else None
             raise ClientError(status_code=status_code, **api_error) from re
 
-    def _execute_http_call(self, method, url, kwargs):
+    def _execute_http_call(self, method, url, kwargs):  # noqa: CCR001
         retry_count = 0
         while True:
             if self.logger:
                 self.logger.log_request(method, url, kwargs)
-
-            self.response = requests.request(method, url, **kwargs)
-
-            if self.logger:
-                self.logger.log_response(self.response)
+            try:
+                self.response = requests.request(method, url, **kwargs)
+                if self.logger:
+                    self.logger.log_response(self.response)
+            except Timeout:
+                if retry_count < self.max_retries:
+                    retry_count += 1
+                    time.sleep(1)
+                    continue
+                raise
 
             if (  # pragma: no branch
                 self.response.status_code >= 500

tests/client/test_fluent.py

@@ -4,7 +4,7 @@
 
 import responses
 
-from requests import RequestException
+from requests import RequestException, Timeout
 
 from connect.client.constants import CONNECT_ENDPOINT_URL, CONNECT_SPECS_URL
 from connect.client.exceptions import ClientError
@@ -205,18 +205,27 @@ def test_execute_non_json_response(mocked_responses):
     assert result == b'This is a non json response.'
 
 
-def test_execute_retries(mocked_responses):
+@pytest.mark.parametrize(
+    'mock_config',
+    (
+        {'status': 500},
+        {'status': 501},
+        {'status': 502},
+        {'body': Timeout()},
+    ),
+)
+def test_execute_retries(mocked_responses, mock_config):
     expected = [{'id': i} for i in range(10)]
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=502,
+        **mock_config,
     )
 
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=502,
+        **mock_config,
     )
 
     mocked_responses.add(
@@ -245,26 +254,31 @@ def test_execute_retries(mocked_responses):
 
 
 @pytest.mark.parametrize(
-    'code',
-    [500, 501, 502],
+    'mock_config',
+    (
+        {'status': 500},
+        {'status': 501},
+        {'status': 502},
+        {'body': Timeout()},
+    ),
 )
-def test_execute_max_retries_exceeded(code, mocked_responses):
+def test_execute_max_retries_exceeded(mocked_responses, mock_config):
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=code,
+        **mock_config,
     )
 
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=code,
+        **mock_config,
     )
 
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=code,
+        **mock_config,
     )
 
     c = ConnectClient(
@@ -327,7 +341,7 @@ def test_execute_with_kwargs(mocked_responses):
     assert 'X-Custom-Header' in headers and headers['X-Custom-Header'] == 'value'
 
 
-def test_execute_with_overwritten_timeout(mocked_responses, mocker):
+def test_execute_with_overwritten_timeout(mocker):
     http_call = mocker.patch(
         'connect.client.mixins.SyncClientMixin._execute_http_call',
         side_effect=RequestException(),
@@ -354,7 +368,7 @@ def test_execute_with_overwritten_timeout(mocked_responses, mocker):
     )
 
 
-def test_execute_with_default_timeout(mocked_responses, mocker):
+def test_execute_with_default_timeout(mocker):
     http_call = mocker.patch(
         'connect.client.mixins.SyncClientMixin._execute_http_call',
         side_effect=RequestException(),