Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

task/socketio add base websocket service #236

Merged
merged 23 commits into from
Mar 16, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 83 additions & 3 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ redis = ">=4.2.0rc1"
pydantic = {version = "^2.5.1", extras = ["email"]}
py-fast-grpc = "^0.3.4"
cryptography = "^42.0.4"
python-socketio = "^5.11.1"

[tool.poetry.extras]
sqlite = ["aiosqlite"]
Expand Down
2 changes: 1 addition & 1 deletion sapphire/common/api/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from fastapi.middleware.cors import CORSMiddleware
from loguru import logger

from .uvicorn_server import UvicornServer
from sapphire.common.uvicorn_server import UvicornServer


class BaseAPIService(ServiceMixin):
Expand Down
Empty file.
44 changes: 44 additions & 0 deletions sapphire/common/socketio/service.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
from typing import Iterable

import socketio
import uvicorn
from facet import ServiceMixin
from loguru import logger

from sapphire.common.uvicorn_server import UvicornServer


class BaseSocketIOService(ServiceMixin):
def __init__(
self,
root_path: str = "",
allowed_origins: Iterable[str] = (),
port: int = 8000,
namespaces: dict[str, socketio.AsyncNamespace] | None = None,
):
self._root_path = root_path
self._port = port
self._server = socketio.AsyncServer(
async_mode="asgi",
cors_allowed_origins=allowed_origins,
)
if namespaces:
vanvanich9 marked this conversation as resolved.
Show resolved Hide resolved
for name, namespace in namespaces.items():
self._server.register_namespace(namespace(name))

def get_app(self) -> socketio.ASGIApp:
sio_app = socketio.ASGIApp(
socketio_server=self._server,
socketio_path=self._root_path,
)
return sio_app

async def start(self):
config = uvicorn.Config(app=self.get_app(), host="0.0.0.0", port=self._port)
server = UvicornServer(config)

logger.info("Start Socket IO service")
self.add_task(server.serve())

async def stop(self):
logger.info("Stop Socket IO service")
8 changes: 8 additions & 0 deletions sapphire/common/socketio/settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
from pydantic import conint
from pydantic_settings import BaseSettings


class BaseSocketIOSettings(BaseSettings):
port: conint(ge=1, le=65535) = 8080
root_path: str = ""
allowed_origins: list[str] = []