chore(user-agent): add runtime info (#86)

Author: Filip1x9

src/fds/sdk/utils/authentication/confidential.py

@@ -187,11 +187,16 @@ def _init_auth_server_metadata(self) -> None:
             if self._ssl_ca_cert:
                 verify = self._ssl_ca_cert
 
+            headers = {
+                "User-Agent": CONSTS.USER_AGENT,
+                **(self._proxy_headers if self._proxy_headers else {}),
+            }
+
             res = self._requests_session.get(
                 url=self._config[CONSTS.CONFIG_WELL_KNOWN_URI],
                 proxies=self._proxy,
                 verify=verify,
-                headers=self._proxy_headers,
+                headers=headers,
             )
             log.debug("Request from well_known_uri completed with status: %s", res.status_code)
             log.debug("Response headers from well_known_uri were %s", res.headers)
@@ -281,6 +286,7 @@ def get_access_token(self) -> str:
             headers = {
                 "Accept": "application/json",
                 "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
+                "User-Agent": CONSTS.USER_AGENT,
             }
 
             if self._proxy_headers:

src/fds/sdk/utils/authentication/constants.py

@@ -1,3 +1,6 @@
+import platform
+
+
 class CONSTS:
     # confidential client assertion JWT
     CC_JWT_NOT_BEFORE_SECS = 5
@@ -25,5 +28,7 @@ class CONSTS:
     # default values
     FACTSET_WELL_KNOWN_URI = "https://auth.factset.com/.well-known/openid-configuration"
 
+    USER_AGENT = f"fds-sdk/python/utils/2.0.1 ({platform.system()}; Python {platform.python_version()})"
+
 
 CONSTS = CONSTS()

tests/fds/sdk/utils/authentication/test_confidential.py

@@ -1,5 +1,6 @@
 import json
 import logging
+import platform
 from unittest.mock import ANY, mock_open
 
 import pytest
@@ -202,7 +203,7 @@ def json(self):
         url="https://auth.factset.com/.well-known/openid-configuration",
         proxies={"http": "http://my:pass@test.test.test", "https": "http://my:pass@test.test.test"},
         verify=False,
-        headers={},
+        headers={"User-Agent": f"fds-sdk/python/utils/2.0.1 ({platform.system()}; Python {platform.python_version()})"},
     )
 
 
@@ -228,7 +229,12 @@ def json(self):
 
     client = ConfidentialClient(config=example_config)
 
-    get_mock.assert_called_with(url=auth_test, proxies=None, verify=True, headers=None)
+    get_mock.assert_called_with(
+        url=auth_test,
+        proxies=None,
+        verify=True,
+        headers={"User-Agent": f"fds-sdk/python/utils/2.0.1 ({platform.system()}; Python {platform.python_version()})"},
+    )
     assert client
 
     assert "Attempting metadata retrieval from well_known_uri: https://auth.test" in caplog.text
@@ -372,6 +378,7 @@ def test_get_access_token_fetch(client, mocker):
         headers={
             "Accept": "application/json",
             "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
+            "User-Agent": f"fds-sdk/python/utils/2.0.1 ({platform.system()}; Python {platform.python_version()})",
         },
     )