Merge pull request #13 from apilytics/user-agent

Send `User-Agent` information with metrics

Author: ruohola

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Send `User-Agent` information with metrics.
+
 ## [1.2.1] - 2022-02-01
 
 ### Fixed

README.md

@@ -81,6 +81,7 @@ def my_apilytics_middleware(request, get_response):
         query=request.query_string,
         method=request.method,
         request_size=len(request.body),
+        user_agent=request.headers.get("user-agent"),
     ) as sender:
         response = get_response(request)
         sender.set_response_info(

apilytics/core.py

@@ -30,6 +30,7 @@ class ApilyticsSender:
                 query=request.query_string,
                 method=request.method,
                 request_size=len(request.body),
+                user_agent=request.headers.get("user-agent"),
             ) as sender:
                 response = get_response(request)
                 sender.set_response_info(
@@ -52,6 +53,7 @@ def __init__(
         method: str,
         query: Optional[str] = None,
         request_size: Optional[int] = None,
+        user_agent: Optional[str] = None,
         apilytics_integration: Optional[str] = None,
         integrated_library: Optional[str] = None,
     ) -> None:
@@ -65,6 +67,7 @@ def __init__(
             query: Optional query string of the user's HTTP request e.g. "key=val&other=123".
                 An empty string and None are treated equally. Can have an optional "?" at the start.
             request_size: Size of the user's HTTP request's body in bytes.
+            user_agent: Value of the `User-Agent` header from the user's HTTP request.
             apilytics_integration: Name of the Apilytics integration that's calling this,
                 e.g. "apilytics-python-django". No need to pass this when calling from user code.
             integrated_library: Name and version of the integration that this is used in,
@@ -75,6 +78,7 @@ def __init__(
         self._method = method
         self._query = query
         self._request_size = request_size
+        self._user_agent = user_agent
 
         self._response_size: Optional[int] = None
         self._status_code: Optional[int] = None
@@ -136,7 +140,9 @@ def _send_metrics(self) -> None:
             "path": self._path,
             "method": self._method,
             "timeMillis": (self._end_time_ns - self._start_time_ns) // 1_000_000,
-            **({"query": self._query} if self._query else {}),  # Don't send empty str.
+            # Don't send empty strings.
+            **({"query": self._query} if self._query else {}),
+            **({"userAgent": self._user_agent} if self._user_agent else {}),
             **(
                 {"statusCode": self._status_code}
                 if self._status_code is not None

apilytics/django.py

@@ -48,6 +48,7 @@ def __call__(self, request: django.http.HttpRequest) -> django.http.HttpResponse
             query=request.META.get("QUERY_STRING"),
             method=request.method or "",  # Typed as Optional, should never be None.
             request_size=int(request.META.get("CONTENT_LENGTH", 0)),
+            user_agent=request.headers.get("user-agent"),
             apilytics_integration="apilytics-python-django",
             integrated_library=f"django/{django.__version__}",
         ) as sender:

apilytics/fastapi.py

@@ -56,6 +56,7 @@ async def dispatch(
             query=request.url.query,
             method=request.method,
             request_size=len(await request.body()),
+            user_agent=request.headers.get("user-agent"),
             apilytics_integration="apilytics-python-fastapi",
             integrated_library=f"fastapi/{fastapi.__version__}",
         ) as sender:

tests/django/test_django.py

@@ -6,15 +6,10 @@
 import apilytics
 import tests.conftest
 
-client = django.test.client.Client()
-
 
 def test_middleware_should_call_apilytics_api(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    # Refresh middleware to call `__init__` again making sure `MiddlewareNotUsed`
-    # is ether called or not called properly.
-    client.handler.load_middleware()
     response = client.get("/")
     assert response.status_code == 200
 
@@ -53,9 +48,8 @@ def test_middleware_should_call_apilytics_api(
 
 
 def test_middleware_should_send_query_params(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     response = client.post("/dummy/123/path/?param=foo&param2=bar")
     assert response.status_code == 201
 
@@ -71,10 +65,21 @@ def test_middleware_should_send_query_params(
     assert isinstance(data["timeMillis"], int)
 
 
+def test_middleware_should_send_user_agent(
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
+) -> None:
+    response = client.get("/dummy", HTTP_USER_AGENT="some agent")
+    assert response.status_code == 200
+
+    assert mocked_urlopen.call_count == 1
+    __, call_kwargs = mocked_urlopen.call_args
+    data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data["userAgent"] == "some agent"
+
+
 def test_middleware_should_handle_zero_request_and_response_sizes(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     response = client.post("/empty?some=query", content_type="application/json")
     assert response.status_code == 200
 
@@ -86,9 +91,8 @@ def test_middleware_should_handle_zero_request_and_response_sizes(
 
 
 def test_middleware_should_handle_non_zero_request_and_response_sizes(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     response = client.post(
         "/dummy?some=query", data={"hello": "world"}, content_type="application/json"
     )
@@ -102,9 +106,8 @@ def test_middleware_should_handle_non_zero_request_and_response_sizes(
 
 
 def test_middleware_should_work_with_streaming_response(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     response = client.get("/streaming")
     assert response.status_code == 200
     # Ignore: The attribute *does* exist on StreamingHTTPResponse.
@@ -130,19 +133,17 @@ def test_middleware_should_work_with_streaming_response(
 
 @django.test.override_settings(APILYTICS_API_KEY=None)
 def test_middleware_should_be_disabled_if_api_key_is_unset(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     response = client.get("/")
     assert response.status_code == 200
 
     assert mocked_urlopen.call_count == 0
 
 
 def test_middleware_should_send_data_even_on_errors(
-    mocked_urlopen: unittest.mock.MagicMock,
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:
-    client.handler.load_middleware()
     try:
         client.get("/error")
     except RuntimeError:

tests/fastapi/test_fastapi.py

@@ -42,13 +42,15 @@ def test_middleware_should_call_apilytics_api(
         "statusCode",
         "requestSize",
         "responseSize",
+        "userAgent",
         "timeMillis",
     }
     assert data["path"] == "/"
     assert data["method"] == "GET"
     assert data["statusCode"] == 200
     assert data["requestSize"] == 0
     assert data["responseSize"] > 0
+    assert data["userAgent"] == "testclient"
     assert isinstance(data["timeMillis"], int)
 
 
@@ -70,6 +72,18 @@ def test_middleware_should_send_query_params(
     assert isinstance(data["timeMillis"], int)
 
 
+def test_middleware_should_send_user_agent(
+    mocked_urlopen: unittest.mock.MagicMock,
+) -> None:
+    response = client.get("/dummy", headers={"User-Agent": "some agent"})
+    assert response.status_code == 200
+
+    assert mocked_urlopen.call_count == 1
+    __, call_kwargs = mocked_urlopen.call_args
+    data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data["userAgent"] == "some agent"
+
+
 def test_middleware_should_handle_zero_request_and_response_sizes(
     mocked_urlopen: unittest.mock.MagicMock,
 ) -> None:
@@ -112,12 +126,14 @@ def test_middleware_should_work_with_streaming_response(
         "method",
         "statusCode",
         "requestSize",
+        "userAgent",
         "timeMillis",
     }
     assert data["path"] == "/streaming"
     assert data["method"] == "GET"
     assert data["statusCode"] == 200
     assert data["requestSize"] == 0
+    assert data["userAgent"] == "testclient"
     assert isinstance(data["timeMillis"], int)
 
 
@@ -150,8 +166,9 @@ def test_middleware_should_send_data_even_on_errors(
 
     __, call_kwargs = mocked_urlopen.call_args
     data = tests.conftest.decode_request_data(call_kwargs["data"])
-    assert data.keys() == {"method", "path", "timeMillis", "requestSize"}
+    assert data.keys() == {"method", "path", "timeMillis", "userAgent", "requestSize"}
     assert data["method"] == "GET"
     assert data["path"] == "/error"
     assert data["requestSize"] == 0
+    assert data["userAgent"] == "testclient"
     assert isinstance(data["timeMillis"], int)

tests/test_core.py

@@ -89,6 +89,30 @@ def test_middleware_should_not_send_empty_query_params(
     assert "query" not in data
 
 
+def test_apilytics_sender_should_handle_empty_values_correctly(
+    mocked_urlopen: unittest.mock.MagicMock,
+) -> None:
+    with apilytics.core.ApilyticsSender(
+        api_key="dummy-key",
+        path="",
+        method="",
+        query="",
+        request_size=None,
+        user_agent=None,
+        apilytics_integration=None,
+        integrated_library=None,
+    ) as sender:
+        sender.set_response_info(status_code=None, response_size=None)
+
+    assert mocked_urlopen.call_count == 1
+    __, call_kwargs = mocked_urlopen.call_args
+    data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data.keys() == {"path", "method", "timeMillis"}
+    assert data["path"] == ""
+    assert data["method"] == ""
+    assert isinstance(data["timeMillis"], int)
+
+
 @unittest.mock.patch(
     "apilytics.core.urllib.request.urlopen",
     side_effect=urllib.error.URLError("testing"),