feat: support compensation

Related to camunda/camunda-modeler#3945

CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to [@camunda/linting](https://github.com/camunda/linting) ar
 
 ___Note:__ Yet to be released changes appear here._
 
+## 3.18.0
+
+`FEAT`: handle `wait-for-completion` rule ([#103](https://github.com/camunda/linting/pull/103))
+`DEPS`: update to `[email protected]`
+
 ## 3.17.0
 
 `FEAT`: handle `no-zeebe-user-task` rule ([#101](https://github.com/camunda/linting/pull/101))

lib/compiled-config.js

@@ -63,7 +63,8 @@ const rules = {
   "camunda-compat/task-schedule": "error",
   "camunda-compat/timer": "error",
   "camunda-compat/user-task-definition": "warn",
-  "camunda-compat/user-task-form": "error"
+  "camunda-compat/user-task-form": "error",
+  "camunda-compat/wait-for-completion": "error"
 };
 
 const config = {
@@ -217,4 +218,8 @@ cache['bpmnlint-plugin-camunda-compat/user-task-definition'] = rule_33;
 
 import rule_34 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-form';
 
-cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_34;
+cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_34;
+
+import rule_35 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion';
+
+cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_35;

lib/utils/error-messages.js

@@ -126,7 +126,7 @@ export function getErrorMessage(report, executionPlatform, executionPlatformVers
   }
 
   if (type === ERROR_TYPES.PROPERTY_VALUE_REQUIRED) {
-    return getPropertyValueRequiredErrorMessage(report);
+    return getPropertyValueRequiredErrorMessage(report, executionPlatform, executionPlatformVersion);
   }
 
   if (type === ERROR_TYPES.EXPRESSION_REQUIRED) {
@@ -228,13 +228,14 @@ function getPropertyValueDuplicatedErrorMessage(report) {
   return message;
 }
 
-function getPropertyValueRequiredErrorMessage(report) {
+function getPropertyValueRequiredErrorMessage(report, executionPlatform, executionPlatformVersion) {
   const {
     data,
     message
   } = report;
 
   const {
+    allowedVersion,
     node,
     property,
     parentNode
@@ -248,6 +249,12 @@ function getPropertyValueRequiredErrorMessage(report) {
     }
   }
 
+  const typeString = getTypeString(parentNode || node);
+
+  if (is(node, 'bpmn:CompensateEventDefinition') && property === 'waitForCompletion') {
+    return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> with <Wait for completion> disabled`, executionPlatform, executionPlatformVersion, allowedVersion);
+  }
+
   return message;
 }
 

lib/utils/properties-panel.js

@@ -312,6 +312,10 @@ export function getEntryIds(report) {
     return [ 'linkName' ];
   }
 
+  if (isPropertyError(data, 'waitForCompletion', 'bpmn:CompensateEventDefinition')) {
+    return [ 'waitForCompletion' ];
+  }
+
   return [];
 }
 
@@ -515,6 +519,10 @@ export function getErrorMessage(id, report) {
       return 'Must be defined.';
     }
   }
+
+  if (id === 'waitForCompletion') {
+    return 'Must wait for completion.';
+  }
 }
 
 function isExtensionElementNotAllowedError(data, extensionElement, type) {

package.json

@@ -32,7 +32,7 @@
     "@bpmn-io/diagram-js-ui": "^0.2.2",
     "bpmn-moddle": "^8.1.0",
     "bpmnlint": "^10.2.0",
-    "bpmnlint-plugin-camunda-compat": "^2.17.0",
+    "bpmnlint-plugin-camunda-compat": "^2.18.0",
     "bpmnlint-utils": "^1.0.2",
     "camunda-bpmn-moddle": "^7.0.1",
     "clsx": "^2.0.0",

test/spec/utils/error-messages.spec.js

@@ -1762,6 +1762,27 @@ describe('utils/error-messages', function() {
           expect(errorMessage).to.equal('A <Call Activity> with <Propagate all variables> disabled is only supported by Camunda 8.2 or newer');
         });
 
+
+        it('should adjust wait for completion', async function() {
+
+          // given
+          const node = createElement('bpmn:EndEvent', {
+            eventDefinitions: [
+              createElement('bpmn:CompensateEventDefinition', { waitForCompletion: false })
+            ]
+          });
+
+          const { default: rule } = await import('bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion');
+
+          const report = await getLintError(node, rule);
+
+          // when
+          const errorMessage = getErrorMessage(report, 'Camunda Cloud', '1.0');
+
+          // then
+          expect(errorMessage).to.equal('A <Compensate End Event> with <Wait for completion> disabled is not supported by Camunda 8 (Zeebe 1.0)');
+        });
+
       });
 
 

test/spec/utils/properties-panel.spec.js

@@ -1910,6 +1910,30 @@ describe('utils/properties-panel', function() {
 
       });
 
+
+      it('should support `waitForCompletion`', async function() {
+
+        // given
+        const node = createElement('bpmn:IntermediateThrowEvent', {
+          eventDefinitions: [
+            createElement('bpmn:CompensateEventDefinition', {
+              waitForCompletion: false
+            })
+          ]
+        });
+
+        const { default: rule } = await import('bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion');
+
+        const report = await getLintError(node, rule);
+
+        // when
+        const entryIds = getEntryIds(report);
+
+        // then
+        expect(entryIds).to.eql([ 'waitForCompletion' ]);
+
+        expectErrorMessage(entryIds[ 0 ], 'Must wait for completion.', report);
+      });
     });