mirror of
https://github.com/zvx-echo6/central.git
synced 2026-06-10 11:54:37 +02:00
fix(wizard): eliminate all hardcoded field.name branches
Change 5: Move contact_email validation to Pydantic schema - NWSSettings now uses Field(pattern=...) for email validation - Pydantic pattern validation catches invalid emails - No special handler branch needed in routes.py Change 6: Generic api_key_field mechanism - Add api_key_field attribute to SourceAdapter base class - FIRMSAdapter sets api_key_field="api_key_alias" - GET handlers swap widget to "api_key_select" when field matches - POST handlers validate against state.api_keys generically - Templates use new api_key_select widget branch - adapters_edit handlers now fetch and pass api_keys to context Tests added: - test_invalid_contact_email_via_pydantic_pattern - test_invalid_api_key_alias_generic - test_api_key_field_none_no_check - test_adapters_edit_fetches_api_keys_into_context Zero field.name hardcoded branches remain in routes.py or templates. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Matt Johnson
parent
d0eeaa9d1a
commit
e8019a32b7
8 changed files with 314 additions and 32 deletions
|
|
@ -34,6 +34,10 @@ class SourceAdapter(ABC):
|
|||
description: str
|
||||
settings_schema: type[BaseModel]
|
||||
requires_api_key: str | None = None
|
||||
api_key_field: str | None = None
|
||||
"""Names the settings_schema field that holds an api_key alias reference, if any.
|
||||
The GUI renders this field as a select populated from config.api_keys;
|
||||
the wizard validates it against staged api_keys state."""
|
||||
wizard_order: int | None = None
|
||||
default_cadence_s: int
|
||||
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ class FIRMSAdapter(SourceAdapter):
|
|||
description = "Near-real-time satellite-detected fire hotspots from NASA FIRMS."
|
||||
settings_schema = FIRMSSettings
|
||||
requires_api_key = "firms"
|
||||
api_key_field = "api_key_alias"
|
||||
wizard_order = 2
|
||||
default_cadence_s = 300
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ from tenacity import (
|
|||
|
||||
from central import __version__
|
||||
from central.adapter import SourceAdapter
|
||||
from pydantic import BaseModel
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from central.config_models import AdapterConfig, RegionConfig
|
||||
from central.config_store import ConfigStore
|
||||
|
|
@ -193,7 +193,11 @@ def _build_regions(same_codes: list[str], ugc_codes: list[str]) -> list[str]:
|
|||
|
||||
class NWSSettings(BaseModel):
|
||||
"""Settings schema for NWS adapter."""
|
||||
contact_email: str = ""
|
||||
contact_email: str = Field(
|
||||
default="",
|
||||
pattern=r"^$|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$",
|
||||
description="Contact email for NWS API User-Agent header",
|
||||
)
|
||||
region: RegionConfig | None = None
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -652,6 +652,11 @@ async def setup_adapters_form(request: Request) -> HTMLResponse:
|
|||
else:
|
||||
settings_dict = {}
|
||||
fields = describe_fields(cls.settings_schema, settings_dict)
|
||||
# Swap widget for api_key_field to api_key_select
|
||||
if cls.api_key_field is not None:
|
||||
for f in fields:
|
||||
if f.name == cls.api_key_field:
|
||||
f.widget = "api_key_select"
|
||||
adapters.append({
|
||||
"name": name,
|
||||
"display_name": cls.display_name,
|
||||
|
|
@ -683,6 +688,11 @@ async def setup_adapters_form(request: Request) -> HTMLResponse:
|
|||
enabled = False
|
||||
cadence_s = 300
|
||||
fields = describe_fields(cls.settings_schema, settings_dict)
|
||||
# Swap widget for api_key_field to api_key_select
|
||||
if cls.api_key_field is not None:
|
||||
for f in fields:
|
||||
if f.name == cls.api_key_field:
|
||||
f.widget = "api_key_select"
|
||||
adapters.append({
|
||||
"name": name,
|
||||
"display_name": cls.display_name,
|
||||
|
|
@ -803,28 +813,12 @@ async def setup_adapters_submit(request: Request) -> Response:
|
|||
|
||||
if field.widget == "text":
|
||||
value = form.get(form_key, "").strip()
|
||||
# Special validation for contact_email
|
||||
if field.name == "contact_email":
|
||||
if enabled:
|
||||
if not value:
|
||||
errors[form_key] = "Contact email is required when enabled"
|
||||
elif not EMAIL_REGEX.match(value):
|
||||
errors[form_key] = "Invalid email format"
|
||||
else:
|
||||
new_settings[field.name] = value
|
||||
else:
|
||||
new_settings[field.name] = value if value else current_settings.get(field.name)
|
||||
# Special validation for api_key_alias
|
||||
elif field.name == "api_key_alias":
|
||||
if value:
|
||||
if not any(k["alias"] == value for k in state.api_keys):
|
||||
errors[form_key] = "API key alias does not exist"
|
||||
else:
|
||||
new_settings[field.name] = value
|
||||
else:
|
||||
new_settings[field.name] = None
|
||||
else:
|
||||
new_settings[field.name] = value if value else current_settings.get(field.name)
|
||||
new_settings[field.name] = value if value else current_settings.get(field.name)
|
||||
|
||||
elif field.widget == "api_key_select":
|
||||
# API key alias field - stored as text, validated post-loop
|
||||
value = form.get(form_key, "").strip()
|
||||
new_settings[field.name] = value if value else None
|
||||
|
||||
elif field.widget == "number":
|
||||
value_str = form.get(form_key, "").strip()
|
||||
|
|
@ -892,6 +886,15 @@ async def setup_adapters_submit(request: Request) -> Response:
|
|||
loc = err["loc"][0] if err["loc"] else "unknown"
|
||||
errors[f"{adapter_name}_{loc}"] = err["msg"]
|
||||
|
||||
# Generic api_key_field validation against wizard state
|
||||
if adapter_cls.api_key_field is not None:
|
||||
field_value = new_settings.get(adapter_cls.api_key_field)
|
||||
if field_value:
|
||||
if not any(k["alias"] == field_value for k in state.api_keys):
|
||||
errors[f"{adapter_name}_{adapter_cls.api_key_field}"] = (
|
||||
"API key alias does not exist"
|
||||
)
|
||||
|
||||
new_adapters[adapter_name] = {
|
||||
"enabled": enabled,
|
||||
"cadence_s": cadence_s,
|
||||
|
|
@ -904,6 +907,11 @@ async def setup_adapters_submit(request: Request) -> Response:
|
|||
for name, cls in wizard_adapters:
|
||||
settings_dict = new_adapters[name]["settings"]
|
||||
fields = describe_fields(cls.settings_schema, settings_dict)
|
||||
# Swap widget for api_key_field to api_key_select
|
||||
if cls.api_key_field is not None:
|
||||
for f in fields:
|
||||
if f.name == cls.api_key_field:
|
||||
f.widget = "api_key_select"
|
||||
adapters.append({
|
||||
"name": name,
|
||||
"display_name": cls.display_name,
|
||||
|
|
@ -1399,6 +1407,17 @@ async def adapters_edit_form(
|
|||
fields = []
|
||||
if adapter_cls and hasattr(adapter_cls, "settings_schema"):
|
||||
fields = describe_fields(adapter_cls.settings_schema, settings)
|
||||
# Swap widget for api_key_field to api_key_select
|
||||
if adapter_cls.api_key_field is not None:
|
||||
for f in fields:
|
||||
if f.name == adapter_cls.api_key_field:
|
||||
f.widget = "api_key_select"
|
||||
|
||||
# Fetch API keys for api_key_select widget
|
||||
api_keys = []
|
||||
async with pool.acquire() as conn:
|
||||
api_key_rows = await conn.fetch("SELECT alias FROM config.api_keys ORDER BY alias")
|
||||
api_keys = [{"alias": r["alias"]} for r in api_key_rows]
|
||||
|
||||
csrf_token = request.state.csrf_token
|
||||
response = templates.TemplateResponse(
|
||||
|
|
@ -1409,6 +1428,7 @@ async def adapters_edit_form(
|
|||
"csrf_token": csrf_token,
|
||||
"adapter": adapter,
|
||||
"fields": fields,
|
||||
"api_keys": api_keys,
|
||||
"errors": None,
|
||||
"form_data": None,
|
||||
"tile_url": tile_url,
|
||||
|
|
@ -1520,6 +1540,10 @@ async def adapters_edit_submit(
|
|||
parsed_values[field.name] = values
|
||||
else:
|
||||
parsed_values[field.name] = values
|
||||
elif field.widget == "api_key_select":
|
||||
# API key select - validate against existing keys
|
||||
value = raw.strip() if raw else None
|
||||
parsed_values[field.name] = value
|
||||
elif field.widget == "region":
|
||||
# Region handled separately below
|
||||
pass
|
||||
|
|
@ -1600,6 +1624,15 @@ async def adapters_edit_submit(
|
|||
fields = []
|
||||
if adapter_cls and hasattr(adapter_cls, "settings_schema"):
|
||||
fields = describe_fields(adapter_cls.settings_schema, current_settings)
|
||||
# Swap widget for api_key_field to api_key_select
|
||||
if adapter_cls.api_key_field is not None:
|
||||
for f in fields:
|
||||
if f.name == adapter_cls.api_key_field:
|
||||
f.widget = "api_key_select"
|
||||
|
||||
# Fetch API keys for api_key_select widget
|
||||
api_key_rows = await conn.fetch("SELECT alias FROM config.api_keys ORDER BY alias")
|
||||
api_keys = [{"alias": r["alias"]} for r in api_key_rows]
|
||||
|
||||
csrf_token = request.state.csrf_token
|
||||
response = templates.TemplateResponse(
|
||||
|
|
@ -1610,6 +1643,7 @@ async def adapters_edit_submit(
|
|||
"csrf_token": csrf_token,
|
||||
"adapter": adapter,
|
||||
"fields": fields,
|
||||
"api_keys": api_keys,
|
||||
"errors": errors,
|
||||
"form_data": form_data,
|
||||
"tile_url": tile_url,
|
||||
|
|
|
|||
|
|
@ -134,6 +134,24 @@
|
|||
{% if errors and errors[field.name] %}
|
||||
<small style="color: var(--pico-color-red-500); display: block;">{{ errors[field.name] }}</small>
|
||||
{% endif %}
|
||||
|
||||
{% elif field.widget == "api_key_select" %}
|
||||
<label for="{{ field.name }}">{{ field.label }}</label>
|
||||
<select id="{{ field.name }}" name="{{ field.name }}">
|
||||
<option value="">(none)</option>
|
||||
{% for key in api_keys %}
|
||||
<option value="{{ key.alias }}"
|
||||
{% if (form_data[field.name] if form_data and field.name in form_data else field.current_value) == key.alias %}selected{% endif %}>
|
||||
{{ key.alias }}
|
||||
</option>
|
||||
{% endfor %}
|
||||
</select>
|
||||
{% if field.description %}
|
||||
<small>{{ field.description }}</small>
|
||||
{% endif %}
|
||||
{% if errors and errors[field.name] %}
|
||||
<small style="color: var(--pico-color-red-500);">{{ errors[field.name] }}</small>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</fieldset>
|
||||
|
|
|
|||
|
|
@ -53,8 +53,18 @@
|
|||
{% set form_key = adapter.name + '_' + field.name %}
|
||||
|
||||
{% if field.widget == "text" %}
|
||||
{# Special handling for api_key_alias - render as select from wizard API keys #}
|
||||
{% if field.name == "api_key_alias" %}
|
||||
<label for="{{ form_key }}">{{ field.label }}</label>
|
||||
<input type="text" id="{{ form_key }}" name="{{ form_key }}"
|
||||
value="{{ form_data.get(form_key) if form_data else field.current_value or '' }}"
|
||||
{% if field.required %}required{% endif %}>
|
||||
{% if field.description %}
|
||||
<small>{{ field.description }}</small>
|
||||
{% endif %}
|
||||
{% if errors and errors.get(form_key) %}
|
||||
<small style="color: var(--pico-color-red-500);">{{ errors[form_key] }}</small>
|
||||
{% endif %}
|
||||
|
||||
{% elif field.widget == "api_key_select" %}
|
||||
<label for="{{ form_key }}">{{ field.label }}</label>
|
||||
<select id="{{ form_key }}" name="{{ form_key }}">
|
||||
<option value="">(none)</option>
|
||||
|
|
@ -65,12 +75,6 @@
|
|||
</option>
|
||||
{% endfor %}
|
||||
</select>
|
||||
{% else %}
|
||||
<label for="{{ form_key }}">{{ field.label }}</label>
|
||||
<input type="text" id="{{ form_key }}" name="{{ form_key }}"
|
||||
value="{{ form_data.get(form_key) if form_data else field.current_value or '' }}"
|
||||
{% if field.required %}required{% endif %}>
|
||||
{% endif %}
|
||||
{% if field.description %}
|
||||
<small>{{ field.description }}</small>
|
||||
{% endif %}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue