Update for new flask/flask-sqlalchemy (#33)

* Update for new flask/flask-sqlalchemy

* Update CI

* Bump version

Author: Keats

.github/workflows/test.yml

@@ -10,11 +10,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     services:
       postgres:
-        image: postgres:11.6
+        image: postgres:14.9
         env:
-          POSTGRES_DB: chrononaut_test
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: ""
+          POSTGRES_PASSWORD: "password"
         ports:
           - 5432:5432
         # needed because the postgres container does not provide a healthcheck
@@ -23,19 +21,16 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
-      - name: Install virtualenv (Python2/3 compat)
-        run: |
-          pip install --progress-bar=off virtualenv
       - name: Cache virtualenv
         uses: actions/cache@v1
         id: cache-pip
@@ -45,12 +40,14 @@ jobs:
       - name: Install dependencies in a venv
         if: steps.cache-pip.outputs.cache-hit != 'true'
         run: |
-          virtualenv venv
+          python -m venv venv
           . venv/bin/activate
           pip install -q -U pip
           pip install --progress-bar=off .
           pip install --progress-bar=off -r requirements.txt
       - name: Run all tests
+        env:
+          SQLALCHEMY_DATABASE_URI: postgresql://postgres:password@localhost:5432/chrononaut_test
         run: |
           . venv/bin/activate
           py.test tests/

chrononaut/__init__.py

@@ -7,10 +7,10 @@
     :license: MIT, see LICENSE for more details.
 """
 
-import sqlalchemy
 from sqlalchemy import event
 from flask import g
-from flask_sqlalchemy import SignallingSession, SQLAlchemy
+from flask_sqlalchemy import SQLAlchemy
+from flask_sqlalchemy.session import Session
 
 
 # Chrononaut imports
@@ -39,7 +39,7 @@ def before_flush(session, flush_context, instances):
         """A listener that handles state changes for objects with Chrononaut mixins."""
         for obj in session.new:
             if hasattr(obj, "__chrononaut_record_change_info__"):
-                append_recorded_changes(obj, session)
+                append_recorded_changes(obj)
             if hasattr(obj, "__chrononaut_primary_key_nonunique__"):
                 increment_version_on_insert(obj)
 
@@ -48,7 +48,7 @@ def before_flush(session, flush_context, instances):
                 # Objects cannot be updated in the `after_flush` step hence bumping the version here
                 obj.version = obj.version + 1 if obj.version is not None else 1
             if hasattr(obj, "__chrononaut_record_change_info__"):
-                append_recorded_changes(obj, session)
+                append_recorded_changes(obj)
 
         for obj in session.deleted:
             if hasattr(obj, "__chrononaut_version__") and not hasattr(
@@ -71,8 +71,8 @@ def after_flush(session, flush_context):
                 create_version(obj, session)
 
 
-class VersionedSignallingSession(SignallingSession):
-    """A subclass of Flask-SQLAlchemy's SignallingSession that supports
+class VersionedSession(Session):
+    """A subclass of Flask-SQLAlchemy's Session that supports
     versioned and change info session information.
     """
 
@@ -85,7 +85,7 @@ def delete(self, instance):
             super().delete(instance)
 
 
-versioned_session(VersionedSignallingSession)
+versioned_session(VersionedSession)
 
 
 class VersionedSQLAlchemy(SQLAlchemy):
@@ -121,8 +121,9 @@ def __init__(self, *args, **kwargs):
         super(VersionedSQLAlchemy, self).__init__(*args, **kwargs)
         self.metadata._activity_cls = activity_factory(self.Model)
 
-    def create_session(self, options):
-        return sqlalchemy.orm.sessionmaker(class_=VersionedSignallingSession, db=self, **options)
+    def _make_session_factory(self, options):
+        options["class_"] = VersionedSession
+        return super(VersionedSQLAlchemy, self)._make_session_factory(options)
 
 
 __all__ = [

chrononaut/change_info.py

@@ -2,8 +2,7 @@
 """
 from datetime import datetime
 
-from flask import current_app, g, request
-from flask.globals import _app_ctx_stack, _request_ctx_stack
+from flask import current_app, g, request, has_request_context, has_app_context
 from sqlalchemy import Column, DateTime
 from sqlalchemy.dialects import postgresql
 
@@ -12,13 +11,6 @@
 from chrononaut.flask_versioning import UTC
 
 
-def _in_flask_context():
-    if _app_ctx_stack.top is None or _request_ctx_stack.top is None:
-        return False
-    else:
-        return True
-
-
 class ChangeInfoMixin(object):
     """A mixin that the :class:`Versioned` mixin inherits from and includes change info tracking
     features.
@@ -45,13 +37,14 @@ def _fetch_current_user_id(cls):
 
         :return: A unique user ID string or ``None`` if not available.
         """
-        if not _in_flask_context():
+        if not has_app_context():
             return None
+
         try:
             from flask_login import current_user
 
             return current_user.email if current_user.is_authenticated else None
-        except ImportError:
+        except (ImportError, AttributeError):
             return None
 
     @classmethod
@@ -60,7 +53,7 @@ def _fetch_remote_addr(cls):
 
         :return: An IP address string or ``None`` if not available.
         """
-        if not _in_flask_context():
+        if not has_request_context():
             return None
         return request.remote_addr
 
@@ -92,8 +85,8 @@ class RecordChanges(ChangeInfoMixin):
     changed = Column("changed", DateTime(timezone=True), default=lambda: datetime.now(UTC))
 
 
-def append_recorded_changes(obj, session):
-    if session.app.config.get(
+def append_recorded_changes(obj):
+    if current_app.config.get(
         "CHRONONAUT_REQUIRE_EXTRA_CHANGE_INFO", False
     ) is True and not hasattr(g, "__version_extra_change_info__"):
         msg = (

chrononaut/context_managers.py

@@ -1,6 +1,7 @@
 from contextlib import contextmanager
 
-from flask import g, _app_ctx_stack
+from flask import g, has_app_context
+
 from chrononaut.exceptions import ChrononautException
 
 
@@ -27,7 +28,7 @@ def extra_change_info(**kwargs):
             "change_rationale": "User request"
         }
     """
-    if _app_ctx_stack.top is None:
+    if not has_app_context():
         raise ChrononautException("Can only use `extra_change_info` in a Flask app context.")
     g.__version_extra_change_info__ = kwargs
     yield
@@ -71,7 +72,7 @@ def append_change_info(obj, **kwargs):
     block for additional fields to be appended. Changes take the same form as with
     :func:`extra_change_info`.
     """
-    if _app_ctx_stack.top is None:
+    if not has_app_context():
         raise ChrononautException("Can only use `append_change_info` in a Flask app context.")
 
     if not hasattr(obj, "__versioned__"):

chrononaut/flask_versioning.py

@@ -1,7 +1,6 @@
 """Flask versioning extension. Requires g and _app_ctx_stack in looking for extra recorded changes.
 """
-from flask import g
-from flask.globals import _app_ctx_stack
+from flask import g, current_app, has_app_context
 from datetime import datetime
 from dateutil.tz import tzutc
 import six
@@ -94,7 +93,7 @@ def _get_dirty_attributes(obj, state=None, check_relationships=False):
 def fetch_change_info(obj):
     """Returns a user and extra info context for a change."""
     user_info = obj._capture_user_info()
-    if _app_ctx_stack.top is None:
+    if not has_app_context():
         return user_info, {}
 
     extra_change_info = obj._get_custom_change_info()
@@ -169,7 +168,7 @@ def create_version(obj, session, created=False, deleted=False):
 
     snapshot = model_to_chrononaut_snapshot(obj, state)
 
-    if session.app.config.get(
+    if current_app.config.get(
         "CHRONONAUT_REQUIRE_EXTRA_CHANGE_INFO", False
     ) is True and not hasattr(g, "__version_extra_change_info__"):
         msg = (

chrononaut/unsafe.py

@@ -1,6 +1,7 @@
 from contextlib import contextmanager
 
-from flask import g, _app_ctx_stack
+from flask import g, has_app_context
+
 from chrononaut.exceptions import ChrononautException
 
 
@@ -25,7 +26,7 @@ def suppress_versioning(allow_deleting_history=False):
 
     Do not nest this context manager. If possible, avoid using at all.
     """
-    if _app_ctx_stack.top is None:
+    if not has_app_context():
         raise ChrononautException("Can only use `suppress_versioning` in a Flask app context.")
     g.__suppress_versioning__ = True
     if allow_deleting_history:

requirements.txt

@@ -1,7 +1,7 @@
 # Requirements
-Flask==2.1.0
-Flask-SQLAlchemy==2.5.1
-SQLAlchemy==1.4.25
+Flask>=2.3.2
+Flask-SQLAlchemy>=3.0.5
+SQLAlchemy==1.4.50
 psycopg2-binary>=2.8.1
 alembic>=1.5.1
 six>=1.15.0
@@ -10,12 +10,13 @@ python-dateutil
 # Testing & documentation requirements (note these must be installable across all Tox environment)
 pytest>=3.0.7
 pytest-cov==2.4.0
-Flask-Security-Fork==2.0.1
-Flask-WTF==1.0.1
-Werkzeug==2.0.0
+Flask-Security-Too==5.3.2
+Flask-WTF==1.2.1
+Werkzeug==2.3.6
 sphinx==1.5.5
-sphinx-autobuild==0.6.0
-Flask-Sphinx-Themes==1.0.1
-bcrypt==3.1.4
+Flask-Sphinx-Themes==1.0.2
 email_validator>=1.1.0
 enum34>=1.1.10
+flake8
+black==23.7.0
+sqlalchemy-utils

setup.py

@@ -9,7 +9,7 @@
 from setuptools import setup, find_packages
 import sys
 
-__version__ = "0.4.2"
+__version__ = "0.5.0"
 
 
 if sys.version_info[0] < 3:

tests/conftest.py

@@ -1,12 +1,15 @@
+import uuid
+
+from sqlalchemy_utils import database_exists, drop_database, create_database
+
 from chrononaut.flask_versioning import UTC
 from datetime import datetime
 import os
 from enum import Enum
 
 import flask
-from flask import g, _request_ctx_stack
+from flask import g
 import flask_security
-import flask_sqlalchemy
 import sqlalchemy
 import random
 import string
@@ -36,19 +39,17 @@ def app(request):
 
 
 @pytest.fixture(scope="session")
-def unversioned_db(app, request):
-    """An unversioned db fixture."""
-    db = flask_sqlalchemy.SQLAlchemy(app)
-    yield db
-
-
-@pytest.fixture(scope="session")
-def db(app, request):
+def db(app):
     """A versioned db fixture."""
     db = chrononaut.VersionedSQLAlchemy(app)
     models = generate_test_models(db)
     for model in models:
         setattr(db, model.__name__, model)
+    if database_exists(db.engine.url):
+        db.engine.dispose()
+        drop_database(db.engine.url)
+
+    create_database(db.engine.url)
     db.create_all()
     try:
         yield db
@@ -170,6 +171,9 @@ def validate_title(self, k, v):
         db.Column("role_id", db.Integer(), db.ForeignKey("role.id")),
     )
 
+    def gen_fs_uniquifier() -> str:
+        return str(uuid.uuid4())
+
     class Role(db.Model, flask_security.RoleMixin, chrononaut.Versioned):
         id = db.Column(db.Integer, primary_key=True)
         name = db.Column(db.String(80), unique=True)
@@ -187,6 +191,9 @@ class User(db.Model, flask_security.UserMixin, chrononaut.Versioned):
         roles = db.relationship(
             "Role", secondary=roles_users, backref=db.backref("users", lazy="dynamic")
         )
+        fs_uniquifier = db.Column(
+            db.String(255), unique=True, nullable=False, default=gen_fs_uniquifier
+        )
 
     class ChangeLog(db.Model, chrononaut.RecordChanges, chrononaut.Versioned):
         id = db.Column(db.Integer, primary_key=True)
@@ -202,7 +209,7 @@ def session(db):
     transaction = connection.begin()
 
     options = dict(bind=connection, binds={})
-    session = db.create_scoped_session(options=options)
+    session = db._make_scoped_session(options=options)
     session.begin_nested()
 
     # session is actually a scoped_session
@@ -242,16 +249,6 @@ def app_client(security_app):
     yield security_app.test_client(use_cookies=True)
 
 
-@pytest.fixture(scope="function")
-def user(db, session):
-    user = db.User(email="test@example.com", password="password", active=True)
-    role = db.Role(name="Admin")
-    session.add(user)
-    session.add(role)
-    session.commit()
-    yield user
-
-
 @pytest.fixture(scope="function")
 def anonymous_user(app_client):
     with app_client:
@@ -261,19 +258,18 @@ def anonymous_user(app_client):
 
 
 @pytest.fixture(scope="function")
-def logged_in_user(security_app, user):
+def logged_in_user(security_app, db, session):
     with security_app.test_request_context(environ_base={"REMOTE_ADDR": "10.0.0.1"}):
-        original = security_app.login_manager._load_user
-        if hasattr(g, "_login_user"):
-            delattr(g, "_login_user")
-
-        def _load_user_from_request():
-            _request_ctx_stack.top.user = user
-            g._login_user = user
-            return user
-
-        security_app.login_manager._load_user = _load_user_from_request
+        user = db.User(email="test@example.com", password="password", active=True)
+        role = db.Role(name="Admin")
+        session.add(user)
+        session.add(role)
+        session.commit()
+
+        security_app.login_manager._update_request_context_with_user(user)
+        g._login_user = user
         try:
             yield user
         finally:
-            security_app.login_manager._load_user = original
+            delattr(g, "_login_user")
+            security_app.login_manager._update_request_context_with_user(None)

tests/test_basic.py

@@ -1,28 +1,17 @@
 """Test basic FlaskSQLAlchemy integration points
 """
-import flask_sqlalchemy
 import sqlalchemy
 
 import chrononaut
 
 
-def test_unversioned_db_fixture(unversioned_db):
-    """Test unversioned SQLAlchemy object."""
-    assert unversioned_db.__class__ == flask_sqlalchemy.SQLAlchemy
-    assert unversioned_db.session.__class__ == sqlalchemy.orm.scoping.scoped_session
-    assert (
-        unversioned_db.session.session_factory().__class__.__name__
-        == flask_sqlalchemy.SignallingSession.__name__  # noqa
-    )
-
-
 def test_db_fixture(db):
     """Test fixtures."""
     assert db.__class__ == chrononaut.VersionedSQLAlchemy
     assert db.session.__class__ == sqlalchemy.orm.scoping.scoped_session
     assert (
         db.session.session_factory().__class__.__name__
-        == chrononaut.VersionedSignallingSession.__name__  # noqa
+        == chrononaut.VersionedSession.__name__  # noqa
     )
 
 

tests/test_versioning_suppression.py

@@ -77,7 +77,7 @@ def test_suppressing_version_info_delete_version_commit_out_of_scope(db, session
     assert len(todo.versions()) == 2
 
 
-def test_suppressing_version_info_delete_whole_record(db, session):
+def test_suppressing_version_info_delete_whole_record(db, session, logged_in_user):
     todo = db.SpecialTodo("Special 1", "A todo")
     session.add(todo)
     session.commit()

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py37,py38,py39,py310,coverage,lint
+envlist = py38,py39,py310,py311,py312,coverage,lint
 
 [testenv]
 commands =
@@ -13,7 +13,7 @@ deps =
 
 
 [testenv:lint]
-basepython = python3.9
+basepython = python3.11
 deps =
     flake8
     black==19.3b0