Allow to move nodes by drag & drop

Author: picklepete

backend/Makefile

@@ -177,10 +177,16 @@ test-coverage: .check-dev
 	$(VPYTEST) -n 10 --cov-report term --cov-report html:reports/html --cov=src $(BACKEND_TESTS_DIRS) || exit;
 
 test-builder: .check-dev
-	$(VPYTEST) tests/baserow/contrib/builder || exit
+	$(VPYTEST) tests/baserow/contrib/integrations tests/baserow/contrib/builder || exit
 
 test-builder-parallel: .check-dev
-	$(VPYTEST) tests/baserow/contrib/builder -n 10 || exit
+	$(VPYTEST) tests/baserow/contrib/integrations tests/baserow/contrib/builder -n 10 || exit
+
+test-automation: .check-dev
+	$(VPYTEST) tests/baserow/contrib/integrations tests/baserow/contrib/automation || exit
+
+test-automation-parallel: .check-dev
+	$(VPYTEST) tests/baserow/contrib/integrations tests/baserow/contrib/automation -n 10 || exit
 
 test-regenerate-ci-durations: .check-dev
 	$(VPYTEST) $(BACKEND_TESTS_DIRS) --store-durations || exit;

backend/src/baserow/contrib/automation/api/nodes/errors.py

@@ -48,3 +48,9 @@
     HTTP_400_BAD_REQUEST,
     "Failed to simulate dispatch: {e}",
 )
+
+ERROR_AUTOMATION_NODE_NOT_MOVABLE = (
+    "ERROR_AUTOMATION_NODE_NOT_MOVABLE",
+    HTTP_400_BAD_REQUEST,
+    "{e}",
+)

backend/src/baserow/contrib/automation/api/nodes/serializers.py

@@ -110,3 +110,15 @@ class ReplaceAutomationNodeSerializer(serializers.Serializer):
         required=True,
         help_text="The type of the new automation node",
     )
+
+
+class MoveAutomationNodeSerializer(serializers.Serializer):
+    previous_node_id = serializers.IntegerField(
+        required=False,
+        help_text="The ID of the node that should be before the moved node.",
+    )
+    previous_node_output = serializers.CharField(
+        required=False,
+        allow_blank=True,
+        help_text="The output UID of the destination.",
+    )

backend/src/baserow/contrib/automation/api/nodes/urls.py

@@ -4,6 +4,7 @@
     AutomationNodesView,
     AutomationNodeView,
     DuplicateAutomationNodeView,
+    MoveAutomationNodeView,
     OrderAutomationNodesView,
     ReplaceAutomationNodeView,
     SimulateDispatchAutomationNodeView,
@@ -42,4 +43,9 @@
         SimulateDispatchAutomationNodeView.as_view(),
         name="simulate_dispatch",
     ),
+    re_path(
+        r"node/(?P<node_id>[0-9]+)/move/$",
+        MoveAutomationNodeView.as_view(),
+        name="move",
+    ),
 ]

backend/src/baserow/contrib/automation/api/nodes/views.py

@@ -21,13 +21,15 @@
     ERROR_AUTOMATION_NODE_MISCONFIGURED_SERVICE,
     ERROR_AUTOMATION_NODE_NOT_DELETABLE,
     ERROR_AUTOMATION_NODE_NOT_IN_WORKFLOW,
+    ERROR_AUTOMATION_NODE_NOT_MOVABLE,
     ERROR_AUTOMATION_NODE_NOT_REPLACEABLE,
     ERROR_AUTOMATION_NODE_SIMULATE_DISPATCH,
     ERROR_AUTOMATION_TRIGGER_NODE_MODIFICATION_DISALLOWED,
 )
 from baserow.contrib.automation.api.nodes.serializers import (
     AutomationNodeSerializer,
     CreateAutomationNodeSerializer,
+    MoveAutomationNodeSerializer,
     OrderAutomationNodesSerializer,
     ReplaceAutomationNodeSerializer,
     UpdateAutomationNodeSerializer,
@@ -39,6 +41,7 @@
     CreateAutomationNodeActionType,
     DeleteAutomationNodeActionType,
     DuplicateAutomationNodeActionType,
+    MoveAutomationNodeActionType,
     OrderAutomationNodesActionType,
     ReplaceAutomationNodeActionType,
     UpdateAutomationNodeActionType,
@@ -49,6 +52,7 @@
     AutomationNodeMisconfiguredService,
     AutomationNodeNotDeletable,
     AutomationNodeNotInWorkflow,
+    AutomationNodeNotMovable,
     AutomationNodeNotReplaceable,
     AutomationNodeSimulateDispatchError,
     AutomationTriggerModificationDisallowed,
@@ -439,3 +443,50 @@ def post(self, request, node_id: int):
         )
 
         return Response(serializer.data)
