Merge pull request #319 from splitio/add-expire-to-imp-and-event

Added expire_key method

Author: chillaq

splitio/storage/pluggable.py

@@ -476,6 +476,8 @@ def put(self, segment):
 
 class PluggableImpressionsStorage(ImpressionStorage):
 
+    IMPRESSIONS_KEY_DEFAULT_TTL = 3600
+
     def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
         """
         Class constructor.
@@ -542,6 +544,18 @@ def put(self, impressions):
             _LOGGER.error('Error: ', exc_info=True)
             return False
 
+    def expire_key(self, total_keys, inserted):
+        """
+        Set expire
+
+        :param total_keys: length of keys.
+        :type total_keys: int
+        :param inserted: added keys.
+        :type inserted: int
+        """
+        if total_keys == inserted:
+            self._pluggable_adapter.expire(self._impressions_queue_key, self.IMPRESSIONS_KEY_DEFAULT_TTL)
+
     def pop_many(self, count):
         """
         Pop the oldest N events from storage.
@@ -561,6 +575,8 @@ def clear(self):
 class PluggableEventsStorage(EventStorage):
     """Redis based event storage class."""
 
+    _EVENTS_KEY_DEFAULT_TTL = 3600
+
     def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
         """
         Class constructor.
@@ -615,6 +631,18 @@ def put(self, events):
             _LOGGER.debug('Error: ', exc_info=True)
             return False
 
+    def expire_key(self, total_keys, inserted):
+        """
+        Set expire
+
+        :param total_keys: length of keys.
+        :type total_keys: int
+        :param inserted: added keys.
+        :type inserted: int
+        """
+        if total_keys == inserted:
+            self._pluggable_adapter.expire(self._events_queue_key, self._EVENTS_KEY_DEFAULT_TTL)
+
     def pop_many(self, count):
         """
         Pop the oldest N events from storage.

tests/storage/test_pluggable.py

@@ -93,6 +93,10 @@ def get_items_count(self, key):
             return len(self._keys[key])
         return None
 
+    def expire(self, key, ttl):
+        #Not needed for Memory storage
+        pass
+
 class PluggableSplitStorageTests(object):
     """In memory split storage test cases."""
 
@@ -406,6 +410,27 @@ def test_wrap_impressions(self):
             })
         ])
 
+    def test_expire_key(self):
+        self.expired_called = False
+        self.key = ""
+        self.ttl = 0
+        def mock_expire(impressions_queue_key, ttl):
+            self.key = impressions_queue_key
+            self.ttl = ttl
+            self.expired_called = True
+
+        self.mock_adapter.expire = mock_expire
+
+        # should not call if total_keys are higher
+        self.pluggable_imp_storage.expire_key(200, 10)
+        assert(not self.expired_called)
+
+        self.pluggable_imp_storage.expire_key(200, 200)
+        assert(self.expired_called)
+        assert(self.key == "myprefix.SPLITIO.impressions")
+        assert(self.ttl == self.pluggable_imp_storage.IMPRESSIONS_KEY_DEFAULT_TTL)
+
+
 class PluggableEventsStorageTests(object):
     """In memory events storage test cases."""
 
@@ -481,3 +506,23 @@ def test_wrap_events(self):
                 }
             })
         ])
+
+    def test_expire_key(self):
+        self.expired_called = False
+        self.key = ""
+        self.ttl = 0
+        def mock_expire(impressions_event_key, ttl):
+            self.key = impressions_event_key
+            self.ttl = ttl
+            self.expired_called = True
+
+        self.mock_adapter.expire = mock_expire
+
+        # should not call if total_keys are higher
+        self.pluggable_events_storage.expire_key(200, 10)
+        assert(not self.expired_called)
+
+        self.pluggable_events_storage.expire_key(200, 200)
+        assert(self.expired_called)
+        assert(self.key == "myprefix.SPLITIO.events")
+        assert(self.ttl == self.pluggable_events_storage._EVENTS_KEY_DEFAULT_TTL)