Merge pull request #99 from clerk/tm/pinned-version

feat: Pinned header version

Author: tmilewski

src/clerk_backend_api/_hooks/clerk_before_request_hook.py

@@ -0,0 +1,16 @@
+from typing import Union
+
+import httpx
+
+from .types import (
+    BeforeRequestContext,
+    BeforeRequestHook,
+)
+
+class ClerkBeforeRequestHook(BeforeRequestHook):
+    def before_request(
+        self, hook_ctx: BeforeRequestContext, request: httpx.Request
+    ) -> Union[httpx.Request, Exception]:
+        request.headers["Clerk-API-Version"] = "2024-10-01"
+
+        return request

src/clerk_backend_api/_hooks/registration.py

@@ -1,3 +1,4 @@
+from .clerk_before_request_hook import ClerkBeforeRequestHook
 from .types import Hooks
 
 
@@ -11,3 +12,4 @@ def init_hooks(hooks: Hooks):
     """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook 
     with an instance of a hook that implements that specific Hook interface
     Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance"""
+    hooks.register_before_request_hook(ClerkBeforeRequestHook())

tests/test_clerk_before_request_hook.py

@@ -0,0 +1,82 @@
+import pytest
+import httpx
+
+from clerk_backend_api._hooks.clerk_before_request_hook import ClerkBeforeRequestHook
+from clerk_backend_api._hooks.types import (
+    BeforeRequestContext,
+    HookContext
+)
+
+@pytest.fixture
+def hook():
+    """ClerkBeforeRequestHook instance"""
+    return ClerkBeforeRequestHook()
+
+@pytest.fixture
+def hook_context():
+    """HookContext instance"""
+    return HookContext(
+        base_url="https://api.clerk.dev",
+        operation_id="test_operation",
+        oauth2_scopes=None,
+        security_source=None
+    )
+
+@pytest.fixture
+def before_request_context(hook_context):
+    """BeforeRequestContext instance"""
+    return BeforeRequestContext(hook_context)
+
+def test_before_request_adds_api_version_header(hook, before_request_context):
+    """Test that before_request adds the Clerk-API-Version header"""
+    # Create a request
+    request = httpx.Request("GET", "https://api.clerk.dev/v1/users")
+    
+    # Call the before_request method
+    modified_request = hook.before_request(before_request_context, request)
+    
+    # Assert that the request is returned (not an Exception)
+    assert isinstance(modified_request, httpx.Request)
+    
+    # Assert that the Clerk-API-Version header is added with the correct value
+    assert "Clerk-API-Version" in modified_request.headers
+    assert modified_request.headers["Clerk-API-Version"] == "2024-10-01"
+    
+    # Assert that the original request is modified, not a new one created
+    assert modified_request is request
+
+
+def test_before_request_preserves_existing_headers(hook, before_request_context):
+    """Test that before_request preserves existing headers"""
+    # Create a request with existing headers
+    request = httpx.Request(
+        "GET", 
+        "https://api.clerk.dev/v1/users",
+        headers={"Authorization": "Bearer sdk_test_foo", "Content-Type": "application/json"}
+    )
+    
+    # Call the before_request method
+    modified_request = hook.before_request(before_request_context, request)
+    
+    # Assert that existing headers are preserved
+    assert modified_request.headers["Authorization"] == "Bearer sdk_test_foo"
+    assert modified_request.headers["Content-Type"] == "application/json"
+    
+    # Assert that the Clerk-API-Version header is added
+    assert modified_request.headers["Clerk-API-Version"] == "2024-10-01"
+
+
+def test_before_request_overwrites_existing_api_version_header(hook, before_request_context):
+    """Test that before_request overwrites an existing Clerk-API-Version header"""
+    # Create a request with an existing Clerk-API-Version header
+    request = httpx.Request(
+        "GET", 
+        "https://api.clerk.dev/v1/users",
+        headers={"Clerk-API-Version": "2021-02-05"}
+    )
+    
+    # Call the before_request method
+    modified_request = hook.before_request(before_request_context, request)
+    
+    # Assert that the Clerk-API-Version header is overwritten
+    assert modified_request.headers["Clerk-API-Version"] == "2024-10-01"