transient error handling (404, 403) (#40)

Author: kp-cat

configcatclient/configfetcher.py

@@ -33,10 +33,11 @@ class Status(IntEnum):
 
 
 class FetchResponse(object):
-    def __init__(self, status, entry, error=None):
+    def __init__(self, status, entry, error=None, is_transient_error=False):
         self._status = status
         self.entry = entry
         self.error = error
+        self.is_transient_error = is_transient_error
 
     def is_fetched(self):
         """Gets whether a new configuration value was fetched or not.
@@ -65,8 +66,8 @@ def not_modified(cls):
         return FetchResponse(Status.NotModified, ConfigEntry.empty)
 
     @classmethod
-    def failure(cls, error):
-        return FetchResponse(Status.Failure, ConfigEntry.empty, error)
+    def failure(cls, error, is_transient_error):
+        return FetchResponse(Status.Failure, ConfigEntry.empty, error, is_transient_error)
 
 
 class ConfigFetcher(object):
@@ -169,19 +170,23 @@ def _fetch(self, etag):
                 return FetchResponse.success(ConfigEntry(config, response_etag, get_utc_now_seconds_since_epoch()))
             elif response.status_code == 304:
                 return FetchResponse.not_modified()
+            elif response.status_code in [404, 403]:
+                error = 'Double-check your SDK Key at https://app.configcat.com/sdkkey. ' \
+                        'Received unexpected response: %s' % str(response)
+                self.log.error(error)
+                return FetchResponse.failure(error, False)
             else:
                 raise (requests.HTTPError(response))
         except HTTPError as e:
-            error = 'Double-check your SDK Key at https://app.configcat.com/sdkkey. ' \
-                    'Received unexpected response: %s' % str(e.response)
+            error = 'Unexpected HTTP response was received: %s' % str(e.response)
             self.log.error(error)
-            return FetchResponse.failure(error)
+            return FetchResponse.failure(error, True)
         except Timeout:
             error = 'Request timed out. Timeout values: [connect: {}s, read: {}s]'.format(
-                self._config_fetcher.get_connect_timeout(), self._config_fetcher.get_read_timeout())
+                self.get_connect_timeout(), self.get_read_timeout())
             self.log.error(error)
-            return FetchResponse.failure(error)
+            return FetchResponse.failure(error, True)
         except Exception as e:
             error = 'Exception occurred during fetching: ' + str(e)
             self.log.error(error)
-            return FetchResponse.failure(error)
+            return FetchResponse.failure(error, True)

configcatclient/configservice.py

@@ -132,7 +132,8 @@ def _fetch_if_older(self, time, prefer_cache=False):
                     self._cached_entry = response.entry
                     self._write_cache(response.entry)
                     self._hooks.invoke_on_config_changed(response.entry.config.get(FEATURE_FLAGS))
-                elif response.is_not_modified():
+                elif (response.is_not_modified() or not response.is_transient_error) and \
+                        not self._cached_entry.is_empty():
                     self._cached_entry.fetch_time = utils.get_utc_now_seconds_since_epoch()
                     self._write_cache(self._cached_entry)
 

configcatclient/version.py

@@ -1 +1 @@
-CONFIGCATCLIENT_VERSION = "6.0.3"
+CONFIGCATCLIENT_VERSION = "7.0.0"

configcatclienttests/mocks.py

@@ -97,7 +97,7 @@ def __init__(self, error):
         self._error = error
 
     def get_configuration(self, etag=''):
-        return FetchResponse.failure(self._error)
+        return FetchResponse.failure(self._error, True)
 
 
 class ConfigFetcherWaitMock(ConfigFetcher):

configcatclienttests/test_configcatclient.py

@@ -1,12 +1,15 @@
+import datetime
 import logging
 import unittest
 import requests
 
 from configcatclient import ConfigCatClientException
 from configcatclient.configcatclient import ConfigCatClient
+from configcatclient.constants import VALUE, COMPARATOR, COMPARISON_ATTRIBUTE, COMPARISON_VALUE
 from configcatclient.user import User
 from configcatclient.configcatoptions import ConfigCatOptions
 from configcatclient.pollingmode import PollingMode
+from configcatclient.utils import get_utc_now
 from configcatclienttests.mocks import ConfigCacheMock, TEST_OBJECT
 
 # Python2/Python3 support
@@ -143,6 +146,37 @@ def details_by_key(all_details, key):
 
         client.close()
 
+    def test_get_value_details(self):
+        with mock.patch.object(requests, 'get') as request_get:
+            response_mock = Mock()
+            request_get.return_value = response_mock
+            response_mock.json.return_value = TEST_OBJECT
+            response_mock.status_code = 200
+            response_mock.headers = {}
+
+            client = ConfigCatClient.get('test', ConfigCatOptions(polling_mode=PollingMode.manual_poll()))
+            client.force_refresh()
+
+            user = User("[email protected]")
+            details = client.get_value_details('testStringKey', '', user)
+
+            self.assertEqual('fake1', details.value)
+            self.assertEqual('testStringKey', details.key)
+            self.assertEqual('id1', details.variation_id)
+            self.assertFalse(details.is_default_value)
+            self.assertIsNone(details.error)
+            self.assertIsNone(details.matched_evaluation_percentage_rule)
+            self.assertEqual('fake1', details.matched_evaluation_rule[VALUE])
+            self.assertEqual(2, details.matched_evaluation_rule[COMPARATOR])
+            self.assertEqual('Identifier', details.matched_evaluation_rule[COMPARISON_ATTRIBUTE])
+            self.assertEqual('@test1.com', details.matched_evaluation_rule[COMPARISON_VALUE])
+            self.assertEqual(str(user), str(details.user))
+            now = get_utc_now()
+            self.assertGreaterEqual(now, details.fetch_time)
+            self.assertLessEqual(now, details.fetch_time + + datetime.timedelta(seconds=1))
+
+            client.close()
+
     def test_cache_key(self):
         client1 = ConfigCatClient.get('test1', ConfigCatOptions(polling_mode=PollingMode.manual_poll(),
                                                                 config_cache=ConfigCacheMock()))

configcatclienttests/test_configfetcher.py

@@ -68,6 +68,7 @@ def test_http_error(self):
             fetcher = ConfigFetcher(sdk_key='', log=log, mode='m')
             fetch_response = fetcher.get_configuration()
             self.assertTrue(fetch_response.is_failed())
+            self.assertTrue(fetch_response.is_transient_error)
             self.assertTrue(fetch_response.entry.is_empty())
 
     def test_exception(self):
@@ -76,6 +77,35 @@ def test_exception(self):
             fetcher = ConfigFetcher(sdk_key='', log=log, mode='m')
             fetch_response = fetcher.get_configuration()
             self.assertTrue(fetch_response.is_failed())
+            self.assertTrue(fetch_response.is_transient_error)
+            self.assertTrue(fetch_response.entry.is_empty())
+
+    def test_404_failed_fetch_response(self):
+        with mock.patch.object(requests, 'get') as request_get:
+            response_mock = Mock()
+            request_get.return_value = response_mock
+            response_mock.json.return_value = {}
+            response_mock.status_code = 404
+            response_mock.headers = {}
+            fetcher = ConfigFetcher(sdk_key='', log=log, mode='m')
+            fetch_response = fetcher.get_configuration()
+            self.assertTrue(fetch_response.is_failed())
+            self.assertFalse(fetch_response.is_transient_error)
+            self.assertFalse(fetch_response.is_fetched())
+            self.assertTrue(fetch_response.entry.is_empty())
+
+    def test_403_failed_fetch_response(self):
+        with mock.patch.object(requests, 'get') as request_get:
+            response_mock = Mock()
+            request_get.return_value = response_mock
+            response_mock.json.return_value = {}
+            response_mock.status_code = 403
+            response_mock.headers = {}
+            fetcher = ConfigFetcher(sdk_key='', log=log, mode='m')
+            fetch_response = fetcher.get_configuration()
+            self.assertTrue(fetch_response.is_failed())
+            self.assertFalse(fetch_response.is_transient_error)
+            self.assertFalse(fetch_response.is_fetched())
             self.assertTrue(fetch_response.entry.is_empty())
 
     def test_server_side_etag(self):

configcatclienttests/test_hooks.py

@@ -118,6 +118,32 @@ def test_evaluation(self):
 
             client.close()
 
+    def test_callback_exception(self):
+        with mock.patch.object(requests, 'get') as request_get:
+            response_mock = Mock()
+            request_get.return_value = response_mock
+            response_mock.json.return_value = TEST_OBJECT
+            response_mock.status_code = 200
+            response_mock.headers = {}
+
+            hook_callbacks = HookCallbacks()
+            hooks = Hooks(
+                on_client_ready=hook_callbacks.callback_exception,
+                on_config_changed=hook_callbacks.callback_exception,
+                on_flag_evaluated=hook_callbacks.callback_exception,
+                on_error=hook_callbacks.callback_exception
+            )
+            client = ConfigCatClient.get('test', ConfigCatOptions(polling_mode=PollingMode.manual_poll(),
+                                                                  hooks=hooks))
+
+            client.force_refresh()
+
+            value = client.get_value('testStringKey', '')
+            self.assertEqual('testValue', value)
+
+            value = client.get_value('', 'default')
+            self.assertEqual('default', value)
+
 
 if __name__ == '__main__':
     unittest.main()

configcatclienttests/test_rollout.py

@@ -44,7 +44,7 @@ def _test_matrix(self, file_path, sdk_key, type):
         custom_key = header.split(';')[3]
         content.pop(0)
 
-        client = configcatclient.create_client(sdk_key)
+        client = configcatclient.get(sdk_key)
         errors = ''
         for line in content:
             user_descriptor = line.rstrip().split(';')
@@ -81,10 +81,10 @@ def _test_matrix(self, file_path, sdk_key, type):
         client.close()
 
     def test_wrong_user_object(self):
-        client = configcatclient.create_client('PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A')
+        client = configcatclient.get('PKDVCLf-Hq-h-kCzMp-L7Q/psuH7BGHoUmdONrzzUOY7A')
         setting_value = client.get_value('stringContainsDogDefaultCat', 'Lion', {'Email': '[email protected]'})
         self.assertEqual('Cat', setting_value)
-        client.close()
+        configcatclient.close_all()
 
 
 '''

setup.py

@@ -6,7 +6,7 @@ def parse_requirements(filename):
     return [line for line in lines if line]
 
 
-configcatclient_version = '6.0.3'
+configcatclient_version = '7.0.0'
 
 requirements = parse_requirements('requirements.txt')