Merge pull request #121 from splitio/feature/oneSingleQueue

[SDKS]: Single Queue With Input Validation

Author: mmelograno

CHANGES.txt

@@ -1,6 +1,7 @@
 6.3.0 ()
  - Stored Impressions in Queue.
  - Fixed bug related to Machine Name and Machine IP.
+ - Updated Input Validation.
 6.2.2 (Dec 17, 2018)
  - Fixed issue on selecting db for Sentinel.
 6.2.1 (Dec 6, 2018)

README.md

@@ -28,8 +28,8 @@ Split has built and maintains a SDKs for:
 * PHP [Github](https://github.com/splitio/php-client) [Docs](http://docs.split.io/docs/php-sdk-overview)
 * Python [Github](https://github.com/splitio/python-client) [Docs](http://docs.split.io/docs/python-sdk-overview)
 * GO [Github](https://github.com/splitio/go-client) [Docs](http://docs.split.io/docs/go-sdk-overview)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/v1/docs/android-sdk-overview)
-* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/v1/docs/ios-sdk-overview)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://docs.split.io/docs/android-sdk-overview)
+* IOS [Github](https://github.com/splitio/ios-client) [Docs](https://docs.split.io/docs/ios-sdk-overview)
 
 For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

splitio/api.py

@@ -5,6 +5,7 @@
 import requests
 import json
 
+from splitio.exceptions import ForbiddenException
 from splitio.config import SDK_API_BASE_URL, EVENTS_API_BASE_URL, SDK_VERSION
 
 _SEGMENT_CHANGES_URL_TEMPLATE = '{base_url}/segmentChanges/{segment_name}/'
@@ -92,7 +93,10 @@ def _build_headers(self):
         return headers
 
     def _logHttpError(self, response):
-        if response.status_code < 200 or response.status_code >= 400:
+        if response.status_code == requests.codes.forbidden:
+            raise ForbiddenException()
+
+        if response.status_code < requests.codes.ok or response.status_code >= requests.codes.bad:
             respJson = response.json()
             if 'message' in respJson:
                 self._logger.error(

splitio/clients.py

@@ -81,18 +81,16 @@ def get_treatment(self, key, feature, attributes=None):
         :rtype: str
         """
         if self._destroyed:
-            self._logger.warning("Client has already been destroyed, returning CONTROL")
+            self._logger.error("Client has already been destroyed - no calls possible")
             return CONTROL
 
         start = int(round(time.time() * 1000))
 
-        matching_key, bucketing_key = input_validator.validate_key(key)
+        matching_key, bucketing_key = input_validator.validate_key(key, 'get_treatment')
         feature = input_validator.validate_feature_name(feature)
 
-        if (matching_key is None and bucketing_key is None) or feature is None:
-            impression = self._build_impression(matching_key, feature, CONTROL, Label.EXCEPTION,
-                                                0, bucketing_key, start)
-            self._record_stats(impression, start, SDK_GET_TREATMENT)
+        if (matching_key is None and bucketing_key is None) or feature is None or\
+           input_validator.validate_attributes(attributes, 'get_treatment') is False:
             return CONTROL
 
         try:
@@ -151,52 +149,50 @@ def get_treatments(self, key, features, attributes=None):
         :rtype: dict
         """
         if self._destroyed:
-            self._logger.warning("Client has already been destroyed, returning None")
-            return None
+            self._logger.error("Client has already been destroyed - no calls possible")
+            return input_validator.generate_control_treatments(features)
 
         start = int(round(time.time() * 1000))
 
+        matching_key, bucketing_key = input_validator.validate_key(key, 'get_treatments')
+        if matching_key is None and bucketing_key is None:
+            return input_validator.generate_control_treatments(features)
+
+        if input_validator.validate_attributes(attributes, 'get_treatment') is False:
+            return input_validator.generate_control_treatments(features)
+
         features = input_validator.validate_features_get_treatments(features)
         if features is None:
-            return None
-
-        matching_key, bucketing_key = input_validator.validate_key(key)
+            return {}
 
         bulk_impressions = []
         treatments = {}
 
-        if matching_key is None and bucketing_key is None:
-            for feature in features:
-                impression = self._build_impression(matching_key, feature, CONTROL, Label.EXCEPTION,
-                                                    0, bucketing_key, start)
-                bulk_impressions.insert(impression)
+        for feature in features:
+            try:
+                treatment = self._evaluator.evaluate_treatment(
+                    feature,
+                    matching_key,
+                    bucketing_key,
+                    attributes
+                )
+
+                impression = self._build_impression(matching_key,
+                                                    feature,
+                                                    treatment['treatment'],
+                                                    treatment['impression']['label'],
+                                                    treatment['impression']['change_number'],
+                                                    bucketing_key,
+                                                    start)
+
+                bulk_impressions.append(impression)
+                treatments[feature] = treatment['treatment']
+
+            except Exception:
+                self._logger.exception('get_treatments: An exception occured when evaluating '
+                                       'feature ' + feature + ' returning CONTROL.')
                 treatments[feature] = CONTROL
-        else:
-            for feature in features:
-                try:
-                    treatment = self._evaluator.evaluate_treatment(
-                        feature,
-                        matching_key,
-                        bucketing_key,
-                        attributes
-                    )
-
-                    impression = self._build_impression(matching_key,
-                                                        feature,
-                                                        treatment['treatment'],
-                                                        treatment['impression']['label'],
-                                                        treatment['impression']['change_number'],
-                                                        bucketing_key,
-                                                        start)
-
-                    bulk_impressions.append(impression)
-                    treatments[feature] = treatment['treatment']
-
-                except Exception:
-                    self._logger.exception('get_treatments: An exception occured when evaluating '
-                                           'feature ' + feature + ' returning CONTROL.')
-                    treatments[feature] = CONTROL
-                    continue
+                continue
 
             # Register impressions
             try:
@@ -268,6 +264,10 @@ def track(self, key, traffic_type, event_type, value=None):
 
         :rtype: bool
         """
+        if self._destroyed:
+            self._logger.error("Client has already been destroyed - no calls possible")
+            return False
+
         key = input_validator.validate_track_key(key)
         event_type = input_validator.validate_event_type(event_type)
         traffic_type = input_validator.validate_traffic_type(traffic_type)

splitio/exceptions.py

@@ -4,3 +4,7 @@
 
 class TimeoutException(Exception):
     pass
+
+
+class ForbiddenException(Exception):
+    pass

splitio/factories.py

@@ -6,6 +6,7 @@
 from splitio.managers import RedisSplitManager, SelfRefreshingSplitManager, \
     LocalhostSplitManager, UWSGISplitManager
 from splitio.impressions import ImpressionListenerWrapper
+from . import input_validator
 
 import logging
 
@@ -36,9 +37,7 @@ class MainSplitFactory(SplitFactory):
     def __init__(self, api_key, **kwargs):
         super(MainSplitFactory, self).__init__()
 
-        config = dict()
-        if 'config' in kwargs:
-            config = kwargs['config']
+        config = kwargs.get('config', {})
 
         labels_enabled = config.get('labelsEnabled', True)
 
@@ -109,6 +108,13 @@ def get_factory(api_key, **kwargs):
     :param kwargs:
     :return:
     """
+    config = kwargs.get('config', {})
+    sdk_api_base_url = kwargs.get('sdk_api_base_url', None)
+    if 'redisHost' not in config and 'redisSentinels' not in config \
+       and input_validator.validate_factory_instantiation(api_key, config, sdk_api_base_url) \
+       is False:
+        return None
+
     if api_key == 'localhost':
         return LocalhostSplitFactory(**kwargs)
     else: