add metadata headers to splits & segments endpoint

Author: mredolatti

splitio/api/segments.py

@@ -5,7 +5,7 @@
 
 from future.utils import raise_from
 
-from splitio.api import APIException
+from splitio.api import APIException, headers_from_metadata
 from splitio.api.client import HttpClientException
 
 
@@ -15,17 +15,21 @@
 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):
+    def __init__(self, http_client, apikey, sdk_metadata):
         """
         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_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio.client.util.SdkMetadata
+
         """
         self._client = http_client
         self._apikey = apikey
+        self._metadata = headers_from_metadata(sdk_metadata)
 
     def fetch_segment(self, segment_name, change_number):
         """
@@ -44,7 +48,8 @@ def fetch_segment(self, segment_name, change_number):
                 'sdk',
                 '/segmentChanges/{segment_name}'.format(segment_name=segment_name),
                 self._apikey,
-                {'since': change_number}
+                extra_headers=self._metadata,
+                query={'since': change_number}
             )
 
             if 200 <= response.status_code < 300:

splitio/api/splits.py

@@ -5,7 +5,7 @@
 
 from future.utils import raise_from
 
-from splitio.api import APIException
+from splitio.api import APIException, headers_from_metadata
 from splitio.api.client import HttpClientException
 
 
@@ -15,17 +15,20 @@
 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):
+    def __init__(self, client, apikey, sdk_metadata):
         """
         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_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio.client.util.SdkMetadata
         """
         self._client = client
         self._apikey = apikey
+        self._metadata = headers_from_metadata(sdk_metadata)
 
     def fetch_splits(self, change_number):
         """
@@ -42,7 +45,8 @@ def fetch_splits(self, change_number):
                 'sdk',
                 '/splitChanges',
                 self._apikey,
-                {'since': change_number}
+                extra_headers=self._metadata,
+                query={'since': change_number}
             )
             if 200 <= response.status_code < 300:
                 return json.loads(response.body)

splitio/client/factory.py

@@ -261,8 +261,8 @@ def _build_in_memory_factory(api_key, cfg, sdk_url=None, events_url=None,  # pyl
     sdk_metadata = util.get_metadata(cfg)
     apis = {
         'auth': AuthAPI(http_client, api_key, sdk_metadata),
-        'splits': SplitsAPI(http_client, api_key),
-        'segments': SegmentsAPI(http_client, api_key),
+        'splits': SplitsAPI(http_client, api_key, sdk_metadata),
+        'segments': SegmentsAPI(http_client, api_key, sdk_metadata),
         'impressions': ImpressionsAPI(http_client, api_key, sdk_metadata, cfg['impressionsMode']),
         'events': EventsAPI(http_client, api_key, sdk_metadata),
         'telemetry': TelemetryAPI(http_client, api_key, sdk_metadata)

splitio/tasks/uwsgi_wrappers.py

@@ -45,10 +45,12 @@ def uwsgi_update_splits(user_config):
     :type user_config: dict
     """
     config = _get_config(user_config)
+    metadata = get_metadata(config)
     seconds = config['featuresRefreshRate']
     split_sync = SplitSynchronizer(
         SplitsAPI(
-            HttpClient(1500, config.get('sdk_url'), config.get('events_url')), config['apikey']
+            HttpClient(1500, config.get('sdk_url'), config.get('events_url')), config['apikey'],
+            metadata
         ),
         UWSGISplitStorage(get_uwsgi()),
     )
@@ -71,9 +73,11 @@ def uwsgi_update_segments(user_config):
     """
     config = _get_config(user_config)
     seconds = config['segmentsRefreshRate']
+    metadata = get_metadata(config)
     segment_sync = SegmentSynchronizer(
         SegmentsAPI(
-            HttpClient(1500, config.get('sdk_url'), config.get('events_url')), config['apikey']
+            HttpClient(1500, config.get('sdk_url'), config.get('events_url')), config['apikey'],
+            metadata
         ),
         UWSGISplitStorage(get_uwsgi()),
         UWSGISegmentStorage(get_uwsgi()),

splitio/version.py

@@ -1 +1 @@
-__version__ = '8.3.1-rc1'
+__version__ = '8.3.1-rc2'

tests/api/test_segments_api.py

@@ -2,6 +2,7 @@
 
 import pytest
 from splitio.api import segments, client, APIException
+from splitio.client.util import SdkMetadata
 
 
 class SegmentAPITests(object):
@@ -11,11 +12,17 @@ def test_fetch_segment_changes(self, mocker):
         """Test segment changes fetching API call."""
         httpclient = mocker.Mock(spec=client.HttpClient)
         httpclient.get.return_value = client.HttpResponse(200, '{"prop1": "value1"}')
-        segment_api = segments.SegmentsAPI(httpclient, 'some_api_key')
+        segment_api = segments.SegmentsAPI(httpclient, 'some_api_key', SdkMetadata('1.0', 'some', '1.2.3.4'))
         response = segment_api.fetch_segment('some_segment', 123)
 
         assert response['prop1'] == 'value1'
-        assert httpclient.get.mock_calls == [mocker.call('sdk', '/segmentChanges/some_segment', 'some_api_key', {'since': 123})]
+        assert httpclient.get.mock_calls == [mocker.call('sdk', '/segmentChanges/some_segment', 'some_api_key', 
+                                                         extra_headers={
+                                                             'SplitSDKVersion': '1.0', 
+                                                             'SplitSDKMachineIP': '1.2.3.4', 
+                                                             'SplitSDKMachineName': 'some'
+                                                         },
+                                                         query={'since': 123})]
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):

tests/api/test_splits_api.py

@@ -2,6 +2,7 @@
 
 import pytest
 from splitio.api import splits, client, APIException
+from splitio.client.util import SdkMetadata
 
 
 class SplitAPITests(object):
@@ -11,11 +12,17 @@ def test_fetch_split_changes(self, mocker):
         """Test split changes fetching API call."""
         httpclient = mocker.Mock(spec=client.HttpClient)
         httpclient.get.return_value = client.HttpResponse(200, '{"prop1": "value1"}')
-        split_api = splits.SplitsAPI(httpclient, 'some_api_key')
+        split_api = splits.SplitsAPI(httpclient, 'some_api_key', SdkMetadata('1.0', 'some', '1.2.3.4'))
         response = split_api.fetch_splits(123)
 
         assert response['prop1'] == 'value1'
-        assert httpclient.get.mock_calls == [mocker.call('sdk', '/splitChanges', 'some_api_key', {'since': 123})]
+        assert httpclient.get.mock_calls == [mocker.call('sdk', '/splitChanges', 'some_api_key', 
+                                                         extra_headers={
+                                                             'SplitSDKVersion': '1.0', 
+                                                             'SplitSDKMachineIP': '1.2.3.4', 
+                                                             'SplitSDKMachineName': 'some'
+                                                         },
+                                                         query={'since': 123})]
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):