add tenant configuration

Author: zambrovski

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/ProcessEngineWorker.kt

@@ -12,12 +12,12 @@ annotation class ProcessEngineWorker(
   /**
    * Topic name to subscribe this worker for.
    */
-  @get: AliasFor(attribute = "value")
+  @get:AliasFor(attribute = "value")
   val topic: String = DEFAULT_UNSET_TOPIC,
   /**
    * Topic name to subscribe this worker for.
    */
-  @get: AliasFor(attribute = "topic")
+  @get:AliasFor(attribute = "topic")
   val value: String = DEFAULT_UNSET_TOPIC,
   /**
    * Flag, indicating if the task should be automatically completed after the execution of the worker.
@@ -38,13 +38,23 @@ annotation class ProcessEngineWorker(
    * If not specified (default: -1), the adapter's global configuration will be used.
    * @since 0.8.0
    */
-  val lockDuration: Long = DEFAULT_UNSET_LOCK_DURATION
+  val lockDuration: Long = DEFAULT_UNSET_LOCK_DURATION,
+  /**
+   * Tenant ID to subscribe this worker for. Defaults to "__unset" representing no tenant.
+   */
+  val tenantId: String = DEFAULT_UNSET_TENANT_ID,
 ) {
   companion object {
     /**
      * Null value for the topic.
      */
     const val DEFAULT_UNSET_TOPIC = "__unset"
+
+    /**
+     * Null value for the tenant.
+     */
+    const val DEFAULT_UNSET_TENANT_ID = "__unset"
+
     /**
      * Sentinel value indicating lock duration is not specified.
      */
@@ -59,12 +69,14 @@ annotation class ProcessEngineWorker(
      * Use default configured via property.
      */
     DEFAULT,
+
     /**
      * Execute external task completion before the transaction is committed.
      */
     BEFORE_COMMIT,
+
     /**
-     * Execute external task completion after transaction is committed.
+     * Execute external task completion after the transaction is committed.
      */
     AFTER_COMMIT,
   }

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/configuration/ProcessEngineWorkerProperties.kt

@@ -26,6 +26,10 @@ data class ProcessEngineWorkerProperties(
    * if the completion of a task was successful but the removal of a task result was not.
    */
   var removeTaskResultOnCompletion: Boolean = true,
+  /**
+   * Default tenant id to use for all workers.
+   */
+  var tenantId: String? = null,
 ) {
   companion object {
     const val DEFAULT_PREFIX = "dev.bpm-crafters.process-api.worker"

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/registrar/ProcessEngineStarterRegistrar.kt

@@ -8,15 +8,9 @@ import dev.bpmcrafters.processengine.worker.ProcessEngineWorker.Completion.DEFAU
 import dev.bpmcrafters.processengine.worker.configuration.ProcessEngineWorkerAutoConfiguration
 import dev.bpmcrafters.processengine.worker.configuration.ProcessEngineWorkerProperties
 import dev.bpmcrafters.processengine.worker.configuration.ProcessEngineWorkerProperties.Companion.DEFAULT_PREFIX
-import dev.bpmcrafters.processengineapi.task.CompleteTaskByErrorCmd
-import dev.bpmcrafters.processengineapi.task.CompleteTaskCmd
-import dev.bpmcrafters.processengineapi.task.FailTaskCmd
-import dev.bpmcrafters.processengineapi.task.ServiceTaskCompletionApi
-import dev.bpmcrafters.processengineapi.task.SubscribeForTaskCmd
-import dev.bpmcrafters.processengineapi.task.TaskInformation
-import dev.bpmcrafters.processengineapi.task.TaskSubscriptionApi
-import dev.bpmcrafters.processengineapi.task.TaskType
 import dev.bpmcrafters.processengine.worker.idempotency.IdempotencyRegistry
+import dev.bpmcrafters.processengineapi.CommonRestrictions
+import dev.bpmcrafters.processengineapi.task.*
 import io.github.oshai.kotlinlogging.KotlinLogging
 import org.springframework.beans.factory.config.BeanPostProcessor
 import org.springframework.boot.autoconfigure.AutoConfiguration
@@ -88,11 +82,16 @@ class ProcessEngineStarterRegistrar(
 
       val completion = method.getCompletion()
       val customLockDuration = method.getLockDuration()
-      val restrictions = if (customLockDuration == null) {
-        mapOf()
-      } else {
-        mapOf("workerLockDurationInMilliseconds" to customLockDuration.toString()) // FIXME replace with constant introduced in Process Engine API 1.6
-      }
+      val tenantId = method.getTenantId() ?: processEngineWorkerProperties.tenantId
+
+      val restrictions: Map<String, String> = mutableMapOf<String, String>().apply {
+        if (customLockDuration != null) {
+          this[CommonRestrictions.WORKER_LOCK_DURATION_IN_MILLISECONDS] = customLockDuration.toString()
+        }
+        if (tenantId != null) {
+          this[CommonRestrictions.TENANT_ID] = tenantId
+        }
+      }.toMap()
 
       // check if the method or class is marked to run in transaction
       val isTransactional = method.isTransactional()

spring-boot-starter/src/main/kotlin/dev/bpmcrafters/processengine/worker/registrar/ReflectionUtils.kt

@@ -176,6 +176,20 @@ fun Method.getLockDuration(): Long? {
   }
 }
 
+/**
+ * Returns the tenant id, configured on the annotation or null if it is not set.
+ * @return tenant id, or null if the default should be used.
+ * @since 0.8.4
+ */
+fun Method.getTenantId(): String? {
+  val tenantId = this.getAnnotation(ProcessEngineWorker::class.java).tenantId
+  return if (tenantId == ProcessEngineWorker.DEFAULT_UNSET_TENANT_ID || tenantId.isBlank()) {
+    null
+  } else {
+    tenantId
+  }
+}
+
 /**
  * Checks if the method of the worker is transactional.
  * @return true, if the method should be executed transactional and be atomic with completion of the worker.

spring-boot-starter/src/test/kotlin/dev/bpmcrafters/processengine/worker/registrar/ReflectionUtilsTest.kt

@@ -63,13 +63,52 @@ class ReflectionUtilsTest {
 
     inner class LockDurationTestWorker {
       @ProcessEngineWorker(topic = "withLock", lockDuration = 30)
-      fun workerWithLockDuration() {}
+      fun workerWithLockDuration() {
+      }
 
       @ProcessEngineWorker(topic = "withoutLock")
-      fun workerWithoutLockDuration() {}
+      fun workerWithoutLockDuration() {
+      }
 
       @ProcessEngineWorker(topic = "explicitDefault", lockDuration = -1)
-      fun workerWithExplicitDefault() {}
+      fun workerWithExplicitDefault() {
+      }
+    }
+  }
+
+  @Nested
+  inner class TenantIdTest {
+
+    @Test
+    fun `getTenantId should return value when specified`() {
+      val method = TenantWorker::class.java.getDeclaredMethod("workerWithTenantId")
+      assertThat(method.getTenantId()).isEqualTo("tenant")
+    }
+
+    @Test
+    fun `getTenantId should return null when not specified`() {
+      val method = TenantWorker::class.java.getDeclaredMethod("worker")
+      assertThat(method.getTenantId()).isNull()
+    }
+
+    @Test
+    fun `getTenantId should return null when specified empty string`() {
+      val method = TenantWorker::class.java.getDeclaredMethod("withEmptyTenantId")
+      assertThat(method.getTenantId()).isNull()
+    }
+
+    inner class TenantWorker {
+      @ProcessEngineWorker(topic = "withTenant", tenantId = "tenant")
+      fun workerWithTenantId() {
+      }
+
+      @ProcessEngineWorker(topic = "withoutTenant")
+      fun worker() {
+      }
+
+      @ProcessEngineWorker(topic = "withEmptyTenantId", tenantId = "")
+      fun withEmptyTenantId() {
+      }
     }
   }
 }