Merge pull request #373 from splitio/development

Release 9.4.2

Author: chillaq

CHANGES.txt

@@ -1,3 +1,8 @@
+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.
+- Fixed setting defaultTreatment to 'control' if it is missing in localhost JSON file.
+
 9.4.1 (Apr 18, 2023)
 - Fixed storing incorrect Telemetry method latency data
 
@@ -103,7 +108,7 @@
 7.0.1 (Mar 8, 2019)
  - Updated Splits refreshing rate.
  - Replaced exception log level to error level.
- - Improved validation for apikey.
+ - Improved validation for sdkkey.
 
 7.0.0 (Feb 21, 2019)
  - BREAKING CHANGE: Stored Impressions in Queue.

README.md

@@ -22,7 +22,7 @@ factory = get_factory('YOUR_SDK_TYPE_API_KEY', config=config)
 try:
     factory.block_until_ready(5) # wait up to 5 seconds
     split = factory.client()
-    treatment = split.get_treatment('CUSTOMER_ID', 'SPLIT_NAME')
+    treatment = split.get_treatment('CUSTOMER_ID', 'FEATURE_FLAG_NAME')
     if treatment == "on":
         # insert code here to show on treatment
     elif treatment == "off":
@@ -54,16 +54,21 @@ To learn more about Split, contact hello@split.io, or get started with feature f
 
 Split has built and maintains SDKs for:
 
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
+* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
-* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
-* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
-* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
+* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
+* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
+* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 
 For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
 

doc/source/introduction.rst

