fixed hobbit_core.db.transaction

Author: legolas.zhan

hobbit_core/db.py

@@ -306,7 +306,7 @@ def transaction(session: Session, nested: bool = False):
     """SQLAlchemy 1.4 deprecates “autocommit mode.
     See more: https://docs.sqlalchemy.org/en/14/orm/session_transaction.html
 
-    2022-05-18 Updated: Use `nested=None` to prevent signal bug, See more:
+    2024-09-25 ignore signal bug, See more:
     https://github.com/pallets-eco/flask-sqlalchemy/issues/645
 
     Tips:
@@ -355,22 +355,15 @@ def create(username, password):
     def wrapper(func):
         @wraps(func)
         def inner(*args, **kwargs):
-            if getattr(session, 'autocommit') is True and nested is False:
-                session.begin()  # start a transaction
             try:
-                if nested is None:
-                    resp = func(*args, **kwargs)
-                else:
+                if nested:
                     with session.begin_nested():
-                        resp = func(*args, **kwargs)
-                if not nested:
-                    # commit - begin(), transaction finished
-                    session.commit()
+                        return func(*args, **kwargs)
+                else:
+                    with session.begin():
+                        return func(*args, **kwargs)
             except Exception as e:
-                if not nested:
-                    session.rollback()
-                    session.remove()
+                session.rollback()
                 raise e
-            return resp
         return inner
     return wrapper

hobbit_core/utils.py

@@ -300,7 +300,8 @@ def bulk_create_or_update_on_duplicate(
     while len(items) > 0:
         batch, items = items[:batch_size], items[batch_size:]
         try:
-            result = db.session.execute(text(sql), batch, bind_arguments={'bind': engine})
+            result = db.session.execute(
+                text(sql), batch, bind_arguments={'bind': engine})
         except Exception as e:
             logger.error(e, exc_info=True)
             logger.info(sql)

tests/conftest.py

@@ -29,7 +29,6 @@ def assert_session(app):
         conn = tdb.engine.connect()
         options = dict(bind=conn, binds={})
         sess = tdb._make_scoped_session(options=options)
-        assert sess.autocommit is False
         yield sess
         sess.remove()
 
@@ -38,7 +37,6 @@ def assert_session(app):
 def db_session(app):
     with app.app_context():
         sess = tdb.session
-        assert sess.autocommit is False
         return sess
 
 

tests/test_app/views.py

@@ -63,15 +63,3 @@ def create_user():
 
     create_user()
     return jsonify({})
-
-
-@bp.route('/create_user/failed/', methods=['POST'])
-@base_use_kwargs({'email': fields.Str()})
-def create_user_failed(email):
-    @transaction(db.session)
-    def create_user():
-        user1 = User(username='signalling_test', email=email, password='1')
-        db.session.add(user1)
-
-    create_user()
-    return jsonify({})

tests/test_db.py

@@ -2,6 +2,8 @@
 import pytest
 import random
 
+from sqlalchemy.exc import InvalidRequestError
+
 from hobbit_core.db import EnumExt, transaction
 from hobbit_core.db import BaseModel, Column
 
@@ -119,10 +121,10 @@ def test_to_opts(self, TaskState):
 class TestTransaction(BaseTest):
 
     def clear_user(self):
-        User.query.delete()
-        db.session.commit()
-        db.session.remove()
-        assert User.query.all() == []
+        with db.session.begin():
+            User.query.delete()
+        with db.session.begin():
+            assert User.query.all() == []
 
     def test_transaction_decorator(self, session, assert_session):
         @transaction(session)
@@ -214,8 +216,8 @@ def view_func2():
         assert len(assert_session.query(User).all()) == 1
         assert assert_session.query(User).first().username == 'test1'
 
-    def test_nested_self_not_raise(self, session, assert_session):
-        # > 1.4
+    # v2.x should raise
+    def test_nested_self_raise(self, session, assert_session):
         @transaction(session)
         def create_user():
             user = User(username='test1', email='[email protected]', password='1')
@@ -227,8 +229,9 @@ def view_func():
             db.session.add(user)
             create_user()
 
-        view_func()
-        assert len(assert_session.query(User).all()) == 2
+        with pytest.raises(InvalidRequestError, match='A transaction is already begun on this Session.'):  # NOQA E501
+            view_func()
+        assert len(assert_session.query(User).all()) == 0
 
     def test_nested_self_with_nested_arg_is_true(
             self, session, assert_session):
@@ -269,11 +272,3 @@ def test_transaction_signal_success(self, client, assert_session):
 
         user = assert_session.query(User).filter(User.email == email).first()
         assert user and user.username == "signalling_ok"
-
-    def test_transaction_signal_dailed(self, client, assert_session):
-        email = "[email protected]"
-        resp = client.post('/create_user/failed/', json={"email": email})
-        assert resp.status_code == 200
-
-        user = assert_session.query(User).filter(User.email == email).first()
-        assert user and user.username != "signalling_ok"