The firmware publishes status/heartbeat, system/alerts, system/info and
status/playback with retain=true. On every backend (re)connect - every
restart and every uvicorn --reload - the broker replays the last message on
each of those topics for every device that ever connected. We handled those
replays as if they had just happened:
- heartbeats: a row with received_at=now() for every device, so devices
that have been dead for months showed ONLINE for 90s after each restart
and got pinged. ~770k such rows exist locally.
- boot_report: the last boot logged again as a new reboot (the phantom
PANIC entries on the Health tab).
- alerts / other info events: logged again as new occurrences.
MQTT delivers retain=1 only for replays caused by a new subscription; live
publishes always arrive with retain=0. The flag is now passed through to the
handlers and the WS broadcast:
- heartbeat: replays are not stored. A live heartbeat is.
- {"state":"offline"} heartbeat (LWT / graceful disconnect) is no longer
stored as a sign of life. It marks the device offline immediately in
a small in-memory set (mqtt/presence.py) used by /mqtt/status and the ping
loop; a later live heartbeat clears it. Replayed offline markers also mark
offline, since a retained message is the device's last word.
- boot_report: live -> always a new boot. Replay -> stored only if it
differs from the device's latest boot row (i.e. we missed it while down).
- alerts: replay still syncs the current-alert row; history gets a row on a
live alert (even an identical repeat - faults recur) or on a replay that
changes state. Replaces the 98dd16b rule that dropped identical live alerts.
- other info events: replays are not logged.
- Frontend (DeviceList, DeviceDetail, LogsTab) ignores retained WS messages
for live updates, and flips a device offline on the offline marker instead
of marking it online.
Verified locally after a backend restart: only the 7 actually-live devices
got new heartbeat rows (none from the replays), and no boot/alert/info rows
were created.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
265 lines
11 KiB
Python
265 lines
11 KiB
Python
import logging
|
|
import time
|
|
import database as db
|
|
from mqtt import presence
|
|
|
|
logger = logging.getLogger("mqtt.logger")
|
|
|
|
LEVEL_MAP = {
|
|
"🟢 INFO": "INFO",
|
|
"🟡 WARN": "WARN",
|
|
"🔴 EROR": "ERROR",
|
|
"INFO": "INFO",
|
|
"WARN": "WARN",
|
|
"ERROR": "ERROR",
|
|
"EROR": "ERROR",
|
|
}
|
|
|
|
|
|
async def handle_message(serial: str, topic_type: str, payload: dict,
|
|
retained: bool = False):
|
|
"""`retained` is True when the broker replayed this from its retained store
|
|
on (re)subscribe: a stale copy of the device's last message, NOT a new
|
|
event. The firmware publishes status/heartbeat, system/alerts, system/info
|
|
and status/playback retained, so every backend restart replays them for
|
|
every device that ever connected. Handlers for those topics must never
|
|
record a retained replay as something that just happened."""
|
|
try:
|
|
# v2 topic set — see project-vesper's vesper_mqtt_topic_spec_v2.md.
|
|
if topic_type == "status/heartbeat":
|
|
await _handle_heartbeat(serial, payload, retained)
|
|
elif topic_type == "system/alerts":
|
|
await _handle_alerts(serial, payload, retained)
|
|
elif topic_type == "system/info":
|
|
await _handle_info(serial, payload, retained)
|
|
elif topic_type == "system/logs":
|
|
await _handle_log(serial, payload)
|
|
elif topic_type == "system/metrics":
|
|
await _handle_metrics(serial, payload)
|
|
elif topic_type == "control/ack":
|
|
await _handle_ack(serial, payload)
|
|
elif topic_type == "control/reports":
|
|
await _handle_report(serial, payload)
|
|
elif topic_type == "status/playback":
|
|
pass # no console-side storage needed — WS broadcast already carries it live
|
|
else:
|
|
logger.debug(f"Unhandled topic type: {topic_type} for {serial}")
|
|
except Exception as e:
|
|
logger.error(f"Error handling {topic_type} for {serial}: {e}")
|
|
|
|
|
|
async def _handle_heartbeat(serial: str, payload: dict, retained: bool = False):
|
|
# Online status is "a heartbeat row newer than 90s", so only a live sign of
|
|
# life may be stored:
|
|
# - retained replay: the device's last heartbeat from whenever. Storing it
|
|
# with received_at=now() marked every device ever seen (even long-dead
|
|
# ones) online for 90s after each backend restart.
|
|
# - state "offline": the LWT / graceful-disconnect marker published when
|
|
# the device goes AWAY. Not a heartbeat, but it IS current state even
|
|
# when replayed (a retained message is the device's last word).
|
|
if payload.get("state") == "offline":
|
|
presence.mark_offline(serial)
|
|
return
|
|
if retained:
|
|
return
|
|
presence.mark_alive(serial)
|
|
# Store silently — do not log as a visible event.
|
|
# The console surfaces an alert only when the device goes silent (no heartbeat for 90s).
|
|
# v2 heartbeat payload is FLAT — no {"status","type","payload"} wrapper,
|
|
# and field names changed: firmware_version -> fw_version, timestamp -> uptime_human.
|
|
# See vesper_mqtt_topic_spec_v2.md and mqtt-events.md for the full shape.
|
|
await db.insert_heartbeat(
|
|
device_serial=serial,
|
|
device_id=payload.get("device_id", ""),
|
|
firmware_version=payload.get("fw_version", ""),
|
|
ip_address=payload.get("ip_address", ""),
|
|
gateway=payload.get("gateway", ""),
|
|
uptime_ms=payload.get("uptime_ms", 0),
|
|
uptime_display=payload.get("uptime_human", ""),
|
|
rssi=payload.get("rssi"),
|
|
free_heap=payload.get("free_heap"),
|
|
state=payload.get("state"),
|
|
ok=payload.get("ok"),
|
|
)
|
|
|
|
|
|
async def _handle_log(serial: str, payload: dict):
|
|
raw_level = payload.get("level", "INFO")
|
|
level = LEVEL_MAP.get(raw_level, "INFO")
|
|
message = payload.get("message", "")
|
|
device_timestamp = payload.get("timestamp")
|
|
|
|
await db.insert_log(
|
|
device_serial=serial,
|
|
level=level,
|
|
message=message,
|
|
device_timestamp=device_timestamp,
|
|
source="log",
|
|
)
|
|
|
|
|
|
async def _handle_alerts(serial: str, payload: dict, retained: bool = False):
|
|
subsystem = payload.get("subsystem", "")
|
|
state = payload.get("state", "")
|
|
if not subsystem or not state:
|
|
logger.warning(f"Malformed alert payload from {serial}: {payload}")
|
|
return
|
|
|
|
if state == "CLEARED":
|
|
await db.delete_alert(serial, subsystem)
|
|
else:
|
|
# Retained replays still sync the current-alert row, so a fresh DB
|
|
# learns about alerts raised while the backend was down.
|
|
changed = await db.upsert_alert(serial, subsystem, state, payload.get("msg"))
|
|
# Append-only history — survives past the alert being resolved, used to
|
|
# answer "when was the most recent issue" even once it's cleared.
|
|
# A live alert is always a new occurrence (the same fault can recur);
|
|
# a retained replay only counts if it isn't already the current state.
|
|
if changed or not retained:
|
|
await db.insert_alert_event(serial, subsystem, state, payload.get("msg"))
|
|
|
|
|
|
async def _handle_info(serial: str, payload: dict, retained: bool = False):
|
|
event_type = payload.get("type", "")
|
|
|
|
# boot_report carries structured fields (boot_count, crash detail, etc.) —
|
|
# parsed into device_boot_events instead of flattened into a text log line,
|
|
# so the Health tab can query/chart it. Not routed through insert_log at
|
|
# all: a text summary here would just duplicate the structured row.
|
|
#
|
|
# Note: diagnostics_report used to also arrive here (F-056) but moved to
|
|
# its own system/metrics topic in the v2 spec — see _handle_metrics below.
|
|
if event_type == "boot_report":
|
|
await _handle_boot_report(serial, payload, retained)
|
|
return
|
|
|
|
# Any other info event replayed from the retained store (e.g. an old
|
|
# playback_started) already happened in the past — don't log it again.
|
|
if retained:
|
|
return
|
|
|
|
data = payload.get("payload", {})
|
|
|
|
if event_type == "playback_started":
|
|
message = f"Playback started — melody_uid={data.get('melody_uid')}"
|
|
elif event_type == "playback_stopped":
|
|
message = "Playback stopped"
|
|
else:
|
|
message = f"Info event '{event_type}'" + (f" — {data}" if data else "")
|
|
|
|
await db.insert_log(
|
|
device_serial=serial,
|
|
level="INFO",
|
|
message=message,
|
|
source="info",
|
|
)
|
|
|
|
|
|
async def _handle_boot_report(serial: str, payload: dict, retained: bool = False):
|
|
"""Parses the firmware's consolidated boot_report event (see
|
|
CommunicationRouter::reportBootOnce() / publishInfo()) into
|
|
device_boot_events. Like all status/info events, the report fields are
|
|
nested under "payload" — CommunicationRouter::publishInfo() wraps every
|
|
info event as { "type": ..., "payload": {...} }.
|
|
"""
|
|
data = payload.get("payload", {})
|
|
crash = data.get("crash") or {}
|
|
await db.insert_boot_event(
|
|
device_serial=serial,
|
|
boot_count=data.get("boot_count"),
|
|
reset_reason=data.get("reset_reason"),
|
|
is_fault=bool(data.get("is_fault", False)),
|
|
free_heap=data.get("free_heap"),
|
|
crash_task=crash.get("task"),
|
|
crash_pc=crash.get("pc"),
|
|
crash_exc_cause=crash.get("exc_cause"),
|
|
crash_exc_vaddr=crash.get("exc_vaddr"),
|
|
# A live boot_report is always a new boot. A retained replay is the
|
|
# device's last boot, recorded only if we missed it while down.
|
|
skip_if_latest=retained,
|
|
)
|
|
|
|
|
|
async def _handle_metrics(serial: str, payload: dict):
|
|
"""Parses the firmware's periodic metrics payload (see
|
|
CommunicationRouter::reportDiagnosticsIfDue() in project-vesper) into
|
|
device_diagnostics_reports. Unlike status/info events, system/metrics has
|
|
NO {"type","payload"} wrapper — the payload IS the metrics object,
|
|
flat at the top level. See vesper_mqtt_topic_spec_v2.md / mqtt-events.md.
|
|
|
|
cpu_temp is entirely absent from the firmware payload (not present as a
|
|
key at all, not present-with-nulls) when no samples were taken yet this
|
|
window — .get() on a missing "cpu_temp" key correctly falls back to {}
|
|
below, leaving every cpu_temp_* column null for that row.
|
|
"""
|
|
cpu_temp = payload.get("cpu_temp") or {}
|
|
wifi = payload.get("wifi_reconnects") or {}
|
|
ota = payload.get("ota") or {}
|
|
stack = payload.get("stack_high_water") or {}
|
|
bell_strikes = payload.get("bell_strikes") or {}
|
|
bell_loads = payload.get("bell_loads") or {}
|
|
|
|
await db.insert_diagnostics_report(
|
|
device_serial=serial,
|
|
cpu_temp_avg=cpu_temp.get("avg"),
|
|
cpu_temp_min=cpu_temp.get("min"),
|
|
cpu_temp_max=cpu_temp.get("max"),
|
|
cpu_temp_samples=cpu_temp.get("samples"),
|
|
wifi_reconnect_count=wifi.get("lifetime_count"),
|
|
wifi_last_disconnect_reason=wifi.get("last_reason"),
|
|
wifi_last_disconnect_uptime_ms=wifi.get("last_at_uptime_ms"),
|
|
ota_current_version=ota.get("current_version"),
|
|
ota_update_available=ota.get("update_available"),
|
|
ota_available_version=ota.get("available_version"),
|
|
ota_last_check_uptime_ms=ota.get("last_check_uptime_ms"),
|
|
ota_last_error=ota.get("last_error"),
|
|
stack_high_water=stack if stack else None,
|
|
bell_strikes=bell_strikes if bell_strikes else None,
|
|
bell_loads=bell_loads if bell_loads else None,
|
|
cooling_active=payload.get("cooling_active"),
|
|
)
|
|
|
|
|
|
async def _handle_report(serial: str, payload: dict):
|
|
"""Parses control/reports — critical, unsolicited board-initiated events
|
|
(currently only bell_overload). Console-side storage is intentionally
|
|
light: history/audit only. The tablets are the real-time consumer."""
|
|
report_type = payload.get("type", "")
|
|
if not report_type:
|
|
logger.warning(f"Malformed report payload from {serial}: {payload}")
|
|
return
|
|
|
|
await db.insert_report(
|
|
device_serial=serial,
|
|
report_type=report_type,
|
|
payload=payload.get("payload"),
|
|
)
|
|
logger.warning(f"Report '{report_type}' received from {serial}: {payload.get('payload')}")
|
|
|
|
|
|
async def _handle_ack(serial: str, payload: dict):
|
|
status = payload.get("status", "")
|
|
|
|
# Health-check pings (see MqttManager.ping_loop) are published directly,
|
|
# bypassing db.insert_command, so scheduled liveness checks don't clutter
|
|
# the user-facing command history. The device echoes the caller's own
|
|
# send-time ("ts", epoch-ms) back unchanged, so RTT is computed here
|
|
# without needing to correlate against any pending-command bookkeeping.
|
|
if payload.get("type") == "pong":
|
|
ts = (payload.get("data") or {}).get("ts")
|
|
if isinstance(ts, (int, float)):
|
|
rtt_ms = max(0, int(time.time() * 1000) - int(ts))
|
|
await db.insert_ping_sample(device_serial=serial, rtt_ms=rtt_ms)
|
|
return
|
|
|
|
pending = await db.get_pending_command(serial)
|
|
if pending:
|
|
cmd_status = "success" if status == "SUCCESS" else "error"
|
|
await db.update_command_response(
|
|
command_id=pending["id"],
|
|
status=cmd_status,
|
|
response_payload=payload,
|
|
)
|
|
else:
|
|
logger.debug(f"Received control/ack for {serial} with no pending command")
|