Thanks to visit codestin.com
Credit goes to github.com

Skip to content

✨ Add support for dependencies in WebSocket routes#4534

Merged
tiangolo merged 12 commits into
fastapi:masterfrom
paulo-raca:websocket-dependencies
Jun 11, 2023
Merged

✨ Add support for dependencies in WebSocket routes#4534
tiangolo merged 12 commits into
fastapi:masterfrom
paulo-raca:websocket-dependencies

Conversation

@paulo-raca

@paulo-raca paulo-raca commented Feb 8, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

I've been using dependencies to handle authentication.
But imagine my surprise when I realized my websocket endpoint wasn't authenticated at all?

This commit cherry-picks the dependencies chunks from APIRoute into APIWebSocketRoute

I also made a few minor style nit-picks.

Here is a much-simplified code that demonstrates the issue:

import uvicorn
from fastapi import Depends, FastAPI, HTTPException,  WebSocket
from starlette.requests import Request, HTTPConnection
from starlette.websockets import WebSocket
from starlette.responses import PlainTextResponse, Response

def check_permission():
    print("check_permission")
    raise HTTPException(status_code=401, detail="Unauthorized")

app = FastAPI(dependencies=[Depends(check_permission)])

@app.get("/get")
def get_endpoint() -> Response:
    return PlainTextResponse("GET")

@app.websocket("/ws")
async def websocket_endpoint(ws: WebSocket):
    await ws.accept()
    await ws.send_text("Hello")

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

As expected, accessing "/get" results in 401 error:

$ curl "http://localhost:8000/get"
{"detail":"Unauthorized"}

However the websocket endpoint remains accessible:

$ python -m websockets "ws://localhost:8000/ws"
Connected to ws://localhost:8000/ws.
< Hello
Connection closed: 1000 (OK).

After applying the patch, the dependencies execute successfully:

$ python -m websockets "ws://localhost:8000/ws"
Failed to connect to ws://localhost:8000/ws: server rejected WebSocket connection: HTTP 500.

Interestingly the websocket connection fails with code 500 instead of 401. I have addressed it into a separate PR to starlette

cikay
cikay reviewed Feb 9, 2022
View reviewed changes
Comment thread fastapi/routing.py
@paulo-raca paulo-raca force-pushed the websocket-dependencies branch 2 times, most recently from 10dc6e9 to 0ac85d4 Compare February 10, 2022 18:07
@paulo-raca paulo-raca force-pushed the websocket-dependencies branch from 0ac85d4 to 4d892d9 Compare March 2, 2022 23:40
@paulo-raca

paulo-raca commented Mar 2, 2022

Copy link
Copy Markdown
Contributor Author

Hello!

Is there anything missing on this PR?

@paulo-raca paulo-raca force-pushed the websocket-dependencies branch from 64a3946 to 62d72b5 Compare March 3, 2022 00:50
@paulo-raca

paulo-raca commented Mar 14, 2022

Copy link
Copy Markdown
Contributor Author

Thank you for the reviews, @BilalAlpaslan @cikay.

I just fixed the merge conflicts, it should be ready for merging

@paulo-raca
Support dependencies in websocket routes
50c667b 
I've been using dependencies to handle authentication.
But imagine my surprise when I realized my websocket endpoint wasn't authenticated at all?

This commit cherry-picks the `dependencies` chunks from `APIRoute` into `APIWebSocketRoute`

I also made a few minor style nit-picks
@paulo-raca
Add tests for dependencies on websocket endpoints/routes
0fc264d
@paulo-raca paulo-raca force-pushed the websocket-dependencies branch from 31a89c4 to 0fc264d Compare March 24, 2022 03:43
@paulo-raca

paulo-raca commented Mar 24, 2022

Copy link
Copy Markdown
Contributor Author

@tiangolo, sorry to call you directly, but can I get your eyes on this?

This is a straightforward issue, but it has been bugging me a lot in the last month 😅

Thank you 🙏

@paulo-raca

paulo-raca commented Jun 15, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Anything missing from this change? How can I get it merged?

@github-actions

github-actions Bot commented Jun 15, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 6453788 at: https://62a95f500fa552369a8a9c11--fastapi.netlify.app

@paulo-raca paulo-raca force-pushed the websocket-dependencies branch from 6453788 to 0925718 Compare June 15, 2022 05:20
@codecov

codecov Bot commented Jun 15, 2022 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (cf73051) 100.00% compared to head (ccc1987) 100.00%.

