feat: Provide documented routes as labels (#33)

* feat: Provide documented routes as labels

* fix docstring

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: khvn26

src/common/gunicorn/middleware.py

@@ -3,6 +3,7 @@
 from django.http import HttpRequest, HttpResponse
 
 from common.gunicorn.constants import WSGI_DJANGO_ROUTE_ENVIRON_KEY
+from common.gunicorn.utils import get_route_template
 
 
 class RouteLoggerMiddleware:
@@ -23,6 +24,8 @@ def __call__(self, request: HttpRequest) -> HttpResponse:
         if resolver_match := request.resolver_match:
             # https://peps.python.org/pep-3333/#specification-details
             # "...the application is allowed to modify the dictionary in any way it desires"
-            request.META[WSGI_DJANGO_ROUTE_ENVIRON_KEY] = resolver_match.route
+            request.META[WSGI_DJANGO_ROUTE_ENVIRON_KEY] = get_route_template(
+                resolver_match.route
+            )
 
         return response

src/common/gunicorn/utils.py

@@ -1,9 +1,11 @@
 import argparse
 import os
+from functools import lru_cache
 from typing import Any
 
 from django.core.handlers.wsgi import WSGIHandler
 from django.core.wsgi import get_wsgi_application
+from drf_yasg.generators import EndpointEnumerator  # type: ignore[import-untyped]
 from environs import Env
 from gunicorn.app.wsgiapp import (  # type: ignore[import-untyped]
     WSGIApplication as GunicornWSGIApplication,
@@ -59,3 +61,18 @@ def add_arguments(parser: argparse.ArgumentParser) -> None:
 
 def run_server(options: dict[str, Any] | None = None) -> None:
     DjangoWSGIApplication(options).run()
+
+
+@lru_cache
+def get_route_template(route: str) -> str:
+    """
+    Convert a Django regex route to a template string that can be
+    searched for in the API documentation.
+
+    e.g.,
+
+    `"^api/v1/environments/(?P<environment_api_key>[^/.]+)/api-keys/$"` ->
+    `"/api/v1/environments/{environment_api_key}/api-keys/"`
+    """
+    route_template: str = EndpointEnumerator().get_path_from_regex(route)
+    return route_template

tests/unit/common/gunicorn/test_utils.py

@@ -4,16 +4,18 @@
 import time
 
 import pytest
-import pytest_mock
+from drf_yasg.generators import EndpointEnumerator  # type: ignore[import-untyped]
+from pytest_mock import MockerFixture
 
 from common.gunicorn.utils import (
     DjangoWSGIApplication,
+    get_route_template,
     run_server,
 )
 
 
 def test_django_wsgi_application__defaults__expected_config(
-    mocker: pytest_mock.MockerFixture,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     wsgi_handler_mock = mocker.Mock()
@@ -37,7 +39,7 @@ def test_django_wsgi_application__defaults__expected_config(
 
 def test_run_server__default_config_file__runs_expected(
     unused_tcp_port: int,
-    mocker: pytest_mock.MockerFixture,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     # prevent real forking from Gunicorn
@@ -58,3 +60,19 @@ def delay_kill(pid: int = pid) -> None:
 
     # Then
     mark_process_dead_mock.assert_called_once_with(pid)
+
+
+def test_get_route_template__returns_expected__caches_expected(
+    mocker: MockerFixture,
+) -> None:
+    # Given
+    get_path_from_regex_spy = mocker.spy(EndpointEnumerator, "get_path_from_regex")
+    regex_route = "^api/v1/environments/(?P<environment_api_key>[^/.]+)/api-keys/$"
+
+    # When
+    result = get_route_template(regex_route)
+    get_route_template(regex_route)
+
+    # Then
+    assert result == "/api/v1/environments/{environment_api_key}/api-keys/"
+    get_path_from_regex_spy.assert_called_once()