[ENH] Make root_path for app configurable (#400)

* add env var for root path * set root path in app and in docs overrides * test docs when root_path is set * update default env var values * update welcome page message Co-authored-by: Sebastian Urchs <[email protected]> --------- Co-authored-by: Sebastian Urchs <[email protected]>
neurobagel · Jan 18, 2025 · 2e22e12 · 2e22e12
1 parent 3008ce9
commit 2e22e12
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 16 deletions.
diff --git a/app/api/utility.py b/app/api/utility.py
@@ -10,6 +10,10 @@
 # Request constants
 EnvVar = namedtuple("EnvVar", ["name", "val"])
 
+ROOT_PATH = EnvVar(
+    "NB_NAPI_ROOT_PATH", os.environ.get("NB_NAPI_ROOT_PATH", "")
+)
+
 ALLOWED_ORIGINS = EnvVar(
     "NB_API_ALLOWED_ORIGINS", os.environ.get("NB_API_ALLOWED_ORIGINS", "")
 )
@@ -21,12 +25,12 @@
     "NB_GRAPH_PASSWORD", os.environ.get("NB_GRAPH_PASSWORD")
 )
 GRAPH_ADDRESS = EnvVar(
-    "NB_GRAPH_ADDRESS", os.environ.get("NB_GRAPH_ADDRESS", "206.12.99.17")
+    "NB_GRAPH_ADDRESS", os.environ.get("NB_GRAPH_ADDRESS", "127.0.0.1")
 )
 GRAPH_DB = EnvVar(
-    "NB_GRAPH_DB", os.environ.get("NB_GRAPH_DB", "test_data/query")
+    "NB_GRAPH_DB", os.environ.get("NB_GRAPH_DB", "repositories/my_db")
 )
-GRAPH_PORT = EnvVar("NB_GRAPH_PORT", os.environ.get("NB_GRAPH_PORT", 5820))
+GRAPH_PORT = EnvVar("NB_GRAPH_PORT", os.environ.get("NB_GRAPH_PORT", 7200))
 # TODO: Environment variables can't be parsed as bool so this is a workaround but isn't ideal.
 # Another option is to switch this to a command-line argument, but that would require changing the
 # Dockerfile also since Uvicorn can't accept custom command-line args.

diff --git a/app/main.py b/app/main.py
@@ -6,7 +6,7 @@
 from tempfile import TemporaryDirectory
 
 import uvicorn
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
 from fastapi.responses import HTMLResponse, ORJSONResponse, RedirectResponse
@@ -16,6 +16,7 @@
 from .api.security import check_client_id
 
 app = FastAPI(
+    root_path=util.ROOT_PATH.val,
     default_response_class=ORJSONResponse,
     docs_url=None,
     redoc_url=None,
@@ -33,15 +34,15 @@
 
 
 @app.get("/", response_class=HTMLResponse)
-def root():
+def root(request: Request):
     """
     Display a welcome message and a link to the API documentation.
     """
-    return """
+    return f"""
     <html>
         <body>
             <h1>Welcome to the Neurobagel REST API!</h1>
-            <p>Please visit the <a href="/docs">documentation</a> to view available API endpoints.</p>
+            <p>Please visit the <a href="{request.scope.get("root_path", "")}/docs">API documentation</a> to view available API endpoints.</p>
         </body>
     </html>
     """
@@ -56,24 +57,24 @@ async def favicon():
 
 
 @app.get("/docs", include_in_schema=False)
-def overridden_swagger():
+def overridden_swagger(request: Request):
     """
     Overrides the Swagger UI HTML for the "/docs" endpoint.
     """
     return get_swagger_ui_html(
-        openapi_url="/openapi.json",
+        openapi_url=f"{request.scope.get('root_path', '')}/openapi.json",
         title="Neurobagel API",
         swagger_favicon_url=favicon_url,
     )
 
 
 @app.get("/redoc", include_in_schema=False)
-def overridden_redoc():
+def overridden_redoc(request: Request):
     """
     Overrides the Redoc HTML for the "/redoc" endpoint.
     """
     return get_redoc_html(
-        openapi_url="/openapi.json",
+        openapi_url=f"{request.scope.get('root_path', '')}/openapi.json",
         title="Neurobagel API",
         redoc_favicon_url=favicon_url,
     )

diff --git a/tests/test_routing.py b/tests/test_routing.py
@@ -1,20 +1,22 @@
 import pytest
 
 from app.api import crud
+from app.main import app
 
 
 @pytest.mark.parametrize(
-    "root_path",
+    "route",
     ["/", ""],
 )
-def test_root(test_app, root_path):
+def test_root(test_app, route, monkeypatch):
     """Given a GET request to the root endpoint, Check for 200 status and expected content."""
-
-    response = test_app.get(root_path, follow_redirects=False)
+    # root_path determines the path prefix for the docs link on the welcome page
+    monkeypatch.setattr(app, "root_path", "")
+    response = test_app.get(route, follow_redirects=False)
 
     assert response.status_code == 200
     assert "Welcome to the Neurobagel REST API!" in response.text
-    assert '<a href="/docs">documentation</a>' in response.text
+    assert '<a href="/docs">API documentation</a>' in response.text
 
 
 @pytest.mark.parametrize(
@@ -43,3 +45,29 @@ def test_request_with_trailing_slash_not_redirected(
     """
     response = test_app.get(invalid_route)
     assert response.status_code == 404
+
+
+@pytest.mark.parametrize(
+    "test_route,expected_status_code",
+    [("", 200), ("/api/v1", 200), ("/wrongroot", 404)],
+)
+def test_docs_work_using_defined_root_path(
+    test_app, test_route, expected_status_code, monkeypatch
+):
+    """
+    Test that when the API root_path is set to a non-empty string,
+    the interactive docs and OpenAPI schema are only reachable with the correct path prefix
+    (e.g., mimicking access through a proxy) or without the prefix entirely (e.g., mimicking local access or by a proxy itself).
+
+    Note: We test the OpenAPI schema as well because when the root path is not set correctly,
+    the docs break from failure to fetch openapi.json.
+    (https://fastapi.tiangolo.com/advanced/behind-a-proxy/#proxy-with-a-stripped-path-prefix)
+    """
+
+    monkeypatch.setattr(app, "root_path", "/api/v1")
+    docs_response = test_app.get(f"{test_route}/docs", follow_redirects=False)
+    schema_response = test_app.get(
+        f"{test_route}/openapi.json", follow_redirects=False
+    )
+    assert docs_response.status_code == expected_status_code
+    assert schema_response.status_code == expected_status_code