feat: support zeebe:UserTaskListener

related to camunda/camunda-modeler#4590
camunda · Nov 6, 2024 · ca3cce8 · ca3cce8
1 parent 0453da9
commit ca3cce8
Show file tree

Hide file tree

Showing 6 changed files with 172 additions and 0 deletions.
diff --git a/resources/zeebe.json b/resources/zeebe.json
@@ -548,6 +548,52 @@
         }
       ]
     },
+    {
+      "name": "UserTaskListeners",
+      "superClass": [
+        "Element"
+      ],
+      "meta": {
+        "allowedIn": [
+          "bpmn:UserTask"
+        ]
+      },
+      "properties": [
+        {
+          "name": "listeners",
+          "type": "UserTaskListener",
+          "isMany": true
+        }
+      ]
+    },
+    {
+      "name": "UserTaskListener",
+      "superClass": [
+        "Element"
+      ],
+      "meta": {
+        "allowedIn": [
+          "zeebe:UserTaskListeners"
+        ]
+      },
+      "properties": [
+        {
+          "name": "eventType",
+          "type": "String",
+          "isAttr": true
+        },
+        {
+          "name": "retries",
+          "type": "String",
+          "isAttr": true
+        },
+        {
+          "name": "type",
+          "type": "String",
+          "isAttr": true
+        }
+      ]
+    },
     {
       "name": "VersionTag",
       "superClass": [

diff --git a/test/fixtures/xml/userTask-zeebe-userTaskListener.part.bpmn b/test/fixtures/xml/userTask-zeebe-userTaskListener.part.bpmn
@@ -0,0 +1,11 @@
+<bpmn:task
+  id="task-1"
+  xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL"
+  xmlns:zeebe="http://camunda.org/schema/zeebe/1.0"
+>
+  <bpmn:extensionElements>
+    <zeebe:userTaskListeners>
+      <zeebe:userTaskListener eventType="complete" retries="3" type="complete_listener"/>
+    </zeebe:userTaskListeners>
+  </bpmn:extensionElements>
+</bpmn:task>
diff --git a/test/fixtures/xml/zeebe-userTaskListeners.bpmn b/test/fixtures/xml/zeebe-userTaskListeners.bpmn
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:zeebe="http://camunda.org/schema/zeebe/1.0" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_0qh9wc7" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.23.0" modeler:userTaskPlatform="Camunda Cloud" modeler:userTaskPlatformVersion="8.0.0">
+  <bpmn:process id="ZeebePropertiesTest" name="Zeebe Properties Test" isExecutable="true">
+    <bpmn:extensionElements>
+      <zeebe:userTaskListeners>
+        <zeebe:userTaskListener eventType="complete" retries="1" type="complete_listener" />
+      </zeebe:userTaskListeners>
+    </bpmn:extensionElements>
+    <bpmn:userTask id="Activity_0ls77qd">
+      <bpmn:extensionElements>
+        <zeebe:userTaskListeners>
+          <zeebe:userTaskListener eventType="assign" retries="2" type="assign_listener" />
+        </zeebe:userTaskListeners>
+      </bpmn:extensionElements>
+    </bpmn:userTask>
+    <bpmn:subProcess id="Activity_1yf35jc">
+      <bpmn:extensionElements>
+        <zeebe:userTaskListeners>
+          <zeebe:userTaskListener eventType="complete" retries="3" type="complete_listener" />
+        </zeebe:userTaskListeners>
+      </bpmn:extensionElements>
+      <bpmn:userTask id="Event_06ifkc6">
+        <bpmn:extensionElements>
+          <zeebe:userTaskListeners>
+            <zeebe:userTaskListener eventType="assign" retries="4" type="assign_listener" />
+          </zeebe:userTaskListeners>
+        </bpmn:extensionElements>
+      </bpmn:userTask>
+    </bpmn:subProcess>
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="ZeebePropertiesTest">
+      <bpmndi:BPMNShape id="Activity_0ls77qd_di" bpmnElement="Activity_0ls77qd">
+        <dc:Bounds x="160" y="400" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_1yf35jc_di" bpmnElement="Activity_1yf35jc" isExpanded="true">
+        <dc:Bounds x="160" y="510" width="350" height="200" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Event_06ifkc6_di" bpmnElement="Event_06ifkc6">
+        <dc:Bounds x="200" y="592" width="36" height="36" />
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>
diff --git a/test/spec/xml/read.js b/test/spec/xml/read.js
@@ -1231,6 +1231,44 @@ describe('read', function() {
 
     });
 
+
+    describe('zeebe:UserTaskListener', function() {
+
+      it('on UserTask', async function() {
+
+        // given
+        var xml = readFile('test/fixtures/xml/userTask-zeebe-userTaskListener.part.bpmn');
+
+        // when
+        const {
+          rootElement: task
+        } = await moddle.fromXML(xml, 'bpmn:UserTask');
+
+        // then
+        expect(task).to.jsonEqual({
+          $type: 'bpmn:UserTask',
+          id: 'task-1',
+          extensionElements: {
+            $type: 'bpmn:ExtensionElements',
+            values: [
+              {
+                $type: 'zeebe:UserTaskListeners',
+                listeners: [
+                  {
+                    $type: 'zeebe:UserTaskListener',
+                    eventType: 'complete',
+                    retries: '3',
+                    type: 'complete_listener'
+                  }
+                ]
+              }
+            ]
+          }
+        });
+      });
+
+    });
+
   });
 
 });
diff --git a/test/spec/xml/roundtrip.js b/test/spec/xml/roundtrip.js
@@ -82,4 +82,11 @@ describe('import -> export roundtrip', function() {
 
   });
 
+
+  describe('zeebe:UserTaskListeners', function() {
+
+    it('should keep zeebe:userTaskListeners', validateExport('test/fixtures/xml/zeebe-userTaskListeners.bpmn'));
+
+  });
+
 });
diff --git a/test/spec/xml/write.js b/test/spec/xml/write.js
@@ -686,6 +686,32 @@ describe('write', function() {
 
     });
 
+
+    it('zeebe:UserTaskListeners', async function() {
+
+      // given
+      const moddleElement = moddle.create('zeebe:UserTaskListeners', {
+        listeners: [
+          moddle.create('zeebe:UserTaskListener', {
+            eventType: 'complete',
+            retries: '1',
+            type: 'complete_listener'
+          })
+        ]
+      });
+
+      const expectedXML = '<zeebe:userTaskListeners ' +
+        'xmlns:zeebe="http://camunda.org/schema/zeebe/1.0">' +
+        '<zeebe:userTaskListener eventType="complete" retries="1" type="complete_listener" />' +
+        '</zeebe:userTaskListeners>';
+
+      // when
+      const xml = await write(moddleElement);
+
+      // then
+      expect(xml).to.eql(expectedXML);
+    });
+
   });
 
 });
-Original file line number
+Diff line change
@@ Expand Up / @@ -82,4 +82,11 @@ describe('import -> export roundtrip', function() { @@
       });
+      describe('zeebe:UserTaskListeners', function() {
+        it('should keep zeebe:userTaskListeners', validateExport('test/fixtures/xml/zeebe-userTaskListeners.bpmn'));
+      });
     });