Websocket 'broadcast' demo using FastAPI/Starlette

Last update: Nov 30, 2022

Overview

fastapi-websocket-broadcast

An example of the familiar 'chat' websocket demo app, implemented in FastAPI / Starlette.

Run with

uvicorn app:app

And then point your browser to http://localhost:8000. REST API documentation is available under the /docs endpoint.

Websocket interface

Data from the server is JSON in the form

{
    "type": ...,
    "data": {
        ...
    }
}

Where type is one of:

ROOM_JOIN - sent to a user on successfully joining the chatroom
USER_JOIN - sent to all chatroom users when a new user joins the chatroom
USER_LEAVE - sent to all chatroom users when a user leaves the chatroom
ERROR - sent to one or more users in the event of a server error
MESSAGE - chat message from one user, broadcast to all chatroom users
WHISPER - private message from one user to another

Comments

MiddleWare throwing error!
ERROR

File "./app.py", line 189, in app.add_middleware(RoomEventMiddleware) File "/home/sree/SREEVISHAL/Project/fastapi-websocket-broadcast/venv/lib/python3.6/site-packages/starlette/applications.py", line 117, in add_middleware self.middleware_stack = self.build_middleware_stack() File "/home/sree/SREEVISHAL/Project/fastapi-websocket-broadcast/venv/lib/python3.6/site-packages/starlette/applications.py", line 81, in build_middleware_stack app = cls(app=app, **options) TypeError: init() got an unexpected keyword argument 'app'

My package versions

fastapi==0.58.0

starlette==0.13.4

uvicorn==0.11.5

Command used to run the app

uvicorn app:app
opened by rsreevishal 4

Error in room

You are passing "server" as user_id to the broadcast method, this user_id will never exists. Thunder endpoint

@app.post("/thunder")
async def thunder(request: Request, distance: ThunderDistance = Body(...)):
    """Broadcast an ambient message to all chat room users.
    """
    room: Optional[Room] = request.get("room")
    if room is None:
        raise HTTPException(500, detail="Global `Room` instance unavailable!")
    if distance.category == Distance.Near:
        await room.broadcast_message("server", "Thunder booms overhead")
    elif distance.category == Distance.Far:
        await room.broadcast_message("server", "Thunder rumbles in the distance")
    else:
        await room.broadcast_message("server", "You feel a faint tremor")

