add NOT READY label

Author: mredolatti

splitio/client/client.py

@@ -85,6 +85,25 @@ def _send_impression_to_listener(self, impression, attributes):
                 )
                 self._logger.debug('Error', exc_info=True)
 
+    def _evaluate_if_ready(self, matching_key, bucketing_key, feature, attributes=None):
+        if not self.ready:
+            return {
+                'treatment': CONTROL,
+                'configurations': None,
+                'impression': {
+                    'label': Label.NOT_READY,
+                    'change_number': None
+                }
+            }
+
+        return self._evaluator.evaluate_treatment(
+            feature,
+            matching_key,
+            bucketing_key,
+            attributes
+        )
+
+
     def get_treatment_with_config(self, key, feature, attributes=None):
         """
         Get the treatment and config for a feature and key, with optional dictionary of attributes.
@@ -120,12 +139,7 @@ def get_treatment_with_config(self, key, feature, attributes=None):
                     or not input_validator.validate_attributes(attributes):
                 return CONTROL, None
 
-            result = self._evaluator.evaluate_treatment(
-                feature,
-                matching_key,
-                bucketing_key,
-                attributes
-            )
+            result = self._evaluate_if_ready(matching_key, bucketing_key, feature, attributes)
 
             impression = self._build_impression(
                 matching_key,
@@ -221,23 +235,17 @@ def get_treatments_with_config(self, key, features, attributes=None):
 
         for feature in features:
             try:
-                treatment = self._evaluator.evaluate_treatment(
-                    feature,
-                    matching_key,
-                    bucketing_key,
-                    attributes
-                )
-
+                result = self._evaluate_if_ready(matching_key, bucketing_key, feature, attributes)
                 impression = self._build_impression(matching_key,
                                                     feature,
-                                                    treatment['treatment'],
-                                                    treatment['impression']['label'],
-                                                    treatment['impression']['change_number'],
+                                                    result['treatment'],
+                                                    result['impression']['label'],
+                                                    result['impression']['change_number'],
                                                     bucketing_key,
                                                     start)
 
                 bulk_impressions.append(impression)
-                treatments[feature] = (treatment['treatment'], treatment['configurations'])
+                treatments[feature] = (result['treatment'], result['configurations'])
 
             except Exception:  #pylint: disable=broad-except
                 self._logger.error('get_treatments: An exception occured when evaluating '

splitio/models/impressions.py

@@ -46,3 +46,8 @@ class Label(object):  #pylint: disable=too-few-public-methods
     # Treatment: control
     # Label: exception
     EXCEPTION = 'exception'
+
+    # Condition: Evaluation requested while client not ready
+    # Treatment: control
+    # Label: not ready
+    NOT_READY = 'not ready'

tests/client/test_client.py

@@ -6,7 +6,7 @@
 from splitio.client.client import Client
 from splitio.client.factory import SplitFactory
 from splitio.engine.evaluator import Evaluator
-from splitio.models.impressions import Impression
+from splitio.models.impressions import Impression, Label
 from splitio.models.events import Event
 from splitio.storage import EventStorage, ImpressionStorage, SegmentStorage, SplitStorage, \
     TelemetryStorage
@@ -67,7 +67,18 @@ def _get_storage_mock(name):
             None
         ) in client._send_impression_to_listener.mock_calls
 
+        # Test with client not ready
+        ready_property = mocker.PropertyMock()
+        ready_property.return_value = False
+        type(factory).ready = ready_property
+        impression_storage.put.reset_mock()
+        assert client.get_treatment('some_key', 'some_feature', {'some_attribute': 1}) == 'control'
+        assert mocker.call(
+            [Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY)]
+        ) in impression_storage.put.mock_calls
+
         # Test with exception:
+        ready_property.return_value = True
         split_storage.get_change_number.return_value = -1
         def _raise(*_):
             raise Exception('something')
@@ -76,7 +87,7 @@ def _raise(*_):
         assert mocker.call(
             [Impression('some_key', 'some_feature', 'control', 'exception', -1, None, 1000)]
         ) in impression_storage.put.mock_calls
-        assert len(telemetry_storage.inc_latency.mock_calls) == 2
+        assert len(telemetry_storage.inc_latency.mock_calls) == 3
 
     def test_get_treatment_with_config(self, mocker):
         """Test get_treatment execution paths."""
@@ -131,7 +142,18 @@ def _get_storage_mock(name):
             None
         ) in client._send_impression_to_listener.mock_calls
 
+        # Test with client not ready
+        ready_property = mocker.PropertyMock()
+        ready_property.return_value = False
+        type(factory).ready = ready_property
+        impression_storage.put.reset_mock()
+        assert client.get_treatment_with_config('some_key', 'some_feature', {'some_attribute': 1}) == ('control', None)
+        assert mocker.call(
+            [Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY)]
+        ) in impression_storage.put.mock_calls
+
         # Test with exception:
+        ready_property.return_value = True
         split_storage.get_change_number.return_value = -1
         def _raise(*_):
             raise Exception('something')
@@ -140,7 +162,7 @@ def _raise(*_):
         assert mocker.call(
             [Impression('some_key', 'some_feature', 'control', 'exception', -1, None, 1000)]
         ) in impression_storage.put.mock_calls
-        assert len(telemetry_storage.inc_latency.mock_calls) == 2
+        assert len(telemetry_storage.inc_latency.mock_calls) == 3
 
     def test_get_treatments(self, mocker):
         """Test get_treatment execution paths."""
@@ -196,13 +218,24 @@ def _get_storage_mock(name):
             None
         ) in client._send_impression_to_listener.mock_calls
 
+        # Test with client not ready
+        ready_property = mocker.PropertyMock()
+        ready_property.return_value = False
+        type(factory).ready = ready_property
+        impression_storage.put.reset_mock()
+        assert client.get_treatments('some_key', ['some_feature'], {'some_attribute': 1}) == {'some_feature': 'control'}
+        assert mocker.call(
+            [Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY)]
+        ) in impression_storage.put.mock_calls
+
         # Test with exception:
+        ready_property.return_value = True
         split_storage.get_change_number.return_value = -1
         def _raise(*_):
             raise Exception('something')
         client._evaluator.evaluate_treatment.side_effect = _raise
         assert client.get_treatments('key', ['f1', 'f2']) == {'f1': 'control', 'f2': 'control'}
-        assert len(telemetry_storage.inc_latency.mock_calls) == 1
+        assert len(telemetry_storage.inc_latency.mock_calls) == 2
 
     def test_get_treatments_with_config(self, mocker):
         """Test get_treatment execution paths."""
@@ -261,7 +294,18 @@ def _get_storage_mock(name):
             None
         ) in client._send_impression_to_listener.mock_calls
 
+        # Test with client not ready
+        ready_property = mocker.PropertyMock()
+        ready_property.return_value = False
+        type(factory).ready = ready_property
+        impression_storage.put.reset_mock()
+        assert client.get_treatments_with_config('some_key', ['some_feature'], {'some_attribute': 1}) == {'some_feature': ('control', None)}
+        assert mocker.call(
+            [Impression('some_key', 'some_feature', 'control', Label.NOT_READY, mocker.ANY, mocker.ANY, mocker.ANY)]
+        ) in impression_storage.put.mock_calls
+
         # Test with exception:
+        ready_property.return_value = True
         split_storage.get_change_number.return_value = -1
         def _raise(*_):
             raise Exception('something')
@@ -270,7 +314,7 @@ def _raise(*_):
             'f1': ('control', None),
             'f2': ('control', None)
         }
-        assert len(telemetry_storage.inc_latency.mock_calls) == 1
+        assert len(telemetry_storage.inc_latency.mock_calls) == 2
 
     def test_destroy(self, mocker):
         """Test that destroy/destroyed calls are forwarded to the factory."""

tests/client/test_input_validator.py

@@ -671,7 +671,6 @@ def test_track(self, mocker):
         assert client._logger.error.mock_calls == []
         assert client._logger.warning.mock_calls == []
 
-
     def test_get_treatments(self, mocker):
         """Test getTreatments() method."""
         split_mock = mocker.Mock(spec=Split)