added impressions pluggable storage and tests

Author: chillaq

splitio/storage/pluggable.py

@@ -1,9 +1,11 @@
 """Pluggable Storage classes."""
 
 import logging
+import json
 
 from splitio.models import splits, segments
-from splitio.storage import SplitStorage, SegmentStorage
+from splitio.models.impressions import Impression
+from splitio.storage import SplitStorage, SegmentStorage, ImpressionStorage
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -470,3 +472,87 @@ def put(self, segment):
 #        except Exception:
 #            _LOGGER.error('Error updating segment storage')
 #            _LOGGER.debug('Error: ', exc_info=True)
+
+
+class PluggableImpressionsStorage(ImpressionStorage):
+
+    def __init__(self, pluggable_adapter, sdk_metadata, prefix=None):
+        """
+        Class constructor.
+
+        :param pluggable_adapter: Storage client or compliant interface.
+        :type pluggable_adapter: TBD
+        :param sdk_metadata: SDK & Machine information.
+        :type sdk_metadata: splitio.client.util.SdkMetadata
+        """
+        self._pluggable_adapter = pluggable_adapter
+        self._sdk_metadata = sdk_metadata
+        self._impressions_queue_key = 'SPLITIO.impressions'
+        if prefix is not None:
+            self._impressions_queue_key = prefix + "." + self._impressions_queue_key
+
+    def _wrap_impressions(self, impressions):
+        """
+        Wrap impressions to be stored in storage
+
+        :param impressions: Impression to add to the queue.
+        :type impressions: splitio.models.impressions.Impression
+
+        :return: Processed impressions.
+        :rtype: list[splitio.models.impressions.Impression]
+        """
+        bulk_impressions = []
+        for impression in impressions:
+            if isinstance(impression, Impression):
+                to_store = {
+                    'm': {  # METADATA PORTION
+                        's': self._sdk_metadata.sdk_version,
+                        'n': self._sdk_metadata.instance_name,
+                        'i': self._sdk_metadata.instance_ip,
+                    },
+                    'i': {  # IMPRESSION PORTION
+                        'k': impression.matching_key,
+                        'b': impression.bucketing_key,
+                        'f': impression.feature_name,
+                        't': impression.treatment,
+                        'r': impression.label,
+                        'c': impression.change_number,
+                        'm': impression.time,
+                    }
+                }
+            bulk_impressions.append(json.dumps(to_store))
+        return bulk_impressions
+
+    def put(self, impressions):
+        """
+        Add an impression to the pluggable storage.
+
+        :param impressions: Impression to add to the queue.
+        :type impressions: splitio.models.impressions.Impression
+
+        :return: Whether the impression has been added or not.
+        :rtype: bool
+        """
+        bulk_impressions = self._wrap_impressions(impressions)
+        try:
+            self._pluggable_adapter.push_items(self._impressions_queue_key, *bulk_impressions)
+            return True
+        except Exception:
+            _LOGGER.error('Something went wrong when trying to add impression to storage')
+            _LOGGER.error('Error: ', exc_info=True)
+            return False
+
+    def pop_many(self, count):
+        """
+        Pop the oldest N events from storage.
+
+        :param count: Number of events to pop.
+        :type count: int
+        """
+        raise NotImplementedError('Only consumer mode is supported.')
+
+    def clear(self):
+        """
+        Clear data.
+        """
+        raise NotImplementedError('Only consumer mode is supported.')

tests/storage/test_pluggable.py

@@ -1,8 +1,12 @@
 """Pluggable storage test module."""
+import json
+
 from splitio.models.splits import Split
 from splitio.models import splits, segments
 from splitio.models.segments import Segment
-from splitio.storage.pluggable import PluggableSplitStorage, PluggableSegmentStorage
+from splitio.models.impressions import Impression
+from splitio.storage.pluggable import PluggableSplitStorage, PluggableSegmentStorage, PluggableImpressionsStorage
+from splitio.client.util import get_metadata, SdkMetadata
 
 from tests.integration import splits_json
 import pytest
@@ -27,6 +31,13 @@ def get_many(self, keys):
     def set(self, key, value):
         self._keys[key] = value
 
