Merge pull request #300 from splitio/fix-track-rc-with-pipeline

fix return boolean for client.track when using redis pipeline

Author: chillaq

splitio/recorder/recorder.py

@@ -152,11 +152,18 @@ def record_track_stats(self, event, latency):
         :param event: events tracked
         :type event: splitio.models.events.EventWrapper
         """
-        pipe = self._make_pipe()
-        rc = self._event_sotrage.add_events_to_pipe(event, pipe)
-        self._telemetry_redis_storage.add_latency_to_pipe(MethodExceptionsAndLatencies.TRACK, latency, pipe)
-        result = pipe.execute()
-        if len(result) == 2:
-            self._event_sotrage.expire_keys(result[0], len(event))
-            self._telemetry_redis_storage.expire_latency_keys(result[1], latency)
-        return rc
+        try:
+            pipe = self._make_pipe()
+            self._event_sotrage.add_events_to_pipe(event, pipe)
+            self._telemetry_redis_storage.add_latency_to_pipe(MethodExceptionsAndLatencies.TRACK, latency, pipe)
+            result = pipe.execute()
+            if len(result) == 2:
+                self._event_sotrage.expire_keys(result[0], len(event))
+                self._telemetry_redis_storage.expire_latency_keys(result[1], latency)
+                if result[0] > 0:
+                    return True
+            return False
+        except Exception:  # pylint: disable=broad-except
+            _LOGGER.error('Error recording events')
+            _LOGGER.debug('Error: ', exc_info=True)
+            return False

splitio/version.py

@@ -1 +1 @@
-__version__ = '9.3.0-rc1'
+__version__ = '9.3.0-rc2'

tests/integration/test_client_e2e.py

@@ -90,6 +90,13 @@ def _validate_last_impressions(self, client, *to_validate):
         as_tup_set = set((i.feature_name, i.matching_key, i.treatment) for i in impressions)
         assert as_tup_set == set(to_validate)
 
+    def _validate_last_events(self, client, *to_validate):
+        """Validate the last N impressions are present disregarding the order."""
+        event_storage = client._factory._get_storage('events')
+        events = event_storage.pop_many(len(to_validate))
+        as_tup_set = set((i.key, i.traffic_type_name, i.event_type_id, i.value, str(i.properties)) for i in events)
+        assert as_tup_set == set(to_validate)
+
     def test_get_treatment(self):
         """Test client.get_treatment()."""
         try:
@@ -269,6 +276,21 @@ def test_get_treatments_with_config(self):
             ('sample_feature', 'invalidKey', 'off'),
         )
 
+    def test_track(self):
+        """Test client.track()."""
+        try:
+            client = self.factory.client()
+        except:
+            pass
+        assert(client.track('user1', 'user', 'conversion', 1, {"prop1": "value1"}))
+        assert(not client.track(None, 'user', 'conversion'))
+        assert(not client.track('user1', None, 'conversion'))
+        assert(not client.track('user1', 'user', None))
+        self._validate_last_events(
+            client,
+            ('user1', 'user', 'conversion', 1, "{'prop1': 'value1'}")
+        )
+
     def test_manager_methods(self):
         """Test manager.split/splits."""
         try:
@@ -358,6 +380,13 @@ def _validate_last_impressions(self, client, *to_validate):
         as_tup_set = set((i.feature_name, i.matching_key, i.treatment) for i in impressions)
         assert as_tup_set == set(to_validate)
 
+    def _validate_last_events(self, client, *to_validate):
+        """Validate the last N impressions are present disregarding the order."""
+        event_storage = client._factory._get_storage('events')
+        events = event_storage.pop_many(len(to_validate))
+        as_tup_set = set((i.key, i.traffic_type_name, i.event_type_id, i.value, str(i.properties)) for i in events)
+        assert as_tup_set == set(to_validate)
+
     def test_get_treatment(self):
         """Test client.get_treatment()."""
         client = self.factory.client()
@@ -529,6 +558,17 @@ def test_manager_methods(self):
         assert len(manager.split_names()) == 7
         assert len(manager.splits()) == 7
 
+    def test_track(self):
+        """Test client.track()."""
+        client = self.factory.client()
+        assert(client.track('user1', 'user', 'conversion', 1, {"prop1": "value1"}))
+        assert(not client.track(None, 'user', 'conversion'))
+        assert(not client.track('user1', None, 'conversion'))
+        assert(not client.track('user1', 'user', None))
+        self._validate_last_events(
+            client,
+            ('user1', 'user', 'conversion', 1, "{'prop1': 'value1'}")
+        )
 
 class RedisIntegrationTests(object):
     """Redis storage-based integration tests."""
@@ -581,6 +621,20 @@ def setup_method(self):
                                     telemetry_init_producer=telemetry_producer.get_telemetry_init_producer(),
                                     )  # pylint:disable=attribute-defined-outside-init
 
+    def _validate_last_events(self, client, *to_validate):
+        """Validate the last N impressions are present disregarding the order."""
+        event_storage = client._factory._get_storage('events')
+        redis_client = event_storage._redis
+        events_raw = [
+            json.loads(redis_client.lpop(event_storage._EVENTS_KEY_TEMPLATE))
+            for _ in to_validate
+        ]
+        as_tup_set = set(
+            (i['e']['key'], i['e']['trafficTypeName'], i['e']['eventTypeId'], i['e']['value'], str(i['e']['properties']))
+            for i in events_raw
+        )
+        assert as_tup_set == set(to_validate)
+
     def _validate_last_impressions(self, client, *to_validate):
         """Validate the last N impressions are present disregarding the order."""
         imp_storage = client._factory._get_storage('impressions')
@@ -765,6 +819,18 @@ def test_get_treatments_with_config(self):
             ('sample_feature', 'invalidKey', 'off'),
         )
 
+    def test_track(self):
+        """Test client.track()."""
+        client = self.factory.client()
+        assert(client.track('user1', 'user', 'conversion', 1, {"prop1": "value1"}))
+        assert(not client.track(None, 'user', 'conversion'))
+        assert(not client.track('user1', None, 'conversion'))
+        assert(not client.track('user1', 'user', None))
+        self._validate_last_events(
+            client,
+            ('user1', 'user', 'conversion', 1, "{'prop1': 'value1'}")
+        )
+
     def test_manager_methods(self):
         """Test manager.split/splits."""
         try: