Refactor Zeebe workflow start endpoint to accept JSON request body and enhance error handling; update README with usage examples and add unit tests for controller

Author: RemodifyBerlin

README.md

@@ -66,7 +66,17 @@ The Zeebe client automatically deploys the BPMN files to the Zeebe broker. It is
 
 You can start the process using the controller (see the example in ZeebeController.java). The controller will start the process with the given variables.
 
-The JobWorkers will automatically pick up the tasks and execute them. The JobWorkers for the example BPMN file are configured in ZeebeWorker.java.
+The Controller for starting the process is configured in ZeebeController.java. The controller will start the given process with the given variables. They will be passed to the process as JSON. For example, the ticket-process.bpmn file has the processID "ticket-process" and a variable "approve". The JSON should look like this: 
+
+{
+  "processId": "ticket-process",
+  "variables": {
+    "approve": true
+  }
+}
+
+The JobWorkers will automatically pick up the tasks and execute them.
+The JobWorkers are configured in ZeebeWorker.java. The worker will pick up the tasks with the given task type and execute them. They are annotated with @ZeebeWorker. The task type must match the task type in the BPMN file. When the worker picks up the task, it will execute the given function. After the function is executed, the worker will complete the task and pass the result back to the Zeebe broker. Then the next task will be picked up by the worker. 
 
 This setup provides a foundational integration of Zeebe into your project.
 

remsfal-service/src/main/java/de/remsfal/service/control/ZeebeController.java

@@ -3,28 +3,59 @@
 import io.camunda.zeebe.client.ZeebeClient;
 import jakarta.inject.Inject;
 import jakarta.ws.rs.Path;
-import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.Response;
+
+import java.util.HashMap;
 import java.util.Map;
+import org.jboss.logging.Logger;
+
 
 @Path("/zeebe")
 public class ZeebeController {
 
         @Inject
         ZeebeClient zeebeClient;
 
-        @Path("/start")
-        public String startWorkflow(@QueryParam("approve") Boolean approve) {
-
-                Map<String, Object> variables = Map.of("approve", approve);
-
-                var workflowInstance = zeebeClient.newCreateInstanceCommand()
-                                .bpmnProcessId("ticket-process")
-                                .latestVersion()
-                                .variables(variables)
-                                .send()
-                                .join();
+        @Inject
+        Logger logger;
 
-                return "Ticket Process instance started with key: " + workflowInstance.getProcessInstanceKey();
-        }
+        @Path("/start")
+        public Response startWorkflow(Map<String, Object> requestBody) {
+                try {
+                    if (!requestBody.containsKey("processId")) {
+                        throw new IllegalArgumentException("Missing 'processId' in request body.");
+                    }
+        
+                    String processId = (String) requestBody.get("processId");
+                    Map<String, Object> variables = new HashMap<>();
+        
+                    Object rawVars = requestBody.get("variables");
+                    if (rawVars instanceof Map<?, ?> rawMap) {
+                        for (Map.Entry<?, ?> entry : rawMap.entrySet()) {
+                            if (entry.getKey() instanceof String key) {
+                                variables.put(key, entry.getValue());
+                            }
+                        }
+                    }
+        
+                    var workflowInstance = zeebeClient
+                            .newCreateInstanceCommand()
+                            .bpmnProcessId(processId)
+                            .latestVersion()
+                            .variables(variables)
+                            .send()
+                            .join();
+        
+                    return Response.ok("Workflow '" + processId + "' started with key: "
+                            + workflowInstance.getProcessInstanceKey())
+                            .build();
+        
+                } catch (IllegalArgumentException e) {
+                        logger.error("Bad request: " + e.getMessage(), e);
+                        return Response.status(Response.Status.BAD_REQUEST)
+                                .entity("Error: " + e.getMessage())
+                                .build();
+                    }
+            }
 
 }

remsfal-service/src/main/resources/application.properties

@@ -41,16 +41,20 @@ de.remsfal.auth.oidc.client-id=821093255871-8pnrdogfojdc36mqooovf951ao9r4o8i.app
 de.remsfal.auth.oidc.client-secret=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
 de.remsfal.auth.session.secret=removeMe
 
+# Zeebe Production Configuration
+quarkus.zeebe.client.broker.gateway-address=zeebe.remsfal.de:26500
+quarkus.zeebe.client.security.plaintext=false
+quarkus.zeebe.client.worker-name=remsfal-worker
+quarkus.zeebe.client.request-timeout=20s
 # quarkus.zeebe configuration
 quarkus.zeebe.resources.enabled=true
 quarkus.zeebe.resources.location=processes
-quarkus.zeebe.devservices.enabled=true
-quarkus.zeebe.devservices.shared=true
-quarkus.zeebe.devservices.service-name=zeebe_broker
-quarkus.zeebe.devservices.reuse=false
-quarkus.zeebe.dev-mode.watch-bpmn-dir=true
-quarkus.zeebe.dev-mode.watch-bpmn-files=true
-quarkus.zeebe.dev-mode.watch-job-worker=true
+quarkus.zeebe.client.request-timeout=20s
+# Disable Development Features
+quarkus.zeebe.devservices.enabled=false
+quarkus.zeebe.dev-mode.watch-bpmn-dir=false
+quarkus.zeebe.dev-mode.watch-bpmn-files=false
+quarkus.zeebe.dev-mode.watch-job-worker=false
 
 # MinIO configuration for Dev Profile
 %dev.quarkus.minio.devservices.enabled=false

remsfal-service/src/test/java/de/remsfal/service/control/ZeebeControllerTest.java

@@ -0,0 +1,52 @@
+package de.remsfal.service.control;
+
+import io.quarkus.test.junit.QuarkusTest;
+import io.restassured.http.ContentType;
+import jakarta.ws.rs.core.Response;
+import org.junit.jupiter.api.Test;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.equalTo;
+
+@QuarkusTest
+class ZeebeControllerTest {
+
+    @Test
+    void testStartWorkflowSuccess() {
+        given()
+        .contentType(ContentType.JSON)
+        .body("""
+               {
+                 "processId": "ticket-process",
+                 "variables": {
+                   "approved": "true"
+                 }
+               }
+               """)
+        .when()
+        .post("/zeebe/start")
+        .then()
+        .statusCode(Response.Status.OK.getStatusCode())
+        .body(containsString("Workflow 'test-process' started with key:"));
+    }
+
+    @Test
+    void testStartWorkflowMissingProcessId() {
+        given()
+        .contentType(ContentType.JSON)
+        .body("""
+               {
+                 "variables": {
+                   "approved": "true"
+                 }
+               }
+               """)
+        .when()
+        .post("/zeebe/start")
+        .then()
+        .statusCode(Response.Status.BAD_REQUEST.getStatusCode())
+        .body(equalTo("Error: Missing 'processId' in request body."));
+    }
+
+}