bpmnlint-plugin-camunda-compat 0.18.0 → 0.20.0

package/index.js

@@ -10,6 +10,7 @@ const camundaCloud10Rules = {
   'executable-process': 'error',
   'loop-characteristics': 'error',
   'message-reference': 'error',
+  'no-candidate-users': 'error',
   'no-expression': [ 'error', { version: '1.0' } ],
   'no-template': 'error',
   'no-zeebe-properties': 'error',
@@ -62,9 +63,10 @@ const camundaCloud81Rules = {
 };
 
 const camundaCloud82Rules = {
-  ...camundaCloud81Rules,
+  ...omit(camundaCloud81Rules, 'no-candidate-users'),
   'implementation': [ 'error', { version: '8.2' } ],
   'element-type': [ 'error', { version: '8.2' } ],
+  'escalation-reference': 'error',
   'no-expression': [ 'error', { version: '8.2' } ],
   'timer': [ 'error', { version: '8.2' } ]
 };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
     "all": "npm run lint && npm test",
     "dev": "npm run test:watch",
     "lint": "eslint .",
-    "test": "mocha test/**/*.spec.js",
+    "test": "mocha 'test/**/*.spec.js'",
     "test:watch": "npm run test -- --watch"
   },
   "repository": {

package/rules/element-type/config.js

@@ -2,6 +2,7 @@ module.exports = {
   'bpmn:Association': '1.0',
   'bpmn:BoundaryEvent': {
     'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.0',
     'bpmn:TimerEventDefinition': '1.0'
   },
@@ -15,6 +16,7 @@ module.exports = {
   'bpmn:EndEvent': {
     '_': '1.0',
     'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.2',
     'bpmn:TerminateEventDefinition': '8.1'
   },
@@ -29,6 +31,7 @@ module.exports = {
   },
   'bpmn:IntermediateThrowEvent': {
     '_': '1.1',
+    'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.2',
     'bpmn:LinkEventDefinition': '8.2'
   },
@@ -45,6 +48,7 @@ module.exports = {
   'bpmn:StartEvent': {
     '_': '1.0',
     'bpmn:ErrorEventDefinition': '1.0',
+    'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.0',
     'bpmn:TimerEventDefinition': '1.0'
   },

package/rules/escalation-reference.js

@@ -0,0 +1,53 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+      return;
+    }
+
+    let errors = hasProperties(eventDefinition, {
+      escalationRef: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const escalationRef = eventDefinition.get('escalationRef');
+
+    errors = hasProperties(escalationRef, {
+      escalationCode: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};

package/rules/no-candidate-users.js

@@ -0,0 +1,37 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const assignmentDefinition = findExtensionElement(node, 'zeebe:AssignmentDefinition');
+
+    if (!assignmentDefinition) {
+      return;
+    }
+
+    const errors = hasProperties(assignmentDefinition, {
+      candidateUsers: {
+        allowed: false,
+        allowedVersion: '8.2'
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};

package/rules/no-expression.js

@@ -1,6 +1,5 @@
 const {
-  is,
-  isAny
+  is
 } = require('bpmnlint-utils');
 
 const { getPath } = require('@bpmn-io/moddle-utils');
@@ -31,7 +30,10 @@ const handlersMap = {
   '8.1': [
     checkErrorCode
   ],
-  '8.2': []
+  '8.2': [
+    checkErrorCatchEvent,
+    checkEscalationCatchEvent
+  ]
 };
 
 module.exports = noExpressionRule;
@@ -58,7 +60,7 @@ function checkForVersion(node, version) {
   const handlers = handlersMap[version];
 
   return handlers.reduce((errors, handler) => {
-    const handlerErrors = handler(node, version) || [];
+    const handlerErrors = handler(node) || [];
     return errors.concat(handlerErrors);
   }, []);
 }
@@ -71,8 +73,12 @@ function noExpression(node, propertyName, parentNode, allowedVersion) {
     return;
   }
 
+  const errorMessage = allowedVersion ?
+    `Expression statement <${truncate(propertyValue)}> only supported by Camunda Platform ${allowedVersion} or newer` :
+    `Expression statement <${truncate(propertyValue)}> not supported`;
+
   return {
-    message: `Expression statement <${truncate(propertyValue)}> only supported by Camunda Platform 8.2 or newer`,
+    message: errorMessage,
     path: path
       ? [ ...path, propertyName ]
       : [ propertyName ],
@@ -91,7 +97,7 @@ function isExpression(value) {
 }
 
 function checkErrorCode(node) {
-  if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+  if (!is(node, 'bpmn:Event')) {
     return;
   }
 
@@ -107,7 +113,39 @@ function checkErrorCode(node) {
     return;
   }
 
-  return errorRef && noExpression(errorRef, 'errorCode', node, '8.2');
+  if (is(node, 'bpmn:CatchEvent')) {
+    return noExpression(errorRef, 'errorCode', node, null);
+  } else {
+    return noExpression(errorRef, 'errorCode', node, '8.2');
+  }
+}
+
+function checkErrorCatchEvent(node) {
+  if (!is(node, 'bpmn:CatchEvent')) {
+    return;
+  }
+
+  return checkErrorCode(node);
+}
+
+function checkEscalationCatchEvent(node) {
+  if (!is(node, 'bpmn:CatchEvent')) {
+    return;
+  }
+
+  const eventDefinition = getEventDefinition(node);
+
+  if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+    return;
+  }
+
+  const escalationRef = eventDefinition.get('escalationRef');
+
+  if (!escalationRef) {
+    return;
+  }
+
+  return noExpression(escalationRef, 'escalationCode', node, null);
 }
 
 function truncate(string, maxLength = 10) {