mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-04 18:28:06 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2fab41924b | ||
|
|
183e23edb3 | ||
|
|
970ca2d04f |
@@ -79,4 +79,5 @@ jobs:
|
|||||||
test/test_sports_scroll.py \
|
test/test_sports_scroll.py \
|
||||||
test/test_version_consistency.py \
|
test/test_version_consistency.py \
|
||||||
test/test_plugin_compatibility_gate.py \
|
test/test_plugin_compatibility_gate.py \
|
||||||
test/test_install_preserves_existing.py
|
test/test_install_preserves_existing.py \
|
||||||
|
test/test_core_owned_config_keys.py
|
||||||
|
|||||||
@@ -29,6 +29,21 @@ Adoption is deliberately staged: the modules below ship here, plugins adopt them
|
|||||||
behind guarded imports, and only then do the bundled copies go away. Nothing in
|
behind guarded imports, and only then do the bundled copies go away. Nothing in
|
||||||
this release changes what an existing plugin loads.
|
this release changes what an existing plugin loads.
|
||||||
|
|
||||||
|
**This is also the first release that *enforces* `ledmatrix_min_version`.**
|
||||||
|
Before it, the floor was advisory — the loader logged a warning and continued,
|
||||||
|
and the plugin store never compared the core version at all, so an update could
|
||||||
|
deliver a plugin that could not run. From 3.2.0 the store refuses such an
|
||||||
|
install. That matters for the sunset rule: a plugin may only delete its bundled
|
||||||
|
fallback once the cores in the field actually enforce the floor, which means
|
||||||
|
waiting for 3.2.0 to be widely installed rather than merely released. See
|
||||||
|
`docs/SPORTS_UNIFICATION.md`, phase B6.
|
||||||
|
|
||||||
|
One deliberate exception: a core reporting a version below `2.0.0` is treated as
|
||||||
|
*unknown* rather than old and is never blocked. The v3.1.0 release ships
|
||||||
|
`__version__ = "1.0.0"` (the tag was cut before the string was bumped), and
|
||||||
|
nearly every published manifest floors at `2.0.0` — so blocking on that number
|
||||||
|
would lock those users out of the plugin store entirely.
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- `src/element_style.py` — per-element style resolver backing the
|
- `src/element_style.py` — per-element style resolver backing the
|
||||||
`x-style-elements` config-schema extension. Already consumed (behind guarded
|
`x-style-elements` config-schema extension. Already consumed (behind guarded
|
||||||
@@ -71,8 +86,37 @@ this release changes what an existing plugin loads.
|
|||||||
override point — see `docs/SPORTS_UNIFICATION.md` for where the line falls
|
override point — see `docs/SPORTS_UNIFICATION.md` for where the line falls
|
||||||
and why.
|
and why.
|
||||||
|
|
||||||
|
- `src/plugin_system/compatibility.py` — the single place that answers "can this
|
||||||
|
plugin run on this core?", shared by the loader (advisory, at load time) and
|
||||||
|
the store (blocking, at install/update time) so the two cannot drift. Reads
|
||||||
|
every spelling published manifests use, including the deprecated
|
||||||
|
`versions[].ledmatrix_min`. It does **not** yet evaluate `compatible_versions`,
|
||||||
|
which is the schema-required field and can express upper bounds; closing that
|
||||||
|
is tracked in `docs/SPORTS_UNIFICATION.md` before B6.
|
||||||
|
- `scripts/check_release_version.py` and a `Release version check` workflow —
|
||||||
|
assert that a tag, the newest CHANGELOG heading and `src.__version__` agree,
|
||||||
|
on pushed `v*` tags and published releases. Runnable via `workflow_dispatch`
|
||||||
|
to check a tag *before* creating it. Added because `v3.1.0` was tagged six
|
||||||
|
weeks before `src/__init__.py` was bumped to match, which is why devices
|
||||||
|
installed from that release report `1.0.0`.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- `src/__init__.py` bumped to **3.2.0** — the number the sunset rule keys on.
|
- `src/__init__.py` bumped to **3.2.0** — the number the sunset rule keys on.
|
||||||
|
- **The plugin store refuses an incompatible install.**
|
||||||
|
`StoreManager.install_plugin` now checks the downloaded manifest's declared
|
||||||
|
floor against `src.__version__` and refuses when the plugin needs a newer
|
||||||
|
core. The check sits in `install_plugin` because `_reinstall_with_rollback`
|
||||||
|
calls it, so a refused *update* restores the version the user already had.
|
||||||
|
Refusal requires evidence: an undeclared floor, an unparseable version on
|
||||||
|
either side, or an untrustworthy core version all allow the install.
|
||||||
|
- **A failed install no longer destroys the plugin it replaced.**
|
||||||
|
`install_plugin` previously deleted the existing plugin directory before
|
||||||
|
downloading, so any later failure — a dropped connection, a malformed
|
||||||
|
manifest, or the new compatibility refusal — left the user with nothing. The
|
||||||
|
existing copy is now set aside and restored if the install fails, matching
|
||||||
|
the protection `_reinstall_with_rollback` already gave the update path.
|
||||||
|
- `web_interface.__version__` re-exports `src.__version__` instead of carrying
|
||||||
|
its own hardcoded `"3.0.0"`, which had drifted two majors from the core.
|
||||||
- **Live games are no longer dropped when the feed omits a game clock.**
|
- **Live games are no longer dropped when the feed omits a game clock.**
|
||||||
`SportsLive._is_game_really_over` previously (in the baseball and UFC
|
`SportsLive._is_game_really_over` previously (in the baseball and UFC
|
||||||
plugin lineages) coerced a missing or non-string clock to the literal
|
plugin lineages) coerced a missing or non-string clock to the literal
|
||||||
@@ -86,6 +130,12 @@ this release changes what an existing plugin loads.
|
|||||||
there means kickoff rather than expiry.
|
there means kickoff rather than expiry.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
- **Plugin updates could hang the web request thread.** The per-plugin reinstall
|
||||||
|
locks were non-reentrant, and `_reinstall_with_rollback` holds one across its
|
||||||
|
call to `install_plugin` — which now takes the same lock to protect the
|
||||||
|
set-aside/restore above. That nesting deadlocked
|
||||||
|
`update_plugin → _reinstall_with_rollback → install_plugin`, the standard
|
||||||
|
path for every monorepo plugin update. The locks are now `RLock`s.
|
||||||
- `FontManager` resolves `assets/fonts` against the core install root instead
|
- `FontManager` resolves `assets/fonts` against the core install root instead
|
||||||
of the process working directory, so font loading works when the process
|
of the process working directory, so font loading works when the process
|
||||||
starts elsewhere (e.g. the plugin safety harness on CI).
|
starts elsewhere (e.g. the plugin safety harness on CI).
|
||||||
|
|||||||
@@ -395,6 +395,37 @@ class PluginManager:
|
|||||||
self.state_manager.set_state(plugin_id, PluginState.ERROR, error=e)
|
self.state_manager.set_state(plugin_id, PluginState.ERROR, error=e)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
#: Config keys the **core** reads out of a plugin's own config block. The
|
||||||
|
#: plugin never declares them, so a schema with
|
||||||
|
#: ``"additionalProperties": false`` — 37 of the 42 published ones — reports
|
||||||
|
#: them as violations and the plugin gets flagged degraded in the web UI for
|
||||||
|
#: using a documented core feature.
|
||||||
|
#:
|
||||||
|
#: Listed explicitly rather than matched on a ``vegas_`` prefix, because
|
||||||
|
#: ``vegas_mode`` is the opposite case: plugins *do* declare that one, and a
|
||||||
|
#: prefix rule would silently stop validating it.
|
||||||
|
#:
|
||||||
|
#: Read by: ``vegas_mode/plugin_adapter.py`` (``vegas_width_pct``,
|
||||||
|
#: ``vegas_overflow``) and ``base_plugin.py`` (``vegas_max_width_screens``).
|
||||||
|
CORE_OWNED_CONFIG_KEYS = frozenset({
|
||||||
|
'vegas_width_pct',
|
||||||
|
'vegas_overflow',
|
||||||
|
'vegas_max_width_screens',
|
||||||
|
})
|
||||||
|
|
||||||
|
def _strip_core_owned_keys(self, config: Dict[str, Any]) -> Dict[str, Any]:
|
||||||
|
"""A shallow copy of ``config`` without the core's own tuning keys.
|
||||||
|
|
||||||
|
Only the top level is touched, and only when such a key is present, so
|
||||||
|
the common case allocates nothing extra.
|
||||||
|
"""
|
||||||
|
if not isinstance(config, dict):
|
||||||
|
return config
|
||||||
|
if not self.CORE_OWNED_CONFIG_KEYS.intersection(config):
|
||||||
|
return config
|
||||||
|
return {k: v for k, v in config.items()
|
||||||
|
if k not in self.CORE_OWNED_CONFIG_KEYS}
|
||||||
|
|
||||||
def _validate_config_schema_soft(self, plugin_id: str, config: Dict[str, Any]) -> None:
|
def _validate_config_schema_soft(self, plugin_id: str, config: Dict[str, Any]) -> None:
|
||||||
"""Validate a plugin's config against its JSON schema — warn/degrade only.
|
"""Validate a plugin's config against its JSON schema — warn/degrade only.
|
||||||
|
|
||||||
@@ -419,7 +450,7 @@ class PluginManager:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
is_valid, errors = self.schema_manager.validate_config_against_schema(
|
is_valid, errors = self.schema_manager.validate_config_against_schema(
|
||||||
config, schema, plugin_id
|
self._strip_core_owned_keys(config), schema, plugin_id
|
||||||
)
|
)
|
||||||
except Exception as e: # pragma: no cover - defensive
|
except Exception as e: # pragma: no cover - defensive
|
||||||
# Validation machinery itself failed — do not penalise the plugin.
|
# Validation machinery itself failed — do not penalise the plugin.
|
||||||
|
|||||||
@@ -0,0 +1,98 @@
|
|||||||
|
"""The core's own tuning keys must not make a plugin look broken.
|
||||||
|
|
||||||
|
`vegas_width_pct`, `vegas_overflow` and `vegas_max_width_screens` are read by
|
||||||
|
the *core* out of each plugin's config block — `vegas_mode/plugin_adapter.py`
|
||||||
|
and `base_plugin.py`. No plugin declares them, and 37 of the 42 published
|
||||||
|
config schemas set `"additionalProperties": false`, so schema validation
|
||||||
|
reported them as violations.
|
||||||
|
|
||||||
|
That is not just log noise: `_validate_config_schema_soft` sets `degraded` in
|
||||||
|
the health tracker, which the web UI surfaces. Measured on a real device, **9
|
||||||
|
of 27 installed plugins** were flagged degraded purely for using a documented
|
||||||
|
core feature — including `baseball-scoreboard` and `f1-scoreboard`.
|
||||||
|
|
||||||
|
The fix strips those keys before validating. It deliberately does *not* match
|
||||||
|
on a `vegas_` prefix: `vegas_mode` is plugin-owned and declared in schemas, and
|
||||||
|
a prefix rule would silently stop validating it.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.plugin_system.plugin_manager import PluginManager
|
||||||
|
|
||||||
|
|
||||||
|
STRICT_SCHEMA = {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": False,
|
||||||
|
"properties": {
|
||||||
|
"enabled": {"type": "boolean"},
|
||||||
|
"vegas_mode": {"type": "string"}, # plugin-owned, must stay validated
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def manager():
|
||||||
|
mgr = PluginManager.__new__(PluginManager) # skip the heavy constructor
|
||||||
|
mgr.logger = MagicMock()
|
||||||
|
mgr.schema_manager = MagicMock()
|
||||||
|
mgr._set_degraded_safe = MagicMock()
|
||||||
|
return mgr
|
||||||
|
|
||||||
|
|
||||||
|
class TestStripCoreOwnedKeys:
|
||||||
|
def test_removes_every_core_owned_key(self, manager):
|
||||||
|
cfg = {"enabled": True, "vegas_width_pct": 50,
|
||||||
|
"vegas_overflow": "wrap", "vegas_max_width_screens": 2}
|
||||||
|
assert manager._strip_core_owned_keys(cfg) == {"enabled": True}
|
||||||
|
|
||||||
|
def test_leaves_plugin_owned_vegas_mode_alone(self, manager):
|
||||||
|
"""A prefix rule would have eaten this one."""
|
||||||
|
cfg = {"enabled": True, "vegas_mode": "scroll"}
|
||||||
|
assert manager._strip_core_owned_keys(cfg) == cfg
|
||||||
|
|
||||||
|
def test_returns_the_same_object_when_nothing_to_strip(self, manager):
|
||||||
|
cfg = {"enabled": True}
|
||||||
|
assert manager._strip_core_owned_keys(cfg) is cfg
|
||||||
|
|
||||||
|
def test_does_not_mutate_the_caller_config(self, manager):
|
||||||
|
cfg = {"enabled": True, "vegas_width_pct": 50}
|
||||||
|
manager._strip_core_owned_keys(cfg)
|
||||||
|
assert "vegas_width_pct" in cfg, "the live plugin config was mutated"
|
||||||
|
|
||||||
|
def test_tolerates_a_non_dict(self, manager):
|
||||||
|
assert manager._strip_core_owned_keys(None) is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestSoftValidation:
|
||||||
|
def _validate_with(self, manager, config, valid=True, errors=()):
|
||||||
|
manager.schema_manager.load_schema.return_value = STRICT_SCHEMA
|
||||||
|
manager.schema_manager.validate_config_against_schema.return_value = (
|
||||||
|
valid, list(errors))
|
||||||
|
manager._validate_config_schema_soft("baseball-scoreboard", config)
|
||||||
|
return manager.schema_manager.validate_config_against_schema.call_args
|
||||||
|
|
||||||
|
def test_core_keys_never_reach_the_validator(self, manager):
|
||||||
|
"""The regression: these keys reaching a strict schema is what flagged
|
||||||
|
9 of 27 plugins degraded."""
|
||||||
|
args = self._validate_with(
|
||||||
|
manager, {"enabled": True, "vegas_width_pct": 50})
|
||||||
|
validated = args[0][0]
|
||||||
|
assert "vegas_width_pct" not in validated
|
||||||
|
assert validated == {"enabled": True}
|
||||||
|
|
||||||
|
def test_plugin_owned_keys_still_reach_the_validator(self, manager):
|
||||||
|
args = self._validate_with(
|
||||||
|
manager, {"enabled": True, "vegas_mode": "scroll"})
|
||||||
|
assert args[0][0]["vegas_mode"] == "scroll"
|
||||||
|
|
||||||
|
def test_a_genuine_violation_is_still_reported(self, manager):
|
||||||
|
"""Stripping core keys must not turn the check into a no-op."""
|
||||||
|
self._validate_with(
|
||||||
|
manager, {"enabled": True, "typo_key": 1},
|
||||||
|
valid=False, errors=["Field root: 'typo_key' was unexpected"])
|
||||||
|
manager._set_degraded_safe.assert_called()
|
||||||
|
reason = manager._set_degraded_safe.call_args[0][1]
|
||||||
|
assert reason and "typo_key" in reason
|
||||||
Reference in New Issue
Block a user