Make it compatible with fsm-log (#51)

Author: pfouque

README.md

@@ -446,31 +446,31 @@ from django_fsm.admin import FSMAdminMixin
 
 @admin.register(AdminBlogPost)
 class MyAdmin(FSMAdminMixin, admin.ModelAdmin):
-    fsm_field = ['my_fsm_field',]
+    fsm_field = ['my_fsm_field']
     ...
 ```
 
-3. You can customize the label by adding ``custom={"label"="My awesome transition"}`` to the transition decorator
+3. You can customize the label by adding ``custom={"label": "My awesome transition"}`` to the transition decorator
 
 ``` python
 @transition(
     field='state',
     source=['startstate'],
     target='finalstate',
-    custom={"label"=False},
+    custom={"label": False},
 )
 def do_something(self, param):
        ...
 ```
 
-4. By adding ``custom={"admin"=False}`` to the transition decorator, one can disallow a transition to show up in the admin interface.
+4. By adding ``custom={"admin": False}`` to the transition decorator, one can disallow a transition to show up in the admin interface.
 
 ``` python
     @transition(
        field='state',
        source=['startstate'],
        target='finalstate',
-       custom={"admin"=False},
+       custom={"admin": False},
     )
     def do_something(self, param):
        # will not add a button "Do Something" to your admin model interface

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,

pyproject.toml

@@ -40,6 +40,7 @@ Documentation = "http://github.com/django-commons/django-fsm-2"
 graphviz = ["graphviz"]
 dev = [
     "coverage",
+    "django_fsm_log",
     "django-guardian",
     "graphviz",
     "pre-commit",

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.MultiDecoratedModel",
+    "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.ExceptTargetTransition",
+    "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/models.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
 from django.db import models
+from django_fsm_log.decorators import fsm_log_by
+from django_fsm_log.decorators import fsm_log_description
 
 from django_fsm import GET_STATE
 from django_fsm import RETURN_VALUE
@@ -287,6 +289,8 @@ class AdminBlogPost(models.Model):
 
     # state transitions
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source="*",
@@ -295,17 +299,21 @@ class AdminBlogPost(models.Model):
             "admin": False,
         },
     )
-    def secret_transition(self):
+    def secret_transition(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[AdminBlogPostState.CREATED],
         target=AdminBlogPostState.REVIEWED,
     )
-    def moderate(self):
+    def moderate(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[
@@ -314,9 +322,11 @@ def moderate(self):
         ],
         target=AdminBlogPostState.PUBLISHED,
     )
-    def publish(self):
+    def publish(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=state,
         source=[
@@ -325,11 +335,13 @@ def publish(self):
         ],
         target=AdminBlogPostState.HIDDEN,
     )
-    def hide(self):
+    def hide(self, by=None, description=None):
         pass
 
     # step transitions
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[AdminBlogPostStep.STEP_1],
@@ -338,17 +350,21 @@ def hide(self):
             "label": "Go to Step 2",
         },
     )
-    def step_two(self):
+    def step_two(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[AdminBlogPostStep.STEP_2],
         target=AdminBlogPostStep.STEP_3,
     )
-    def step_three(self):
+    def step_three(self, by=None, description=None):
         pass
 
+    @fsm_log_by
+    @fsm_log_description
     @transition(
         field=step,
         source=[
@@ -357,5 +373,5 @@ def step_three(self):
         ],
         target=AdminBlogPostStep.STEP_1,
     )
-    def step_reset(self):
+    def step_reset(self, by=None, description=None):
         pass

tests/testapp/tests/test_admin.py

@@ -7,6 +7,7 @@
 from django.contrib.auth import get_user_model
 from django.test import TestCase
 from django.test.client import RequestFactory
+from django_fsm_log.models import StateLog
 
 from django_fsm import ConcurrentTransition
 from django_fsm import FSMField
@@ -105,6 +106,7 @@ def setUpTestData(cls):
         cls.user = get_user_model().objects.create_user(username="jacob", password="password", is_staff=True)  # noqa: S106
 
     def test_unknown_transition(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "unknown_transition"},
@@ -126,8 +128,10 @@ def test_unknown_transition(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0
 
     def test_transition_applied(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "moderate"},
@@ -150,8 +154,11 @@ def test_transition_applied(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.REVIEWED
+        assert StateLog.objects.count() == 1
+        assert StateLog.objects.get().by == self.user
 
     def test_transition_not_allowed_exception(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "publish"},
@@ -174,8 +181,10 @@ def test_transition_not_allowed_exception(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0
 
     def test_concurrent_transition_exception(self, mock_message_user):
+        assert StateLog.objects.count() == 0
         request = RequestFactory().post(
             path="/",
             data={"_fsm_transition_to": "moderate"},
@@ -202,3 +211,4 @@ def test_concurrent_transition_exception(self, mock_message_user):
 
         updated_blog_post = AdminBlogPost.objects.get(pk=blog_post.pk)
         assert updated_blog_post.state == AdminBlogPostState.CREATED
+        assert StateLog.objects.count() == 0

tests/testapp/tests/test_transition_all_except_target.py

@@ -20,7 +20,7 @@ def remove(self):
         pass
 
 
-class Test(TestCase):
+class TestExceptTargetTransition(TestCase):
     def setUp(self):
         self.model = ExceptTargetTransition()
 

tox.ini

@@ -18,6 +18,7 @@ deps =
     dj60: Django==6.0
     djmain: https://github.com/django/django/tarball/main
 
+    django-fsm-log
     django-guardian
     graphviz
     pep8