bpmnlint-plugin-camunda-compat 2.16.0 → 2.18.0

package/index.js

@@ -19,6 +19,7 @@ const camundaCloud10Rules = withConfig({
   'no-task-schedule': 'error',
   'no-template': 'error',
   'no-zeebe-properties': 'error',
+  'no-zeebe-user-task': 'error',
   'sequence-flow-condition': 'error',
   'start-event-form': 'error',
   'subscription': 'error',
@@ -65,6 +66,14 @@ const camundaCloud83Rules = withConfig({
 const camundaCloud84Rules = withConfig(
   omit(camundaCloud83Rules, 'collapsed-subprocess'), { version: '8.4' });
 
+const camundaCloud85Rules = withConfig({
+  ...omit(camundaCloud83Rules, [
+    'collapsed-subprocess',
+    'no-zeebe-user-task'
+  ]),
+  'wait-for-completion': 'error'
+}, { version: '8.5' });
+
 const camundaPlatform719Rules = withConfig({
   'history-time-to-live': 'info'
 }, {
@@ -108,6 +117,7 @@ const rules = {
   'no-task-schedule': './rules/camunda-cloud/no-task-schedule',
   'no-template': './rules/camunda-cloud/no-template',
   'no-zeebe-properties': './rules/camunda-cloud/no-zeebe-properties',
+  'no-zeebe-user-task': './rules/camunda-cloud/no-zeebe-user-task',
   'secrets': './rules/camunda-cloud/secrets',
   'sequence-flow-condition': './rules/camunda-cloud/sequence-flow-condition',
   'signal-reference': './rules/camunda-cloud/signal-reference',
@@ -116,7 +126,8 @@ const rules = {
   'task-schedule': './rules/camunda-cloud/task-schedule',
   'timer': './rules/camunda-cloud/timer',
   'user-task-definition': './rules/camunda-cloud/user-task-definition',
-  'user-task-form': './rules/camunda-cloud/user-task-form'
+  'user-task-form': './rules/camunda-cloud/user-task-form',
+  'wait-for-completion': './rules/camunda-cloud/wait-for-completion'
 };
 
 const configs = {
@@ -147,6 +158,9 @@ const configs = {
   'camunda-cloud-8-4': {
     rules: camundaCloud84Rules
   },
+  'camunda-cloud-8-5': {
+    rules: camundaCloud85Rules
+  },
   'camunda-platform-7-19': {
     rules: camundaPlatform719Rules
   },

package/package.json

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

package/rules/camunda-cloud/element-type/config.js

@@ -1,6 +1,7 @@
 module.exports = {
   'bpmn:Association': '1.0',
   'bpmn:BoundaryEvent': {
+    'bpmn:CompensateEventDefinition': '8.5',
     'bpmn:ErrorEventDefinition': '1.0',
     'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.0',
@@ -16,6 +17,7 @@ module.exports = {
   'bpmn:Definitions': '1.0',
   'bpmn:EndEvent': {
     '_': '1.0',
+    'bpmn:CompensateEventDefinition': '8.5',
     'bpmn:ErrorEventDefinition': '1.0',
     'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.2',
@@ -34,6 +36,7 @@ module.exports = {
   },
   'bpmn:IntermediateThrowEvent': {
     '_': '1.1',
+    'bpmn:CompensateEventDefinition': '8.5',
     'bpmn:EscalationEventDefinition': '8.2',
     'bpmn:LinkEventDefinition': '8.2',
     'bpmn:MessageEventDefinition': '1.2',

package/rules/camunda-cloud/no-zeebe-user-task.js

@@ -0,0 +1,27 @@
+const { is } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { hasNoExtensionElement } = require('../utils/element');
+
+const ALLOWED_VERSION = '8.5';
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const errors = hasNoExtensionElement(node, 'zeebe:UserTask', node, ALLOWED_VERSION);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/user-task-form.js

@@ -19,6 +19,8 @@ const formIdAllowedVersions = {
   web: '8.0'
 };
 
+const ZEEBE_USER_TASK_VERSION = '8.5';
+
 module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', version }) {
   function check(node, reporter) {
     if (!is(node, 'bpmn:UserTask')) {
@@ -31,7 +33,27 @@ module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', vers
       return;
     }
 
-    let errors = [];
+    // handle Zebee User Task
+    if (isZeebeUserTask(node)) {
+
+      // handled by no-zeebe-user-task rule
+      if (!greaterOrEqual(version, ZEEBE_USER_TASK_VERSION)) {
+        return;
+      }
+
+      const errors = hasProperty(formDefinition, [
+        'externalReference',
+        'formId'
+      ], node) || [];
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+
+      return;
+    }
+
+    let errors;
 
     const formIdAllowedVersion = formIdAllowedVersions[ modeler ];
 
@@ -113,4 +135,8 @@ function findUserTaskForm(node, formKey) {
 
 function isFormIdAllowed(version, formIdAllowedVersion) {
   return greaterOrEqual(version, formIdAllowedVersion);
-}
+}
+
+function isZeebeUserTask(node) {
+  return !!findExtensionElement(node, 'zeebe:UserTask');
+}

package/rules/camunda-cloud/wait-for-completion.js

@@ -0,0 +1,46 @@
+const {
+  is
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(waitForCompletion);
+
+/**
+ * Make sure that wait for completion is NOT set to false.
+ */
+function waitForCompletion() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:ThrowEvent')) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:CompensateEventDefinition')) {
+      return;
+    }
+
+    const errors = hasProperties(eventDefinition, {
+      waitForCompletion: {
+        value: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+
+  return {
+    check
+  };
+}