b99450db2f
Mirror the Proxmox auto-sync pattern for the Zigbee2MQTT and Z-Wave JS UI mesh imports. Connection config + MQTT credentials live in .env only, are never persisted to scan_config.json, and are never returned by any API or shown in the UI (single source of truth). - config: ZIGBEE_* / ZWAVE_* env settings; only sync_enabled+interval are persisted, connection/credentials stay env-only - routes: GET/POST /config, POST /sync-now; auto-sync reuses the exact manual _background_*_import + _persist_pending_import path (fresh import when empty, update-in-place when nodes exist, ScanRun trace) - scheduler: zigbee_sync / zwave_sync jobs with live enable + reschedule - frontend: reusable MeshAutoSync section in Settings (Zigbee, Z-Wave) - .env.example: documented both blocks - tests: scheduler jobs, router config/sync-now/auth, credential-never- persisted, SettingsModal sections Manual Zigbee/Z-Wave import behaviour is unchanged. ha-relevant: no
381 lines
13 KiB
Python
381 lines
13 KiB
Python
"""APScheduler setup for background scan and status check jobs."""
|
|
import asyncio
|
|
import logging
|
|
from datetime import datetime, timezone
|
|
|
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
|
from sqlalchemy import select
|
|
|
|
from app.core.config import settings
|
|
from app.db.database import AsyncSessionLocal
|
|
from app.db.models import Node
|
|
from app.services.status_checker import check_node, check_services
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
scheduler: AsyncIOScheduler = AsyncIOScheduler()
|
|
|
|
|
|
async def _check_single_node(
|
|
node_id: str,
|
|
check_method: str,
|
|
check_target: str | None,
|
|
ip: str | None,
|
|
) -> tuple[str, dict[str, object] | None]:
|
|
"""Run a single node check; returns (node_id, result_or_None).
|
|
|
|
Accepts plain scalars — not an ORM object — so there is no risk of
|
|
DetachedInstanceError when the originating session has already closed.
|
|
"""
|
|
from app.api.routes.status import broadcast_status # avoid circular import
|
|
|
|
try:
|
|
check_result = await check_node(check_method, check_target, ip)
|
|
now = datetime.now(timezone.utc)
|
|
async with AsyncSessionLocal() as db:
|
|
n = await db.get(Node, node_id)
|
|
if n:
|
|
n.status = check_result["status"]
|
|
n.response_time_ms = check_result["response_time_ms"]
|
|
if check_result["status"] == "online":
|
|
n.last_seen = now
|
|
await db.commit()
|
|
await broadcast_status(
|
|
node_id=node_id,
|
|
status=check_result["status"],
|
|
checked_at=now.isoformat(),
|
|
response_time_ms=check_result["response_time_ms"],
|
|
)
|
|
return node_id, check_result
|
|
except Exception as exc:
|
|
logger.error("Status check failed for node %s: %s", node_id, exc)
|
|
return node_id, None
|
|
|
|
|
|
async def _run_status_checks() -> None:
|
|
"""Check all nodes concurrently and broadcast results via WebSocket."""
|
|
async with AsyncSessionLocal() as db:
|
|
result = await db.execute(select(Node))
|
|
nodes = result.scalars().all()
|
|
# Extract scalars while the session is open to avoid DetachedInstanceError
|
|
checkable = [
|
|
(n.id, n.check_method, n.check_target, n.ip)
|
|
for n in nodes
|
|
if n.check_method
|
|
]
|
|
|
|
if not checkable:
|
|
return
|
|
|
|
await asyncio.gather(*[
|
|
_check_single_node(node_id, method, target, ip)
|
|
for node_id, method, target, ip in checkable
|
|
])
|
|
|
|
|
|
def _node_host(ip: str | None, hostname: str | None) -> str | None:
|
|
"""Pick the address to probe services on: first IP, else hostname."""
|
|
if ip:
|
|
first = ip.split(",")[0].strip()
|
|
if first:
|
|
return first
|
|
return hostname or None
|
|
|
|
|
|
async def _run_service_checks() -> None:
|
|
"""Check every service of every node and broadcast per-service results."""
|
|
if not settings.service_check_enabled:
|
|
return
|
|
from app.api.routes.status import broadcast_service_status # avoid circular import
|
|
|
|
async with AsyncSessionLocal() as db:
|
|
result = await db.execute(select(Node))
|
|
nodes = result.scalars().all()
|
|
checkable = [
|
|
(n.id, _node_host(n.ip, n.hostname), list(n.services or []))
|
|
for n in nodes
|
|
if n.services
|
|
]
|
|
|
|
now = datetime.now(timezone.utc).isoformat()
|
|
for node_id, host, services in checkable:
|
|
try:
|
|
statuses = await check_services(host, services)
|
|
await broadcast_service_status(node_id=node_id, services=statuses, checked_at=now)
|
|
except Exception as exc:
|
|
logger.error("Service checks failed for node %s: %s", node_id, exc)
|
|
|
|
|
|
async def _run_proxmox_sync() -> None:
|
|
"""Fetch the Proxmox inventory and upsert it into pending (auto-sync).
|
|
|
|
Records a ScanRun (kind=proxmox) so the scheduled sync shows in Scan
|
|
history, exactly like the manual /sync-now and /import-pending paths.
|
|
"""
|
|
if not settings.proxmox_sync_enabled:
|
|
return
|
|
if not (settings.proxmox_host and settings.proxmox_token_id and settings.proxmox_token_secret):
|
|
logger.warning("Proxmox auto-sync enabled but host/token not configured — skipping")
|
|
return
|
|
# Lazy import to avoid a circular import at module load.
|
|
from app.api.routes.proxmox import _background_proxmox_import
|
|
from app.db.models import ScanRun
|
|
|
|
async with AsyncSessionLocal() as db:
|
|
run = ScanRun(
|
|
status="running",
|
|
kind="proxmox",
|
|
ranges=[f"{settings.proxmox_host}:{settings.proxmox_port}"],
|
|
)
|
|
db.add(run)
|
|
await db.commit()
|
|
await db.refresh(run)
|
|
run_id = run.id
|
|
|
|
# Shares the manual-sync flow: fetch + persist + mark the run done/error +
|
|
# broadcast the inventory-reload signal.
|
|
await _background_proxmox_import(
|
|
run_id,
|
|
settings.proxmox_host,
|
|
settings.proxmox_port,
|
|
settings.proxmox_token_id,
|
|
settings.proxmox_token_secret,
|
|
settings.proxmox_verify_tls,
|
|
)
|
|
|
|
|
|
async def _run_mesh_sync(kind: str) -> None:
|
|
"""Shared auto-sync for the MQTT mesh imports (Zigbee / Z-Wave).
|
|
|
|
Records a ScanRun (kind=zigbee|zwave) so the scheduled sync shows in Scan
|
|
history, then delegates to the exact same background import the manual
|
|
/sync-now and /import-pending paths use. Connection config comes from the
|
|
server env only (credentials never leave it).
|
|
"""
|
|
from app.db.models import ScanRun
|
|
|
|
if kind == "zigbee":
|
|
if not settings.zigbee_sync_enabled:
|
|
return
|
|
if not settings.zigbee_mqtt_host:
|
|
logger.warning("Zigbee auto-sync enabled but MQTT host not configured — skipping")
|
|
return
|
|
from app.api.routes.zigbee import _background_zigbee_import, env_import_request
|
|
host, port = settings.zigbee_mqtt_host, settings.zigbee_mqtt_port
|
|
background = _background_zigbee_import
|
|
else:
|
|
if not settings.zwave_sync_enabled:
|
|
return
|
|
if not settings.zwave_mqtt_host:
|
|
logger.warning("Z-Wave auto-sync enabled but MQTT host not configured — skipping")
|
|
return
|
|
from app.api.routes.zwave import _background_zwave_import, env_import_request
|
|
host, port = settings.zwave_mqtt_host, settings.zwave_mqtt_port
|
|
background = _background_zwave_import
|
|
|
|
payload = env_import_request()
|
|
async with AsyncSessionLocal() as db:
|
|
run = ScanRun(status="running", kind=kind, ranges=[f"{host}:{port}"])
|
|
db.add(run)
|
|
await db.commit()
|
|
await db.refresh(run)
|
|
run_id = run.id
|
|
|
|
await background(run_id, payload)
|
|
|
|
|
|
async def _run_zigbee_sync() -> None:
|
|
await _run_mesh_sync("zigbee")
|
|
|
|
|
|
async def _run_zwave_sync() -> None:
|
|
await _run_mesh_sync("zwave")
|
|
|
|
|
|
def _add_service_check_job() -> None:
|
|
scheduler.add_job(
|
|
_run_service_checks,
|
|
"interval",
|
|
seconds=settings.service_check_interval,
|
|
id="service_checks",
|
|
max_instances=1,
|
|
coalesce=True,
|
|
)
|
|
|
|
|
|
def _add_proxmox_sync_job() -> None:
|
|
scheduler.add_job(
|
|
_run_proxmox_sync,
|
|
"interval",
|
|
seconds=settings.proxmox_sync_interval,
|
|
id="proxmox_sync",
|
|
max_instances=1,
|
|
coalesce=True,
|
|
)
|
|
|
|
|
|
def _add_zigbee_sync_job() -> None:
|
|
scheduler.add_job(
|
|
_run_zigbee_sync,
|
|
"interval",
|
|
seconds=settings.zigbee_sync_interval,
|
|
id="zigbee_sync",
|
|
max_instances=1,
|
|
coalesce=True,
|
|
)
|
|
|
|
|
|
def _add_zwave_sync_job() -> None:
|
|
scheduler.add_job(
|
|
_run_zwave_sync,
|
|
"interval",
|
|
seconds=settings.zwave_sync_interval,
|
|
id="zwave_sync",
|
|
max_instances=1,
|
|
coalesce=True,
|
|
)
|
|
|
|
|
|
def start_scheduler() -> None:
|
|
global scheduler
|
|
if scheduler.running:
|
|
try:
|
|
scheduler.shutdown(wait=False)
|
|
except Exception as exc:
|
|
logger.warning("Failed to shut down previous scheduler instance: %s", exc)
|
|
scheduler = AsyncIOScheduler()
|
|
scheduler.add_job(
|
|
_run_status_checks,
|
|
"interval",
|
|
seconds=settings.status_checker_interval,
|
|
id="status_checks",
|
|
max_instances=1,
|
|
coalesce=True,
|
|
)
|
|
if settings.service_check_enabled:
|
|
_add_service_check_job()
|
|
if settings.proxmox_sync_enabled:
|
|
_add_proxmox_sync_job()
|
|
if settings.zigbee_sync_enabled:
|
|
_add_zigbee_sync_job()
|
|
if settings.zwave_sync_enabled:
|
|
_add_zwave_sync_job()
|
|
scheduler.start()
|
|
logger.info("Scheduler started — status checks every %ds", settings.status_checker_interval)
|
|
|
|
|
|
def reschedule_status_checks(interval_seconds: int) -> None:
|
|
"""Update the status check interval on the running scheduler."""
|
|
if interval_seconds < 10:
|
|
raise ValueError(f"interval_seconds must be >= 10, got {interval_seconds}")
|
|
if not scheduler.running:
|
|
logger.warning("Scheduler not running, skipping reschedule")
|
|
return
|
|
scheduler.reschedule_job("status_checks", trigger="interval", seconds=interval_seconds)
|
|
logger.info("Status checks rescheduled to every %ds", interval_seconds)
|
|
|
|
|
|
def reschedule_service_checks(interval_seconds: int) -> None:
|
|
"""Update the service-check interval on the running scheduler (if enabled)."""
|
|
if interval_seconds < 30:
|
|
raise ValueError(f"interval_seconds must be >= 30, got {interval_seconds}")
|
|
if not scheduler.running:
|
|
logger.warning("Scheduler not running, skipping reschedule")
|
|
return
|
|
if scheduler.get_job("service_checks"):
|
|
scheduler.reschedule_job("service_checks", trigger="interval", seconds=interval_seconds)
|
|
logger.info("Service checks rescheduled to every %ds", interval_seconds)
|
|
|
|
|
|
def set_service_checks_enabled(enabled: bool) -> None:
|
|
"""Add or remove the service-check job on the running scheduler."""
|
|
if not scheduler.running:
|
|
return
|
|
job = scheduler.get_job("service_checks")
|
|
if enabled and not job:
|
|
_add_service_check_job()
|
|
logger.info("Service checks enabled — every %ds", settings.service_check_interval)
|
|
elif not enabled and job:
|
|
scheduler.remove_job("service_checks")
|
|
logger.info("Service checks disabled")
|
|
|
|
|
|
def reschedule_proxmox_sync(interval_seconds: int) -> None:
|
|
"""Update the Proxmox auto-sync interval on the running scheduler (if enabled)."""
|
|
if interval_seconds < 300:
|
|
raise ValueError(f"interval_seconds must be >= 300, got {interval_seconds}")
|
|
if not scheduler.running:
|
|
logger.warning("Scheduler not running, skipping reschedule")
|
|
return
|
|
if scheduler.get_job("proxmox_sync"):
|
|
scheduler.reschedule_job("proxmox_sync", trigger="interval", seconds=interval_seconds)
|
|
logger.info("Proxmox auto-sync rescheduled to every %ds", interval_seconds)
|
|
|
|
|
|
def set_proxmox_sync_enabled(enabled: bool) -> None:
|
|
"""Add or remove the Proxmox auto-sync job on the running scheduler."""
|
|
if not scheduler.running:
|
|
return
|
|
job = scheduler.get_job("proxmox_sync")
|
|
if enabled and not job:
|
|
_add_proxmox_sync_job()
|
|
logger.info("Proxmox auto-sync enabled — every %ds", settings.proxmox_sync_interval)
|
|
elif not enabled and job:
|
|
scheduler.remove_job("proxmox_sync")
|
|
logger.info("Proxmox auto-sync disabled")
|
|
|
|
|
|
def reschedule_zigbee_sync(interval_seconds: int) -> None:
|
|
"""Update the Zigbee auto-sync interval on the running scheduler (if enabled)."""
|
|
if interval_seconds < 300:
|
|
raise ValueError(f"interval_seconds must be >= 300, got {interval_seconds}")
|
|
if not scheduler.running:
|
|
logger.warning("Scheduler not running, skipping reschedule")
|
|
return
|
|
if scheduler.get_job("zigbee_sync"):
|
|
scheduler.reschedule_job("zigbee_sync", trigger="interval", seconds=interval_seconds)
|
|
logger.info("Zigbee auto-sync rescheduled to every %ds", interval_seconds)
|
|
|
|
|
|
def set_zigbee_sync_enabled(enabled: bool) -> None:
|
|
"""Add or remove the Zigbee auto-sync job on the running scheduler."""
|
|
if not scheduler.running:
|
|
return
|
|
job = scheduler.get_job("zigbee_sync")
|
|
if enabled and not job:
|
|
_add_zigbee_sync_job()
|
|
logger.info("Zigbee auto-sync enabled — every %ds", settings.zigbee_sync_interval)
|
|
elif not enabled and job:
|
|
scheduler.remove_job("zigbee_sync")
|
|
logger.info("Zigbee auto-sync disabled")
|
|
|
|
|
|
def reschedule_zwave_sync(interval_seconds: int) -> None:
|
|
"""Update the Z-Wave auto-sync interval on the running scheduler (if enabled)."""
|
|
if interval_seconds < 300:
|
|
raise ValueError(f"interval_seconds must be >= 300, got {interval_seconds}")
|
|
if not scheduler.running:
|
|
logger.warning("Scheduler not running, skipping reschedule")
|
|
return
|
|
if scheduler.get_job("zwave_sync"):
|
|
scheduler.reschedule_job("zwave_sync", trigger="interval", seconds=interval_seconds)
|
|
logger.info("Z-Wave auto-sync rescheduled to every %ds", interval_seconds)
|
|
|
|
|
|
def set_zwave_sync_enabled(enabled: bool) -> None:
|
|
"""Add or remove the Z-Wave auto-sync job on the running scheduler."""
|
|
if not scheduler.running:
|
|
return
|
|
job = scheduler.get_job("zwave_sync")
|
|
if enabled and not job:
|
|
_add_zwave_sync_job()
|
|
logger.info("Z-Wave auto-sync enabled — every %ds", settings.zwave_sync_interval)
|
|
elif not enabled and job:
|
|
scheduler.remove_job("zwave_sync")
|
|
logger.info("Z-Wave auto-sync disabled")
|
|
|
|
|
|
def stop_scheduler() -> None:
|
|
if scheduler.running:
|
|
scheduler.shutdown(wait=False)
|