feat: add linting for ad-hoc subprocess completion condition & cancelRemainingInstances only supported from camunda 8.8

Author: maff

rules/camunda-cloud/ad-hoc-sub-process.js

@@ -3,25 +3,41 @@ const { is, isAny } = require('bpmnlint-utils');
 const { reportErrors } = require('../utils/reporter');
 
 const { skipInNonExecutableProcess } = require('../utils/rule');
+const { hasProperties } = require('../utils/element');
+const { greaterOrEqual } = require('../utils/version');
 
-module.exports = skipInNonExecutableProcess(function() {
+module.exports = skipInNonExecutableProcess(function({ version }) {
   function check(node, reporter) {
     if (!is(node, 'bpmn:AdHocSubProcess')) {
       return;
     }
 
     // Ad-Hoc Sub-Process must contain at least one activity
-    if (node.get('flowElements').some(isActivity)) {
-      return;
+    if (!node.get('flowElements').some(isActivity)) {
+      reportErrors(node, reporter, {
+        message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
+        data: {
+          node,
+          parentNode: null
+        }
+      });
     }
 
-    reportErrors(node, reporter, {
-      message: 'Element of type <bpmn:AdHocSubProcess> must contain at least one activity',
-      data: {
-        node,
-        parentNode: null
+    // cancelRemainingInstances attribute is only allowed in version 8.8 or greater
+    reportErrors(node, reporter, hasProperties(node, {
+      cancelRemainingInstances: {
+        allowedVersion: '8.8',
+        allowed: () => {
+          if (greaterOrEqual(version, '8.8')) {
+            return true;
+          }
+
+          return !Object.prototype.hasOwnProperty.call(node, 'cancelRemainingInstances');
+        },
       }
-    });
+    }));
+
+    // TODO check completion condition not allowed in version < 8.8
   }
 
   return {
@@ -31,4 +47,4 @@ module.exports = skipInNonExecutableProcess(function() {
 
 function isActivity(element) {
   return isAny(element, [ 'bpmn:Task', 'bpmn:SubProcess' ]);
-}
+}

test/camunda-cloud/ad-hoc-sub-process.spec.js

@@ -10,17 +10,48 @@ const {
 const valid = [
   {
     name: 'ad hoc sub process (with task)',
+    config: { version: '8.7' },
     moddleElement: createModdle(createProcess(`
       <bpmn:adHocSubProcess id="Subprocess_1">
         <bpmn:task id="Task_1" />
       </bpmn:adHocSubProcess>
     `))
-  }
+  },
+  {
+    name: 'ad hoc sub process (with completion condition)',
+    config: { version: '8.8' },
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1">
+        <bpmn:task id="Task_1" />
+        <bpmn:completionCondition xsi:type="tFormalExpression">=myCondition</bpmn:completionCondition>
+      </bpmn:adHocSubProcess>
+    `))
+  },
+  {
+    name: 'ad hoc sub process (with cancelRemainingInstances attribute)',
+    config: { version: '8.8' },
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1" cancelRemainingInstances="false">
+        <bpmn:task id="Task_1" />
+      </bpmn:adHocSubProcess>
+    `))
+  },
+  {
+    name: 'ad hoc sub process (with completion condition and cancelRemainingInstances attribute)',
+    config: { version: '8.8' },
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1" cancelRemainingInstances="false">
+        <bpmn:task id="Task_1" />
+        <bpmn:completionCondition xsi:type="tFormalExpression">=myCondition</bpmn:completionCondition>
+      </bpmn:adHocSubProcess>
+    `))
+  },
 ];
 
 const invalid = [
   {
     name: 'ad hoc sub process (empty)',
+    config: { version: '8.7' },
     moddleElement: createModdle(createProcess(`
       <bpmn:adHocSubProcess id="Subprocess_1">
       </bpmn:adHocSubProcess>
@@ -36,6 +67,7 @@ const invalid = [
   },
   {
     name: 'ad hoc sub process (no activity)',
+    config: { version: '8.7' },
     moddleElement: createModdle(createProcess(`
       <bpmn:adHocSubProcess id="Subprocess_1">
         <bpmn:exclusiveGateway id="Gateway_1" />
@@ -50,10 +82,55 @@ const invalid = [
         parentNode: null
       }
     }
-  }
+  },
+  {
+    name: 'ad hoc sub process (with completion condition)',
+    config: { version: '8.7' },
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1">
+        <bpmn:task id="Task_1" />
+        <bpmn:completionCondition xsi:type="tFormalExpression">=myCondition</bpmn:completionCondition>
+      </bpmn:adHocSubProcess>
+    `)),
+    report: {
+      id: 'Subprocess_1',
+      message: 'Element of type <bpmn:completionCondition> within <bpmn:AdHocSubProcess> only allowed by Camunda 8.8 or newer',
+      data: {
+        node: 'Subprocess_1',
+        parentNode: null
+      }
+    }
+  },
+  {
+    name: 'ad hoc sub process (with cancelRemainingInstances attribute)',
+    config: { version: '8.7' },
+    moddleElement: createModdle(createProcess(`
+      <bpmn:adHocSubProcess id="Subprocess_1" cancelRemainingInstances="false">
+        <bpmn:task id="Task_1" />
+      </bpmn:adHocSubProcess>
+    `)),
+    report: {
+      id: 'Subprocess_1',
+      message: 'Property value of <false> only allowed by Camunda 8.8 or newer',
+      path: [
+        'rootElements',
+        0,
+        'flowElements',
+        0,
+        'cancelRemainingInstances'
+      ],
+      data: {
+        type: 'camunda.propertyValueNotAllowed',
+        node: 'Subprocess_1',
+        parentNode: null,
+        property: 'cancelRemainingInstances',
+        allowedVersion: '8.8'
+      }
+    }
+  },
 ];
 
-RuleTester.verify('called-element', rule, {
+RuleTester.verify('ad-hoc-sub-process', rule, {
   valid,
   invalid
 });