Merge branch 'development' into Feature/Async

Author: chillaq

CHANGES.txt

@@ -2,6 +2,10 @@
 - Added support for asyncio library
 - BREAKING CHANGE: Minimum supported Python version is 3.7.16
 
+9.7.0 (May 15, 2024)
+- Added support for targeting rules based on semantic versions (https://semver.org/).
+- Added the logic to handle correctly when the SDK receives an unsupported Matcher type.
+
 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.
 

README.md

@@ -7,7 +7,7 @@ This SDK is designed to work with Split, the platform for controlled rollouts, w
 [![Twitter Follow](https://img.shields.io/twitter/follow/splitsoftware.svg?style=social&label=Follow&maxAge=1529000)](https://twitter.com/intent/follow?screen_name=splitsoftware)
 
 ## Compatibility
-This SDK is compatible with **Python 3 and higher**.
+This SDK is compatible with **Python 3.7 and higher**.
 
 ## Getting started
 Below is a simple example that describes the instantiation and most basic usage of our SDK:

setup.py

@@ -8,18 +8,18 @@
     'flake8',
     'pytest==7.0.1',
     'pytest-mock==3.11.1',
-    'coverage==6.2',
+    'coverage==7.2,7',
     'pytest-cov==4.1.0',
-    'importlib-metadata==4.2',
+    'importlib-metadata==6.7',
     'tomli==1.2.3',
     'iniconfig==1.1.1',
     'attrs==22.1.0',
     'pytest-asyncio==0.21.0'
 ]
 
 INSTALL_REQUIRES = [
-    'requests>=2.9.1',
-    'pyyaml>=5.4',
+    'requests',
+    'pyyaml',
     'docopt>=0.6.2',
     'enum34;python_version<"3.4"',
     'bloom-filter2>=2.0.0',

splitio/api/auth.py

@@ -4,6 +4,9 @@
 import json
 
 from splitio.api import APIException, headers_from_metadata
+from splitio.api.commons import headers_from_metadata, record_telemetry
+from splitio.spec import SPEC_VERSION
+from splitio.util.time import get_current_epoch_time_ms
 from splitio.api.client import HttpClientException
 from splitio.models.token import from_raw
 from splitio.models.telemetry import HTTPExceptionsAndLatencies
@@ -41,7 +44,7 @@ def authenticate(self):
         try:
             response = self._client.get(
                 'auth',
-                'v2/auth',
+                '/v2/auth?s=' + SPEC_VERSION,
                 self._sdk_key,
                 extra_headers=self._metadata,
             )

splitio/api/commons.py

@@ -1,12 +1,63 @@
 """Commons module."""
+from splitio.util.time import get_current_epoch_time_ms
+from splitio.spec import SPEC_VERSION
 
 _CACHE_CONTROL = 'Cache-Control'
 _CACHE_CONTROL_NO_CACHE = 'no-cache'
 
+def headers_from_metadata(sdk_metadata, client_key=None):
+    """
+    Generate a dict with headers required by data-recording API endpoints.
+
+    :param sdk_metadata: SDK Metadata object, generated at sdk initialization time.
+    :type sdk_metadata: splitio.client.util.SdkMetadata
+
+    :param client_key: client key.
+    :type client_key: str
+
+    :return: A dictionary with headers.
+    :rtype: dict
+    """
+
+    metadata = {
+        'SplitSDKVersion': sdk_metadata.sdk_version,
+        'SplitSDKMachineIP': sdk_metadata.instance_ip,
+        'SplitSDKMachineName': sdk_metadata.instance_name
+    } if sdk_metadata.instance_ip != 'NA' and sdk_metadata.instance_ip != 'unknown' else {
+        'SplitSDKVersion': sdk_metadata.sdk_version,
+    }
+
+    if client_key is not None:
+        metadata['SplitSDKClientKey'] = client_key
+
+    return metadata
+
+def record_telemetry(status_code, elapsed, metric_name, telemetry_runtime_producer):
+    """
+    Record Telemetry info
+
+    :param status_code: http request status code
+    :type status_code: int
+
+    :param elapsed: response time elapsed.
+    :type status_code: int
+
+    :param metric_name: metric name for telemetry
+    :type metric_name: str
+
+    :param telemetry_runtime_producer: telemetry recording instance
+    :type telemetry_runtime_producer: splitio.engine.telemetry.TelemetryRuntimeProducer
+    """
+    telemetry_runtime_producer.record_sync_latency(metric_name, elapsed)
+    if 200 <= status_code < 300:
+        telemetry_runtime_producer.record_successful_sync(metric_name, get_current_epoch_time_ms())
+        return
+    telemetry_runtime_producer.record_sync_error(metric_name, status_code)
+
 class FetchOptions(object):
     """Fetch Options object."""
 
-    def __init__(self, cache_control_headers=False, change_number=None, sets=None):
+    def __init__(self, cache_control_headers=False, change_number=None, sets=None, spec=SPEC_VERSION):
         """
         Class constructor.
 
@@ -22,6 +73,7 @@ def __init__(self, cache_control_headers=False, change_number=None, sets=None):
         self._cache_control_headers = cache_control_headers
         self._change_number = change_number
         self._sets = sets
+        self._spec = spec
 
     @property
     def cache_control_headers(self):
@@ -38,6 +90,11 @@ def sets(self):
         """Return sets."""
         return self._sets
 
+    @property
+    def spec(self):
+        """Return sets."""
+        return self._spec
+
     def __eq__(self, other):
         """Match between other options."""
         if self._cache_control_headers != other._cache_control_headers:
@@ -48,7 +105,8 @@ def __eq__(self, other):
 
         if self._sets != other._sets:
             return False
-
+        if self._spec != other._spec:
+            return False
         return True
 
 
@@ -68,15 +126,16 @@ def build_fetch(change_number, fetch_options, metadata):
     :return: Objects for fetch
     :rtype: dict, dict
     """
-    query = {'since': change_number}
+    query = {'s': fetch_options.spec} if fetch_options.spec is not None else {}
+    query['since'] = change_number
     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:
-        query['till'] = fetch_options.change_number
     if fetch_options.sets is not None:
         query['sets'] = fetch_options.sets
+    if fetch_options.change_number is not None:
+        query['till'] = fetch_options.change_number
     return query, extra_headers

splitio/models/__init__.py

@@ -0,0 +1,6 @@
+class MatcherNotFoundException(Exception):
+    """Exception to raise when a matcher is not found."""
+
+    def __init__(self, custom_message):
+        """Constructor."""
+        Exception.__init__(self, custom_message)

splitio/models/grammar/condition.py

@@ -2,6 +2,7 @@
 
 from enum import Enum
 
+from splitio.models import MatcherNotFoundException
 from splitio.models.grammar import matchers
 from splitio.models.grammar import partitions
 
@@ -124,6 +125,7 @@ def from_raw(raw_condition):
     ]
 
     matcher_objects = [matchers.from_raw(x) for x in raw_condition['matcherGroup']['matchers']]
+
     combiner = _MATCHER_COMBINERS[raw_condition['matcherGroup']['combiner']]
     label = raw_condition.get('label')
 

splitio/models/grammar/matchers/__init__.py

@@ -1,4 +1,5 @@
 """Matchers entrypoint module."""
+from splitio.models import MatcherNotFoundException
 from splitio.models.grammar.matchers.keys import AllKeysMatcher, UserDefinedSegmentMatcher
 from splitio.models.grammar.matchers.numeric import BetweenMatcher, EqualToMatcher, \
     GreaterThanOrEqualMatcher, LessThanOrEqualMatcher
@@ -7,6 +8,8 @@
 from splitio.models.grammar.matchers.string import ContainsStringMatcher, \
     EndsWithMatcher, RegexMatcher, StartsWithMatcher, WhitelistMatcher
 from splitio.models.grammar.matchers.misc import BooleanMatcher, DependencyMatcher
+from splitio.models.grammar.matchers.semver import EqualToSemverMatcher, GreaterThanOrEqualToSemverMatcher, LessThanOrEqualToSemverMatcher, \
+        BetweenSemverMatcher, InListSemverMatcher
 
 
 MATCHER_TYPE_ALL_KEYS = 'ALL_KEYS'
@@ -26,6 +29,11 @@
 MATCHER_TYPE_IN_SPLIT_TREATMENT = 'IN_SPLIT_TREATMENT'
 MATCHER_TYPE_EQUAL_TO_BOOLEAN = 'EQUAL_TO_BOOLEAN'
 MATCHER_TYPE_MATCHES_STRING = 'MATCHES_STRING'
+MATCHER_TYPE_EQUAL_TO_SEMVER = 'EQUAL_TO_SEMVER'
+MATCHER_GREATER_THAN_OR_EQUAL_TO_SEMVER = 'GREATER_THAN_OR_EQUAL_TO_SEMVER'
+MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER = 'LESS_THAN_OR_EQUAL_TO_SEMVER'
+MATCHER_BETWEEN_SEMVER = 'BETWEEN_SEMVER'
+MATCHER_INLIST_SEMVER = 'IN_LIST_SEMVER'
 
 
 _MATCHER_BUILDERS = {
@@ -45,10 +53,14 @@
     MATCHER_TYPE_CONTAINS_STRING: ContainsStringMatcher,
     MATCHER_TYPE_IN_SPLIT_TREATMENT: DependencyMatcher,
     MATCHER_TYPE_EQUAL_TO_BOOLEAN: BooleanMatcher,
-    MATCHER_TYPE_MATCHES_STRING: RegexMatcher
+    MATCHER_TYPE_MATCHES_STRING: RegexMatcher,
+    MATCHER_TYPE_EQUAL_TO_SEMVER: EqualToSemverMatcher,
+    MATCHER_GREATER_THAN_OR_EQUAL_TO_SEMVER: GreaterThanOrEqualToSemverMatcher,
+    MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER: LessThanOrEqualToSemverMatcher,
+    MATCHER_BETWEEN_SEMVER: BetweenSemverMatcher,
+    MATCHER_INLIST_SEMVER: InListSemverMatcher
 }
 
-
 def from_raw(raw_matcher):
     """
     Parse a condition from a JSON portion of splitChanges.
@@ -63,5 +75,5 @@ def from_raw(raw_matcher):
     try:
         builder = _MATCHER_BUILDERS[matcher_type]
     except KeyError:
-        raise ValueError('Invalid matcher type %s' % matcher_type)
+        raise MatcherNotFoundException('Invalid matcher type %s' % matcher_type)
     return builder(raw_matcher)