django-viewflow 2.2.5__tar.gz → 2.2.6__tar.gz

{django_viewflow-2.2.5/django_viewflow.egg-info → django_viewflow-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.2.5
+Version: 2.2.6
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/README.md

@@ -9,6 +9,8 @@ Viewflow is a low-code, reusable component library for creating comprehensive bu
 
 With Viewflow, you can create full-featured business applications in just a few lines of code using its reusable component library. It's shipped as a single package with batteries included, and each part of Viewflow can be used independently of the others, but they all work well together.
 
+GPT assisted with Viewflow documentation: [Viewflow Pair Programming Buddy][gpt]
+
 
 Viewflow comes in two flavors:
 - **Viewflow Core:** A lightweight, open-source library with only non-opinionated core classes that allows you to build your custom solution on top.
@@ -264,3 +266,4 @@ modifications of Viewflow. You can find the commercial license terms in
 [py-versions]: https://img.shields.io/pypi/pyversions/django-viewflow.svg
 [requirements-svg]: https://requires.io/github/viewflow/viewflow/requirements.svg?branch=v2
 [requirements]: https://requires.io/github/viewflow/viewflow/requirements/?branch=v2
+[gpt]: https://chatgpt.com/g/g-8UHAnOpE3-viewflow-pair-programming

{django_viewflow-2.2.5 → django_viewflow-2.2.6/django_viewflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.2.5
+Version: 2.2.6
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/setup.py

@@ -4,7 +4,7 @@ README = open("README.md", "r", encoding="utf-8").read()
 
 setuptools.setup(
     name="django-viewflow",
-    version="2.2.5",
+    version="2.2.6",
     author_email="kmmbvnr@gmail.com",
     author="Mikhail Podgurskiy",
     description="Reusable library to build business applications fast",

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/templatetags/workflow.py

@@ -49,9 +49,9 @@ def include_task_data(context, task):
     template = select_template(template_names)
     context.push()
     try:
-        if task.artifact_object_id:
+        if task.artifact_object_id and task.artifact is not None:
             context["artifact_data"] = get_object_data(task.artifact)
-        if task.seed_object_id:
+        if task.seed_object_id and task.seed is not None:
             context["seed_data"] = get_object_data(task.seed)
         context["data"] = task.data
         context["task"] = task

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/utils.py

@@ -228,7 +228,11 @@ def get_object_data(obj: models.Model) -> Iterator[Tuple[models.Field, str, Any]
         if value is not None:
             yield (field, field.verbose_name.capitalize(), value)
 
-    if hasattr(obj, "artifact_object_id") and obj.artifact_object_id:
+    if (
+        hasattr(obj, "artifact_object_id")
+        and obj.artifact_object_id
+        and obj.artifact is not None
+    ):
         yield from get_object_data(obj.artifact)
 
 

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/activation.py

@@ -1,4 +1,6 @@
-from contextlib import contextmanager
+import json
+import traceback
+from contextlib import ContextDecorator
 from typing import Any, List, Optional, Set
 
 from django.db import connection, transaction
@@ -119,31 +121,54 @@ class Activation:
         """Get the flow class associated with the activation."""
         return self.flow_task.flow_class
 
-    def exception_guard(self) -> contextmanager:
+    def exception_guard(self) -> ContextDecorator:
         """
         Perform activation action inside a transaction.
 
         Handle and propagate exception depending on activation context state.
         """
 
-        @contextmanager
-        def guard():
-            try:
-                with transaction.atomic(savepoint=True):
-                    yield
-            except Exception as exc:  # noqa: TODO
-                if not context.propagate_exception:
-                    # TODO self.task.comments = "{}\n{}".format(exc, traceback.format_exc())
-                    self.task.finished = now()
-                    self.set_status(STATUS.ERROR)
-                    self.task.save()
-                    task_failed.send(
-                        sender=self.flow_class, process=self.process, task=self.task
-                    )
-                else:
-                    raise
-
-        return guard()
+        class ExceptionGuard(ContextDecorator):
+            def __enter__(self):
+                return self
+
+            def __exit__(self_eg, exc_type, exc_val, exc_tb):
+                if exc_type is not None:
+                    if not context.propagate_exception:
+                        # Keep error state
+                        tb = exc_val.__traceback__
+                        while tb.tb_next:
+                            tb = tb.tb_next
+
+                        try:
+                            serialized_locals = json.dumps(
+                                tb.tb_frame.f_locals, default=lambda obj: str(obj)
+                            )
+                        except Exception as ex:
+                            serialized_locals = json.dumps(
+                                {"_serialization_exception": str(ex)}
+                            )
+
+                        self.task.data["_exception"] = {
+                            "title": str(exc_val),
+                            "traceback": traceback.format_exc(),
+                            "locals": json.loads(serialized_locals),
+                        }
+
+                        # Set status
+                        self.task.finished = now()
+                        self._set_status(STATUS.ERROR)
+                        self.task.save()
+                        task_failed.send(
+                            sender=self.flow_class, process=self.process, task=self.task
+                        )
+                        # self.transaction.__exit__(exc_type, exc_val, exc_tb)
+                        return True  # Suppress the exception
+                    else:
+                        # self.transaction.__exit__(exc_type, exc_val, exc_tb)
+                        return False  # Propagate the exception
+
+        return ExceptionGuard()
 
     @classmethod
     def create(
@@ -171,9 +196,9 @@ class Activation:
             process=prev_activation.process,
             flow_task=flow_task,
             token=token,
-            data=data if data is not None else {},
-            seed=seed,
         )
+        task.data = data if data is not None else {}
+        task.seed = seed
         task.save()
         task.previous.add(prev_activation.task)
         return cls(task)
@@ -270,10 +295,10 @@ class Activation:
             process=self.process,
             flow_task=self.flow_task,
             token=self.task.token,
-            seed=self.task.seed,
-            artifact=self.task.artifact,
-            data=self.task.data,
         )
+        task.seed = self.task.seed
+        task.data = self.task.data
+        task.artifact = self.task.artifact
         task.save()
 
         for prev_task in self.task.previous.all():

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/base.py

@@ -479,7 +479,7 @@ class Flow(Viewset, metaclass=FlowMetaClass):
             if not_cancellable:
                 raise FlowRuntimeError(
                     "Can't cancel {}".format(
-                        ",".join(activation.task for activation in not_cancellable)
+                        ",".join(str(activation.task) for activation in not_cancellable)
                     )
                 )
 

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/flow/nodes.py

@@ -221,7 +221,12 @@ class If(
     revive_view_class = views.ReviveTaskView
 
 
-class Function(mixins.NodeDetailMixin, mixins.NodeUndoMixin, nodes.Function):
+class Function(
+    mixins.NodeDetailMixin,
+    mixins.NodeUndoMixin,
+    mixins.NodeReviveMixin,
+    nodes.Function,
+):
     """
     Represents a callback function executed synchronously as part of a workflow
     node.
@@ -255,6 +260,7 @@ class Function(mixins.NodeDetailMixin, mixins.NodeUndoMixin, nodes.Function):
     index_view_class = views.IndexTaskView
     detail_view_class = views.DetailTaskView
     undo_view_class = views.UndoTaskView
+    revive_view_class = views.ReviveTaskView
 
 
 class Handle(
@@ -357,6 +363,7 @@ class Split(
 
 class SplitFirst(
     mixins.NodeDetailMixin,
+    mixins.NodeReviveMixin,
     nodes.SplitFirst,
 ):
     """
@@ -385,6 +392,8 @@ class SplitFirst(
 
     index_view_class = views.IndexTaskView
     detail_view_class = views.DetailTaskView
+    undo_view_class = views.UndoTaskView
+    revive_view_class = views.ReviveTaskView
 
 
 try:

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/end.py

@@ -27,7 +27,7 @@ class EndActivation(Activation):
         """
         Finalize the flow. If there is no active task, process marked as finished.
         """
-        with transaction.atomic(savepoint=True):
+        with transaction.atomic(savepoint=True), self.exception_guard():
             self.task.started = now()
             task_started.send(
                 sender=self.flow_class, process=self.process, task=self.task

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/func.py

@@ -1,7 +1,8 @@
+from django.db import transaction
 from django.utils.timezone import now
 
 from viewflow import this
-from ..activation import Activation
+from ..activation import Activation, has_manage_permission
 from ..base import Node
 from ..status import STATUS
 from ..signals import task_started
@@ -18,17 +19,21 @@ class FunctionActivation(mixins.NextNodeActivationMixin, Activation):
     @Activation.status.super()
     def activate(self):
         """Perform the callback within current exception propagation strategy."""
-        with self.exception_guard():
+        with transaction.atomic(savepoint=True), self.exception_guard():
             self.task.started = now()
             task_started.send(
                 sender=self.flow_class, process=self.process, task=self.task
             )
             self.flow_task._func(self)
 
-    @Activation.status.transition(source=STATUS.ERROR, target=STATUS.DONE)
-    def retry(self):
-        """Retry the next node calculation and activation."""
-        self.activate.original()
+    @Activation.status.transition(
+        source=[STATUS.ERROR],
+        target=STATUS.CANCELED,
+        permission=has_manage_permission,
+    )
+    def cancel(self):
+        self.task.finished = now()
+        self.task.save()
 
 
 class Function(mixins.NextNodeMixin, mixins.NodePermissionMixin, Node):

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/if_gate.py

@@ -1,3 +1,4 @@
+from django.db import transaction
 from viewflow import this
 
 from ..base import Node, Edge
@@ -12,7 +13,8 @@ class IfActivation(Activation):
 
     @Activation.status.super()
     def activate(self):
-        self._condition_result = self.flow_task.condition(self)
+        with transaction.atomic(savepoint=True), self.exception_guard():
+            self._condition_result = self.flow_task._condition(self)
 
     @Activation.status.super()
     def create_next(self):
@@ -72,6 +74,7 @@ class If(Node):
     def _resolve(self, instance):
         super()._resolve(instance)
 
+        self._condition = this.resolve(self.flow_class.instance, self._condition)
         self._on_true = this.resolve(instance, self._on_true)
         self._on_true_data = this.resolve(instance, self._on_true_data)
         self._on_true_seed = this.resolve(instance, self._on_true_seed)
@@ -80,10 +83,6 @@ class If(Node):
         self._on_false_data = this.resolve(instance, self._on_false_data)
         self._on_false_seed = this.resolve(instance, self._on_false_seed)
 
-    @property
-    def condition(self):
-        return this.resolve(self.flow_class.instance, self._condition)
-
     def Then(self, node, task_data=None, task_seed=None):
         """Node activated if condition is True."""
         self._on_true = node

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/job.py

@@ -6,6 +6,7 @@ from django.utils import timezone
 
 from ..activation import Activation
 from ..base import Node
+from ..context import Context
 from ..fields import get_flow_ref
 from ..signals import task_failed
 from ..status import STATUS
@@ -22,9 +23,9 @@ class AbstractJobActivation(mixins.NextNodeActivationMixin, Activation):
             flow_task=flow_task,
             token=token,
             external_task_id=str(uuid.uuid4()),
-            data=data if data is not None else {},
-            seed=seed,
         )
+        task.data = data if data is not None else {}
+        task.seed = seed
         task.save()
         task.previous.add(prev_activation.task)
         return cls(task)
@@ -45,7 +46,8 @@ class AbstractJobActivation(mixins.NextNodeActivationMixin, Activation):
     @Activation.status.transition(source=STATUS.STARTED)
     def execute(self):
         self.complete()
-        self.activate_next()
+        with Context(propagate_exception=False):
+            self.activate_next()
 
     @Activation.status.transition(source=STATUS.STARTED, target=STATUS.ERROR)
     def error(self, exception):

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/join.py

@@ -44,13 +44,14 @@ class JoinActivation(mixins.NextNodeActivationMixin, Activation):
             if token.is_split_token():
                 token = token.get_base_split_token()
 
-            task = flow_class.task_class.objects.create(
+            task = flow_class.task_class(
                 process=prev_activation.process,
                 flow_task=flow_task,
                 token=token,
-                data=data if data is not None else {},
-                seed=seed,
             )
+            task.data = data if data is not None else {}
+            task.seed = seed
+            task.save()
         else:
             # todo resolve task_data and seed
             pass
@@ -63,7 +64,6 @@ class JoinActivation(mixins.NextNodeActivationMixin, Activation):
     @Activation.status.transition(source=STATUS.NEW, target=STATUS.STARTED)
     @Activation.status.transition(source=STATUS.STARTED)
     def activate(self):
-        """Do nothing on a sync call"""
         if self.task.started is None:
             self.task.started = now()
             self.task.save()

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/start.py

@@ -21,10 +21,9 @@ class StartActivation(mixins.NextNodeActivationMixin, Activation):
             flow_task=flow_task,
             process=process,
             started=now(),
-            data=data if data is not None else {},
-            seed=seed,
         )
-
+        task.data = data if data is not None else {}
+        task.seed = seed
         return cls(task)
 
     @Activation.status.transition(source=STATUS.NEW)

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/switch.py

@@ -1,3 +1,4 @@
+from django.db import transaction
 from django.utils.timezone import now
 
 from viewflow import this
@@ -16,18 +17,19 @@ class SwitchActivation(Activation):
 
     @Activation.status.super()
     def activate(self):
-        for node, cond in self.flow_task._branches:
-            if cond:
-                if cond(self):
+        with transaction.atomic(savepoint=True), self.exception_guard():
+            for node, cond in self.flow_task._branches:
+                if cond:
+                    if cond(self):
+                        self.next_task = node
+                        break
+                else:
                     self.next_task = node
-                    break
-            else:
-                self.next_task = node
-
-        if not self.next_task:
-            raise FlowRuntimeError(
-                "No next task available for {}".format(self.flow_task.name)
-            )
+
+            if not self.next_task:
+                raise FlowRuntimeError(
+                    "No next task available for {}".format(self.flow_task.name)
+                )
 
     @Activation.status.super()
     def create_next(self):

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/nodes/view.py

@@ -20,9 +20,9 @@ class ViewActivation(mixins.NextNodeActivationMixin, Activation):
             process=prev_activation.process,
             flow_task=flow_task,
             token=token,
-            data=data if data is not None else {},
-            seed=seed,
         )
+        task.data = data if data is not None else {}
+        task.seed = seed
 
         activation = cls(task)
 

{django_viewflow-2.2.5 → django_viewflow-2.2.6}/viewflow/workflow/utils.py

@@ -45,4 +45,8 @@ def get_next_process_task(manager, process, user):
             status__in=[STATUS.NEW, STATUS.SCHEDULED, STATUS.STARTED],
         ).first()
 
+    # a task in a ERROR state
+    if task is None:
+        task = manager.filter(process=process, status=STATUS.ERROR).first()
+
     return task