#202 Actions on route transitions (#204)

#202 Actions on route transition
2025-12-29 01:21:49 +00:00 · 2018-03-12 22:55:04 +01:00
parent 9ca27d7c12
commit 995e45d28f
19 changed files with 472 additions and 50 deletions
--- a/docs-web/src/main/java/com/sismics/docs/rest/resource/AuditLogResource.java
+++ b/docs-web/src/main/java/com/sismics/docs/rest/resource/AuditLogResource.java
@@ -41,7 +41,7 @@ public class AuditLogResource extends BaseResource {
     * @apiSuccess {String} logs.id ID
     * @apiSuccess {String} logs.username Username
     * @apiSuccess {String} logs.target Entity ID
-     * @apiSuccess {String="Acl","Comment","Document","File","Group","Tag","User","RouteModel"} logs.class Entity type
+     * @apiSuccess {String="Acl","Comment","Document","File","Group","Tag","User","RouteModel","Route"} logs.class Entity type
     * @apiSuccess {String="CREATE","UPDATE","DELETE"} logs.type Type
     * @apiSuccess {String} logs.message Message
     * @apiSuccess {Number} logs.create_date Create date (timestamp)
--- a/docs-web/src/main/java/com/sismics/docs/rest/resource/RouteModelResource.java
+++ b/docs-web/src/main/java/com/sismics/docs/rest/resource/RouteModelResource.java
@@ -1,12 +1,18 @@
 package com.sismics.docs.rest.resource;

+import com.google.common.collect.Lists;
 import com.sismics.docs.core.constant.AclTargetType;
+import com.sismics.docs.core.constant.ActionType;
+import com.sismics.docs.core.constant.RouteStepTransition;
 import com.sismics.docs.core.constant.RouteStepType;
 import com.sismics.docs.core.dao.jpa.GroupDao;
 import com.sismics.docs.core.dao.jpa.RouteModelDao;
+import com.sismics.docs.core.dao.jpa.TagDao;
 import com.sismics.docs.core.dao.jpa.UserDao;
 import com.sismics.docs.core.dao.jpa.criteria.RouteModelCriteria;
+import com.sismics.docs.core.dao.jpa.criteria.TagCriteria;
 import com.sismics.docs.core.dao.jpa.dto.RouteModelDto;
+import com.sismics.docs.core.dao.jpa.dto.TagDto;
 import com.sismics.docs.core.model.jpa.Group;
 import com.sismics.docs.core.model.jpa.RouteModel;
 import com.sismics.docs.core.model.jpa.User;
@@ -120,6 +126,7 @@ public class RouteModelResource extends BaseResource {
    private void validateRouteModelSteps(String steps) {
        UserDao userDao = new UserDao();
        GroupDao groupDao = new GroupDao();
+        TagDao tagDao = new TagDao();

        try (JsonReader reader = Json.createReader(new StringReader(steps))) {
            JsonArray stepsJson = reader.readArray();
@@ -128,19 +135,26 @@ public class RouteModelResource extends BaseResource {
            }
            for (int i = 0; i < stepsJson.size(); i++) {
                JsonObject step = stepsJson.getJsonObject(i);
-                if (step.size() != 3) {
+                if (step.size() != 4) {
                    throw new ClientException("ValidationError", "Steps data not valid");
                }
-                String type = step.getString("type");
+
+                // Name
                ValidationUtil.validateLength(step.getString("name"), "step.name", 1, 200, false);
+
+                // Type
+                String typeStr = step.getString("type");
+                RouteStepType type;
                try {
-                    RouteStepType.valueOf(type);
+                    type = RouteStepType.valueOf(typeStr);
                } catch (IllegalArgumentException e) {
-                    throw new ClientException("ValidationError", type + "is not a valid route step type");
+                    throw new ClientException("ValidationError", typeStr + "is not a valid route step type");
                }
+
+                // Target
                JsonObject target = step.getJsonObject("target");
                if (target.size() != 2) {
-                    throw new ClientException("ValidationError", "Steps data not valid");
+                    throw new ClientException("ValidationError", "Step target is not valid");
                }
                AclTargetType targetType;
                String targetTypeStr = target.getString("type");
@@ -166,6 +180,69 @@ public class RouteModelResource extends BaseResource {
                        }
                        break;
                }
+
+                // Transitions
+                List<RouteStepTransition> transitionsNames = Lists.newArrayList();
+                JsonArray transitions = step.getJsonArray("transitions");
+                if (type == RouteStepType.VALIDATE) {
+                    if (transitions.size() != 1) {
+                        throw new ClientException("ValidationError", "VALIDATE steps should have one transition");
+                    }
+                    transitionsNames.add(RouteStepTransition.VALIDATED);
+                } else if (type == RouteStepType.APPROVE) {
+                    if (transitions.size() != 2) {
+                        throw new ClientException("ValidationError", "APPROVE steps should have two transition");
+                    }
+                    transitionsNames.add(RouteStepTransition.APPROVED);
+                    transitionsNames.add(RouteStepTransition.REJECTED);
+                }
+
+                for (int j = 0; j < transitions.size(); j++) {
+                    // Transition
+                    JsonObject transition = transitions.getJsonObject(j);
+                    if (transition.size() != 2) {
+                        throw new ClientException("ValidationError", "Transition data is not valid");
+                    }
+
+                    // Transition name
+                    String routeStepTransitionStr = transition.getString("name");
+                    ValidationUtil.validateRequired(routeStepTransitionStr, "step.transitions.name");
+                    RouteStepTransition routeStepTransition;
+                    try {
+                        routeStepTransition = RouteStepTransition.valueOf(routeStepTransitionStr);
+                    } catch (IllegalArgumentException e) {
+                        throw new ClientException("ValidationError", routeStepTransitionStr + " is not a valid route step transition type");
+                    }
+                    if (!transitionsNames.contains(routeStepTransition)) {
+                        throw new ClientException("ValidationError", routeStepTransitionStr + " is not allowed for this step type");
+                    }
+
+                    // Actions
+                    JsonArray actions = transition.getJsonArray("actions");
+                    for (int k = 0; k < actions.size(); k++) {
+                        JsonObject action = actions.getJsonObject(k);
+
+                        // Action type
+                        String actionTypeStr = action.getString("type");
+                        ActionType actionType;
+                        ValidationUtil.validateRequired(routeStepTransitionStr, "step.transitions.actions.type");
+                        try {
+                            actionType = ActionType.valueOf(actionTypeStr);
+                        } catch (IllegalArgumentException e) {
+                            throw new ClientException("ValidationError", actionTypeStr + " is not a valid action type");
+                        }
+
+                        // Action custom fields
+                        if (actionType == ActionType.ADD_TAG) {
+                            String tagId = action.getString("tag");
+                            ValidationUtil.validateRequired(routeStepTransitionStr, "step.transitions.actions.tag");
+                            List<TagDto> tagDtoList = tagDao.findByCriteria(new TagCriteria().setId(tagId), null);
+                            if (tagDtoList.size() != 1) {
+                                throw new ClientException("ValidationError", tagId + " is not a valid tag");
+                            }
+                        }
+                    }
+                }
            }
        } catch (JsonException e) {
            throw new ClientException("ValidationError", "Steps data not valid");
--- a/docs-web/src/main/java/com/sismics/docs/rest/resource/RouteResource.java
+++ b/docs-web/src/main/java/com/sismics/docs/rest/resource/RouteResource.java
@@ -1,9 +1,6 @@
 package com.sismics.docs.rest.resource;

-import com.sismics.docs.core.constant.AclTargetType;
-import com.sismics.docs.core.constant.PermType;
-import com.sismics.docs.core.constant.RouteStepTransition;
-import com.sismics.docs.core.constant.RouteStepType;
+import com.sismics.docs.core.constant.*;
 import com.sismics.docs.core.dao.jpa.*;
 import com.sismics.docs.core.dao.jpa.criteria.RouteCriteria;
 import com.sismics.docs.core.dao.jpa.criteria.RouteStepCriteria;
@@ -13,6 +10,7 @@ import com.sismics.docs.core.dao.jpa.dto.RouteStepDto;
 import com.sismics.docs.core.model.jpa.Route;
 import com.sismics.docs.core.model.jpa.RouteModel;
 import com.sismics.docs.core.model.jpa.RouteStep;
+import com.sismics.docs.core.util.ActionUtil;
 import com.sismics.docs.core.util.RoutingUtil;
 import com.sismics.docs.core.util.SecurityUtil;
 import com.sismics.docs.core.util.jpa.SortCriteria;
@@ -93,12 +91,17 @@ public class RouteResource extends BaseResource {
                JsonObject target = step.getJsonObject("target");
                AclTargetType targetType = AclTargetType.valueOf(target.getString("type"));
                String targetName = target.getString("name");
+                String transitions = null;
+                if (step.containsKey("transitions")) {
+                    transitions = step.getJsonArray("transitions").toString();
+                }

                RouteStep routeStep = new RouteStep()
                        .setRouteId(route.getId())
                        .setName(step.getString("name"))
                        .setOrder(order)
                        .setType(RouteStepType.valueOf(step.getString("type")))
+                        .setTransitions(transitions)
                        .setTargetId(SecurityUtil.getTargetIdFromName(targetName, targetType));

                if (routeStep.getTargetId() == null) {
@@ -149,7 +152,9 @@ public class RouteResource extends BaseResource {

        // Get the document
        AclDao aclDao = new AclDao();
-        if (!aclDao.checkPermission(documentId, PermType.READ, getTargetIdList(null))) {
+        DocumentDao documentDao = new DocumentDao();
+        DocumentDto documentDto = documentDao.getDocument(documentId, PermType.READ, getTargetIdList(null));
+        if (documentDto == null) {
            throw new NotFoundException();
        }

@@ -168,18 +173,39 @@ public class RouteResource extends BaseResource {
        // Validate data
        ValidationUtil.validateRequired(transitionStr, "transition");
        comment = ValidationUtil.validateLength(comment, "comment", 1, 500, true);
-        RouteStepTransition transition = RouteStepTransition.valueOf(transitionStr);
-        if (routeStepDto.getType() == RouteStepType.VALIDATE && transition != RouteStepTransition.VALIDATED
-                || routeStepDto.getType() == RouteStepType.APPROVE && transition != RouteStepTransition.APPROVED && transition != RouteStepTransition.REJECTED) {
+        RouteStepTransition routeStepTransition = RouteStepTransition.valueOf(transitionStr);
+        if (routeStepDto.getType() == RouteStepType.VALIDATE && routeStepTransition != RouteStepTransition.VALIDATED
+                || routeStepDto.getType() == RouteStepType.APPROVE
+                && routeStepTransition != RouteStepTransition.APPROVED && routeStepTransition != RouteStepTransition.REJECTED) {
            throw new ClientException("ValidationError", "Invalid transition for this route step type");
        }

        // Validate the step and update ACLs
-        routeStepDao.endRouteStep(routeStepDto.getId(), transition, comment, principal.getId());
+        routeStepDao.endRouteStep(routeStepDto.getId(), routeStepTransition, comment, principal.getId());
        RouteStepDto newRouteStep = routeStepDao.getCurrentStep(documentId);
        RoutingUtil.updateAcl(documentId, newRouteStep, routeStepDto, principal.getId());
        RoutingUtil.sendRouteStepEmail(documentId, routeStepDto);

+        // Execute actions
+        if (routeStepDto.getTransitions() != null) {
+            try (JsonReader reader = Json.createReader(new StringReader(routeStepDto.getTransitions()))) {
+                JsonArray transitions = reader.readArray();
+                // Filter out our transition
+                for (int i = 0; i < transitions.size(); i++) {
+                    JsonObject transition = transitions.getJsonObject(i);
+                    if (transition.getString("name").equals(routeStepTransition.name())) {
+                        // Transition found, execute those actions
+                        JsonArray actions = transition.getJsonArray("actions");
+                        for (int j = 0; j < actions.size(); j++) {
+                            JsonObject action = actions.getJsonObject(j);
+                            ActionType actionType = ActionType.valueOf(action.getString("type"));
+                            ActionUtil.executeAction(actionType, action, documentDto);
+                        }
+                    }
+                }
+            }
+        }
+
        JsonObjectBuilder response = Json.createObjectBuilder()
                .add("readable", aclDao.checkPermission(documentId, PermType.READ, getTargetIdList(null)));
        if (newRouteStep != null) {
--- a/docs-web/src/main/webapp/src/app/docs/controller/settings/SettingsWorkflowEdit.js
+++ b/docs-web/src/main/webapp/src/app/docs/controller/settings/SettingsWorkflowEdit.js
@@ -45,9 +45,11 @@ angular.module('docs').controller('SettingsWorkflowEdit', function($scope, $dial
   * Add a workflow step.
   */
  $scope.addStep = function () {
-    $scope.workflow.steps.push({
+    var step = {
      type: 'VALIDATE'
-    });
+    };
+    $scope.updateTransitions(step);
+    $scope.workflow.steps.push(step);
  };

  /**
@@ -64,6 +66,12 @@ angular.module('docs').controller('SettingsWorkflowEdit', function($scope, $dial
    Restangular.one('routemodel', $stateParams.id).get().then(function (data) {
      $scope.workflow = data;
      $scope.workflow.steps = JSON.parse(data.steps);
+      _.each($scope.workflow.steps, function (step) {
+        if (!step.transitions) {
+          // Patch for old route models
+          $scope.updateTransitions(step);
+        }
+      });
    });
  } else {
    $scope.workflow = {
@@ -124,4 +132,35 @@ angular.module('docs').controller('SettingsWorkflowEdit', function($scope, $dial
  $scope.removeStep = function (step) {
    $scope.workflow.steps.splice($scope.workflow.steps.indexOf(step), 1);
  };
+
+  $scope.updateTransitions = function (step) {
+    if (step.type === 'VALIDATE') {
+      step.transitions = [{
+        name: 'VALIDATED',
+        actions: []
+      }];
+    } else if (step.type === 'APPROVE') {
+      step.transitions = [{
+        name: 'APPROVED',
+        actions: []
+      }, {
+        name: 'REJECTED',
+        actions: []
+      }];
+    }
+  };
+
+  $scope.addAction = function (transition) {
+    transition.actions.push({
+      type: 'ADD_TAG'
+    });
+  };
+
+  $scope.removeAction = function (actions, action) {
+    actions.splice(actions.indexOf(action), 1);
+  };
+
+  Restangular.one('tag/list').get().then(function(data) {
+    $scope.tags = data.tags;
+  });
 });
--- a/docs-web/src/main/webapp/src/locale/en.json
+++ b/docs-web/src/main/webapp/src/locale/en.json
@@ -301,7 +301,9 @@
        "type_validate": "Validate",
        "target": "Assigned to",
        "target_help": "<strong>Approve:</strong> Accept or reject the review<br/><strong>Validate:</strong> Review and continue the workflow",
-        "add_step": "Add a workflow step"
+        "add_step": "Add a workflow step",
+        "actions": "What happens after?",
+        "remove_action": "Remove action"
      }
    },
    "security": {
@@ -507,6 +509,9 @@
    "number": "Number required",
    "no_space": "Spaces are not allowed"
  },
+  "action_type": {
+    "ADD_TAG": "Add this tag"
+  },
  "pagination": {
    "previous": "Previous",
    "next": "Next",
--- a/docs-web/src/main/webapp/src/partial/docs/settings.workflow.edit.html
+++ b/docs-web/src/main/webapp/src/partial/docs/settings.workflow.edit.html
@@ -49,7 +49,7 @@
                      <span class="fas fa-exchange-alt" ng-if="step.type == 'APPROVE'"></span>
                      <span class="fas fa-check-circle" ng-if="step.type == 'VALIDATE'"></span>
                    </span>
-                    <select class="form-control" name="type-{{ $index }}" ng-model="step.type" required>
+                    <select class="form-control" name="type-{{ $index }}" ng-model="step.type" ng-change="updateTransitions(step)" required>
                      <option value="APPROVE">{{ 'settings.workflow.edit.type_approve' | translate }}</option>
                      <option value="VALIDATE">{{ 'settings.workflow.edit.type_validate' | translate }}</option>
                    </select>
@@ -82,17 +82,54 @@
              </div>
            </div>
          </div>
+          <div class="row mt-10">
+            <div class="col-xs-2 text-center">
+              <strong>{{ 'settings.workflow.edit.actions' | translate }}</strong>
+            </div>
+            <div class="col-xs-5" ng-repeat="transition in step.transitions">
+              <div class="panel panel-default">
+                <div class="panel-heading text-center">
+                  <strong>{{ 'workflow_transition.' + transition.name | translate }}</strong>
+                </div>
+                <div class="panel-body">
+                  <div ng-repeat="action in transition.actions" class="mb-10 workflow-action">
+                    <p><strong>{{ 'action_type.' + action.type | translate }}</strong></p>
+                    <div ng-switch="action.type" class="mb-10">
+                      <div ng-switch-when="ADD_TAG">
+                        <select title="{{ 'action_type.ADD_TAG' | translate }}" ng-model="action.tag" required class="form-control">
+                          <option ng-repeat="tag in tags" value="{{ tag.id }}">{{ tag.name }}</option>
+                        </select>
+                      </div>
+                    </div>
+                    <p class="text-center">
+                      <a href ng-click="removeAction(transition.actions, action)">
+                        <span class="fas fa-minus-circle"></span> {{ 'settings.workflow.edit.remove_action' | translate }}
+                      </a>
+                    </p>
+                  </div>
+                  <div class="input-group">
+                    <select title="Action type" class="form-control">
+                      <option name="ADD_TAG">{{ 'action_type.ADD_TAG' | translate }}</option>
+                    </select>
+                    <span class="input-group-addon btn" ng-click="addAction(transition)">
+                      <span class="fas fa-plus-circle"></span>
+                    </span>
+                  </div>
+                </div>
+              </div>
+            </div>
+          </div>
        </div>
      </div>
    </div>

-    <div class="form-group">
+    <div class="clearfix form-group mt-10">
      <div class="col-sm-offset-2 col-sm-10 btn-link pointer" ng-click="addStep()">
        <span class="fas fa-plus-circle"></span> {{ 'settings.workflow.edit.add_step' | translate }}
      </div>
    </div>

-    <div class="form-group">
+    <div class="clearfix form-group mt-10">
      <div class="col-sm-offset-2 col-sm-10">
        <button type="submit" class="btn btn-primary" ng-click="edit()" ng-disabled="!editWorkflowForm.$valid">
          <span class="fas fa-pencil-alt"></span> {{ isEdit() ? 'save' : 'add' | translate }}
--- a/docs-web/src/main/webapp/src/style/main.less
+++ b/docs-web/src/main/webapp/src/style/main.less
@@ -366,6 +366,11 @@ input[readonly].share-link {
  }
 }

+.workflow-action {
+  border: 2px dashed #ccc;
+  padding: 4px;
+}
+
 // Settings
 .settings-menu {
  .panel-default {