Merge remote-tracking branch 'origin/development' into Feature/Async

Author: Bilal Al

.github/workflows/update-license-year.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -24,7 +24,7 @@ jobs:
         run: "echo PREVIOUS=$(($CURRENT-1)) >> $GITHUB_ENV"
 
       - name: Update LICENSE
-        uses: jacobtomlinson/gha-find-replace@v2
+        uses: jacobtomlinson/gha-find-replace@v3
         with:
           find: ${{ env.PREVIOUS }}
           replace: ${{ env.CURRENT }}
@@ -38,7 +38,7 @@ jobs:
           git commit -m "Updated License Year" -a
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           title: Update License Year

CHANGES.txt

@@ -1,3 +1,30 @@
+10.0.0 (XXX XX, XXXX)
+- Added support for asyncio library
+- BREAKING CHANGE: Minimum supported Python version is 3.7.16
+
+9.6.2 (Apr 5, 2024)
+- Fixed an issue when pushing unique keys tracker data to redis if no keys exist, i.e. get_treatment flavors are not called.
+
+9.6.1 (Feb 15, 2024)
+- Added redisUsername configuration parameter for Redis connection to set the username for accessing redis when not using the default `root` username
+
+9.6.0 (Nov 3, 2023)
+- Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):
+  - Added new variations of the get treatment methods to support evaluating flags in given flag set/s.
+    - get_treatments_by_flag_set and get_treatments_by_flag_sets
+    - get_treatments_with_config_by_flag_set and get_treatments_with_config_by_flag_sets
+- Added a new optional Split Filter configuration option. This allows the SDK and Split services to only synchronize the flags in the specified flag sets, avoiding unused or unwanted flags from being synced on the SDK instance, bringing all the benefits from a reduced payload.
+   - Note: Only applicable when the SDK is in charge of the rollout data synchronization. When not applicable, the SDK will log a warning on init.
+- Updated the following SDK manager methods to expose flag sets on flag views.
+- Removed raising an exception when Telemetry post config data fails, SDK will only log the error.
+
+9.5.1 (Sep 5, 2023)
+- Exclude tests from when building the package
+- Fixed exception when fetching telemetry stats if no SSE Feature flags update events are stored
+
+9.5.0 (Jul 18, 2023)
+- Improved streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.
+
 9.4.2 (May 15, 2023)
 - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and code documentation comments.
 - Added detailed debug logging for redis adapter.

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright © 2023 Split Software, Inc.
+Copyright © 2024 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

setup.py

@@ -7,7 +7,7 @@
 TESTS_REQUIRES = [
     'flake8',
     'pytest==7.0.1',
-    'pytest-mock>=3.5.1',
+    'pytest-mock==3.12.0',
     'coverage==6.2',
     'pytest-cov',
     'importlib-metadata==4.2',
@@ -53,5 +53,5 @@
         'Programming Language :: Python :: 3',
         'Topic :: Software Development :: Libraries'
     ],
-    packages=find_packages()
+    packages=find_packages(exclude=('tests', 'tests.*'))
 )

splitio/api/auth.py

@@ -48,6 +48,7 @@ def authenticate(self):
             if 200 <= response.status_code < 300:
                 payload = json.loads(response.body)
                 return from_raw(payload)
+
             else:
                 if (response.status_code >= 400 and response.status_code < 500):
                     self._telemetry_runtime_producer.record_auth_rejections()
@@ -94,6 +95,7 @@ async def authenticate(self):
             if 200 <= response.status_code < 300:
                 payload = json.loads(response.body)
                 return from_raw(payload)
+
             else:
                 if (response.status_code >= 400 and response.status_code < 500):
                     await self._telemetry_runtime_producer.record_auth_rejections()

splitio/api/client.py

@@ -145,6 +145,7 @@ def get(self, server, path, sdk_key, query=None, extra_headers=None):  # pylint:
             )
             self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
             return HttpResponse(response.status_code, response.text, response.headers)
