Rewrite configuration system (#78)

Author: No767

config.dist.yml

@@ -26,6 +26,14 @@ kanae:
     # Whether the Prometheus exporter is enabled or not
     enabled: False
 
+    # The host that the Prometheus exporter will bind to. By default,
+    # it will always be set to 127.0.0.1
+    host: "localhost"
+
+    # The port used for the Prometheus exporter. By default,
+    # it will always be set to 9555
+    port: 9555
+
   # Settings for Kanae's custom rate limiters
   limiter:
 

mise.toml

@@ -30,8 +30,8 @@ depends = ["server:docker:up"]
 alias = ["server:up", "server:dev"]
 description = "Start backend development server. Save file(s) to see changes through reloading"
 env._.path = ".venv/bin"
-dir = "{{ config_root }}/server"
-run = "uvicorn launcher:app --reload"
+dir = "{{ config_root }}"
+run = "uvicorn launcher:app --app-dir=server --reload"
 
 [tasks."server:lint"]
 description = "Lints the codebase by type checking and general linting"

server/core.py

@@ -157,7 +157,7 @@ def _decode_jsonb(value):
 class SupertokensQuerier(Querier):
     def __init__(self, recipe_id: str, *, config: KanaeConfig):
         super().__init__(
-            self._get_normalized_host_supertokens(config["auth"]["connection_uri"]),
+            self._get_normalized_host_supertokens(config.auth.connection_uri),
             recipe_id,
         )
 
@@ -463,15 +463,15 @@ def __init__(
         supertokens_init(
             app_info=InputAppInfo(
                 app_name="ucmacm-website",
-                api_domain=config["auth"]["api_domain"],
-                website_domain=config["auth"]["website_domain"],
+                api_domain=config.auth.api_domain,
+                website_domain=config.auth.website_domain,
                 api_base_path="/auth",
                 website_base_path="/auth",
             ),
             supertokens_config=SupertokensConfig(
                 # Force the first one for connection
-                connection_uri=config["auth"]["connection_uri"][0],
-                api_key=config["auth"]["api_key"],
+                connection_uri=config.auth.connection_uri[0],
+                api_key=config.auth.api_key,
             ),
             framework="fastapi",
             recipe_list=[
@@ -484,13 +484,13 @@ def __init__(
                                     third_party_id="google",
                                     clients=[
                                         ProviderClientConfig(
-                                            client_id=config["auth"]["providers"][
-                                                "google"
-                                            ]["client_id"],
-                                            client_secret=config["auth"]["providers"][
+                                            client_id=config.auth.providers["google"][
+                                                "client_id"
+                                            ],
+                                            client_secret=config.auth.providers[
                                                 "google"
                                             ]["client_secret"],
-                                            scope=config["auth"]["providers"]["google"][
+                                            scope=config.auth.providers["google"][
                                                 "scopes"
                                             ],
                                         ),
@@ -526,7 +526,7 @@ def __init__(
         self._logger = logging.getLogger("kanae.core")
 
         self.config = config
-        self.is_prometheus_enabled: bool = config["kanae"]["prometheus"]["enabled"]
+        self.is_prometheus_enabled: bool = config.kanae.prometheus["enabled"]
 
         _instrumentator_settings = InstrumentatorSettings(metric_namespace="kanae")
         self.instrumentator = PrometheusInstrumentator(
@@ -561,8 +561,8 @@ def __init__(
         )
 
         if self.is_prometheus_enabled:
-            _host = self.config["kanae"]["host"]
-            _port = self.config["kanae"]["port"]
+            _host = self.config.kanae.prometheus["host"]
+            _port = self.config.kanae.prometheus["port"]
 
             self.instrumentator.start()
 
@@ -658,7 +658,7 @@ async def lifespan(self, app: Self):
             )
 
         async with asyncpg.create_pool(
-            dsn=self.config["postgres_uri"], init=init
+            dsn=self.config.postgres_uri, init=init
         ) as app.pool:
             yield
 

server/launcher.py

@@ -1,23 +1,22 @@
-from pathlib import Path
-
 from core import Kanae
 from fastapi_pagination import add_pagination
 from routes import router
 from starlette.middleware.cors import CORSMiddleware
 from supertokens_python import get_all_cors_headers
 from supertokens_python.framework.fastapi import get_middleware
-from utils.config import KanaeConfig, KanaeUvicornConfig
+from utils.config import KanaeConfig, find_config
+from utils.uvicorn.config import KanaeUvicornConfig
 from utils.uvicorn.server import KanaeUvicornServer
 
-config_path = Path(__file__).parent / "config.yml"
-config = KanaeConfig(config_path)
+config = KanaeConfig.load_from_file(find_config())
+
 
 app = Kanae(config=config)
 app.add_middleware(get_middleware())
 app.include_router(router)
 app.add_middleware(
     CORSMiddleware,
-    allow_origins=config["auth"]["allowed_origins"],
+    allow_origins=config.auth.allowed_origins,
     allow_credentials=True,
     allow_methods=["GET", "PUT", "POST", "DELETE", "OPTIONS", "PATCH"],
     allow_headers=["Content-Type"] + get_all_cors_headers(),
@@ -32,8 +31,8 @@
 if __name__ == "__main__":
     config = KanaeUvicornConfig(
         "launcher:app",
-        port=config["kanae"]["port"],
-        host=config["kanae"]["host"],
+        port=config.kanae.host,
+        host=config.kanae.port,
         workers=2,
         access_log=True,
     )

server/tests/conftest.py

@@ -19,7 +19,7 @@
 from testcontainers.core.utils import raise_for_deprecated_parameter
 from testcontainers.core.waiting_utils import wait_container_is_ready, wait_for_logs
 from testcontainers.postgres import PostgresContainer
-from utils.config import KanaeConfig
+from utils.config import KanaeConfig, find_config
 from utils.limiter import get_remote_address
 from utils.limiter.extension import (
     KanaeLimiter,
@@ -40,9 +40,9 @@
 
 ROOT = Path(__file__).parents[2]
 DOCKERFILE_PATH = ROOT / "docker" / "pg-test" / "Dockerfile"
-CONFIG_PATH = ROOT / "server" / "config.yml"
+CONFIG_PATH = find_config()
 
-config = KanaeConfig(CONFIG_PATH)
+config = KanaeConfig.load_from_file(CONFIG_PATH)
 
 
 async def _async_rate_limit_exceeded_handler(request: Request, exc: RateLimitExceeded):
@@ -109,8 +109,8 @@ class KanaeServices(NamedTuple):
 class KanaeTestClient:
     def __init__(self, app: Kanae, *, base_url: Optional[str] = None):
         self._config = app.config
-        self._host = self._config["kanae"]["host"]
-        self._port = self._config["kanae"]["port"]
+        self._host = self._config.kanae.host
+        self._port = self._config.kanae.port
 
         self._transport = httpx.ASGITransport(app=app)
 
@@ -158,7 +158,7 @@ def valkey() -> Generator[ValkeyContainer, None, None]:
 async def app(
     get_app: Kanae, setup: KanaeServices
 ) -> AsyncGenerator[KanaeTestClient, None]:
-    get_app.config["postgres_uri"] = setup.postgres.get_connection_url(driver=None)
+    get_app.config.postgres_uri = setup.postgres.get_connection_url(driver=None)
     async with (
         LifespanManager(app=get_app),
         KanaeTestClient(app=get_app) as client,
@@ -177,8 +177,8 @@ async def build_fastapi_app(request, valkey: ValkeyContainer):
     def _factory(**limiter_args):
         middleware, exception_handler = request.param
 
-        test_config = KanaeConfig(CONFIG_PATH)
-        test_config["kanae"]["limiter"]["storage_uri"] = valkey.get_connection_url()
+        test_config = KanaeConfig.load_from_file(CONFIG_PATH)
+        test_config.kanae.limiter["storage_uri"] = valkey.get_connection_url()
 
         limiter_args.setdefault("key_func", get_remote_address)
         limiter_args.setdefault("config", test_config)