Make it compatible with fsm-log

Author: pfouque

django_fsm/admin.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from functools import partial
 from typing import Any
 
 from django.conf import settings
@@ -15,6 +16,13 @@
 
 import django_fsm as fsm
 
+try:
+    import django_fsm_log  # noqa: F401
+except ModuleNotFoundError:
+    FSM_LOG_ENABLED = False
+else:
+    FSM_LOG_ENABLED = True
+
 
 @dataclass
 class FSMObjectTransition:
@@ -127,7 +135,20 @@ def response_change(self, request: HttpRequest, obj: Any) -> HttpResponse:
                 )
 
             try:
-                transition_func()
+                if FSM_LOG_ENABLED:
+                    for fn in [
+                        partial(transition_func, request=request, by=request.user),
+                        partial(transition_func, by=request.user),
+                        transition_func,
+                    ]:
+                        try:
+                            fn()
+                        except TypeError:  # noqa: PERF203
+                            pass
+                        else:
+                            break
+                else:
+                    transition_func()
             except fsm.TransitionNotAllowed:
                 self.message_user(
                     request=request,

tests/settings.py

@@ -43,6 +43,7 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "django_fsm_log",
     "guardian",
     *PROJECT_APPS,
 ]
@@ -135,3 +136,35 @@
 # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+
+# Django FSM-log settings
+DJANGO_FSM_LOG_IGNORED_MODELS = (
+    "tests.testapp.models.AdminBlogPost",
+    "tests.testapp.models.Application",
+    "tests.testapp.models.BlogPost",
+    "tests.testapp.models.DbState",
+    "tests.testapp.models.FKApplication",
+    "tests.testapp.tests.SimpleBlogPost",
+    "tests.testapp.tests.test_abstract_inheritance.BaseAbstractModel",
+    "tests.testapp.tests.test_abstract_inheritance.InheritedFromAbstractModel",
+    "tests.testapp.tests.test_access_deferred_fsm_field.DeferrableModel",
+    "tests.testapp.tests.test_basic_transitions.SimpleBlogPost",
+    "tests.testapp.tests.test_conditions.BlogPostWithConditions",
+    "tests.testapp.tests.test_custom_data.BlogPostWithCustomData",
+    "tests.testapp.tests.test_exception_transitions.ExceptionalBlogPost",
+    "tests.testapp.tests.test_graph_transitions.VisualBlogPost",
+    "tests.testapp.tests.test_integer_field.BlogPostWithIntegerField",
+    "tests.testapp.tests.test_lock_mixin.ExtendedBlogPost",
+    "tests.testapp.tests.test_lock_mixin.LockedBlogPost",
+    "tests.testapp.tests.test_mixin_support.MixinSupportTestModel",
+    "tests.testapp.tests.test_multi_resultstate.MultiResultTest",
+    "tests.testapp.tests.test_multidecorators.TestModel",
+    "tests.testapp.tests.test_protected_field.ProtectedAccessModel",
+    "tests.testapp.tests.test_protected_fields.RefreshableProtectedAccessModel",
+    "tests.testapp.tests.test_proxy_inheritance.InheritedModel",
+    "tests.testapp.tests.test_state_transitions.Caterpillar",
+    "tests.testapp.tests.test_string_field_parameter.BlogPostWithStringField",
+    "tests.testapp.tests.test_transition_all_except_target.TestExceptTargetTransitionShortcut",
+    "tests.testapp.tests.test_key_field.FKBlogPost",
+)

tests/testapp/admin.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from django.contrib import admin
+from django_fsm_log.admin import StateLogInline
 
 from django_fsm.admin import FSMAdminMixin
 
@@ -20,3 +21,5 @@ class AdminBlogPostAdmin(FSMAdminMixin, admin.ModelAdmin):
         "state",
         "step",
     ]
+
+    inlines = [StateLogInline]

tests/testapp/tests/test_admin.py

@@ -139,6 +139,7 @@ def test_transition_applied(self, mock_message_user):
             path="/",
             data={"_fsm_transition_to": "moderate"},
         )
+        request.user = MockSuperUser()
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED
@@ -162,6 +163,7 @@ def test_transition_not_allowed_exception(self, mock_message_user):
             path="/",
             data={"_fsm_transition_to": "publish"},
         )
+        request.user = MockSuperUser()
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED
@@ -185,6 +187,7 @@ def test_concurrent_transition_exception(self, mock_message_user):
             path="/",
             data={"_fsm_transition_to": "moderate"},
         )
+        request.user = MockSuperUser()
 
         blog_post = AdminBlogPost.objects.create(title="Article name")
         assert blog_post.state == AdminBlogPostState.CREATED

tests/testapp/tests/test_fsm_log_support.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import pytest
+from django.contrib.auth import get_user_model
+from django.db import models
+from django.test import TestCase
+from django_fsm_log.decorators import fsm_log_by
+from django_fsm_log.models import StateLog
+
+from django_fsm import FSMField
+from django_fsm import TransitionNotAllowed
+from django_fsm import transition
+
+
+class LoggableModel(models.Model):
+    state = FSMField(default="new")
+
+    @transition(field=state, source="new", target="published")
+    def publish(self):
+        pass
+
+    @fsm_log_by
+    @transition(field=state, source="new", target="published")
+    def publish_by(self, by=None):
+        pass
+
+    @transition(source="published", target="hidden", field=state)
+    def hide(self):
+        pass
+
+
+class PluginFsmLogTests(TestCase):
+    def setUp(self):
+        self.model = LoggableModel.objects.create()
+        self.user = get_user_model().objects.create_user(username="jacob", password="password")  # noqa: S106
+
+    def test_fsm_log_simple(self):
+        assert StateLog.objects.count() == 0
+        self.model.publish()
+        assert StateLog.objects.count() == 1
+
+    def test_fsm_log_by(self):
+        assert StateLog.objects.count() == 0
+        self.model.publish_by(by=self.user)
+        assert StateLog.objects.count() == 1
+        assert StateLog.objects.get().by is not None
+
+    def test_signals_not_called_on_invalid_transition(self):
+        assert StateLog.objects.count() == 0
+        with pytest.raises(TransitionNotAllowed):
+            self.model.hide()
+        assert StateLog.objects.count() == 0

tests/testapp/tests/test_multidecorators.py

@@ -8,7 +8,7 @@
 from django_fsm.signals import post_transition
 
 
-class TestModel(models.Model):
+class MultiDecoratedModel(models.Model):
     counter = models.IntegerField(default=0)
     signal_counter = models.IntegerField(default=0)
     state = FSMField(default="SUBMITTED_BY_USER")
@@ -24,12 +24,12 @@ def count_calls(sender, instance, name, source, target, **kwargs):
     instance.signal_counter += 1
 
 
-post_transition.connect(count_calls, sender=TestModel)
+post_transition.connect(count_calls, sender=MultiDecoratedModel)
 
 
 class TestStateProxy(TestCase):
     def test_transition_method_called_once(self):
-        model = TestModel()
+        model = MultiDecoratedModel.objects.create()
         model.review()
         assert model.counter == 1
         assert model.signal_counter == 1

tests/wsgi.py

@@ -12,6 +12,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "silvr.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
 
 application = get_wsgi_application()

tox.ini

@@ -13,6 +13,7 @@ deps =
     dj51: Django==5.1
     dj52: Django==5.2
 
+    django-fsm-log
     django-guardian
     graphviz
     pep8