fix: incomplete/incorrect headers sent when establishing event hub connection (#13)

Co-authored-by: Octavian Ionescu <[email protected]>
Co-authored-by: erhe <[email protected]>

Author: octavian-ionescu

source/ftrack_api/event/hub.py

@@ -126,9 +126,16 @@ def __init__(self, server_url, api_user, api_key, headers=None, cookies=None):
             url_parse_result.hostname,
             url_parse_result.port
         )
-        
-        self._cookies = cookies or {}
-        self._headers = headers or {}
+
+        def _validate_mapping(mapping):
+            '''Validate mapping is a mapping type and return as dict.'''
+            if not isinstance(mapping, collections_abc.Mapping):
+                raise TypeError('Expected mapping, got {0!r}.'.format(mapping))
+
+            return dict(mapping)
+
+        self._cookies = _validate_mapping(cookies or {})
+        self._headers = _validate_mapping(headers or {})
 
     def get_server_url(self):
         '''Return URL to server.'''

source/ftrack_api/session.py

@@ -250,22 +250,28 @@ def __init__(
         self._managed_request = None
         self._request = requests.Session()
 
-        if cookies is not None:
+        if cookies:
             if not isinstance(cookies, collections_abc.Mapping):
                 raise TypeError('The cookies argument is required to be a mapping.')
             self._request.cookies.update(cookies)
-        
-        if headers is not None:
+
+        if headers:
             if not isinstance(headers, collections_abc.Mapping):
                 raise TypeError('The headers argument is required to be a mapping.')
-            self._request.headers.update(headers)
+
+            headers = dict(headers)
+
+        else:
+            headers = {}
 
         if not isinstance(strict_api, bool):
             raise TypeError('The strict_api argument is required to be a boolean.')
-        self._request.headers.update(
+
+        headers.update(
             {'ftrack-strict-api': 'true' if strict_api is True else 'false'}
         )
-        
+
+        self._request.headers.update(headers)
         self._request.auth = SessionAuthentication(
             self._api_key, self._api_user
         )
@@ -287,7 +293,7 @@ def __init__(
             self._server_url,
             self._api_user,
             self._api_key,
-            headers=self._request.headers,
+            headers=headers,
             cookies=requests.utils.dict_from_cookiejar(self._request.cookies)
         )
 

test/unit/event/test_hub.py

@@ -7,6 +7,7 @@
 import time
 import subprocess
 import sys
+import requests
 import logging
 
 import pytest
@@ -181,15 +182,28 @@ def test_connect_custom_headers(session):
     event_hub.disconnect()
 
 
-def test_connect_strict_api_header(session):
+@pytest.mark.parametrize(
+    'headers', [
+        (
+            requests.structures.CaseInsensitiveDict(
+                {'ftrack-strict-api': 'true'}
+            )
+        ),
+        (
+            {'ftrack-strict-api': 'true'}
+        )
+    ]
+)
+def test_connect_strict_api_header(session, headers):
     '''Connect with ftrack-strict-api = True header passed in.'''
     event_hub = ftrack_api.event.hub.EventHub(
-        session.server_url, session.api_user, session.api_key, headers={'ftrack-strict-api': 'true'}
+        session.server_url, session.api_user, session.api_key, headers=headers
     )
     event_hub.connect()
 
     assert (
         'ftrack-strict-api' in event_hub._headers.keys(),
+        isinstance(event_hub._headers, dict),
         event_hub._headers['ftrack-strict-api'] is True,
         event_hub.connected is True
     )