mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-21 02:19:07 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
29f1c68bea |
Executable → Regular
Executable → Regular
Executable → Regular
@@ -9,7 +9,7 @@ import time
|
|||||||
import logging
|
import logging
|
||||||
import threading
|
import threading
|
||||||
from typing import Dict, Optional, Any, Callable
|
from typing import Dict, Optional, Any, Callable
|
||||||
from dataclasses import dataclass, field
|
from dataclasses import dataclass, field, fields
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import psutil
|
import psutil
|
||||||
@@ -102,6 +102,50 @@ class PluginResourceMonitor:
|
|||||||
"psutil not available - resource monitoring will be limited to execution time only"
|
"psutil not available - resource monitoring will be limited to execution time only"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def _metrics_from_cache(self, plugin_id: str, cached: Any) -> "ResourceMetrics":
|
||||||
|
"""Build metrics from a cached record, ignoring anything unrecognised.
|
||||||
|
|
||||||
|
ResourceMetrics(**cached) raises TypeError on a single unexpected key,
|
||||||
|
and that exception escapes into plugin_manager, which reports it as
|
||||||
|
"plugin <id> operation failed". Every plugin fails, and the plugin
|
||||||
|
system never finishes initialising.
|
||||||
|
|
||||||
|
Seen on a live rig: every plugin failing with
|
||||||
|
|
||||||
|
ResourceMetrics.__init__() got an unexpected keyword argument
|
||||||
|
'consecutive_failures'
|
||||||
|
|
||||||
|
which is a plugin_health field, not a metrics one. How a health-shaped
|
||||||
|
record came to sit under a plugin_metrics key on that machine is not
|
||||||
|
established -- a restored backup that mixed two machines' caches is the
|
||||||
|
likeliest explanation -- but the loader should not be brittle enough for
|
||||||
|
it to matter. plugin_health already repairs its records field by field
|
||||||
|
rather than trusting whatever is on disk; this does the same.
|
||||||
|
|
||||||
|
Unknown keys are dropped and named once, so a genuine schema change is
|
||||||
|
visible in the log instead of silently discarded.
|
||||||
|
"""
|
||||||
|
if not isinstance(cached, dict):
|
||||||
|
self.logger.warning(
|
||||||
|
"Ignoring cached metrics for %s: expected a mapping, got %s",
|
||||||
|
plugin_id, type(cached).__name__)
|
||||||
|
return ResourceMetrics()
|
||||||
|
|
||||||
|
known = {f.name for f in fields(ResourceMetrics)}
|
||||||
|
unknown = sorted(set(cached) - known)
|
||||||
|
if unknown:
|
||||||
|
self.logger.warning(
|
||||||
|
"Dropping unrecognised field(s) from cached metrics for %s: %s",
|
||||||
|
plugin_id, ", ".join(unknown))
|
||||||
|
usable = {k: v for k, v in cached.items() if k in known}
|
||||||
|
try:
|
||||||
|
return ResourceMetrics(**usable)
|
||||||
|
except (TypeError, ValueError) as e:
|
||||||
|
self.logger.warning(
|
||||||
|
"Cached metrics for %s unusable (%s); starting fresh",
|
||||||
|
plugin_id, e)
|
||||||
|
return ResourceMetrics()
|
||||||
|
|
||||||
def _get_metrics_key(self, plugin_id: str) -> str:
|
def _get_metrics_key(self, plugin_id: str) -> str:
|
||||||
"""Get cache key for plugin metrics."""
|
"""Get cache key for plugin metrics."""
|
||||||
return f"plugin_metrics:{plugin_id}"
|
return f"plugin_metrics:{plugin_id}"
|
||||||
@@ -126,7 +170,7 @@ class PluginResourceMonitor:
|
|||||||
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
cache_key, max_age=None, memory_ttl=0 if force_reload else None
|
||||||
)
|
)
|
||||||
if cached:
|
if cached:
|
||||||
metrics = ResourceMetrics(**cached)
|
metrics = self._metrics_from_cache(plugin_id, cached)
|
||||||
else:
|
else:
|
||||||
metrics = ResourceMetrics()
|
metrics = ResourceMetrics()
|
||||||
self._metrics[plugin_id] = metrics
|
self._metrics[plugin_id] = metrics
|
||||||
|
|||||||
Executable → Regular
Executable → Regular
@@ -58,7 +58,7 @@ def repos(tmp_path):
|
|||||||
def test_branch_with_upstream_uses_a_plain_pull(repos):
|
def test_branch_with_upstream_uses_a_plain_pull(repos):
|
||||||
args, note, error = resolve_pull_command(str(repos))
|
args, note, error = resolve_pull_command(str(repos))
|
||||||
assert error is None
|
assert error is None
|
||||||
assert args == ['git', 'pull', '--rebase', '--autostash']
|
assert args == ['git', 'pull', '--rebase']
|
||||||
assert note == ''
|
assert note == ''
|
||||||
|
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ def test_branch_without_upstream_falls_back_to_origin_branch(repos):
|
|||||||
|
|
||||||
args, note, error = resolve_pull_command(str(repos))
|
args, note, error = resolve_pull_command(str(repos))
|
||||||
assert error is None
|
assert error is None
|
||||||
assert args == ['git', 'pull', '--rebase', '--autostash', 'origin', 'audit']
|
assert args == ['git', 'pull', '--rebase', 'origin', 'audit']
|
||||||
assert 'audit' in note
|
assert 'audit' in note
|
||||||
|
|
||||||
|
|
||||||
@@ -155,7 +155,7 @@ def test_switching_attaches_tracking_so_pull_needs_no_fallback(repos):
|
|||||||
|
|
||||||
args, note, error = resolve_pull_command(str(repos))
|
args, note, error = resolve_pull_command(str(repos))
|
||||||
assert error is None
|
assert error is None
|
||||||
assert args == ['git', 'pull', '--rebase', '--autostash']
|
assert args == ['git', 'pull', '--rebase']
|
||||||
assert note == ''
|
assert note == ''
|
||||||
|
|
||||||
|
|
||||||
@@ -200,37 +200,3 @@ def test_stash_option_lets_the_switch_through_and_keeps_the_work(repos):
|
|||||||
assert _git('branch', '--show-current', cwd=repos).stdout.strip() == 'other'
|
assert _git('branch', '--show-current', cwd=repos).stdout.strip() == 'other'
|
||||||
# The edit is not lost — it is on the stash.
|
# The edit is not lost — it is on the stash.
|
||||||
assert 'switch to other' in _git('stash', 'list', cwd=repos).stdout
|
assert 'switch to other' in _git('stash', 'list', cwd=repos).stdout
|
||||||
|
|
||||||
|
|
||||||
class TestInstallerDoesNotBlockTheUpdateButton:
|
|
||||||
"""first_time_install.sh chmods scripts that git tracked as 644.
|
|
||||||
|
|
||||||
With core.fileMode true -- the default on Linux -- that leaves five
|
|
||||||
permanently modified tracked files on every machine that ran the
|
|
||||||
installer, and `git pull --rebase` refuses to start:
|
|
||||||
|
|
||||||
error: cannot pull with rebase: You have unstaged changes.
|
|
||||||
|
|
||||||
Tracking them as executable makes the installer's chmod a no-op.
|
|
||||||
"""
|
|
||||||
|
|
||||||
CHMODDED = [
|
|
||||||
'first_time_install.sh',
|
|
||||||
'start_display.sh',
|
|
||||||
'stop_display.sh',
|
|
||||||
'scripts/install/install_service.sh',
|
|
||||||
'scripts/install/install_web_service.sh',
|
|
||||||
]
|
|
||||||
|
|
||||||
def test_scripts_the_installer_chmods_are_tracked_executable(self):
|
|
||||||
import subprocess
|
|
||||||
from pathlib import Path
|
|
||||||
root = Path(__file__).resolve().parent.parent
|
|
||||||
out = subprocess.run(['git', 'ls-files', '-s', *self.CHMODDED],
|
|
||||||
capture_output=True, text=True, cwd=str(root)).stdout
|
|
||||||
modes = {line.split()[3]: line.split()[0] for line in out.strip().split('\n') if line}
|
|
||||||
non_exec = sorted(f for f, m in modes.items() if m != '100755')
|
|
||||||
assert not non_exec, (
|
|
||||||
f"{non_exec} are chmodded by the installer but tracked non-executable, "
|
|
||||||
"so every install leaves the working tree dirty and the update "
|
|
||||||
"button cannot pull")
|
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
"""A malformed metrics cache entry must not take every plugin down with it.
|
||||||
|
|
||||||
|
`ResourceMetrics(**cached)` raises TypeError on a single unexpected key, and
|
||||||
|
that exception escapes into plugin_manager, which reports it per plugin as
|
||||||
|
"plugin <id> operation failed". Every plugin fails and the plugin system never
|
||||||
|
finishes initialising -- the health endpoint reports
|
||||||
|
`plugin_system: not_initialized` while the display itself keeps running.
|
||||||
|
|
||||||
|
Seen on a live rig, once per plugin, continuously:
|
||||||
|
|
||||||
|
ERROR - src.plugin_system.plugin_manager - plugin geochron operation failed:
|
||||||
|
ResourceMetrics.__init__() got an unexpected keyword argument
|
||||||
|
'consecutive_failures'
|
||||||
|
|
||||||
|
`consecutive_failures` belongs to plugin_health, not to metrics. How a
|
||||||
|
health-shaped record came to sit under a plugin_metrics key on that machine is
|
||||||
|
not established -- a restored backup that mixed two machines' caches is the
|
||||||
|
likeliest explanation, and the same rig had one restored onto it -- but a
|
||||||
|
loader that turns one bad cache entry into a total outage is the part worth
|
||||||
|
fixing. plugin_health already repairs its own records field by field rather
|
||||||
|
than trusting what is on disk.
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
from dataclasses import fields
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.plugin_system.resource_monitor import PluginResourceMonitor, ResourceMetrics
|
||||||
|
|
||||||
|
|
||||||
|
class _Cache:
|
||||||
|
def __init__(self, payload=None):
|
||||||
|
self.payload = payload
|
||||||
|
|
||||||
|
def get(self, key, max_age=None, memory_ttl=None, **kwargs):
|
||||||
|
return self.payload
|
||||||
|
|
||||||
|
def set(self, key, data, ttl=None, **kwargs):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _monitor(payload):
|
||||||
|
m = PluginResourceMonitor(cache_manager=_Cache(payload))
|
||||||
|
m.logger = logging.getLogger("test")
|
||||||
|
return m
|
||||||
|
|
||||||
|
|
||||||
|
#: What the rig actually had under the metrics key.
|
||||||
|
HEALTH_SHAPED = {
|
||||||
|
"consecutive_failures": 0, "circuit_state": "closed",
|
||||||
|
"circuit_opened_time": None, "half_open_start_time": None,
|
||||||
|
"last_error": None, "last_failure_time": None,
|
||||||
|
"last_success_time": 1_700_000_000.0, "total_failures": 0,
|
||||||
|
"total_successes": 42,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_health_record_under_the_metrics_key_does_not_raise():
|
||||||
|
"""The exact failure: it must degrade, not take the plugin system down."""
|
||||||
|
monitor = _monitor(HEALTH_SHAPED)
|
||||||
|
metrics = monitor.get_metrics(" plugin-a".strip())
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recognised_fields_in_a_mixed_record_are_kept():
|
||||||
|
"""Dropping the record wholesale would lose real history unnecessarily."""
|
||||||
|
mixed = dict(HEALTH_SHAPED, call_count=7, memory_mb=12.5)
|
||||||
|
metrics = _monitor(mixed).get_metrics("plugin-b")
|
||||||
|
assert metrics.call_count == 7
|
||||||
|
assert metrics.memory_mb == 12.5
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_clean_record_still_loads_unchanged():
|
||||||
|
clean = {f.name: 3 for f in fields(ResourceMetrics)}
|
||||||
|
metrics = _monitor(clean).get_metrics("plugin-c")
|
||||||
|
for name in (f.name for f in fields(ResourceMetrics)):
|
||||||
|
assert getattr(metrics, name) == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_unknown_fields_are_named_in_the_log(caplog):
|
||||||
|
"""Silently discarding them would hide a real schema change."""
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
_monitor(HEALTH_SHAPED).get_metrics("plugin-d")
|
||||||
|
# getMessage(), not .message: the latter is only populated once a handler
|
||||||
|
# formats the record, so the obvious spelling silently never matches.
|
||||||
|
assert any("consecutive_failures" in r.getMessage() for r in caplog.records), \
|
||||||
|
caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("payload", ["a string", 42, ["a", "list"]])
|
||||||
|
def test_a_non_mapping_cache_entry_does_not_raise(payload):
|
||||||
|
metrics = _monitor(payload).get_metrics("plugin-e")
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
|
|
||||||
|
|
||||||
|
def test_values_of_the_wrong_type_do_not_raise():
|
||||||
|
"""A dataclass will accept these, but a later float() on them would not."""
|
||||||
|
metrics = _monitor({"call_count": "not a number"}).get_metrics("plugin-f")
|
||||||
|
assert isinstance(metrics, ResourceMetrics)
|
||||||
@@ -1657,22 +1657,13 @@ def resolve_pull_command(project_dir):
|
|||||||
backup, or following an install guide that names one. The update button
|
backup, or following an install guide that names one. The update button
|
||||||
then reports a failure the user cannot act on.
|
then reports a failure the user cannot act on.
|
||||||
|
|
||||||
``--autostash`` is passed for the same reason. Rebase refuses to start
|
|
||||||
when any tracked file is modified, and on these installs something always
|
|
||||||
is: first_time_install.sh chmods five scripts that git tracked as 644, so
|
|
||||||
every machine that ran the installer carries five permanent mode changes
|
|
||||||
and the update button reports "cannot pull with rebase: You have unstaged
|
|
||||||
changes". Those modes are corrected in this commit, but a user cannot pull
|
|
||||||
the correction while the pull is what is blocked, and any other local edit
|
|
||||||
would reproduce it anyway. Autostash reapplies the changes afterwards.
|
|
||||||
|
|
||||||
Returns ``(args, note, error)``. When ``origin/<branch>`` exists the pull
|
Returns ``(args, note, error)``. When ``origin/<branch>`` exists the pull
|
||||||
is made explicit against it, so the update proceeds and the branch is
|
is made explicit against it, so the update proceeds and the branch is
|
||||||
given tracking information afterwards.
|
given tracking information afterwards.
|
||||||
"""
|
"""
|
||||||
upstream = _git_upstream(project_dir)
|
upstream = _git_upstream(project_dir)
|
||||||
if upstream:
|
if upstream:
|
||||||
return ['git', 'pull', '--rebase', '--autostash'], '', None
|
return ['git', 'pull', '--rebase'], '', None
|
||||||
|
|
||||||
branch = _git_current_branch(project_dir)
|
branch = _git_current_branch(project_dir)
|
||||||
if not branch:
|
if not branch:
|
||||||
@@ -1682,7 +1673,7 @@ def resolve_pull_command(project_dir):
|
|||||||
)
|
)
|
||||||
if _git_remote_branch_exists(project_dir, branch):
|
if _git_remote_branch_exists(project_dir, branch):
|
||||||
return (
|
return (
|
||||||
['git', 'pull', '--rebase', '--autostash', 'origin', branch],
|
['git', 'pull', '--rebase', 'origin', branch],
|
||||||
f"Branch '{branch}' had no upstream; pulled from origin/{branch} and set it as the upstream.",
|
f"Branch '{branch}' had no upstream; pulled from origin/{branch} and set it as the upstream.",
|
||||||
None,
|
None,
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user