Merge branch 'release/0.8.2'

zambrovski · zambrovski · commit a07eee1b444f · 2026-04-16T14:09:15.000+02:00
diff --git a/docs/idempotency.md b/docs/idempotency.md
@@ -16,11 +16,11 @@ When a worker is triggered, the process engine worker:
 
 There are three available implementations of the `IdempotencyRegistry`:
 
-| Implementation | Description | Recommended Use |
-| --- | --- | --- |
-| `NoOpIdempotencyRegistry` | Does nothing. No results are stored or retrieved. | Default, use if idempotency is handled elsewhere. |
-| `InMemoryIdempotencyRegistry` | Stores results in a local `ConcurrentHashMap`. | Testing or non-clustered environments. |
-| `JpaIdempotencyRegistry` | Stores results in a database using JPA. | Production, clustered environments. |
+| Implementation                | Description                                       | Recommended Use                                   |
+|-------------------------------|---------------------------------------------------|---------------------------------------------------|
+| `NoOpIdempotencyRegistry`     | Does nothing. No results are stored or retrieved. | Default, use if idempotency is handled elsewhere. |
+| `InMemoryIdempotencyRegistry` | Stores results in a local `ConcurrentHashMap`.    | Testing or non-clustered environments.            |
+| `JpaIdempotencyRegistry`      | Stores results in a database using JPA.           | Production, clustered environments.               |
 
 ## Setup Procedures
 
@@ -58,7 +58,58 @@ Add the following dependency to your `pom.xml`:
 
 The `JpaIdempotencyAutoConfiguration` will automatically register the `JpaIdempotencyRegistry` if an `EntityManager` is present and no other `IdempotencyRegistry` bean is defined.
 
