Merge pull request #551 from splitio/imp-toggle-rename-field

Imp toggle rename field

Author: chillaq

splitio/client/client.py

@@ -23,7 +23,7 @@ class ClientBase(object):  # pylint: disable=too-many-instance-attributes
             'label': Label.EXCEPTION,
             'change_number': None,
         },
-        'track': True
+        'impressions_disabled': False
     }
 
     _NON_READY_EVAL_RESULT = {
@@ -33,7 +33,7 @@ class ClientBase(object):  # pylint: disable=too-many-instance-attributes
             'label': Label.NOT_READY,
             'change_number': None
         },
-        'track': True
+        'impressions_disabled': False
     }
 
     def __init__(self, factory, recorder, labels_enabled=True):
@@ -126,7 +126,7 @@ def _build_impression(self, key, bucketing, feature, result):
                 change_number=result['impression']['change_number'],
                 bucketing_key=bucketing,
                 time=utctime_ms()),
-                track=result['track'])
+                disabled=result['impressions_disabled'])
 
     def _build_impressions(self, key, bucketing, results):
         """Build an impression based on evaluation data & it's result."""

splitio/engine/evaluator.py

@@ -68,7 +68,7 @@ def eval_with_context(self, key, bucketing, feature_name, attrs, ctx):
                 'label': label,
                 'change_number': _change_number
             },
-            'track': feature.trackImpressions if feature else None
+            'impressions_disabled': feature.impressionsDisabled if feature else None
         }
 
     def _treatment_for_flag(self, flag, key, bucketing, attributes, ctx):

splitio/engine/impressions/impressions.py

@@ -43,7 +43,7 @@ def process_impressions(self, impressions_decorated):
         for_counter_all = []
         for_unique_keys_tracker_all = []
         for impression_decorated, att in impressions_decorated:
-            if not impression_decorated.track:
+            if impression_decorated.disabled:
                 for_log, for_listener, for_counter, for_unique_keys_tracker = self._none_strategy.process_impressions([(impression_decorated.Impression, att)])
             else:
                 for_log, for_listener, for_counter, for_unique_keys_tracker = self._strategy.process_impressions([(impression_decorated.Impression, att)])

splitio/models/impressions.py

@@ -20,7 +20,7 @@
     'ImpressionDecorated',
     [
         'Impression',
-        'track'
+        'disabled'
     ]
 )
 

splitio/models/splits.py

@@ -10,7 +10,7 @@
 
 SplitView = namedtuple(
     'SplitView',
-    ['name', 'traffic_type', 'killed', 'treatments', 'change_number', 'configs', 'default_treatment', 'sets', 'trackImpressions']
+    ['name', 'traffic_type', 'killed', 'treatments', 'change_number', 'configs', 'default_treatment', 'sets', 'impressions_disabled']
 )
 
 _DEFAULT_CONDITIONS_TEMPLATE =   {
@@ -74,7 +74,7 @@ def __init__(  # pylint: disable=too-many-arguments
             traffic_allocation_seed=None,
             configurations=None,
             sets=None,
-            trackImpressions=None
+            impressionsDisabled=None
     ):
         """
         Class constructor.
@@ -97,8 +97,8 @@ def __init__(  # pylint: disable=too-many-arguments
         :type traffic_allocation_seed: int
         :pram sets: list of flag sets
         :type sets: list
-        :pram trackImpressions: track impressions flag
-        :type trackImpressions: boolean
+        :pram impressionsDisabled: track impressions flag
+        :type impressionsDisabled: boolean
         """
         self._name = name
         self._seed = seed
@@ -128,7 +128,7 @@ def __init__(  # pylint: disable=too-many-arguments
 
         self._configurations = configurations
         self._sets = set(sets) if sets is not None else set()
-        self._trackImpressions = trackImpressions if trackImpressions is not None else True
+        self._impressionsDisabled = impressionsDisabled if impressionsDisabled is not None else False
 
     @property
     def name(self):
@@ -191,9 +191,9 @@ def sets(self):
         return self._sets
 
     @property
-    def trackImpressions(self):
-        """Return trackImpressions of the split."""
-        return self._trackImpressions
+    def impressionsDisabled(self):
+        """Return impressionsDisabled of the split."""
+        return self._impressionsDisabled
 
     def get_configurations_for(self, treatment):
         """Return the mapping of treatments to configurations."""
@@ -224,7 +224,7 @@ def to_json(self):
             'conditions': [c.to_json() for c in self.conditions],
             'configurations': self._configurations,
             'sets': list(self._sets),
-            'trackImpressions': self._trackImpressions
+            'impressionsDisabled': self._impressionsDisabled
         }
 
     def to_split_view(self):
@@ -243,7 +243,7 @@ def to_split_view(self):
             self._configurations if self._configurations is not None else {},
             self._default_treatment,
             list(self._sets) if self._sets is not None else [],
-            self._trackImpressions
+            self._impressionsDisabled
         )
 
     def local_kill(self, default_treatment, change_number):