+
         except Exception as exc:  # pylint: disable=broad-except
             raise HttpClientException('requests library is throwing exceptions') from exc
 
@@ -184,6 +185,7 @@ def post(self, server, path, sdk_key, body, query=None, extra_headers=None):  #
             )
             self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
             return HttpResponse(response.status_code, response.text, response.headers)
+
         except Exception as exc:  # pylint: disable=broad-except
             raise HttpClientException('requests library is throwing exceptions') from exc
 
@@ -262,6 +264,7 @@ async def get(self, server, path, apikey, query=None, extra_headers=None):  # py
                 _LOGGER.debug(body)
                 await self._record_telemetry(response.status, get_current_epoch_time_ms() - start)
                 return HttpResponse(response.status, body, response.headers)
+
         except aiohttp.ClientError as exc:  # pylint: disable=broad-except
             raise HttpClientException('aiohttp library is throwing exceptions') from exc
 
@@ -307,6 +310,7 @@ async def post(self, server, path, apikey, body, query=None, extra_headers=None)
                 _LOGGER.debug(body)
                 await self._record_telemetry(response.status, get_current_epoch_time_ms() - start)
                 return HttpResponse(response.status, body, response.headers)
+
         except aiohttp.ClientError as exc:  # pylint: disable=broad-except
             raise HttpClientException('aiohttp library is throwing exceptions') from exc
 
@@ -324,6 +328,7 @@ async def _record_telemetry(self, status_code, elapsed):
         if 200 <= status_code < 300:
             await self._telemetry_runtime_producer.record_successful_sync(self._metric_name, get_current_epoch_time_ms())
             return
+
         await self._telemetry_runtime_producer.record_sync_error(self._metric_name, status_code)
 
     async def close_session(self):

splitio/api/commons.py

@@ -42,10 +42,13 @@ def __eq__(self, other):
         """Match between other options."""
         if self._cache_control_headers != other._cache_control_headers:
             return False
+
         if self._change_number != other._change_number:
             return False
+
         if self._sets != other._sets:
             return False
+
         return True
 
 
@@ -69,6 +72,7 @@ def build_fetch(change_number, fetch_options, metadata):
     extra_headers = metadata
     if fetch_options is None:
         return query, extra_headers
+
     if fetch_options.cache_control_headers:
         extra_headers[_CACHE_CONTROL] = _CACHE_CONTROL_NO_CACHE
     if fetch_options.change_number is not None:

splitio/api/events.py

@@ -1,6 +1,5 @@
 """Events API module."""
 import logging
-import time
 
 from splitio.api import APIException, headers_from_metadata
 from splitio.api.client import HttpClientException

splitio/api/segments.py

@@ -2,7 +2,6 @@
 
 import json
 import logging
-import time
 
 from splitio.api import APIException, headers_from_metadata
 from splitio.api.commons import build_fetch
@@ -61,6 +60,7 @@ def fetch_segment(self, segment_name, change_number, fetch_options):
             )
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
+
             raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
             _LOGGER.error(
@@ -119,6 +119,7 @@ async def fetch_segment(self, segment_name, change_number, fetch_options):
             )
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
+
             raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
             _LOGGER.error(

splitio/api/splits.py

@@ -2,7 +2,6 @@
 
 import logging
 import json
-import time
 
 from splitio.api import APIException, headers_from_metadata
 from splitio.api.commons import build_fetch
@@ -56,6 +55,7 @@ def fetch_splits(self, change_number, fetch_options):
             )
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
+
             else:
                 if response.status_code == 414:
                     _LOGGER.error('Error fetching feature flags; the amount of flag sets provided are too big, causing uri length error.')
@@ -110,6 +110,7 @@ async def fetch_splits(self, change_number, fetch_options):
             )
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)
+
             else:
                 if response.status_code == 414:
                     _LOGGER.error('Error fetching feature flags; the amount of flag sets provided are too big, causing uri length error.')