Merge pull request #503 from splitio/Feature/Async

Feature/async

Author: chillaq

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v3
         with:
-          python-version: '3.7'
+          python-version: '3.7.16'
 
       - name: Install dependencies
         run: |

CHANGES.txt

@@ -1,3 +1,7 @@
+10.0.0 (XXX XX, XXXX)
+- 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.

setup.cfg

@@ -12,7 +12,6 @@ exclude=tests/*
 test=pytest
 
 [tool:pytest]
-ignore_glob=./splitio/_OLD/*
 addopts = --verbose --cov=splitio --cov-report xml
 python_classes=*Tests
 

setup.py

@@ -6,20 +6,24 @@
 
 TESTS_REQUIRES = [
     'flake8',
-    'pytest==7.1.0',
+    'pytest==7.0.1',
     'pytest-mock==3.11.1',
-    'coverage==7.2.7',
-    'pytest-cov',
+    'coverage',
+    'pytest-cov==4.1.0',
     'importlib-metadata==6.7',
-    'tomli',
-    'iniconfig',
-    'attrs'
+    'tomli==1.2.3',
+    'iniconfig==1.1.1',
+    'attrs==22.1.0',
+    'pytest-asyncio==0.21.0',
+    'aiohttp>=3.8.4',
+    'aiofiles>=23.1.0'
 ]
 
 INSTALL_REQUIRES = [
     'requests',
     'pyyaml',
     'docopt>=0.6.2',
+    'enum34;python_version<"3.4"',
     'bloom-filter2>=2.0.0'
 ]
 
@@ -42,8 +46,9 @@
         'redis': ['redis>=2.10.5'],
         'uwsgi': ['uwsgi>=2.0.0'],
         'cpphash': ['mmh3cffi==0.2.1'],
+        'asyncio': ['aiohttp>=3.8.4', 'aiofiles>=23.1.0']
     },
-    setup_requires=['pytest-runner', 'pluggy==1.0.0;python_version<"3.7"'],
+    setup_requires=['pytest-runner', 'pluggy==1.0.0;python_version<"3.8"'],
     classifiers=[
         'Environment :: Console',
         'Intended Audience :: Developers',

splitio/__init__.py

@@ -1,3 +1,3 @@
-from splitio.client.factory import get_factory
+from splitio.client.factory import get_factory, get_factory_async
 from splitio.client.key import Key
 from splitio.version import __version__

splitio/api/__init__.py

@@ -13,3 +13,34 @@ def __init__(self, custom_message, status_code=None):
     def status_code(self):
         """Return HTTP status code."""
         return self._status_code
+
+class APIUriException(APIException):
+    """Exception to raise when an API call fails due to 414  http error."""
+
+    def __init__(self, custom_message, status_code=None):
+        """Constructor."""
+        APIException.__init__(self, custom_message, status_code)
+
+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

splitio/api/auth.py

@@ -3,7 +3,7 @@
 import logging
 import json
 
-from splitio.api import APIException
+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
@@ -32,6 +32,7 @@ def __init__(self, client, sdk_key, sdk_metadata, telemetry_runtime_producer):
         self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._client.set_telemetry_data(HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
 
     def authenticate(self):
         """
@@ -40,18 +41,17 @@ def authenticate(self):
         :return: Json representation of an authentication.
         :rtype: splitio.models.token.Token
         """
-        start = get_current_epoch_time_ms()
         try:
             response = self._client.get(
                 'auth',
-                '/v2/auth?s=' + SPEC_VERSION,
+                'v2/auth?s=' + SPEC_VERSION,
                 self._sdk_key,
                 extra_headers=self._metadata,
             )
-            record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
             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()
@@ -60,3 +60,50 @@ def authenticate(self):
             _LOGGER.error('Exception raised while authenticating')
             _LOGGER.debug('Exception information: ', exc_info=True)
             raise APIException('Could not perform authentication.') from exc
+
+class AuthAPIAsync(object):  # pylint: disable=too-few-public-methods
+    """Async Class that uses an httpClient to communicate with the SDK Auth Service API."""
+
+    def __init__(self, client, sdk_key, sdk_metadata, telemetry_runtime_producer):
+        """
+        Class constructor.
+
+        :param client: HTTP Client responsble for issuing calls to the backend.
+        :type client: HttpClient
+        :param sdk_key: User sdk key.
+        :type sdk_key: string
+        :param sdk_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio.client.util.SdkMetadata
+        """
+        self._client = client
+        self._sdk_key = sdk_key
+        self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._client.set_telemetry_data(HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
+
+    async def authenticate(self):
+        """
+        Perform authentication.
+
+        :return: Json representation of an authentication.
+        :rtype: splitio.models.token.Token
+        """
+        try:
+            response = await self._client.get(
+                'auth',
+                'v2/auth?s=' + SPEC_VERSION,
+                self._sdk_key,
+                extra_headers=self._metadata,
+            )
+            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()
+                raise APIException(response.body, response.status_code)
+        except HttpClientException as exc:
+            _LOGGER.error('Exception raised while authenticating')
+            _LOGGER.debug('Exception information: ', exc_info=True)
+            raise APIException('Could not perform authentication.') from exc