♻️ Simplify database readiness checks (#2460)

backend/README.md

@@ -78,7 +78,7 @@ If your stack is already up and you just want to run the tests, you can use:
 docker compose exec backend bash scripts/tests-start.sh
 ```
 
-The `/app/backend/scripts/tests-start.sh` script calls `pytest` after making sure that the rest of the stack is running. If you need to pass extra arguments to `pytest`, you can pass them to that command and they will be forwarded.
+The `/app/backend/scripts/tests-start.sh` script calls `pytest`. If you need to pass extra arguments to `pytest`, you can pass them to that command and they will be forwarded.
 
 For example, to stop on first error:
 

backend/app/backend_pre_start.py

@@ -1,39 +0,0 @@
-import logging
-
-from sqlalchemy import Engine
-from sqlmodel import Session, select
-from tenacity import after_log, before_log, retry, stop_after_attempt, wait_fixed
-
-from app.core.db import engine
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-max_tries = 60 * 5  # 5 minutes
-wait_seconds = 1
-
-
-@retry(
-    stop=stop_after_attempt(max_tries),
-    wait=wait_fixed(wait_seconds),
-    before=before_log(logger, logging.INFO),
-    after=after_log(logger, logging.WARN),
-)
-def init(db_engine: Engine) -> None:
-    try:
-        with Session(db_engine) as session:
-            # Try to create session to check if DB is awake
-            session.exec(select(1))
-    except Exception as e:
-        logger.error(e)
-        raise e
-
-
-def main() -> None:
-    logger.info("Initializing service")
-    init(engine)
-    logger.info("Service finished initializing")
-
-
-if __name__ == "__main__":
-    main()

backend/app/core/db.py

@@ -4,7 +4,7 @@ from app import crud
 from app.core.config import settings
 from app.models import User, UserCreate
 
-engine = create_engine(str(settings.DATABASE_URL))
+engine = create_engine(str(settings.DATABASE_URL), pool_pre_ping=True)
 
 
 # make sure all SQLModel models are imported (app.models) before initializing DB

backend/app/tests_pre_start.py

@@ -1,39 +0,0 @@
-import logging
-
-from sqlalchemy import Engine
-from sqlmodel import Session, select
-from tenacity import after_log, before_log, retry, stop_after_attempt, wait_fixed
-
-from app.core.db import engine
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
-
-max_tries = 60 * 5  # 5 minutes
-wait_seconds = 1
-
-
-@retry(
-    stop=stop_after_attempt(max_tries),
-    wait=wait_fixed(wait_seconds),
-    before=before_log(logger, logging.INFO),
-    after=after_log(logger, logging.WARN),
-)
-def init(db_engine: Engine) -> None:
-    try:
-        # Try to create session to check if DB is awake
-        with Session(db_engine) as session:
-            session.exec(select(1))
-    except Exception as e:
-        logger.error(e)
-        raise e
-
-
-def main() -> None:
-    logger.info("Initializing service")
-    init(engine)
-    logger.info("Service finished initializing")
-
-
-if __name__ == "__main__":
-    main()

backend/pyproject.toml

@@ -7,7 +7,6 @@ dependencies = [
     "fastapi[standard]>=0.141.1,<1.0.0",
     "python-multipart<1.0.0,>=0.0.27",
     "email-validator<3.0.0.0,>=2.1.0.post1",
-    "tenacity<10.0.0,>=8.2.3",
     "pydantic>2.0",
     "emails>=1.1.2,<2.0",
     "jinja2<4.0.0,>=3.1.4",

backend/scripts/prestart.sh

@@ -3,9 +3,6 @@
 set -e
 set -x
 
-# Let the DB start
-python app/backend_pre_start.py
-
 # Run migrations
 alembic upgrade head
 

backend/scripts/tests-start.sh

@@ -2,6 +2,4 @@
 set -e
 set -x
 
-python app/tests_pre_start.py
-
 bash scripts/test.sh "$@"

backend/tests/scripts/test_backend_pre_start.py

@@ -1,33 +0,0 @@
-from unittest.mock import MagicMock, patch
-
-from sqlmodel import select
-
-from app.backend_pre_start import init, logger
-
-
-def test_init_successful_connection() -> None:
-    engine_mock = MagicMock()
-
-    session_mock = MagicMock()
-    session_mock.__enter__.return_value = session_mock
-
-    select1 = select(1)
-
-    with (
-        patch("app.backend_pre_start.Session", return_value=session_mock),
-        patch("app.backend_pre_start.select", return_value=select1),
-        patch.object(logger, "info"),
-        patch.object(logger, "error"),
-        patch.object(logger, "warn"),
-    ):
-        try:
-            init(engine_mock)
-            connection_successful = True
-        except Exception:
-            connection_successful = False
-
-        assert connection_successful, (
-            "The database connection should be successful and not raise an exception."
-        )
-
-        session_mock.exec.assert_called_once_with(select1)

backend/tests/scripts/test_test_pre_start.py

@@ -1,33 +0,0 @@
-from unittest.mock import MagicMock, patch
-
-from sqlmodel import select
-
-from app.tests_pre_start import init, logger
-
-
-def test_init_successful_connection() -> None:
-    engine_mock = MagicMock()
-
-    session_mock = MagicMock()
-    session_mock.__enter__.return_value = session_mock
-
-    select1 = select(1)
-
-    with (
-        patch("app.tests_pre_start.Session", return_value=session_mock),
-        patch("app.tests_pre_start.select", return_value=select1),
-        patch.object(logger, "info"),
-        patch.object(logger, "error"),
-        patch.object(logger, "warn"),
-    ):
-        try:
-            init(engine_mock)
-            connection_successful = True
-        except Exception:
-            connection_successful = False
-
-        assert connection_successful, (
-            "The database connection should be successful and not raise an exception."
-        )
-
-        session_mock.exec.assert_called_once_with(select1)