feat: Enhance CRUD repository with @transactional decorator for improved transaction management

- Added @transactional decorator to multiple CRUD methods in CrudRepository to ensure proper transaction handling.
- Updated commit logic in PySpringSession to warn against committing managed transactions.
- Refactored clone method in PySpringModel to return the correct type.
- Improved logging during session commit in PySpringModel for better clarity.
- Introduced a method in SessionContextHolder to check if a transaction is managed.

Author: William-W-Chen

py_spring_model/core/model.py

@@ -1,5 +1,4 @@
 import contextlib
-from typing_extensions import Self
 from typing import ClassVar, Iterator, Optional, Type
 from loguru import logger
 from sqlalchemy import Engine, MetaData
@@ -81,7 +80,7 @@ def get_model_lookup(cls) -> dict[str, type["PySpringModel"]]:
             raise ValueError("[MODEL_LOOKUP NOT SET] Model lookup is not set")
         return {str(_model.__tablename__): _model for _model in cls._models}
 
-    def clone(self) -> Self:
+    def clone(self) -> "PySpringModel":
         return self.model_validate_json(self.model_dump_json())
 
     @classmethod
@@ -105,11 +104,7 @@ def create_managed_session(cls, should_commit: bool = True) -> Iterator[PySpring
             logger.debug("[MANAGED SESSION COMMIT] Session committing...")
             if should_commit:
                 session.commit()
-            logger.debug(
-                "[MANAGED SESSION COMMIT] Session committed, refreshing instances..."
-            )
-            session.refresh_current_session_instances()
-            logger.success("[MANAGED SESSION COMMIT] Session committed.")
+                logger.success("[MANAGED SESSION COMMIT] Session committed.")
         except Exception as error:
             logger.error(error)
             logger.error("[MANAGED SESSION ROLLBACK] Session rolling back...")

py_spring_model/core/py_spring_session.py

@@ -1,5 +1,6 @@
 from typing import Iterable
 
+from loguru import logger
 from sqlmodel import Session, SQLModel
 
 
@@ -33,3 +34,12 @@ def add_all(self, instances: Iterable[SQLModel]) -> None:
     def refresh_current_session_instances(self) -> None:
         for instance in self.current_session_instance:
             self.refresh(instance)
+
+    def commit(self) -> None:
+        # Import here to avoid circular import
+        from py_spring_model.core.session_context_holder import SessionContextHolder
+        if SessionContextHolder.is_transaction_managed():
+            logger.warning("Commiting a transaction that is currently being managed by the outermost transaction is strongly discouraged...")
+            return
+        super().commit()
+        self.refresh_current_session_instances()

py_spring_model/core/session_context_holder.py

@@ -3,9 +3,8 @@
 from functools import wraps
 from typing import Any, Callable, ClassVar, Optional
 
-from py_spring_model.core.py_spring_session import PySpringSession
-
 from py_spring_model.core.model import PySpringModel
+from py_spring_model.core.py_spring_session import PySpringSession
 
 class TransactionalDepth(IntEnum):
     OUTERMOST = 1
@@ -131,4 +130,8 @@ def clear_session(cls):
         if session is not None:
             session.close()
         cls._session.set(None)
-        cls._session_depth.set(TransactionalDepth.ON_EXIT.value)
+        cls._session_depth.set(TransactionalDepth.ON_EXIT.value)
+
+    @classmethod
+    def is_transaction_managed(cls) -> bool:
+        return cls._session_depth.get() > TransactionalDepth.OUTERMOST.value

py_spring_model/repository/crud_repository.py

@@ -59,6 +59,7 @@ def __init__(self) -> None:
     def _get_model_id_type_with_class(cls) -> tuple[Type[ID], Type[T]]:
         return get_args(tp=cls.__mro__[0].__orig_bases__[0])
 
+    @Transactional
     def _find_by_statement(
         self,
         statement: Union[Select, SelectOfScalar],
@@ -67,7 +68,7 @@ def _find_by_statement(
 
         return session.exec(statement).first()
 
-
+    @Transactional
     def _find_by_query(
         self,
         query_by: dict[str, Any],
@@ -76,6 +77,8 @@ def _find_by_query(
         statement = select(self.model_class).filter_by(**query_by)
         return session.exec(statement).first()
 
+
+    @Transactional
     def _find_all_by_query(
         self,
         query_by: dict[str, Any],
@@ -84,13 +87,15 @@ def _find_all_by_query(
         statement = select(self.model_class).filter_by(**query_by)
         return session, list(session.exec(statement).fetchall())
 
+    @Transactional
     def _find_all_by_statement(
         self,
         statement: Union[Select, SelectOfScalar],
     ) -> list[T]:
         session = SessionContextHolder.get_or_create_session()
         return list(session.exec(statement).fetchall())
 
+    @Transactional
     def find_by_id(self, id: ID) -> Optional[T]:
         session = SessionContextHolder.get_or_create_session()
         statement = select(self.model_class).where(self.model_class.id == id)  # type: ignore
@@ -99,11 +104,14 @@ def find_by_id(self, id: ID) -> Optional[T]:
             return
 
         return optional_entity
+    
+    @Transactional
     def find_all_by_ids(self, ids: list[ID]) -> list[T]:
         session = SessionContextHolder.get_or_create_session()
         statement = select(self.model_class).where(self.model_class.id.in_(ids))  # type: ignore
         return [entity for entity in session.exec(statement).all()]  # type: ignore
 
+    @Transactional
     def find_all(self) -> list[T]:
         session = SessionContextHolder.get_or_create_session()
         statement = select(self.model_class)  # type: ignore

tests/test_crud_repository.py

@@ -135,4 +135,17 @@ def test_upsert_for_new_user(self, user_repository: UserRepository):
         new_user = user_repository.find_by_id(1)
         assert new_user is not None
         assert new_user.name == "John Doe"
-        assert new_user.email == "john@example.com"
+        assert new_user.email == "john@example.com"
+
+    def test_update_user(self, user_repository: UserRepository):
+        self.create_test_user(user_repository)
+        user = user_repository.find_by_id(1)
+        assert user is not None
+        user.name = "William Chen"
+        user.email = "william.chen@example.com"
+        user_repository.save(user)
+        updated_user = user_repository.find_by_id(1)
+        assert updated_user is not None
+        assert updated_user.name == "William Chen"
+        assert updated_user.email == "william.chen@example.com"
+