+
+
+class MoveAutomationNodeView(APIView):
+    permission_classes = (IsAuthenticated,)
+
+    @extend_schema(
+        parameters=[
+            OpenApiParameter(
+                name="node_id",
+                location=OpenApiParameter.PATH,
+                type=OpenApiTypes.INT,
+                description="The node that is to be moved.",
+            ),
+            CLIENT_SESSION_ID_SCHEMA_PARAMETER,
+        ],
+        tags=[AUTOMATION_NODES_TAG],
+        operation_id="move_automation_node",
+        description="Move a node in a workflow to a new position.",
+        request=MoveAutomationNodeSerializer,
+        responses={
+            200: DiscriminatorCustomFieldsMappingSerializer(
+                automation_node_type_registry, AutomationNodeSerializer
+            ),
+            400: get_error_schema(["ERROR_AUTOMATION_NODE_NOT_MOVABLE"]),
+            404: get_error_schema(["ERROR_AUTOMATION_NODE_DOES_NOT_EXIST"]),
+        },
+    )
+    @transaction.atomic
+    @map_exceptions(
+        {
+            AutomationNodeDoesNotExist: ERROR_AUTOMATION_NODE_DOES_NOT_EXIST,
+            AutomationNodeNotMovable: ERROR_AUTOMATION_NODE_NOT_MOVABLE,
+        }
+    )
+    @validate_body(MoveAutomationNodeSerializer)
+    def post(self, request, data: Dict, node_id: int):
+        moved_node = MoveAutomationNodeActionType.do(
+            request.user,
+            node_id,
+            data["previous_node_id"],
+            data["previous_node_output"],
+        )
+        return Response(
+            automation_node_type_registry.get_serializer(
+                moved_node, AutomationNodeSerializer
+            ).data
+        )

backend/src/baserow/contrib/automation/apps.py

@@ -15,6 +15,7 @@ def ready(self):
             CreateAutomationNodeActionType,
             DeleteAutomationNodeActionType,
             DuplicateAutomationNodeActionType,
+            MoveAutomationNodeActionType,
             OrderAutomationNodesActionType,
             ReplaceAutomationNodeActionType,
             UpdateAutomationNodeActionType,
@@ -145,6 +146,7 @@ def ready(self):
             action_type_registry.register(OrderAutomationNodesActionType())
             action_type_registry.register(DuplicateAutomationNodeActionType())
             action_type_registry.register(ReplaceAutomationNodeActionType())
+            action_type_registry.register(MoveAutomationNodeActionType())
 
             action_scope_registry.register(WorkflowActionScopeType())
 

backend/src/baserow/contrib/automation/nodes/actions.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Any, List
+from typing import Any, List, Optional
 
 from django.contrib.auth.models import AbstractUser
 from django.utils.translation import gettext_lazy as _
@@ -10,7 +10,7 @@
 )
 from baserow.contrib.automation.actions import AUTOMATION_WORKFLOW_CONTEXT
 from baserow.contrib.automation.nodes.handler import AutomationNodeHandler
