Fix servers and global root_path (#235)

Author: tarsil

docs/en/docs/release-notes.md

@@ -7,9 +7,14 @@ hide:
 
 ## 0.19.1
 
+### Changed
+
+- Root path for auto detection behind reverse proxies.
+
 ### Fixed
 
 - Typo in the error for the security.
+- Servers for `openapi` were not being detected automatically.
 
 ## 0.19.0
 

lilya/__init__.py

@@ -1 +1 @@
-__version__ = "0.19.0"
+__version__ = "0.19.1"

lilya/apps.py

@@ -465,6 +465,9 @@ async def hello(self):
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         scope["app"] = self
         with _monkay.with_settings(self.settings), _monkay.with_instance(self):
+            if self.root_path:
+                scope["root_path"] = self.root_path
+
             if self.middleware_stack is None:
                 self.middleware_stack = self.build_middleware_stack()
             await self.middleware_stack(scope, receive, send)
@@ -957,6 +960,25 @@ async def populate_g(connection: Connection):
                 """
             ),
         ] = False,
+        root_path: Annotated[
+            str | None,
+            Doc(
+                """
+                A path prefix that is handled by a proxy not seen in the
+                application but seen by external libraries.
+
+                This affects the tools like the OpenAPI documentation.
+
+                **Example**
+
+                ```python
+                from lilya.apps import Lilya
+
+                app = Lilya(root_path="/api/v3")
+                ```
+                """
+            ),
+        ] = None,
     ) -> None:
         self.populate_global_context = populate_global_context
         self.settings_module: Settings | None = None
@@ -1008,6 +1030,8 @@ async def populate_g(connection: Connection):
         self.enable_intercept_global_exceptions = self.load_settings_value(
             "enable_intercept_global_exceptions", enable_intercept_global_exceptions
         )
+        self.root_path = self.load_settings_value("root_path", root_path)
+
         if self.router_class is not None:
             self.router = self.router_class(
                 routes=routes,

lilya/conf/global_settings.py

@@ -286,7 +286,6 @@ class Settings(Internal):
             """
         ),
     ] = True
-
     default_route_pattern: Annotated[
         str,
         Doc(
@@ -468,6 +467,26 @@ async def create_user(request: Request):
             """
         ),
     ] = False
+    root_path_in_servers: Annotated[
+        bool,
+        Doc(
+            """
+            Boolean flag use to disable the automatic URL generation in the `servers` field
+            in the OpenAPI documentation.
+            """
+        ),
+    ] = True
+    root_path: Annotated[
+        str | None,
+        Doc(
+            """
+            A path prefix that is handled by a proxy not seen in the
+            application but seen by external libraries.
+
+            This affects the tools like the OpenAPI documentation.
+            """
+        ),
+    ] = ""
 
     @property
     def routes(self) -> list[Any]:

tests/openapi/test_servers.py

@@ -0,0 +1,72 @@
+from typing import Any
+
+from lilya.apps import Lilya
+from lilya.contrib.openapi.config import OpenAPIConfig
+from lilya.contrib.openapi.decorator import openapi
+from lilya.routing import Path
+from lilya.testclient import TestClient
+
+
+class CustomOpenAPIConfig(OpenAPIConfig):
+    servers: Any = [
+        {"url": "/", "description": "Default server"},
+        {
+            "url": "http://staging.esmerald.dev",
+            "description": "Staging of Esmerald",
+        },
+        {"url": "https://esmerald.dev"},
+    ]
+
+
+@openapi(summary="Bar", description="", operation_id="bar_bar_get")
+async def bar() -> dict[str, str]:
+    return {"hello": "world"}
+
+
+app = Lilya(
+    routes=[Path("/bar", handler=bar)],
+    enable_openapi=True,
+    openapi_config=CustomOpenAPIConfig(),
+)
+
+
+client = TestClient(app)
+
+
+def test_application(test_client_factory):
+    response = client.get("/bar")
+    assert response.status_code == 200, response.json()
+
+
+def test_openapi_schema(test_client_factory):
+    response = client.get("/openapi.json")
+
+    assert response.status_code == 200, response.text
+
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {
+            "title": "Lilya",
+            "version": client.app.version,
+            "summary": "Lilya application",
+            "description": "Yet another framework/toolkit that delivers.",
+            "contact": {"name": "Lilya", "url": "https://lilya.dev", "email": "admin@myapp.com"},
+        },
+        "paths": {
+            "/bar": {
+                "get": {
+                    "operationId": "bar_bar_get",
+                    "summary": "Bar",
+                    "description": "",
+                    "parameters": [],
+                    "responses": {"200": {"description": "Successful response"}},
+                }
+            }
+        },
+        "components": {"schemas": {}, "securitySchemes": {}},
+        "servers": [
+            {"url": "/", "description": "Default server"},
+            {"url": "http://staging.esmerald.dev", "description": "Staging of Esmerald"},
+            {"url": "https://esmerald.dev"},
+        ],
+    }