bpmnlint-plugin-camunda-compat 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -6,6 +6,19 @@ All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camun
 
 ___Note:__ Yet to be released changes appear here._
 
+## 0.10.0
+
+* `FEAT`: add duplicate task headers rule ([#41](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/41))
+
+
+## 0.9.2
+
+* `FIX`: ignore null properties ([#39](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/39))
+
+## 0.9.1
+
+* `FIX`: add name to reports ([#38](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/38))
+
 ## 0.9.0
 
 * `FEAT`: add user task forms rule ([#32](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/32))

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {

package/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;
+}

package/rules/user-task-form.js

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

package/rules/utils/element.js

@@ -1,10 +1,14 @@
 const {
   isArray,
   isDefined,
+  isNil,
   some
 } = require('min-dash');
 
-const { isAny } = require('bpmnlint-utils');
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
 
 const { getPath } = require('@bpmn-io/moddle-utils');
 
@@ -12,12 +16,22 @@ 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) {
@@ -71,6 +85,50 @@ function formatTypes(types, exclusive = false) {
 
 module.exports.formatTypes = formatTypes;
 
+module.exports.hasDuplicatedPropertyValues = function(node, propertiesName, propertyName, parentNode = null) {
+  const properties = node.get(propertiesName);
+
+  const propertyValues = properties.map(property => property.get(propertyName));
+
+  // (1) find duplicates
+  const duplicates = propertyValues.reduce((duplicates, propertyValue, index) => {
+    if (propertyValues.indexOf(propertyValue) !== index && !duplicates.includes(propertyValue)) {
+      return [
+        ...duplicates,
+        propertyValue
+      ];
+    }
+
+    return duplicates;
+  }, []);
+
+  // (2) report error for each duplicate
+  if (duplicates.length) {
+    return duplicates.map(duplicate => {
+
+      // (3) find properties with duplicate
+      const duplicateProperties = properties.filter(property => property.get(propertyName) === duplicate);
+
+      // (4) report error
+      return {
+        message: `Properties of type <${ duplicateProperties[ 0 ].$type }> have property <${ propertyName }> with duplicate value of <${ duplicate }>`,
+        path: null,
+        error: {
+          type: ERROR_TYPES.PROPERTY_VALUE_DUPLICATED,
+          node,
+          parentNode: parentNode == node ? null : parentNode,
+          duplicatedProperty: propertyName,
+          duplicatedPropertyValue: duplicate,
+          properties: duplicateProperties,
+          propertiesName
+        }
+      };
+    });
+  }
+
+  return [];
+};
+
 module.exports.hasProperties = function(node, properties, parentNode = null) {
   return Object.entries(properties).reduce((results, property) => {
     const [ propertyName, propertyChecks ] = property;
@@ -147,7 +205,7 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       ];
     }
 
-    if (propertyChecks.allowed === false && isDefined(propertyValue)) {
+    if (propertyChecks.allowed === false && isDefined(propertyValue) && !isNil(propertyValue)) {
       return [
         ...results,
         {

package/rules/utils/error-types.js

@@ -5,5 +5,6 @@ module.exports.ERROR_TYPES = Object.freeze({
   PROPERTY_DEPENDEND_REQUIRED: 'propertyDependendRequired',
   PROPERTY_NOT_ALLOWED: 'propertyNotAllowed',
   PROPERTY_REQUIRED: 'propertyRequired',
-  PROPERTY_TYPE_NOT_ALLOWED: 'propertyTypeNotAllowed'
+  PROPERTY_TYPE_NOT_ALLOWED: 'propertyTypeNotAllowed',
+  PROPERTY_VALUE_DUPLICATED: 'propertyValueDuplicated'
 });

package/rules/utils/reporter.js

@@ -1,3 +1,5 @@
+const { is } = require('bpmnlint-utils');
+
 const { isArray } = require('min-dash');
 
 module.exports.reportErrors = function(node, reporter, errors) {
@@ -6,6 +8,31 @@ module.exports.reportErrors = function(node, reporter, errors) {
   }
 
   errors.forEach(({ message, ...options }) => {
+    const name = getName(node);
+
+    if (name) {
+      options = {
+        ...options,
+        name
+      };
+    }
+
     reporter.report(node.get('id'), message, options);
   });
-};
+};
+
+function getName(node) {
+  if (is(node, 'bpmn:TextAnnotation')) {
+    return node.get('text');
+  }
+
+  if (is(node, 'bpmn:Group')) {
+    const categoryValueRef = node.get('categoryValueRef');
+
+    return categoryValueRef && categoryValueRef.get('value');
+  }
+
+  return node.get('name');
+}
+
+module.exports.getName = getName;