mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-01 08:48:05 +00:00
* feat(plugin-system): activate dormant plugin health & metrics subsystem
PluginManager shipped a fully-built health tracker, resource monitor and
circuit breaker that were never instantiated (health_tracker/resource_monitor
were left as None), so the circuit breaker never engaged and the existing
health/metrics API routes always returned "not available".
- DisplayController now wires a PluginHealthTracker and PluginResourceMonitor
onto the plugin manager, enabling the circuit breaker (a repeatedly-failing
plugin's update() is skipped after consecutive failures, then retried after
a cooldown) and per-plugin execution-time metrics. Both persist to the
shared cache.
- load_plugin() now validates each plugin's config against its JSON schema in
a strictly warn/degrade-only way: a violation logs a warning and flags the
plugin degraded in the health tracker, but never changes whether the plugin
loads or its pass/fail behaviour. Adds PluginHealthTracker.set_degraded(),
which never touches the circuit breaker.
- ResourceMonitor CPU/memory sampling now reuses a cached psutil.Process and
reads cpu_percent(interval=None), so monitoring no longer blocks ~100ms per
call on the display loop's update path.
- Fix DiskCache.get() raising TypeError for max_age=None ("never expires"),
which silently discarded persisted plugin health/metrics on read and thus
broke cross-process and post-restart surfacing.
- Fix two dead PluginManager helpers that called non-existent tracker methods.
Tests: new test_resource_monitor, test_plugin_health,
test_plugin_manager_schema_soft; extended test_cache_manager and
test_display_controller.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UvTav268UXv44ub9K11LYq
* feat(web-ui): surface plugin health, metrics and load state
With the health/metrics subsystem now active in the display service, expose it
in the web UI (which runs as a separate process from the display loop):
- Wire a health tracker / resource monitor backed by the shared on-disk cache
into the web process so /api/v3/plugins/health and /plugins/metrics read the
data the display service persists.
- Build those route responses per installed plugin id (the tracker's in-memory
view is empty in a fresh web process) so cross-process data is included.
- Add state + error_info to /plugins/installed entries so the UI can show why a
plugin isn't running instead of just loaded:false.
- Add a "Plugin Health" panel to the Tools page (circuit status, avg/max update
time, update count, last error) plus PluginAPI.getPluginMetrics().
Tests: route-level tests for the health/metrics endpoints in test_web_api.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UvTav268UXv44ub9K11LYq
* fix(plugin-metrics): refresh cross-process health/metrics reads; type hints
Addresses CodeRabbit review on #388:
- Major: the web process's health/resource trackers cached the first persisted
read in an in-memory dict (and the CacheManager memory tier held max_age=None
entries indefinitely), so a long-lived web process showed the first snapshot
and never reflected the display service's later updates. Add an opt-in
force_reload path (get_health_summary/get_health_state/_load_health_state and
get_metrics_summary/get_metrics) that bypasses the in-memory copy and, via a
new memory_ttl passthrough on CacheManager.get, the cache manager's memory
tier — so each /plugins/health and /plugins/metrics poll reads fresh persisted
state. Default behaviour (force_reload=False) is unchanged for the display
process and existing callers.
- Minor: DiskCache.get type hint is now Optional[int] with the None ("never
expires") semantics documented, matching MemoryCache.get.
Tests: new force_reload staleness cases in test_plugin_health and
test_resource_monitor.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UvTav268UXv44ub9K11LYq
---------
Co-authored-by: Claude <noreply@anthropic.com>
80 lines
2.6 KiB
Python
80 lines
2.6 KiB
Python
"""
|
|
Tests for PluginManager._validate_config_schema_soft (Phase 1, warn-only schema
|
|
validation).
|
|
|
|
Contract:
|
|
- A schema violation logs a warning and marks the plugin degraded in the health
|
|
tracker, but never raises and never changes load pass/fail behaviour.
|
|
- A valid config (or no schema) clears any stale degraded flag.
|
|
- The method is safe when no health tracker is wired.
|
|
"""
|
|
|
|
import tempfile
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock
|
|
|
|
import pytest
|
|
|
|
from src.plugin_system.plugin_manager import PluginManager
|
|
|
|
|
|
@pytest.fixture
|
|
def pm():
|
|
with tempfile.TemporaryDirectory() as tmp:
|
|
manager = PluginManager(plugins_dir=str(Path(tmp) / "plugins"))
|
|
manager.schema_manager = MagicMock()
|
|
yield manager
|
|
|
|
|
|
def test_invalid_config_marks_degraded_without_raising(pm):
|
|
pm.health_tracker = MagicMock()
|
|
pm.schema_manager.load_schema.return_value = {"type": "object"}
|
|
pm.schema_manager.validate_config_against_schema.return_value = (
|
|
False,
|
|
["Missing required field: 'api_key'"],
|
|
)
|
|
|
|
pm._validate_config_schema_soft("youtube-stats", {})
|
|
|
|
pm.health_tracker.set_degraded.assert_called_once()
|
|
plugin_id, reason = pm.health_tracker.set_degraded.call_args[0]
|
|
assert plugin_id == "youtube-stats"
|
|
assert "api_key" in reason
|
|
|
|
|
|
def test_valid_config_clears_degraded(pm):
|
|
pm.health_tracker = MagicMock()
|
|
pm.schema_manager.load_schema.return_value = {"type": "object"}
|
|
pm.schema_manager.validate_config_against_schema.return_value = (True, [])
|
|
|
|
pm._validate_config_schema_soft("p", {"api_key": "x"})
|
|
|
|
pm.health_tracker.set_degraded.assert_called_once_with("p", None)
|
|
|
|
|
|
def test_no_schema_clears_degraded(pm):
|
|
pm.health_tracker = MagicMock()
|
|
pm.schema_manager.load_schema.return_value = None
|
|
|
|
pm._validate_config_schema_soft("p", {})
|
|
|
|
pm.health_tracker.set_degraded.assert_called_once_with("p", None)
|
|
|
|
|
|
def test_validation_exception_is_swallowed(pm):
|
|
pm.health_tracker = MagicMock()
|
|
pm.schema_manager.load_schema.return_value = {"type": "object"}
|
|
pm.schema_manager.validate_config_against_schema.side_effect = RuntimeError("boom")
|
|
|
|
# Must not raise — the validation machinery failing must never break loading.
|
|
pm._validate_config_schema_soft("p", {})
|
|
|
|
|
|
def test_safe_without_health_tracker(pm):
|
|
pm.health_tracker = None
|
|
pm.schema_manager.load_schema.return_value = {"type": "object"}
|
|
pm.schema_manager.validate_config_against_schema.return_value = (False, ["err"])
|
|
|
|
# Must not raise even though there is no tracker to record against.
|
|
pm._validate_config_schema_soft("p", {})
|