splitio-commons 1.0.0__tar.gz → 1.1.0__tar.gz

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/NOTICE.txt

@@ -1,4 +1,4 @@
-Harness Feature Management Python Commons Copyright 2024-2026 Harness Inc.
+Harness Feature Management JavaScript SDK Copyright 2024-2026 Harness Inc.
 
 This product includes software developed at Harness Inc. (https://harness.io/).
 

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: splitio_commons
-Version: 1.0.0
-Summary: Splitio Python Commons
-Home-page: https://github.com/splitio/python-commons
-Download-URL: https://github.com/splitio/python-commons/tarball/1.0.0
+Version: 1.1.0
+Summary: harness.io Python Commons
+Home-page: https://github.com/splitio_commons/python-commons
+Download-URL: https://github.com/splitio_commons/python-commons/tarball/1.1.0
 Author: Bilal Al-Shahwany
 Author-email: bilal.al-shahwany@harness.io
 License: Apache License 2.0

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/setup.py

@@ -37,11 +37,11 @@ with open(path.join(path.abspath(path.dirname(__file__)), 'splitio_commons', 've
 setup(
     name='splitio_commons',
     version=__version__,  # pylint: disable=undefined-variable
-    description='Splitio Python Commons',
+    description='harness.io Python Commons',
     author='Bilal Al-Shahwany',
     author_email='bilal.al-shahwany@harness.io',
-    url='https://github.com/splitio/python-commons',
-    download_url=('https://github.com/splitio/python-commons/tarball/' + __version__),  # pylint: disable=undefined-variable
+    url='https://github.com/splitio_commons/python-commons',
+    download_url=('https://github.com/splitio_commons/python-commons/tarball/' + __version__),  # pylint: disable=undefined-variable
     license='Apache License 2.0',
     install_requires=INSTALL_REQUIRES,
     tests_require=TESTS_REQUIRES,

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons/api/segments.py

@@ -52,6 +52,7 @@ class SegmentsAPI(object):  # pylint: disable=too-few-public-methods
         :rtype: dict
         """
         try:
+            self._update_sdk_version_header()
             query, extra_headers = build_fetch(change_number, fetch_options, self._metadata)
             response = self._client.get(
                 'sdk',
@@ -77,6 +78,8 @@ class SegmentsAPI(object):  # pylint: disable=too-few-public-methods
             _LOGGER.debug('Error: ', exc_info=True)
             raise APIException('Segments not fetched properly.') from exc
 
+    def _update_sdk_version_header(self):
+        pass
 
 class SegmentsAPIAsync(object):  # pylint: disable=too-few-public-methods
     """Async Class that uses an httpClient to communicate with the segments API."""
@@ -118,6 +121,7 @@ class SegmentsAPIAsync(object):  # pylint: disable=too-few-public-methods
         :rtype: dict
         """
         try:
+            self._update_sdk_version_header()
             query, extra_headers = build_fetch(change_number, fetch_options, self._metadata)
             response = await self._client.get(
                 'sdk',
@@ -142,3 +146,6 @@ class SegmentsAPIAsync(object):  # pylint: disable=too-few-public-methods
             )
             _LOGGER.debug('Error: ', exc_info=True)
             raise APIException('Segments not fetched properly.') from exc
+
+    def _update_sdk_version_header(self):
+        pass

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons/push/sse.py

@@ -85,6 +85,9 @@ class SSEClient(object):
                     event_builder = EventBuilder()
                 else:
                     event_builder.process_line(line)
+        except OSError:
+            _LOGGER.debug('sse connection ended.')
+            pass
         except Exception:  # pylint:disable=broad-except
             _LOGGER.debug('sse connection ended.')
             _LOGGER.debug('stack trace: ', exc_info=True)
@@ -131,11 +134,10 @@ class SSEClient(object):
         if self._shutdown_requested:
             _LOGGER.warning("shutdown already requested")
             return
-
+        _LOGGER.debug("shutting down SSE")
         self._shutdown_requested = True
         self._conn.sock.shutdown(socket.SHUT_RDWR)
 
-
 class SSEClientAsync(object):
     """SSE Client implementation."""
 

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons/recorder/recorder.py

@@ -6,6 +6,7 @@ import random
 from splitio_commons.models.telemetry import MethodExceptionsAndLatencies
 from splitio_commons.models import telemetry
 from splitio_commons.optional.loaders import asyncio
+from splitio_commons.storage.inmemmory import MAX_SIZE_BYTES
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -60,6 +61,9 @@ class StatsRecorder(object, metaclass=abc.ABCMeta):
         """
         pass
 
+    def _get_size(self, event):
+        return sum(ev.size for ev in event)
+        
 class StatsRecorderThreadingBase(StatsRecorder):
     """StandardRecorder class."""
 
@@ -131,7 +135,7 @@ class StatsRecorderAsyncBase(StatsRecorder):
 class StandardRecorder(StatsRecorderThreadingBase):
     """StandardRecorder class."""
 
-    def __init__(self, impressions_manager, event_storage, impression_storage, telemetry_evaluation_producer, telemetry_runtime_producer, listener=None, unique_keys_tracker=None, imp_counter=None):
+    def __init__(self, impression_queue_full_hook, event_queue_full_hook, impressions_manager, event_storage, impression_storage, telemetry_evaluation_producer, telemetry_runtime_producer, listener=None, unique_keys_tracker=None, imp_counter=None):
         """
         Class constructor.
 
@@ -149,6 +153,8 @@ class StandardRecorder(StatsRecorderThreadingBase):
         StatsRecorderThreadingBase.__init__(self, impressions_manager, event_storage, impression_storage, listener, unique_keys_tracker, imp_counter)
         self._telemetry_evaluation_producer = telemetry_evaluation_producer
         self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._event_queue_full_hook = event_queue_full_hook
+        self._impression_queue_full_hook = impression_queue_full_hook
 
     def record_treatment_stats(self, impressions_decorated, latency, operation, method_name):
         """
@@ -167,7 +173,14 @@ class StandardRecorder(StatsRecorderThreadingBase):
             impressions, deduped, for_listener, for_counter, for_unique_keys_tracker = self._impressions_manager.process_impressions(impressions_decorated)
             if deduped > 0:
                 self._telemetry_runtime_producer.record_impression_stats(telemetry.CounterConstants.IMPRESSIONS_DEDUPED, deduped)
-            self._impression_storage.put(impressions)
+
+            for impression in impressions:
+                self._impression_storage.put([impression])
+
+                if self._impression_queue_full_hook != None:
+                    if self._impression_storage._impressions.qsize() >= self._impression_storage._queue_size:
+                        self._impression_queue_full_hook()
+
             self._send_impressions_to_listener(for_listener)
             if len(for_counter) > 0:
                 self._imp_counter.track(for_counter)
@@ -185,12 +198,17 @@ class StandardRecorder(StatsRecorderThreadingBase):
         :type event: splitio_commons.models.events.EventWrapper
         """
         self._telemetry_evaluation_producer.record_latency(MethodExceptionsAndLatencies.TRACK, latency)
-        return self._event_sotrage.put(event)
+        
+        if self._event_queue_full_hook != None:
+            if self._event_sotrage._size + self._get_size(event) >= MAX_SIZE_BYTES or self._event_sotrage._events.qsize() + 1 >= self._event_sotrage._queue_size:
+                self._event_queue_full_hook()
 
+        return self._event_sotrage.put(event)
+        
 class StandardRecorderAsync(StatsRecorderAsyncBase):
     """StandardRecorder async class."""
 
-    def __init__(self, impressions_manager, event_storage, impression_storage, telemetry_evaluation_producer, telemetry_runtime_producer, listener=None, unique_keys_tracker=None, imp_counter=None):
+    def __init__(self, impression_queue_full_hook, event_queue_full_hook, impressions_manager, event_storage, impression_storage, telemetry_evaluation_producer, telemetry_runtime_producer, listener=None, unique_keys_tracker=None, imp_counter=None):
         """
         Class constructor.
 
@@ -208,6 +226,8 @@ class StandardRecorderAsync(StatsRecorderAsyncBase):
         StatsRecorderAsyncBase.__init__(self, impressions_manager, event_storage, impression_storage, listener, unique_keys_tracker, imp_counter)
         self._telemetry_evaluation_producer = telemetry_evaluation_producer
         self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._event_queue_full_hook = event_queue_full_hook
+        self._impression_queue_full_hook = impression_queue_full_hook
 
     async def record_treatment_stats(self, impressions_decorated, latency, operation, method_name):
         """
@@ -227,7 +247,13 @@ class StandardRecorderAsync(StatsRecorderAsyncBase):
             if deduped > 0:
                 await self._telemetry_runtime_producer.record_impression_stats(telemetry.CounterConstants.IMPRESSIONS_DEDUPED, deduped)
 
-            await self._impression_storage.put(impressions)
+            for impression in impressions:
+                await self._impression_storage.put([impression])
+
+                if self._impression_queue_full_hook != None:
+                    if self._impression_storage._impressions.qsize() >= self._impression_storage._queue_size:
+                        await self._impression_queue_full_hook()
+                      
             await self._send_impressions_to_listener_async(for_listener)
             if len(for_counter) > 0:
                 self._imp_counter.track(for_counter)
@@ -246,8 +272,15 @@ class StandardRecorderAsync(StatsRecorderAsyncBase):
         :type event: splitio_commons.models.events.EventWrapper
         """
         await self._telemetry_evaluation_producer.record_latency(MethodExceptionsAndLatencies.TRACK, latency)
-        return await self._event_sotrage.put(event)
 
+        to_return = await self._event_sotrage.put(event)
+
+        if self._event_queue_full_hook != None:
+            if self._event_sotrage._size + self._get_size(event) >= MAX_SIZE_BYTES or self._event_sotrage._events.qsize() >= self._event_sotrage._queue_size:
+                await self._event_queue_full_hook()
+
+        return to_return
+        
 class PipelinedRecorder(StatsRecorderThreadingBase):
     """PipelinedRecorder class."""
 

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons/storage/inmemmory.py

@@ -1323,8 +1323,6 @@ class InMemoryImpressionStorage(InMemoryImpressionStorageBase):
         except queue.Full:
             self._telemetry_runtime_producer.record_impression_stats(CounterConstants.IMPRESSIONS_DROPPED, len(impressions) - impressions_stored)
             self._telemetry_runtime_producer.record_impression_stats(CounterConstants.IMPRESSIONS_QUEUED, impressions_stored)
-            if self._queue_full_hook is not None and callable(self._queue_full_hook):
-                self._queue_full_hook()
             _LOGGER.warning(
                 'Impression queue is full, failing to add more impressions. \n'
                 'Consider increasing parameter `impressionsQueueSize` in configuration'
@@ -1381,6 +1379,7 @@ class InMemoryImpressionStorageAsync(InMemoryImpressionStorageBase):
                 for impression in impressions:
                     if self._impressions.qsize() == self._queue_size:
                         raise asyncio.QueueFull
+
                     await self._impressions.put(impression)
                     impressions_stored += 1
             await self._telemetry_runtime_producer.record_impression_stats(CounterConstants.IMPRESSIONS_QUEUED, len(impressions))
@@ -1389,8 +1388,6 @@ class InMemoryImpressionStorageAsync(InMemoryImpressionStorageBase):
         except asyncio.QueueFull:
             await self._telemetry_runtime_producer.record_impression_stats(CounterConstants.IMPRESSIONS_DROPPED, len(impressions) - impressions_stored)
             await self._telemetry_runtime_producer.record_impression_stats(CounterConstants.IMPRESSIONS_QUEUED, impressions_stored)
-            if self._queue_full_hook is not None and callable(self._queue_full_hook):
-                await self._queue_full_hook()
             _LOGGER.warning(
                 'Impression queue is full, failing to add more impressions. \n'
                 'Consider increasing parameter `impressionsQueueSize` in configuration'
@@ -1424,15 +1421,6 @@ class InMemoryEventStorageBase(EventStorage):
     In memory storage base class for events.
     Supports adding and popping events.
     """
-    def set_queue_full_hook(self, hook):
-        """
-        Set a hook to be called when the queue is full.
-
-        :param h: Hook to be called when the queue is full
-        """
-        if callable(hook):
-            self._queue_full_hook = hook
-
     def put(self, events):
         """
         Add an event to storage.
@@ -1472,7 +1460,6 @@ class InMemoryEventStorage(InMemoryEventStorageBase):
         self._queue_size = eventsQueueSize
         self._lock = threading.Lock()
         self._events = queue.Queue(maxsize=eventsQueueSize)
-        self._queue_full_hook = None
         self._size = 0
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
@@ -1486,27 +1473,25 @@ class InMemoryEventStorage(InMemoryEventStorageBase):
         try:
             with self._lock:
                 for event in events:
-                    self._size += event.size
-
-                    if self._size >= MAX_SIZE_BYTES:
-                        self._queue_full_hook()
-                        return False
-
                     self._events.put(event.event, False)
+                    self._size += event.size
                     events_stored += 1
+
             self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, len(events))
             return True
 
         except queue.Full:
-            self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_DROPPED, len(events) - events_stored)
-            self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, events_stored)
-            if self._queue_full_hook is not None and callable(self._queue_full_hook):
-                self._queue_full_hook()
             _LOGGER.warning(
-                'Events queue is full, failing to add more events. \n'
-                'Consider increasing parameter `eventsQueueSize` in configuration'
+                'Events queue is full, flushing storage events. \n'
+                'Consider increasing Queue Size parameter in configuration'
             )
-            return False
+        except Exception:
+            _LOGGER.error("Exception in storing events")
+            _LOGGER.debug("Exception info: ", exc_info=True)
+
+        self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_DROPPED, len(events) - events_stored)
+        self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, events_stored)
+        return False
 
     def pop_many(self, count):
         """
@@ -1544,7 +1529,6 @@ class InMemoryEventStorageAsync(InMemoryEventStorageBase):
         self._queue_size = eventsQueueSize
         self._lock = asyncio.Lock()
         self._events = asyncio.Queue(maxsize=eventsQueueSize)
-        self._queue_full_hook = None
         self._size = 0
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
@@ -1560,27 +1544,27 @@ class InMemoryEventStorageAsync(InMemoryEventStorageBase):
                 for event in events:
                     if self._events.qsize() == self._queue_size:
                         raise asyncio.QueueFull
-
-                    self._size += event.size
-                    if self._size >= MAX_SIZE_BYTES:
-                        await self._queue_full_hook()
-                        return False
-
+                    
                     await self._events.put(event.event)
+                    self._size += event.size
                     events_stored += 1
+                        
+            await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_DROPPED, len(events) - events_stored)
             await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, len(events))
             return True
 
         except asyncio.QueueFull:
-            await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_DROPPED, len(events) - events_stored)
-            await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, events_stored)
-            if self._queue_full_hook is not None and callable(self._queue_full_hook):
-                await self._queue_full_hook()
             _LOGGER.warning(
                 'Events queue is full, failing to add more events. \n'
                 'Consider increasing parameter `eventsQueueSize` in configuration'
             )
