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

Related to camunda/linting#4
Co-authored-by: Niklas Kiefer <[email protected]>

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',

rules/duplicate-task-headers.js

@@ -0,0 +1,57 @@
+const {
+  is,
+  isAny
+} = 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
+  };
+};
+
+// helpers //////////
+
+function isZeebeServiceTask(element) {
+  if (is(element, 'zeebe:ZeebeServiceTask')) {
+    return true;
+  }
+
+  if (isAny(element, [
+    'bpmn:EndEvent',
+    'bpmn:IntermediateThrowEvent'
+  ])) {
+    return getMessageEventDefinition(element);
+  }
+
+  if (is(element, 'bpmn:BusinessRuleTask')) {
+    return findExtensionElement(element, 'zeebe:TaskDefinition');
+  }
+
+  return false;
+}

rules/user-task-form.js

@@ -56,6 +56,8 @@ module.exports = function() {
   };
 };
 
+// helpers //////////
+
 function findUserTaskForm(node, formKey) {
   const process = findParent(node, 'bpmn:Process');
 

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) {