feat(rules): add duplicate-task-headers rule

Related to camunda/linting#4 Co-authored-by: Niklas Kiefer <[email protected]>
camunda · Aug 18, 2022 · 4eb57f1 · 4eb57f1
1 parent b815fca
commit 4eb57f1
Show file tree

Hide file tree

Showing 5 changed files with 477 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -7,6 +7,7 @@ module.exports = {
       rules: {
         'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud10 ],
         'called-element': 'error',
+        'duplicate-task-headers': 'error',
         'element-type': [ 'error', elementTypeConfig.camundaCloud10 ],
         'error-reference': 'error',
         'loop-characteristics': 'error',
@@ -20,6 +21,7 @@ module.exports = {
       rules: {
         'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
         'called-element': 'error',
+        'duplicate-task-headers': 'error',
         'element-type': [ 'error', elementTypeConfig.camundaCloud11 ],
         'error-reference': 'error',
         'loop-characteristics': 'error',
@@ -33,6 +35,7 @@ module.exports = {
       rules: {
         'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
         'called-element': 'error',
+        'duplicate-task-headers': 'error',
         'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
         'error-reference': 'error',
         'loop-characteristics': 'error',
@@ -46,6 +49,7 @@ module.exports = {
       rules: {
         'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
         'called-element': 'error',
+        'duplicate-task-headers': 'error',
         'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
         'error-reference': 'error',
         'loop-characteristics': 'error',
@@ -59,6 +63,7 @@ module.exports = {
       rules: {
         'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
         'called-element': 'error',
+        'duplicate-task-headers': 'error',
         'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
         'error-reference': 'error',
         'loop-characteristics': 'error',

diff --git a/rules/duplicate-task-headers.js b/rules/duplicate-task-headers.js
@@ -0,0 +1,54 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  getMessageEventDefinition,
+  hasDuplicatedPropertyValues
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask') && !isZeebeServiceTask(node)) {
+      return;
+    }
+
+    const taskHeaders = findExtensionElement(node, 'zeebe:TaskHeaders');
+
+    if (!taskHeaders) {
+      return;
+    }
+
+    const errors = hasDuplicatedPropertyValues(taskHeaders, 'values', 'key', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};
+
+
+// helper ///////////////
+
+function isZeebeServiceTask(element) {
+  if (!is(element, 'zeebe:ZeebeServiceTask')) {
+    return false;
+  }
+
+  if (is(element, 'bpmn:EndEvent') || is(element, 'bpmn:IntermediateThrowEvent')) {
+    return !!getMessageEventDefinition(element);
+  }
+
+  // A BusinessRuleTask is per default not a ServiceTask, only if it has a TaskDefinition
+  // (ie. if the implementation is set to ==JobWorker)
+  if (is(element, 'bpmn:BusinessRuleTask') && !findExtensionElement(element, 'zeebe:TaskDefinition')) {
+    return false;
+  }
+
+  return true;
+}
diff --git a/rules/utils/element.js b/rules/utils/element.js
@@ -5,20 +5,33 @@ const {
   some
 } = require('min-dash');
 
-const { isAny } = require('bpmnlint-utils');
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
 
 const { getPath } = require('@bpmn-io/moddle-utils');
 
 const { ERROR_TYPES } = require('./error-types');
 
 module.exports.ERROR_TYPES = ERROR_TYPES;
 
-module.exports.getEventDefinition = function(node) {
+function getEventDefinition(node) {
   const eventDefinitions = node.get('eventDefinitions');
 
   if (eventDefinitions) {
     return eventDefinitions[ 0 ];
   }
+}
+
+module.exports.getEventDefinition = getEventDefinition;
+
+module.exports.getMessageEventDefinition = function(node) {
+  if (is(node, 'bpmn:ReceiveTask')) {
+    return node;
+  }
+
+  return getEventDefinition(node);
 };
 
 function findExtensionElements(node, types) {