comment suggestions, tests

Author: Gawor270

fishjam/_openapi_client/client.py

@@ -193,6 +193,9 @@ class AuthenticatedClient:
     prefix: str = "Bearer"
     auth_header_name: str = "Authorization"
 
+    api_prefix: str = "python-server"
+    api_header_name: str = "x-fishjam-api-client"
+
     def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
         """Get a new client matching this one with additional headers"""
         if self._client is not None:
@@ -231,7 +234,7 @@ def get_httpx_client(self) -> httpx.Client:
             self._headers[self.auth_header_name] = (
                 f"{self.prefix} {self.token}" if self.prefix else self.token
             )
-            self._headers["x-sdk_version"] = f"py-{get_version()}"
+            self._headers[self.api_header_name] = f"{self.api_prefix}-{get_version()}"
             self._client = httpx.Client(
                 base_url=self._base_url,
                 cookies=self._cookies,
@@ -268,7 +271,7 @@ def get_async_httpx_client(self) -> httpx.AsyncClient:
             self._headers[self.auth_header_name] = (
                 f"{self.prefix} {self.token}" if self.prefix else self.token
             )
-            self._headers["x-sdk_version"] = f"py-{get_version()}"
+            self._headers[self.api_header_name] = f"{self.api_prefix}-{get_version()}"
             self._async_client = httpx.AsyncClient(
                 base_url=self._base_url,
                 cookies=self._cookies,

tests/test_openapi_client_headers.py

@@ -0,0 +1,41 @@
+import pytest
+
+from fishjam._openapi_client.client import AuthenticatedClient
+from fishjam.version import get_version
+
+
+def test_authenticated_client_sets_sdk_and_auth_headers_sync():
+    client = AuthenticatedClient(
+        base_url="https://example.com",
+        token="token123",
+        headers={"custom": "value"},
+    )
+
+    httpx_client = client.get_httpx_client()
+    try:
+        headers = httpx_client.headers
+
+        assert headers[client.auth_header_name] == "Bearer token123"
+        assert headers[client.api_header_name] == f"{client.api_prefix}-{get_version()}"
+        assert headers["custom"] == "value"
+    finally:
+        httpx_client.close()
+
+
+@pytest.mark.asyncio
+async def test_authenticated_client_sets_sdk_and_auth_headers_async():
+    client = AuthenticatedClient(
+        base_url="https://example.com",
+        token="token456",
+        headers={"another": "header"},
+    )
+
+    async_client = client.get_async_httpx_client()
+    try:
+        headers = async_client.headers
+
+        assert headers[client.auth_header_name] == "Bearer token456"
+        assert headers[client.api_header_name] == f"{client.api_prefix}-{get_version()}"
+        assert headers["another"] == "header"
+    finally:
+        await async_client.aclose()