Skip to content

Commit f506303

Browse files
authored
feat: provide settings through the container and derive engine URLs (#81)
Engines take Settings from ioc.Config.settings and get their URL via provider.derive, so tests override settings instead of monkeypatching the module-level instance. Requires modern-di 4.3.0.
1 parent c1e18cd commit f506303

9 files changed

Lines changed: 55 additions & 47 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class ListDecksUseCase:
6767

6868
**Migrations**: `migrations/env.py` reads `app.models.METADATA` and rewrites the DSN driver from `postgresql+asyncpg` to `postgresql+psycopg` (Alembic runs on sync psycopg 3). Always run autogen against an upgraded DB; `just migration` enforces this.
6969

70-
**Settings** (`app/settings.py`): `pydantic_settings.BaseSettings` reads from env vars (see `docker-compose.yml` for `SERVICE_DEBUG`, `SERVICE_ENVIRONMENT`, `DB_DSN`; `DB_REPLICA_DSN` is optional). Pool and server sizing uses `DB_POOL_SIZE`, `DB_MAX_OVERFLOW`, `DB_POOL_TIMEOUT`, `DB_POOL_RECYCLE` and `APP_WORKERS` (see **Pool and server sizing**). `api_bootstrapper_config` builds the `LitestarConfig` consumed by `lite-bootstrap`.
70+
**Settings** (`app/settings.py`): `pydantic_settings.BaseSettings` reads from env vars (see `docker-compose.yml` for `SERVICE_DEBUG`, `SERVICE_ENVIRONMENT`, `DB_DSN`; `DB_REPLICA_DSN` is optional). Pool and server sizing uses `DB_POOL_SIZE`, `DB_MAX_OVERFLOW`, `DB_POOL_TIMEOUT`, `DB_POOL_RECYCLE` and `APP_WORKERS` (see **Pool and server sizing**). `api_bootstrapper_config` builds the `LitestarConfig` consumed by `lite-bootstrap`. Components get settings from the container through `ioc.Config.settings`. The engines take the whole object and get their URL from `Config.settings.derive(...)`, so a test can change their config with `container.override(ioc.Config.settings, Settings(...))` on a container that has not built the engines yet, since the engines are cached. `app/__main__.py`, `migrations/env.py` and `build_app` read the module-level `settings` instead, because they run outside the container or before it exists.
7171

7272
## Conventions
7373

‎app/ioc.py‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@
99
choose_sa_engine,
1010
close_sa_engine,
1111
close_session,
12-
create_primary_sa_engine,
13-
create_read_sa_engine,
12+
create_sa_engine,
1413
create_session,
14+
read_engine_url,
1515
)
16+
from app.settings import Settings
1617
from app.use_cases.create_cards import CreateCardsUseCase
1718
from app.use_cases.create_deck import CreateDeckUseCase
1819
from app.use_cases.get_card import GetCardUseCase
@@ -23,16 +24,22 @@
2324
from app.use_cases.update_deck import UpdateDeckUseCase
2425

2526