@@ -166,7 +166,7 @@ The client depends on the information for features and segments being updated ex
 The scripts are configured through a JSON settings file, like the following: ::
 
     {
-      "apiKey": "some-api-key",
+      "sdkKey": "some-sdk-key",
       "sdkApiBaseUrl": "https://sdk.split.io/api",
       "eventsApiBaseUrl": "https://events.split.io/api",
       "redisFactory": 'some.redis.factory',
@@ -180,7 +180,7 @@ These are the possible configuration parameters:
 +------------------------+------+--------------------------------------------------------+-------------------------------+
 | Key                    | Type | Description                                            | Default                       |
 +========================+======+========================================================+===============================+
-| apiKey                 | str  | A valid Split.io API key.                              | None                          |
+| sdkKey                 | str  | A valid Split.io SDK key.                              | None                          |
 +------------------------+------+--------------------------------------------------------+-------------------------------+
 | sdkApiBaseUrl          | str  | The SDK API url base                                   | "https://sdk.split.io/api"    |
 +------------------------+------+--------------------------------------------------------+-------------------------------+
@@ -238,7 +238,7 @@ On the other hand, there is available a python script named ``splitio.bin.synchr
         The configuration file is a JSON file with the following fields:
 
         {
-          "apiKey": "YOUR_API_KEY",
+          "sdkKey": "YOUR_SDK_KEY",
           "redisHost": "REDIS_DNS_OR_IP",
           "redisPort": 6379,
           "redisDb": 0
@@ -274,7 +274,7 @@ In order to support Redis' Sentinel host discovery, you need to provide a custom
 Afterwards you tell the client to use this factory using the config file: ::
 
   {
-    "apiKey": "some-api-key",
+    "sdkKey": "some-sdk-key",
     "sdkApiBaseUrl": "https://sdk.split.io/api",
     "eventsApiBaseUrl": "https://events.split.io/api",
     "redisFactory": 'redis_config.my_redis_factory'

splitio/api/auth.py

@@ -16,19 +16,19 @@
 class AuthAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the SDK Auth Service API."""
 
-    def __init__(self, client, apikey, sdk_metadata, telemetry_runtime_producer):
+    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 apikey: User apikey token.
-        :type apikey: string
+        :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._apikey = apikey
+        self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
@@ -44,7 +44,7 @@ def authenticate(self):
             response = self._client.get(
                 'auth',
                 '/v2/auth',
-                self._apikey,
+                self._sdk_key,
                 extra_headers=self._metadata,
             )
             record_telemetry(response.status_code, get_current_epoch_time_ms() - start, HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)

splitio/api/client.py

@@ -66,28 +66,28 @@ def _build_url(self, server, path):
         return self._urls[server] + path
 
     @staticmethod
-    def _build_basic_headers(apikey):
+    def _build_basic_headers(sdk_key):
         """
         Build basic headers with auth.
 
-        :param apikey: API token used to identify backend calls.
-        :type apikey: str
+        :param sdk_key: API token used to identify backend calls.
+        :type sdk_key: str
         """
         return {
             'Content-Type': 'application/json',
-            'Authorization': "Bearer %s" % apikey
+            'Authorization': "Bearer %s" % sdk_key
         }
 
-    def get(self, server, path, apikey, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
+    def get(self, server, path, sdk_key, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
         """
         Issue a get request.
 
         :param server: Whether the request is for SDK server, Events server or Auth server.
         :typee server: str
         :param path: path to append to the host url.
         :type path: str
-        :param apikey: api token.
-        :type apikey: str
+        :param sdk_key: sdk key.
+        :type sdk_key: str
         :param query: Query string passed as dictionary.
         :type query: dict
         :param extra_headers: key/value pairs of possible extra headers.
@@ -96,7 +96,7 @@ def get(self, server, path, apikey, query=None, extra_headers=None):  # pylint:
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = self._build_basic_headers(apikey)
+        headers = self._build_basic_headers(sdk_key)
         if extra_headers is not None:
             headers.update(extra_headers)
 
@@ -111,16 +111,16 @@ def get(self, server, path, apikey, query=None, extra_headers=None):  # pylint:
         except Exception as exc:  # pylint: disable=broad-except
             raise HttpClientException('requests library is throwing exceptions') from exc
 
-    def post(self, server, path, apikey, body, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
+    def post(self, server, path, sdk_key, body, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
         """
         Issue a POST request.
 
         :param server: Whether the request is for SDK server or Events server.
         :typee server: str
         :param path: path to append to the host url.
         :type path: str
-        :param apikey: api token.
-        :type apikey: str
+        :param sdk_key: sdk key.
+        :type sdk_key: str
         :param body: body sent in the request.
         :type body: str
         :param query: Query string passed as dictionary.
@@ -131,7 +131,7 @@ def post(self, server, path, apikey, body, query=None, extra_headers=None):  # p
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = self._build_basic_headers(apikey)
+        headers = self._build_basic_headers(sdk_key)
 
         if extra_headers is not None:
             headers.update(extra_headers)

splitio/api/events.py

@@ -15,19 +15,19 @@
 class EventsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the events API."""
 
-    def __init__(self, http_client, apikey, sdk_metadata, telemetry_runtime_producer):
+    def __init__(self, http_client, sdk_key, sdk_metadata, telemetry_runtime_producer):
         """
         Class constructor.
 
         :param http_client: HTTP Client responsble for issuing calls to the backend.
         :type http_client: HttpClient
-        :param apikey: User apikey token.
-        :type apikey: string
+        :param sdk_key: sdk key.
+        :type sdk_key: string
         :param sdk_metadata: SDK version & machine name & IP.
         :type sdk_metadata: splitio.client.util.SdkMetadata
         """
         self._client = http_client
-        self._apikey = apikey
+        self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
@@ -70,7 +70,7 @@ def flush_events(self, events):
             response = self._client.post(
                 'events',
                 '/events/bulk',
-                self._apikey,
+                self._sdk_key,
                 body=bulk,
                 extra_headers=self._metadata,
             )

splitio/api/impressions.py

@@ -17,17 +17,17 @@
 class ImpressionsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the impressions API."""
 
-    def __init__(self, client, apikey, sdk_metadata, telemetry_runtime_producer, mode=ImpressionsMode.OPTIMIZED):
+    def __init__(self, client, sdk_key, sdk_metadata, telemetry_runtime_producer, mode=ImpressionsMode.OPTIMIZED):
         """
         Class constructor.
 
         :param client: HTTP Client responsble for issuing calls to the backend.
         :type client: HttpClient
-        :param apikey: User apikey token.
-        :type apikey: string
+        :param sdk_key: sdk key.
+        :type sdk_key: string
         """
         self._client = client
-        self._apikey = apikey
+        self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._metadata['SplitSDKImpressionsMode'] = mode.name
         self._telemetry_runtime_producer = telemetry_runtime_producer
@@ -99,7 +99,7 @@ def flush_impressions(self, impressions):
             response = self._client.post(
                 'events',
                 '/testImpressions/bulk',
-                self._apikey,
+                self._sdk_key,
                 body=bulk,
                 extra_headers=self._metadata,
             )
@@ -126,7 +126,7 @@ def flush_counters(self, counters):
             response = self._client.post(
                 'events',
                 '/testImpressions/count',
-                self._apikey,
+                self._sdk_key,
                 body=bulk,
                 extra_headers=self._metadata,
             )

splitio/api/segments.py

@@ -17,20 +17,20 @@
 class SegmentsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the segments API."""
 
-    def __init__(self, http_client, apikey, sdk_metadata, telemetry_runtime_producer):
+    def __init__(self, http_client, sdk_key, sdk_metadata, telemetry_runtime_producer):
         """
         Class constructor.
 
         :param client: HTTP Client responsble for issuing calls to the backend.
         :type client: client.HttpClient
-        :param apikey: User apikey token.
-        :type apikey: string
+        :param sdk_key: User sdk_key token.
+        :type sdk_key: string
         :param sdk_metadata: SDK version & machine name & IP.
         :type sdk_metadata: splitio.client.util.SdkMetadata
 
         """
         self._client = http_client
-        self._apikey = apikey
+        self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
@@ -56,7 +56,7 @@ def fetch_segment(self, segment_name, change_number, fetch_options):
             response = self._client.get(
                 'sdk',
                 '/segmentChanges/{segment_name}'.format(segment_name=segment_name),
-                self._apikey,
+                self._sdk_key,
                 extra_headers=extra_headers,
                 query=query,
             )

splitio/api/splits.py

@@ -16,30 +16,30 @@
 class SplitsAPI(object):  # pylint: disable=too-few-public-methods
     """Class that uses an httpClient to communicate with the splits API."""
 
-    def __init__(self, client, apikey, sdk_metadata, telemetry_runtime_producer):
+    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 apikey: User apikey token.
-        :type apikey: string
+        :param sdk_key: User sdk_key token.
+        :type sdk_key: string
         :param sdk_metadata: SDK version & machine name & IP.
         :type sdk_metadata: splitio.client.util.SdkMetadata
         """
         self._client = client
-        self._apikey = apikey
+        self._sdk_key = sdk_key
         self._metadata = headers_from_metadata(sdk_metadata)
         self._telemetry_runtime_producer = telemetry_runtime_producer
 
     def fetch_splits(self, change_number, fetch_options):
         """
-        Fetch splits from backend.
+        Fetch feature flags from backend.
 
         :param change_number: Last known timestamp of a split modification.
         :type change_number: int
 
-        :param fetch_options: Fetch options for getting split definitions.
+        :param fetch_options: Fetch options for getting feature flag definitions.
         :type fetch_options: splitio.api.commons.FetchOptions
 
         :return: Json representation of a splitChanges response.
@@ -51,7 +51,7 @@ def fetch_splits(self, change_number, fetch_options):
             response = self._client.get(
                 'sdk',
                 '/splitChanges',
-                self._apikey,
+                self._sdk_key,
                 extra_headers=extra_headers,
                 query=query,
             )
@@ -61,6 +61,6 @@ def fetch_splits(self, change_number, fetch_options):
             else:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            _LOGGER.error('Error fetching splits because an exception was raised by the HTTPClient')
+            _LOGGER.error('Error fetching feature flags because an exception was raised by the HTTPClient')
             _LOGGER.debug('Error: ', exc_info=True)
-            raise APIException('Splits not fetched correctly.') from exc
+            raise APIException('Feature flags not fetched correctly.') from exc