mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-05 06:45:09 +00:00
* refactor(plugins): remove the no-op PluginHealthMonitor Its monitor loop did nothing (`if callbacks: pass`), register_health_check had no callers and api_v3.health_monitor was never read by any route. The live health data comes from PluginHealthTracker, which is untouched. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(store): drop the never-set uninstall tombstones Nothing in production called mark_recently_uninstalled, so the reconciler's was_recently_uninstalled check was always False. The persistent uninstall registry is what actually stops resurrection; the reconciler test now exercises that gate instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(common): delete unused config/display/game helpers, utils and error_handler Nothing in core, the web UI, scripts or the plugin monorepo imports config_helper, display_helper, game_helper, utils or error_handler; only their own tests did. The error_handler re-exports leave src.common's __all__; APIHelper, TextHelper, ScrollHelper, LogoHelper and the adaptive layout exports are unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(config): drop ConfigService's unused versioning and save API ConfigVersion, get_version/get_version_history/get_version_config, rollback, save_config, reload, get_plugin_config and the backward-compat load_config/get_config_path/get_secrets_path had no callers. The display controller only uses get_config, subscribe, unsubscribe and shutdown, plus the file watcher. Change detection now compares against the current checksum instead of the last history entry. The subscriber tests asserted `callback.called or True`; they now reload the way the watcher does and assert the notification. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(plugins): drop unread plugin state history and callbacks plugin_state.PluginStateManager kept a bounded per-plugin transition history that only get_state_history (tests only) read; get_state_info reports a separate lifetime count, which stays. set_error_info and record_display had no callers, and set_state_with_error's `error` argument only fed the history. The web-side state_manager.PluginStateManager loses subscribe_to_state_changes, _notify_callbacks, set_plugin_error and get_state_version, none of which had callers; with no subscribers the old-state copy in update_plugin_state went with them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(plugins): remove unused PluginManager methods and attribute guards update_all_plugins was only called by a test (the display loop uses run_scheduled_updates); get_plugin_health_metrics, get_plugin_resource_metrics and get_plugin_state had no callers; and plugin_modules was written but never read. plugin_directories is now initialised in __init__, so the hasattr() guards around it go. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(plugins): remove unused executor, loader, store and package helpers - PluginExecutor.execute_safe: no callers. - PluginLoader._parse_semver: only its own tests; compatibility.parse_semver is the live copy and test_compatibility.py already covers it. - PluginStoreManager.get_installed_plugin_info: no callers. - PluginResourceMonitor._local: never read. - src.plugin_system.get_store_manager and __api_version__: no importers in core, scripts or the plugin monorepo. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(wifi): stop storing Wi-Fi passwords in wifi_config.json WiFiManager appended every joined network's SSID and password, in plaintext, to saved_networks in config/wifi_config.json, and nothing (web UI, backup restore, scripts) ever read them back: NetworkManager keeps its own credentials. The writes are gone, and loading the config now drops any saved_networks key and rewrites the file, so passwords already on disk are scrubbed. Also removes _check_dnsmasq_conflict (never called) and _detect_trixie, whose result only reached one log line, along with the NM_CONNECTIONS_PATHS constant only it used. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(display): remove unreachable and unused DisplayController code - _follower_rebuild_scroll_image: never called. - mode_duration (never read) and last_mode_change (write-only). - The `chosen_cap <= 0` branch: chosen_cap is either the minimum of caps already filtered to > 0 or DEFAULT_DYNAMIC_DURATION_CAP (180). - The `max_duration < min_duration` branch directly after `max_duration = max(min_duration, max_duration)`. - The circuit-breaker branch's `display_result = False` and `manager_to_display = None`: the first is overwritten a few lines later, the second is already None there. - The bool-to-bool conversion of execute_display's result, which is always a bool. - The `loaded_plugins` lookup in _update_modules: PluginManager has no such attribute, so it always fell through to `plugins`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(vegas): remove unused config update, boundary finder and refresh VegasModeConfig.update had no callers outside its own tests (the coordinator rebuilds the config with from_config on a change); geometry.find_item_boundary and StreamManager._refresh_plugin_content had no callers at all. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * refactor(run): drop the debug block that pretended to import the plugin system In debug mode run.py put src/plugin_system itself on sys.path and printed "Plugin system import successful" without importing anything. Nothing imports plugin_system modules by bare name, so the path entry did nothing either. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test: delete tests that test nothing - test/plugins/test_{basketball_scoreboard,calendar,clock_simple, odds_ticker,soccer_scoreboard,text_display}.py skip everywhere the named plugins are not installed, including CI (LEDMATRIX_PLUGINS_DIR holds only the fixture plugin); test_plugin_matrix.py already covers every discovered plugin. Their PluginTestBase and the fixtures only it used (plugins_dir, mock_display_manager, mock_cache_manager, mock_plugin_manager, base_plugin_config in test/plugins/conftest.py) go with them. - test_plugin_system.py: test_discover_plugins (body was `pass`) and test_dependency_check (a comment), plus the test_plugin_manager fixture only the former requested. - test_display_manager.py: test_draw_image asserted that an image it had just assigned was not None. - test_display_controller.py: the rotation and schedule-override tests re-implemented the run-loop arithmetic inline and asserted on their own result without calling the controller. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test: expect one plugin_last_update success stamp after update_all_plugins EveryStampRecordsACompletion required at least two success-path stamps; the second was update_all_plugins, removed as test-only. The worker and synchronous paths share the remaining stamp in _execute_update_now, and the check that every stamp calls _note_update_completed is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
337 lines
10 KiB
Python
337 lines
10 KiB
Python
"""
|
|
Centralized plugin state management.
|
|
|
|
Provides a single source of truth for plugin state (installed, enabled, version, etc.)
|
|
with persistence.
|
|
"""
|
|
|
|
import json
|
|
import threading
|
|
from typing import Dict, Any, Optional
|
|
from pathlib import Path
|
|
from datetime import datetime
|
|
from dataclasses import dataclass, asdict
|
|
from enum import Enum
|
|
|
|
from src.logging_config import get_logger
|
|
|
|
|
|
class PluginStateStatus(Enum):
|
|
"""Status of a plugin."""
|
|
INSTALLED = "installed"
|
|
ENABLED = "enabled"
|
|
DISABLED = "disabled"
|
|
ERROR = "error"
|
|
UNKNOWN = "unknown"
|
|
|
|
|
|
@dataclass
|
|
class PluginState:
|
|
"""Represents the state of a plugin."""
|
|
plugin_id: str
|
|
status: PluginStateStatus
|
|
enabled: bool
|
|
version: Optional[str] = None
|
|
installed_at: Optional[datetime] = None
|
|
last_updated: Optional[datetime] = None
|
|
config_version: int = 1 # For detecting state corruption
|
|
metadata: Dict[str, Any] = None
|
|
|
|
def __post_init__(self):
|
|
if self.metadata is None:
|
|
self.metadata = {}
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
"""Convert state to dictionary for serialization."""
|
|
result = asdict(self)
|
|
# Convert enum to string
|
|
result['status'] = self.status.value
|
|
# Convert datetime to ISO string
|
|
if result.get('installed_at'):
|
|
result['installed_at'] = self.installed_at.isoformat()
|
|
if result.get('last_updated'):
|
|
result['last_updated'] = self.last_updated.isoformat()
|
|
return result
|
|
|
|
@classmethod
|
|
def from_dict(cls, data: Dict[str, Any]) -> 'PluginState':
|
|
"""Create state from dictionary."""
|
|
# Parse enum
|
|
if isinstance(data.get('status'), str):
|
|
data['status'] = PluginStateStatus(data['status'])
|
|
|
|
# Parse datetime
|
|
if data.get('installed_at') and isinstance(data['installed_at'], str):
|
|
data['installed_at'] = datetime.fromisoformat(data['installed_at'])
|
|
if data.get('last_updated') and isinstance(data['last_updated'], str):
|
|
data['last_updated'] = datetime.fromisoformat(data['last_updated'])
|
|
|
|
return cls(**data)
|
|
|
|
|
|
class PluginStateManager:
|
|
"""
|
|
Centralized plugin state manager.
|
|
|
|
Provides:
|
|
- Single source of truth for plugin state
|
|
- State persistence
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
state_file: Optional[str] = None,
|
|
auto_save: bool = True,
|
|
lazy_load: bool = False
|
|
):
|
|
"""
|
|
Initialize state manager.
|
|
|
|
Args:
|
|
state_file: Path to file for persisting state
|
|
auto_save: Whether to automatically save state on changes
|
|
lazy_load: If True, defer loading state file until first access
|
|
"""
|
|
self.logger = get_logger(__name__)
|
|
self.state_file = Path(state_file) if state_file else None
|
|
self.auto_save = auto_save
|
|
self._lazy_load = lazy_load
|
|
self._state_loaded = False
|
|
|
|
# State storage
|
|
self._states: Dict[str, PluginState] = {}
|
|
self._state_version = 1
|
|
|
|
# Threading
|
|
self._lock = threading.RLock()
|
|
|
|
# Load state from file if it exists (unless lazy loading)
|
|
if not self._lazy_load and self.state_file and self.state_file.exists():
|
|
self._load_state()
|
|
self._state_loaded = True
|
|
|
|
def _ensure_loaded(self) -> None:
|
|
"""Ensure state is loaded (for lazy loading)."""
|
|
if not self._state_loaded and self.state_file and self.state_file.exists():
|
|
self._load_state()
|
|
self._state_loaded = True
|
|
|
|
def get_plugin_state(self, plugin_id: str) -> Optional[PluginState]:
|
|
"""
|
|
Get state for a plugin.
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier
|
|
|
|
Returns:
|
|
PluginState if found, None otherwise
|
|
"""
|
|
self._ensure_loaded()
|
|
with self._lock:
|
|
return self._states.get(plugin_id)
|
|
|
|
def get_all_states(self) -> Dict[str, PluginState]:
|
|
"""
|
|
Get all plugin states.
|
|
|
|
Returns:
|
|
Dictionary mapping plugin_id to PluginState
|
|
"""
|
|
self._ensure_loaded()
|
|
with self._lock:
|
|
return self._states.copy()
|
|
|
|
def update_plugin_state(
|
|
self,
|
|
plugin_id: str,
|
|
updates: Dict[str, Any]
|
|
) -> bool:
|
|
"""
|
|
Update plugin state.
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier
|
|
updates: Dictionary of state updates
|
|
|
|
Returns:
|
|
True if update successful
|
|
"""
|
|
self._ensure_loaded()
|
|
with self._lock:
|
|
# Get current state or create new
|
|
current_state = self._states.get(plugin_id)
|
|
if not current_state:
|
|
current_state = PluginState(
|
|
plugin_id=plugin_id,
|
|
status=PluginStateStatus.UNKNOWN,
|
|
enabled=False
|
|
)
|
|
|
|
# Apply updates
|
|
if 'status' in updates:
|
|
if isinstance(updates['status'], str):
|
|
current_state.status = PluginStateStatus(updates['status'])
|
|
else:
|
|
current_state.status = updates['status']
|
|
|
|
if 'enabled' in updates:
|
|
current_state.enabled = bool(updates['enabled'])
|
|
|
|
if 'version' in updates:
|
|
current_state.version = updates['version']
|
|
|
|
if 'installed_at' in updates:
|
|
current_state.installed_at = updates['installed_at']
|
|
|
|
if 'last_updated' in updates:
|
|
current_state.last_updated = updates['last_updated']
|
|
else:
|
|
current_state.last_updated = datetime.now()
|
|
|
|
if 'metadata' in updates:
|
|
if current_state.metadata is None:
|
|
current_state.metadata = {}
|
|
current_state.metadata.update(updates['metadata'])
|
|
|
|
# Increment config version
|
|
current_state.config_version += 1
|
|
|
|
# Store updated state
|
|
self._states[plugin_id] = current_state
|
|
|
|
# Auto-save if enabled
|
|
if self.auto_save:
|
|
self._save_state()
|
|
|
|
return True
|
|
|
|
def set_plugin_enabled(self, plugin_id: str, enabled: bool) -> bool:
|
|
"""
|
|
Set plugin enabled/disabled state.
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier
|
|
enabled: Whether plugin is enabled
|
|
|
|
Returns:
|
|
True if update successful
|
|
"""
|
|
status = PluginStateStatus.ENABLED if enabled else PluginStateStatus.DISABLED
|
|
return self.update_plugin_state(
|
|
plugin_id,
|
|
{
|
|
'enabled': enabled,
|
|
'status': status
|
|
}
|
|
)
|
|
|
|
def set_plugin_installed(
|
|
self,
|
|
plugin_id: str,
|
|
version: Optional[str] = None,
|
|
installed_at: Optional[datetime] = None
|
|
) -> bool:
|
|
"""
|
|
Mark plugin as installed.
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier
|
|
version: Plugin version
|
|
installed_at: Installation timestamp
|
|
|
|
Returns:
|
|
True if update successful
|
|
"""
|
|
return self.update_plugin_state(
|
|
plugin_id,
|
|
{
|
|
'status': PluginStateStatus.INSTALLED,
|
|
'version': version,
|
|
'installed_at': installed_at or datetime.now()
|
|
}
|
|
)
|
|
|
|
def remove_plugin_state(self, plugin_id: str) -> bool:
|
|
"""
|
|
Remove plugin state (e.g., after uninstall).
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier
|
|
|
|
Returns:
|
|
True if removal successful
|
|
"""
|
|
self._ensure_loaded()
|
|
with self._lock:
|
|
if plugin_id in self._states:
|
|
del self._states[plugin_id]
|
|
|
|
# Auto-save if enabled
|
|
if self.auto_save:
|
|
self._save_state()
|
|
|
|
return True
|
|
|
|
return False
|
|
|
|
def _save_state(self) -> None:
|
|
"""Save state to file."""
|
|
if not self.state_file:
|
|
return
|
|
|
|
try:
|
|
with self._lock:
|
|
# Convert states to dicts
|
|
states_data = {
|
|
plugin_id: state.to_dict()
|
|
for plugin_id, state in self._states.items()
|
|
}
|
|
|
|
state_data = {
|
|
'version': self._state_version,
|
|
'states': states_data,
|
|
'last_updated': datetime.now().isoformat()
|
|
}
|
|
|
|
# Ensure directory exists with proper permissions
|
|
from src.common.permission_utils import (
|
|
ensure_directory_permissions,
|
|
get_config_dir_mode
|
|
)
|
|
ensure_directory_permissions(self.state_file.parent, get_config_dir_mode())
|
|
|
|
# Write to file
|
|
with open(self.state_file, 'w') as f:
|
|
json.dump(state_data, f, indent=2)
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error saving plugin state: {e}", exc_info=True)
|
|
|
|
def _load_state(self) -> None:
|
|
"""Load state from file."""
|
|
if not self.state_file or not self.state_file.exists():
|
|
return
|
|
|
|
try:
|
|
with open(self.state_file, 'r') as f:
|
|
state_data = json.load(f)
|
|
|
|
with self._lock:
|
|
# Load state version
|
|
self._state_version = state_data.get('version', 1)
|
|
|
|
# Load states
|
|
states_data = state_data.get('states', {})
|
|
for plugin_id, state_dict in states_data.items():
|
|
try:
|
|
self._states[plugin_id] = PluginState.from_dict(state_dict)
|
|
except Exception as e:
|
|
self.logger.warning(
|
|
f"Error loading state for plugin {plugin_id}: {e}"
|
|
)
|
|
|
|
self.logger.info(f"Loaded {len(self._states)} plugin states from file")
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error loading plugin state: {e}", exc_info=True)
|