mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-08 12:18:06 +00:00
Follow-ups from #441: secret-helper migration, ten more bug fixes, and coverage for every remaining untested module (#444)
* refactor(web): use canonical secret helpers in api_v3; make ConfigManager secret strip/merge array-aware
api_v3.py carried three inline nested copies of find_secret_fields/
separate_secrets (main-config save, plugin-config save, plugin-config
reset). They drifted from each other (one lacked isinstance guards) and
none supported the canonical module's array-item secrets
(accounts[].token). All three endpoints now import from
src/web_interface/secret_helpers.
Adopting the canonical behavior makes array-item secrets reachable, and
their parallel-placeholder shape ([{'token': ...}, {}] alongside the
regular list) was not survivable by ConfigManager's round-trip:
_strip_secrets_recursive dropped the whole key (losing the regular
fields from config.json) and _deep_merge replaced the regular list
wholesale on load. Both are now array-aware:
- strip removes the secret fields from each item and ALWAYS keeps the
list so indices survive for merge-on-load; whole-key secrets (scalar
lists, shape mismatches) still drop the key entirely — never leak.
- merge folds each secrets item into the config item at the same index,
skipping {} placeholders. The regular list's length is authoritative
in both directions: a user deleting an array item never has it
resurrected from a stale secrets entry (extras warn and are ignored).
api_v3's own deep_merge intentionally still replaces lists wholesale —
form posts carry complete arrays and index-merging would resurrect
deleted items; a comment now documents that.
Tests: the parity guard flips from 'exactly 3 inline copies' to 'zero,
and the canonical import must exist'; TestArraySecretStripAndMerge
covers the new strip/merge semantics incl. length-mismatch contracts;
new test_api_v3_secret_roundtrip.py drives all three endpoints through
a Flask client with a REAL ConfigManager+SchemaManager over tmp_path,
proving secrets land in config_secrets.json, config.json stays clean,
and a fresh load merges them back into the right array items.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: repair broken helper paths across display, cache, odds, logging, resolver, repos, config, validator
Nine fixes for bugs surfaced while writing coverage for previously
untested modules (plus the bool-duration quirk pinned in PR #441):
- base_plugin.get_display_duration: exclude bools from both numeric
branches — display_duration=True no longer reads as a 1-second slot;
it falls through to config, then the 15.0 default.
- display_helper: draw_error_message/draw_no_data_message called
_draw_centered_text with the wrong arguments and crashed with
AttributeError — both now delegate to draw_centered_text.
draw_scorebug_layout drew status and clock at the same y, overprinting
each other — they now share one combined top line.
draw_ticker_layout drew its text starting at x=display_width (fully
off-canvas), returning a blank frame every time — now draws at x=0;
scroll_speed stays accepted-but-unused and is documented as such.
- api_helper.clear_cache guarded on a nonexistent CacheManager.clear()
method, silently never clearing anything; it now uses the real surface
(clear_cache/delete/list_cache_files) and no-ops safely otherwise.
- base_odds_manager._extract_espn_data raised AttributeError when ESPN
sent explicit JSON nulls ("homeTeamOdds": null) — every level now
null-safes with 'or {}'. format_odds_summary gated on
is_odds_available, which deliberately ignores money lines, so
ML-only odds formatted as "No odds available" — it now gates only on
empty/no_odds data and formats money lines.
- logging_config.ContextualFormatter mutated record.msg in place, so a
second handler prepended the context prefix twice; it now formats a
copy. log_error hardcoded exc_info=True and raised TypeError when the
caller passed exc_info — now kwargs.setdefault.
- dynamic_team_resolver wrote its "shared" class cache through self,
creating instance shadows — the cache was per-instance and every
scoreboard refetched rankings. Writes now go through the class.
- saved_repositories cleaned URLs with an unanchored .replace('.git','')
that mangled URLs merely containing '.git' (my.github.io -> myhub.io);
now strips only a trailing suffix. add/remove also roll back the
in-memory list when the save fails, so memory always matches disk.
- config_helper.merge_configs shallow-copied the base, aliasing every
un-overridden nested dict into the result — now deep-copies.
- startup_validator.validate_all accumulated errors/warnings across
calls — now resets both lists per run.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: cover the previously untested modules
Nine new suites plus an extension, asserting the Phase-1b fixed behavior
and pinning the quirks deliberately left alone:
- test_logging_config.py: formatters (JSON shape, no record mutation,
single prefix through two handlers), PluginLoggerAdapter precedence,
setup_logging handler hygiene and LEDMATRIX_DEBUG, log_error exc_info.
- test_startup_validator.py: exact messages, error-vs-warning split,
accessor split (load_config vs get_config), cache-dir branches with
os.access monkeypatched (root can write anything in CI), idempotence,
raise_on_errors classification precedence.
- test_config_helper.py (full): load/save round trips, dot-notation
get/set incl. silent-failure contract, post-fix no-aliasing merge,
schema validation branches, the '{id}_config' key pin, default-enabled
pin.
- test_saved_repositories.py: three load shapes, bare-list rewrite pin,
trailing-only .git strip (my.github.io regression), save-failure
rollback, type-classification case-sensitivity pin.
- test_api_helper.py: rate-limit math, cache-hit short circuit, ESPN
URL/key formats, exact User-Agent guard, retry adapter, post-fix
clear_cache against the real CacheManager surface, ttl-dropped pin.
- test_base_odds_manager.py: cache-key/URL construction, no_odds
sentinel round trip, stale-cache fallback, null-safe extraction,
ML-only formatting, is_odds_available truth table (ML-blind by
contract), config key/attr mismatch pin.
- test_dynamic_team_resolver.py: expansion/dedup/slicing, dropped
unknown-dynamic names (TOP_ substring hazard pinned), genuinely
shared class cache (second instance: zero HTTP), TTL expiry,
failure degradation without raising.
- test_display_helper.py (full): the fixed error/no-data renders,
combined scorebug top line, non-blank ticker with scroll_speed
no-op pin, composite upconversion, logo bleed positions, square
orientation pin.
- test_skin_runtime_cache.py: discovery-cache hit/invalidation
semantics (manifest mtime, .py edits pinned as non-invalidating),
sys.modules namespacing contract incl. bare-name restore and stdlib
shadowing, entry-module execute-once, API minor-version tolerance,
skin_matches_target table.
- test_sports_capabilities.py (extended): _draw_celebration_layout
executed for real (flash window, matrix-dims fallback, highlight
alternation, logo-failure isolation), _should_celebrate_for direct,
strict duration boundary, score_to_int edges, both-teams-score
precedence, expired-coalesce refire, disabled-win baseline
preservation, id-less prune.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: real schedule/dim coverage for DisplayController; fix two vacuous schedule tests
New test_display_controller_schedule.py drives _check_schedule and
_check_dim_schedule on a bare controller stub: same-day and
midnight-crossing windows with inclusive boundaries, global vs per-day vs
legacy-inferred modes (and dim's global-only default — no legacy
inference), per-day disabled days, invalid %H:%M fallbacks, unknown
timezone -> UTC, dim_brightness default 30, inactive-display short
circuit, and the _was_display_active/_was_dimmed transition flags.
test_display_controller.py's test_schedule_disabled and
test_active_hours patched config_service.get_config — which
_check_schedule never reads — so both asserted the init-default value
and could not fail. Rewritten on the test_inactive_hours pattern
(inject controller.config['schedule'], reset the minute gate, flip the
flag to the opposite state first so the assertion has teeth).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* ci: raise coverage floor to 48%
Measured 50% with the new suites in place (was 47% baseline when the
gate was introduced at 45); floor stays two points under measured.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: address CodeQL alert and review findings
- config_manager: the "secrets list longer than config list" warning now
interpolates only config-side data (no key name or secrets-derived
values), resolving the CodeQL clear-text-logging alert.
- base_plugin: validate_config rejects bool display_duration, matching
get_display_duration (bool is an int subclass and would otherwise pass
as a positive number).
- config_helper: merge_configs deep-copies override values in the
non-recursive branch so mutating the merged result cannot reach back
into override_config.
- saved_repositories: saves are atomic (temp file + fsync + os.replace),
so a failed write can no longer truncate saved_repositories.json.
- tests: regression cases for each fix, plus a pin that whole-item
array secrets (key[] + key[].field both marked) strip to empty {}
skeletons — no secret values can reach config.json.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
---------
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Chuck
@@ -21,6 +21,7 @@ logger = logging.getLogger(__name__)
|
||||
# Import new infrastructure
|
||||
from src.web_interface.api_helpers import success_response, error_response, validate_request_json
|
||||
from src.web_interface.errors import ErrorCode
|
||||
from src.web_interface.secret_helpers import find_secret_fields, separate_secrets
|
||||
from src.plugin_system.operation_types import OperationType
|
||||
from src.web_interface.validators import (
|
||||
validate_file_upload
|
||||
@@ -1196,18 +1197,6 @@ def save_main_config():
|
||||
plugins_dir = PROJECT_ROOT / plugins_dir_name
|
||||
schema_path = plugins_dir / plugin_id / 'config_schema.json'
|
||||
|
||||
def find_secret_fields(properties, prefix=''):
|
||||
"""Recursively find fields marked with x-secret: true"""
|
||||
fields = set()
|
||||
for field_name, field_props in properties.items():
|
||||
full_path = f"{prefix}.{field_name}" if prefix else field_name
|
||||
if field_props.get('x-secret', False):
|
||||
fields.add(full_path)
|
||||
# Check nested objects
|
||||
if field_props.get('type') == 'object' and 'properties' in field_props:
|
||||
fields.update(find_secret_fields(field_props['properties'], full_path))
|
||||
return fields
|
||||
|
||||
if schema_path.exists():
|
||||
try:
|
||||
with open(schema_path, 'r', encoding='utf-8') as f:
|
||||
@@ -1218,24 +1207,6 @@ def save_main_config():
|
||||
logger.debug("Error reading schema for secret detection: %s", e)
|
||||
|
||||
# Separate secrets from regular config (same logic as save_plugin_config)
|
||||
def separate_secrets(config, secrets_set, prefix=''):
|
||||
"""Recursively separate secret fields from regular config"""
|
||||
regular = {}
|
||||
secrets = {}
|
||||
for key, value in config.items():
|
||||
full_path = f"{prefix}.{key}" if prefix else key
|
||||
if isinstance(value, dict):
|
||||
nested_regular, nested_secrets = separate_secrets(value, secrets_set, full_path)
|
||||
if nested_regular:
|
||||
regular[key] = nested_regular
|
||||
if nested_secrets:
|
||||
secrets[key] = nested_secrets
|
||||
elif full_path in secrets_set:
|
||||
secrets[key] = value
|
||||
else:
|
||||
regular[key] = value
|
||||
return regular, secrets
|
||||
|
||||
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
||||
|
||||
# PRE-PROCESSING: Preserve 'enabled' state if not in regular_config
|
||||
@@ -4276,6 +4247,11 @@ def deep_merge(base_dict, update_dict):
|
||||
"""
|
||||
Deep merge update_dict into base_dict.
|
||||
For nested dicts, recursively merge. For other types, update_dict takes precedence.
|
||||
|
||||
Lists are intentionally REPLACED wholesale, never index-merged: form posts
|
||||
carry complete arrays, and index-merging would resurrect items the user
|
||||
deleted. This also applies to the parallel secrets lists produced by
|
||||
separate_secrets — a newly saved secrets list is authoritative.
|
||||
"""
|
||||
result = base_dict.copy()
|
||||
for key, value in update_dict.items():
|
||||
@@ -5290,23 +5266,9 @@ def save_plugin_config():
|
||||
# Default to True on error to avoid disabling plugins
|
||||
plugin_config['enabled'] = True
|
||||
|
||||
# Find secret fields (supports nested schemas)
|
||||
# Find secret fields (supports nested schemas and array-item secrets)
|
||||
secret_fields = set()
|
||||
|
||||
def find_secret_fields(properties, prefix=''):
|
||||
"""Recursively find fields marked with x-secret: true"""
|
||||
fields = set()
|
||||
if not isinstance(properties, dict):
|
||||
return fields
|
||||
for field_name, field_props in properties.items():
|
||||
full_path = f"{prefix}.{field_name}" if prefix else field_name
|
||||
if isinstance(field_props, dict) and field_props.get('x-secret', False):
|
||||
fields.add(full_path)
|
||||
# Check nested objects
|
||||
if isinstance(field_props, dict) and field_props.get('type') == 'object' and 'properties' in field_props:
|
||||
fields.update(find_secret_fields(field_props['properties'], full_path))
|
||||
return fields
|
||||
|
||||
if schema and 'properties' in schema:
|
||||
secret_fields = find_secret_fields(schema['properties'])
|
||||
|
||||
@@ -5621,29 +5583,8 @@ def save_plugin_config():
|
||||
status_code=400
|
||||
)
|
||||
|
||||
# Separate secrets from regular config (handles nested configs)
|
||||
def separate_secrets(config, secrets_set, prefix=''):
|
||||
"""Recursively separate secret fields from regular config"""
|
||||
regular = {}
|
||||
secrets = {}
|
||||
|
||||
for key, value in config.items():
|
||||
full_path = f"{prefix}.{key}" if prefix else key
|
||||
|
||||
if isinstance(value, dict):
|
||||
# Recursively handle nested dicts
|
||||
nested_regular, nested_secrets = separate_secrets(value, secrets_set, full_path)
|
||||
if nested_regular:
|
||||
regular[key] = nested_regular
|
||||
if nested_secrets:
|
||||
secrets[key] = nested_secrets
|
||||
elif full_path in secrets_set:
|
||||
secrets[key] = value
|
||||
else:
|
||||
regular[key] = value
|
||||
|
||||
return regular, secrets
|
||||
|
||||
# Separate secrets from regular config (handles nested configs and
|
||||
# array-item secrets — see src/web_interface/secret_helpers.py)
|
||||
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
||||
|
||||
# Get current configs
|
||||
@@ -5891,41 +5832,10 @@ def reset_plugin_config():
|
||||
schema = schema_mgr.load_schema(plugin_id, use_cache=True)
|
||||
secret_fields = set()
|
||||
|
||||
def find_secret_fields(properties, prefix=''):
|
||||
"""Recursively find fields marked with x-secret: true"""
|
||||
fields = set()
|
||||
if not isinstance(properties, dict):
|
||||
return fields
|
||||
for field_name, field_props in properties.items():
|
||||
full_path = f"{prefix}.{field_name}" if prefix else field_name
|
||||
if isinstance(field_props, dict) and field_props.get('x-secret', False):
|
||||
fields.add(full_path)
|
||||
if isinstance(field_props, dict) and field_props.get('type') == 'object' and 'properties' in field_props:
|
||||
fields.update(find_secret_fields(field_props['properties'], full_path))
|
||||
return fields
|
||||
|
||||
if schema and 'properties' in schema:
|
||||
secret_fields = find_secret_fields(schema['properties'])
|
||||
|
||||
# Separate defaults into regular and secret configs
|
||||
def separate_secrets(config, secrets_set, prefix=''):
|
||||
"""Recursively separate secret fields from regular config"""
|
||||
regular = {}
|
||||
secrets = {}
|
||||
for key, value in config.items():
|
||||
full_path = f"{prefix}.{key}" if prefix else key
|
||||
if isinstance(value, dict):
|
||||
nested_regular, nested_secrets = separate_secrets(value, secrets_set, full_path)
|
||||
if nested_regular:
|
||||
regular[key] = nested_regular
|
||||
if nested_secrets:
|
||||
secrets[key] = nested_secrets
|
||||
elif full_path in secrets_set:
|
||||
secrets[key] = value
|
||||
else:
|
||||
regular[key] = value
|
||||
return regular, secrets
|
||||
|
||||
default_regular, default_secrets = separate_secrets(defaults, secret_fields)
|
||||
|
||||
# Update main config with defaults
|
||||
|
||||
Reference in New Issue
Block a user