wbcore 1.46.0__py2.py3-none-any.whl → 1.58.2__py2.py3-none-any.whl

wbcore/fsm/mixins.py

@@ -1,11 +1,14 @@
 import logging
 
+from django.contrib.messages import get_messages, warning
 from django_fsm import FSMField, Transition, TransitionNotAllowed
 from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.request import Request
 from rest_framework.response import Response
 
+from wbcore.messages import InMemoryMessageStorage
+
 logger = logging.getLogger(__name__)
 
 
@@ -20,15 +23,15 @@ def get_method(transition, fsm_field_name):
 class FSMViewSetMixinMetaclass(type):
     """Metaclass for dynamically creating all FSM Routes"""
 
-    def __new__(cls, name, bases, dct):
-        _class = super().__new__(cls, name, bases, dct)
+    def __new__(cls, *args, **kwargs):
+        _class = super().__new__(cls, *args, **kwargs)
 
         # The class needs the field FSM_MODELFIELDS to know which transitions it needs to add
         if hasattr(_class, "get_model"):
             model = _class.get_model()
 
             if model:
-                setattr(_class, "FSM_BUTTONS", getattr(_class, "FSM_BUTTONS", set()))
+                _class.FSM_BUTTONS = getattr(_class, "FSM_BUTTONS", set())
                 # The model potentially has multiple FSMFields, which needs to be iterated over
                 for field in filter(lambda f: isinstance(f, FSMField), model._meta.fields):
                     # Get all transitions, by calling the partialmethod defined by django-fsm
@@ -100,15 +103,26 @@ class FSMViewSetMixin(metaclass=FSMViewSetMixinMetaclass):
             errors = can_action_method()
 
         if errors is None or len(errors.keys()) == 0:
-            obj.fsm_context = {"current_user": request.user}
+            obj.fsm_context = {"current_user": request.user, "request": request}
             if getattr(obj, fsm_field_name) != transition.target:
                 if (action_method := getattr(obj, action, None)) and callable(action_method):
-                    action_method(by=request.user)
+                    warnings = action_method(by=request.user)
                     obj.save()
                     if (post_action_method := getattr(obj, f"post_{action}", None)) and callable(post_action_method):
                         post_action_method(by=request.user)
+                    # we extend the framework to allow action to successfully return but notify any possible warning. We use the message framework to communicate these warnings to the user
+                    if warnings:
+                        if isinstance(warnings, list):
+                            html = "<ul>" + "".join(f"<li>{e}</li>" for e in warnings) + "</ul>"
+                        else:
+                            html = "<p>" + warnings + "</p>"
+                        warning(request, html, extra_tags="auto_close=0")
 
             serializer = serializer_class(instance=obj, context=serializer_context)
-            return Response({"instance": serializer.data})
+            storage = get_messages(request._request)
+            data = {"instance": serializer.data}
+            if isinstance(storage, InMemoryMessageStorage):
+                data["messages"] = list(storage.serialize_messages())
+            return Response(data)
 
         return Response(errors, status=status.HTTP_412_PRECONDITION_FAILED)