- | {{ adapter.name }} |
+
+ {{ adapter.display_name or adapter.name }}
+ {% if adapter.api_key_missing %}
+ ⚠️ API Key Missing
+ {% endif %}
+ |
{% if adapter.enabled %}Yes{% else %}No{% endif %} |
{{ adapter.cadence_s }}s |
{{ adapter.updated_at.strftime('%Y-%m-%d %H:%M') if adapter.updated_at else '—' }} |
diff --git a/src/central/supervisor.py b/src/central/supervisor.py
index c4ea0bc..bebed6c 100644
--- a/src/central/supervisor.py
+++ b/src/central/supervisor.py
@@ -266,6 +266,23 @@ class Supervisor:
If the adapter was previously stopped (state exists but task is not running),
reuses the existing state to preserve last_completed_poll for rate limiting.
"""
+ # API key precondition
+ adapter_cls = self._adapters.get(config.name)
+ if adapter_cls is not None and adapter_cls.requires_api_key is not None:
+ alias = adapter_cls.requires_api_key
+ key_value = await self._config_store.get_api_key(alias)
+ if not key_value:
+ error_msg = f"missing api key: {alias}"
+ logger.warning(
+ "Adapter cannot start - api key missing",
+ extra={"adapter": config.name, "alias": alias},
+ )
+ await self._config_store.set_adapter_last_error(config.name, error_msg)
+ return
+
+ # Clear any stale last_error before proceeding
+ await self._config_store.set_adapter_last_error(config.name, None)
+
existing_state = self._adapter_states.get(config.name)
if existing_state is not None:
diff --git a/tests/test_adapters.py b/tests/test_adapters.py
index beaeae0..aa3cd90 100644
--- a/tests/test_adapters.py
+++ b/tests/test_adapters.py
@@ -42,9 +42,9 @@ class TestAdaptersListAuthenticated:
mock_conn = AsyncMock()
mock_conn.fetch.return_value = [
- {"name": "firms", "enabled": True, "cadence_s": 300, "settings": {"api_key_alias": "firms"}, "paused_at": None, "updated_at": None},
- {"name": "nws", "enabled": True, "cadence_s": 60, "settings": {"contact_email": "test@test.com"}, "paused_at": None, "updated_at": None},
- {"name": "usgs_quake", "enabled": True, "cadence_s": 120, "settings": {"feed": "all_hour"}, "paused_at": None, "updated_at": None},
+ {"name": "firms", "enabled": True, "cadence_s": 300, "settings": {"api_key_alias": "firms"}, "paused_at": None, "updated_at": None, "last_error": None},
+ {"name": "nws", "enabled": True, "cadence_s": 60, "settings": {"contact_email": "test@test.com"}, "paused_at": None, "updated_at": None, "last_error": None},
+ {"name": "usgs_quake", "enabled": True, "cadence_s": 120, "settings": {"feed": "all_hour"}, "paused_at": None, "updated_at": None, "last_error": None},
]
mock_pool = MagicMock()
@@ -55,9 +55,22 @@ class TestAdaptersListAuthenticated:
mock_response = MagicMock()
mock_templates.TemplateResponse.return_value = mock_response
+ # Mock adapter classes
+ mock_firms_cls = MagicMock()
+ mock_firms_cls.requires_api_key = "firms"
+ mock_firms_cls.display_name = "FIRMS"
+ mock_nws_cls = MagicMock()
+ mock_nws_cls.requires_api_key = None
+ mock_nws_cls.display_name = "NWS"
+ mock_usgs_cls = MagicMock()
+ mock_usgs_cls.requires_api_key = None
+ mock_usgs_cls.display_name = "USGS Quake"
+ mock_adapter_classes = {"firms": mock_firms_cls, "nws": mock_nws_cls, "usgs_quake": mock_usgs_cls}
+
with patch("central.gui.routes._get_templates", return_value=mock_templates):
with patch("central.gui.routes.get_pool", return_value=mock_pool):
- result = await adapters_list(mock_request)
+ with patch("central.gui.routes._adapter_classes", return_value=mock_adapter_classes):
+ result = await adapters_list(mock_request)
# Verify template was called with adapters
call_args = mock_templates.TemplateResponse.call_args
diff --git a/tests/test_requires_api_key.py b/tests/test_requires_api_key.py
new file mode 100644
index 0000000..9f8d32b
--- /dev/null
+++ b/tests/test_requires_api_key.py
@@ -0,0 +1,117 @@
+"""Tests for requires_api_key enforcement."""
+
+import pytest
+from unittest.mock import MagicMock, AsyncMock, patch
+
+
+class TestConfigStoreSetAdapterLastError:
+ """Tests for ConfigStore.set_adapter_last_error method."""
+
+ @pytest.mark.asyncio
+ async def test_set_adapter_last_error_updates_row(self):
+ """set_adapter_last_error should update the last_error column."""
+ from central.config_store import ConfigStore
+
+ mock_pool = MagicMock()
+ mock_conn = MagicMock()
+ mock_conn.execute = AsyncMock()
+ mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
+ mock_conn.__aexit__ = AsyncMock()
+ mock_pool.acquire = MagicMock(return_value=mock_conn)
+
+ config_store = ConfigStore.__new__(ConfigStore)
+ config_store._pool = mock_pool
+
+ await config_store.set_adapter_last_error("firms", "missing api key: firms")
+
+ mock_conn.execute.assert_called_once()
+ call_args = mock_conn.execute.call_args[0]
+ assert "UPDATE config.adapters SET last_error" in call_args[0]
+ assert call_args[1] == "missing api key: firms"
+ assert call_args[2] == "firms"
+
+ @pytest.mark.asyncio
+ async def test_clear_adapter_last_error(self):
+ """set_adapter_last_error with None should clear the error."""
+ from central.config_store import ConfigStore
+
+ mock_pool = MagicMock()
+ mock_conn = MagicMock()
+ mock_conn.execute = AsyncMock()
+ mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
+ mock_conn.__aexit__ = AsyncMock()
+ mock_pool.acquire = MagicMock(return_value=mock_conn)
+
+ config_store = ConfigStore.__new__(ConfigStore)
+ config_store._pool = mock_pool
+
+ await config_store.set_adapter_last_error("firms", None)
+
+ mock_conn.execute.assert_called_once()
+ call_args = mock_conn.execute.call_args[0]
+ assert call_args[1] is None
+ assert call_args[2] == "firms"
+
+
+class TestRoutesApiKeyMissing:
+ """Tests for routes api_key_missing computation."""
+
+ @pytest.mark.asyncio
+ async def test_adapters_list_includes_api_key_missing_flag(self):
+ """adapters_list should compute api_key_missing for each adapter."""
+ from central.gui.routes import adapters_list
+
+ mock_request = MagicMock()
+ mock_request.state = MagicMock()
+ mock_request.state.operator = {"username": "test"}
+ mock_request.state.csrf_token = "test_token"
+
+ mock_pool = MagicMock()
+ mock_conn = MagicMock()
+ mock_conn.fetch = AsyncMock(return_value=[
+ {"name": "firms", "enabled": False, "cadence_s": 300, "settings": {}, "paused_at": None, "updated_at": None, "last_error": None},
+ ])
+ mock_conn.fetchval = AsyncMock(return_value=None) # No API key exists
+ mock_conn.__aenter__ = AsyncMock(return_value=mock_conn)
+ mock_conn.__aexit__ = AsyncMock()
+ mock_pool.acquire = MagicMock(return_value=mock_conn)
+
+ # Mock adapter class with requires_api_key
+ mock_firms_cls = MagicMock()
+ mock_firms_cls.requires_api_key = "firms"
+ mock_firms_cls.display_name = "FIRMS"
+
+ with patch("central.gui.routes._get_templates") as mock_templates:
+ with patch("central.gui.routes.get_pool", return_value=mock_pool):
+ with patch("central.gui.routes._adapter_classes", return_value={"firms": mock_firms_cls}):
+ mock_template_response = MagicMock()
+ mock_templates.return_value.TemplateResponse = MagicMock(return_value=mock_template_response)
+
+ await adapters_list(mock_request)
+
+ # Check the context passed to template
+ call_kwargs = mock_templates.return_value.TemplateResponse.call_args[1]
+ adapters = call_kwargs["context"]["adapters"]
+
+ assert len(adapters) == 1
+ assert adapters[0]["api_key_missing"] is True
+ assert adapters[0]["requires_api_key_alias"] == "firms"
+
+
+class TestAdapterClassRequiresApiKey:
+ """Tests for adapter class requires_api_key attribute."""
+
+ def test_firms_adapter_requires_api_key(self):
+ """FIRMS adapter should declare requires_api_key."""
+ from central.adapters.firms import FIRMSAdapter
+ assert FIRMSAdapter.requires_api_key == "firms"
+
+ def test_nws_adapter_no_requires_api_key(self):
+ """NWS adapter should not require an API key."""
+ from central.adapters.nws import NWSAdapter
+ assert NWSAdapter.requires_api_key is None
+
+ def test_usgs_quake_adapter_no_requires_api_key(self):
+ """USGS Quake adapter should not require an API key."""
+ from central.adapters.usgs_quake import USGSQuakeAdapter
+ assert USGSQuakeAdapter.requires_api_key is None
diff --git a/tests/test_supervisor_integration.py b/tests/test_supervisor_integration.py
index e318752..20360fe 100644
--- a/tests/test_supervisor_integration.py
+++ b/tests/test_supervisor_integration.py
@@ -94,6 +94,8 @@ class MockConfigSource:
class MockNWSAdapter:
"""Mock NWSAdapter that tracks poll calls and allows control."""
+ requires_api_key = None # Mock adapters don't require API keys
+
def __init__(self, config, config_store, cursor_db_path) -> None:
self.config = config
self._config_store = config_store
@@ -152,6 +154,8 @@ def mock_config_store():
store = MagicMock()
store.list_streams = AsyncMock(return_value=[])
store.get_stream = AsyncMock(return_value=None)
+ store.set_adapter_last_error = AsyncMock()
+ store.get_api_key = AsyncMock(return_value=None)
return store