Merge pull request #498 from splitio/async-flagsets-api

updated api commons, split and telemetry classes

Author: chillaq

splitio/api/commons.py

@@ -6,7 +6,7 @@
 class FetchOptions(object):
     """Fetch Options object."""
 
-    def __init__(self, cache_control_headers=False, change_number=None):
+    def __init__(self, cache_control_headers=False, change_number=None, sets=None):
         """
         Class constructor.
 
@@ -15,9 +15,13 @@ def __init__(self, cache_control_headers=False, change_number=None):
 
         :param change_number: ChangeNumber to use for bypassing CDN in request.
         :type change_number: int
+
+        :param sets: list of flag sets
+        :type sets: list
         """
         self._cache_control_headers = cache_control_headers
         self._change_number = change_number
+        self._sets = sets
 
     @property
     def cache_control_headers(self):
@@ -29,12 +33,19 @@ def change_number(self):
         """Return change number."""
         return self._change_number
 
+    @property
+    def sets(self):
+        """Return sets."""
+        return self._sets
+
     def __eq__(self, other):
         """Match between other options."""
         if self._cache_control_headers != other._cache_control_headers:
             return False
         if self._change_number != other._change_number:
             return False
+        if self._sets != other._sets:
+            return False
         return True
 
 
@@ -62,4 +73,6 @@ def build_fetch(change_number, fetch_options, metadata):
         extra_headers[_CACHE_CONTROL] = _CACHE_CONTROL_NO_CACHE
     if fetch_options.change_number is not None:
         query['till'] = fetch_options.change_number
+    if fetch_options.sets is not None:
+        query['sets'] = fetch_options.sets
     return query, extra_headers

splitio/api/splits.py

@@ -57,6 +57,8 @@ def fetch_splits(self, change_number, fetch_options):
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
             else:
+                if response.status_code == 414:
+                    _LOGGER.error('Error fetching feature flags; the amount of flag sets provided are too big, causing uri length error.')
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
             _LOGGER.error('Error fetching feature flags because an exception was raised by the HTTPClient')
@@ -109,6 +111,8 @@ async def fetch_splits(self, change_number, fetch_options):
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
             else:
+                if response.status_code == 414:
+                    _LOGGER.error('Error fetching feature flags; the amount of flag sets provided are too big, causing uri length error.')
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
             _LOGGER.error('Error fetching feature flags because an exception was raised by the HTTPClient')

splitio/api/telemetry.py

@@ -71,7 +71,6 @@ def record_init(self, configs):
                 'Error posting init config because an exception was raised by the HTTPClient'
             )
             _LOGGER.debug('Error: ', exc_info=True)
-            raise APIException('Init config data not flushed properly.') from exc
 
     def record_stats(self, stats):
         """
@@ -162,7 +161,6 @@ async def record_init(self, configs):
                 'Error posting init config because an exception was raised by the HTTPClient'
             )
             _LOGGER.debug('Error: ', exc_info=True)
-            raise APIException('Init config data not flushed properly.') from exc
 
     async def record_stats(self, stats):
         """

tests/api/test_splits_api.py

@@ -16,18 +16,18 @@ def test_fetch_split_changes(self, mocker):
         httpclient.get.return_value = client.HttpResponse(200, '{"prop1": "value1"}', {})
         split_api = splits.SplitsAPI(httpclient, 'some_api_key', SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
 
-        response = split_api.fetch_splits(123, FetchOptions())
+        response = split_api.fetch_splits(123, FetchOptions(False, None, 'set1,set2'))
         assert response['prop1'] == 'value1'
         assert httpclient.get.mock_calls == [mocker.call('sdk', 'splitChanges', 'some_api_key',
                                                          extra_headers={
                                                              'SplitSDKVersion': '1.0',
                                                              'SplitSDKMachineIP': '1.2.3.4',
                                                              'SplitSDKMachineName': 'some'
                                                          },
-                                                         query={'since': 123})]
+                                                         query={'since': 123, 'sets': 'set1,set2'})]
 
         httpclient.reset_mock()
-        response = split_api.fetch_splits(123, FetchOptions(True))
+        response = split_api.fetch_splits(123, FetchOptions(True, 123, 'set3'))
         assert response['prop1'] == 'value1'
         assert httpclient.get.mock_calls == [mocker.call('sdk', 'splitChanges', 'some_api_key',
                                                          extra_headers={
@@ -36,7 +36,7 @@ def test_fetch_split_changes(self, mocker):
                                                              'SplitSDKMachineName': 'some',
                                                              'Cache-Control': 'no-cache'
                                                          },
-                                                         query={'since': 123})]
+                                                         query={'since': 123, 'till': 123, 'sets': 'set3'})]
 
         httpclient.reset_mock()
         response = split_api.fetch_splits(123, FetchOptions(True, 123))
@@ -82,7 +82,7 @@ async def get(verb, url, key, query, extra_headers):
             return client.HttpResponse(200, '{"prop1": "value1"}', {})
         httpclient.get = get
 
-        response = await split_api.fetch_splits(123, FetchOptions())
+        response = await split_api.fetch_splits(123, FetchOptions(False, None, 'set1,set2'))
         assert response['prop1'] == 'value1'
         assert self.verb == 'sdk'
         assert self.url == 'splitChanges'
@@ -92,10 +92,10 @@ async def get(verb, url, key, query, extra_headers):
             'SplitSDKMachineIP': '1.2.3.4',
             'SplitSDKMachineName': 'some'
         }
-        assert self.query == {'since': 123}
+        assert self.query == {'since': 123, 'sets': 'set1,set2'}
 
         httpclient.reset_mock()
-        response = await split_api.fetch_splits(123, FetchOptions(True))
+        response = await split_api.fetch_splits(123, FetchOptions(True, 123, 'set3'))
         assert response['prop1'] == 'value1'
         assert self.verb == 'sdk'
         assert self.url == 'splitChanges'
@@ -106,7 +106,7 @@ async def get(verb, url, key, query, extra_headers):
             'SplitSDKMachineName': 'some',
             'Cache-Control': 'no-cache'
         }
-        assert self.query == {'since': 123}
+        assert self.query == {'since': 123, 'till': 123, 'sets': 'set3'}
 
         httpclient.reset_mock()
         response = await split_api.fetch_splits(123, FetchOptions(True, 123))

tests/api/test_telemetry_api.py

@@ -82,15 +82,6 @@ def test_record_init(self, mocker):
         # validate key-value args (body)
         assert call_made[2]['body'] == uniques
 
-        httpclient.reset_mock()
-        def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message')
-        httpclient.post.side_effect = raise_exception
-        with pytest.raises(APIException) as exc_info:
-            response = telemetry_api.record_init(uniques)
-            assert exc_info.type == APIException
-            assert exc_info.value.message == 'some_message'
-
     def test_record_stats(self, mocker):
         """Test telemetry posting stats."""
         httpclient = mocker.Mock(spec=client.HttpClient)
@@ -224,15 +215,6 @@ async def post(verb, url, key, body, extra_headers):
         # validate key-value args (body)
         assert self.body == uniques
 
-        httpclient.reset_mock()
-        def raise_exception(*args, **kwargs):
-            raise client.HttpClientException('some_message')
-        httpclient.post = raise_exception
-        with pytest.raises(APIException) as exc_info:
-            response = await telemetry_api.record_init(uniques)
-            assert exc_info.type == APIException
-            assert exc_info.value.message == 'some_message'
-
     @pytest.mark.asyncio
     async def test_record_stats(self, mocker):
         """Test telemetry posting unique keys."""