-from baserow.contrib.automation.nodes.models import AutomationNode
+from baserow.contrib.automation.nodes.models import AutomationActionNode, AutomationNode
 from baserow.contrib.automation.nodes.node_types import AutomationNodeType
 from baserow.contrib.automation.nodes.registries import (
     ReplaceAutomationNodeTrashOperationType,
@@ -483,3 +483,122 @@ def redo(
             deleted_node=deleted_node,
             user=user,
         )
+
+
+class MoveAutomationNodeActionType(UndoableActionType):
+    type = "move_automation_node"
+    description = ActionTypeDescription(
+        _("Moved automation node"),
+        _("Node (%(node_id)s) moved"),
+        NODE_ACTION_CONTEXT,
+    )
+
+    @dataclass
+    class Params:
+        automation_id: int
+        automation_name: str
+        workflow_id: int
+        node_id: int
+        node_type: str
+        origin_previous_node_id: int
+        origin_previous_node_output: str
+        origin_new_next_nodes_values: List[NextAutomationNodeValues]
+        origin_old_next_nodes_values: List[NextAutomationNodeValues]
+        destination_previous_node_id: int
+        destination_previous_node_output: str
+        destination_new_next_nodes_values: List[NextAutomationNodeValues]
+        destination_old_next_nodes_values: List[NextAutomationNodeValues]
+
+    @classmethod
+    def do(
+        cls,
+        user: AbstractUser,
+        node_id: int,
+        new_previous_node_id: int,
+        new_previous_node_output: Optional[str] = None,
+    ) -> AutomationActionNode:
+        move = AutomationNodeService().move_node(
+            user, node_id, new_previous_node_id, new_previous_node_output
+        )
+        workflow = move.node.workflow
+        cls.register_action(
+            user=user,
+            params=cls.Params(
+                workflow.automation_id,
+                workflow.automation.name,
+                workflow.id,
+                move.node.id,
+                move.node.get_type().type,
+                move.origin_previous_node_id,
+                move.origin_previous_node_output,
+                move.origin_new_next_nodes_values,
+                move.origin_old_next_nodes_values,
+                move.destination_previous_node_id,
+                move.destination_previous_node_output,
+                move.destination_new_next_nodes_values,
+                move.destination_old_next_nodes_values,
+            ),
+            scope=cls.scope(workflow.id),
+            workspace=workflow.automation.workspace,
+        )
+        return move.node
+
+    @classmethod
+    def scope(cls, workflow_id):
+        return WorkflowActionScopeType.value(workflow_id)
+
+    @classmethod
+    def undo(
+        cls,
+        user: AbstractUser,
+        params: Params,
+        action_to_undo: Action,
+    ):
+        # Revert the node to its original position & output (if applicable).
+        AutomationNodeService().update_node(
+            user,
+            params.node_id,
+            previous_node_id=params.origin_previous_node_id,
+            previous_node_output=params.origin_previous_node_output,
+        )
+
+        # Pluck out the workflow, we need it to send our signals for next nodes.
+        workflow = AutomationWorkflowService().get_workflow(user, params.workflow_id)
+
+        # Revert the origin's next nodes back to their original position.
+        AutomationNodeService().update_next_nodes_values(
+            user, params.origin_old_next_nodes_values, workflow
+        )
+
+        # Revert the destination's next nodes back to their original position.
+        AutomationNodeService().update_next_nodes_values(
+            user, params.destination_old_next_nodes_values, workflow
+        )
+
+    @classmethod
+    def redo(
+        cls,
+        user: AbstractUser,
+        params: Params,
+        action_to_redo: Action,
+    ):
+        # Set the node to its new position & output (if applicable).
+        AutomationNodeService().update_node(
+            user,
+            params.node_id,
+            previous_node_id=params.destination_previous_node_id,
+            previous_node_output=params.destination_previous_node_output,
+        )
+
+        # Pluck out the workflow, we need it to send our signals for next nodes.
+        workflow = AutomationWorkflowService().get_workflow(user, params.workflow_id)
+
+        # Set the origin's next nodes to their new position.
+        AutomationNodeService().update_next_nodes_values(
+            user, params.origin_new_next_nodes_values, workflow
+        )
+
+        # Set the destination's next nodes to their new position.
+        AutomationNodeService().update_next_nodes_values(
+            user, params.destination_new_next_nodes_values, workflow
+        )

backend/src/baserow/contrib/automation/nodes/exceptions.py

@@ -66,3 +66,10 @@ class AutomationNodeNotReplaceable(AutomationNodeError):
 
 class AutomationNodeSimulateDispatchError(AutomationNodeError):
     """Raised when there is an error while simulating a dispatch of a node."""
+
+
+class AutomationNodeNotMovable(AutomationNodeError):
+    """
+    Raised when an automation node is not movable. This can happen if
+    the node's type dictates that it cannot be moved due to its state.
+    """