@@ -300,5 +300,5 @@ def from_raw(raw_split):
         traffic_allocation_seed=raw_split.get('trafficAllocationSeed'),
         configurations=raw_split.get('configurations'),
         sets=set(raw_split.get('sets')) if raw_split.get('sets') is not None else [],
-        trackImpressions=raw_split.get('trackImpressions') if raw_split.get('trackImpressions') is not None else True
+        impressionsDisabled=raw_split.get('impressionsDisabled') if raw_split.get('impressionsDisabled') is not None else False
     )

tests/client/test_client.py

@@ -17,6 +17,8 @@
     InMemoryImpressionStorageAsync, InMemorySegmentStorageAsync, InMemoryTelemetryStorageAsync, InMemoryEventStorageAsync
 from splitio.models.splits import Split, Status, from_raw
 from splitio.engine.impressions.impressions import Manager as ImpressionManager
+from splitio.engine.impressions.manager import Counter as ImpressionsCounter
+from splitio.engine.impressions.unique_keys_tracker import UniqueKeysTracker, UniqueKeysTrackerAsync
 from splitio.engine.telemetry import TelemetryStorageConsumer, TelemetryStorageProducer, TelemetryStorageProducerAsync
 from splitio.engine.evaluator import Evaluator
 from splitio.recorder.recorder import StandardRecorder, StandardRecorderAsync
@@ -44,7 +46,9 @@ def test_get_treatment(self, mocker):
         mocker.patch('splitio.client.client.get_latency_bucket_index', new=lambda x: 5)
 
         impmanager = ImpressionManager(StrategyDebugMode(), StrategyNoneMode(), telemetry_runtime_producer)
-        recorder = StandardRecorder(impmanager, event_storage, impression_storage, telemetry_producer.get_telemetry_evaluation_producer(), telemetry_producer.get_telemetry_runtime_producer())
+        recorder = StandardRecorder(impmanager, event_storage, impression_storage, telemetry_producer.get_telemetry_evaluation_producer(), telemetry_producer.get_telemetry_runtime_producer(),
+                                    unique_keys_tracker=UniqueKeysTracker(),
+                                    imp_counter=ImpressionsCounter())
         class TelemetrySubmitterMock():
             def synchronize_config(*_):
                 pass
@@ -61,7 +65,9 @@ def synchronize_config(*_):
             telemetry_producer.get_telemetry_init_producer(),
             TelemetrySubmitterMock(),
         )
-
+        ready_property = mocker.PropertyMock()
+        ready_property.return_value = True
+        type(factory).ready = ready_property
         factory.block_until_ready(5)
 
         split_storage.update([from_raw(splits_json['splitChange1_1']['splits'][0])], [], -1)
@@ -74,7 +80,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         _logger = mocker.Mock()
         assert client.get_treatment('some_key', 'SPLIT_2') == 'on'
@@ -85,6 +91,7 @@ def synchronize_config(*_):
         ready_property = mocker.PropertyMock()
         ready_property.return_value = False
         type(factory).ready = ready_property
+       # pytest.set_trace()
         assert client.get_treatment('some_key', 'SPLIT_2', {'some_attribute': 1}) == 'control'
         assert impression_storage.pop_many(100) == [Impression('some_key', 'SPLIT_2', 'control', Label.NOT_READY, None, None, 1000)]
 
@@ -143,7 +150,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         _logger = mocker.Mock()
         client._send_impression_to_listener = mocker.Mock()
@@ -218,7 +225,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -296,7 +303,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -373,7 +380,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -449,7 +456,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,
@@ -530,7 +537,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,
@@ -608,7 +615,7 @@ def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,
@@ -1270,7 +1277,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         _logger = mocker.Mock()
         assert await client.get_treatment('some_key', 'SPLIT_2') == 'on'
@@ -1340,7 +1347,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         _logger = mocker.Mock()
         client._send_impression_to_listener = mocker.Mock()
@@ -1415,7 +1422,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -1493,7 +1500,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -1571,7 +1578,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_2': evaluation,
@@ -1648,7 +1655,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,
@@ -1730,7 +1737,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,
@@ -1812,7 +1819,7 @@ async def synchronize_config(*_):
                 'label': 'some_label',
                 'change_number': 123
             },
-            'track': True
+            'impressions_disabled': False
         }
         client._evaluator.eval_many_with_context.return_value = {
             'SPLIT_1': evaluation,

tests/engine/test_evaluator.py

@@ -52,7 +52,7 @@ def test_evaluate_treatment_ok(self, mocker):
         assert result['impression']['change_number'] == 123
         assert result['impression']['label'] == 'some_label'
         assert mocked_split.get_configurations_for.mock_calls == [mocker.call('on')]
-        assert result['track'] == mocked_split.trackImpressions
+        assert result['impressions_disabled'] == mocked_split.impressionsDisabled
 
 
     def test_evaluate_treatment_ok_no_config(self, mocker):