Merge pull request #456 from splitio/flagsets-client-client

Added flagset support in client, updated client.config and models.tel…

Author: chillaq

splitio/client/client.py

@@ -6,7 +6,7 @@
 from splitio.models.impressions import Impression, Label
 from splitio.models.events import Event, EventWrapper
 from splitio.models.telemetry import get_latency_bucket_index, MethodExceptionsAndLatencies
-from splitio.client import input_validator
+from splitio.client import input_validator, config
 from splitio.util.time import get_current_epoch_time_ms, utctime_ms
 
 _LOGGER = logging.getLogger(__name__)
@@ -309,6 +309,132 @@ def get_treatments(self, key, feature_flags, attributes=None):
                                              MethodExceptionsAndLatencies.TREATMENTS)
         return {feature_flag: result[0] for (feature_flag, result) in with_config.items()}
 
+    def get_treatments_by_flag_set(self, key, flag_set, attributes=None):
+        """
+        Get treatments for feature flags that contain given flag set.
+
+        This method never raises an exception. If there's a problem, the appropriate log message
+        will be generated and the method will return the CONTROL treatment.
+
+        :param key: The key for which to get the treatment
+        :type key: str
+        :param flag_set: flag set
+        :type flag_sets: str
+        :param attributes: An optional dictionary of attributes
+        :type attributes: dict
+
+        :return: Dictionary with the result of all the feature flags provided
+        :rtype: dict
+        """
+        return self._get_treatments_by_flag_sets( key, [flag_set], MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SET, attributes)
+
+    def get_treatments_by_flag_sets(self, key, flag_sets, attributes=None):
+        """
+        Get treatments for feature flags that contain given flag sets.
+
+        This method never raises an exception. If there's a problem, the appropriate log message
+        will be generated and the method will return the CONTROL treatment.
+
+        :param key: The key for which to get the treatment
+        :type key: str
+        :param flag_sets: list of flag sets
+        :type flag_sets: list
+        :param attributes: An optional dictionary of attributes
+        :type attributes: dict
+
+        :return: Dictionary with the result of all the feature flags provided
+        :rtype: dict
+        """
+        return self._get_treatments_by_flag_sets( key, flag_sets, MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SETS, attributes)
+
+    def get_treatments_with_config_by_flag_set(self, key, flag_set, attributes=None):
+        """
+        Get treatments for feature flags that contain given flag set.
+
+        This method never raises an exception. If there's a problem, the appropriate log message
+        will be generated and the method will return the CONTROL treatment.
+
+        :param key: The key for which to get the treatment
+        :type key: str
+        :param flag_set: flag set
+        :type flag_sets: str
+        :param attributes: An optional dictionary of attributes
+        :type attributes: dict
+
+        :return: Dictionary with the result of all the feature flags provided
+        :rtype: dict
+        """
+        return self._get_treatments_by_flag_sets( key, [flag_set], MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SET, attributes)
+
+    def get_treatments_with_config_by_flag_sets(self, key, flag_sets, attributes=None):
+        """
+        Get treatments for feature flags that contain given flag set.
+
+        This method never raises an exception. If there's a problem, the appropriate log message
+        will be generated and the method will return the CONTROL treatment.
+
+        :param key: The key for which to get the treatment
+        :type key: str
+        :param flag_set: flag set
+        :type flag_sets: str
+        :param attributes: An optional dictionary of attributes
+        :type attributes: dict
+
+        :return: Dictionary with the result of all the feature flags provided
+        :rtype: dict
+        """
+        return self._get_treatments_by_flag_sets( key, flag_sets, MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS, attributes)
+
+    def _get_treatments_by_flag_sets(self, key, flag_sets, method, attributes=None):
+        """
+        Get treatments for feature flags that contain given flag sets.
+
+        This method never raises an exception. If there's a problem, the appropriate log message
+        will be generated and the method will return the CONTROL treatment.
+
+        :param key: The key for which to get the treatment
+        :type key: str
+        :param flag_sets: list of flag sets
+        :type flag_sets: list
+        :param method: Treatment by flag set method flavor
+        :type method: splitio.models.telemetry.MethodExceptionsAndLatencies
+        :param attributes: An optional dictionary of attributes
+        :type attributes: dict
+
+        :return: Dictionary with the result of all the feature flags provided
+        :rtype: dict
+        """
+        feature_flags_names = self._get_feature_flag_names_by_flag_sets(flag_sets)
+        if feature_flags_names == []:
+            _LOGGER.warning("No valid Flag set or no feature flags found for evaluating treatments")
+            return {}
+
+        if 'config' in method.value:
+            return self._make_evaluations(key, feature_flags_names, attributes, method.value,
+                                      method)
+
+        with_config = self._make_evaluations(key, feature_flags_names, attributes, method.value,
+                                             method)
+        return {feature_flag: result[0] for (feature_flag, result) in with_config.items()}
+
+
+    def _get_feature_flag_names_by_flag_sets(self, flag_sets):
+        """
+        Sanitize given flag sets and return list of feature flag names associated with them
+
+        :param flag_sets: list of flag sets
+        :type flag_sets: list
+
+        :return: list of feature flag names
+        :rtype: list
+        """
+        sanitized_flag_sets = config.sanitize_flag_sets(flag_sets)
+        feature_flags = []
+        [feature_flags.extend(self._split_storage.get_feature_flags_by_set(flag_set)) for flag_set in sanitized_flag_sets]
+        feature_flags_names = []
+        [feature_flags_names.append(feature_flag) for feature_flag in feature_flags]
+        return feature_flags_names
+
     def _build_impression(  # pylint: disable=too-many-arguments
             self,
             matching_key,

splitio/client/config.py

@@ -120,7 +120,7 @@ def _sanitize_impressions_mode(storage_type, mode, refresh_rate=None):
     return mode, refresh_rate
 
 
-def _sanitize_flag_sets(flag_sets):
+def sanitize_flag_sets(flag_sets):
     """
     Check supplied flag sets list
 
@@ -130,8 +130,15 @@ def _sanitize_flag_sets(flag_sets):
     :returns: Sanitized and sorted flag sets
     :rtype: list[str]
     """
+    if not isinstance(flag_sets, list):
+        _LOGGER.warning("SDK config: FlagSets config parameters type should be list object, parameter is discarded")
+        return []
+
     sanitized_flag_sets = set()
     for flag_set in flag_sets:
+        if not isinstance(flag_set, str):
+            _LOGGER.warning("SDK config: Flag Set name %s should be str object, this flag set is discarded" % (flag_set))
+            continue
         if flag_set != flag_set.strip():
             _LOGGER.warning("SDK config: Flag Set name %s has extra whitespace, trimming" % (flag_set))
             flag_set = flag_set.strip()

splitio/models/telemetry.py

@@ -82,6 +82,10 @@ class MethodExceptionsAndLatencies(Enum):
     TREATMENTS = 'treatments'
     TREATMENT_WITH_CONFIG = 'treatment_with_config'
     TREATMENTS_WITH_CONFIG = 'treatments_with_config'
+    TREATMENTS_BY_FLAG_SET = 'treatments_by_flag_set'
+    TREATMENTS_BY_FLAG_SETS = 'treatments_by_flag_sets'
+    TREATMENTS_WITH_CONFIG_BY_FLAG_SET = 'treatments_with_config_by_flag_set'
+    TREATMENTS_WITH_CONFIG_BY_FLAG_SETS = 'treatments_with_config_by_flag_sets'
     TRACK = 'track'
 
 class LastSynchronizationConstants(Enum):
@@ -166,6 +170,10 @@ def _reset_all(self):
             self._treatments = [0] * MAX_LATENCY_BUCKET_COUNT
             self._treatment_with_config = [0] * MAX_LATENCY_BUCKET_COUNT
             self._treatments_with_config = [0] * MAX_LATENCY_BUCKET_COUNT
+            self._treatments_by_flag_set = [0] * MAX_LATENCY_BUCKET_COUNT
+            self._treatments_by_flag_sets = [0] * MAX_LATENCY_BUCKET_COUNT
+            self._treatments_with_config_by_flag_set = [0] * MAX_LATENCY_BUCKET_COUNT
+            self._treatments_with_config_by_flag_sets = [0] * MAX_LATENCY_BUCKET_COUNT
             self._track = [0] * MAX_LATENCY_BUCKET_COUNT
 
     def add_latency(self, method, latency):
@@ -187,6 +195,14 @@ def add_latency(self, method, latency):
                 self._treatment_with_config[latency_bucket] += 1
             elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG:
                 self._treatments_with_config[latency_bucket] += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SET:
+                self._treatments_by_flag_set[latency_bucket] += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SETS:
+                self._treatments_by_flag_sets[latency_bucket] += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SET:
+                self._treatments_with_config_by_flag_set[latency_bucket] += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS:
+                self._treatments_with_config_by_flag_sets[latency_bucket] += 1
             elif method == MethodExceptionsAndLatencies.TRACK:
                 self._track[latency_bucket] += 1
             else:
@@ -200,10 +216,18 @@ def pop_all(self):
         :rtype: dict
         """
         with self._lock:
-            latencies = {MethodExceptionsAndLatencies.METHOD_LATENCIES.value: {MethodExceptionsAndLatencies.TREATMENT.value: self._treatment, MethodExceptionsAndLatencies.TREATMENTS.value: self._treatments,
-                            MethodExceptionsAndLatencies.TREATMENT_WITH_CONFIG.value: self._treatment_with_config, MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG.value: self._treatments_with_config,
-                            MethodExceptionsAndLatencies.TRACK.value: self._track}
+            latencies = {MethodExceptionsAndLatencies.METHOD_LATENCIES.value: {
+                MethodExceptionsAndLatencies.TREATMENT.value: self._treatment,
+                MethodExceptionsAndLatencies.TREATMENTS.value: self._treatments,
+                MethodExceptionsAndLatencies.TREATMENT_WITH_CONFIG.value: self._treatment_with_config,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG.value: self._treatments_with_config,
+                MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SET.value: self._treatments_by_flag_set,
+                MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SETS.value: self._treatments_by_flag_sets,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SET.value: self._treatments_with_config_by_flag_set,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS.value: self._treatments_with_config_by_flag_sets,
+                MethodExceptionsAndLatencies.TRACK.value: self._track
                 }
+            }
             self._reset_all()
             return latencies
 
@@ -288,6 +312,10 @@ def _reset_all(self):
             self._treatments = 0
             self._treatment_with_config = 0
             self._treatments_with_config = 0
+            self._treatments_by_flag_set = 0
+            self._treatments_by_flag_sets = 0
+            self._treatments_with_config_by_flag_set = 0
+            self._treatments_with_config_by_flag_sets = 0
             self._track = 0
 
     def add_exception(self, method):
@@ -306,6 +334,14 @@ def add_exception(self, method):
                 self._treatment_with_config += 1
             elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG:
                 self._treatments_with_config += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SET:
+                self._treatments_by_flag_set += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SETS:
+                self._treatments_by_flag_sets += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SET:
+                self._treatments_with_config_by_flag_set += 1
+            elif method == MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS:
+                self._treatments_with_config_by_flag_sets += 1
             elif method == MethodExceptionsAndLatencies.TRACK:
                 self._track += 1
             else:
@@ -319,10 +355,18 @@ def pop_all(self):
         :rtype: dict
         """
         with self._lock:
-            exceptions = {MethodExceptionsAndLatencies.METHOD_EXCEPTIONS.value: {MethodExceptionsAndLatencies.TREATMENT.value: self._treatment, MethodExceptionsAndLatencies.TREATMENTS.value: self._treatments,
-                                MethodExceptionsAndLatencies.TREATMENT_WITH_CONFIG.value: self._treatment_with_config, MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG.value: self._treatments_with_config,
-                                MethodExceptionsAndLatencies.TRACK.value: self._track}
+            exceptions = {MethodExceptionsAndLatencies.METHOD_EXCEPTIONS.value: {
+                MethodExceptionsAndLatencies.TREATMENT.value: self._treatment,
+                MethodExceptionsAndLatencies.TREATMENTS.value: self._treatments,
+                MethodExceptionsAndLatencies.TREATMENT_WITH_CONFIG.value: self._treatment_with_config,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG.value: self._treatments_with_config,
+                MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SET.value: self._treatments_by_flag_set,
+                MethodExceptionsAndLatencies.TREATMENTS_BY_FLAG_SETS.value: self._treatments_by_flag_sets,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SET.value: self._treatments_with_config_by_flag_set,
+                MethodExceptionsAndLatencies.TREATMENTS_WITH_CONFIG_BY_FLAG_SETS.value: self._treatments_with_config_by_flag_sets,
+                MethodExceptionsAndLatencies.TRACK.value: self._track
                 }
+            }
             self._reset_all()
             return exceptions