From 0e4cdb3bc740dd30c9c0d3fa71bc5d6b4e4471c4 Mon Sep 17 00:00:00 2001 From: Ricardo Madriz Date: Sun, 18 Feb 2024 12:34:38 -0600 Subject: [PATCH 1/5] Add test to demonstrate bug --- tests/test_root_path_redirects.py | 36 +++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 tests/test_root_path_redirects.py diff --git a/tests/test_root_path_redirects.py b/tests/test_root_path_redirects.py new file mode 100644 index 000000000..5a6d6cd2a --- /dev/null +++ b/tests/test_root_path_redirects.py @@ -0,0 +1,36 @@ +from fastapi import APIRouter, FastAPI +from fastapi.testclient import TestClient + + +def test_redirects_without_root_path(): + app = FastAPI() + router = APIRouter() + + @router.get("/hello/") + def hello_page() -> str: + return "Hello, World!" + + app.include_router(router) + + client = TestClient(app, base_url="http://testserver") + + response = client.get("/hello", follow_redirects=False) + assert response.status_code == 307 + assert response.headers["location"] == "http://testserver/hello/" + + +def test_redirects_with_root_path(): + app = FastAPI(root_path="/api") + router = APIRouter() + + @router.get("/hello/") + def hello_page() -> str: + return "Hello, World!" + + app.include_router(router) + + client = TestClient(app, base_url="http://testserver") + + response = client.get("/hello", follow_redirects=False) + assert response.status_code == 307 + assert response.headers["location"] == "http://testserver/api/hello/" From 1a01c3c2217736d5374c6e9d8593a123d40a0476 Mon Sep 17 00:00:00 2001 From: Ricardo Madriz Date: Sun, 18 Feb 2024 12:48:27 -0600 Subject: [PATCH 2/5] Modify the scope to include root_path in path and raw_path --- fastapi/applications.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/fastapi/applications.py b/fastapi/applications.py index 6d427cdc2..5ef22b432 100644 --- a/fastapi/applications.py +++ b/fastapi/applications.py @@ -1050,7 +1050,20 @@ class FastAPI(Starlette): async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None: if self.root_path: + root_path = scope.get("root_path", "") + if root_path and self.root_path != root_path: + raise RuntimeError( + f"The ASGI server is using a different root path than the one " + f"configured in FastAPI. The configured root path is: " + f"{self.root_path}, the ASGI server root path is: {root_path}. " + ) scope["root_path"] = self.root_path + path = scope.get("path") + if path and not path.startswith(self.root_path): + scope["path"] = self.root_path + path + raw_path: bytes | None = scope.get("raw_path") + if raw_path and not raw_path.startswith(self.root_path.encode()): + scope["raw_path"] = self.root_path.encode() + raw_path await super().__call__(scope, receive, send) def add_api_route( From e2599bda9aa9952edf0771fafeb78794bd8bfb3a Mon Sep 17 00:00:00 2001 From: Ricardo Madriz Date: Sun, 18 Feb 2024 12:58:09 -0600 Subject: [PATCH 3/5] Move logic to else block to avoid unnecessary modifications --- fastapi/applications.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/fastapi/applications.py b/fastapi/applications.py index 5ef22b432..b4cb13c59 100644 --- a/fastapi/applications.py +++ b/fastapi/applications.py @@ -1057,13 +1057,14 @@ class FastAPI(Starlette): f"configured in FastAPI. The configured root path is: " f"{self.root_path}, the ASGI server root path is: {root_path}. " ) - scope["root_path"] = self.root_path - path = scope.get("path") - if path and not path.startswith(self.root_path): - scope["path"] = self.root_path + path - raw_path: bytes | None = scope.get("raw_path") - if raw_path and not raw_path.startswith(self.root_path.encode()): - scope["raw_path"] = self.root_path.encode() + raw_path + else: + scope["root_path"] = self.root_path + path = scope.get("path") + if path and not path.startswith(self.root_path): + scope["path"] = self.root_path + path + raw_path: bytes | None = scope.get("raw_path") + if raw_path and not raw_path.startswith(self.root_path.encode()): + scope["raw_path"] = self.root_path.encode() + raw_path await super().__call__(scope, receive, send) def add_api_route( From 390540eebdbf823eab1e99a7aeb0815c6a04282e Mon Sep 17 00:00:00 2001 From: Ricardo Madriz Date: Sun, 18 Feb 2024 14:25:53 -0600 Subject: [PATCH 4/5] Make FastAPI's root_path take precedence --- fastapi/applications.py | 18 +++++++++--------- tests/test_root_path_redirects.py | 16 ++++++++++++++++ 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/fastapi/applications.py b/fastapi/applications.py index b4cb13c59..2d9944c99 100644 --- a/fastapi/applications.py +++ b/fastapi/applications.py @@ -1052,19 +1052,19 @@ class FastAPI(Starlette): if self.root_path: root_path = scope.get("root_path", "") if root_path and self.root_path != root_path: - raise RuntimeError( + logger.warning( f"The ASGI server is using a different root path than the one " f"configured in FastAPI. The configured root path is: " f"{self.root_path}, the ASGI server root path is: {root_path}. " + f"The former will be used." ) - else: - scope["root_path"] = self.root_path - path = scope.get("path") - if path and not path.startswith(self.root_path): - scope["path"] = self.root_path + path - raw_path: bytes | None = scope.get("raw_path") - if raw_path and not raw_path.startswith(self.root_path.encode()): - scope["raw_path"] = self.root_path.encode() + raw_path + scope["root_path"] = self.root_path + path = scope.get("path") + if path and not path.startswith(self.root_path): + scope["path"] = self.root_path + path + raw_path: bytes | None = scope.get("raw_path") + if raw_path and not raw_path.startswith(self.root_path.encode()): + scope["raw_path"] = self.root_path.encode() + raw_path await super().__call__(scope, receive, send) def add_api_route( diff --git a/tests/test_root_path_redirects.py b/tests/test_root_path_redirects.py index 5a6d6cd2a..0542f39f0 100644 --- a/tests/test_root_path_redirects.py +++ b/tests/test_root_path_redirects.py @@ -34,3 +34,19 @@ def test_redirects_with_root_path(): response = client.get("/hello", follow_redirects=False) assert response.status_code == 307 assert response.headers["location"] == "http://testserver/api/hello/" + + +def test_invalid_combination_of_root_path(): + app = FastAPI(root_path="/api") + router = APIRouter() + + @router.get("/hello/") + def hello_page() -> str: + return "Hello, World!" + + app.include_router(router) + + client = TestClient(app, base_url="http://testserver", root_path="/notapi") + response = client.get("/hello", follow_redirects=False) + assert response.status_code == 307 + assert response.headers["location"] == "http://testserver/api/hello/" From 168184c26560d018421a0ce84e786a9912c8aee1 Mon Sep 17 00:00:00 2001 From: Ricardo Madriz Date: Sun, 18 Feb 2024 14:46:22 -0600 Subject: [PATCH 5/5] Ignore unreacheable code --- tests/test_root_path_redirects.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_root_path_redirects.py b/tests/test_root_path_redirects.py index 0542f39f0..150693b34 100644 --- a/tests/test_root_path_redirects.py +++ b/tests/test_root_path_redirects.py @@ -8,7 +8,7 @@ def test_redirects_without_root_path(): @router.get("/hello/") def hello_page() -> str: - return "Hello, World!" + return "Hello, World!" # pragma: nocover app.include_router(router) @@ -25,7 +25,7 @@ def test_redirects_with_root_path(): @router.get("/hello/") def hello_page() -> str: - return "Hello, World!" + return "Hello, World!" # pragma: nocover app.include_router(router) @@ -42,7 +42,7 @@ def test_invalid_combination_of_root_path(): @router.get("/hello/") def hello_page() -> str: - return "Hello, World!" + return "Hello, World!" # pragma: nocover app.include_router(router)