bpmnlint-plugin-camunda-compat 0.16.0 → 0.18.0

package/README.md

@@ -2,28 +2,36 @@
 
 [![CI](https://github.com/camunda/bpmnlint-plugin-camunda-compat/workflows/CI/badge.svg)](https://github.com/camunda/bpmnlint-plugin-camunda-compat/actions?query=workflow%3ACI)
 
-Camunda BPMN compatibility provided as a [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in.
+A [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in that checks whether a given BPMN process can be executed with [Camunda](https://camunda.com/).
 
 
 ## Usage
 
-To configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle), use [`@camunda/linting`](https://github.com/camunda/linting).
+Add configuration corresponding to your execution platform and version to your [`.bpmnlintrc` configuration](https://github.com/bpmn-io/bpmnlint#configuration):
 
-To configure the linter statically, add the configuration corresponding to your execution platform and version to your `.bpmnlintrc` file:
-
-```
+```json
 {
   "extends": [
     "bpmnlint:recommended",
     "plugin:camunda-compat/camunda-cloud-8-0"
-  ]
+  ],
+  "rules": {
+    "camunda-compat/timer": "off"
+  }
 }
 ```
 
+Use [`@camunda/linting`](https://github.com/camunda/linting) to configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle).
+
+
 ## Resources
 
 * [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)
-* BPMN coverage for [Camunda Cloud](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda Platform](https://docs.camunda.org/manual/latest/reference/bpmn20/)
+
+
+## Related
+
+* BPMN coverage for [Camunda 8](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda 7](https://docs.camunda.org/manual/latest/reference/bpmn20/)
 
 
 ## License

package/index.js

@@ -1,7 +1,7 @@
 const { omit } = require('min-dash');
 
 const camundaCloud10Rules = {
-  'called-decision-or-task-definition': [ 'error', { version: '1.0' } ],
+  'implementation': [ 'error', { version: '1.0' } ],
   'called-element': 'error',
   'collapsed-subprocess': 'error',
   'duplicate-task-headers': 'error',
@@ -10,6 +10,7 @@ const camundaCloud10Rules = {
   'executable-process': 'error',
   'loop-characteristics': 'error',
   'message-reference': 'error',
+  'no-expression': [ 'error', { version: '1.0' } ],
   'no-template': 'error',
   'no-zeebe-properties': 'error',
   'sequence-flow-condition': 'error',
@@ -21,44 +22,50 @@ const camundaCloud10Rules = {
 
 const camundaCloud11Rules = {
   ...camundaCloud10Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.1' } ],
+  'implementation': [ 'error', { version: '1.1' } ],
   'element-type': [ 'error', { version: '1.1' } ],
+  'no-expression': [ 'error', { version: '1.1' } ],
   'timer': [ 'error', { version: '1.1' } ]
 };
 
 const camundaCloud12Rules = {
   ...camundaCloud11Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.2' } ],
+  'implementation': [ 'error', { version: '1.2' } ],
   'element-type': [ 'error', { version: '1.2' } ],
+  'no-expression': [ 'error', { version: '1.2' } ],
   'timer': [ 'error', { version: '1.2' } ]
 };
 
 const camundaCloud13Rules = {
   ...camundaCloud12Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '1.3' } ],
+  'implementation': [ 'error', { version: '1.3' } ],
   'element-type': [ 'error', { version: '1.3' } ],
+  'no-expression': [ 'error', { version: '1.3' } ],
   'timer': [ 'error', { version: '1.3' } ]
 };
 
 const camundaCloud80Rules = {
   ...omit(camundaCloud13Rules, 'no-template'),
-  'called-decision-or-task-definition': [ 'error', { version: '8.0' } ],
+  'implementation': [ 'error', { version: '8.0' } ],
   'element-type': [ 'error', { version: '8.0' } ],
+  'no-expression': [ 'error', { version: '8.0' } ],
   'timer': [ 'error', { version: '8.0' } ]
 };
 
 const camundaCloud81Rules = {
   ...omit(camundaCloud80Rules, 'no-zeebe-properties'),
-  'called-decision-or-task-definition': [ 'error', { version: '8.1' } ],
+  'implementation': [ 'error', { version: '8.1' } ],
   'element-type': [ 'error', { version: '8.1' } ],
   'inclusive-gateway': 'error',
+  'no-expression': [ 'error', { version: '8.1' } ],
   'timer': [ 'error', { version: '8.1' } ]
 };
 
 const camundaCloud82Rules = {
   ...camundaCloud81Rules,
-  'called-decision-or-task-definition': [ 'error', { version: '8.2' } ],
+  'implementation': [ 'error', { version: '8.2' } ],
   'element-type': [ 'error', { version: '8.2' } ],
+  'no-expression': [ 'error', { version: '8.2' } ],
   'timer': [ 'error', { version: '8.2' } ]
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -33,7 +33,7 @@
     "modeler-moddle": "^0.1.0",
     "sinon": "^14.0.0",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.14.0"
+    "zeebe-bpmn-moddle": "^0.17.0"
   },
   "dependencies": {
     "@bpmn-io/feel-lint": "^0.1.1",

package/rules/{called-decision-or-task-definition → implementation}/config.js

@@ -5,10 +5,13 @@ module.exports = {
   taskDefinition: {
     'bpmn:BusinessRuleTask': '1.1',
     'bpmn:IntermediateThrowEvent': {
-      'bpmn:MessageEventDefinition': '1.2',
+      'bpmn:MessageEventDefinition': '1.2'
     },
     'bpmn:ScriptTask': '1.1',
     'bpmn:SendTask': '1.1',
     'bpmn:ServiceTask': '1.0'
+  },
+  script: {
+    'bpmn:ScriptTask': '8.2'
   }
 };

package/rules/{called-decision-or-task-definition → implementation}/index.js

@@ -22,10 +22,12 @@ const { ERROR_TYPES } = require('../utils/error-types');
 module.exports = function({ version }) {
   function check(node, reporter) {
     const calledDecisionConfig = config.calledDecision[ node.$type ];
+    const scriptConfig = config.script[ node.$type ];
     const taskDefinitionConfig = config.taskDefinition[ node.$type ];
 
     if (
       (!calledDecisionConfig || (isString(calledDecisionConfig) && !greaterOrEqual(version, calledDecisionConfig)))
+      && (!scriptConfig || (isString(scriptConfig) && !greaterOrEqual(version, scriptConfig)))
       && (!taskDefinitionConfig || (isString(taskDefinitionConfig) && !greaterOrEqual(version, taskDefinitionConfig)))) {
       return;
     }
@@ -37,9 +39,10 @@ module.exports = function({ version }) {
     let errors;
 
     const calledDecision = findExtensionElement(node, 'zeebe:CalledDecision'),
+          script = findExtensionElement(node, 'zeebe:Script'),
           taskDefinition = findExtensionElement(node, 'zeebe:TaskDefinition');
 
-    if (calledDecision && !taskDefinition) {
+    if (calledDecision && !script && !taskDefinition) {
 
       if (!isCalledDecisionAllowed(node, version)) {
         const allowedVersion = getAllowedVersion(calledDecisionConfig, node);
@@ -77,7 +80,45 @@ module.exports = function({ version }) {
       }
     }
 
-    if (!calledDecision && taskDefinition) {
+    if (!calledDecision && script && !taskDefinition) {
+
+      if (!isScriptAllowed(node, version)) {
+        const allowedVersion = getAllowedVersion(scriptConfig, node);
+
+        reportErrors(node, reporter, {
+          message: allowedVersion
+            ? `Extension element of type <zeebe:Script> only allowed by Camunda Platform ${ allowedVersion } or newer`
+            : 'Extension element of type <zeebe:Script> not allowed',
+          path: getPath(script, node),
+          data: {
+            type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
+            node,
+            parentNode: null,
+            extensionElement: script,
+            allowedVersion
+          }
+        });
+
+        return;
+      }
+
+      errors = hasProperties(script, {
+        expression: {
+          required: true
+        },
+        resultVariable: {
+          required: true
+        }
+      }, node);
+
+      if (errors && errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+    }
+
+    if (!calledDecision && !script && taskDefinition) {
 
       if (!isTaskDefinitionAllowed(node, version)) {
         const allowedVersion = getAllowedVersion(taskDefinitionConfig, node);
@@ -110,15 +151,18 @@ module.exports = function({ version }) {
       }
     }
 
-    if (isCalledDecisionAllowed(node, version) && isTaskDefinitionAllowed(node, version)) {
-      errors = hasExtensionElement(node, [
-        'zeebe:CalledDecision',
-        'zeebe:TaskDefinition'
-      ], node);
-    } else if (isCalledDecisionAllowed(node, version)) {
-      errors = hasExtensionElement(node, 'zeebe:CalledDecision', node);
-    } else if (isTaskDefinitionAllowed(node, version)) {
-      errors = hasExtensionElement(node, 'zeebe:TaskDefinition', node);
+    const allowedTypes = [
+      isCalledDecisionAllowed(node, version) ? 'zeebe:CalledDecision' : false,
+      isScriptAllowed(node, version) ? 'zeebe:Script' : false,
+      isTaskDefinitionAllowed(node, version) ? 'zeebe:TaskDefinition' : false
+    ].filter(isAllowed => isAllowed);
+
+    if (allowedTypes.length === 0) {
+      return;
+    } else if (allowedTypes.length === 1) {
+      errors = hasExtensionElement(node, allowedTypes[0], node);
+    } else {
+      errors = hasExtensionElement(node, allowedTypes, node);
     }
 
     if (errors && errors.length) {
@@ -136,7 +180,17 @@ module.exports = function({ version }) {
 function isCalledDecisionAllowed(node, version) {
   const { calledDecision } = config;
 
-  return calledDecision[ node.$type ] && greaterOrEqual(version, calledDecision[ node.$type ]);
+  const allowedVersion = getAllowedVersion(calledDecision[ node.$type ], node);
+
+  return calledDecision[ node.$type ] && greaterOrEqual(version, allowedVersion);
+}
+
+function isScriptAllowed(node, version) {
+  const { script } = config;
+
+  const allowedVersion = getAllowedVersion(script[ node.$type ], node);
+
+  return allowedVersion && greaterOrEqual(version, allowedVersion);
 }
 
 function isTaskDefinitionAllowed(node, version) {
@@ -159,4 +213,4 @@ function getAllowedVersion(config, node) {
   const eventDefinition = getEventDefinition(node);
 
   return eventDefinition && config[ eventDefinition.$type ];
-}
+}

package/rules/no-expression.js

@@ -0,0 +1,117 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const {
+  ERROR_TYPES,
+  getEventDefinition
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+const handlersMap = {
+  '1.0': [
+    checkErrorCode
+  ],
+  '1.1': [
+    checkErrorCode
+  ],
+  '1.2': [
+    checkErrorCode
+  ],
+  '1.3': [
+    checkErrorCode
+  ],
+  '8.0': [
+    checkErrorCode
+  ],
+  '8.1': [
+    checkErrorCode
+  ],
+  '8.2': []
+};
+
+module.exports = noExpressionRule;
+
+/**
+ * Make sure that certain properties do not contain expressions in older versions.
+ * @param {{ version: string }} config
+ */
+function noExpressionRule({ version }) {
+  function check(node, reporter) {
+    const errors = checkForVersion(node, version);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+}
+
+function checkForVersion(node, version) {
+  const handlers = handlersMap[version];
+
+  return handlers.reduce((errors, handler) => {
+    const handlerErrors = handler(node, version) || [];
+    return errors.concat(handlerErrors);
+  }, []);
+}
+
+function noExpression(node, propertyName, parentNode, allowedVersion) {
+  const propertyValue = node.get(propertyName);
+  const path = getPath(node, parentNode);
+
+  if (!isExpression(propertyValue)) {
+    return;
+  }
+
+  return {
+    message: `Expression statement <${truncate(propertyValue)}> only supported by Camunda Platform 8.2 or newer`,
+    path: path
+      ? [ ...path, propertyName ]
+      : [ propertyName ],
+    data: {
+      type: ERROR_TYPES.EXPRESSION_NOT_ALLOWED,
+      node,
+      parentNode: parentNode == node ? null : parentNode,
+      property: propertyName,
+      allowedVersion
+    }
+  };
+}
+
+function isExpression(value) {
+  return value && value.startsWith('=');
+}
+
+function checkErrorCode(node) {
+  if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+    return;
+  }
+
+  const eventDefinition = getEventDefinition(node);
+
+  if (!eventDefinition || !is(eventDefinition, 'bpmn:ErrorEventDefinition')) {
+    return;
+  }
+
+  const errorRef = eventDefinition.get('errorRef');
+
+  if (!errorRef) {
+    return;
+  }
+
+  return errorRef && noExpression(errorRef, 'errorCode', node, '8.2');
+}
+
+function truncate(string, maxLength = 10) {
+  const stringified = `${ string }`;
+
+  return stringified.length > maxLength ? `${ stringified.slice(0, maxLength) }...` : stringified;
+}

package/rules/utils/error-types.js

@@ -1,6 +1,7 @@
 module.exports.ERROR_TYPES = Object.freeze({
   ELEMENT_COLLAPSED_NOT_ALLOWED: 'camunda.elementCollapsedNotAllowed',
   ELEMENT_TYPE_NOT_ALLOWED: 'camunda.elementTypeNotAllowed',
+  EXPRESSION_NOT_ALLOWED: 'camunda.expressionNotAllowed',
   EXPRESSION_REQUIRED: 'camunda.expressionRequired',
   EXPRESSION_VALUE_NOT_ALLOWED: 'camunda.expressionValueNotAllowed',
   EXTENSION_ELEMENT_NOT_ALLOWED: 'camunda.extensionElementNotAllowed',