27+
class Config(Group):
28+
settings = providers.Factory(creator=Settings, cache=True)
29+
30+
2631
class Database(Group):
2732
database_engine = providers.Factory(
28-
creator=create_primary_sa_engine,
33+
creator=create_sa_engine,
2934
cache=providers.CacheSettings(finalizer=close_sa_engine),
3035
bound_type=None,
36+
kwargs={"settings": Config.settings, "url": Config.settings.derive(lambda s: s.db_dsn_parsed)},
3137
)
3238
database_read_engine = providers.Factory(
33-
creator=create_read_sa_engine,
39+
creator=create_sa_engine,
3440
cache=providers.CacheSettings(finalizer=close_sa_engine),
3541
bound_type=None,
42+
kwargs={"settings": Config.settings, "url": Config.settings.derive(read_engine_url), "read_only": True},
3643
)
3744
dynamic_engine = providers.Factory(
3845
scope=Scope.REQUEST,
@@ -85,4 +92,4 @@ class UseCases(Group, scope=Scope.REQUEST):
8592
update_cards_use_case = providers.Factory(creator=UpdateCardsUseCase)
8693

8794

88-
ALL_GROUPS: typing.Final[list[type[Group]]] = [Database, Repositories, UseCases]
95+
ALL_GROUPS: typing.Final[list[type[Group]]] = [Config, Database, Repositories, UseCases]

‎app/resources/db.py‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from sqlalchemy.engine.url import URL, make_url
88
from sqlalchemy.ext import asyncio as sa
99

10-
from app.settings import settings
10+
from app.settings import Settings
1111

1212

1313
logger = logging.getLogger(__name__)
@@ -16,7 +16,7 @@
1616
READ_METHODS: typing.Final = frozenset({"GET", "HEAD"})
1717

1818

19-
def create_sa_engine(url: URL, *, read_only: bool = False) -> sa.AsyncEngine:
19+
def create_sa_engine(*, settings: Settings, url: URL, read_only: bool = False) -> sa.AsyncEngine:
2020
return sa.create_async_engine(
2121
url=url,
2222
echo=settings.service_debug,
@@ -31,15 +31,8 @@ def create_sa_engine(url: URL, *, read_only: bool = False) -> sa.AsyncEngine:
3131
)
3232

3333

34-
def create_primary_sa_engine() -> sa.AsyncEngine:
35-
return create_sa_engine(settings.db_dsn_parsed)
36-
37-
38-
def create_read_sa_engine() -> sa.AsyncEngine:
39-
return create_sa_engine(
40-
make_url(settings.db_replica_dsn) if settings.db_replica_dsn else settings.db_dsn_parsed,
41-
read_only=True,
42-
)
34+
def read_engine_url(settings: Settings) -> URL:
35+
return make_url(settings.db_replica_dsn) if settings.db_replica_dsn else settings.db_dsn_parsed
4336

4437

4538
def autocommit_isolation_level() -> IsolationLevel | None:

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ license = "MIT"
1111
dependencies = [
1212
"litestar",
1313
"lite-bootstrap[litestar-all]>=1.13",
14+
"modern-di>=4.3.0,<5",
1415
"modern-di-litestar>=4,<5",
1516
"advanced-alchemy",
1617
"pydantic-settings",

‎tests/conftest.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010

1111
from app import ioc
1212
from app.application import build_app
13-
from app.resources.db import create_primary_sa_engine, create_session
13+
from app.resources.db import create_sa_engine, create_session
14+
from app.settings import settings
1415

1516

1617
if typing.TYPE_CHECKING:
@@ -50,7 +51,7 @@ async def di_container(app: litestar.Litestar) -> typing.AsyncIterator[modern_di
5051

5152
@pytest.fixture
5253
async def db_session(di_container: modern_di.Container) -> typing.AsyncIterator[AsyncSession]:
53-
engine = create_primary_sa_engine()
54+
engine = create_sa_engine(settings=settings, url=settings.db_dsn_parsed)
5455
connection = await engine.connect()
5556
transaction = await connection.begin()
5657
di_container.override(ioc.Database.dynamic_engine, connection)
@@ -97,7 +98,7 @@ def record(*args: object) -> None:
9798

9899
@pytest.fixture
99100
async def committing_engine(di_container: modern_di.Container) -> typing.AsyncIterator[AsyncEngine]:
100-
engine = create_primary_sa_engine()
101+
engine = create_sa_engine(settings=settings, url=settings.db_dsn_parsed)
101102
di_container.override(ioc.Database.dynamic_engine, engine)
102103
try:
103104
yield engine

‎tests/test_create_deck.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
from app import models, schemas
1010
from app.repositories import DecksRepository
11-
from app.resources.db import create_primary_sa_engine, create_session
11+
from app.resources.db import create_sa_engine, create_session
12+
from app.settings import settings
1213
from app.use_cases.create_deck import CreateDeckUseCase
1314

1415

@@ -23,7 +24,7 @@ async def _wait_until_blocked_on_a_lock(engine: AsyncEngine, pid: int) -> None:
2324

2425

2526
async def test_create_deck_returns_the_deck_a_concurrent_request_created_with_the_same_key() -> None:
26-
engine: typing.Final = create_primary_sa_engine()
27+
engine: typing.Final = create_sa_engine(settings=settings, url=settings.db_dsn_parsed)
2728
idempotency_key: typing.Final = uuid.uuid4()
2829
try:
2930
async with engine.connect() as concurrent_request:

‎tests/test_db_routing.py‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
11
import typing
22

33
import litestar
4+
import modern_di
45
import pytest
56
import sqlalchemy as sa
67
from litestar.enums import HttpMethod
78
from litestar.testing import RequestFactory
89
from modern_di import Scope
10+
from sqlalchemy.engine.url import URL
911
from sqlalchemy.exc import DBAPIError
1012

1113
from app import ioc, models
12-
from app.resources.db import create_read_sa_engine, create_sa_engine
13-
from app.settings import settings
14+
from app.resources.db import create_sa_engine, read_engine_url
15+
from app.settings import Settings, settings
1416

1517

1618
if typing.TYPE_CHECKING:
17-
import modern_di
1819
from sqlalchemy.ext.asyncio import AsyncEngine
1920

2021

2122
@pytest.fixture
2223
async def primary_engine(di_container: modern_di.Container) -> typing.AsyncIterator[AsyncEngine]:
23-
engine = create_sa_engine(settings.db_dsn_parsed)
24+
engine = create_sa_engine(settings=settings, url=settings.db_dsn_parsed)
2425
di_container.override(ioc.Database.database_engine, engine)
2526
yield engine
2627
await engine.dispose()
2728

2829

2930
@pytest.fixture
3031
async def read_engine(di_container: modern_di.Container) -> typing.AsyncIterator[AsyncEngine]:
31-
engine = create_read_sa_engine()
32+
engine = create_sa_engine(settings=settings, url=read_engine_url(settings), read_only=True)
3233
di_container.override(ioc.Database.database_read_engine, engine)
3334
yield engine
3435
await engine.dispose()
@@ -69,21 +70,26 @@ def test_no_request_uses_primary(di_container: modern_di.Container, primary_engi
6970
assert resolve_engine(di_container, None) is primary_engine
7071

7172

73+
async def resolve_read_engine_url(app_settings: Settings) -> URL:
74+
container: typing.Final = modern_di.Container(groups=ioc.ALL_GROUPS)
75+
container.override(ioc.Config.settings, app_settings)
76+
try:
77+
return container.resolve_provider(ioc.Database.database_read_engine).url
78+
finally:
79+
await container.close_async()
80+
81+
7282
async def test_read_engine_built_from_primary_dsn_without_replica() -> None:
73-
engine = create_read_sa_engine()
74-
assert engine.url == settings.db_dsn_parsed
75-
await engine.dispose()
83+
assert await resolve_read_engine_url(Settings(db_replica_dsn="")) == settings.db_dsn_parsed
7684

7785

78-
async def test_read_engine_built_from_replica_dsn(monkeypatch: pytest.MonkeyPatch) -> None:
79-
monkeypatch.setattr(settings, "db_replica_dsn", "postgresql+asyncpg://postgres:password@replica/postgres")
80-
engine = create_read_sa_engine()
81-
assert engine.url.host == "replica"
82-
await engine.dispose()
86+
async def test_read_engine_built_from_overridden_replica_dsn() -> None:
87+
replica_settings: typing.Final = Settings(db_replica_dsn="postgresql+asyncpg://postgres:password@replica/postgres")
88+
assert (await resolve_read_engine_url(replica_settings)).host == "replica"
8389

8490

8591
async def test_read_engine_runs_each_statement_in_its_own_transaction() -> None:
86-
engine = create_read_sa_engine()
92+
engine = create_sa_engine(settings=settings, url=read_engine_url(settings), read_only=True)
8793
async with engine.connect() as connection:
8894
first = await connection.scalar(sa.text("SELECT transaction_timestamp()"))
8995
second = await connection.scalar(sa.text("SELECT transaction_timestamp()"))
@@ -92,7 +98,7 @@ async def test_read_engine_runs_each_statement_in_its_own_transaction() -> None:
9298

9399

94100
async def test_read_engine_rejects_writes() -> None:
95-
engine = create_read_sa_engine()
101+
engine = create_sa_engine(settings=settings, url=read_engine_url(settings), read_only=True)
96102
async with engine.connect() as connection:
97103
with pytest.raises(DBAPIError, match="read-only transaction"):
98104
await connection.execute(sa.insert(models.Deck).values(name="read only"))

‎tests/test_pool.py‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
from litestar import status_codes as status
66

77
from app import ioc
8-
from app.resources.db import create_primary_sa_engine
9-
from app.settings import settings
8+
from app.resources.db import create_sa_engine
9+
from app.settings import Settings
1010
from tests import factories
1111

1212

@@ -25,13 +25,10 @@
2525
async def test_exhausted_pool_returns_503(
2626
client: AsyncClient,
2727
di_container: modern_di.Container,
28-
monkeypatch: pytest.MonkeyPatch,
2928
request_kwargs: dict[str, typing.Any],
3029
) -> None:
31-
monkeypatch.setattr(settings, "db_pool_size", 1)
32-
monkeypatch.setattr(settings, "db_max_overflow", 0)
33-
monkeypatch.setattr(settings, "db_pool_timeout", 0.1)
34-
engine: typing.Final = create_primary_sa_engine()
30+
pool_settings: typing.Final = Settings(db_pool_size=1, db_max_overflow=0, db_pool_timeout=0.1)
31+
engine: typing.Final = create_sa_engine(settings=pool_settings, url=pool_settings.db_dsn_parsed)
3532
di_container.override(ioc.Database.dynamic_engine, engine)
3633
try:
3734
async with engine.connect():

‎uv.lock‎

Lines changed: 5 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)