mirror of
https://github.com/Donkie/Spoolman.git
synced 2026-10-21 17:42:16 -05:00
Donkie
025f18f914
The REST endpoints serialize with response_model_exclude_none=True (unset fields are omitted), but websocket events were serialized with a plain .json() that includes unset fields as explicit null. The spool list fills a missing price from the filament price only when it is `undefined`, so a live update carrying `price: null` (e.g. after a quick weight adjust) blanked the price column until a full page reload. Fixed on both sides so the two serialization paths can no longer drift: - Server: websocket payloads now use exclude_none=True (spoolman/ws.py), giving live updates and REST responses an identical shape. Note this is a small websocket wire-format change external consumers will see: unset fields are now omitted instead of sent as null, matching REST. - Client: collapseSpool and the price column now fall back for both `null` and `undefined`, keeping the list resilient regardless of serialization.
107 lines
4.0 KiB
Python
107 lines
4.0 KiB
Python
"""Websocket functionality."""
|
|
|
|
import logging
|
|
|
|
from fastapi import WebSocket
|
|
from starlette.websockets import WebSocketState
|
|
|
|
from spoolman.api.v1.models import Event
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class SubscriptionTree:
|
|
"""Subscription tree.
|
|
|
|
This is a tree structure that allows us to efficiently send messages to
|
|
all websockets that are subscribed to a certain pool of events.
|
|
|
|
You can subscribe to different levels of the tree, for example:
|
|
- ("vendor", "1") will subscribe to events for vendor 1
|
|
- ("vendor") will subscribe to events for all vendors
|
|
- () will subscribe to events for all vendors, filaments and spools
|
|
"""
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize."""
|
|
self.children: dict[str, SubscriptionTree] = {}
|
|
self.subscribers: set[WebSocket] = set()
|
|
|
|
def add(self, path: tuple[str, ...], websocket: WebSocket) -> None:
|
|
"""Add a websocket to the subscription tree."""
|
|
if len(path) == 0:
|
|
self.subscribers.add(websocket)
|
|
else:
|
|
if path[0] not in self.children:
|
|
self.children[path[0]] = SubscriptionTree()
|
|
self.children[path[0]].add(path[1:], websocket)
|
|
|
|
def remove(self, path: tuple[str, ...], websocket: WebSocket) -> None:
|
|
"""Remove a websocket from the subscription tree."""
|
|
if len(path) == 0:
|
|
self.subscribers.remove(websocket)
|
|
elif path[0] in self.children:
|
|
self.children[path[0]].remove(path[1:], websocket)
|
|
|
|
async def send(self, path: tuple[str, ...], evt: Event) -> None:
|
|
"""Send a message to all websockets in this branch of the tree."""
|
|
# Broadcast to all subscribers on this level
|
|
for websocket in self.subscribers:
|
|
if (
|
|
websocket.client_state == WebSocketState.DISCONNECTED # noqa: PLR1714
|
|
or websocket.application_state == WebSocketState.DISCONNECTED
|
|
):
|
|
# A bad disconnection may have occurred
|
|
self.remove(path, websocket)
|
|
logger.info(
|
|
"Forcing disconnection of client %s on pool %s",
|
|
websocket.client.host if websocket.client else "?",
|
|
",".join(path),
|
|
)
|
|
elif (
|
|
websocket.client_state == WebSocketState.CONNECTED
|
|
and websocket.application_state == WebSocketState.CONNECTED
|
|
):
|
|
# exclude_none mirrors the REST endpoints' response_model_exclude_none=True so that
|
|
# websocket payloads and REST responses have an identical shape. Without this, unset
|
|
# fields arrive as explicit `null` over the websocket but are omitted over REST, which
|
|
# trips up clients that distinguish the two (e.g. the spool list's price fallback).
|
|
await websocket.send_text(evt.json(exclude_none=True))
|
|
|
|
# Send the message further down the tree
|
|
if len(path) > 0 and path[0] in self.children:
|
|
await self.children[path[0]].send(path[1:], evt)
|
|
|
|
|
|
class WebsocketManager:
|
|
"""Websocket manager."""
|
|
|
|
def __init__(self) -> None:
|
|
"""Initialize."""
|
|
self.tree = SubscriptionTree()
|
|
|
|
def connect(self, pool: tuple[str, ...], websocket: WebSocket) -> None:
|
|
"""Connect a websocket."""
|
|
self.tree.add(pool, websocket)
|
|
logger.info(
|
|
"Client %s is now listening on pool %s",
|
|
websocket.client.host if websocket.client else "?",
|
|
",".join(pool),
|
|
)
|
|
|
|
def disconnect(self, pool: tuple[str, ...], websocket: WebSocket) -> None:
|
|
"""Disconnect a websocket."""
|
|
self.tree.remove(pool, websocket)
|
|
logger.info(
|
|
"Client %s has stopped listening on pool %s",
|
|
websocket.client.host if websocket.client else "?",
|
|
",".join(pool),
|
|
)
|
|
|
|
async def send(self, pool: tuple[str, ...], evt: Event) -> None:
|
|
"""Send a message to all websockets in a pool."""
|
|
await self.tree.send(pool, evt)
|
|
|
|
|
|
websocket_manager = WebsocketManager()
|