Merge pull request #1614 from major/fix/rspeed-2941-metrics-root-path

RSPEED-2941: fix REST API metrics when root_path is set

Author: tisnik

src/app/main.py

@@ -154,7 +154,14 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
             await self.app(scope, receive, send)
             return
 
-        path = scope["path"]
+        # When root_path is set (e.g., /api/lightspeed), the proxy forwards
+        # requests with the full prefixed path (/api/lightspeed/v1/infer) but
+        # app_routes_paths contains only application-level paths (/v1/infer).
+        # Strip the prefix so the path check and metric labels match the routes.
+        root_path = scope.get("root_path", "")
+        path: str = scope["path"]
+        if root_path and path.startswith(root_path + "/"):
+            path = path[len(root_path) :]
         logger.debug("Received request for path: %s", path)
 
         # Ignore paths that are not part of the app routes.

tests/unit/app/test_main_middleware.py

@@ -12,15 +12,18 @@
 from models.responses import InternalServerErrorResponse
 
 
-def _make_scope(path: str = "/test") -> dict:
+def _make_scope(path: str = "/test", root_path: str = "") -> Scope:
     """Build a minimal HTTP ASGI scope."""
-    return {
+    scope: Scope = {
         "type": "http",
         "method": "GET",
         "path": path,
         "query_string": b"",
         "headers": [],
     }
+    if root_path:
+        scope["root_path"] = root_path
+    return scope
 
 
 async def _noop_receive() -> dict:
@@ -175,3 +178,59 @@ async def failing_app(_scope: Scope, _receive: Receive, _send: Send) -> None:
     mock_metrics.response_duration_seconds.labels.assert_called_once_with("/v1/infer")
     mock_metrics.rest_api_calls_total.labels.assert_called_once_with("/v1/infer", 500)
     mock_metrics.rest_api_calls_total.labels.return_value.inc.assert_called_once()
+
+
+@pytest.mark.asyncio
+async def test_rest_api_metrics_strips_root_path(
+    mocker: MockerFixture,
+) -> None:
+    """Middleware must strip root_path so prefixed requests still match routes."""
+    mocker.patch("app.main.app_routes_paths", ["/v1/infer"])
+    mock_metrics = mocker.patch("app.main.metrics")
+
+    async def ok_app(_scope: Scope, _receive: Receive, send: Send) -> None:
+        await send({"type": "http.response.start", "status": 200, "headers": []})
+        await send({"type": "http.response.body", "body": b"ok"})
+
+    middleware = RestApiMetricsMiddleware(ok_app)
+    collector = _ResponseCollector()
+
+    # Simulate 3scale forwarding /api/lightspeed/v1/infer with root_path set.
+    await middleware(
+        _make_scope("/api/lightspeed/v1/infer", root_path="/api/lightspeed"),
+        _noop_receive,
+        collector,
+    )
+
+    assert collector.status_code == 200
+    # Metrics labels should use the stripped path, not the full prefixed path.
+    mock_metrics.response_duration_seconds.labels.assert_called_once_with("/v1/infer")
+    mock_metrics.rest_api_calls_total.labels.assert_called_once_with("/v1/infer", 200)
+    mock_metrics.rest_api_calls_total.labels.return_value.inc.assert_called_once()
+
+
+@pytest.mark.asyncio
+async def test_rest_api_metrics_no_root_path_unchanged(
+    mocker: MockerFixture,
+) -> None:
+    """Without root_path, middleware behaves as before."""
+    mocker.patch("app.main.app_routes_paths", ["/v1/infer"])
+    mock_metrics = mocker.patch("app.main.metrics")
+
+    async def ok_app(_scope: Scope, _receive: Receive, send: Send) -> None:
+        await send({"type": "http.response.start", "status": 200, "headers": []})
+        await send({"type": "http.response.body", "body": b"ok"})
+
+    middleware = RestApiMetricsMiddleware(ok_app)
+    collector = _ResponseCollector()
+
+    await middleware(
+        _make_scope("/v1/infer"),
+        _noop_receive,
+        collector,
+    )
+
+    assert collector.status_code == 200
+    mock_metrics.response_duration_seconds.labels.assert_called_once_with("/v1/infer")
+    mock_metrics.rest_api_calls_total.labels.assert_called_once_with("/v1/infer", 200)
+    mock_metrics.rest_api_calls_total.labels.return_value.inc.assert_called_once()