mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-08 12:18:06 +00:00
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
This commit is contained in:
Claude
@@ -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
|
||||
@@ -4039,6 +4010,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():
|
||||
@@ -5053,23 +5029,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'])
|
||||
|
||||
@@ -5384,29 +5346,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
|
||||
@@ -5654,41 +5595,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