Merge pull request #1 from pyropy/add-socketio-fastapi-integration

Add basic socketio fastapi integration

Author: pyropy

.gitignore

@@ -7,3 +7,4 @@ venv
 .pytest_cache
 *.egg-info
 .DS_Store
+.vscode/

Pipfile

@@ -11,8 +11,9 @@ neovim = "*"
 fastapi = "==0.61.1"
 netifaces = "==0.10.6"
 pydantic = "==1.6.1"
-socketio = "==0.2.1"
 starlette = "==0.13.6"
+python-socketio = "==4.6.0"
+python-engineio = "*"
 
 [test]
 pytest = "==6.0.1"

Pipfile.lock

@@ -14,7 +14,40 @@ Install this plugin using `pip`:
 
 ## Usage
 
-Usage instructions go here.
+To add SocketIO support to FastAPI all you need to do is import `SocketManager` and pass it `FastAPI` object.
+
+```python
+# app.py
+from fastapi import FastAPI
+from fastapi_socketio import SocketManager
+
+app = FastAPI()
+socket_manager = SocketManager(app=app)
+```
+
+
+Now you can use SocketIO directly from your `FastAPI` app object.
+```python
+# socket_handlers.py
+from .app import app
+
+@app.sio.on('join')
+async def handle_join(sid, *args, **kwargs):
+    await app.sio.emit('lobby', 'User joined')
+
+```
+
+Or you can import `SocketManager` object that exposes most of the SocketIO functionality.
+
+```python
+# socket_handlers2.py
+from .app import socket_manager as sm
+
+@sm.on('leave')
+async def handle_leave(sid, *args, **kwargs):
+    await sm.emit('lobby', 'User left')
+
+```
 
 ## Development
 

README.md

@@ -0,0 +1,28 @@
+from fastapi import FastAPI
+from fastapi_socketio import SocketManager
+
+app = FastAPI()
+sio = SocketManager(app=app)
+
+
+@app.sio.on('join')
+async def handle_join(sid, *args, **kwargs):
+    await sio.emit('lobby', 'User joined')
+
+
+@sio.on('test')
+async def test(sid, *args, **kwargs):
+    await sio.emit('hey', 'joe')
+
+
+
+if __name__ == '__main__':
+    import logging
+    import sys
+
+    logging.basicConfig(level=logging.DEBUG,
+                        stream=sys.stdout)
+
+    import uvicorn
+
+    uvicorn.run("examples:app", host='0.0.0.0', port=8000, reload=True, debug=False)

examples/app.py

@@ -1,2 +1,4 @@
+from .socket_manager import SocketManager
+
 def example_function():
     return 1 + 1

fastapi_socketio/__init__.py

@@ -0,0 +1,88 @@
+import socketio
+from fastapi import FastAPI
+
+
+class SocketManager:
+    """
+    Integrates SocketIO with FastAPI app. 
+    Adds `sio` property to FastAPI object (app).
+
+    Default mount location for SocketIO app is at `/ws`
+    and defautl SocketIO path is `socket.io`.
+    (e.g. full path: `ws://www.example.com/ws/socket.io/)
+
+    SocketManager exposes basic underlying SocketIO functionality
+
+    e.g. emit, on, send, call, etc.
+    """
+
+    def __init__(
+        self,
+        app: FastAPI,
+        mount_location: str = "/ws",
+        socketio_path: str = "socket.io",
+        cors_allowed_origins: list = [],
+    ) -> None:
+        # TODO: Change Cors policy based on fastapi cors Middleware
+        self._sio = socketio.AsyncServer(async_mode="asgi", cors_allowed_origins="*")
+        self._app = socketio.ASGIApp(
+            socketio_server=self._sio, socketio_path=socketio_path
+        )
+
+        app.mount(mount_location, self._app)
+        app.sio = self._sio
+
+    def is_asyncio_based(self) -> bool:
+        return True
+
+    @property
+    def on(self):
+        return self._sio.on
+
+    @property
+    def attach(self):
+        return self._sio.attach
+
+    @property
+    def emit(self):
+        return self._sio.emit
+
+    @property
+    def send(self):
+        return self._sio.send
+
+    @property
+    def call(self):
+        return self._sio.call
+
+    @property
+    def close_room(self):
+        return self._sio.close_room
+
+    @property
+    def get_session(self):
+        return self._sio.get_session
+
+    @property
+    def save_session(self):
+        return self._sio.save_session
+
+    @property
+    def session(self):
+        return self._sio.session
+
+    @property
+    def disconnect(self):
+        return self._sio.disconnect
+
+    @property
+    def handle_request(self):
+        return self._sio.handle_request
+
+    @property
+    def start_background_task(self):
+        return self._sio.start_background_task
+
+    @property
+    def sleep(self):
+        return self._sio.sleep