fix: FastAPI built-in paths bypass custom routing (Docs) and update r… #1841

solaius · 2025-03-30T15:21:33Z

What does this PR do?

This PR improves the server's request routing logic by ensuring built-in FastAPI paths such as /docs, /redoc, /openapi.json, /favicon.ico, and /static bypass the custom TracingMiddleware. This prevents unnecessary tracing logic for documentation and static file requests, ensuring better performance and cleaner logs.

Additionally, it adds proper metadata (title, description, and version) to the FastAPI application initialization and updates the requirements document accordingly.

Test Plan

Ran the server locally with uvicorn using the provided run.yaml config
Verified that:
- FastAPI docs (/docs, /redoc) load correctly without triggering the custom tracing middleware
- All other routes still go through the middleware and trace logic
- Application metadata appears as expected in the OpenAPI docs

To reproduce:

Start the server with python server.py --template <template-name>
Navigate to /docs and /redoc
Confirm that no extra trace headers are added for those routes
Confirm other API endpoints behave as expected and include x-trace-id in the response headers

Froze the requirements file to include many of the other libraries that have been added in the past few releases to make install easier.

…equirements document

facebook-github-bot · 2025-03-30T15:21:40Z

Hi @solaius!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

facebook-github-bot · 2025-03-30T17:05:51Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Left my local file version of llama stack in the requirements.txt file, just updated for >= 0.1.9

raghotham

Thanks for the improvements. A couple of comments.

raghotham · 2025-03-30T18:04:29Z

llama_stack/distribution/server/server.py

+        openapi_url="/openapi.json",
+        title="Llama Stack API",
+        description="API for Llama Stack",
+        version="0.1.9"


Let’s not hardcode the version - we should use a version file instead.

removed unnecessary entries.

raghotham · 2025-03-30T18:05:36Z

llama_stack/distribution/server/server.py


    async def __call__(self, scope, receive, send):
        if scope.get("type") == "lifespan":
            return await self.app(scope, receive, send)

        path = scope.get("path", "")
+
+        # Check if the path is a FastAPI built-in path
+        if any(path.startswith(fastapi_path) for fastapi_path in self.fastapi_paths):


Why startswith?

Hello! I used startswith to handle routes like any other related subpaths that FastAPI may have. I can remove if you feel it is not worth covering for that.

Also, if you make self.fastapi_paths a tuple you can just do if path.startswith(self.fastapi_paths): I think?

Removed 3 unnecessary FastAPI entries

leseb

Please do not edit requirements.txt manually. If new dependencies are needed, please add them to pyproject.toml and let pre-commit do the rest. Thanks!

solaius · 2025-03-31T18:40:27Z

Reverted requirements.txt to be same as current main.

requirements from initial push had llama-stack-client at 0.1.19 instead of 0.1.9 so I used the latest one.

leseb · 2025-04-01T08:51:04Z

requirements.txt

@@ -21,7 +21,7 @@ idna==3.10
 jinja2==3.1.6
 jsonschema==4.23.0
 jsonschema-specifications==2024.10.1
-llama-stack-client==0.1.19
+llama-stack-client==0.1.9


no changes required here

llama_stack/distribution/server/server.py

leseb · 2025-04-01T09:08:22Z

llama_stack/distribution/server/server.py


    async def __call__(self, scope, receive, send):
        if scope.get("type") == "lifespan":
            return await self.app(scope, receive, send)

        path = scope.get("path", "")
+
+        # Check if the path is a FastAPI built-in path
+        if any(path.startswith(fastapi_path) for fastapi_path in self.fastapi_paths):


Also, if you make self.fastapi_paths a tuple you can just do if path.startswith(self.fastapi_paths): I think?

Adding logger per request. Co-authored-by: Sébastien Han <[email protected]>

solaius · 2025-04-02T02:33:15Z

@leseb you were correct! Thanks for the efficiency :-)

leseb

We still need to remove the requirements.txt

fix: FastAPI built-in paths bypass custom routing (Docs) and update r…

de60fb5

…equirements document

solaius requested review from ashwinb, yanxi0830, hardikjshah, dltn, raghotham, dineshyv, vladimirivic, sixianyi0721, ehhuang, terrytangyuan, SLR722 and leseb as code owners March 30, 2025 15:21

facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Mar 30, 2025

Update requirements.txt

3d4e816

Left my local file version of llama stack in the requirements.txt file, just updated for >= 0.1.9

raghotham reviewed Mar 30, 2025

View reviewed changes

Updated server.py

ec9a319

Removed 3 unnecessary FastAPI entries

leseb requested changes Mar 31, 2025

View reviewed changes

solaius force-pushed the main branch from aedb63d to ec9a319 Compare March 31, 2025 18:48

requirements.txt to match main

e71a482

solaius requested a review from leseb March 31, 2025 19:01

leseb reviewed Apr 1, 2025

View reviewed changes

leseb requested changes Apr 1, 2025

View reviewed changes

solaius and others added 3 commits April 1, 2025 05:29

Update llama_stack/distribution/server/server.py

b7072c3

Adding logger per request. Co-authored-by: Sébastien Han <[email protected]>

Update llama_stack/distribution/server/server.py

ca2c46a

Adding logger per request. Co-authored-by: Sébastien Han <[email protected]>

fastapi_paths to tuple and simplified startswith check

80adc42

solaius requested a review from leseb April 2, 2025 02:32

leseb requested changes Apr 2, 2025

View reviewed changes

solaius force-pushed the main branch 2 times, most recently from 26047e8 to 80adc42 Compare April 2, 2025 15:39

Revert requirements.txt to match commit b7ab1a9

ffb5600

solaius requested a review from leseb April 2, 2025 15:43

leseb approved these changes Apr 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: FastAPI built-in paths bypass custom routing (Docs) and update r… #1841

fix: FastAPI built-in paths bypass custom routing (Docs) and update r… #1841

solaius commented Mar 30, 2025

facebook-github-bot commented Mar 30, 2025

facebook-github-bot commented Mar 30, 2025

raghotham left a comment

raghotham Mar 30, 2025

solaius Mar 30, 2025

raghotham Mar 30, 2025

solaius Mar 30, 2025

leseb Apr 1, 2025

leseb left a comment

solaius commented Mar 31, 2025 •

edited

Loading

leseb Apr 1, 2025

leseb Apr 1, 2025

solaius commented Apr 2, 2025

leseb left a comment

fix: FastAPI built-in paths bypass custom routing (Docs) and update r… #1841

Are you sure you want to change the base?

fix: FastAPI built-in paths bypass custom routing (Docs) and update r… #1841

Conversation

solaius commented Mar 30, 2025

What does this PR do?

Test Plan

facebook-github-bot commented Mar 30, 2025

Action Required

Process

facebook-github-bot commented Mar 30, 2025

raghotham left a comment

Choose a reason for hiding this comment

raghotham Mar 30, 2025

Choose a reason for hiding this comment

solaius Mar 30, 2025

Choose a reason for hiding this comment

raghotham Mar 30, 2025

Choose a reason for hiding this comment

solaius Mar 30, 2025

Choose a reason for hiding this comment

leseb Apr 1, 2025

Choose a reason for hiding this comment

leseb left a comment

Choose a reason for hiding this comment

solaius commented Mar 31, 2025 • edited Loading

leseb Apr 1, 2025

Choose a reason for hiding this comment

leseb Apr 1, 2025

Choose a reason for hiding this comment

solaius commented Apr 2, 2025

leseb left a comment

Choose a reason for hiding this comment

solaius commented Mar 31, 2025 •

edited

Loading