feat: add developer runtime config endpoint

Author: gsiri-code

server/endpoints.py

@@ -1,27 +1,67 @@
-"""
-This is the file containing all of the endpoints for our flask app.
-The endpoint called `endpoints` will return all available endpoints.
-"""
+"""General-purpose API endpoints."""
 
+import os
 from http import HTTPStatus
 
 from flask_restx import Resource, Namespace
 
 import data.countries as countries_db
 import data.states as states_db
+from data.db_connect import CLOUD, LOCAL, SE_DB
+from server.app import (
+    APP_NAME,
+    get_cache_enabled,
+    get_runtime_environment,
+    get_runtime_log_level,
+    get_runtime_port,
+    get_runtime_version,
+)
 
 # Create namespace for each resource
 general_ns = Namespace("general", description="General API operations")
-countries_ns = Namespace(
-    "countries", description="Operations related to countries"
-)
+countries_ns = Namespace("countries", description="Operations related to countries")
 states_ns = Namespace("states", description="Operations related to states")
 
 # Constants for endpoints and responses
 HELLO_EP = "/hello"
 HELLO_RESP = "hello"
 
 
+def _parse_feature_flag(raw_value: str) -> bool | int | str:
+    lowered = raw_value.lower()
+    if lowered in {"true", "false"}:
+        return lowered == "true"
+    if raw_value.isdigit():
+        return int(raw_value)
+    return raw_value
+
+
+def _get_feature_flags() -> dict[str, bool | int | str]:
+    feature_flags = {}
+    for key, value in os.environ.items():
+        if key.startswith("FEATURE_"):
+            feature_name = key.removeprefix("FEATURE_").lower()
+            feature_flags[feature_name] = _parse_feature_flag(value)
+    return dict(sorted(feature_flags.items()))
+
+
+def _get_build_metadata() -> dict[str, str]:
+    metadata_fields = {
+        "commit_sha": os.getenv("GIT_SHA"),
+        "build_id": os.getenv("BUILD_ID"),
+        "release_id": os.getenv("RELEASE_ID"),
+        "deploy_id": os.getenv("DEPLOY_ID"),
+    }
+    return {key: value for key, value in metadata_fields.items() if value}
+
+
+def _get_safe_database_config() -> dict[str, str | bool]:
+    return {
+        "name": os.getenv("DB_NAME", SE_DB),
+        "mode": "cloud" if os.getenv("CLOUD_MONGO", LOCAL) == CLOUD else "local",
+    }
+
+
 @general_ns.route("/hello")
 class HelloWorld(Resource):
     """
@@ -76,6 +116,27 @@ def get(self):
         The `get()` method will return a sorted list of available endpoints.
         """
         from flask import current_app
-        endpoints = sorted(rule.rule for rule in
-                           current_app.url_map.iter_rules())
+
+        endpoints = sorted(rule.rule for rule in current_app.url_map.iter_rules())
         return {"Available endpoints": endpoints}
+
+
+@general_ns.route("/dev/config")
+class DevConfig(Resource):
+    """Return curated runtime configuration that is safe to expose."""
+
+    def get(self):
+        payload = {
+            "app_name": APP_NAME,
+            "environment": get_runtime_environment(),
+            "version": get_runtime_version(),
+            "port": get_runtime_port(),
+            "log_level": get_runtime_log_level(),
+            "feature_flags": _get_feature_flags(),
+            "database": _get_safe_database_config(),
+            "cache_enabled": get_cache_enabled(),
+        }
+        build_metadata = _get_build_metadata()
+        if build_metadata:
+            payload["build"] = build_metadata
+        return payload, HTTPStatus.OK

server/tests/test_dev_config.py

@@ -0,0 +1,85 @@
+import os
+
+from server.app import create_app
+
+
+def test_dev_config_returns_safe_runtime_configuration(monkeypatch):
+    monkeypatch.setenv("APP_ENV", "production")
+    monkeypatch.setenv("PORT", "9090")
+    monkeypatch.setenv("LOG_LEVEL", "debug")
+    monkeypatch.setenv("FEATURE_BETA_DASHBOARD", "true")
+    monkeypatch.setenv("FEATURE_METRICS_ENABLED", "false")
+    monkeypatch.setenv("DB_NAME", "geo")
+    monkeypatch.setenv("CLOUD_MONGO", "1")
+    monkeypatch.setenv("GIT_SHA", "abc123")
+    monkeypatch.setenv("JWT_SECRET", "super-secret")
+    monkeypatch.setenv("LOCAL_MONGO_DB_URI", "mongodb://user:pass@localhost:27017/")
+    monkeypatch.setenv(
+        "ATLAS_MONGO_DB_URI", "mongodb+srv://user:pass@example.mongodb.net/"
+    )
+
+    app = create_app()
+    with app.test_client() as client:
+        response = client.get("/dev/config")
+
+    payload = response.get_json()
+    response_text = response.get_data(as_text=True)
+
+    assert response.status_code == 200
+    assert payload == {
+        "app_name": "Geographic Database API",
+        "environment": "production",
+        "version": "v1",
+        "port": 9090,
+        "log_level": "DEBUG",
+        "feature_flags": {
+            "beta_dashboard": True,
+            "metrics_enabled": False,
+        },
+        "database": {
+            "name": "geo",
+            "mode": "cloud",
+        },
+        "cache_enabled": True,
+        "build": {
+            "commit_sha": "abc123",
+        },
+    }
+    assert "super-secret" not in response_text
+    assert "mongodb://user:pass@localhost:27017/" not in response_text
+    assert "mongodb+srv://user:pass@example.mongodb.net/" not in response_text
+    assert "JWT_SECRET" not in response_text
+
+
+def test_dev_config_omits_optional_build_metadata_when_absent(monkeypatch):
+    for key in [
+        "APP_ENV",
+        "PORT",
+        "LOG_LEVEL",
+        "DB_NAME",
+        "CLOUD_MONGO",
+        "FEATURE_BETA_DASHBOARD",
+        "FEATURE_METRICS_ENABLED",
+        "GIT_SHA",
+        "BUILD_ID",
+        "RELEASE_ID",
+        "DEPLOY_ID",
+    ]:
+        monkeypatch.delenv(key, raising=False)
+
+    app = create_app()
+    with app.test_client() as client:
+        response = client.get("/dev/config")
+
+    payload = response.get_json()
+
+    assert response.status_code == 200
+    assert payload["version"] == "v1"
+    assert payload["environment"] == "development"
+    assert payload["port"] == 8000
+    assert payload["feature_flags"] == {}
+    assert payload["database"] == {
+        "name": "seDB",
+        "mode": "local",
+    }
+    assert "build" not in payload