feat: support execution listeners in properties panel

camunda · Jul 30, 2024 · 3bdcfc8 · 3bdcfc8
1 parent 3014907
commit 3bdcfc8
Show file tree

Hide file tree

Showing 2 changed files with 107 additions and 0 deletions.
diff --git a/lib/utils/properties-panel.js b/lib/utils/properties-panel.js
@@ -316,6 +316,22 @@ export function getEntryIds(report) {
     return [ 'waitForCompletion' ];
   }
 
+  if (isPropertyError(data, 'type', 'zeebe:ExecutionListener')) {
+    const index = path[ path.length - 2 ];
+
+    return [ `${id}-executionListener-${index}-listenerType` ];
+  }
+
+  if (isPropertyValuesDuplicatedError(data, 'zeebe:ExecutionListeners')) {
+    const { properties, propertiesName } = data;
+
+    return properties.map(property => {
+      const index = data.node.get(propertiesName).indexOf(property);
+
+      return `${ id }-executionListener-${ index }-listenerType`;
+    });
+  }
+
   return [];
 }
 
@@ -528,6 +544,14 @@ export function getErrorMessage(id, report) {
   if (id === 'waitForCompletion') {
     return 'Must wait for completion.';
   }
+
+  if (/^.+-executionListener-[0-9]+-listenerType$/.test(id)) {
+    if (type === ERROR_TYPES.PROPERTY_VALUES_DUPLICATED) {
+      return 'Must be unique.';
+    } else {
+      return 'Must be defined.';
+    }
+  }
 }
 
 function isExtensionElementNotAllowedError(data, extensionElement, type) {
@@ -580,6 +604,11 @@ function isPropertyValueDuplicatedError(data, propertiesName, duplicatedProperty
     && (!type || is(data.node, type));
 }
 
+function isPropertyValuesDuplicatedError(data, type) {
+  return data.type === ERROR_TYPES.PROPERTY_VALUES_DUPLICATED
+    && (!type || is(data.node, type));
+}
+
 function isExpressionRequiredError(data, propertyName, type) {
   return data.type === ERROR_TYPES.EXPRESSION_REQUIRED
     && data.property === propertyName

diff --git a/test/spec/utils/properties-panel.spec.js b/test/spec/utils/properties-panel.spec.js
@@ -1934,6 +1934,84 @@ describe('utils/properties-panel', function() {
 
         expectErrorMessage(entryIds[ 0 ], 'Must wait for completion.', report);
       });
+
+
+      describe('execution listener', async function() {
+
+        it('should mark type as required', async function() {
+
+          // given
+          const node = createElement('bpmn:ServiceTask', {
+            id: 'ServiceTask_1',
+            extensionElements: createElement('bpmn:ExtensionElements', {
+              values: [
+                createElement('zeebe:ExecutionListeners', {
+                  listeners: [
+                    createElement('zeebe:ExecutionListener', {
+                      eventType: 'start'
+                    })
+                  ]
+                })
+              ]
+            })
+          });
+
+          const { default: rule } = await import('bpmnlint-plugin-camunda-compat/rules/camunda-cloud/execution-listener');
+
+          const report = await getLintError(node, rule);
+
+          // when
+          const entryIds = getEntryIds(report);
+
+          // then
+          expect(entryIds).to.eql([ 'ServiceTask_1-executionListener-0-listenerType' ]);
+
+          expectErrorMessage(entryIds[ 0 ], 'Must be defined.', report);
+        });
+
+
+        it('duplicated', async function() {
+
+          // given
+          const node = createElement('bpmn:ServiceTask', {
+            id: 'ServiceTask_1',
+            extensionElements: createElement('bpmn:ExtensionElements', {
+              values: [
+                createElement('zeebe:ExecutionListeners', {
+                  listeners: [
+                    createElement('zeebe:ExecutionListener', {
+                      eventType: 'start',
+                      type: 'foo'
+                    }),
+                    createElement('zeebe:ExecutionListener', {
+                      eventType: 'start',
+                      type: 'foo'
+                    })
+                  ]
+                })
+              ]
+            })
+          });
+
+          const { default: rule } = await import('bpmnlint-plugin-camunda-compat/rules/camunda-cloud/duplicate-execution-listeners');
+
+          const reports = await getLintErrors(node, rule);
+
+          // when
+          reports.forEach(report => {
+            const entryIds = getEntryIds(report);
+
+            // then
+            expect(entryIds).to.eql([
+              'ServiceTask_1-executionListener-0-listenerType',
+              'ServiceTask_1-executionListener-1-listenerType'
+            ]);
+
+            expectErrorMessage(entryIds[ 0 ], 'Must be unique.', report);
+          });
+        });
+
+      });
     });