-#### 2. Database Schema (Liquibase)
+#### 2. Configure JPA
+
+Add the `dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntryRepository` with the following annotation
+```java
+@EnableJpaRepositories(basePackages = {
+    "your.package(s)",
+    "dev.bpmcrafters.processengine.worker.idempotency"
+})
+```
+
+You can add the entity `dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntry` either via annotation
+```java
+@EntityScan(basePackages = {
+    "your.package(s)",
+    "dev.bpmcrafters.processengine.worker.idempotency"
+})
+```
+or via `META-INF/orm.xml`
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<entity-mappings
+  xmlns="https://jakarta.ee/xml/ns/persistence/orm"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="https://jakarta.ee/xml/ns/persistence/orm https://jakarta.ee/xml/ns/persistence/orm/orm_3_2.xsd"
+  version="3.2"
+>
+  <entity class="dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntry">
+    <table schema="your_schema" name="task_log_entry"/>
+    <attributes>
+      <basic name="taskId">
+        <column name="task_id" column-definition="varchar2(100)"/>
+      </basic>
+      <basic name="processInstanceId">
+        <column name="process_instance_id" column-definition="varchar2(100)"/>
+      </basic>
+      <basic name="createdAt">
+        <column name="created_at"/>
+      </basic>
+      <basic name="result">
+        <column name="result"/>
+      </basic>
+    </attributes>
+  </entity>
+</entity-mappings>
+```
+Using the `orm.xml` could be useful. E.g., when you
+* are using Hibernate's schema validation and the default types mismatch.
+* want to relocate the entity into a different schema.
+* want to rename the table.
+* want to rename columns.
+
+#### 3. Database Schema (Liquibase)
 
 The JPA registry requires a table named `task_log_entry_`. You can use the following Liquibase changeSet to create it:
 
@@ -91,8 +142,6 @@ databaseChangeLog:
               - column:
                   name: result_
                   type: blob # or bytea for PostgreSQL
-                  constraints:
-                    nullable: false
         - createIndex:
             indexName: idx_task_log_entry_process_instance_id_
             tableName: task_log_entry_
diff --git a/examples/camunda7-embedded-starter-transaction/pom.xml b/examples/camunda7-embedded-starter-transaction/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-examples</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/examples/camunda7-remote-starter-native/pom.xml b/examples/camunda7-remote-starter-native/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-examples</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/examples/order-fulfillment/pom.xml b/examples/order-fulfillment/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-examples</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-root</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/itest/pom.xml b/itest/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-root</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/itest/spring-boot-integration-testing/pom.xml b/itest/spring-boot-integration-testing/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-itest</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/itest/spring-boot-integration-testing/src/main/kotlin/dev/bpmcrafters/processengine/worker/itest/AbstractBehaviorITestBase.kt b/itest/spring-boot-integration-testing/src/main/kotlin/dev/bpmcrafters/processengine/worker/itest/AbstractBehaviorITestBase.kt
@@ -127,6 +127,13 @@ abstract class AbstractBehaviorITestBase {
     null
   ).body as List<IncidentDto>
 
+  protected fun setExternalTaskRetries(externalTaskId: String, retries: Int) {
+    externalTaskApiClient.setExternalTaskRetries(SetRetriesForExternalTasksDto().apply {
+      externalTaskIds = listOf(externalTaskId)
+      this.retries = retries
+    })
+  }
+
   protected fun getHistoricActivityInstances(processInstanceId: String, activityId: String): List<HistoricActivityInstanceDto> {
     return historyApiClient.queryHistoricActivityInstances(
       0,
diff --git a/itest/spring-boot-starter-integration-test/pom.xml b/itest/spring-boot-starter-integration-test/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-itest</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/itest/spring-boot-starter-integration-test/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/idempotency/IdempotencyITest.kt b/itest/spring-boot-starter-integration-test/src/test/kotlin/dev/bpmcrafters/processengine/worker/itest/idempotency/IdempotencyITest.kt
@@ -1,9 +1,13 @@
 package dev.bpmcrafters.processengine.worker.itest.idempotency
 
 import dev.bpmcrafters.processengine.worker.fixture.InMemoryIdempotencyRegistryConfiguration
+import dev.bpmcrafters.processengine.worker.fixture.MyEntity
+import dev.bpmcrafters.processengine.worker.fixture.MyEntityRepository
 import dev.bpmcrafters.processengine.worker.fixture.worker.WorkerWithTransactionalAnnotation
 import dev.bpmcrafters.processengine.worker.fixture.worker.WorkerWithoutTransactionalAnnotation
 import dev.bpmcrafters.processengine.worker.idempotency.IdempotencyRegistry
+import dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntry
+import dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntryRepository
 import dev.bpmcrafters.processengine.worker.itest.FixtureITestBase
 import dev.bpmcrafters.processengineapi.task.ServiceTaskCompletionApi
 import org.assertj.core.api.Assertions.assertThat
@@ -15,7 +19,9 @@ import org.junit.jupiter.api.Test
 import org.mockito.kotlin.*
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Value
+import org.springframework.boot.autoconfigure.domain.EntityScan
 import org.springframework.context.annotation.Import
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories
 import org.springframework.test.context.TestPropertySource
 import org.springframework.test.context.bean.override.mockito.MockitoSpyBean
 import java.util.*
@@ -24,6 +30,7 @@ import kotlin.time.toJavaDuration
 
 @TestPropertySource(
   properties = [
+    "dev.bpm-crafters.process-api.adapter.c7remote.service-tasks.retries=0",
     "dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=false",
     "dev.bpm-crafters.process-api.worker.remove-task-result-on-completion=true"
   ]
@@ -50,12 +57,11 @@ abstract class IdempotencyITest : FixtureITestBase() {
     val processInstanceId = startProcess(name, verified = true)
     assertThat(processInstanceIsRunning(processInstanceId)).isTrue()
     await atMost 30.seconds.toJavaDuration() untilAsserted {
-      val entity = findEntityByName(name)
-      assertThat(entity).isNotNull
+      val incidents = getIncidents(processInstanceId)
+      assertThat(incidents).hasSize(1)
     }
     doCallRealMethod().`when`(serviceTaskCompletionApi).completeTask(any())
-    unlockExternalTask(getExternalTasks(processInstanceId).first().id!!)
-    print(idempotencyRegistry)
+    setExternalTaskRetries(getExternalTasks(processInstanceId).first().id!!, 1)
     await atMost 30.seconds.toJavaDuration() untilAsserted {
       assertThat(processInstanceIsRunning(processInstanceId)).isFalse
     }
@@ -94,13 +100,17 @@ abstract class IdempotencyITest : FixtureITestBase() {
 
   @Nested
   @Import(WorkerWithoutTransactionalAnnotation::class)
+  @EntityScan(basePackageClasses = [TaskLogEntry::class])
+  @EnableJpaRepositories(basePackageClasses = [TaskLogEntryRepository::class])
   class JpaIdempotencyWithoutTransactionITest : IdempotencyITest()
 
   @TestPropertySource(properties = ["dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=false"])
   class JpaIdempotencyWithoutTransactionNotRemovingTaskResultITest : JpaIdempotencyWithoutTransactionITest()
 
   @Nested
   @Import(WorkerWithTransactionalAnnotation::class)
+  @EntityScan(basePackageClasses = [TaskLogEntry::class])
+  @EnableJpaRepositories(basePackageClasses = [TaskLogEntryRepository::class])
   class JpaIdempotencyWithTransactionITest : IdempotencyITest()
 
   @TestPropertySource(properties = ["dev.bpm-crafters.process-api.worker.complete-tasks-before-commit=false"])
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
 
   <groupId>dev.bpm-crafters.process-engine-worker</groupId>
   <artifactId>process-engine-worker-root</artifactId>
-  <version>0.8.1</version>
+  <version>0.8.2</version>
   <name>${project.artifactId}</name>
   <description>Process Engine Worker</description>
   <url>https://github.com/bpm-crafters/process-engine-worker/</url>
diff --git a/spring-boot-idempotency-registry-jpa/pom.xml b/spring-boot-idempotency-registry-jpa/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-root</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/spring-boot-idempotency-registry-jpa/src/main/kotlin/dev/bpmcrafters/processengine/worker/configuration/JpaIdempotencyAutoConfiguration.kt b/spring-boot-idempotency-registry-jpa/src/main/kotlin/dev/bpmcrafters/processengine/worker/configuration/JpaIdempotencyAutoConfiguration.kt
@@ -2,22 +2,17 @@ package dev.bpmcrafters.processengine.worker.configuration
 
 import dev.bpmcrafters.processengine.worker.idempotency.IdempotencyRegistry
 import dev.bpmcrafters.processengine.worker.idempotency.JpaIdempotencyRegistry
-import dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntry
 import dev.bpmcrafters.processengine.worker.idempotency.TaskLogEntryRepository
 import org.springframework.boot.autoconfigure.AutoConfiguration
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean
-import org.springframework.boot.autoconfigure.domain.EntityScan
 import org.springframework.context.annotation.Bean
-import org.springframework.data.jpa.repository.config.EnableJpaRepositories
 
 /**
  * Autoconfiguration for JPA-based Idempotency Registry.
  * @since 0.8.0
  */
 @AutoConfiguration(before = [ProcessEngineWorkerAutoConfiguration::class])
 @ConditionalOnMissingBean(IdempotencyRegistry::class)
-@EntityScan(basePackageClasses = [TaskLogEntry::class])
-@EnableJpaRepositories(basePackageClasses = [TaskLogEntryRepository::class])
 class JpaIdempotencyAutoConfiguration {
 
   @Bean
diff --git a/spring-boot-idempotency-registry-jpa/src/main/kotlin/dev/bpmcrafters/processengine/worker/idempotency/TaskLogEntry.kt b/spring-boot-idempotency-registry-jpa/src/main/kotlin/dev/bpmcrafters/processengine/worker/idempotency/TaskLogEntry.kt
@@ -8,15 +8,14 @@ import java.time.Instant
 class TaskLogEntry(
   @Id
   @Column(name = "task_id_", nullable = false, length = 100)
-  val taskId: String,
+  var taskId: String,
   @Column(name = "process_instance_id_", nullable = false, length = 100)
-  val processInstanceId: String,
+  var processInstanceId: String,
   @Column(name = "created_at_", nullable = false)
-  val createdAt: Instant,
+  var createdAt: Instant,
   @Column(name = "result_")
-  @Lob
   @Convert(converter = TaskResultMapConverter::class)
-  val result: Map<String, Any?>?
+  var result: Map<String, Any?>
 ) {
 
   override fun toString(): String {
diff --git a/spring-boot-starter/pom.xml b/spring-boot-starter/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-worker</groupId>
     <artifactId>process-engine-worker-root</artifactId>
-    <version>0.8.1</version>
+    <version>0.8.2</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
diff --git a/spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/registrar/ProcessEngineStarterRegistrar.kt b/spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/registrar/ProcessEngineStarterRegistrar.kt
@@ -220,7 +220,6 @@ class ProcessEngineStarterRegistrar(
   private fun completeTask(taskInformation: TaskInformation, payload: Map<String, Any?>) {
     taskCompletionApi.completeTask(CompleteTaskCmd(taskInformation.taskId) { payload }).get()
     if (processEngineWorkerProperties.removeTaskResultOnCompletion) {
-      logger.debug { "Removing task result" }
       logger.debug { "PROCESS-ENGINE-WORKER-018: Removing result of task ${taskInformation.taskId}" }
       idempotencyRegistry.removeTaskResult(taskInformation.taskId)
     }
