Resolve merge conflicts for Propagate main to stripe (#235)

chriscarrollsmith · github-actions · bhtabor · web-flow · commit 040f6348dc7b · 2026-07-29T16:59:42.000-04:00
* chore: release v1.1.8 [skip ci] Automatically generated by python-semantic-release * fix: engine too many connections (#231) * fix: engine too many connections Fix create_engine() connection leaks per request/call * refactor: use lru cached engine Use lru cached engine * add pool_pre_ping and dispose() * fix: address review feedback on engine cache - Route rate_limit.py through the shared get_engine() cache instead of its own module-level singleton, so no second unmanaged pool survives clear_engine_cache() or goes stale when the connection URL changes. - Guard the engine cache with a threading.Lock: sync dependencies run in FastAPI's threadpool, so concurrent first requests could race in get_engine() and orphan an undisposed engine, and clear_engine_cache() could hit a dict-mutated-during-iteration error. - Remove the clear_engine_cache() side effect from tear_down_db(); test fixtures that relied on it now call it explicitly in their teardown. - Make engine-cache tests isolation-safe via an engine_cache fixture so cleanup runs even when an assertion fails mid-test. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Rafiuzzaman Khan <rafiuzzamank@gmail.com> Co-authored-by: chriscarrollsmith <chriscarrollsmith@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: github-actions <actions@users.noreply.github.com> Co-authored-by: Biruk Haileye Tabor <biruk.haileye@gmail.com> Co-authored-by: Rafiuzzaman Khan <rafiuzzamank@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Christopher Carroll Smith <chriscarrollsmith@users.noreply.github.com>
diff --git a/.env.example b/.env.example
@@ -7,6 +7,10 @@ BASE_URL=http://localhost:8000
 # Database connection mode (0 = direct, 1 = pooled)
 USE_POOL=0
 
+# SQLAlchemy pool (per process; keep small when using PgBouncer)
+# DB_POOL_SIZE=5
+# DB_MAX_OVERFLOW=5
+
 # Shared database settings
 DB_HOST=127.0.0.1
 DB_SSLMODE=prefer
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- version list -->
 
+## v1.1.8 (2026-07-14)
+
+### Bug Fixes
+
+- **ci**: Keep Test workflow push triggers unfiltered
+  ([#229](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/pull/229),
+  [`2a88198`](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/commit/2a88198586079c45761afc69995a84586c76899d))
+
+### Code Style
+
+- **footer**: Improve site footer layout and typography
+  ([#226](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/pull/226),
+  [`85b5fe9`](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/commit/85b5fe92b266ae7459631c336275c82eeba3a610))
+
+### Documentation
+
+- Document stripe branch and add propagate/CI support
+  ([#229](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/pull/229),
+  [`2a88198`](https://github.com/Promptly-Technologies-LLC/fastapi-jinja2-postgres-webapp/commit/2a88198586079c45761afc69995a84586c76899d))
+
+
 ## v1.1.7 (2026-07-06)
 
 ### Bug Fixes
diff --git a/main.py b/main.py
@@ -50,7 +50,7 @@
 from routers.app import billing as billing_router
 from utils.app.credentials import validate_billing_environment
 from utils.app.billing import resolve_billing_nav_href, should_resolve_billing_nav
-from utils.core.db import set_up_db
+from utils.core.db import set_up_db, clear_engine_cache
 
 logger = logging.getLogger("uvicorn.error")
 logger.setLevel(logging.DEBUG)
@@ -62,6 +62,7 @@ async def lifespan(app: FastAPI):
     validate_billing_environment()
     set_up_db()
     yield
+    clear_engine_cache()
 
 
 # Initialize the FastAPI app
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-jinja2-postgres-webapp"
-version = "1.1.7"
+version = "1.1.8"
 description = "A template webapp with a pure-Python FastAPI backend, frontend templating with Jinja2, and a Postgres database to power user auth"
 readme = "README.md"
 package-mode = false
diff --git a/tests/browser/conftest.py b/tests/browser/conftest.py
@@ -8,6 +8,7 @@
 from playwright.sync_api import Browser, Page
 from tests.browser.db_helpers import browser_db_env
 from utils.core.db import (
+    clear_engine_cache,
     ensure_database_exists,
     get_connection_url,
     set_up_db,
@@ -160,6 +161,7 @@ def live_server(browser_env):
         proc.wait(timeout=5)
         with _temporary_env(browser_env):
             tear_down_db()
+        clear_engine_cache()
 
 
 @pytest.fixture(scope="session")
@@ -173,3 +175,4 @@ def live_server_csrf(browser_csrf_env):
         proc.wait(timeout=5)
         with _temporary_env(browser_csrf_env):
             tear_down_db()
+        clear_engine_cache()
diff --git a/tests/browser/db_helpers.py b/tests/browser/db_helpers.py
@@ -8,10 +8,10 @@
 from datetime import timedelta
 
 from dotenv import load_dotenv
-from sqlmodel import Session, create_engine, select
+from sqlmodel import Session, select
 
 from utils.core.auth import get_password_hash
-from utils.core.db import create_default_roles, get_connection_url
+from utils.core.db import create_default_roles, get_engine
 from utils.core.models import (
     Account,
     Invitation,
@@ -39,8 +39,7 @@ def browser_db_session():
     saved = {key: os.environ.get(key) for key in env}
     os.environ.update(env)
     try:
-        engine = create_engine(get_connection_url())
-        with Session(engine) as session:
+        with Session(get_engine()) as session:
             yield session
     finally:
         for key, value in saved.items():
@@ -168,8 +167,7 @@ def browser_csrf_db_session():
     saved = {key: os.environ.get(key) for key in env}
     os.environ.update(env)
     try:
-        engine = create_engine(get_connection_url())
-        with Session(engine) as session:
+        with Session(get_engine()) as session:
             yield session
     finally:
         for key, value in saved.items():
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -3,11 +3,13 @@
 from typing import Generator, cast
 
 pytest_plugins = ["tests.frontend.fixtures"]
-from sqlmodel import create_engine, Session, select
+from sqlmodel import Session, select
 from fastapi.testclient import TestClient
 from dotenv import load_dotenv
 from utils.core.db import (
+    clear_engine_cache,
     get_connection_url,
+    get_engine,
     tear_down_db,
     set_up_db,
     create_default_roles,
@@ -85,15 +87,19 @@ def engine(env_vars):
     Create a new SQLModel engine for the test database.
     Use PostgreSQL for testing to match production environment.
     """
-    # Use PostgreSQL for testing to match production environment
+    # Use PostgreSQL for testing to match production environment. get_engine()
+    # returns the same cached pool the app itself uses via get_session(), so
+    # TestClient requests and direct test queries share one pool instead of
+    # opening a second one for the same database.
     ensure_database_exists(get_connection_url())
-    engine = create_engine(get_connection_url())
+    engine = get_engine()
     set_up_db(drop=True)
 
     yield engine
 
     # Clean up after tests
     tear_down_db()
+    clear_engine_cache()
 
 
 @pytest.fixture
diff --git a/tests/utils/test_db.py b/tests/utils/test_db.py
@@ -3,6 +3,8 @@
 from sqlalchemy import Engine
 from utils.core.db import (
     get_connection_url,
+    get_engine,
+    clear_engine_cache,
     assign_permissions_to_role,
     create_default_roles,
     create_permissions,
@@ -147,6 +149,84 @@ def test_get_connection_url_missing_pool_vars(monkeypatch):
         get_connection_url()
 
 
+# --- Engine cache ---
+
+
+@pytest.fixture
+def engine_cache():
+    """Ensure engine-cache tests start clean and never leak cached engines,
+    even when an assertion fails mid-test."""
+    clear_engine_cache()
+    yield
+    clear_engine_cache()
+
+
+def _direct_db_env(monkeypatch, *, name: str = "testdb", password: str = "testpass"):
+    for var in (
+        "USE_POOL",
+        "DB_HOST",
+        "DB_PORT",
+        "DB_NAME",
+        "DB_USER",
+        "DB_PASSWORD",
+        "DB_POOL_PORT",
+        "DB_POOL_NAME",
+        "DB_APPUSER",
+        "DB_APPUSER_PASSWORD",
+        "DB_POOL_SIZE",
+        "DB_MAX_OVERFLOW",
+    ):
+        monkeypatch.delenv(var, raising=False)
+    monkeypatch.setenv("DB_HOST", "localhost")
+    monkeypatch.setenv("DB_PORT", "5432")
+    monkeypatch.setenv("DB_NAME", name)
+    monkeypatch.setenv("DB_USER", "testuser")
+    monkeypatch.setenv("DB_PASSWORD", password)
+
+
+def test_get_engine_reuses_same_instance(engine_cache, monkeypatch):
+    _direct_db_env(monkeypatch)
+    assert get_engine() is get_engine()
+
+
+def test_get_engine_different_urls_get_different_engines(engine_cache, monkeypatch):
+    _direct_db_env(monkeypatch, name="db_a")
+    engine_a = get_engine()
+    _direct_db_env(monkeypatch, name="db_b")
+    engine_b = get_engine()
+    assert engine_a is not engine_b
+
+
+def test_get_engine_not_keyed_by_masked_str_password(engine_cache, monkeypatch):
+    """str(URL) masks passwords; cache must still separate credentials."""
+    _direct_db_env(monkeypatch, password="secretA")
+    engine_a = get_engine()
+    assert "***" in str(get_connection_url())
+    _direct_db_env(monkeypatch, password="secretB")
+    engine_b = get_engine()
+    assert engine_a is not engine_b
+
+
+def test_clear_engine_cache_disposes_and_creates_new(engine_cache, monkeypatch):
+    _direct_db_env(monkeypatch)
+    first = get_engine()
+    clear_engine_cache()
+    second = get_engine()
+    assert first is not second
+
+
+def test_get_engine_applies_pool_settings(engine_cache, monkeypatch):
+    _direct_db_env(monkeypatch)
+    monkeypatch.setenv("DB_POOL_SIZE", "3")
+    monkeypatch.setenv("DB_MAX_OVERFLOW", "2")
+    engine = get_engine()
+    assert engine.pool.size() == 3
+    # No public accessors for these; private attrs are stable in practice but
+    # may need updating on a SQLAlchemy major upgrade.
+    assert engine.pool._max_overflow == 2
+    assert engine.pool._pre_ping is True
+
+
 # --- Permission and Role Tests ---
 
 
diff --git a/utils/core/auth.py b/utils/core/auth.py
@@ -13,7 +13,7 @@
 from fastapi.templating import Jinja2Templates
 from fastapi import Cookie
 from starlette.responses import Response
-from utils.core.db import create_engine, get_connection_url
+from utils.core.db import get_engine
 from utils.core.models import (
     AccountRecoveryToken,
     EmailVerificationToken,
@@ -339,8 +339,7 @@ def send_reset_email_task(email: str) -> None:
     FastAPI background tasks should not reuse request-scoped resources from
     `yield` dependencies, because cleanup may run before the task executes.
     """
-    engine = create_engine(get_connection_url())
-    with Session(engine) as session:
+    with Session(get_engine()) as session:
         send_reset_email(email, session)
 
 
diff --git a/utils/core/db.py b/utils/core/db.py
diff --git a/utils/core/dependencies.py b/utils/core/dependencies.py
diff --git a/utils/core/rate_limit.py b/utils/core/rate_limit.py
diff --git a/uv.lock b/uv.lock