-            return False
+        except Exception:
+            _LOGGER.error("Exception in storing events")
+            _LOGGER.debug("Exception info: ", exc_info=True)
+
+        await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_DROPPED, len(events) - events_stored)
+        await self._telemetry_runtime_producer.record_event_stats(CounterConstants.EVENTS_QUEUED, events_stored)
+        return False
 
     async def pop_many(self, count):
         """

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons/sync/definition.py

@@ -66,8 +66,8 @@ class DefinitionSynchronizerBase(object):
     def _check_exit_conditions(self, till, rbs_till, change_number, rbs_change_number):
         return (till is not None and till < change_number) or (rbs_till is not None and rbs_till < rbs_change_number)
 
-    def _check_return_conditions(self, definition_changes):
-        return definition_changes.get(self._definition_json_section_name)['t'] == definition_changes.get(self._definition_json_section_name)['s'] and definition_changes.get('rbs')['t'] == definition_changes.get('rbs')['s']
+    def _check_return_conditions(self, definition_changes,  till, rbs_till):
+        return (definition_changes.get(self._definition_json_section_name)['t'] == definition_changes.get(self._definition_json_section_name)['s'] and definition_changes.get('rbs')['t'] == definition_changes.get('rbs')['s']) or (till is None and rbs_till is None)
     
     def _update_definition_if_needed(self, definition_changes):
         # Call used to inject any changed needed
@@ -144,7 +144,7 @@ class DefinitionSynchronizer(DefinitionSynchronizerBase):
             segment_list.update(update_definition_storage(self._definition_storage, fetched_definitions, definition_changes.get(self._definition_json_section_name)['t'], self._api.clear_storage))
             segment_list.update(rbs_segment_list)
             
-            if self._check_return_conditions(definition_changes):
+            if self._check_return_conditions(definition_changes, till, rbs_till):
                 return definition_changes.get(self._definition_json_section_name)['t'], definition_changes.get('rbs')['t'], segment_list
 
     def _attempt_definition_sync(self, fetch_options, till=None, rbs_till=None):
@@ -293,7 +293,7 @@ class DefinitionSynchronizerAsync(DefinitionSynchronizerBase):
             segment_list = await update_definition_storage_async(self._definition_storage, fetched_definitions, definition_changes.get(self._definition_json_section_name)['t'], self._api.clear_storage)
             segment_list.update(rbs_segment_list)
 
-            if self._check_return_conditions(definition_changes):
+            if self._check_return_conditions(definition_changes, till, rbs_till):
                 return definition_changes.get(self._definition_json_section_name)['t'], definition_changes.get('rbs')['t'], segment_list
 
     async def _attempt_definition_sync(self, fetch_options, till=None, rbs_till=None):

splitio_commons-1.1.0/splitio_commons/version.py

@@ -0,0 +1 @@
+__version__ = '1.1.0'

{splitio_commons-1.0.0 → splitio_commons-1.1.0}/splitio_commons.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: splitio-commons
-Version: 1.0.0
-Summary: Splitio Python Commons
-Home-page: https://github.com/splitio/python-commons
-Download-URL: https://github.com/splitio/python-commons/tarball/1.0.0
+Version: 1.1.0
+Summary: harness.io Python Commons
+Home-page: https://github.com/splitio_commons/python-commons
+Download-URL: https://github.com/splitio_commons/python-commons/tarball/1.1.0
 Author: Bilal Al-Shahwany
 Author-email: bilal.al-shahwany@harness.io
 License: Apache License 2.0

splitio_commons-1.0.0/splitio_commons/version.py

@@ -1 +0,0 @@
-__version__ = '1.0.0'