diff --git a/pyproject.toml b/pyproject.toml index 1cbf4c7..7bf0f24 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] -dynamic = ["version"] name = "edge-proxy" +version = "2.23.0" license = { file = "LICENSE" } dependencies = [ "fastapi", diff --git a/src/edge_proxy/environments.py b/src/edge_proxy/environments.py index 880930e..912507c 100644 --- a/src/edge_proxy/environments.py +++ b/src/edge_proxy/environments.py @@ -2,6 +2,7 @@ from datetime import datetime from email.utils import formatdate from functools import lru_cache +from importlib.metadata import PackageNotFoundError, version import httpx import starlette.status @@ -34,6 +35,18 @@ SERVER_API_KEY_PREFIX = "ser." +def _get_user_agent() -> str: + try: + edge_proxy_version = version("edge-proxy") + except PackageNotFoundError: + edge_proxy_version = "unknown" + return f"flagsmith-edge-proxy-python/{edge_proxy_version}" + + +# Lets the Flagsmith API attribute usage to Edge Proxy. +USER_AGENT = _get_user_agent() + + def _get_hide_disabled_flags(environment_document: dict[str, Any]) -> bool: return environment_document.get("project", {}).get("hide_disabled_flags", False) @@ -179,7 +192,9 @@ def get_environment( raise FlagsmithUnknownKeyError(environment_key) async def _fetch_document(self, key_pair: EnvironmentKeyPair) -> dict[str, Any]: + # Set per request so injected clients also send it. headers = { + "User-Agent": USER_AGENT, "X-Environment-Key": key_pair.server_side_key, } environment_document = self.cache.get_environment( diff --git a/tests/test_environments.py b/tests/test_environments.py index 245b259..83faf99 100644 --- a/tests/test_environments.py +++ b/tests/test_environments.py @@ -1,6 +1,9 @@ import copy +import tomllib import unittest.mock from datetime import datetime +from importlib.metadata import PackageNotFoundError +from pathlib import Path import httpx import pytest @@ -8,7 +11,7 @@ from orjson import orjson from pytest_mock import MockerFixture -from edge_proxy.environments import EnvironmentService +from edge_proxy.environments import USER_AGENT, EnvironmentService, _get_user_agent from edge_proxy.exceptions import ( FeatureNotFoundError, FlagsmithUnknownKeyError, @@ -55,17 +58,19 @@ async def test_refresh_makes_correct_http_call(mocker: MockerFixture): mocker.call( url=f"{settings.api_url}/environment-document/", headers={ + "User-Agent": USER_AGENT, "X-Environment-Key": settings.environment_key_pairs[ 0 - ].server_side_key + ].server_side_key, }, ), mocker.call( url=f"{settings.api_url}/environment-document/", headers={ + "User-Agent": USER_AGENT, "X-Environment-Key": settings.environment_key_pairs[ 1 - ].server_side_key + ].server_side_key, }, ), ] @@ -443,3 +448,53 @@ async def test_get_identity_flags_response_skips_filter_for_server_key( flags = result.get("flags") assert len(flags) == 3 assert flags[2].get("feature").get("name") == "feature_3" + + +async def test_user_agent__returns_edge_proxy_name_and_version() -> None: + # Given + pyproject = tomllib.loads( + (Path(__file__).parent.parent / "pyproject.toml").read_text() + ) + + # When + user_agent = _get_user_agent() + + # Then + assert ( + user_agent == f"flagsmith-edge-proxy-python/{pyproject['project']['version']}" + ) + assert user_agent == USER_AGENT + + +async def test_user_agent__version_not_found__returns_unknown( + mocker: MockerFixture, +) -> None: + # Given + mocker.patch("edge_proxy.environments.version", side_effect=PackageNotFoundError) + + # When + user_agent = _get_user_agent() + + # Then + assert user_agent == "flagsmith-edge-proxy-python/unknown" + + +async def test_refresh_environment_caches__sends_user_agent_header() -> None: + # Given + requests: list[httpx.Request] = [] + + def handler(request: httpx.Request) -> httpx.Response: + requests.append(request) + return httpx.Response(200, json={"api_key": "value"}) + + environment_service = EnvironmentService( + client=httpx.AsyncClient(transport=httpx.MockTransport(handler)), + settings=settings, + ) + + # When + await environment_service.refresh_environment_caches() + + # Then + assert len(requests) == len(settings.environment_key_pairs) + assert all(request.headers["User-Agent"] == USER_AGENT for request in requests)