❗ Current head ccc1987 differs from pull request most recent head 931b492. Consider uploading reports for the commit 931b492 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff            @@
##            master     #4534   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          540       541    +1     
  Lines        13969     14001   +32     
=========================================
+ Hits         13969     14001   +32
Impacted Files Coverage Δ
fastapi/applications.py 100.00% <100.00%> (ø)
fastapi/routing.py 100.00% <100.00%> (ø)
tests/test_ws_dependencies.py 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@paulo-raca paulo-raca force-pushed the websocket-dependencies branch from 0925718 to 73249da Compare June 15, 2022 05:22
@github-actions

github-actions Bot commented Jun 15, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 73249da at: https://62a96d422ba68a456ea1be02--fastapi.netlify.app

@paulo-raca

paulo-raca commented Oct 1, 2022

Copy link
Copy Markdown
Contributor Author

Merged master branch again 👍

@tiangolo, @Kludex, can I get eyes on this one?

Thanks!

@github-actions

github-actions Bot commented Oct 1, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 3945a32 at: https://6337d198c51f172ca119d1f5--fastapi.netlify.app

Kludex
Kludex reviewed Oct 1, 2022
View reviewed changes
Comment thread fastapi/routing.py Outdated
@github-actions

github-actions Bot commented Oct 4, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit e4ddcb8 at: https://633b8d39f6ae0b0073aa6272--fastapi.netlify.app

@github-actions

github-actions Bot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 5943bae at: https://634eff6b41393725675bf3ea--fastapi.netlify.app

@github-actions

github-actions Bot commented Oct 24, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit ccc1987 at: https://6355f671a4e4cf7923aace28--fastapi.netlify.app

@paulo-raca paulo-raca requested a review from Kludex October 24, 2022 02:34
@github-actions

github-actions Bot commented Dec 16, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit f2541d2 at: https://639ce37dca15d5006470360d--fastapi.netlify.app

@github-actions

github-actions Bot commented Feb 5, 2023

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 275208e at: https://63dfcc686a21a87de30b11e3--fastapi.netlify.app

@paulo-raca

paulo-raca commented Feb 5, 2023

Copy link
Copy Markdown
Contributor Author

ping?

@lclbm

lclbm commented Feb 26, 2023

Copy link
Copy Markdown

Is there any progress about this issue?
have the same problem

@tiangolo

tiangolo commented Jun 11, 2023

Copy link
Copy Markdown
Member

📝 Docs preview for commit a463414 at: https://64861d40ff845b421d97876c--fastapi.netlify.app

@tiangolo tiangolo changed the title Support dependencies in websocket routes ✨ Add support for dependencies in WebSocket routes Jun 11, 2023
@tiangolo

tiangolo commented Jun 11, 2023

Copy link
Copy Markdown
Member

Great, thank you @paulo-raca! 🚀 🙇

This will be available in the next version, FastAPI 0.97.0, released in the next hours (or tomorrow). 🎉

@tiangolo tiangolo enabled auto-merge (squash) June 11, 2023 20:33
@paulo-raca

paulo-raca commented Jun 11, 2023

Copy link
Copy Markdown
Contributor Author

Neat, thank you

@tiangolo tiangolo merged commit d8b8f21 into fastapi:master Jun 11, 2023
@bastianh

bastianh commented Jun 22, 2023 •
edited
Loading

Copy link
Copy Markdown

For me this was a breaking change because some dependencies I have on the router itself had Request as a dependency which is not available on the websocket endpoint... and those were suddenly executed for the websocket endpoint as well.

@gjanezic

gjanezic commented Jun 27, 2023

Copy link
Copy Markdown

I have the same problem as @bastianh. How can we resolve this? Maybe related to #8503?

@tiangolo

tiangolo commented Jun 30, 2023

Copy link
Copy Markdown
Member

@bastianh and/or @gjanezic, please create a new discussion with a simple example I can copy paste and replicate your issue: https://github.com/tiangolo/fastapi/discussions/categories/questions 🙏

@monometa monometa mentioned this pull request Oct 17, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tiangolo tiangolo tiangolo left review comments

@Kludex Kludex Awaiting requested review from Kludex

+3 more reviewers

@cikay cikay cikay approved these changes

@BilalAlpaslan BilalAlpaslan BilalAlpaslan approved these changes

@yezz123 yezz123 yezz123 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

investigate

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@paulo-raca @lclbm @tiangolo @bastianh @gjanezic @Kludex @cikay @BilalAlpaslan @yezz123