Files
Sternsinger/CMBNet/cmbnet/ws/heartbeat.py
T

122 lines
4.7 KiB
Python

"""
Heartbeat-Routine für WebSocket-Verbindungen
Der Server sendet jede Minute eine Nachricht mit Code 1 an alle
authentifizierten Clients. Die Clients antworten mit Code 2; diese Antwort
wird vom Broker ausschließlich an Dispatcher-Views weitergeleitet.
Zusätzlich räumt die Routine abgelaufene Late-Entry-Nachrichten auf, damit die
Tabelle ws_messages_store nicht unbegrenzt wächst.
"""
from threading import Timer
from cmbnet.ws import broker, store
from cmbnet.ws.protocol import WSMessage
class HeartbeatManager:
def __init__(self, interval=60):
self.interval = interval
self.running = False
self.app = None
self._timer = None
self._presence_timer = None
def start(self, app=None, interval=None):
"""Startet die zyklische Heartbeat-Routine."""
# Die App-Referenz wird benötigt, um im Hintergrund-Thread einen
# Flask-App-Kontext für Datenbankzugriffe öffnen zu können.
if app is not None:
self.app = app
if interval is not None:
self.interval = interval
if self.running:
return
self.running = True
self._send_heartbeat()
self._check_presence()
def stop(self):
"""Stoppt die Heartbeat-Routine."""
self.running = False
for timer in (self._timer, self._presence_timer):
if timer is not None:
timer.cancel()
self._timer = None
self._presence_timer = None
def _check_presence(self):
"""Prüft die Code-2-Lebenszeichen der Gruppen unabhängig vom Heartbeat."""
if not self.running:
return
if self.app is not None:
try:
with self.app.app_context():
broker.check_group_presence_timeouts()
except Exception as exc:
print(f'Group presence check error: {exc}')
# Kürzer als das Zwei-Minuten-Fenster prüfen, damit der Status
# zeitnah auf "unterwegs" wechselt.
self._presence_timer = Timer(15, self._check_presence)
self._presence_timer.daemon = True
self._presence_timer.start()
def _send_heartbeat(self):
if not self.running:
return
msg = WSMessage(sender_id=0, code=1, msg='ping')
if self.app is not None:
try:
# Auch der Versand braucht einen App-Kontext: Die
# Sequenznummern liegen inzwischen in der gemeinsamen
# SQLite-Datenbank und werden beim Senden fortgeschrieben.
with self.app.app_context():
# Eigenes Lebenszeichen aktualisieren, bevor verwaiste
# Clients anderer Worker erkannt werden.
timeout = self.app.config.get(
'WS_CLIENT_OFFLINE_TIMEOUT_SECONDS',
max(180, int(self.interval) * 3)
)
store.touch_worker(broker.worker_id)
store.mark_orphan_clients_disconnected(
store.now() - max(1, int(timeout))
)
# Nur authentifizierte Verbindungen erhalten einen
# Heartbeat.
for tenant_id, connections in list(broker.connections.items()):
for client_id in list(connections):
if not broker.is_authenticated(tenant_id, client_id):
continue
broker.send_to_connection(
tenant_id, client_id, msg.to_json()
)
# Halb offene Verbindungen erkennen. Ein mobiles Gerät
# verliert beim Schlafenlegen oft die Verbindung, ohne
# dass der Server ein FIN/RST erhält. Ohne diese Prüfung
# bliebe der Client dauerhaft als "verbunden" markiert
# und würde nie über FCM geweckt.
broker.check_client_liveness(timeout)
store.cleanup_worker_registry(max(600, int(timeout) * 4))
# Abgelaufene persistierte Nachrichten und Client-Queues
# löschen.
broker.cleanup_client_queues()
broker.cleanup_old_messages()
except Exception as exc:
print(f'Heartbeat cleanup error: {exc}')
# Nächsten Heartbeat planen. Der Timer läuft als Daemon, damit er den
# Prozess beim Beenden nicht blockiert.
self._timer = Timer(self.interval, self._send_heartbeat)
self._timer.daemon = True
self._timer.start()
heartbeat_manager = HeartbeatManager()