Extending HTTP retries to all methods (#255)

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Unreleased
 
--
+- [fixed] Extending HTTP retries to more HTTP methods like POST and PATCH.
 
 # v2.15.1
 

firebase_admin/_http_client.py

@@ -22,11 +22,13 @@
 from requests.packages.urllib3.util import retry # pylint: disable=import-error
 
 
+_ANY_METHOD = None
+
 # Default retry configuration: Retries once on low-level connection and socket read errors.
 # Retries up to 4 times on HTTP 500 and 503 errors, with exponential backoff. Returns the
 # last response upon exhausting all retries.
 DEFAULT_RETRY_CONFIG = retry.Retry(
-    connect=1, read=1, status=4, status_forcelist=[500, 503],
+    connect=1, read=1, status=4, status_forcelist=[500, 503], method_whitelist=_ANY_METHOD,
     raise_on_status=False, backoff_factor=0.5)
 
 

tests/test_http_client.py

@@ -87,26 +87,37 @@ def _instrument(client, payload, status=200):
 class TestHttpRetry(object):
     """Unit tests for the default HTTP retry configuration."""
 
+    ENTITY_ENCLOSING_METHODS = ['post', 'put', 'patch']
+    ALL_METHODS = ENTITY_ENCLOSING_METHODS + ['get', 'delete', 'head', 'options']
+
     @classmethod
     def setup_class(cls):
         # Turn off exponential backoff for faster execution
         _http_client.DEFAULT_RETRY_CONFIG.backoff_factor = 0
 
-    def test_retry_on_503(self, httpserver):
+    @pytest.mark.parametrize('method', ALL_METHODS)
+    def test_retry_on_503(self, httpserver, method):
         httpserver.serve_content({}, 503)
         client = _http_client.JsonHttpClient(
             credential=testutils.MockGoogleCredential(), base_url=httpserver.url)
+        body = None
+        if method in self.ENTITY_ENCLOSING_METHODS:
+            body = {'key': 'value'}
         with pytest.raises(requests.exceptions.HTTPError) as excinfo:
-            client.request('get', '/')
+            client.request(method, '/', json=body)
         assert excinfo.value.response.status_code == 503
         assert len(httpserver.requests) == 5
 
-    def test_retry_on_500(self, httpserver):
+    @pytest.mark.parametrize('method', ALL_METHODS)
+    def test_retry_on_500(self, httpserver, method):
         httpserver.serve_content({}, 500)
         client = _http_client.JsonHttpClient(
             credential=testutils.MockGoogleCredential(), base_url=httpserver.url)
+        body = None
+        if method in self.ENTITY_ENCLOSING_METHODS:
+            body = {'key': 'value'}
         with pytest.raises(requests.exceptions.HTTPError) as excinfo:
-            client.request('get', '/')
+            client.request(method, '/', json=body)
         assert excinfo.value.response.status_code == 500
         assert len(httpserver.requests) == 5