``broadcast_messagemethod inRoom` class

async def broadcast_message(self, user_id: str, msg: str):
        """Broadcast message to all connected users.
        """
        # self._user_meta[user_id].message_count += 1 
        for websocket in self._users.values():
            await websocket.send_json(
                {"type": "MESSAGE", "data": {"user_id": user_id, "msg": msg}}
            )

opened by lautarodapin 1

build(deps): Bump fastapi from 0.42.0 to 0.65.2
Bumps fastapi from 0.42.0 to 0.65.2.

Release notes

Sourced from fastapi's releases.

0.65.2

Security fixes

🔒 Check Content-Type request header before assuming JSON. Initial PR #2118 by @patrickkwang.

This change fixes a CSRF security vulnerability when using cookies for authentication in path operations with JSON payloads sent by browsers.

In versions lower than 0.65.2, FastAPI would try to read the request payload as JSON even if the content-type header sent was not set to application/json or a compatible JSON media type (e.g. application/geo+json).

So, a request with a content type of text/plain containing JSON data would be accepted and the JSON data would be extracted.

But requests with content type text/plain are exempt from CORS preflights, for being considered Simple requests. So, the browser would execute them right away including cookies, and the text content could be a JSON string that would be parsed and accepted by the FastAPI application.

See CVE-2021-32677 for more details.

Thanks to Dima Boger for the security report! 🙇🔒

Internal

🔧 Update sponsors badge, course bundle. PR #3340 by @tiangolo.

🔧 Add new gold sponsor Jina 🎉. PR #3291 by @tiangolo.

🔧 Add new banner sponsor badge for FastAPI courses bundle. PR #3288 by @tiangolo.

👷 Upgrade Issue Manager GitHub Action. PR #3236 by @tiangolo.

0.65.1

Security fixes

📌 Upgrade pydantic pin, to handle security vulnerability CVE-2021-29510. PR #3213 by @tiangolo.

0.65.0

Breaking Changes - Upgrade

⬆️ Upgrade Starlette to 0.14.2, including internal UJSONResponse migrated from Starlette. This includes several bug fixes and features from Starlette. PR #2335 by @hanneskuettner.

Translations

🌐 Initialize new language Polish for translations. PR #3170 by @neternefer.

Internal

👷 Add GitHub Action cache to speed up CI installs. PR #3204 by @tiangolo.

⬆️ Upgrade setup-python GitHub Action to v2. PR #3203 by @tiangolo.

🐛 Fix docs script to generate a new translation language with overrides boilerplate. PR #3202 by @tiangolo.

✨ Add new Deta banner badge with new sponsorship tier 🙇. PR #3194 by @tiangolo.

👥 Update FastAPI People. PR #3189 by @github-actions[bot].

🔊 Update FastAPI People to allow better debugging. PR #3188 by @tiangolo.

0.64.0

Features

... (truncated)

Commits

4d91f97 🔖 Release version 0.65.2

aabe2c7 📝 Update release notes

377234a 🔒 Create Security Policy

38b7858 📝 Update release notes

fa7e3c9 🐛 Check Content-Type request header before assuming JSON (#2118)

90120dd 📝 Update release notes

3677254 🔧 Update sponsors badge, course bundle (#3340)

40bb0c5 📝 Update release notes

60918d2 🔧 Add new gold sponsor Jina 🎉 (#3291)

3afce2c 📝 Update release notes

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
build(deps): Bump uvicorn from 0.10.3 to 0.11.7
Bumps uvicorn from 0.10.3 to 0.11.7.

Release notes

Sourced from uvicorn's releases.

Version 0.11.7

0.11.7

SECURITY FIX: Prevent sending invalid HTTP header names and values.

SECURITY FIX: Ensure path value is escaped before logging to the console.

Version 0.11.6

Fix overriding the root logger.

Version 0.11.5

Revert "Watch all files, not just .py" due to unexpected side effects.

Revert "Pass through gunicorn timeout config." due to unexpected side effects.

Version 0.11.4

Use watchgod, if installed, for watching code changes.

Reload application when any files in watched directories change, not just .py files.

Changelog

Sourced from uvicorn's changelog.

0.11.7

SECURITY FIX: Prevent sending invalid HTTP header names and values.

SECURITY FIX: Ensure path value is escaped before logging to the console.

0.11.6

Fix overriding the root logger.

0.11.5

Revert "Watch all files, not just .py" due to unexpected side effects.

Revert "Pass through gunicorn timeout config." due to unexpected side effects.

0.11.4

Use watchgod, if installed, for watching code changes.

Watch all files, not just .py.

Pass through gunicorn timeout config.

0.11.3

Update dependencies.

0.11.2

Don't open socket until after application startup.

Support --backlog.

0.11.1

Use a more liberal h11 dependency. Either 0.8.* or `0.9.*``.

0.11.0

Fix reload/multiprocessing on Windows with Python 3.8.

Drop IOCP support. (Required for fix above.)

Add uvicorn --version flag.

Add --use-colors and --no-use-colors flags.

Display port correctly, when auto port selection isused with --port=0.

0.10.8

Fix reload/multiprocessing error.

0.10.7

Use resource_sharer.DupSocket to resolve socket sharing on Windows.

0.10.6

Commits

