bpmnlint-plugin-camunda-compat 0.9.1 → 0.11.0

package/index.js

@@ -1,71 +1,62 @@
+const { omit } = require('min-dash');
+
 const calledDecisionOrTaskDefinitionConfig = require('./rules/called-decision-or-task-definition/config'),
       elementTypeConfig = require('./rules/element-type/config');
 
+const camundaCloud10Rules = {
+  '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',
+  'message-reference': 'error',
+  'no-template': 'error',
+  'no-zeebe-properties': 'error',
+  'subscription': 'error',
+  'user-task-form': 'error'
+};
+
+const camundaCloud11Rules = {
+  ...camundaCloud10Rules,
+  'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
+  'element-type': [ 'error', elementTypeConfig.camundaCloud11 ]
+};
+
+const camundaCloud12Rules = {
+  ...camundaCloud11Rules,
+  'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
+  'element-type': [ 'error', elementTypeConfig.camundaCloud12 ]
+};
+
+const camundaCloud13Rules = {
+  ...camundaCloud12Rules,
+  'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ]
+};
+
+const camundaCloud80Rules = omit(camundaCloud13Rules, 'no-template');
+
+const camundaCloud81Rules = omit(camundaCloud13Rules, 'no-zeebe-properties');
+
 module.exports = {
   configs: {
     'camunda-cloud-1-0': {
-      rules: {
-        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud10 ],
-        'called-element': 'error',
-        'element-type': [ 'error', elementTypeConfig.camundaCloud10 ],
-        'error-reference': 'error',
-        'loop-characteristics': 'error',
-        'message-reference': 'error',
-        'no-template': 'error',
-        'subscription': 'error',
-        'user-task-form': 'error'
-      }
+      rules: camundaCloud10Rules
     },
     'camunda-cloud-1-1': {
-      rules: {
-        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
-        'called-element': 'error',
-        'element-type': [ 'error', elementTypeConfig.camundaCloud11 ],
-        'error-reference': 'error',
-        'loop-characteristics': 'error',
-        'message-reference': 'error',
-        'no-template': 'error',
-        'subscription': 'error',
-        'user-task-form': 'error'
-      }
+      rules: camundaCloud11Rules
     },
     'camunda-cloud-1-2': {
-      rules: {
-        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
-        'called-element': 'error',
-        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
-        'error-reference': 'error',
-        'loop-characteristics': 'error',
-        'message-reference': 'error',
-        'no-template': 'error',
-        'subscription': 'error',
-        'user-task-form': 'error'
-      }
+      rules: camundaCloud12Rules
     },
     'camunda-cloud-1-3': {
-      rules: {
-        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
-        'called-element': 'error',
-        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
-        'error-reference': 'error',
-        'loop-characteristics': 'error',
-        'message-reference': 'error',
-        'no-template': 'error',
-        'subscription': 'error',
-        'user-task-form': 'error'
-      }
+      rules: camundaCloud13Rules
     },
     'camunda-cloud-8-0': {
-      rules: {
-        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
-        'called-element': 'error',
-        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
-        'error-reference': 'error',
-        'loop-characteristics': 'error',
-        'message-reference': 'error',
-        'subscription': 'error',
-        'user-task-form': 'error'
-      }
+      rules: camundaCloud80Rules
+    },
+    'camunda-cloud-8-1': {
+      rules: camundaCloud81Rules
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.9.1",
+  "version": "0.11.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -23,21 +23,21 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "bpmn-moddle": "^7.1.2",
+    "bpmn-moddle": "^7.1.3",
     "bpmnlint": "^7.8.0",
-    "chai": "^4.3.5",
-    "eslint": "^7.32.0",
-    "eslint-plugin-bpmn-io": "^0.13.0",
-    "mocha": "^5.2.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.23.0",
+    "eslint-plugin-bpmn-io": "^0.14.1",
+    "mocha": "^10.0.0",
     "modeler-moddle": "^0.1.0",
-    "sinon": "^13.0.1",
+    "sinon": "^14.0.0",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.12.1"
+    "zeebe-bpmn-moddle": "^0.14.0"
   },
   "dependencies": {
     "@bpmn-io/moddle-utils": "^0.1.0",
     "bpmnlint-utils": "^1.0.2",
-    "min-dash": "^3.8.0"
+    "min-dash": "^3.8.1"
   },
   "files": [
     "rules",

package/rules/called-decision-or-task-definition/index.js

@@ -8,9 +8,8 @@ const { getPath } = require('@bpmn-io/moddle-utils');
 const {
   findExtensionElement,
   getEventDefinition,
-  hasProperties,
-  hasExtensionElementOfType,
-  hasExtensionElementsOfTypes
+  hasExtensionElement,
+  hasProperties
 } = require('../utils/element');
 
 const { reportErrors } = require('../utils/reporter');
@@ -99,14 +98,14 @@ module.exports = function(config) {
     }
 
     if (isAny(node, elementsCalledDecision) && isAny(node, elementsTaskDefinition)) {
-      errors = hasExtensionElementsOfTypes(node, [
+      errors = hasExtensionElement(node, [
         'zeebe:CalledDecision',
         'zeebe:TaskDefinition'
-      ], node, true);
+      ], node);
     } else if (isAny(node, elementsCalledDecision)) {
-      errors = hasExtensionElementOfType(node, 'zeebe:CalledDecision', node);
+      errors = hasExtensionElement(node, 'zeebe:CalledDecision', node);
     } else {
-      errors = hasExtensionElementOfType(node, 'zeebe:TaskDefinition', node);
+      errors = hasExtensionElement(node, 'zeebe:TaskDefinition', node);
     }
 
     if (errors && errors.length) {

package/rules/called-element.js

@@ -2,7 +2,7 @@ const { is } = require('bpmnlint-utils');
 
 const {
   findExtensionElement,
-  hasExtensionElementOfType,
+  hasExtensionElement,
   hasProperties
 } = require('./utils/element');
 
@@ -14,7 +14,7 @@ module.exports = function() {
       return;
     }
 
-    let errors = hasExtensionElementOfType(node, 'zeebe:CalledElement', node);
+    let errors = hasExtensionElement(node, 'zeebe:CalledElement', node);
 
     if (errors && errors.length) {
       reportErrors(node, reporter, errors);

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/loop-characteristics.js

@@ -3,7 +3,7 @@ const { is } = require('bpmnlint-utils');
 const {
   findExtensionElement,
   hasProperties,
-  hasExtensionElementOfType
+  hasExtensionElement
 } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
@@ -32,7 +32,7 @@ module.exports = function() {
       return;
     }
 
-    errors = hasExtensionElementOfType(loopCharacteristics, 'zeebe:LoopCharacteristics', node);
+    errors = hasExtensionElement(loopCharacteristics, 'zeebe:LoopCharacteristics', node);
 
     if (errors && errors.length) {
       reportErrors(node, reporter, errors);

package/rules/no-zeebe-properties.js

@@ -0,0 +1,23 @@
+const { is } = require('bpmnlint-utils');
+
+const { hasNoExtensionElement } = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'zeebe:PropertiesHolder')) {
+      return;
+    }
+
+    const errors = hasNoExtensionElement(node, 'zeebe:Properties', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};

package/rules/subscription.js

@@ -6,7 +6,7 @@ const {
 const {
   findExtensionElement,
   getEventDefinition,
-  hasExtensionElementOfType,
+  hasExtensionElement,
   hasProperties
 } = require('./utils/element');
 
@@ -37,7 +37,7 @@ module.exports = function() {
       return;
     }
 
-    let errors = hasExtensionElementOfType(messageRef, 'zeebe:Subscription', node);
+    let errors = hasExtensionElement(messageRef, 'zeebe:Subscription', node);
 
     if (errors && errors.length) {
       reportErrors(node, reporter, errors);

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;
@@ -132,7 +190,7 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       return [
         ...results,
         {
-          message: `Property <${ propertyName }> of type <${ propertyValue.$type }> not allowed`,
+          message: `Element of type <${ node.$type }> must not have property <${ propertyName }> of type <${ propertyValue.$type }>`,
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
@@ -147,11 +205,11 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       ];
     }
 
-    if (propertyChecks.allowed === false && isDefined(propertyValue)) {
+    if (propertyChecks.allowed === false && isDefined(propertyValue) && !isNil(propertyValue)) {
       return [
         ...results,
         {
-          message: `Property <${ propertyName }> not allowed`,
+          message: `Element of type <${ node.$type }> must not have property <${ propertyName }>`,
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
@@ -169,38 +227,21 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
   }, []);
 };
 
-module.exports.hasExtensionElementsOfTypes = function(node, types, parentNode = null, exclusive = false) {
-  const extensionElements = findExtensionElements(node, types);
+module.exports.hasExtensionElement = function(node, types, parentNode = null) {
+  const typesArray = isArray(types) ? types : [ types ];
 
-  if (!extensionElements || !extensionElements.length) {
-    return [
-      {
-        message: exclusive
-          ? `Element of type <${ node.$type }> must have one extension element of type ${ formatTypes(types, true) }`
-          : `Element of type <${ node.$type }> must have one or many extension elements of type ${ formatTypes(types, true) }`,
-        path: getPath(node, parentNode),
-        error: {
-          type: ERROR_TYPES.EXTENSION_ELEMENT_REQUIRED,
-          node,
-          parentNode: parentNode == node ? null : parentNode,
-          requiredExtensionElement: types,
-          exclusive
-        }
-      }
-    ];
-  }
+  const extensionElements = findExtensionElements(node, typesArray);
 
-  if (exclusive && extensionElements.length > 1) {
+  if (!extensionElements || extensionElements.length !== 1) {
     return [
       {
-        message: `Element of type <${ node.$type }> must have one extension element of type ${ formatTypes(types, true) }`,
+        message: `Element of type <${ node.$type }> must have one extension element of type ${ formatTypes(typesArray, true) }`,
         path: getPath(node, parentNode),
         error: {
           type: ERROR_TYPES.EXTENSION_ELEMENT_REQUIRED,
           node,
           parentNode: parentNode == node ? null : parentNode,
-          requiredExtensionElement: types,
-          exclusive
+          requiredExtensionElement: types
         }
       }
     ];
@@ -209,19 +250,19 @@ module.exports.hasExtensionElementsOfTypes = function(node, types, parentNode =
   return [];
 };
 
-module.exports.hasExtensionElementOfType = function(node, type, parentNode = null) {
+module.exports.hasNoExtensionElement = function(node, type, parentNode = null) {
   const extensionElement = findExtensionElement(node, type);
 
-  if (!extensionElement) {
+  if (extensionElement) {
     return [
       {
-        message: `Element of type <${ node.$type }> must have extension element of type <${ type }>`,
-        path: getPath(node, parentNode),
+        message: `Element of type <${ node.$type }> must not have extension element of type <${ type }>`,
+        path: getPath(extensionElement, parentNode),
         error: {
-          type: ERROR_TYPES.EXTENSION_ELEMENT_REQUIRED,
+          type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
           node,
           parentNode: parentNode == node ? null : parentNode,
-          requiredExtensionElement: type
+          extensionElement
         }
       }
     ];

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/CHANGELOG.md

@@ -1,83 +0,0 @@
-# Changelog
-
-All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat) are documented here. We use [semantic versioning](http://semver.org/) for releases.
-
-## Unreleased
-
-___Note:__ Yet to be released changes appear here._
-
-## 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))
-
-## 0.8.0
-
-* `FEAT`: add templates rule ([#31](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/31))
-
-## 0.7.1
-
-* `FIX`: lint subscription only if start event child of sub process ([#34](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/34))
-
-## 0.7.0
-
-* `FEAT`: refactor plugin structure ([#29](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/29))
-* `DEPS`: update to `bpmnlint@7.8.0` ([#29](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/29))
-
-### Breaking Changes
-
-* configuration not selected based on execution platform and version anymore, either configure manually or use [`@camunda/linting`](https://github.com/camunda/linting)
-* error message not adjusted to be shown in Camunda Modeler anymore
-* error type ELEMENT_TYPE changed to ELEMENT_TYPE_NOT_ALLOWED
-* error type PROPERTY_TYPE changed to PROPERTY_TYPE_NOT_ALLOWED
-* error data changed (cf. docs/ERRORS.md)
-
-## 0.6.2
-
-* `FIX`: fix error message formatting ([#27](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/27))
-
-## 0.6.1
-
-* `FIX`: lanes supported ([#26](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/26))
-
-## 0.6.0
-
-* `FEAT`: adjust error messages to be more friendly ([#22](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/22))
-* `FEAT`: lint error code and message name ([#21](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/21))
-* `FIX`: task definition retries not required ([#20](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/20))
-
-## 0.5.0
-
-* `FEAT`: update Camunda Cloud rules to lint extension elements and their properties ([#18](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/18))
-
-## 0.4.0
-
-* `CHORE`: rename `Cloud` `1.4` to `8.0` ([#14](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/14))
-* `CHORE`: rename `Cloud` to `Platform`/`Zeebe` ([#15](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/15))
-
-## 0.3.0
-
-* `FEAT`: support multiInstance for subprocesses with cloud 1.0 ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
-* `FEAT`: add Camunda Platform rules ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
-* `FEAT`: add Camunda Cloud 1.4 rule ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
-* `TEST`: add Cloud 1.1, 1.2, 1.3 integration tests ([#4](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/4))
-* `TEST`: verify exported configs ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
-* `DEPS`: fix security audit warnings ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
-* `DOCS`: update link to documentation
-* `DOCS`: link Camunda Cloud and Platform BPMN coverage
-
-## 0.2.0
-
-* `FEAT`: early return if execution platform does not match
-* `FIX`: correct check for `bpmn:BaseElement`
-
-## 0.1.1
-
-* `FEAT`: initial support for Camunda Cloud 1.0, 1.1, 1.2, and 1.3
-
-## ...
-
-Check `git log` for earlier history.