+    def push_items(self, key, *value):
+        items = []
+        if key in self._keys:
+            items = self._keys[key]
+        [items.append(item) for item in value]
+        self._keys[key] = items
+
     def delete(self, key):
         if key in self._keys:
             del self._keys[key]
@@ -314,3 +325,78 @@ def test_get(self):
 #        assert('myprefix.SPLITIO.segment.segment2' in self.mock_adapter._keys)
 #        assert(self.mock_adapter._keys['myprefix.SPLITIO.segment.segment2'] == {'key1', 'key2', 'key3'})
 #        assert(self.mock_adapter._keys['myprefix.SPLITIO.segment.segment2.till'] == 123)
+
+
+class PluggableImpressionsStorageTests(object):
+    """In memory impressions storage test cases."""
+
+    def setup_method(self):
+        """Prepare storages with test data."""
+        self.mock_adapter = StorageMockAdapter()
+        self.metadata = SdkMetadata('python-1.1.1', 'hostname', 'ip')
+        self.pluggable_imp_storage = PluggableImpressionsStorage(self.mock_adapter, self.metadata, 'myprefix')
+
+    def test_init(self):
+        assert(self.pluggable_imp_storage._impressions_queue_key == "myprefix.SPLITIO.impressions")
+        assert(self.pluggable_imp_storage._sdk_metadata == self.metadata)
+
+        pluggable2 = PluggableImpressionsStorage(self.mock_adapter, self.metadata)
+        assert(pluggable2._impressions_queue_key == "SPLITIO.impressions")
+
+    def test_put(self):
+        impressions = [
+            Impression('key1', 'feature1', 'on', 'some_label', 123456, 'buck1', 321654),
+            Impression('key2', 'feature2', 'on', 'some_label', 123456, 'buck1', 321654),
+            Impression('key3', 'feature2', 'on', 'some_label', 123456, 'buck1', 321654),
+            Impression('key4', 'feature1', 'on', 'some_label', 123456, 'buck1', 321654)
+        ]
+        self.pluggable_imp_storage.put(impressions)
+        assert(self.pluggable_imp_storage._impressions_queue_key in self.mock_adapter._keys)
+        assert(self.mock_adapter._keys["myprefix.SPLITIO.impressions"] == self.pluggable_imp_storage._wrap_impressions(impressions))
+
+        impressions2 = [
+            Impression('key5', 'feature1', 'off', 'some_label', 123456, 'buck1', 321654),
+            Impression('key6', 'feature2', 'off', 'some_label', 123456, 'buck1', 321654),
+        ]
+        self.pluggable_imp_storage.put(impressions2)
+        assert(self.mock_adapter._keys["myprefix.SPLITIO.impressions"] == self.pluggable_imp_storage._wrap_impressions(impressions + impressions2))
+
+    def test_wrap_impressions(self):
+        impressions = [
+            Impression('key1', 'feature1', 'on', 'some_label', 123456, 'buck1', 321654),
+            Impression('key2', 'feature2', 'off', 'some_label', 123456, 'buck1', 321654),
+        ]
+        assert(self.pluggable_imp_storage._wrap_impressions(impressions) == [
+            json.dumps({
+                'm': {
+                    's': self.metadata.sdk_version,
+                    'n': self.metadata.instance_name,
+                    'i': self.metadata.instance_ip,
+                },
+                'i': {
+                    'k': 'key1',
+                    'b': 'buck1',
+                    'f': 'feature1',
+                    't': 'on',
+                    'r': 'some_label',
+                    'c': 123456,
+                    'm': 321654,
+                }
+            }),
+            json.dumps({
+                'm': {
+                    's': self.metadata.sdk_version,
+                    'n': self.metadata.instance_name,
+                    'i': self.metadata.instance_ip,
+                },
+                'i': {
+                    'k': 'key2',
+                    'b': 'buck1',
+                    'f': 'feature2',
+                    't': 'off',
+                    'r': 'some_label',
+                    'c': 123456,
+                    'm': 321654,
+                }
+            })
+        ])