178bee6 Version 0.11.7 (#726)

a796e1d Corrected --proxy-headers client ip/host when using a unix socket (#636)

895807f Quote path component before logging (#724)

789e2f1 Disallow invalid header characters (#725)

81f2136 Brings back windows testing to CI (#685)

f623916 Release version 0.11.6 (#705)

6757386 Removing iocp mentions from documentation (#692)

77468df Add --app-dir option for running uvicorn from any location (#619)

9b92925 Document default backlog setting (#682)

2dcbb13 Fix typo. (#676)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Changing user name

I try to change usr_id when I call the websocket . @app.websocket_route("/ws/{user_id}", name="ws") But I dont know how to change in the code. Can you plz help me to do. I am newbie so plz help me

opened by joshung 0

Owner

Kit Thwaite

GitHub

Whatsapp Clone using django, django-channels and websocket

whatsapp-clone Whatsapp Clone using django, django-channels and websocket Features : Signup/Login One on One personal chat with other user Some screen

14 Dec 25, 2022

WebSocket and WAMP in Python for Twisted and asyncio

Autobahn|Python WebSocket & WAMP for Python on Twisted and asyncio. Quick Links: Source Code - Documentation - WebSocket Examples - WAMP Examples Comm

2.4k Jan 4, 2023

Library for building WebSocket servers and clients in Python

What is websockets? websockets is a library for building WebSocket servers and clients in Python with a focus on correctness and simplicity. Built on

4.3k Jan 4, 2023

WebSocket client for Python

websocket-client The websocket-client module is a WebSocket client for Python. It provides access to low level APIs for WebSockets. All APIs are for s

3.1k Jan 2, 2023

Django Channels HTTP/WebSocket server

daphne Daphne is a HTTP, HTTP2 and WebSocket protocol server for ASGI and ASGI-HTTP, developed to power Django Channels. It supports automatic negotia

1.9k Dec 31, 2022

Websockify is a WebSocket to TCP proxy/bridge. This allows a browser to connect to any application/server/service. Implementations in Python, C, Node.js and Ruby.

websockify: WebSockets support for any application/server websockify was formerly named wsproxy and was part of the noVNC project. At the most basic l

3.3k Jan 3, 2023

WebSocket emulation - Python server

SockJS-tornado server SockJS-tornado is a Python server side counterpart of SockJS-client browser library running on top of Tornado framework. Simplif

854 Nov 19, 2022

一款为 go-cqhttp 的正向 WebSocket 设计的 Python SDK

Nakuru Project 一款为 go-cqhttp 的正向 WebSocket 设计的 Python SDK 在 kuriyama 的基础上改动项目名来源于藍月なくる，图标由せら绘制食用方法将 nakuru 文件夹移至 Python 的 Lib/site-packages 目录下。

35 Dec 21, 2022

This websocket program is for data transmission between server and client. Data transmission is for Federated Learning in Edge computing environment.

websocket-for-data-transmission This websocket program is for data transmission between server and client. Data transmission is for Federated Learning

9 Jul 19, 2022

Websocket 'broadcast' demo using FastAPI/Starlette

Related tags

Overview

fastapi-websocket-broadcast

Websocket interface

Comments

MiddleWare throwing error!

Error in room

build(deps): Bump fastapi from 0.42.0 to 0.65.2

0.65.2

Security fixes

Internal

0.65.1

Security fixes

0.65.0

Breaking Changes - Upgrade

Translations

Internal

0.64.0

Features

build(deps): Bump uvicorn from 0.10.3 to 0.11.7

Version 0.11.7

0.11.7

Version 0.11.6

Version 0.11.5

Version 0.11.4

0.11.7

0.11.6

0.11.5

0.11.4

0.11.3

0.11.2

0.11.1

0.11.0

0.10.8

0.10.7

0.10.6

Changing user name

Owner

Kit Thwaite

Whatsapp Clone using django, django-channels and websocket

WebSocket and WAMP in Python for Twisted and asyncio

Library for building WebSocket servers and clients in Python

WebSocket client for Python

Django Channels HTTP/WebSocket server

Websockify is a WebSocket to TCP proxy/bridge. This allows a browser to connect to any application/server/service. Implementations in Python, C, Node.js and Ruby.

WebSocket emulation - Python server

一款为 go-cqhttp 的正向 WebSocket 设计的 Python SDK

This websocket program is for data transmission between server and client. Data transmission is for Federated Learning in Edge computing environment.

WebSocket implementation in Python built on top of websockets python library. Similar to Node.js's ws.

Benchmark a WebSocket server's message throughput ⌛

wssh ("wish") is a command-line utility/shell for WebSocket inpsired by netcat.

Minecraft WebSocket

Tetri5 - Multiplayer Websocket Backend

alien.py - Python interface to websocket endpoint of ALICE Grid Services

image stream publish server over websocket

AWS API Gateway Websocket Asynchronous Notifications Pusher

Discord.py Connect to Discord voice call with websocket

A websocket client for Source Filmmaker intended to trasmit scene and frame data to other applications.