Set error message for duplicate-task-headers rule

lib/Linter.js

@@ -12,7 +12,7 @@ import modelerModdle from 'modeler-moddle/resources/modeler.json';
 import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe.json';
 
 import { getErrorMessage } from './utils/error-messages';
-import { getEntryId } from './utils/properties-panel';
+import { getEntryIds } from './utils/properties-panel';
 
 const moddle = new BpmnModdle({
   modeler: modelerModdle,
@@ -63,6 +63,8 @@ export class Linter {
       return [
         ...allReports,
         ...reports.map(report => {
+          const entryIds = getEntryIds(report);
+
           return {
             ...report,
             message: getErrorMessage(
@@ -71,7 +73,7 @@ export class Linter {
               this._modeler
             ),
             propertiesPanel: {
-              entryId: getEntryId(report)
+              entryId: entryIds[ Math.max(0, entryIds.length - 1) ]
             }
           };
         })

lib/utils/error-messages.js

@@ -1,6 +1,7 @@
 import { ERROR_TYPES } from 'bpmnlint-plugin-camunda-compat/rules/utils/element';
 
 import { is } from 'bpmnlint-utils';
+import { every } from 'min-dash';
 
 import { isArray } from 'min-dash';
 
@@ -46,6 +47,10 @@ export function getErrorMessage(report, executionPlatformLabel, modeler = 'deskt
     return getPropertyTypeNotAllowedErrorMessage(report, executionPlatformLabel);
   }
 
+  if (type === ERROR_TYPES.PROPERTY_VALUE_DUPLICATED) {
+    return getPropertyValueDuplicatedErrorMessage(report);
+  }
+
   return message;
 }
 
@@ -73,6 +78,28 @@ function getElementTypeNotAllowedErrorMessage(report, executionPlatformLabel) {
   return `${ getIndefiniteArticle(typeString) } <${ typeString }> is not supported by ${ executionPlatformLabel }`;
 }
 
+function getPropertyValueDuplicatedErrorMessage(report) {
+  const {
+    error,
+    message
+  } = report;
+
+  const {
+    node,
+    parentNode,
+    duplicatedPropertyValue,
+    properties
+  } = error;
+
+  const typeString = getTypeString(parentNode || node);
+
+  if (is(node, 'zeebe:TaskHeaders') && every(properties, property => is(property, 'zeebe:Header'))) {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with two or more <Headers> with the same <Key> (${ duplicatedPropertyValue }) is not supported`;
+  }
+
+  return message;
+}
+
 function getExtensionElementNotAllowedErrorMessage(report, executionPlatformLabel) {
   const {
     error,

lib/utils/properties-panel.js

@@ -4,107 +4,125 @@ import { is } from 'bpmnlint-utils';
 
 import { ERROR_TYPES } from 'bpmnlint-plugin-camunda-compat/rules/utils/error-types';
 
-export function getEntryId(report) {
+/**
+ * Get errors for a given element.
+ *
+ * @param {Object[]} reports
+ * @param {Object} element
+ *
+ * @returns {Object}
+ */
+export function getErrors(reports, element) {
+  return reports.reduce((errors, report) => {
+    if (!element || getBusinessObject(element).get('id') !== report.id) {
+      return errors;
+    }
+
+    const ids = getEntryIds(report);
+
+    if (!ids.length) {
+      return errors;
+    }
+
+    let { message } = report;
+
+    return {
+      ...errors,
+      ...ids.reduce((errors, id) => {
+        return {
+          ...errors,
+          [ id ]: getErrorMessage(id) || message
+        };
+      }, {})
+    };
+  }, {});
+}
+
+export function getEntryIds(report) {
   const {
-    error = {}
+    error = {},
+    id
   } = report;
 
   if (isExtensionElementRequiredError(error, 'zeebe:CalledDecision', 'bpmn:BusinessRuleTask')) {
-    return 'businessRuleImplementation';
+    return [ 'businessRuleImplementation' ];
   }
 
   if (isPropertyRequiredError(error, 'errorRef')) {
-    return 'errorRef';
+    return [ 'errorRef' ];
   }
 
   if (isPropertyRequiredError(error, 'messageRef')) {
-    return 'messageRef';
+    return [ 'messageRef' ];
   }
 
   if (isPropertyRequiredError(error, 'decisionId', 'zeebe:CalledDecision')) {
-    return 'decisionId';
+    return [ 'decisionId' ];
   }
 
   if (isPropertyRequiredError(error, 'resultVariable', 'zeebe:CalledDecision')) {
-    return 'resultVariable';
+    return [ 'resultVariable' ];
   }
 
   if (isPropertyRequiredError(error, 'errorCode', 'bpmn:Error')) {
-    return 'errorCode';
+    return [ 'errorCode' ];
   }
 
   if (isPropertyRequiredError(error, 'name', 'bpmn:Message')) {
-    return 'messageName';
+    return [ 'messageName' ];
   }
 
   if (isExtensionElementRequiredError(error, 'zeebe:LoopCharacteristics', 'bpmn:MultiInstanceLoopCharacteristics')
     || isPropertyRequiredError(error, 'inputCollection', 'zeebe:LoopCharacteristics')) {
-    return 'multiInstance-inputCollection';
+    return [ 'multiInstance-inputCollection' ];
   }
 
   if (isPropertyDependendRequiredError(error, 'outputCollection', 'zeebe:LoopCharacteristics')) {
-    return 'multiInstance-outputCollection';
+    return [ 'multiInstance-outputCollection' ];
   }
 
   if (isPropertyDependendRequiredError(error, 'outputElement', 'zeebe:LoopCharacteristics')) {
-    return 'multiInstance-outputElement';
+    return [ 'multiInstance-outputElement' ];
   }
 
   if (isExtensionElementRequiredError(error, 'zeebe:CalledElement', 'bpmn:CallActivity')
     || isPropertyRequiredError(error, 'processId', 'zeebe:CalledElement')) {
-    return 'targetProcessId';
+    return [ 'targetProcessId' ];
   }
 
   if (isExtensionElementRequiredError(error, 'zeebe:TaskDefinition')
     || isPropertyRequiredError(error, 'type', 'zeebe:TaskDefinition')) {
-    return 'taskDefinitionType';
+    return [ 'taskDefinitionType' ];
   }
 
   if (isExtensionElementRequiredError(error, 'zeebe:Subscription')
     || isPropertyRequiredError(error, 'correlationKey', 'zeebe:Subscription')) {
-    return 'messageSubscriptionCorrelationKey';
+    return [ 'messageSubscriptionCorrelationKey' ];
   }
 
   if (isPropertyRequiredError(error, 'formKey', 'zeebe:FormDefinition')) {
-    return 'customFormKey';
+    return [ 'customFormKey' ];
   }
 
   if (isPropertyRequiredError(error, 'body', 'zeebe:UserTaskForm')) {
-    return 'formConfiguration';
+    return [ 'formConfiguration' ];
   }
 
-  return null;
-}
-
-/**
- * Get errors for a given element.
- *
- * @param {Object[]} reports
- * @param {Object} element
- *
- * @returns {Object}
- */
-export function getErrors(reports, element) {
-  return reports.reduce((errors, report) => {
-    if (!element || getBusinessObject(element).get('id') !== report.id) {
-      return errors;
-    }
-
-    const id = getEntryId(report);
+  if (isPropertyValueDuplicatedError(error, 'values', 'key', 'zeebe:TaskHeaders')) {
+    const {
+      node,
+      properties,
+      propertiesName
+    } = error;
 
-    if (!id) {
-      return errors;
-    }
-
-    let { message } = report;
+    return properties.map(property => {
+      const index = node.get(propertiesName).indexOf(property);
 
-    message = getErrorMessage(id) || message;
+      return `${ id }-header-${ index }-key`;
+    });
+  }
 
-    return {
-      ...errors,
-      [ id ]: message
-    };
-  }, {});
+  return [];
 }
 
 export function getErrorMessage(id) {
@@ -167,6 +185,10 @@ export function getErrorMessage(id) {
   if (id === 'formConfiguration') {
     return 'Form JSON configuration must be defined.';
   }
+
+  if (/^.+-header-[0-9]+-key$/.test(id)) {
+    return 'Must be unique.';
+  }
 }
 
 function isExtensionElementRequiredError(error, requiredExtensionElement, type) {
@@ -188,6 +210,13 @@ function isPropertyRequiredError(error, requiredProperty, type) {
     && (!type || is(error.node, type));
 }
 
+function isPropertyValueDuplicatedError(error, propertiesName, duplicatedProperty, type) {
+  return error.type === ERROR_TYPES.PROPERTY_VALUE_DUPLICATED
+    && error.propertiesName === propertiesName
+    && error.duplicatedProperty === duplicatedProperty
+    && (!type || is(error.node, type));
+}
+
 function getBusinessObject(element) {
   return element.businessObject || element;
 }

package.json

@@ -17,11 +17,15 @@
     "name": "Philipp Fromme",
     "url": "https://github.com/philippfromme"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/camunda/linting"
+  },
   "license": "MIT",
   "dependencies": {
     "bpmn-moddle": "^7.1.2",
     "bpmnlint": "^7.8.0",
-    "bpmnlint-plugin-camunda-compat": "^0.9.2",
+    "bpmnlint-plugin-camunda-compat": "^0.10.0",
     "bpmnlint-utils": "^1.0.2",
     "modeler-moddle": "^0.2.0",
     "zeebe-bpmn-moddle": "^0.12.1"

test/spec/camunda-cloud-1-0-invalid.bpmn

@@ -10,6 +10,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="foo" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-0-valid.bpmn

@@ -10,6 +10,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition type="foo" />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="bar" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-1-invalid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="foo" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-1-valid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition type="foo" />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="bar" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-2-invalid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="foo" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-2-valid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition type="foo" />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="bar" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-3-invalid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="foo" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>

test/spec/camunda-cloud-1-3-valid.bpmn

@@ -11,6 +11,10 @@
     <bpmn:serviceTask id="Activity_0tmvr8k" name="foo">
       <bpmn:extensionElements>
         <zeebe:taskDefinition type="foo" />
+        <zeebe:taskHeaders>
+          <zeebe:header key="foo" />
+          <zeebe:header key="bar" />
+        </zeebe:taskHeaders>
       </bpmn:extensionElements>
       <bpmn:incoming>Flow_1c9prry</bpmn:incoming>
       <bpmn:outgoing>Flow_04jud3f</bpmn:outgoing>