feat: add X-Client-Info to default headers

supabase · Nov 16, 2021 · ec2c893 · ec2c893
1 parent 283bd9f
commit ec2c893
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/gotrue/constants.py b/gotrue/constants.py
@@ -1,8 +1,12 @@
 from __future__ import annotations
 
+from gotrue import __version__
+
 GOTRUE_URL = "http://localhost:9999"
 AUDIENCE = ""
-DEFAULT_HEADERS = {}
+DEFAULT_HEADERS = {
+    "X-Client-Info": f"gotrue-py/{__version__}",
+}
 EXPIRY_MARGIN = 60 * 1000
 STORAGE_KEY = "supabase.auth.token"
 COOKIE_OPTIONS = {

diff --git a/tests/_async/test_client_with_sign_ups_disabled.py b/tests/_async/test_client_with_sign_ups_disabled.py
@@ -4,7 +4,7 @@
 from faker import Faker
 
 from gotrue import AsyncGoTrueAPI, AsyncGoTrueClient
-from gotrue.constants import COOKIE_OPTIONS
+from gotrue.constants import COOKIE_OPTIONS, DEFAULT_HEADERS
 from gotrue.exceptions import APIError
 from gotrue.types import CookieOptions, LinkType, User, UserAttributes
 
@@ -118,3 +118,12 @@ async def test_create_user(auth_admin: AsyncGoTrueAPI):
         assert user.email == email2
     except Exception as e:
         assert False, str(e)
+
+
+@pytest.mark.asyncio
+def test_default_headers(client: AsyncGoTrueClient):
+    """Test client for existing default headers"""
+    default_key = "X-Client-Info"
+    assert default_key in DEFAULT_HEADERS
+    assert default_key in client.api.headers
+    assert client.api.headers[default_key] == DEFAULT_HEADERS[default_key]
diff --git a/tests/_sync/test_client_with_sign_ups_disabled.py b/tests/_sync/test_client_with_sign_ups_disabled.py
@@ -4,7 +4,7 @@
 from faker import Faker
 
 from gotrue import SyncGoTrueAPI, SyncGoTrueClient
-from gotrue.constants import COOKIE_OPTIONS
+from gotrue.constants import COOKIE_OPTIONS, DEFAULT_HEADERS
 from gotrue.exceptions import APIError
 from gotrue.types import CookieOptions, LinkType, User, UserAttributes
 
@@ -118,3 +118,12 @@ def test_create_user(auth_admin: SyncGoTrueAPI):
         assert user.email == email2
     except Exception as e:
         assert False, str(e)
+
+
+@pytest.mark.asyncio
+def test_default_headers(client: SyncGoTrueClient):
+    """Test client for existing default headers"""
+    default_key = "X-Client-Info"
+    assert default_key in DEFAULT_HEADERS
+    assert default_key in client.api.headers
+    assert client.api.headers[default_key] == DEFAULT_HEADERS[default_key]