Merge pull request #19 from apilytics/send-geo-ip

Send user's IP address with metrics

Author: ruohola

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Send user's IP address with metrics. Used for visualization aggregate geolocation data.
+  The IP is never stored, and it is never sent to 3rd parties.
+
 ## [1.4.0] - 2022-02-20
 
 ### Added

README.md

@@ -82,6 +82,7 @@ def my_apilytics_middleware(request, get_response):
         method=request.method,
         request_size=len(request.body),
         user_agent=request.headers.get("user-agent"),
+        ip=request.headers.get("x-forwarded-for", "").split(",")[0].strip(),
     ) as sender:
         response = get_response(request)
         sender.set_response_info(

apilytics/core.py

@@ -33,6 +33,7 @@ class ApilyticsSender:
                 method=request.method,
                 request_size=len(request.body),
                 user_agent=request.headers.get("user-agent"),
+                ip=request.headers.get("x-forwarded-for", "").split(",")[0].strip(),
             ) as sender:
                 response = get_response(request)
                 sender.set_response_info(
@@ -56,6 +57,7 @@ def __init__(
         query: Optional[str] = None,
         request_size: Optional[int] = None,
         user_agent: Optional[str] = None,
+        ip: Optional[str] = None,
         apilytics_integration: Optional[str] = None,
         integrated_library: Optional[str] = None,
     ) -> None:
@@ -70,6 +72,9 @@ def __init__(
                 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.
+                An empty string and None are treated equally.
+            ip: User's IP address (used for geolocation, never stored nor sent to 3rd parties).
+                An empty string and None are treated equally.
             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,
@@ -81,6 +86,7 @@ def __init__(
         self._query = query
         self._request_size = request_size
         self._user_agent = user_agent
+        self._ip = ip
 
         self._response_size: Optional[int] = None
         self._status_code: Optional[int] = None
@@ -147,6 +153,7 @@ def _send_metrics(self) -> None:
             # Don't send empty strings.
             **({"query": self._query} if self._query else {}),
             **({"userAgent": self._user_agent} if self._user_agent else {}),
+            **({"ip": self._ip} if self._ip else {}),
             **(
                 {"statusCode": self._status_code}
                 if self._status_code is not None

apilytics/django.py

@@ -49,6 +49,7 @@ def __call__(self, request: django.http.HttpRequest) -> django.http.HttpResponse
             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"),
+            ip=request.headers.get("x-forwarded-for", "").split(",")[0].strip(),
             apilytics_integration="apilytics-python-django",
             integrated_library=f"django/{django.__version__}",
         ) as sender:

apilytics/fastapi.py

@@ -57,6 +57,7 @@ async def dispatch(
             method=request.method,
             request_size=len(await request.body()),
             user_agent=request.headers.get("user-agent"),
+            ip=request.headers.get("x-forwarded-for", "").split(",")[0].strip(),
             apilytics_integration="apilytics-python-fastapi",
             integrated_library=f"fastapi/{fastapi.__version__}",
         ) as sender:

tests/django/test_django.py

@@ -87,6 +87,26 @@ def test_middleware_should_send_user_agent(
     assert data["userAgent"] == "some agent"
 
 
+def test_middleware_should_send_ip(
+    mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
+) -> None:
+    response = client.get("/dummy", HTTP_X_FORWARDED_FOR="127.0.0.1")
+    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["ip"] == "127.0.0.1"
+
+    response = client.get("/dummy", HTTP_X_FORWARDED_FOR="127.0.0.2,127.0.0.3")
+    assert response.status_code == 200
+
+    assert mocked_urlopen.call_count == 2
+    __, call_kwargs = mocked_urlopen.call_args
+    data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data["ip"] == "127.0.0.2"
+
+
 def test_middleware_should_handle_zero_request_and_response_sizes(
     mocked_urlopen: unittest.mock.MagicMock, client: django.test.client.Client
 ) -> None:

tests/fastapi/test_fastapi.py

@@ -94,6 +94,26 @@ def test_middleware_should_send_user_agent(
     assert data["userAgent"] == "some agent"
 
 
+def test_middleware_should_send_ip(
+    mocked_urlopen: unittest.mock.MagicMock,
+) -> None:
+    response = client.get("/dummy", headers={"X-Forwarded-For": "127.0.0.1"})
+    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["ip"] == "127.0.0.1"
+
+    response = client.get("/dummy", headers={"X-Forwarded-For": "127.0.0.2,127.0.0.3"})
+    assert response.status_code == 200
+
+    assert mocked_urlopen.call_count == 2
+    __, call_kwargs = mocked_urlopen.call_args
+    data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data["ip"] == "127.0.0.2"
+
+
 def test_middleware_should_handle_zero_request_and_response_sizes(
     mocked_urlopen: unittest.mock.MagicMock,
 ) -> None: