flowable#3692: Query jobs by process definition key

amporsim · Nov 24, 2023 · c0a4253 · c0a4253
1 parent fef9471
commit c0a4253
Show file tree

Hide file tree

Showing 14 changed files with 229 additions and 3 deletions.
diff --git a/...le-engine/src/test/java/org/flowable/engine/test/api/mgmt/ExternalWorkerJobQueryTest.java b/...le-engine/src/test/java/org/flowable/engine/test/api/mgmt/ExternalWorkerJobQueryTest.java
@@ -115,6 +115,23 @@ public void testQueryByProcessDefinitionId() {
         assertThat(query.singleResult()).isNull();
     }
 
+    @Test
+    @Deployment(resources = "org/flowable/engine/test/api/mgmt/ExternalWorkerJobQueryTest.bpmn20.xml")
+    public void testQueryByProcessDefinitionKey() {
+        ProcessInstance processInstance1 = runtimeService.startProcessInstanceByKey("externalWorkerJobQueryTest");
+        ProcessInstance processInstance2 = runtimeService.startProcessInstanceByKey("externalWorkerJobQueryTest");
+        ExternalWorkerJobQuery query = managementService.createExternalWorkerJobQuery().processDefinitionKey(processInstance1.getProcessDefinitionKey());
+        assertThat(query.count()).isEqualTo(4);
+        assertThat(query.list())
+                .extracting(ExternalWorkerJob::getProcessInstanceId)
+                .containsOnly(processInstance1.getId(), processInstance2.getId());
+
+        query = managementService.createExternalWorkerJobQuery().processDefinitionKey("invalid");
+        assertThat(query.count()).isZero();
+        assertThat(query.list()).isEmpty();
+        assertThat(query.singleResult()).isNull();
+    }
+
     @Test
     @Deployment(resources = "org/flowable/engine/test/api/mgmt/ExternalWorkerJobQueryTest.bpmn20.xml")
     public void testQueryByExecutionId() {

diff --git a/modules/flowable-engine/src/test/java/org/flowable/engine/test/api/mgmt/JobQueryTest.java b/modules/flowable-engine/src/test/java/org/flowable/engine/test/api/mgmt/JobQueryTest.java
@@ -773,6 +773,55 @@ public void testTimerJobQueryWithoutScopeType() {
         assertThat(query.list().size()).isEqualTo(3);
     }
 
+    @Test
+    @Deployment(resources = "org/flowable/engine/test/bpmn/oneTask.bpmn20.xml")
+    public void testDeadLetterJobQueryByProcessDefinitionKey() {
+        ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("startToEnd");
+
+        DeadLetterJobEntity deadLetterJob = managementService.executeCommand(commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            DeadLetterJobEntityManager deadLetterJobEntityManager = jobServiceConfiguration.getDeadLetterJobEntityManager();
+            DeadLetterJobEntity job = deadLetterJobEntityManager.create();
+            job.setJobType(Job.JOB_TYPE_MESSAGE);
+            job.setProcessInstanceId(processInstance.getId());
+            job.setProcessDefinitionId(processInstance.getProcessDefinitionId());
+            jobServiceConfiguration.getDeadLetterJobDataManager().insert(job);
+            return job;
+        });
+
+        DeadLetterJobEntity deadLetterJob2 = managementService.executeCommand(commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            DeadLetterJobEntityManager deadLetterJobEntityManager = jobServiceConfiguration.getDeadLetterJobEntityManager();
+            DeadLetterJobEntity job = deadLetterJobEntityManager.create();
+            job.setJobType(Job.JOB_TYPE_MESSAGE);
+            job.setScopeId("scope1");
+            jobServiceConfiguration.getDeadLetterJobDataManager().insert(job);
+            return job;
+        });
+
+        DeadLetterJobQuery query = managementService.createDeadLetterJobQuery().processDefinitionKey("startToEnd");
+        assertThat(query.count()).isEqualTo(1);
+        assertThat(query.list()).extracting(Job::getId).containsExactly(deadLetterJob.getId());
+        assertThat(query.singleResult().getId()).isEqualTo(deadLetterJob.getId());
+
+        query = managementService.createDeadLetterJobQuery().processDefinitionKey("invalid");
+        assertThat(query.count()).isZero();
+        assertThat(query.list()).isEmpty();
+        assertThat(query.singleResult()).isNull();
+
+        managementService.executeCommand((Command<Void>) commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            DeadLetterJobEntityManager deadLetterJobService = jobServiceConfiguration.getDeadLetterJobEntityManager();
+            List<Job> jobs = deadLetterJobService.findJobsByQueryCriteria(new DeadLetterJobQueryImpl(commandContext, jobServiceConfiguration));
+            for (Job job : jobs) {
+                deadLetterJobService.delete(job.getId());
+            }
+
+            return null;
+        });
+
+
+    }
     @Test
     @Deployment(resources = "org/flowable/engine/test/bpmn/oneTask.bpmn20.xml")
     public void testDeadLetterJobQueryWithoutScopeType() {
@@ -820,6 +869,55 @@ public void testDeadLetterJobQueryWithoutScopeType() {
         });
     }
 
+    @Test
+    @Deployment(resources = "org/flowable/engine/test/bpmn/oneTask.bpmn20.xml")
+    public void testSuspendedJobQueryByProcessDefinitionKey() {
+        ProcessInstance processInstance = runtimeService.startProcessInstanceByKey("startToEnd");
+        SuspendedJobEntity suspendedJob = managementService.executeCommand(commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            SuspendedJobEntityManager suspendedJobEntityManager = jobServiceConfiguration.getSuspendedJobEntityManager();
+            SuspendedJobEntity job = suspendedJobEntityManager.create();
+            job.setJobType(Job.JOB_TYPE_MESSAGE);
+            job.setProcessInstanceId(processInstance.getId());
+            job.setProcessDefinitionId(processInstance.getProcessDefinitionId());
+            jobServiceConfiguration.getSuspendedJobEntityManager().insert(job);
+
+            return job;
+        });
+
+        SuspendedJobEntity suspendedJob2 = managementService.executeCommand(commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            SuspendedJobEntityManager suspendedJobEntityManager = jobServiceConfiguration.getSuspendedJobEntityManager();
+            SuspendedJobEntity job = suspendedJobEntityManager.create();
+            job.setJobType(Job.JOB_TYPE_MESSAGE);
+            job.setScopeId("scope1");
+            jobServiceConfiguration.getSuspendedJobEntityManager().insert(job);
+
+            return job;
+        });
+
+        SuspendedJobQuery query = managementService.createSuspendedJobQuery().processDefinitionKey("startToEnd");
+        assertThat(query.count()).isEqualTo(1);
+        assertThat(query.list()).extracting(Job::getId).containsExactly(suspendedJob.getId());
+        assertThat(query.singleResult().getId()).isEqualTo(suspendedJob.getId());
+
+        query = managementService.createSuspendedJobQuery().processDefinitionKey("invalid");
+        assertThat(query.count()).isZero();
+        assertThat(query.list()).isEmpty();
+        assertThat(query.singleResult()).isNull();
+
+        managementService.executeCommand((Command<Void>) commandContext -> {
+            JobServiceConfiguration jobServiceConfiguration = CommandContextUtil.getProcessEngineConfiguration(commandContext).getJobServiceConfiguration();
+            SuspendedJobEntityManager suspendedJobEntityManager = jobServiceConfiguration.getSuspendedJobEntityManager();
+            List<Job> jobs = suspendedJobEntityManager.findJobsByQueryCriteria(new SuspendedJobQueryImpl(commandContext, jobServiceConfiguration));
+            for (Job job : jobs) {
+                suspendedJobEntityManager.delete(job.getId());
+            }
+
+            return null;
+        });
+    }
+
     @Test
     @Deployment(resources = "org/flowable/engine/test/bpmn/oneTask.bpmn20.xml")
     public void testSuspendedJobQueryWithoutScopeType() {

diff --git a/...es/flowable-engine/src/test/java/org/flowable/engine/test/api/mgmt/TimerJobQueryTest.java b/...es/flowable-engine/src/test/java/org/flowable/engine/test/api/mgmt/TimerJobQueryTest.java
@@ -92,9 +92,16 @@ public void testByExecutionId() {
 
     @Test
     public void testByProcessDefinitionId() {
-        String processDefinitionid = repositoryService.createProcessDefinitionQuery().singleResult().getId();
-        assertThat(managementService.createTimerJobQuery().processDefinitionId(processDefinitionid).count()).isEqualTo(3);
-        assertThat(managementService.createTimerJobQuery().processDefinitionId(processDefinitionid).list()).hasSize(3);
+        String processDefinitionId = repositoryService.createProcessDefinitionQuery().singleResult().getId();
+        assertThat(managementService.createTimerJobQuery().processDefinitionId(processDefinitionId).count()).isEqualTo(3);
+        assertThat(managementService.createTimerJobQuery().processDefinitionId(processDefinitionId).list()).hasSize(3);
+    }
+
+    @Test
+    public void testByProcessDefinitionKey() {
+        String processDefinitionKey = repositoryService.createProcessDefinitionQuery().singleResult().getKey();
+        assertThat(managementService.createTimerJobQuery().processDefinitionKey(processDefinitionKey).count()).isEqualTo(3);
+        assertThat(managementService.createTimerJobQuery().processDefinitionKey(processDefinitionKey).list()).hasSize(3);
     }
 
     @Test

diff --git a/modules/flowable-job-service-api/src/main/java/org/flowable/job/api/BaseJobQuery.java b/modules/flowable-job-service-api/src/main/java/org/flowable/job/api/BaseJobQuery.java
@@ -66,6 +66,11 @@ public interface BaseJobQuery<U extends BaseJobQuery<U, T>, T extends Job> exten
      */
     U processDefinitionId(String processDefinitionId);
 
+    /**
+     * Only select jobs which exist for the given process definition key
+     */
+    U processDefinitionKey(String processDefinitionKey);
+
     /**
      * Only select jobs which exist for the given category
      */

diff --git a/...wable-job-service/src/main/java/org/flowable/job/service/impl/DeadLetterJobQueryImpl.java b/...wable-job-service/src/main/java/org/flowable/job/service/impl/DeadLetterJobQueryImpl.java
@@ -45,6 +45,7 @@ public class DeadLetterJobQueryImpl extends AbstractQuery<DeadLetterJobQuery, Jo
     protected String handlerType;
     protected Collection<String> handlerTypes;
     protected String processDefinitionId;
+    protected String processDefinitionKey;
     protected String category;
     protected String categoryLike;
     protected String elementId;
@@ -124,6 +125,14 @@ public DeadLetterJobQueryImpl processDefinitionId(String processDefinitionId) {
         this.processDefinitionId = processDefinitionId;
         return this;
     }
+
+    public DeadLetterJobQueryImpl processDefinitionKey(String processDefinitionKey) {
+        if (processDefinitionKey == null) {
+            throw new FlowableIllegalArgumentException("Provided process definition key is null");
+        }
+        this.processDefinitionKey = processDefinitionKey;
+        return this;
+    }
 
     @Override
     public DeadLetterJobQueryImpl category(String category) {
@@ -482,6 +491,10 @@ public String getId() {
     public String getProcessDefinitionId() {
         return processDefinitionId;
     }
+
+    public String getProcessDefinitionKey() {
+        return processDefinitionKey;
+    }
 
     public String getCategory() {
         return category;

diff --git a/...e-job-service/src/main/java/org/flowable/job/service/impl/ExternalWorkerJobQueryImpl.java b/...e-job-service/src/main/java/org/flowable/job/service/impl/ExternalWorkerJobQueryImpl.java
@@ -44,6 +44,7 @@ public class ExternalWorkerJobQueryImpl extends AbstractQuery<ExternalWorkerJobQ
     protected String handlerType;
     protected Collection<String> handlerTypes;
     protected String processDefinitionId;
+    protected String processDefinitionKey;
     protected String category;
     protected String categoryLike;
     protected String elementId;
@@ -126,6 +127,15 @@ public ExternalWorkerJobQuery processDefinitionId(String processDefinitionId) {
         return this;
     }
 
+    @Override
+    public ExternalWorkerJobQuery processDefinitionKey(String processDefinitionKey) {
+        if (processDefinitionKey == null) {
+            throw new FlowableIllegalArgumentException("Provided process definition key is null");
+        }
+        this.processDefinitionKey = processDefinitionKey;
+        return this;
+    }
+
     @Override
     public ExternalWorkerJobQuery category(String category) {
         if (category == null) {
@@ -470,6 +480,10 @@ public String getProcessDefinitionId() {
         return processDefinitionId;
     }
 
+    public String getProcessDefinitionKey() {
+        return processDefinitionKey;
+    }
+
     public String getCategory() {
         return category;
     }

diff --git a/modules/flowable-job-service/src/main/java/org/flowable/job/service/impl/JobQueryImpl.java b/modules/flowable-job-service/src/main/java/org/flowable/job/service/impl/JobQueryImpl.java
@@ -46,6 +46,7 @@ public class JobQueryImpl extends AbstractQuery<JobQuery, Job> implements JobQue
     protected String handlerType;
     protected Collection<String> handlerTypes;
     protected String processDefinitionId;
+    protected String processDefinitionKey;
     protected String category;
     protected String categoryLike;
     protected String elementId;
@@ -128,6 +129,15 @@ public JobQueryImpl processDefinitionId(String processDefinitionId) {
         return this;
     }
 
+    @Override
+    public JobQueryImpl processDefinitionKey(String processDefinitionKey) {
+        if (processDefinitionKey == null) {
+            throw new FlowableIllegalArgumentException("Provided process definition key is null");
+        }
+        this.processDefinitionKey = processDefinitionKey;
+        return this;
+    }
+
     @Override
     public JobQueryImpl category(String category) {
         if (category == null) {
@@ -474,6 +484,10 @@ public String getProcessDefinitionId() {
         return processDefinitionId;
     }
 
+    public String getProcessDefinitionKey() {
+        return processDefinitionKey;
+    }
+
     public String getCategory() {
         return category;
     }

diff --git a/...owable-job-service/src/main/java/org/flowable/job/service/impl/SuspendedJobQueryImpl.java b/...owable-job-service/src/main/java/org/flowable/job/service/impl/SuspendedJobQueryImpl.java
@@ -45,6 +45,7 @@ public class SuspendedJobQueryImpl extends AbstractQuery<SuspendedJobQuery, Job>
     protected String handlerType;
     protected Collection<String> handlerTypes;
     protected String processDefinitionId;
+    protected String processDefinitionKey;
     protected String category;
     protected String categoryLike;
     protected String elementId;
@@ -127,6 +128,15 @@ public SuspendedJobQueryImpl processDefinitionId(String processDefinitionId) {
         this.processDefinitionId = processDefinitionId;
         return this;
     }
+
+    @Override
+    public SuspendedJobQueryImpl processDefinitionKey(String processDefinitionKey) {
+        if (processDefinitionKey == null) {
+            throw new FlowableIllegalArgumentException("Provided process definition key is null");
+        }
+        this.processDefinitionKey = processDefinitionKey;
+        return this;
+    }
 
     @Override
     public SuspendedJobQueryImpl category(String category) {
@@ -524,6 +534,10 @@ public String getId() {
     public String getProcessDefinitionId() {
         return processDefinitionId;
     }
+
+    public String getProcessDefinitionKey() {
+        return processDefinitionKey;
+    }
 
     public String getCategory() {
         return category;

diff --git a/...s/flowable-job-service/src/main/java/org/flowable/job/service/impl/TimerJobQueryImpl.java b/...s/flowable-job-service/src/main/java/org/flowable/job/service/impl/TimerJobQueryImpl.java
@@ -45,6 +45,7 @@ public class TimerJobQueryImpl extends AbstractQuery<TimerJobQuery, Job> impleme
     protected String handlerType;
     protected Collection<String> handlerTypes;
     protected String processDefinitionId;
+    protected String processDefinitionKey;
     protected String category;
     protected String categoryLike;
     protected String elementId;
@@ -124,6 +125,15 @@ public TimerJobQueryImpl processDefinitionId(String processDefinitionId) {
         return this;
     }
 
+    @Override
+    public TimerJobQueryImpl processDefinitionKey(String processDefinitionKey) {
+        if (processDefinitionKey == null) {
+            throw new FlowableIllegalArgumentException("Provided process definition key is null");
+        }
+        this.processDefinitionKey = processDefinitionKey;
+        return this;
+    }
+
     @Override
     public TimerJobQueryImpl category(String category) {
         if (category == null) {
@@ -458,6 +468,10 @@ public String getProcessDefinitionId() {
         return processDefinitionId;
     }
 
+    public String getProcessDefinitionKey() {
+        return processDefinitionKey;
+    }
+
     public String getCategory() {
         return category;
     }

diff --git a/...b-service/src/main/resources/org/flowable/job/service/db/mapping/entity/DeadLetterJob.xml b/...b-service/src/main/resources/org/flowable/job/service/db/mapping/entity/DeadLetterJob.xml
@@ -241,6 +241,9 @@
 
     <sql id="selectDeadLetterJobByQueryCriteriaSql">
         from ${prefix}ACT_RU_DEADLETTER_JOB RES
+        <if test="processDefinitionKey != null">
+            inner join ${prefix}ACT_RE_PROCDEF P on RES.PROC_DEF_ID_ = P.ID_
+        </if>
         <where>
             <if test="id != null">
                 RES.ID_ = #{id}
@@ -272,6 +275,9 @@
             <if test="processDefinitionId != null">
                 and RES.PROC_DEF_ID_ = #{processDefinitionId}
             </if>
+            <if test="processDefinitionKey != null">
+                and P.KEY_ = #{processDefinitionKey}
+            </if>
             <if test="category != null">
                 and RES.CATEGORY_ = #{category}
             </if>

diff --git a/...rvice/src/main/resources/org/flowable/job/service/db/mapping/entity/ExternalWorkerJob.xml b/...rvice/src/main/resources/org/flowable/job/service/db/mapping/entity/ExternalWorkerJob.xml
@@ -174,6 +174,9 @@
 
     <sql id="selectExternalWorkerJobByQueryCriteriaSql">
         from ${prefix}ACT_RU_EXTERNAL_JOB RES
+        <if test="processDefinitionKey != null">
+            inner join ${prefix}ACT_RE_PROCDEF P on RES.PROC_DEF_ID_ = P.ID_
+        </if>
         <where>
             <if test="id != null">
                 RES.ID_ = #{id}
@@ -205,6 +208,9 @@
             <if test="processDefinitionId != null">
                 and RES.PROC_DEF_ID_ = #{processDefinitionId}
             </if>
+            <if test="processDefinitionKey != null">
+                and P.KEY_ = #{processDefinitionKey}
+            </if>
             <if test="category != null">
                 and RES.CATEGORY_ = #{category}
             </if>