Refactor CRUD Operations to Utilize SessionContextHolder for Session Management

- Updated CRUD methods in `PySpringModelRestService` and `CrudRepositoryImplementationService` to use `SessionContextHolder` for session handling, replacing the previous context manager approach.
- Added `@Transactional` decorator to relevant methods to ensure proper transaction management.
- Enhanced error handling in the `Transactional` decorator to raise specific exceptions.
- Updated tests to clear session state before and after tests to maintain isolation and prevent side effects.

Author: William-W-Chen

py_spring_model/core/session_context_holder.py

@@ -18,9 +18,9 @@ def wrapper(*args, **kwargs):
             result = func(*args, **kwargs)
             session.commit()
             return result
-        except Exception:
+        except Exception as error:
             session.rollback()
-            raise
+            raise error
         finally:
             SessionContextHolder.clear_session()
     return wrapper

py_spring_model/py_spring_model_provider.py

@@ -148,7 +148,7 @@ def provider_init(self) -> None:
 def provide_py_spring_model() -> EntityProvider:
     return PySpringModelProvider(
         rest_controller_classes=[
-            # PySpringModelRestController
+            PySpringModelRestController
         ],
         component_classes=[
             PySpringModelRestService,

py_spring_model/py_spring_model_rest/service/curd_repository_implementation_service/crud_repository_implementation_service.py

@@ -19,6 +19,7 @@
 from sqlmodel.sql.expression import SelectOfScalar
 
 from py_spring_model.core.model import PySpringModel
+from py_spring_model.core.session_context_holder import SessionContextHolder, Transactional
 from py_spring_model.repository.crud_repository import CrudRepository
 from py_spring_model.py_spring_model_rest.service.curd_repository_implementation_service.method_query_builder import (
     _MetodQueryBuilder,
@@ -150,14 +151,15 @@ def _get_sql_statement(
             query = query.where(filter_condition_stack.pop())
         return query
 
+    @Transactional
     def _session_execute(self, statement: SelectOfScalar, is_one_result: bool) -> Any:
-        with PySpringModel.create_session() as session:
-            logger.debug(f"Executing query: \n{str(statement)}")
-            result = (
-                session.exec(statement).first()
-                if is_one_result
-                else session.exec(statement).fetchall()
-            )
+        session = SessionContextHolder.get_or_create_session()
+        logger.debug(f"Executing query: \n{str(statement)}")
+        result = (
+            session.exec(statement).first()
+            if is_one_result
+            else session.exec(statement).fetchall()
+        )
         return result
 
     def post_construct(self) -> None:

py_spring_model/py_spring_model_rest/service/py_spring_model_rest_service.py

@@ -4,6 +4,7 @@
 from py_spring_core import Component
 
 from py_spring_model import PySpringModel
+from py_spring_model.core.session_context_holder import SessionContextHolder, Transactional
 
 ID = TypeVar("ID", int, UUID)
 ModelT = TypeVar("ModelT", bound=PySpringModel)
@@ -20,44 +21,48 @@ class PySpringModelRestService(Component):
      5. Updating an existing model,
      6. Deleting a model by ID.
     """
-
     def get_all_models(self) -> dict[str, type[PySpringModel]]:
         return PySpringModel.get_model_lookup()
 
+    @Transactional
     def get(self, model_type: Type[ModelT], id: ID) -> Optional[ModelT]:
-        with PySpringModel.create_managed_session() as session:
-            return session.get(model_type, id)  # type: ignore
+        session = SessionContextHolder.get_or_create_session()
+        return session.get(model_type, id)  # type: ignore
 
+    @Transactional
     def get_all_by_ids(self, model_type: Type[ModelT], ids: list[ID]) -> list[ModelT]:
-        with PySpringModel.create_managed_session() as session:
-            return session.query(model_type).filter(model_type.id.in_(ids)).all()  # type: ignore
-
+        session = SessionContextHolder.get_or_create_session()
+        return session.query(model_type).filter(model_type.id.in_(ids)).all()  # type: ignore
+    @Transactional
     def get_all(
         self, model_type: Type[ModelT], limit: int, offset: int
     ) -> list[ModelT]:
-        with PySpringModel.create_managed_session() as session:
-            return session.query(model_type).offset(offset).limit(limit).all()
+        session = SessionContextHolder.get_or_create_session()
+        return session.query(model_type).offset(offset).limit(limit).all()
 
+    @Transactional
     def create(self, model: ModelT) -> ModelT:
-        with PySpringModel.create_managed_session() as session:
-            session.add(model)
-            return model
+        session = SessionContextHolder.get_or_create_session()
+        session.add(model)
+        return model
 
+    @Transactional
     def update(self, id: ID, model: ModelT) -> Optional[ModelT]:
-        with PySpringModel.create_managed_session() as session:
-            model_type = type(model)
-            primary_keys = PySpringModel.get_primary_key_columns(model_type)
-            optional_model = session.get(model_type, id)  # type: ignore
-            if optional_model is None:
-                return
-
-            for key, value in model.model_dump().items():
-                if key in primary_keys:
-                    continue
-                setattr(optional_model, key, value)
-            session.add(optional_model)
+        session = SessionContextHolder.get_or_create_session()
+        model_type = type(model)
+        primary_keys = PySpringModel.get_primary_key_columns(model_type)
+        optional_model = session.get(model_type, id)  # type: ignore
+        if optional_model is None:
+            return
+
+        for key, value in model.model_dump().items():
+            if key in primary_keys:
+                continue
+            setattr(optional_model, key, value)
+        session.add(optional_model)
 
+    @Transactional
     def delete(self, model_type: Type[ModelT], id: ID) -> None:
-        with PySpringModel.create_managed_session() as session:
-            session.query(model_type).filter(model_type.id == id).delete()  # type: ignore
-            session.commit()
+        session = SessionContextHolder.get_or_create_session()
+        session.query(model_type).filter(model_type.id == id).delete()  # type: ignore
+        session.commit()

tests/test_crud_repository.py

@@ -4,6 +4,7 @@
 from sqlmodel import Field, SQLModel
 
 from py_spring_model import PySpringModel
+from py_spring_model.core.session_context_holder import SessionContextHolder
 from py_spring_model.repository.crud_repository import CrudRepository
 
 class User(PySpringModel, table=True):
@@ -19,11 +20,13 @@ def setup_method(self):
         logger.info("Setting up test environment...")
         self.engine = create_engine("sqlite:///:memory:", echo=True)
         PySpringModel._engine = self.engine
+        SessionContextHolder.clear_session()
         SQLModel.metadata.create_all(self.engine)
 
     def teardown_method(self):
         logger.info("Tearing down test environment...")
         SQLModel.metadata.drop_all(self.engine)
+        SessionContextHolder.clear_session()
 
     @pytest.fixture
     def user_repository(self):

tests/test_crud_repository_implementation_service.py

@@ -6,6 +6,7 @@
 from sqlalchemy import create_engine
 from sqlmodel import SQLModel
 from py_spring_model import PySpringModel, Field, CrudRepository, Query
+from py_spring_model.core.session_context_holder import SessionContextHolder
 from py_spring_model.py_spring_model_rest.service.curd_repository_implementation_service.crud_repository_implementation_service import CrudRepositoryImplementationService
 from py_spring_model.py_spring_model_rest.service.curd_repository_implementation_service.method_query_builder import _MetodQueryBuilder
 
@@ -32,11 +33,13 @@ def setup_method(self):
         logger.info("Setting up test environment...")
         self.engine = create_engine("sqlite:///:memory:", echo=True)
         PySpringModel._engine = self.engine
+        SessionContextHolder.clear_session()
         SQLModel.metadata.create_all(self.engine)
 
     def teardown_method(self):
         logger.info("Tearing down test environment...")
         SQLModel.metadata.drop_all(self.engine)
+        SessionContextHolder.clear_session()
 
     @pytest.fixture
     def user_repository(self):

tests/test_query_modifying_operations.py

@@ -6,6 +6,7 @@
 from unittest.mock import patch, MagicMock
 
 from py_spring_model import PySpringModel
+from py_spring_model.core.session_context_holder import SessionContextHolder
 from py_spring_model.py_spring_model_rest.service.query_service.query import Query, QueryExecutionService
 from py_spring_model.repository.crud_repository import CrudRepository
 
@@ -88,14 +89,17 @@ def setup_method(self):
         PySpringModel.set_engine(self.engine)
         PySpringModel.set_metadata(SQLModel.metadata)
         PySpringModel.set_models([TestUser])
+        SessionContextHolder.clear_session()
         SQLModel.metadata.create_all(self.engine)
         self.repository = TestUserRepository()
+       
         self.repository.insert_user_with_commit(name="John Doe", email="john@example.com", age=30)
 
     def teardown_method(self):
         """Clean up test environment"""
         logger.info("Tearing down test environment...")
         SQLModel.metadata.drop_all(self.engine)
+        SessionContextHolder.clear_session()
 
     def test_insert_with_commit_true(self):
         """Test INSERT operation with is_modifying=True (should commit)"""